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