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