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