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