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 set_db_connection($id = -1)
 167         {
 168                 return set_global_connection($id);
 169         }
 170
 171         function update_prefs($prefs)
 172         {
 173                 global $allow_demo_mode;
 174
 175                 if(!$allow_demo_mode) {
 176                         update_user_prefs($this->user, $prefs);
 177                 }
 178
 179                 $this->prefs = new user_prefs(get_user($this->user));
 180         }
 181 }
 182
 183 //--------------------------------------------------------------------------
 184
 185 function round2($number, $decimals=0)
 186 {
 187         $delta = ($number < 0 ? -.0000000001 : .0000000001);
 188         return round($number+$delta, $decimals);
 189 }
 190
 191 /*
 192         Returns number formatted according to user setup and using $decimals digits after dot
 193         (defualt is 0). When $decimals is set to 'max' maximum available precision is used
 194         (decimals depend on value) and trailing zeros are trimmed.
 195 */
 196 function number_format2($number, $decimals=0)
 197 {
 198         global $thoseps, $decseps;
 199         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
 200         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
 201         //return number_format($number, $decimals, $dsep,       $tsep);
 202         if($decimals==='max')
 203                 $dec = 15 - floor(log10(abs($number)));
 204         else {
 205                 $delta = ($number < 0 ? -.0000000001 : .0000000001);
 206                 $number += $delta;
 207                 $dec = $decimals;
 208         }
 209
 210         $num = number_format($number, $dec, $dsep, $tsep);
 211
 212         return $decimals==='max' ? rtrim($num, '0') : $num;
 213
 214 }
 215
 216 /* price/float comparision helper to be used in any suspicious place for zero values?
 217 usage:
 218 if (!floatcmp($value1, $value2))
 219         compare value is 0
 220 */
 221
 222 define('FLOAT_COMP_DELTA', 0.004);
 223
 224 function floatcmp($a, $b)
 225 {
 226     return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
 227 }
 228
 229 //
 230 //      Current ui mode.
 231 //
 232 function fallback_mode() {
 233     return $_SESSION["wa_current_user"]->ui_mode==0;
 234 }
 235
 236 function price_format($number) {
 237     return number_format2($number,
 238         $_SESSION["wa_current_user"]->prefs->price_dec());
 239 }
 240
 241 function price_decimal_format($number, &$dec)
 242 {
 243         $dec = user_price_dec();
 244         $str = strval($number);
 245         $pos = strpos($str, '.');
 246         if ($pos !== false)
 247         {
 248                 $len = strlen(substr($str, $pos + 1));
 249                 if ($len > $dec)
 250                         $dec = $len;
 251         }
 252         return number_format2($number, $dec);
 253 }
 254 // function money_format doesn't exist in OS Win.
 255 if (!function_exists('money_format'))
 256 {
 257         function money_format($format, $number)
 258         {
 259                 return price_format($number);
 260         }
 261 }
 262
 263 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
 264 //--------------------------------------------------------------------
 265 function qty_format($number, $stock_id=null, &$dec) {
 266         $dec = get_qty_dec($stock_id);
 267     return number_format2($number, $dec);
 268 }
 269
 270 // and get_qty_dec
 271 function get_qty_dec($stock_id=null)
 272 {
 273         global $path_to_root;
 274         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
 275         if ($stock_id != null)
 276                 $dec = get_unit_dec($stock_id);
 277         if ($stock_id == null || $dec == -1 || $dec == null)
 278                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
 279         return $dec;
 280 }
 281 //-------------------------------------------------------------------
 282 //
 283 //      Maximum precision format. Strips trailing unsignificant digits.
 284 //
 285 function maxprec_format($number) {
 286     return number_format2($number, 'max');
 287 }
 288
 289 function exrate_format($number) {
 290     return number_format2($number,
 291         $_SESSION["wa_current_user"]->prefs->exrate_dec());
 292 }
 293
 294 function percent_format($number) {
 295     return number_format2($number,
 296         $_SESSION["wa_current_user"]->prefs->percent_dec());
 297 }
 298
 299 function user_numeric($input) {
 300     global $decseps, $thoseps;
 301
 302     $num = trim($input);
 303     $sep = $thoseps[user_tho_sep()];
 304     if ($sep!='')
 305         $num = str_replace( $sep, '', $num);
 306
 307     $sep = $decseps[user_dec_sep()];
 308     if ($sep!='.')
 309         $num = str_replace( $sep, '.', $num);
 310
 311     if (!is_numeric($num))
 312           return false;
 313     $num = (float)$num;
 314     if ($num == (int)$num)
 315           return (int)$num;
 316     else
 317           return $num;
 318 }
 319
 320 function user_company()
 321 {
 322         global $def_coy;
 323
 324         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
 325 }
 326
 327 function user_pos()
 328 {
 329         return $_SESSION["wa_current_user"]->pos;
 330 }
 331
 332 function user_language()
 333 {
 334         return $_SESSION["wa_current_user"]->prefs->language();
 335 }
 336
 337 function user_qty_dec()
 338 {
 339         return $_SESSION["wa_current_user"]->prefs->qty_dec();
 340 }
 341
 342 function user_price_dec()
 343 {
 344         return $_SESSION["wa_current_user"]->prefs->price_dec();
 345 }
 346
 347 function user_exrate_dec()
 348 {
 349         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
 350 }
 351
 352 function user_percent_dec()
 353 {
 354         return $_SESSION["wa_current_user"]->prefs->percent_dec();
 355 }
 356
 357 function user_show_gl_info()
 358 {
 359         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
 360 }
 361
 362 function user_show_codes()
 363 {
 364         return $_SESSION["wa_current_user"]->prefs->show_codes();
 365 }
 366
 367 function user_date_format()
 368 {
 369         return $_SESSION["wa_current_user"]->prefs->date_format();
 370 }
 371
 372 function user_date_display()
 373 {
 374         return $_SESSION["wa_current_user"]->prefs->date_display();
 375 }
 376
 377 function user_date_sep()
 378 {
 379         return $_SESSION["wa_current_user"]->prefs->date_sep();
 380 }
 381
 382 function user_tho_sep()
 383 {
 384         return $_SESSION["wa_current_user"]->prefs->tho_sep();
 385 }
 386
 387 function user_dec_sep()
 388 {
 389         return $_SESSION["wa_current_user"]->prefs->dec_sep();
 390 }
 391
 392 function user_theme()
 393 {
 394         return isset($_SESSION["wa_current_user"]) ?
 395                 $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
 396 }
 397
 398 function user_pagesize()
 399 {
 400         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
 401 }
 402
 403 function user_hints()
 404 {
 405         return $_SESSION["wa_current_user"]->prefs->show_hints();
 406 }
 407
 408 function user_print_profile()
 409 {
 410         return $_SESSION["wa_current_user"]->prefs->print_profile();
 411 }
 412
 413 function user_rep_popup()
 414 {
 415         return $_SESSION["wa_current_user"]->prefs->rep_popup();
 416 }
 417
 418 function user_query_size()
 419 {
 420         return $_SESSION["wa_current_user"]->prefs->query_size();
 421 }
 422
 423 function user_graphic_links()
 424 {
 425         return $_SESSION["wa_current_user"]->prefs->graphic_links();
 426 }
 427
 428 function sticky_doc_date()
 429 {
 430         return $_SESSION["wa_current_user"]->prefs->sticky_date();
 431 }
 432
 433 function user_startup_tab()
 434 {
 435         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
 436 }
 437
 438 function set_user_prefs($prefs)
 439 {
 440         $_SESSION["wa_current_user"]->update_prefs($prefs);
 441 }
 442
 443 function add_user_js_data() {
 444         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
 445
 446         $ts = $thoseps[user_tho_sep()];
 447         $ds = $decseps[user_dec_sep()];
 448
 449     $js = "\n"
 450           . "var user = {\n"
 451           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
 452           . "loadtxt: '"._('Requesting data...')."',\n"
 453           . "date: '".Today()."',\n"    // server date
 454           . "datesys: ".$date_system.",\n"
 455           . "datefmt: ".user_date_format().",\n"
 456           . "datesep: '".$dateseps[user_date_sep()]."',\n"
 457           . "ts: '$ts',\n"
 458           . "ds: '$ds',\n"
 459           . "pdec : " . user_price_dec() . "}\n";
 460
 461   add_js_source($js);
 462 }
 463
 464 //--------------------------------------------------------------------------
 465
 466 function session_timeout()
 467 {
 468         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
 469         return $tout ? $tout : ini_get('session.gc_maxlifetime');
 470 }
 471
 472 //-----------------------------------------------------------------------------
 473 //      Inserts $elements into $array at position $index.
 474 //      $elements is list of any objects
 475 //
 476 function array_insert(&$array, $index, $elements)
 477 {
 478         if (!is_array($elements)) $elements = array($elements);
 479
 480         $head  = array_splice($array, 0, $index);
 481         $array = array_merge($head, $elements, $array);
 482 }
 483
 484 function array_remove(&$array, $index, $len=1)
 485 {
 486         array_splice($array, $index, $len);
 487 }
 488
 489 function array_substitute(&$array, $index, $len, $elements)
 490 {
 491         array_splice($array, $index, $len);
 492         array_insert($array, $index, $elements);
 493 }
 494
 495 function array_append(&$array, $elements)
 496 {
 497         foreach($elements as $key => $el) {
 498                 if(is_int($key))
 499                         $array[] = $el;
 500                 else
 501                         $array[$key] = $el;
 502         }
 503 }
 504 //
 505 //      Search $needle in $haystack or in $haystack[][$valuekey]
 506 //      returns $needle found or null.
 507 //
 508 function array_search_value($needle, $haystack, $valuekey=null)
 509 {
 510         foreach($haystack as $key => $value) {
 511                 $val = isset($valuekey) ? @$value[$valuekey] : $value;
 512                 if ($needle == $val){
 513                         return $value;
 514                 }
 515         }
 516         return null;
 517 }
 518 //
 519 //      Search $needle in $haystack or in $haystack[][$valuekey]
 520 //      returns array of keys of $haystack elements found
 521 //
 522 function array_search_keys($needle, $haystack, $valuekey=null)
 523 {
 524         $keys = array();
 525         if($haystack)
 526                 foreach($haystack as $key => $value) {
 527                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
 528                         if ($needle == $val){
 529                                 $keys[] = $key;
 530                         }
 531                 }
 532         return $keys;
 533 }
 534 //
 535 //      Find first (single) $needle in $haystack or in $haystack[][$valuekey]
 536 //      returns $haystack element found or null
 537 //
 538 function array_search_key($needle, $haystack, $valuekey=null)
 539 {
 540         $keys = array_search_keys($needle, $haystack, $valuekey);
 541         return @$keys[0];
 542 }
 543
 544 function flush_dir($path, $wipe = false)
 545 {
 546         $dir = opendir($path);
 547         if(!$dir)
 548                 return;
 549         while(false !== ($fname = readdir($dir))) {
 550                 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
 551                 if(is_dir($path.'/'.$fname)) {
 552                     flush_dir($path.'/'.$fname, $wipe);
 553                     if ($wipe) @rmdir($path.'/'.$fname);
 554                 } else
 555                     @unlink($path.'/'.$fname);
 556         }
 557 }
 558 /*
 559         Returns current path to company private folder.
 560         (Current path can change after chdir).
 561 */
 562 function company_path($comp=null)
 563 {
 564         global $path_to_root, $comp_path;
 565
 566         if (!isset($comp))
 567                 $comp = user_company();
 568
 569         // if path is relative, set current path_to_root
 570         return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
 571                         . '/'.$comp;
 572 }
 573
 574 ?>