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