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 include_once($path_to_root . "/includes/prefs/userprefs.inc");
  13
  14 //--------------------------------------------------------------------------
  15
  16 class current_user
  17 {
  18         var $user;
  19         var $loginname;
  20         var $username;
  21         var $name;
  22         var $company;
  23         var $pos;
  24         var $access;
  25         var $timeout;
  26         var $last_act;
  27         var $role_set = false;
  28         var $old_db;
  29         var $logged;
  30         var $ui_mode = 0;
  31
  32         var $prefs;
  33
  34         function current_user()
  35         {
  36                 global $def_coy;
  37
  38                 $this->loginname = $this->username = $this->name = "";
  39                 $this->company = isset($def_coy)? $def_coy : 0;
  40                 $this->logged = false;
  41
  42                 $this->prefs = new user_prefs();
  43         }
  44
  45         function logged_in()
  46         {
  47                 return $this->logged;
  48         }
  49
  50         function set_company($company)
  51         {
  52                 $this->company = $company;
  53         }
  54
  55         function login($company, $loginname, $password)
  56         {
  57                 global $security_areas, $security_groups, $security_headings, $path_to_root;
  58
  59                 $this->set_company($company);
  60             $this->logged = false;
  61
  62                 $Auth_Result = get_user_for_login($loginname, $password);
  63
  64                 if (db_num_rows($Auth_Result) > 0)
  65                 {
  66                         $myrow = db_fetch($Auth_Result);
  67                         $this->old_db = isset($myrow["full_access"]);
  68                         if (! @$myrow["inactive"]) {
  69                                 if ($this->old_db) {
  70                                         // Transition code:
  71                                         // db was not yet upgraded after source update to v.2.2
  72                                         // give enough access for admin user to continue upgrade
  73                                         if (!isset($security_groups) || !isset($security_headings)) {
  74                                                 echo "<center><br><br><font size='5' color='red'><b>";
  75                                                 echo _('Before software upgrade you have to include old $security_groups and $security_headings arrays from old config.php file to the new one.');
  76                                                 echo '<br>'."<a href=$path_to_root/index.php>"._("Back")."</a>";
  77                                                 echo "</b></font><br><br></center>";
  78                                                 exit;
  79                                         }
  80                             $this->access = $myrow["full_access"];
  81                             if (in_array(20, $security_groups[$this->access]))
  82                                                 // temporary access for admin users
  83                                                 $this->role_set[] = $security_areas['SA_SOFTWAREUPGRADE'][0];
  84                                         else {
  85                                                 echo "<center><br><br><font size='5' color='red'><b>";
  86                                                 echo _('System is available for site admin only until full database upgrade');
  87                                                 echo "</b></font><br><br></center>";
  88                                                 exit;
  89                                         }
  90                         } else {
  91                                         $this->role_set = array();
  92                             $this->access = $myrow["role_id"];
  93                                         // store area codes available for current user role
  94                                         $role = get_security_role($this->access);
  95                                         if (!$role)
  96                                                 return false;
  97                                         foreach( $role['areas'] as $code )
  98                                                 // filter only area codes for enabled security sections
  99                                                 if (in_array($code&~0xff, $role['sections']))
 100                                                         $this->role_set[] = $code;
 101                         }
 102                     $this->name = $myrow["real_name"];
 103                     $this->pos = $myrow["pos"];
 104                     $this->loginname = $loginname;
 105                     $this->username = $this->loginname;
 106                     $this->prefs = new user_prefs($myrow);
 107                     $this->user = @$myrow["id"];
 108                         update_user_visitdate($this->username);
 109                         $this->logged = true;
 110                                 $this->last_act = time();
 111                                 $this->timeout = session_timeout();
 112                         }
 113                 }
 114                 return $this->logged;
 115         }
 116
 117         function check_user_access()
 118         {
 119                 global $security_groups;
 120                 if ($this->old_db) {
 121                         // notification after upgrade from pre-2.2 version
 122                         return isset($security_groups) && is_array(@$security_groups[$this->access]);
 123                 } else
 124                         return !isset($security_groups) && is_array($this->role_set);
 125         }
 126
 127         function can_access($page_level)
 128         {
 129                 global $security_groups, $security_areas;
 130                 if (isset($security_groups)) {
 131                         return $this->company == 0 &&
 132                                 in_array(20, $security_groups[$this->access]);
 133                 }
 134
 135                 if ($page_level === 'SA_OPEN')
 136                         return true;
 137                 if ($page_level === 'SA_DENIED' || $page_level === '')
 138                         return false;
 139
 140                 $code = $security_areas[$page_level][0];
 141
 142                 // only first registered company has site admin privileges
 143                 return $code && in_array($code, $this->role_set)
 144                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
 145         }
 146
 147         function can_access_page($page_level)
 148         {
 149                 return $this->can_access($page_level);
 150         }
 151
 152         function get_db_connection($id=-1)
 153         {
 154         global $db_connections;
 155
 156         $connection = $db_connections[$id == -1 ? $this->company : $id];
 157
 158         //print_r($connection);
 159
 160         $db = mysql_connect($connection["host"] ,
 161                 $connection["dbuser"], $connection["dbpassword"]);
 162         mysql_select_db($connection["dbname"],$db);
 163
 164                 if (!defined('TB_PREF'))
 165                         define('TB_PREF', $connection["tbpref"]);
 166
 167         return $db;
 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 function number_format2($number, $decimals=0)
 191 {
 192         global $thoseps, $decseps;
 193         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
 194         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
 195         //return number_format($number, $decimals, $dsep,       $tsep);
 196         $delta = ($number < 0 ? -.0000000001 : .0000000001);
 197         return number_format($number+$delta, $decimals, $dsep,  $tsep);
 198 }
 199 //
 200 //      Current ui mode.
 201 //
 202 function fallback_mode() {
 203     return $_SESSION["wa_current_user"]->ui_mode==0;
 204 }
 205
 206 function price_format($number) {
 207     return number_format2($number,
 208         $_SESSION["wa_current_user"]->prefs->price_dec());
 209 }
 210
 211 function price_decimal_format($number, &$dec)
 212 {
 213         $dec = user_price_dec();
 214         $str = strval($number);
 215         $pos = strpos($str, '.');
 216         if ($pos !== false)
 217         {
 218                 $len = strlen(substr($str, $pos + 1));
 219                 if ($len > $dec)
 220                         $dec = $len;
 221         }
 222         return number_format2($number, $dec);
 223 }
 224 // function money_format doesn't exist in OS Win.
 225 if (!function_exists('money_format'))
 226 {
 227         function money_format($format, $number)
 228         {
 229                 return price_format($number);
 230         }
 231 }
 232
 233 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
 234 //--------------------------------------------------------------------
 235 function qty_format($number, $stock_id=null, &$dec) {
 236         $dec = get_qty_dec($stock_id);
 237     return number_format2($number, $dec);
 238 }
 239 // and get_qty_dec
 240 function get_qty_dec($stock_id=null)
 241 {
 242         global $path_to_root;
 243         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
 244         if ($stock_id != null)
 245                 $dec = get_unit_dec($stock_id);
 246         if ($stock_id == null || $dec == -1 || $dec == null)
 247                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
 248         return $dec;
 249 }
 250 //-------------------------------------------------------------------
 251 function exrate_format($number) {
 252     return number_format2($number,
 253         $_SESSION["wa_current_user"]->prefs->exrate_dec());
 254 }
 255
 256 function percent_format($number) {
 257     return number_format2($number,
 258         $_SESSION["wa_current_user"]->prefs->percent_dec());
 259 }
 260
 261 function user_numeric($input) {
 262     global $decseps, $thoseps;
 263
 264     $num = trim($input);
 265     $sep = $thoseps[user_tho_sep()];
 266     if ($sep!='')
 267         $num = str_replace( $sep, '', $num);
 268
 269     $sep = $decseps[user_dec_sep()];
 270     if ($sep!='.')
 271         $num = str_replace( $sep, '.', $num);
 272
 273     if (!is_numeric($num))
 274           return false;
 275     $num = (float)$num;
 276     if ($num == (int)$num)
 277           return (int)$num;
 278     else
 279           return $num;
 280 }
 281
 282 function user_company()
 283 {
 284         global $def_coy;
 285
 286         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
 287 }
 288
 289 function user_pos()
 290 {
 291         return $_SESSION["wa_current_user"]->pos;
 292 }
 293
 294 function user_language()
 295 {
 296         return $_SESSION["wa_current_user"]->prefs->language();
 297 }
 298
 299 function user_qty_dec()
 300 {
 301         return $_SESSION["wa_current_user"]->prefs->qty_dec();
 302 }
 303
 304 function user_price_dec()
 305 {
 306         return $_SESSION["wa_current_user"]->prefs->price_dec();
 307 }
 308
 309 function user_exrate_dec()
 310 {
 311         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
 312 }
 313
 314 function user_percent_dec()
 315 {
 316         return $_SESSION["wa_current_user"]->prefs->percent_dec();
 317 }
 318
 319 function user_show_gl_info()
 320 {
 321         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
 322 }
 323
 324 function user_show_codes()
 325 {
 326         return $_SESSION["wa_current_user"]->prefs->show_codes();
 327 }
 328
 329 function user_date_format()
 330 {
 331         return $_SESSION["wa_current_user"]->prefs->date_format();
 332 }
 333
 334 function user_date_display()
 335 {
 336         return $_SESSION["wa_current_user"]->prefs->date_display();
 337 }
 338
 339 function user_date_sep()
 340 {
 341         return $_SESSION["wa_current_user"]->prefs->date_sep();
 342 }
 343
 344 function user_tho_sep()
 345 {
 346         return $_SESSION["wa_current_user"]->prefs->tho_sep();
 347 }
 348
 349 function user_dec_sep()
 350 {
 351         return $_SESSION["wa_current_user"]->prefs->dec_sep();
 352 }
 353
 354 function user_theme()
 355 {
 356         return $_SESSION["wa_current_user"]->prefs->get_theme();
 357 }
 358
 359 function user_pagesize()
 360 {
 361         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
 362 }
 363
 364 function user_hints()
 365 {
 366         return $_SESSION["wa_current_user"]->prefs->show_hints();
 367 }
 368
 369 function user_print_profile()
 370 {
 371         return $_SESSION["wa_current_user"]->prefs->print_profile();
 372 }
 373
 374 function user_rep_popup()
 375 {
 376         return $_SESSION["wa_current_user"]->prefs->rep_popup();
 377 }
 378
 379 function user_query_size()
 380 {
 381         return $_SESSION["wa_current_user"]->prefs->query_size();
 382 }
 383
 384 function user_graphic_links()
 385 {
 386         return $_SESSION["wa_current_user"]->prefs->graphic_links();
 387 }
 388
 389 function sticky_doc_date()
 390 {
 391         return $_SESSION["wa_current_user"]->prefs->sticky_date();
 392 }
 393
 394 function user_startup_tab()
 395 {
 396         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
 397 }
 398
 399 function set_user_prefs($prefs)
 400 {
 401         $_SESSION["wa_current_user"]->update_prefs($prefs);
 402 }
 403
 404 function add_user_js_data() {
 405         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
 406
 407         $ts = $thoseps[user_tho_sep()];
 408         $ds = $decseps[user_dec_sep()];
 409
 410     $js = "\n"
 411           . "var user = {\n"
 412           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
 413           . "loadtxt: '"._('Requesting data...')."',\n"
 414           . "date: '".Today()."',\n"    // server date
 415           . "datesys: ".$date_system.",\n"
 416           . "datefmt: ".user_date_format().",\n"
 417           . "datesep: '".$dateseps[user_date_sep()]."',\n"
 418           . "ts: '$ts',\n"
 419           . "ds: '$ds',\n"
 420           . "pdec : " . user_price_dec() . "}\n";
 421
 422   add_js_source($js);
 423 }
 424
 425 //--------------------------------------------------------------------------
 426
 427 function session_timeout()
 428 {
 429         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
 430         return $tout ? $tout : ini_get('session.gc_maxlifetime');
 431 }
 432
 433 //-----------------------------------------------------------------------------
 434 //      Inserts $elements into $array at position $index.
 435 //      $elements is list of any objects
 436 //
 437 function array_insert(&$array, $index, $elements)
 438 {
 439         if (!is_array($elements)) $elements = array($elements);
 440
 441         $head  = array_splice($array, 0, $index);
 442         $array = array_merge($head, $elements, $array);
 443 }
 444
 445 function array_remove(&$array, $index, $len=1)
 446 {
 447         array_splice($array, $index, $len);
 448 }
 449
 450 function array_substitute(&$array, $index, $len, $elements)
 451 {
 452         array_splice($array, $index, $len);
 453         array_insert($array, $index, $elements);
 454 }
 455
 456 function array_append(&$array, $elements)
 457 {
 458         foreach($elements as $key => $el) {
 459                 if(is_int($key))
 460                         $array[] = $el;
 461                 else
 462                         $array[$key] = $el;
 463         }
 464 }
 465 //
 466 //      Search $needle in $haystack or in $haystack[][$valuekey]
 467 //      returns $needle found or null.
 468 //
 469 function array_search_value($needle, $haystack, $valuekey=null)
 470 {
 471         foreach($haystack as $key => $value) {
 472                 $val = isset($valuekey) ? $value[$valuekey] : $value;
 473                 if ($needle == $val){
 474                         return $value;
 475                 }
 476         }
 477         return null;
 478 }
 479 //
 480 //      Search $needle in $haystack or in $haystack[][$valuekey]
 481 //      returns array of keys of $haystack elements found
 482 //
 483 function array_search_keys($needle, $haystack, $valuekey=null)
 484 {
 485         $keys = array();
 486         if($haystack)
 487                 foreach($haystack as $key => $value) {
 488                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
 489                         if ($needle == $val){
 490                                 $keys[] = $key;
 491                         }
 492                 }
 493         return $keys;
 494 }
 495 //
 496 //      Find first (single) $needle in $haystack or in $haystack[][$valuekey]
 497 //      returns $haystack element found or null
 498 //
 499 function array_search_key($needle, $haystack, $valuekey=null)
 500 {
 501         $keys = array_search_keys($needle, $haystack, $valuekey);
 502         return @$keys[0];
 503 }
 504
 505 function flush_dir($path, $wipe = false)
 506 {
 507         $dir = opendir($path);
 508         while(false !== ($fname = readdir($dir))) {
 509                 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
 510                 if(is_dir($path.'/'.$fname)) {
 511                     flush_dir($path.'/'.$fname, $wipe);
 512                     if ($wipe) @rmdir($path.'/'.$fname);
 513                 } else
 514                     @unlink($path.'/'.$fname);
 515         }
 516 }
 517 /*
 518         Returns current path to company private folder.
 519         (Current path can change after chdir).
 520 */
 521 function company_path($comp=null)
 522 {
 523         global $path_to_root, $comp_path;
 524
 525         if (!isset($comp))
 526                 $comp = user_company();
 527
 528         // if path is relative, set current path_to_root
 529         return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
 530                         . '/'.$comp;
 531 }
 532
 533 ?>