Changed access control extensions support for modules/plugins to use unique extension...
[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         var $old_db;    
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                 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
139                 // only first registered company has site admin privileges
140                 return $code && in_array($code, $this->role_set)
141                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
142         }
143
144         function can_access_page($page_level)
145         {
146                 return $this->can_access($page_level);
147         }
148
149         function get_db_connection($id=-1)
150         {
151         global $db_connections;
152
153         $connection = $db_connections[$id == -1 ? $this->company : $id];
154
155         //print_r($connection);
156
157         $db = mysql_connect($connection["host"] ,
158                 $connection["dbuser"], $connection["dbpassword"]);
159         mysql_select_db($connection["dbname"],$db);
160
161                 if (!defined('TB_PREF'))
162                         define('TB_PREF', $connection["tbpref"]);
163
164         return $db;
165         }
166
167         function update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, 
168                 $showgl, $showcodes, $date_format, $date_sep, $tho_sep, $dec_sep, 
169                 $theme, $pagesize, $show_hints, $profile, $rep_popup, $query_size, 
170                 $graphic_links, $lang, $stickydate, $startup_tab) {
171                 update_user_display_prefs($this->user, $price_dec, 
172                         $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes, 
173                         $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, 
174                         $show_hints, $profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
175
176                 // re-read the prefs
177                 $user = get_user($this->user);
178                 $this->prefs = new user_prefs($user);
179         }
180 }
181
182 //--------------------------------------------------------------------------
183
184 function round2($number, $decimals=0)
185 {
186         $delta = ($number < 0 ? -.000001 : .000001);
187         return round($number+$delta, $decimals);
188 }
189
190 function number_format2($number, $decimals=0)
191 {
192         global $thoseps, $decseps;
193         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
194         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
195         //return number_format($number, $decimals, $dsep,       $tsep);
196         $delta = ($number < 0 ? -.000001 : .000001);
197         return number_format($number+$delta, $decimals, $dsep,  $tsep);
198 }
199 //
200 //      Current ui mode.
201 //
202 function fallback_mode() {
203     return $_SESSION["wa_current_user"]->ui_mode==0;
204 }
205
206 function price_format($number) {
207     return number_format2($number,
208         $_SESSION["wa_current_user"]->prefs->price_dec());
209 }
210
211 function price_decimal_format($number, &$dec)
212 {
213         $dec = user_price_dec();
214         $str = strval($number);
215         $pos = strpos($str, '.');
216         if ($pos !== false)
217         {
218                 $len = strlen(substr($str, $pos + 1));
219                 if ($len > $dec)
220                         $dec = $len;
221         }
222         return number_format2($number, $dec);
223 }
224 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
225 //--------------------------------------------------------------------
226 function qty_format($number, $stock_id=null, &$dec) {
227         $dec = get_qty_dec($stock_id);
228     return number_format2($number, $dec);
229 }
230 // and get_qty_dec
231 function get_qty_dec($stock_id=null)
232 {
233         global $path_to_root;
234         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
235         if ($stock_id != null)
236                 $dec = get_unit_dec($stock_id);
237         if ($stock_id == null || $dec == -1 || $dec == null)
238                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
239         return $dec;
240 }
241 //-------------------------------------------------------------------
242 function exrate_format($number) {
243     return number_format2($number,
244         $_SESSION["wa_current_user"]->prefs->exrate_dec());
245 }
246
247 function percent_format($number) {
248     return number_format2($number,
249         $_SESSION["wa_current_user"]->prefs->percent_dec());
250 }
251
252 function user_numeric($input) {
253     global $decseps, $thoseps;
254
255     $num = trim($input);
256     $sep = $thoseps[user_tho_sep()];
257     if($sep!='') $num = str_replace( $sep, '', $num);
258         str_replace($sep, '', $num);
259     $sep = $decseps[user_dec_sep()];
260     if($sep!='.') $num = str_replace( $sep, '.', $num);
261
262     if (!is_numeric($num))
263           return false;
264     $num = (float)$num;
265     if ($num == (int)$num)
266           return (int)$num;
267     else
268           return $num;
269 }
270
271 function user_company()
272 {
273         return $_SESSION["wa_current_user"]->company;
274 }
275
276 function user_pos()
277 {
278         return $_SESSION["wa_current_user"]->pos;
279 }
280
281 function user_language()
282 {
283         return $_SESSION["wa_current_user"]->prefs->language();
284 }
285
286 function user_qty_dec()
287 {
288         return $_SESSION["wa_current_user"]->prefs->qty_dec();
289 }
290
291 function user_price_dec()
292 {
293         return $_SESSION["wa_current_user"]->prefs->price_dec();
294 }
295
296 function user_exrate_dec()
297 {
298         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
299 }
300
301 function user_percent_dec()
302 {
303         return $_SESSION["wa_current_user"]->prefs->percent_dec();
304 }
305
306 function user_show_gl_info()
307 {
308         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
309 }
310
311 function user_show_codes()
312 {
313         return $_SESSION["wa_current_user"]->prefs->show_codes();
314 }
315
316 function user_date_format()
317 {
318         return $_SESSION["wa_current_user"]->prefs->date_format();
319 }
320
321 function user_date_display()
322 {
323         return $_SESSION["wa_current_user"]->prefs->date_display();
324 }
325
326 function user_date_sep()
327 {
328         return $_SESSION["wa_current_user"]->prefs->date_sep();
329 }
330
331 function user_tho_sep()
332 {
333         return $_SESSION["wa_current_user"]->prefs->tho_sep();
334 }
335
336 function user_dec_sep()
337 {
338         return $_SESSION["wa_current_user"]->prefs->dec_sep();
339 }
340
341 function user_theme()
342 {
343         return $_SESSION["wa_current_user"]->prefs->get_theme();
344 }
345
346 function user_pagesize()
347 {
348         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
349 }
350
351 function user_hints()
352 {
353         return $_SESSION["wa_current_user"]->prefs->show_hints();
354 }
355
356 function user_print_profile()
357 {
358         return $_SESSION["wa_current_user"]->prefs->print_profile();
359 }
360
361 function user_rep_popup()
362 {
363         return $_SESSION["wa_current_user"]->prefs->rep_popup();
364 }
365
366 function user_query_size()
367 {
368         return $_SESSION["wa_current_user"]->prefs->query_size();
369 }
370
371 function user_graphic_links()
372 {
373         return $_SESSION["wa_current_user"]->prefs->graphic_links();
374 }
375
376 function sticky_doc_date()
377 {
378         return $_SESSION["wa_current_user"]->prefs->sticky_date();
379 }
380
381 function user_startup_tab()
382 {
383         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
384 }
385
386 function set_user_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
387         $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
388         $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab)
389 {
390
391         $_SESSION["wa_current_user"]->update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
392                 $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
393                 $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
394 }
395
396 function add_user_js_data() {
397         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
398
399         $ts = $thoseps[user_tho_sep()];
400         $ds = $decseps[user_dec_sep()];
401
402     $js = "\n"
403           . "var user = {\n"
404           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
405           . "loadtxt: '"._('Requesting data...')."',\n"
406           . "date: '".Today()."',\n"    // server date
407           . "datesys: ".$date_system.",\n"
408           . "datefmt: ".user_date_format().",\n"
409           . "datesep: '".$dateseps[user_date_sep()]."',\n"
410           . "ts: '$ts',\n"
411           . "ds: '$ds',\n"
412           . "pdec : " . user_price_dec() . "}\n";
413
414   add_js_source($js);
415 }
416
417 //--------------------------------------------------------------------------
418
419 function session_timeout()
420 {
421         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
422         return $tout ? $tout : ini_get('session.gc_maxlifetime');
423 }
424 ?>