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