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;
37 var $cur_con; // current db connection (can be different from $company for superuser)
39 function __construct()
43 $this->loginname = $this->username = $this->name = "";
44 $this->company = isset($def_coy)? $def_coy : 0;
45 $this->logged = false;
47 $this->prefs = new user_prefs();
55 function set_company($company)
57 $this->company = (int)$company;
60 function login($company, $loginname, $password)
62 global $security_areas, $security_groups, $security_headings, $path_to_root, $dflt_lang, $SysPrefs;
64 $this->set_company($company);
65 $this->logged = false;
67 set_global_connection($company);
68 $lang = &$_SESSION['language'];
69 $lang->set_language($_SESSION['language']->code);
70 db_set_encoding($_SESSION['language']->encoding);
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);
77 if (!isset($Auth_Result)) // if not used: standard method
78 $Auth_Result = get_user_auth($loginname, md5($password));
80 if ($SysPrefs->login_delay > 0)
81 write_login_filelog($loginname, $Auth_Result);
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);
93 $this->old_db = isset($myrow["full_access"]);
94 if (! @$myrow["inactive"]) {
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>";
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];
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>";
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);
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;
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
142 return $this->logged;
145 function reset_password($company, $email) {
148 $this->set_company($company);
149 $this->logged = false;
151 set_global_connection();
153 $user = get_user_by_email($email);
155 if ($user != false) {
157 $password = generate_password();
158 $hash = md5($password);
160 update_user_password($user['id'], $user['user_id'], $hash);
162 mail($email, _("New password for")." ".$SysPrefs->app_title, $password);
169 function check_user_access()
171 global $security_groups;
173 // notification after upgrade from pre-2.2 version
174 return isset($security_groups) && is_array(@$security_groups[$this->access]);
176 return !isset($security_groups) && is_array($this->role_set);
179 function can_access($sec_area)
181 global $security_groups, $security_areas;
182 if (isset($security_groups)) {
183 return is_admin_company() &&
184 in_array(20, $security_groups[$this->access]);
187 if ($sec_area === 'SA_OPEN')
189 if ($sec_area === 'SA_DENIED' || $sec_area === '')
192 $code = $security_areas[$sec_area][0];
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));
199 function can_access_page($page_level)
201 return $this->can_access($page_level);
204 function check_application_access($waapp)
206 if (!$this->hide_inaccessible_menu_items())
211 foreach ($waapp->modules as $module)
213 if ($this->check_module_access($module))
223 function check_module_access($module)
226 if (!$this->hide_inaccessible_menu_items())
231 if (sizeof($module->lappfunctions) > 0)
233 foreach ($module->lappfunctions as $appfunction)
235 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
242 if (sizeof($module->rappfunctions) > 0)
244 foreach ($module->rappfunctions as $appfunction)
246 if ($appfunction->label != "" && $this->can_access_page($appfunction->access))
257 function hide_inaccessible_menu_items()
261 if (!isset($SysPrefs->hide_inaccessible_menu_items) || $SysPrefs->hide_inaccessible_menu_items == 0)
272 function set_db_connection($id = -1)
274 return set_global_connection($id);
277 function update_prefs($prefs)
281 if (!$SysPrefs->allow_demo_mode) {
282 update_user_prefs($this->user, $prefs);
285 $this->prefs = new user_prefs(get_user($this->user));
289 //--------------------------------------------------------------------------
291 function round2($number, $decimals=0)
293 $delta = ($number < 0 ? -.0000000001 : .0000000001);
294 return round($number+$delta, $decimals);
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.
302 function number_format2($number, $decimals=0)
305 $tsep = $SysPrefs->thoseps[user_tho_sep()];
306 $dsep = $SysPrefs->decseps[user_dec_sep()];
308 if($decimals==='max')
309 $dec = 15 - floor(log10(abs($number)));
311 $delta = ($number < 0 ? -.0000000001 : .0000000001);
316 $num = number_format($number, $dec, $dsep, $tsep);
318 return $decimals==='max' ? rtrim($num, '0') : $num;
322 /* price/float comparision helper to be used in any suspicious place for zero values?
324 if (!floatcmp($value1, $value2))
328 define('FLOAT_COMP_DELTA', 0.004);
330 function floatcmp($a, $b)
332 return $a - $b > FLOAT_COMP_DELTA ? 1 : ($b - $a > FLOAT_COMP_DELTA ? -1 : 0);
338 function fallback_mode() {
339 return $_SESSION["wa_current_user"]->ui_mode==0;
342 function price_format($number) {
343 return number_format2($number, user_price_dec());
346 function price_decimal_format($number, &$dec)
348 $dec = user_price_dec();
349 $str = strval($number);
350 $pos = strpos($str, '.');
353 $len = strlen(substr($str, $pos + 1));
357 return number_format2($number, $dec);
359 // function money_format doesn't exist in OS Win.
360 if (!function_exists('money_format'))
362 function money_format($format, $number)
364 return price_format($number);
368 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
369 //--------------------------------------------------------------------
370 function qty_format($number, $stock_id=null, &$dec) {
371 $dec = get_qty_dec($stock_id);
372 return number_format2($number, $dec);
376 function get_qty_dec($stock_id=null)
378 global $path_to_root;
379 include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
380 if ($stock_id != null)
381 $dec = get_unit_dec($stock_id);
382 if ($stock_id == null || $dec == -1 || $dec == null)
383 $dec = user_qty_dec();
386 //-------------------------------------------------------------------
388 // Maximum precision format. Strips trailing unsignificant digits.
390 function maxprec_format($number) {
391 return number_format2($number, 'max');
394 function exrate_format($number) {
395 return number_format2($number,
396 $_SESSION["wa_current_user"]->prefs->exrate_dec());
399 function percent_format($number) {
400 return number_format2($number,
401 $_SESSION["wa_current_user"]->prefs->percent_dec());
404 function user_numeric($input) {
408 $sep = $SysPrefs->thoseps[user_tho_sep()];
410 $num = str_replace( $sep, '', $num);
412 $sep = $SysPrefs->decseps[user_dec_sep()];
414 $num = str_replace( $sep, '.', $num);
416 if (!is_numeric($num))
419 if ($num == (int)$num)
425 function user_company()
429 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->company : $def_coy;
434 return $_SESSION["wa_current_user"]->pos;
437 function user_language()
439 return $_SESSION["wa_current_user"]->prefs->language();
442 function user_qty_dec()
444 return $_SESSION["wa_current_user"]->prefs->qty_dec();
447 function user_price_dec()
451 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->price_dec() : 2;
454 function user_exrate_dec()
458 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->exrate_dec() : 4;
461 function user_percent_dec()
465 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->percent_dec() : 1;
468 function user_show_gl_info()
470 return $_SESSION["wa_current_user"]->prefs->show_gl_info();
473 function user_show_codes()
475 return $_SESSION["wa_current_user"]->prefs->show_codes();
478 function user_date_format()
482 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_format() : $SysPrefs->dflt_date_fmt;
485 function user_date_display()
488 if (isset($_SESSION["wa_current_user"])) {
489 $fmt = $_SESSION["wa_current_user"]->prefs->date_display();
491 $sep = user_date_sep();
492 $user_date_fmt = user_date_format();
493 switch ($user_date_fmt) {
495 $fmt = "m".$sep."d".$sep."Y"; break;
497 $fmt = "d".$sep."m".$sep."Y"; break;
499 $fmt = "Y".$sep."m".$sep."d"; break;
501 $fmt = "M".$sep."j".$sep."Y"; break;
503 $fmt = "j".$sep."M".$sep."Y"; break;
505 $fmt = "Y".$sep."M".$sep."j";
510 function user_date_sep()
514 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->date_sep() : $SysPrefs->dflt_date_sep;
517 function user_tho_sep()
519 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->tho_sep() : 0;
522 function user_dec_sep()
524 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->dec_sep() : 0;
527 function user_theme()
529 return isset($_SESSION["wa_current_user"]) ? $_SESSION["wa_current_user"]->prefs->get_theme() : 'default';
532 function user_pagesize()
534 return $_SESSION["wa_current_user"]->prefs->get_pagesize();
537 function user_hints()
539 return $_SESSION["wa_current_user"]->prefs->show_hints();
542 function user_print_profile()
544 return $_SESSION["wa_current_user"]->prefs->print_profile();
547 function user_rep_popup()
549 return $_SESSION["wa_current_user"]->prefs->rep_popup();
552 function user_query_size()
554 return $_SESSION["wa_current_user"]->prefs->query_size();
557 function user_graphic_links()
559 return $_SESSION["wa_current_user"]->prefs->graphic_links();
562 function sticky_doc_date()
564 return $_SESSION["wa_current_user"]->prefs->sticky_date();
567 function user_startup_tab()
569 return $_SESSION["wa_current_user"]->prefs->start_up_tab();
572 function user_transaction_days()
574 return $_SESSION["wa_current_user"]->prefs->transaction_days();
577 function user_save_report_selections()
579 return $_SESSION["wa_current_user"]->prefs->save_report_selections();
582 function user_use_date_picker()
584 return $_SESSION["wa_current_user"]->prefs->use_date_picker();
587 function user_def_print_destination()
589 return $_SESSION["wa_current_user"]->prefs->def_print_destination();
592 function user_def_print_orientation()
594 return $_SESSION["wa_current_user"]->prefs->def_print_orientation();
597 function user_check_access($sec_area)
599 return $_SESSION["wa_current_user"]->can_access($sec_area);
602 function set_user_prefs($prefs)
604 $_SESSION["wa_current_user"]->update_prefs($prefs);
607 function add_user_js_data() {
608 global $path_to_root, $SysPrefs;
610 $ts = $SysPrefs->thoseps[user_tho_sep()];
611 $ds = $SysPrefs->decseps[user_dec_sep()];
615 . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
616 . "loadtxt: '"._('Requesting data...')."',\n"
617 . "date: '".Today()."',\n" // server date
618 . "datesys: ".$SysPrefs->date_system.",\n"
619 . "datefmt: ".user_date_format().",\n"
620 . "datesep: '".$SysPrefs->dateseps[user_date_sep()]."',\n"
623 . "pdec : " . user_price_dec() . "}\n";
628 function user_js_cache($id=null)
630 global $path_to_root;
633 $id = @$_SESSION['wa_current_user']->user;
636 $id = 0; // before login
637 return $path_to_root.'/company/'.user_company().'/js_cache/'.$id;
640 //--------------------------------------------------------------------------
642 function session_timeout()
644 $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
645 return $tout ? $tout : ini_get('session.gc_maxlifetime');
648 //-----------------------------------------------------------------------------
649 // Inserts $elements into $array at position $index.
650 // $elements is list of any objects
652 function array_insert(&$array, $index, $elements)
654 if (!is_array($elements)) $elements = array($elements);
656 $head = array_splice($array, 0, $index);
657 $array = array_merge($head, $elements, $array);
660 function array_remove(&$array, $index, $len=1)
662 array_splice($array, $index, $len);
665 function array_substitute(&$array, $index, $len, $elements)
667 array_splice($array, $index, $len);
668 array_insert($array, $index, $elements);
671 function array_append(&$array, $elements)
673 foreach($elements as $key => $el) {
681 // Search $needle in $haystack or in $haystack[][$valuekey]
682 // returns $needle found or null.
684 function array_search_value($needle, $haystack, $valuekey=null)
686 if (is_array($haystack)) {
687 foreach($haystack as $key => $value) {
688 $val = isset($valuekey) ? @$value[$valuekey] : $value;
689 if ($needle == $val){
697 // Search $needle in $haystack or in $haystack[][$valuekey]
698 // returns array of keys of $haystack elements found
700 function array_search_keys($needle, $haystack, $valuekey=null)
703 if (is_array($haystack)) {
704 foreach($haystack as $key => $value) {
705 $val = isset($valuekey) ? @$value[$valuekey] : $value;
706 if ($needle == $val){
714 // Find first (single) $needle in $haystack or in $haystack[][$valuekey]
715 // returns $haystack element found or null
717 function array_search_key($needle, $haystack, $valuekey=null)
719 $keys = array_search_keys($needle, $haystack, $valuekey);
723 // Recalculate report columns if orientation is landscape.
724 function recalculate_cols(&$cols)
726 $factor = (user_pagesize() == "A4" ? 1.4 : 1.3);
727 foreach($cols as $key => $col)
728 $cols[$key] = intval($col * $factor);
731 function flush_dir($path, $wipe = false)
733 $dir = @opendir($path);
737 while(false !== ($fname = readdir($dir))) {
738 if($fname=='.' || $fname=='..' || $fname=='CVS' || (!$wipe && $fname=='index.php')) continue;
739 if(is_dir($path.'/'.$fname)) {
740 flush_dir($path.'/'.$fname, $wipe);
741 if ($wipe) @rmdir($path.'/'.$fname);
743 @unlink($path.'/'.$fname);
747 Returns current path to company private folder.
748 (Current path can change after chdir).
750 function company_path($comp=null)
752 global $path_to_root, $SysPrefs;
754 $comp_path = $SysPrefs->comp_path;
758 $comp = user_company();
760 // if path is relative, set current path_to_root
761 return ($comp_path[0]=='.' ? $path_to_root.'/'.basename($comp_path) : $comp_path)
765 function is_admin_company()
767 return $this->company == 0;