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, $SysPrefs;
  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 ($SysPrefs->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                                 flush_dir(user_js_cache()); // refresh cache on login
 140                         }
 141                 }
 142                 return $this->logged;
 143         }
 144
 145         function reset_password($company, $email) {
 146                 global $SysPrefs;
 147
 148                 $this->set_company($company);
 149                 $this->logged = false;
 150
 151                 set_global_connection();
 152
 153                 $user = get_user_by_email($email);
 154
 155                 if ($user != false) {
 156
 157                         $password = generate_password();
 158                         $hash = md5($password);
 159
 160                         update_user_password($user['id'], $user['user_id'], $hash);
 161
 162                         mail($email, _("New password for")." ".$SysPrefs->app_title, $password);
 163
 164                         return true;
 165                 }
 166                 return false;
 167     }
 168
 169         function check_user_access()
 170         {
 171                 global $security_groups;
 172                 if ($this->old_db) {
 173                         // notification after upgrade from pre-2.2 version
 174                         return isset($security_groups) && is_array(@$security_groups[$this->access]);
 175                 } else
 176                         return !isset($security_groups) && is_array($this->role_set);
 177         }
 178
 179         function can_access($sec_area)
 180         {
 181                 global $security_groups, $security_areas;
 182                 if (isset($security_groups)) {
 183                         return is_admin_company() &&
 184                                 in_array(20, $security_groups[$this->access]);
 185                 }
 186
 187                 if ($sec_area === 'SA_OPEN')
 188                         return true;
 189                 if ($sec_area === 'SA_DENIED' || $sec_area === '')
 190                         return false;
 191
 192                 $code = $security_areas[$sec_area][0];
 193
 194                 // only first registered company has site admin privileges
 195                 return $code && in_array($code, $this->role_set)
 196                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
 197         }
 198
 199         function can_access_page($page_level)
 200         {
 201                 return $this->can_access($page_level);
 202         }
 203
 204         function check_application_access($waapp)
 205         {
 206                 if (!$this->hide_inaccessible_menu_items())
 207                 {
 208                         return true;
 209                 }
 210
 211                 foreach ($waapp->modules as $module)
 212                 {
 213                         if ($this->check_module_access($module))
 214                         {
 215                                 return true;
 216                         }
 217                 }
 218
 219                 return false;
 220
 221         }
 222
 223         function check_module_access($module)
 224         {
 225
 226                 if (!$this->hide_inaccessible_menu_items())
 227                 {
 228                         return true;
 229                 }
 230
 231                 if (sizeof($module->lappfunctions) > 0)
 232                 {
 233                         foreach ($module->lappfunctions as $appfunction)
 234                         {
 235                                 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
 236                                 {
 237                                         return true;
 238                                 }
 239                         }
 240                 }
 241
 242                 if (sizeof($module->rappfunctions) > 0)
 243                 {
 244                         foreach ($module->rappfunctions as $appfunction)
 245                         {
 246                                 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
 247                                 {
 248                                         return true;
 249                                 }
 250                         }
 251                 }
 252
 253                 return false;
 254
 255         }
 256
 257         function hide_inaccessible_menu_items()
 258         {
 259                 global $SysPrefs;
 260
 261                 if (!isset($SysPrefs->hide_inaccessible_menu_items) || $SysPrefs->hide_inaccessible_menu_items == 0)
 262                 {
 263                         return false;
 264                 }
 265
 266                 else
 267                 {
 268                         return true;
 269                 }
 270         }
 271
 272         function set_db_connection($id = -1)
 273         {
 274                 return set_global_connection($id);
 275         }
 276
 277         function update_prefs($prefs)
 278         {
 279                 global $SysPrefs;
 280
 281                 if (!$SysPrefs->allow_demo_mode) {
 282                         update_user_prefs($this->user, $prefs);
 283                 }
 284
 285                 $this->prefs = new user_prefs(get_user($this->user));
 286         }
 287 }
 288
 289 //--------------------------------------------------------------------------
 290
 291 function round2($number, $decimals=0)
 292 {
 293         $delta = ($number < 0 ? -.0000000001 : .0000000001);
 294         return round($number+$delta, $decimals);
 295 }
 296
 297 /*
 298         Returns number formatted according to user setup and using $decimals digits after dot
 299         (defualt is 0). When $decimals is set to 'max' maximum available precision is used
 300         (decimals depend on value) and trailing zeros are trimmed.
 301 */
 302 function number_format2($number, $decimals=0)
 303 {
 304         global $SysPrefs;
 305         $tsep = $SysPrefs->thoseps[user_dec_sep()];
 306         $dsep = $SysPrefs->decseps[user_dec_sep()];
 307         //return number_format($number, $decimals, $dsep,       $tsep);
 308         if($decimals==='max')
 309                 $dec = 15 - floor(log10(abs($number)));
 310         else {
 311                 $delta = ($number < 0 ? -.0000000001 : .0000000001);
 312                 $number += $delta;
 313                 $dec = $decimals;
 314         }
 315
 316         $num = number_format($number, $dec, $dsep, $tsep);
 317
 318         return $decimals==='max' ? rtrim($num, '0') : $num;
 319
 320 }
 321
 322 /* price/float comparision helper to be used in any suspicious place for zero values?
 323 usage:
 324 if (!floatcmp($value1, $value2))
 325         compare value is 0
 326 */
 327
 328 define('FLOAT_COMP_DELTA', 0.004);
 329
 330 function floatcmp($a, $b)
 331 {
 332     return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
 333 }
 334
 335 //
 336 //      Current ui mode.
 337 //
 338 function fallback_mode() {
 339     return $_SESSION["wa_current_user"]->ui_mode==0;
 340 }
 341
 342 function price_format($number) {
 343     return number_format2($number, user_price_dec());
 344 }
 345
 346 function price_decimal_format($number, &$dec)
 347 {
 348         $dec = user_price_dec();
 349         $str = strval($number);
 350         $pos = strpos($str, '.');
 351         if ($pos !== false)
 352         {
 353                 $len = strlen(substr($str, $pos + 1));
 354                 if ($len > $dec)
 355                         $dec = $len;
 356         }
 357         return number_format2($number, $dec);
 358 }
 359 // function money_format doesn't exist in OS Win.
 360 if (!function_exists('money_format'))
 361 {
 362         function money_format($format, $number)
 363         {
 364                 return price_format($number);
 365         }
 366 }
 367
 368 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
 369 //--------------------------------------------------------------------
 370 function qty_format($number, $stock_id=null, &$dec) {
 371         $dec = get_qty_dec($stock_id);
 372     return number_format2($number, $dec);
 373 }
 374
 375 // and get_qty_dec
 376 function get_qty_dec($stock_id=null)
 377 {
 378         global $path_to_root;
 379         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
 380         if ($stock_id != null)
 381                 $dec = get_unit_dec($stock_id);
 382         if ($stock_id == null || $dec == -1 || $dec == null)
 383                 $dec = user_qty_dec();
 384         return $dec;
 385 }
 386 //-------------------------------------------------------------------
 387 //
 388 //      Maximum precision format. Strips trailing unsignificant digits.
 389 //
 390 function maxprec_format($number) {
 391     return number_format2($number, 'max');
 392 }
 393
 394 function exrate_format($number) {
 395     return number_format2($number,
 396         $_SESSION["wa_current_user"]->prefs->exrate_dec());
 397 }
 398
 399 function percent_format($number) {
 400     return number_format2($number,
 401         $_SESSION["wa_current_user"]->prefs->percent_dec());
 402 }
 403
 404 function user_numeric($input) {
 405     global $SysPrefs;
 406
 407     $num = trim($input);
 408     $sep = $SysPrefs->thoseps[user_tho_sep()];
 409     if ($sep!='')
 410         $num = str_replace( $sep, '', $num);
 411
 412     $sep = $SysPrefs->decseps[user_dec_sep()];
 413     if ($sep!='.')
 414         $num = str_replace( $sep, '.', $num);
 415
 416     if (!is_numeric($num))
 417           return false;
 418     $num = (float)$num;
 419     if ($num == (int)$num)
 420           return (int)$num;
 421     else
 422           return $num;
 423 }
 424
 425 function user_company()
 426 {
 427         global $def_coy;
 428
 429         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
 430 }
 431
 432 function user_pos()
 433 {
 434         return $_SESSION["wa_current_user"]->pos;
 435 }
 436
 437 function user_language()
 438 {
 439         return $_SESSION["wa_current_user"]->prefs->language();
 440 }
 441
 442 function user_qty_dec()
 443 {
 444         return $_SESSION["wa_current_user"]->prefs->qty_dec();
 445 }
 446
 447 function user_price_dec()
 448 {
 449         global $SysPrefs;
 450
 451         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->price_dec() : 2;
 452 }
 453
 454 function user_exrate_dec()
 455 {
 456         global $SysPrefs;
 457
 458         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->exrate_dec() : 4;
 459 }
 460
 461 function user_percent_dec()
 462 {
 463         global $SysPrefs;
 464
 465         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->percent_dec() : 1;
 466 }
 467
 468 function user_show_gl_info()
 469 {
 470         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
 471 }
 472
 473 function user_show_codes()
 474 {
 475         return $_SESSION["wa_current_user"]->prefs->show_codes();
 476 }
 477
 478 function user_date_format()
 479 {
 480         global $SysPrefs;
 481
 482         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_format() : $SysPrefs->dflt_date_fmt;
 483 }
 484
 485 function user_date_display()
 486 {
 487         $fmt ='m/d/Y';
 488         if (isset($_SESSION["wa_current_user"])) {
 489                 $fmt = $_SESSION["wa_current_user"]->prefs->date_display();
 490         } else {
 491                 $sep = user_date_sep();
 492                 $user_date_fmt = user_date_format();
 493                 switch ($user_date_fmt) {
 494                         case 0:
 495                         $fmt = "m".$sep."d".$sep."Y"; break;
 496                         case 1:
 497                         $fmt = "d".$sep."m".$sep."Y"; break;
 498                         case 2:
 499                         $fmt = "Y".$sep."m".$sep."d"; break;
 500                         case 3:
 501                         $fmt = "M".$sep."j".$sep."Y"; break;
 502                         case 4:
 503                         $fmt = "j".$sep."M".$sep."Y"; break;
 504                         default:
 505                         $fmt = "Y".$sep."M".$sep."j";
 506                 }
 507         }
 508 }
 509
 510 function user_date_sep()
 511 {
 512         global $SysPrefs;
 513
 514         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_sep() : $SysPrefs->dflt_date_sep;
 515 }
 516
 517 function user_tho_sep()
 518 {
 519         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->tho_sep() : 0;
 520 }
 521
 522 function user_dec_sep()
 523 {
 524         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->dec_sep() : 0;
 525 }
 526
 527 function user_theme()
 528 {
 529         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
 530 }
 531
 532 function user_pagesize()
 533 {
 534         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
 535 }
 536
 537 function user_hints()
 538 {
 539         return $_SESSION["wa_current_user"]->prefs->show_hints();
 540 }
 541
 542 function user_print_profile()
 543 {
 544         return $_SESSION["wa_current_user"]->prefs->print_profile();
 545 }
 546
 547 function user_rep_popup()
 548 {
 549         return $_SESSION["wa_current_user"]->prefs->rep_popup();
 550 }
 551
 552 function user_query_size()
 553 {
 554         return $_SESSION["wa_current_user"]->prefs->query_size();
 555 }
 556
 557 function user_graphic_links()
 558 {
 559         return $_SESSION["wa_current_user"]->prefs->graphic_links();
 560 }
 561
 562 function sticky_doc_date()
 563 {
 564         return $_SESSION["wa_current_user"]->prefs->sticky_date();
 565 }
 566
 567 function user_startup_tab()
 568 {
 569         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
 570 }
 571
 572 function user_transaction_days()
 573 {
 574     return $_SESSION["wa_current_user"]->prefs->transaction_days();
 575 }
 576
 577 function user_save_report_selections()
 578 {
 579     return $_SESSION["wa_current_user"]->prefs->save_report_selections();
 580 }
 581
 582 function user_use_date_picker()
 583 {
 584     return $_SESSION["wa_current_user"]->prefs->use_date_picker();
 585 }
 586
 587 function user_def_print_destination()
 588 {
 589     return $_SESSION["wa_current_user"]->prefs->def_print_destination();
 590 }
 591
 592 function user_def_print_orientation()
 593 {
 594     return $_SESSION["wa_current_user"]->prefs->def_print_orientation();
 595 }
 596
 597 function user_check_access($sec_area)
 598 {
 599         return $_SESSION["wa_current_user"]->can_access($sec_area);
 600 }
 601
 602 function set_user_prefs($prefs)
 603 {
 604         $_SESSION["wa_current_user"]->update_prefs($prefs);
 605 }
 606
 607 function add_user_js_data() {
 608         global $path_to_root, $SysPrefs;
 609
 610         $ts = $SysPrefs->thoseps[user_tho_sep()];
 611         $ds = $SysPrefs->decseps[user_dec_sep()];
 612
 613     $js = "\n"
 614           . "var user = {\n"
 615           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
 616           . "loadtxt: '"._('Requesting data...')."',\n"
 617           . "date: '".Today()."',\n"    // server date
 618           . "datesys: ".$SysPrefs->date_system.",\n"
 619           . "datefmt: ".user_date_format().",\n"
 620           . "datesep: '".$SysPrefs->dateseps[user_date_sep()]."',\n"
 621           . "ts: '$ts',\n"
 622           . "ds: '$ds',\n"
 623           . "pdec : " . user_price_dec() . "}\n";
 624
 625   add_js_source($js);
 626 }
 627
 628 function user_js_cache($id=null)
 629 {
 630         global $path_to_root;
 631
 632         if (!$id)
 633                 $id = @$_SESSION['wa_current_user']->user;
 634
 635         if (!$id)
 636                 $id = 0; // before login
 637         return $path_to_root.'/company/'.user_company().'/js_cache/'.$id;
 638 }
 639
 640 //--------------------------------------------------------------------------
 641
 642 function session_timeout()
 643 {
 644         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
 645         return $tout ? $tout : ini_get('session.gc_maxlifetime');
 646 }
 647
 648 //-----------------------------------------------------------------------------
 649 //      Inserts $elements into $array at position $index.
 650 //      $elements is list of any objects
 651 //
 652 function array_insert(&$array, $index, $elements)
 653 {
 654         if (!is_array($elements)) $elements = array($elements);
 655
 656         $head  = array_splice($array, 0, $index);
 657         $array = array_merge($head, $elements, $array);
 658 }
 659
 660 function array_remove(&$array, $index, $len=1)
 661 {
 662         array_splice($array, $index, $len);
 663 }
 664
 665 function array_substitute(&$array, $index, $len, $elements)
 666 {
 667         array_splice($array, $index, $len);
 668         array_insert($array, $index, $elements);
 669 }
 670
 671 function array_append(&$array, $elements)
 672 {
 673         foreach($elements as $key => $el) {
 674                 if(is_int($key))
 675                         $array[] = $el;
 676                 else
 677                         $array[$key] = $el;
 678         }
 679 }
 680 //
 681 //      Search $needle in $haystack or in $haystack[][$valuekey]
 682 //      returns $needle found or null.
 683 //
 684 function array_search_value($needle, $haystack, $valuekey=null)
 685 {
 686         foreach($haystack as $key => $value) {
 687                 $val = isset($valuekey) ? @$value[$valuekey] : $value;
 688                 if ($needle == $val){
 689                         return $value;
 690                 }
 691         }
 692         return null;
 693 }
 694 //
 695 //      Search $needle in $haystack or in $haystack[][$valuekey]
 696 //      returns array of keys of $haystack elements found
 697 //
 698 function array_search_keys($needle, $haystack, $valuekey=null)
 699 {
 700         $keys = array();
 701         if($haystack)
 702                 foreach($haystack as $key => $value) {
 703                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
 704                         if ($needle == $val){
 705                                 $keys[] = $key;
 706                         }
 707                 }
 708         return $keys;
 709 }
 710 //
 711 //      Find first (single) $needle in $haystack or in $haystack[][$valuekey]
 712 //      returns $haystack element found or null
 713 //
 714 function array_search_key($needle, $haystack, $valuekey=null)
 715 {
 716         $keys = array_search_keys($needle, $haystack, $valuekey);
 717         return @$keys[0];
 718 }
 719
 720 // Recalculate report columns if orientation is landscape.
 721 function recalculate_cols(&$cols)
 722 {
 723         $factor = (user_pagesize() == "A4" ? 1.4 : 1.3);
 724         foreach($cols as $key => $col)
 725                 $cols[$key] = intval($col * $factor);
 726 }
 727
 728 function flush_dir($path, $wipe = false)
 729 {
 730         $dir = @opendir($path);
 731         if(!$dir)
 732                 return;
 733
 734         while(false !== ($fname = readdir($dir))) {
 735                 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
 736                 if(is_dir($path.'/'.$fname)) {
 737                     flush_dir($path.'/'.$fname, $wipe);
 738                     if ($wipe) @rmdir($path.'/'.$fname);
 739                 } else
 740                     @unlink($path.'/'.$fname);
 741         }
 742 }
 743 /*
 744         Returns current path to company private folder.
 745         (Current path can change after chdir).
 746 */
 747 function company_path($comp=null)
 748 {
 749         global $path_to_root, $SysPrefs;
 750
 751         $comp_path = $SysPrefs->comp_path;
 752
 753
 754         if (!isset($comp))
 755                 $comp = user_company();
 756
 757         // if path is relative, set current path_to_root
 758         return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
 759                         . '/'.$comp;
 760 }
 761
 762 function is_admin_company()
 763 {
 764         return $this->company == 0;
 765 }
 766