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