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