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 ***********************************************************************/
13 include_once($path_to_root . "/includes/prefs/userprefs.inc");
14 if (!defined('TB_PREF')) {
15 define('TB_PREF', '&TB_PREF&');
17 //--------------------------------------------------------------------------
26 var $company; // user's company
31 var $role_set = false;
38 var $cur_con; // current db connection (can be different from $company for superuser)
40 function __construct()
44 $this->loginname = $this->username = $this->name = "";
45 $this->company = isset($def_coy)? $def_coy : 0;
46 $this->logged = false;
48 $this->prefs = new user_prefs();
56 function set_company($company)
58 $this->company = (int)$company;
61 function login($company, $loginname, $password)
63 global $security_areas, $security_groups, $security_headings, $path_to_root, $dflt_lang, $SysPrefs;
65 $this->set_company($company);
66 $this->logged = false;
68 set_global_connection($company);
69 $lang = &$_SESSION['language'];
70 $lang->set_language($_SESSION['language']->code);
71 db_set_encoding($_SESSION['language']->encoding);
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);
78 if (!isset($Auth_Result)) // if not used: standard method
79 $Auth_Result = get_user_auth($loginname, md5($password));
81 if ($SysPrefs->login_delay > 0)
82 write_login_filelog($loginname, $Auth_Result);
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);
94 $this->old_db = isset($myrow["full_access"]);
95 if (! @$myrow["inactive"]) {
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>";
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];
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>";
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);
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;
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
144 return $this->logged;
147 function reset_password($company, $email) {
150 $this->set_company($company);
151 $this->logged = false;
153 set_global_connection();
155 $user = get_user_by_email($email);
157 if ($user != false) {
159 $password = generate_password();
160 $hash = md5($password);
162 update_user_password($user['id'], $user['user_id'], $hash);
164 $sender = get_company_pref('email');
168 $header = "From: $sender";
170 mail($email, _("New password for")." ".$SysPrefs->app_title, $password, $header);
177 function check_user_access()
179 global $security_groups;
181 // notification after upgrade from pre-2.2 version
182 return isset($security_groups) && is_array(@$security_groups[$this->access]);
184 return !isset($security_groups) && is_array($this->role_set);
187 function can_access($sec_area)
189 global $security_groups, $security_areas;
190 if (isset($security_groups)) {
191 return is_admin_company() &&
192 in_array(20, $security_groups[$this->access]);
195 if ($sec_area === 'SA_OPEN')
197 if ($sec_area === 'SA_DENIED' || $sec_area === '')
200 $code = $security_areas[$sec_area][0];
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));
207 function can_access_page($page_level)
209 return $this->can_access($page_level);
212 function check_application_access($waapp)
214 if (!$this->hide_inaccessible_menu_items())
219 foreach ($waapp->modules as $module)
221 if ($this->check_module_access($module))
231 function check_module_access($module)
234 if (!$this->hide_inaccessible_menu_items())
239 if (sizeof($module->lappfunctions) > 0)
241 foreach ($module->lappfunctions as $appfunction)
243 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
250 if (sizeof($module->rappfunctions) > 0)
252 foreach ($module->rappfunctions as $appfunction)
254 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
265 function hide_inaccessible_menu_items()
269 if (!isset($SysPrefs->hide_inaccessible_menu_items) || $SysPrefs->hide_inaccessible_menu_items == 0)
280 function set_db_connection($id = -1)
282 return set_global_connection($id);
285 function update_prefs($prefs)
289 if (!$SysPrefs->allow_demo_mode) {
290 update_user_prefs($this->user, $prefs);
293 $this->prefs = new user_prefs(get_user($this->user));
297 //--------------------------------------------------------------------------
299 function round2($number, $decimals=0)
301 $delta = ($number < 0 ? -.0000000001 : .0000000001);
302 return round($number+$delta, $decimals);
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.
310 function number_format2($number, $decimals=0)
313 $tsep = $SysPrefs->thoseps[user_tho_sep()];
314 $dsep = $SysPrefs->decseps[user_dec_sep()];
318 if($decimals==='max')
319 $dec = 15 - floor(log10(abs($number)));
321 $delta = ($number < 0 ? -.0000000001 : .0000000001);
326 $num = number_format($number, intval($dec), $dsep, $tsep);
328 return $decimals==='max' ? rtrim($num, '0') : $num;
332 /* price/float comparision helper to be used in any suspicious place for zero values?
334 if (!floatcmp($value1, $value2))
338 define('FLOAT_COMP_DELTA', 0.004);
340 function floatcmp($a, $b)
342 return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
348 function fallback_mode() {
349 return $_SESSION["wa_current_user"]->ui_mode==0;
352 function price_format($number) {
353 return number_format2($number, user_price_dec());
356 function price_decimal_format($number, &$dec)
358 $dec = user_price_dec();
359 $str = strval($number);
360 $pos = strpos($str, '.');
363 $len = strlen(substr($str, $pos + 1));
364 if ($len > $dec && $len < ini_get('precision')-3)
367 return number_format2($number, $dec);
369 // function money_format doesn't exist in OS Win.
370 if (!function_exists('money_format'))
372 function money_format($format, $number)
374 return price_format($number);
378 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
379 //--------------------------------------------------------------------
380 function qty_format($number, $stock_id=null, &$dec) {
381 $dec = get_qty_dec($stock_id);
382 return number_format2($number, $dec);
386 function get_qty_dec($stock_id=null)
388 global $path_to_root;
389 include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
390 if ($stock_id != null)
391 $dec = get_unit_dec($stock_id);
392 if ($stock_id == null || $dec == -1 || $dec == null)
393 $dec = user_qty_dec();
396 //-------------------------------------------------------------------
398 // Maximum precision format. Strips trailing unsignificant digits.
400 function maxprec_format($number) {
401 return number_format2($number, 'max');
404 function exrate_format($number) {
405 return number_format2($number,
406 $_SESSION["wa_current_user"]->prefs->exrate_dec());
409 function percent_format($number) {
410 return number_format2($number,
411 $_SESSION["wa_current_user"]->prefs->percent_dec());
414 function user_numeric($input) {
418 $sep = $SysPrefs->thoseps[user_tho_sep()];
420 $num = str_replace( $sep, '', $num);
422 $sep = $SysPrefs->decseps[user_dec_sep()];
424 $num = str_replace( $sep, '.', $num);
426 if (!is_numeric($num))
429 if ($num == (int)$num)
435 function user_company()
439 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
444 return $_SESSION["wa_current_user"]->pos;
447 function user_language()
449 return $_SESSION["wa_current_user"]->prefs->language();
452 function user_qty_dec()
454 return $_SESSION["wa_current_user"]->prefs->qty_dec();
457 function user_price_dec()
461 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->price_dec() : 2;
464 function user_exrate_dec()
468 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->exrate_dec() : 4;
471 function user_percent_dec()
475 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->percent_dec() : 1;
478 function user_show_gl_info()
480 return $_SESSION["wa_current_user"]->prefs->show_gl_info();
483 function user_show_codes()
485 return $_SESSION["wa_current_user"]->prefs->show_codes();
488 function user_date_format()
492 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_format() : $SysPrefs->dflt_date_fmt;
495 function user_date_display()
498 if (isset($_SESSION["wa_current_user"])) {
499 $fmt = $_SESSION["wa_current_user"]->prefs->date_display();
501 $sep = user_date_sep();
502 $user_date_fmt = user_date_format();
503 switch ($user_date_fmt) {
505 $fmt = "m".$sep."d".$sep."Y"; break;
507 $fmt = "d".$sep."m".$sep."Y"; break;
509 $fmt = "Y".$sep."m".$sep."d"; break;
511 $fmt = "M".$sep."j".$sep."Y"; break;
513 $fmt = "j".$sep."M".$sep."Y"; break;
515 $fmt = "Y".$sep."M".$sep."j";
520 function user_date_sep()
524 return isset($_SESSION["wa_current_user"]->prefs->date_sep) ? $_SESSION["wa_current_user"]->prefs->date_sep() : $SysPrefs->dflt_date_sep;
527 function user_tho_sep()
529 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->tho_sep() : 0;
532 function user_dec_sep()
534 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->dec_sep() : 0;
537 function user_theme()
539 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
542 function user_pagesize()
544 return $_SESSION["wa_current_user"]->prefs->get_pagesize();
547 function user_hints()
549 return $_SESSION["wa_current_user"]->prefs->show_hints();
552 function user_print_profile()
554 return $_SESSION["wa_current_user"]->prefs->print_profile();
557 function user_rep_popup()
559 return $_SESSION["wa_current_user"]->prefs->rep_popup();
562 function user_query_size()
564 return $_SESSION["wa_current_user"]->prefs->query_size();
567 function user_graphic_links()
569 return $_SESSION["wa_current_user"]->prefs->graphic_links();
572 function sticky_doc_date()
574 return $_SESSION["wa_current_user"]->prefs->sticky_date();
577 function user_startup_tab()
579 return $_SESSION["wa_current_user"]->prefs->start_up_tab();
582 function user_transaction_days()
584 return $_SESSION["wa_current_user"]->prefs->transaction_days();
587 function user_save_report_selections()
589 return $_SESSION["wa_current_user"]->prefs->save_report_selections();
592 function user_use_date_picker()
594 return $_SESSION["wa_current_user"]->prefs->use_date_picker();
597 function user_def_print_destination()
599 return $_SESSION["wa_current_user"]->prefs->def_print_destination();
602 function user_def_print_orientation()
604 return $_SESSION["wa_current_user"]->prefs->def_print_orientation();
607 function user_check_access($sec_area)
609 return $_SESSION["wa_current_user"]->can_access($sec_area);
612 function set_user_prefs($prefs)
614 $_SESSION["wa_current_user"]->update_prefs($prefs);
617 function add_user_js_data() {
618 global $path_to_root, $SysPrefs;
620 $ts = $SysPrefs->thoseps[user_tho_sep()];
621 $ds = $SysPrefs->decseps[user_dec_sep()];
625 . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
626 . "loadtxt: '"._('Requesting data...')."',\n"
627 . "date: '".Today()."',\n" // server date
628 . "datesys: ".$SysPrefs->date_system.",\n"
629 . "datefmt: ".user_date_format().",\n"
630 . "datesep: '".$SysPrefs->dateseps[user_date_sep()]."',\n"
633 . "pdec : " . user_price_dec() . "}\n";
638 function user_js_cache($id=null)
640 global $path_to_root;
643 $id = @$_SESSION['wa_current_user']->user;
646 $id = 0; // before login
647 return $path_to_root.'/company/'.user_company().'/js_cache/'.$id;
650 //--------------------------------------------------------------------------
652 function session_timeout()
654 $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
655 return $tout ? $tout : ini_get('session.gc_maxlifetime');
658 //-----------------------------------------------------------------------------
659 // Inserts $elements into $array at position $index.
660 // $elements is list of any objects
662 function array_insert(&$array, $index, $elements)
664 if (!is_array($elements)) $elements = array($elements);
666 $head = array_splice($array, 0, $index);
667 $array = array_merge($head, $elements, $array);
670 function array_remove(&$array, $index, $len=1)
672 array_splice($array, $index, $len);
675 function array_substitute(&$array, $index, $len, $elements)
677 array_splice($array, $index, $len);
678 array_insert($array, $index, $elements);
681 function array_append(&$array, $elements)
683 foreach($elements as $key => $el) {
691 // Search $needle in $haystack or in $haystack[][$valuekey]
692 // returns $needle found or null.
694 function array_search_value($needle, $haystack, $valuekey=null)
696 if (is_array($haystack)) {
697 foreach($haystack as $key => $value) {
698 $val = isset($valuekey) ? @$value[$valuekey] : $value;
699 if ($needle == $val){
707 // Search $needle in $haystack or in $haystack[][$valuekey]
708 // returns array of keys of $haystack elements found
710 function array_search_keys($needle, $haystack, $valuekey=null)
713 if (is_array($haystack)) {
714 foreach($haystack as $key => $value) {
715 $val = isset($valuekey) ? @$value[$valuekey] : $value;
716 if ($needle == $val){
724 // Find first (single) $needle in $haystack or in $haystack[][$valuekey]
725 // returns $haystack element found or null
727 function array_search_key($needle, $haystack, $valuekey=null)
729 $keys = array_search_keys($needle, $haystack, $valuekey);
733 // Recalculate report columns if orientation is landscape.
734 function recalculate_cols(&$cols)
736 $factor = (user_pagesize() == "A4" ? 1.4 : 1.3);
737 foreach($cols as $key => $col)
738 $cols[$key] = intval($col * $factor);
741 function flush_dir($path, $wipe = false)
743 if (!file_exists($path))
745 $dir = @opendir($path);
749 while(false !== ($fname = readdir($dir))) {
750 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
751 if(is_dir($path.'/'.$fname)) {
752 flush_dir($path.'/'.$fname, $wipe);
753 if ($wipe) @rmdir($path.'/'.$fname);
755 @unlink($path.'/'.$fname);
759 Returns current path to company private folder.
760 (Current path can change after chdir).
762 function company_path($comp=null)
764 global $path_to_root, $SysPrefs;
766 $comp_path = $SysPrefs->comp_path;
770 $comp = user_company();
772 // if path is relative, set current path_to_root
773 return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
777 function is_admin_company()
779 return $this->company == 0;