includes/current_user.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12
  13 include_once($path_to_root . "/includes/prefs/userprefs.inc");
  14 if (!defined('TB_PREF')) {
  15         define('TB_PREF', '&TB_PREF&');
  16 }
  17 //--------------------------------------------------------------------------
  18
  19 class current_user
  20 {
  21         var $user;
  22         var $loginname;
  23         var $username;
  24         var $name;
  25         var $company; // user's company
  26         var $pos;
  27         var $access;
  28         var $timeout;
  29         var $last_act;
  30         var $role_set = false;
  31         var $old_db;
  32         var $logged;
  33         var $ui_mode = 0;
  34
  35         var $prefs;
  36         var $cur_con; // current db connection (can be different from $company for superuser)
  37
  38         function current_user()
  39         {
  40                 global $def_coy;
  41
  42                 $this->loginname = $this->username = $this->name = "";
  43                 $this->company = isset($def_coy)? $def_coy : 0;
  44                 $this->logged = false;
  45
  46                 $this->prefs = new user_prefs();
  47         }
  48
  49         function logged_in()
  50         {
  51                 return $this->logged;
  52         }
  53
  54         function set_company($company)
  55         {
  56                 $this->company = $company;
  57         }
  58
  59         function login($company, $loginname, $password)
  60         {
  61                 global $security_areas, $security_groups, $security_headings, $path_to_root, $dflt_lang;
  62
  63                 $this->set_company($company);
  64             $this->logged = false;
  65
  66                 set_global_connection($company);
  67                 $lang = &$_SESSION['language'];
  68                 $lang->set_language($_SESSION['language']->code);
  69                 db_set_encoding($_SESSION['language']->encoding);
  70
  71                 // Use external authentication source if any.
  72                 // Keep in mind you need to have user data set for $loginname
  73                 // in FA users table anyway to successfully log in.
  74                 $Auth_Result = hook_authenticate($loginname, $password);
  75
  76                 if (!isset($Auth_Result))       // if not used: standard method
  77                         $Auth_Result = get_user_auth($loginname, md5($password));
  78
  79                 if ($Auth_Result)
  80                 {
  81                         $myrow = get_user_by_login($loginname);
  82                         if ($myrow['language'] != $dflt_lang)
  83                         {        // refresh language and user data
  84                                 $lang->set_language($myrow['language']);
  85                                 db_set_encoding($_SESSION['language']->encoding);
  86                                 $myrow = get_user_by_login($loginname);
  87                         }
  88
  89                         $this->old_db = isset($myrow["full_access"]);
  90                         if (! @$myrow["inactive"]) {
  91                                 if ($this->old_db) {
  92                                         // Transition code:
  93                                         // db was not yet upgraded after source update to v.2.2
  94                                         // give enough access for admin user to continue upgrade
  95                                         if (!isset($security_groups) || !isset($security_headings)) {
  96                                                 echo "<center><br><br><font size='5' color='red'><b>";
  97                                                 echo _('Before software upgrade you have to include old $security_groups and $security_headings arrays from old config.php file to the new one.');
  98                                                 echo '<br>'."<a href=$path_to_root/index.php>"._("Back")."</a>";
  99                                                 echo "</b></font><br><br></center>";
 100                                                 exit;
 101                                         }
 102                             $this->access = $myrow["full_access"];
 103                             if (in_array(20, $security_groups[$this->access]))
 104                                                 // temporary access for admin users
 105                                                 $this->role_set[] = $security_areas['SA_SOFTWAREUPGRADE'][0];
 106                                         else {
 107                                                 echo "<center><br><br><font size='5' color='red'><b>";
 108                                                 echo _('System is available for site admin only until full database upgrade');
 109                                                 echo "</b></font><br><br></center>";
 110                                                 exit;
 111                                         }
 112                         } else {
 113                                         $this->role_set = array();
 114                             $this->access = $myrow["role_id"];
 115                                         // store area codes available for current user role
 116                                         $role = get_security_role($this->access);
 117                                         if (!$role)
 118                                                 return false;
 119                                         foreach( $role['areas'] as $code )
 120                                                 // filter only area codes for enabled security sections
 121                                                 if (in_array($code&~0xff, $role['sections']))
 122                                                         $this->role_set[] = $code;
 123                         }
 124                     $this->name = $myrow["real_name"];
 125                     $this->pos = $myrow["pos"];
 126                     $this->loginname = $loginname;
 127                     $this->username = $this->loginname;
 128                     $this->prefs = new user_prefs($myrow);
 129                     $this->user = @$myrow["id"];
 130                         update_user_visitdate($this->username);
 131                         $this->logged = true;
 132                                 $this->last_act = time();
 133                                 $this->timeout = session_timeout();
 134                         }
 135                 }
 136                 return $this->logged;
 137         }
 138
 139         function check_user_access()
 140         {
 141                 global $security_groups;
 142                 if ($this->old_db) {
 143                         // notification after upgrade from pre-2.2 version
 144                         return isset($security_groups) && is_array(@$security_groups[$this->access]);
 145                 } else
 146                         return !isset($security_groups) && is_array($this->role_set);
 147         }
 148
 149         function can_access($sec_area)
 150         {
 151                 global $security_groups, $security_areas;
 152                 if (isset($security_groups)) {
 153                         return is_admin_company() &&
 154                                 in_array(20, $security_groups[$this->access]);
 155                 }
 156
 157                 if ($sec_area === 'SA_OPEN')
 158                         return true;
 159                 if ($sec_area === 'SA_DENIED' || $sec_area === '')
 160                         return false;
 161
 162                 $code = $security_areas[$sec_area][0];
 163
 164                 // only first registered company has site admin privileges
 165                 return $code && in_array($code, $this->role_set)
 166                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
 167         }
 168
 169         function can_access_page($page_level)
 170         {
 171                 return $this->can_access($page_level);
 172         }
 173
 174         function set_db_connection($id = -1)
 175         {
 176                 return set_global_connection($id);
 177         }
 178
 179         function update_prefs($prefs)
 180         {
 181                 global $allow_demo_mode;
 182
 183                 if(!$allow_demo_mode) {
 184                         update_user_prefs($this->user, $prefs);
 185                 }
 186
 187                 $this->prefs = new user_prefs(get_user($this->user));
 188         }
 189 }
 190
 191 //--------------------------------------------------------------------------
 192
 193 function round2($number, $decimals=0)
 194 {
 195         $delta = ($number < 0 ? -.0000000001 : .0000000001);
 196         return round($number+$delta, $decimals);
 197 }
 198
 199 /*
 200         Returns number formatted according to user setup and using $decimals digits after dot
 201         (defualt is 0). When $decimals is set to 'max' maximum available precision is used
 202         (decimals depend on value) and trailing zeros are trimmed.
 203 */
 204 function number_format2($number, $decimals=0)
 205 {
 206         global $thoseps, $decseps;
 207         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
 208         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
 209         //return number_format($number, $decimals, $dsep,       $tsep);
 210         if($decimals==='max')
 211                 $dec = 15 - floor(log10(abs($number)));
 212         else {
 213                 $delta = ($number < 0 ? -.0000000001 : .0000000001);
 214                 $number += $delta;
 215                 $dec = $decimals;
 216         }
 217
 218         $num = number_format($number, $dec, $dsep, $tsep);
 219
 220         return $decimals==='max' ? rtrim($num, '0') : $num;
 221
 222 }
 223
 224 /* price/float comparision helper to be used in any suspicious place for zero values?
 225 usage:
 226 if (!floatcmp($value1, $value2))
 227         compare value is 0
 228 */
 229
 230 define('FLOAT_COMP_DELTA', 0.004);
 231
 232 function floatcmp($a, $b)
 233 {
 234     return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
 235 }
 236
 237 //
 238 //      Current ui mode.
 239 //
 240 function fallback_mode() {
 241     return $_SESSION["wa_current_user"]->ui_mode==0;
 242 }
 243
 244 function price_format($number) {
 245     return number_format2($number,
 246         $_SESSION["wa_current_user"]->prefs->price_dec());
 247 }
 248
 249 function price_decimal_format($number, &$dec)
 250 {
 251         $dec = user_price_dec();
 252         $str = strval($number);
 253         $pos = strpos($str, '.');
 254         if ($pos !== false)
 255         {
 256                 $len = strlen(substr($str, $pos + 1));
 257                 if ($len > $dec)
 258                         $dec = $len;
 259         }
 260         return number_format2($number, $dec);
 261 }
 262 // function money_format doesn't exist in OS Win.
 263 if (!function_exists('money_format'))
 264 {
 265         function money_format($format, $number)
 266         {
 267                 return price_format($number);
 268         }
 269 }
 270
 271 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
 272 //--------------------------------------------------------------------
 273 function qty_format($number, $stock_id=null, &$dec) {
 274         $dec = get_qty_dec($stock_id);
 275     return number_format2($number, $dec);
 276 }
 277
 278 // and get_qty_dec
 279 function get_qty_dec($stock_id=null)
 280 {
 281         global $path_to_root;
 282         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
 283         if ($stock_id != null)
 284                 $dec = get_unit_dec($stock_id);
 285         if ($stock_id == null || $dec == -1 || $dec == null)
 286                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
 287         return $dec;
 288 }
 289 //-------------------------------------------------------------------
 290 //
 291 //      Maximum precision format. Strips trailing unsignificant digits.
 292 //
 293 function maxprec_format($number) {
 294     return number_format2($number, 'max');
 295 }
 296
 297 function exrate_format($number) {
 298     return number_format2($number,
 299         $_SESSION["wa_current_user"]->prefs->exrate_dec());
 300 }
 301
 302 function percent_format($number) {
 303     return number_format2($number,
 304         $_SESSION["wa_current_user"]->prefs->percent_dec());
 305 }
 306
 307 function user_numeric($input) {
 308     global $decseps, $thoseps;
 309
 310     $num = trim($input);
 311     $sep = $thoseps[user_tho_sep()];
 312     if ($sep!='')
 313         $num = str_replace( $sep, '', $num);
 314
 315     $sep = $decseps[user_dec_sep()];
 316     if ($sep!='.')
 317         $num = str_replace( $sep, '.', $num);
 318
 319     if (!is_numeric($num))
 320           return false;
 321     $num = (float)$num;
 322     if ($num == (int)$num)
 323           return (int)$num;
 324     else
 325           return $num;
 326 }
 327
 328 function user_company()
 329 {
 330         global $def_coy;
 331
 332         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
 333 }
 334
 335 function user_pos()
 336 {
 337         return $_SESSION["wa_current_user"]->pos;
 338 }
 339
 340 function user_language()
 341 {
 342         return $_SESSION["wa_current_user"]->prefs->language();
 343 }
 344
 345 function user_qty_dec()
 346 {
 347         return $_SESSION["wa_current_user"]->prefs->qty_dec();
 348 }
 349
 350 function user_price_dec()
 351 {
 352         return $_SESSION["wa_current_user"]->prefs->price_dec();
 353 }
 354
 355 function user_exrate_dec()
 356 {
 357         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
 358 }
 359
 360 function user_percent_dec()
 361 {
 362         return $_SESSION["wa_current_user"]->prefs->percent_dec();
 363 }
 364
 365 function user_show_gl_info()
 366 {
 367         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
 368 }
 369
 370 function user_show_codes()
 371 {
 372         return $_SESSION["wa_current_user"]->prefs->show_codes();
 373 }
 374
 375 function user_date_format()
 376 {
 377         return $_SESSION["wa_current_user"]->prefs->date_format();
 378 }
 379
 380 function user_date_display()
 381 {
 382         return $_SESSION["wa_current_user"]->prefs->date_display();
 383 }
 384
 385 function user_date_sep()
 386 {
 387         return $_SESSION["wa_current_user"]->prefs->date_sep();
 388 }
 389
 390 function user_tho_sep()
 391 {
 392         return $_SESSION["wa_current_user"]->prefs->tho_sep();
 393 }
 394
 395 function user_dec_sep()
 396 {
 397         return $_SESSION["wa_current_user"]->prefs->dec_sep();
 398 }
 399
 400 function user_theme()
 401 {
 402         return isset($_SESSION["wa_current_user"]) ?
 403                 $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
 404 }
 405
 406 function user_pagesize()
 407 {
 408         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
 409 }
 410
 411 function user_hints()
 412 {
 413         return $_SESSION["wa_current_user"]->prefs->show_hints();
 414 }
 415
 416 function user_print_profile()
 417 {
 418         return $_SESSION["wa_current_user"]->prefs->print_profile();
 419 }
 420
 421 function user_rep_popup()
 422 {
 423         return $_SESSION["wa_current_user"]->prefs->rep_popup();
 424 }
 425
 426 function user_query_size()
 427 {
 428         return $_SESSION["wa_current_user"]->prefs->query_size();
 429 }
 430
 431 function user_graphic_links()
 432 {
 433         return $_SESSION["wa_current_user"]->prefs->graphic_links();
 434 }
 435
 436 function sticky_doc_date()
 437 {
 438         return $_SESSION["wa_current_user"]->prefs->sticky_date();
 439 }
 440
 441 function user_startup_tab()
 442 {
 443         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
 444 }
 445
 446 function user_transaction_days()
 447 {
 448     return $_SESSION["wa_current_user"]->prefs->transaction_days();
 449 }
 450
 451
 452 function user_check_access($sec_area)
 453 {
 454         return $_SESSION["wa_current_user"]->can_access($sec_area);
 455 }
 456
 457 function set_user_prefs($prefs)
 458 {
 459         $_SESSION["wa_current_user"]->update_prefs($prefs);
 460 }
 461
 462 function add_user_js_data() {
 463         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
 464
 465         $ts = $thoseps[user_tho_sep()];
 466         $ds = $decseps[user_dec_sep()];
 467
 468     $js = "\n"
 469           . "var user = {\n"
 470           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
 471           . "loadtxt: '"._('Requesting data...')."',\n"
 472           . "date: '".Today()."',\n"    // server date
 473           . "datesys: ".$date_system.",\n"
 474           . "datefmt: ".user_date_format().",\n"
 475           . "datesep: '".$dateseps[user_date_sep()]."',\n"
 476           . "ts: '$ts',\n"
 477           . "ds: '$ds',\n"
 478           . "pdec : " . user_price_dec() . "}\n";
 479
 480   add_js_source($js);
 481 }
 482
 483 //--------------------------------------------------------------------------
 484
 485 function session_timeout()
 486 {
 487         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
 488         return $tout ? $tout : ini_get('session.gc_maxlifetime');
 489 }
 490
 491 //-----------------------------------------------------------------------------
 492 //      Inserts $elements into $array at position $index.
 493 //      $elements is list of any objects
 494 //
 495 function array_insert(&$array, $index, $elements)
 496 {
 497         if (!is_array($elements)) $elements = array($elements);
 498
 499         $head  = array_splice($array, 0, $index);
 500         $array = array_merge($head, $elements, $array);
 501 }
 502
 503 function array_remove(&$array, $index, $len=1)
 504 {
 505         array_splice($array, $index, $len);
 506 }
 507
 508 function array_substitute(&$array, $index, $len, $elements)
 509 {
 510         array_splice($array, $index, $len);
 511         array_insert($array, $index, $elements);
 512 }
 513
 514 function array_append(&$array, $elements)
 515 {
 516         foreach($elements as $key => $el) {
 517                 if(is_int($key))
 518                         $array[] = $el;
 519                 else
 520                         $array[$key] = $el;
 521         }
 522 }
 523 //
 524 //      Search $needle in $haystack or in $haystack[][$valuekey]
 525 //      returns $needle found or null.
 526 //
 527 function array_search_value($needle, $haystack, $valuekey=null)
 528 {
 529         foreach($haystack as $key => $value) {
 530                 $val = isset($valuekey) ? @$value[$valuekey] : $value;
 531                 if ($needle == $val){
 532                         return $value;
 533                 }
 534         }
 535         return null;
 536 }
 537 //
 538 //      Search $needle in $haystack or in $haystack[][$valuekey]
 539 //      returns array of keys of $haystack elements found
 540 //
 541 function array_search_keys($needle, $haystack, $valuekey=null)
 542 {
 543         $keys = array();
 544         if($haystack)
 545                 foreach($haystack as $key => $value) {
 546                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
 547                         if ($needle == $val){
 548                                 $keys[] = $key;
 549                         }
 550                 }
 551         return $keys;
 552 }
 553 //
 554 //      Find first (single) $needle in $haystack or in $haystack[][$valuekey]
 555 //      returns $haystack element found or null
 556 //
 557 function array_search_key($needle, $haystack, $valuekey=null)
 558 {
 559         $keys = array_search_keys($needle, $haystack, $valuekey);
 560         return @$keys[0];
 561 }
 562
 563 function flush_dir($path, $wipe = false)
 564 {
 565         $dir = opendir($path);
 566         if(!$dir)
 567                 return;
 568
 569         while(false !== ($fname = readdir($dir))) {
 570                 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
 571                 if(is_dir($path.'/'.$fname)) {
 572                     flush_dir($path.'/'.$fname, $wipe);
 573                     if ($wipe) @rmdir($path.'/'.$fname);
 574                 } else
 575                     @unlink($path.'/'.$fname);
 576         }
 577 }
 578 /*
 579         Returns current path to company private folder.
 580         (Current path can change after chdir).
 581 */
 582 function company_path($comp=null)
 583 {
 584         global $path_to_root, $comp_path;
 585
 586         if (!isset($comp))
 587                 $comp = user_company();
 588
 589         // if path is relative, set current path_to_root
 590         return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
 591                         . '/'.$comp;
 592 }
 593
 594 function is_admin_company()
 595 {
 596         return $this->company == 0;
 597 }
 598
 599 ?>