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