includes/current_user.inc

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