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