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