includes/current_user.inc

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