PHP 8 rerun of number_format fix.
[fa-stable.git] / 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 $email;
26         var $company; // user's company
27         var $pos;
28         var $access;
29         var $timeout;
30         var $last_act;
31         var $role_set = false;
32         var $old_db;
33         var $logged;
34         var $ui_mode = 0;
35         var $login_attempt=0;
36         
37         var $prefs;
38         var $cur_con; // current db connection (can be different from $company for superuser)
39
40         function __construct()
41         {
42                 global $def_coy;
43                 
44                 $this->loginname = $this->username = $this->name = "";
45                 $this->company = isset($def_coy)? $def_coy : 0;
46                 $this->logged = false;
47
48                 $this->prefs = new user_prefs();
49         }
50
51         function logged_in()
52         {
53                 return $this->logged;
54         }
55
56         function set_company($company)
57         {
58                 $this->company = (int)$company;
59         }
60
61         function login($company, $loginname, $password)
62         {
63                 global $security_areas, $security_groups, $security_headings, $path_to_root, $dflt_lang, $SysPrefs;
64
65                 $this->set_company($company);
66             $this->logged = false;
67
68                 set_global_connection($company);
69                 $lang = &$_SESSION['language'];
70                 $lang->set_language($_SESSION['language']->code);
71                 db_set_encoding($_SESSION['language']->encoding);
72
73                 // Use external authentication source if any.
74                 // Keep in mind you need to have user data set for $loginname
75                 // in FA users table anyway to successfully log in.
76                 $Auth_Result = hook_authenticate($loginname, $password);
77
78                 if (!isset($Auth_Result))       // if not used: standard method
79                         $Auth_Result = get_user_auth($loginname, md5($password));
80
81                 if ($SysPrefs->login_delay > 0)
82                         write_login_filelog($loginname, $Auth_Result);
83
84                 if ($Auth_Result)
85                 {
86                         $myrow = get_user_by_login($loginname);
87                         if ($myrow['language'] != $dflt_lang)
88                         {        // refresh language and user data
89                                 $lang->set_language($myrow['language']);
90                                 db_set_encoding($_SESSION['language']->encoding);
91                                 $myrow = get_user_by_login($loginname);
92                         }
93
94                         $this->old_db = isset($myrow["full_access"]);
95                         if (! @$myrow["inactive"]) {
96                                 if ($this->old_db) { 
97                                         // Transition code:
98                                         // db was not yet upgraded after source update to v.2.2
99                                         // give enough access for admin user to continue upgrade
100                                         if (!isset($security_groups) || !isset($security_headings)) {
101                                                 echo "<center><br><br><font size='5' color='red'><b>";
102                                                 echo _('Before software upgrade you have to include old $security_groups and $security_headings arrays from old config.php file to the new one.');
103                                                 echo '<br>'."<a href=$path_to_root/index.php>"._("Back")."</a>";
104                                                 echo "</b></font><br><br></center>";
105                                                 exit;
106                                         }
107                             $this->access = $myrow["full_access"];
108                             if (in_array(20, $security_groups[$this->access]))
109                                                 // temporary access for admin users
110                                                 $this->role_set[] = $security_areas['SA_SOFTWAREUPGRADE'][0];
111                                         else {
112                                                 echo "<center><br><br><font size='5' color='red'><b>";
113                                                 echo _('System is available for site admin only until full database upgrade');
114                                                 echo "</b></font><br><br></center>";
115                                                 exit;
116                                         }
117                         } else {
118                                         $this->role_set = array();
119                             $this->access = $myrow["role_id"];
120                                         // store area codes available for current user role
121                                         $role = get_security_role($this->access);
122                                         if (!$role) 
123                                                 return false;
124                                         foreach( $role['areas'] as $code )
125                                                 // filter only area codes for enabled security sections
126                                                 if (in_array($code&~0xff, $role['sections'])) 
127                                                         $this->role_set[] = $code;
128                         }
129                     $this->name = $myrow["real_name"];
130                     $this->pos = $myrow["pos"];
131                     $this->loginname = $loginname;
132                     $this->username = $this->loginname;
133                     $this->prefs = new user_prefs($myrow);
134                     $this->user = @$myrow["id"];
135                 $this->email = @$myrow["email"];
136                         update_user_visitdate($this->username);
137                         $this->logged = true;
138                         $this->login_attempt=0;
139                                 $this->last_act = time();
140                                 $this->timeout = session_timeout();
141                                 flush_dir(user_js_cache()); // refresh cache on login
142                         }
143                 }
144                 return $this->logged;
145         }
146
147         function reset_password($company, $email) {
148                 global $SysPrefs;
149
150                 $this->set_company($company);
151                 $this->logged = false;
152
153                 set_global_connection();
154
155                 $user = get_user_by_email($email);
156
157                 if ($user != false) {
158
159                         $password = generate_password();
160                         $hash = md5($password);
161
162                         update_user_password($user['id'], $user['user_id'], $hash);
163                         
164                         $sender = get_company_pref('email');
165                         if (empty($sender))
166                                 $header = "";
167                         else
168                                 $header = "From: $sender";
169
170                         mail($email, _("New password for")." ".$SysPrefs->app_title, $password, $header);
171
172                         return true;
173                 }
174                 return false;
175     }
176
177         function check_user_access()
178         {
179                 global $security_groups;
180                 if ($this->old_db) {
181                         // notification after upgrade from pre-2.2 version
182                         return isset($security_groups) && is_array(@$security_groups[$this->access]);
183                 } else
184                         return !isset($security_groups) && is_array($this->role_set);
185         }
186
187         function can_access($sec_area)
188         {
189                 global $security_groups, $security_areas;
190                 if (isset($security_groups)) {
191                         return is_admin_company() &&
192                                 in_array(20, $security_groups[$this->access]);
193                 }
194
195                 if ($sec_area === 'SA_OPEN') 
196                         return true;
197                 if ($sec_area === 'SA_DENIED' || $sec_area === '') 
198                         return false;
199
200                 $code = $security_areas[$sec_area][0];
201
202                 // only first registered company has site admin privileges
203                 return $code && in_array($code, $this->role_set)
204                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
205         }
206
207         function can_access_page($page_level)
208         {
209                 return $this->can_access($page_level);
210         }
211
212         function check_application_access($waapp)
213         {
214                 if (!$this->hide_inaccessible_menu_items())
215                 {
216                         return true;
217                 }
218
219                 foreach ($waapp->modules as $module)
220                 {
221                         if ($this->check_module_access($module))
222                         {
223                                 return true;
224                         }
225                 }
226
227                 return false;
228
229         }
230
231         function check_module_access($module)
232         {
233
234                 if (!$this->hide_inaccessible_menu_items())
235                 {
236                         return true;
237                 }
238
239                 if (sizeof($module->lappfunctions) > 0)
240                 {
241                         foreach ($module->lappfunctions as $appfunction)
242                         {
243                                 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
244                                 {
245                                         return true;
246                                 }
247                         }
248                 }
249
250                 if (sizeof($module->rappfunctions) > 0)
251                 {
252                         foreach ($module->rappfunctions as $appfunction)
253                         {
254                                 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
255                                 {
256                                         return true;
257                                 }
258                         }
259                 }
260
261                 return false;
262
263         }
264
265         function hide_inaccessible_menu_items()
266         {
267                 global $SysPrefs;
268
269                 if (!isset($SysPrefs->hide_inaccessible_menu_items) || $SysPrefs->hide_inaccessible_menu_items == 0)
270                 {
271                         return false;
272                 }
273
274                 else
275                 {
276                         return true;
277                 }
278         }
279
280         function set_db_connection($id = -1)
281         {
282                 return set_global_connection($id);
283         }
284
285         function update_prefs($prefs)
286         {
287                 global $SysPrefs;
288
289                 if (!$SysPrefs->allow_demo_mode) {
290                         update_user_prefs($this->user, $prefs);
291                 }
292
293                 $this->prefs = new user_prefs(get_user($this->user));
294         }
295 }
296
297 //--------------------------------------------------------------------------
298
299 function round2($number, $decimals=0)
300 {
301         $delta = ($number < 0 ? -.0000000001 : .0000000001);
302         return round($number+$delta, $decimals);
303 }
304
305 /*
306         Returns number formatted according to user setup and using $decimals digits after dot 
307         (defualt is 0). When $decimals is set to 'max' maximum available precision is used 
308         (decimals depend on value) and trailing zeros are trimmed.
309 */
310 function number_format2($number, $decimals=0)
311 {
312         global $SysPrefs;
313         $tsep = $SysPrefs->thoseps[user_tho_sep()];
314         $dsep = $SysPrefs->decseps[user_dec_sep()];
315
316         $number = (float)$number;
317         if($decimals==='max')
318                 $dec = 15 - floor(log10(abs($number)));
319         else {
320                 $delta = ($number < 0 ? -.0000000001 : .0000000001);
321                 $number += $delta;
322                 $dec = $decimals;
323         }
324
325         $num = number_format($number, intval($dec), $dsep, $tsep);
326
327         return $decimals==='max' ? rtrim($num, '0') : $num;
328
329 }
330
331 /* price/float comparision helper to be used in any suspicious place for zero values? 
332 usage:
333 if (!floatcmp($value1, $value2)) 
334         compare value is 0
335 */
336
337 define('FLOAT_COMP_DELTA', 0.004);
338
339 function floatcmp($a, $b)
340 {
341     return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
342 }
343
344 //
345 //      Current ui mode.
346 //
347 function fallback_mode() {
348     return $_SESSION["wa_current_user"]->ui_mode==0;
349 }
350
351 function price_format($number) {
352     return number_format2($number, user_price_dec());
353 }
354
355 function price_decimal_format($number, &$dec)
356 {
357         $dec = user_price_dec();
358         $str = strval($number);
359         $pos = strpos($str, '.');
360         if ($pos !== false)
361         {
362                 $len = strlen(substr($str, $pos + 1));
363                 if ($len > $dec && $len < ini_get('precision')-3)
364                         $dec = $len;
365         }
366         return number_format2($number, $dec);
367 }
368
369 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
370 //--------------------------------------------------------------------
371 function qty_format($number, $stock_id, &$dec) {
372         $dec = get_qty_dec($stock_id);
373     return number_format2($number, $dec);
374 }
375
376 // and get_qty_dec
377 function get_qty_dec($stock_id=null)
378 {
379         global $path_to_root;
380         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
381         if ($stock_id != null)
382                 $dec = get_unit_dec($stock_id);
383         if ($stock_id == null || $dec == -1 || $dec == null)
384                 $dec = user_qty_dec();
385         return $dec;
386 }
387 //-------------------------------------------------------------------
388 //
389 //      Maximum precision format. Strips trailing unsignificant digits.
390 //
391 function maxprec_format($number) {
392     return number_format2($number, 'max');
393 }
394
395 function exrate_format($number) {
396     return number_format2($number,
397         $_SESSION["wa_current_user"]->prefs->exrate_dec());
398 }
399
400 function percent_format($number) {
401     return number_format2($number,
402         $_SESSION["wa_current_user"]->prefs->percent_dec());
403 }
404
405 function user_numeric($input) {
406     global $SysPrefs;
407
408     $num = trim($input);
409     $sep = $SysPrefs->thoseps[user_tho_sep()];
410     if ($sep!='')
411         $num = str_replace( $sep, '', $num);
412
413     $sep = $SysPrefs->decseps[user_dec_sep()];
414     if ($sep!='.')
415         $num = str_replace( $sep, '.', $num);
416
417     if (!is_numeric($num))
418                 return false;
419     $num = (float)$num;
420     if ($num == (int)$num)
421                 return (int)$num;
422     else
423                 return $num;
424 }
425
426 function user_company()
427 {
428         global $def_coy;
429         
430         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
431 }
432
433 function user_pos()
434 {
435         return $_SESSION["wa_current_user"]->pos;
436 }
437
438 function user_language()
439 {
440         return $_SESSION["wa_current_user"]->prefs->language();
441 }
442
443 function user_qty_dec()
444 {
445         return $_SESSION["wa_current_user"]->prefs->qty_dec();
446 }
447
448 function user_price_dec()
449 {
450         global $SysPrefs;
451
452         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->price_dec() : 2;
453 }
454
455 function user_exrate_dec()
456 {
457         global $SysPrefs;
458
459         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->exrate_dec() : 4;
460 }
461
462 function user_percent_dec()
463 {
464         global $SysPrefs;
465
466         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->percent_dec() : 1;
467 }
468
469 function user_show_gl_info()
470 {
471         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
472 }
473
474 function user_show_codes()
475 {
476         return $_SESSION["wa_current_user"]->prefs->show_codes();
477 }
478
479 function user_date_format()
480 {
481         global $SysPrefs;
482
483         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_format() : $SysPrefs->dflt_date_fmt;
484 }
485
486 function user_date_display()
487 {
488         $fmt ='m/d/Y';
489         if (isset($_SESSION["wa_current_user"])) {
490                 $fmt = $_SESSION["wa_current_user"]->prefs->date_display();
491         } else {
492                 $sep = user_date_sep();
493                 $user_date_fmt = user_date_format();
494                 switch ($user_date_fmt) {
495                         case 0:
496                         $fmt = "m".$sep."d".$sep."Y"; break;
497                         case 1:
498                         $fmt = "d".$sep."m".$sep."Y"; break;
499                         case 2:
500                         $fmt = "Y".$sep."m".$sep."d"; break;
501                         case 3:
502                         $fmt = "M".$sep."j".$sep."Y"; break;
503                         case 4:
504                         $fmt = "j".$sep."M".$sep."Y"; break;
505                         default:
506                         $fmt = "Y".$sep."M".$sep."j";
507                 }
508         }
509 }
510
511 function user_date_sep()
512 {
513         global $SysPrefs;
514
515         return isset($_SESSION["wa_current_user"]->prefs->date_sep) ? $_SESSION["wa_current_user"]->prefs->date_sep() : $SysPrefs->dflt_date_sep;
516 }
517
518 function user_tho_sep()
519 {
520         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->tho_sep() : 0;
521 }
522
523 function user_dec_sep()
524 {
525         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->dec_sep() : 0;
526 }
527
528 function user_theme()
529 {
530         return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
531 }
532
533 function user_pagesize()
534 {
535         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
536 }
537
538 function user_hints()
539 {
540         return $_SESSION["wa_current_user"]->prefs->show_hints();
541 }
542
543 function user_print_profile()
544 {
545         return $_SESSION["wa_current_user"]->prefs->print_profile();
546 }
547
548 function user_rep_popup()
549 {
550         return $_SESSION["wa_current_user"]->prefs->rep_popup();
551 }
552
553 function user_query_size()
554 {
555         return $_SESSION["wa_current_user"]->prefs->query_size();
556 }
557
558 function user_graphic_links()
559 {
560         return $_SESSION["wa_current_user"]->prefs->graphic_links();
561 }
562
563 function sticky_doc_date()
564 {
565         return $_SESSION["wa_current_user"]->prefs->sticky_date();
566 }
567
568 function user_startup_tab()
569 {
570         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
571 }
572
573 function user_transaction_days()
574 {
575     return $_SESSION["wa_current_user"]->prefs->transaction_days();
576 }
577
578 function user_save_report_selections()
579 {
580     return $_SESSION["wa_current_user"]->prefs->save_report_selections();
581 }
582
583 function user_use_date_picker()
584 {
585     return $_SESSION["wa_current_user"]->prefs->use_date_picker();
586 }
587
588 function user_def_print_destination()
589 {
590     return $_SESSION["wa_current_user"]->prefs->def_print_destination();
591 }
592
593 function user_def_print_orientation()
594 {
595     return $_SESSION["wa_current_user"]->prefs->def_print_orientation();
596 }
597
598 function user_check_access($sec_area)
599 {
600         return $_SESSION["wa_current_user"]->can_access($sec_area);
601 }
602
603 function set_user_prefs($prefs)
604 {
605         $_SESSION["wa_current_user"]->update_prefs($prefs);
606 }
607
608 function add_user_js_data() {
609         global $path_to_root, $SysPrefs;
610
611         $ts = $SysPrefs->thoseps[user_tho_sep()];
612         $ds = $SysPrefs->decseps[user_dec_sep()];
613
614     $js = "\n"
615           . "var user = {\n"
616           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
617           . "loadtxt: '"._('Requesting data...')."',\n"
618           . "date: '".Today()."',\n"    // server date
619           . "datesys: ".$SysPrefs->date_system.",\n"
620           . "datefmt: ".user_date_format().",\n"
621           . "datesep: '".$SysPrefs->dateseps[user_date_sep()]."',\n"
622           . "ts: '$ts',\n"
623           . "ds: '$ds',\n"
624           . "pdec : " . user_price_dec() . "}\n";
625
626   add_js_source($js);
627 }
628
629 function user_js_cache($id=null)
630 {
631         global $path_to_root;
632
633         if (!$id)
634                 $id = @$_SESSION['wa_current_user']->user;
635
636         if (!$id)
637                 $id = 0; // before login
638         return $path_to_root.'/company/'.user_company().'/js_cache/'.$id;
639 }
640
641 //--------------------------------------------------------------------------
642
643 function session_timeout()
644 {
645         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
646         return $tout ? $tout : ini_get('session.gc_maxlifetime');
647 }
648
649 //-----------------------------------------------------------------------------
650 //      Inserts $elements into $array at position $index.
651 //      $elements is list of any objects
652 //
653 function array_insert(&$array, $index, $elements)
654 {
655         if (!is_array($elements)) $elements = array($elements);
656
657         $head  = array_splice($array, 0, $index);
658         $array = array_merge($head, $elements, $array);
659 }
660
661 function array_remove(&$array, $index, $len=1)
662 {
663         array_splice($array, $index, $len);
664 }
665
666 function array_substitute(&$array, $index, $len, $elements)
667 {
668         array_splice($array, $index, $len);
669         array_insert($array, $index, $elements);
670 }
671
672 function array_append(&$array, $elements)
673 {
674         foreach($elements as $key => $el) {
675                 if(is_int($key))
676                         $array[] = $el;
677                 else
678                         $array[$key] = $el;
679         }
680 }
681 //
682 //      Search $needle in $haystack or in $haystack[][$valuekey]
683 //      returns $needle found or null.
684 //
685 function array_search_value($needle, $haystack, $valuekey=null)
686 {
687         if (is_array($haystack)) {
688                 foreach($haystack as $key => $value) {
689                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
690                         if ($needle == $val){
691                                 return $value;
692                         }
693                 }
694         }
695         return null;
696 }
697 //
698 //      Search $needle in $haystack or in $haystack[][$valuekey]
699 //      returns array of keys of $haystack elements found
700 //
701 function array_search_keys($needle, $haystack, $valuekey=null)
702 {
703         $keys = array();
704         if (is_array($haystack)) {
705                 foreach($haystack as $key => $value) {
706                         $val = isset($valuekey) ? @$value[$valuekey] : $value;
707                         if ($needle == $val){
708                                 $keys[] = $key;
709                         }
710                 }
711         }       
712         return $keys;
713 }
714 //
715 //      Find first (single) $needle in $haystack or in $haystack[][$valuekey]
716 //      returns $haystack element found or null
717 //
718 function array_search_key($needle, $haystack, $valuekey=null)
719 {
720         $keys = array_search_keys($needle, $haystack, $valuekey);
721         return @$keys[0];
722 }
723
724 // Recalculate report columns if orientation is landscape.
725 function recalculate_cols(&$cols)
726 {
727         $factor = (user_pagesize() == "A4" ? 1.4 : 1.3);
728         foreach($cols as $key => $col)
729                 $cols[$key] = intval($col * $factor); 
730 }
731
732 function flush_dir($path, $wipe = false) 
733 {
734         if (!file_exists($path))
735                 return;
736         $dir = @opendir($path);
737         if(!$dir)
738                 return;
739
740         while(false !== ($fname = readdir($dir))) {
741                 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
742                 if(is_dir($path.'/'.$fname)) {
743                     flush_dir($path.'/'.$fname, $wipe);
744                     if ($wipe) @rmdir($path.'/'.$fname);
745                 } else
746                     @unlink($path.'/'.$fname);
747         }
748 }
749 /*
750         Returns current path to company private folder.
751         (Current path can change after chdir).
752 */
753 function company_path($comp=null)
754 {
755         global $path_to_root, $SysPrefs;
756
757         $comp_path = $SysPrefs->comp_path;
758
759
760         if (!isset($comp))
761                 $comp = user_company();
762
763         // if path is relative, set current path_to_root
764         return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
765                         . '/'.$comp;
766 }
767
768 function is_admin_company()
769 {
770         return $this->company == 0;
771 }
772