Back link on upgrade help page.
[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 include_once($path_to_root . "/includes/prefs/userprefs.inc");
13
14 //--------------------------------------------------------------------------
15
16 class current_user
17 {
18         var $user;
19         var $loginname;
20         var $username;
21         var $name;
22         var $company;
23         var $pos;
24         var $access;
25         var $timeout;
26         var $last_act;
27         var $role_set = false;
28         
29         var $logged;
30         var $ui_mode = 0;
31         
32         var $prefs;
33
34         function current_user()
35         {
36                 global $def_coy;
37                 
38                 $this->loginname = $this->username = $this->name = "";
39                 $this->company = isset($def_coy)? $def_coy : 0;
40                 $this->logged = false;
41
42                 $this->prefs = new user_prefs();
43         }
44
45         function logged_in()
46         {
47                 return $this->logged;
48         }
49
50         function set_company($company)
51         {
52                 $this->company = $company;
53         }
54
55         function login($company, $loginname, $password)
56         {
57                 global $security_areas, $security_groups, $security_headings, $path_to_root;
58                 
59                 $this->set_company($company);
60             $this->logged = false;
61
62                 $Auth_Result = get_user_for_login($loginname, $password);
63
64                 if (db_num_rows($Auth_Result) > 0)
65                 {
66                         $myrow = db_fetch($Auth_Result);
67                         $this->old_db = isset($myrow["full_access"]);
68                         if (! @$myrow["inactive"]) {
69                                 if ($this->old_db) { 
70                                         // Transition code:
71                                         // db was not yet upgraded after source update to v.2.2
72                                         // give enough access for admin user to continue upgrade
73                                         if (!isset($security_groups) || !isset($security_headings)) {
74                                                 echo "<center><br><br><font size='5' color='red'><b>";
75                                                 echo _('Before software upgrade you have to include old $security_groups and $security_headings arrays from old config.php file to the new one.');
76                                                 echo '<br>'."<a href=$path_to_root/index.php>"._("Back")."</a>";
77                                                 echo "</b></font><br><br></center>";
78                                                 exit;
79                                         }
80                             $this->access = $myrow["full_access"];
81                             if (in_array(20, $security_groups[$this->access]))
82                                                 // temporary access for admin users
83                                                 $this->role_set[] = $security_areas['SA_SOFTWAREUPGRADE'][0];
84                                         else {
85                                                 echo "<center><br><br><font size='5' color='red'><b>";
86                                                 echo _('System is available for site admin only until full database upgrade');
87                                                 echo "</b></font><br><br></center>";
88                                                 exit;
89                                         }
90                         } else {
91                                         $this->role_set = array();
92                             $this->access = $myrow["role_id"];
93                                         // store area codes available for current user role
94                                         $role = get_security_role($this->access);
95                                         if (!$role) 
96                                                 return false;
97                                         foreach( $role['areas'] as $code )
98                                                 // filter only area codes for enabled security sections
99                                                 if (in_array($code&~0xff, $role['sections'])) 
100                                                         $this->role_set[] = $code;
101                         }
102                     $this->name = $myrow["real_name"];
103                     $this->pos = $myrow["pos"];
104                     $this->loginname = $loginname;
105                     $this->username = $this->loginname;
106                     $this->prefs = new user_prefs($myrow);
107                     $this->user = @$myrow["id"];
108                         update_user_visitdate($this->username);
109                         $this->logged = true;
110                                 $this->last_act = time();
111                                 $this->timeout = session_timeout();
112                         }
113                 }
114                 return $this->logged;
115         }
116
117         function check_user_access()
118         {
119                 global $security_groups;
120                 if ($this->old_db) {
121                         // notification after upgrade from pre-2.2 version
122                         return isset($security_groups) && is_array(@$security_groups[$this->access]);
123                 } else
124                         return !isset($security_groups) && is_array($this->role_set);
125         }
126
127         function can_access($page_level)
128         {
129                 global $security_groups, $security_areas;
130
131                 if (isset($security_groups)) {
132                         return $this->company == 0 &&
133                                 in_array(20, $security_groups[$this->access]);
134                 }
135
136                 if ($page_level === 'SA_OPEN') 
137                         return true;
138                 $code = @$security_areas[$page_level][0];
139
140                 // only first registered company has site admin privileges
141                 return $code && in_array($code, $this->role_set)
142                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
143         }
144
145         function can_access_page($page_level)
146         {
147                 return $this->can_access($page_level);
148         }
149
150         function get_db_connection()
151         {
152         global $db_connections;
153
154         $connection = $db_connections[$this->company];
155
156         //print_r($connection);
157
158         $db = mysql_connect($connection["host"] ,
159                 $connection["dbuser"], $connection["dbpassword"]);
160         mysql_select_db($connection["dbname"],$db);
161
162                 if (!defined('TB_PREF'))
163                         define('TB_PREF', $connection["tbpref"]);
164
165         return $db;
166         }
167
168         function update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, 
169                 $showgl, $showcodes, $date_format, $date_sep, $tho_sep, $dec_sep, 
170                 $theme, $pagesize, $show_hints, $profile, $rep_popup, $query_size, 
171                 $graphic_links, $lang, $stickydate, $startup_tab) {
172                 update_user_display_prefs($this->user, $price_dec, 
173                         $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes, 
174                         $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, 
175                         $show_hints, $profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
176
177                 // re-read the prefs
178                 $user = get_user($this->user);
179                 $this->prefs = new user_prefs($user);
180         }
181 }
182
183 //--------------------------------------------------------------------------
184
185 function round2($number, $decimals=0)
186 {
187         $delta = ($number < 0 ? -.000001 : .000001);
188         return round($number+$delta, $decimals);
189 }
190
191 function number_format2($number, $decimals=0)
192 {
193         global $thoseps, $decseps;
194         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
195         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
196         //return number_format($number, $decimals, $dsep,       $tsep);
197         $delta = ($number < 0 ? -.000001 : .000001);
198         return number_format($number+$delta, $decimals, $dsep,  $tsep);
199 }
200 //
201 //      Current ui mode.
202 //
203 function fallback_mode() {
204     return $_SESSION["wa_current_user"]->ui_mode==0;
205 }
206
207 function price_format($number) {
208     return number_format2($number,
209         $_SESSION["wa_current_user"]->prefs->price_dec());
210 }
211
212 function price_decimal_format($number, &$dec)
213 {
214         $dec = user_price_dec();
215         $str = strval($number);
216         $pos = strpos($str, '.');
217         if ($pos !== false)
218         {
219                 $len = strlen(substr($str, $pos + 1));
220                 if ($len > $dec)
221                         $dec = $len;
222         }
223         return number_format2($number, $dec);
224 }
225 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
226 //--------------------------------------------------------------------
227 function qty_format($number, $stock_id=null, &$dec) {
228         $dec = get_qty_dec($stock_id);
229     return number_format2($number, $dec);
230 }
231 // and get_qty_dec
232 function get_qty_dec($stock_id=null)
233 {
234         global $path_to_root;
235         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
236         if ($stock_id != null)
237                 $dec = get_unit_dec($stock_id);
238         if ($stock_id == null || $dec == -1 || $dec == null)
239                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
240         return $dec;
241 }
242 //-------------------------------------------------------------------
243 function exrate_format($number) {
244     return number_format2($number,
245         $_SESSION["wa_current_user"]->prefs->exrate_dec());
246 }
247
248 function percent_format($number) {
249     return number_format2($number,
250         $_SESSION["wa_current_user"]->prefs->percent_dec());
251 }
252
253 function user_numeric($input) {
254     global $decseps, $thoseps;
255
256     $num = trim($input);
257     $sep = $thoseps[user_tho_sep()];
258     if($sep!='') $num = str_replace( $sep, '', $num);
259         str_replace($sep, '', $num);
260     $sep = $decseps[user_dec_sep()];
261     if($sep!='.') $num = str_replace( $sep, '.', $num);
262
263     if (!is_numeric($num))
264           return false;
265     $num = (float)$num;
266     if ($num == (int)$num)
267           return (int)$num;
268     else
269           return $num;
270 }
271
272 function user_company()
273 {
274         return $_SESSION["wa_current_user"]->company;
275 }
276
277 function user_pos()
278 {
279         return $_SESSION["wa_current_user"]->pos;
280 }
281
282 function user_language()
283 {
284         return $_SESSION["wa_current_user"]->prefs->language();
285 }
286
287 function user_qty_dec()
288 {
289         return $_SESSION["wa_current_user"]->prefs->qty_dec();
290 }
291
292 function user_price_dec()
293 {
294         return $_SESSION["wa_current_user"]->prefs->price_dec();
295 }
296
297 function user_exrate_dec()
298 {
299         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
300 }
301
302 function user_percent_dec()
303 {
304         return $_SESSION["wa_current_user"]->prefs->percent_dec();
305 }
306
307 function user_show_gl_info()
308 {
309         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
310 }
311
312 function user_show_codes()
313 {
314         return $_SESSION["wa_current_user"]->prefs->show_codes();
315 }
316
317 function user_date_format()
318 {
319         return $_SESSION["wa_current_user"]->prefs->date_format();
320 }
321
322 function user_date_display()
323 {
324         return $_SESSION["wa_current_user"]->prefs->date_display();
325 }
326
327 function user_date_sep()
328 {
329         return $_SESSION["wa_current_user"]->prefs->date_sep();
330 }
331
332 function user_tho_sep()
333 {
334         return $_SESSION["wa_current_user"]->prefs->tho_sep();
335 }
336
337 function user_dec_sep()
338 {
339         return $_SESSION["wa_current_user"]->prefs->dec_sep();
340 }
341
342 function user_theme()
343 {
344         return $_SESSION["wa_current_user"]->prefs->get_theme();
345 }
346
347 function user_pagesize()
348 {
349         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
350 }
351
352 function user_hints()
353 {
354         return $_SESSION["wa_current_user"]->prefs->show_hints();
355 }
356
357 function user_print_profile()
358 {
359         return $_SESSION["wa_current_user"]->prefs->print_profile();
360 }
361
362 function user_rep_popup()
363 {
364         return $_SESSION["wa_current_user"]->prefs->rep_popup();
365 }
366
367 function user_query_size()
368 {
369         return $_SESSION["wa_current_user"]->prefs->query_size();
370 }
371
372 function user_graphic_links()
373 {
374         return $_SESSION["wa_current_user"]->prefs->graphic_links();
375 }
376
377 function sticky_doc_date()
378 {
379         return $_SESSION["wa_current_user"]->prefs->sticky_date();
380 }
381
382 function user_startup_tab()
383 {
384         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
385 }
386
387 function set_user_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
388         $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
389         $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab)
390 {
391
392         $_SESSION["wa_current_user"]->update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
393                 $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
394                 $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
395 }
396
397 function add_user_js_data() {
398         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
399
400         $ts = $thoseps[user_tho_sep()];
401         $ds = $decseps[user_dec_sep()];
402
403     $js = "\n"
404           . "var user = {\n"
405           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
406           . "loadtxt: '"._('Requesting data...')."',\n"
407           . "date: '".Today()."',\n"    // server date
408           . "datesys: ".$date_system.",\n"
409           . "datefmt: ".user_date_format().",\n"
410           . "datesep: '".$dateseps[user_date_sep()]."',\n"
411           . "ts: '$ts',\n"
412           . "ds: '$ds',\n"
413           . "pdec : " . user_price_dec() . "}\n";
414
415   add_js_source($js);
416 }
417
418 //--------------------------------------------------------------------------
419
420 function session_timeout()
421 {
422         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
423         return $tout ? $tout : ini_get('session.gc_maxlifetime');
424 }
425 ?>