Merged changes from main trunk up to 2.2.3
[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                 if ($page_level === 'SA_DENIED' || $page_level === '') 
138                         return false;
139
140                 $code = $security_areas[$page_level][0];
141
142                 // only first registered company has site admin privileges
143                 return $code && in_array($code, $this->role_set)
144                         && ($this->company == 0 || (($code&~0xff) != SS_SADMIN));
145         }
146
147         function can_access_page($page_level)
148         {
149                 return $this->can_access($page_level);
150         }
151
152         function get_db_connection($id=-1)
153         {
154         global $db_connections;
155
156         $connection = $db_connections[$id == -1 ? $this->company : $id];
157
158         //print_r($connection);
159
160         $db = mysql_connect($connection["host"] ,
161                 $connection["dbuser"], $connection["dbpassword"]);
162         mysql_select_db($connection["dbname"],$db);
163
164                 if (!defined('TB_PREF'))
165                         define('TB_PREF', $connection["tbpref"]);
166
167         return $db;
168         }
169
170         function update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, 
171                 $showgl, $showcodes, $date_format, $date_sep, $tho_sep, $dec_sep, 
172                 $theme, $pagesize, $show_hints, $profile, $rep_popup, $query_size, 
173                 $graphic_links, $lang, $stickydate, $startup_tab)
174         {
175                 global $allow_demo_mode;
176
177                 $user = array(
178                         'prices_dec' => $price_dec,     'qty_dec' => $qty_dec,
179                         'rates_dec' => $exrate_dec,             'percent_dec' => $percent_dec,
180                         'show_gl' => $showgl,                   'show_codes' => $showcodes,
181                         'date_format' => $date_format,  'date_sep' => $date_sep,
182                         'tho_sep' => $tho_sep,                  'dec_sep' => $dec_sep,
183                         'theme' => $theme,                              'page_size' => $pagesize,
184                         'show_hints' => $show_hints,    'print_profile' => $profile,
185                         'rep_popup' => $rep_popup,              'query_size' => $query_size,
186                         'graphic_links' => $graphic_links,      'language' => $lang,
187                         'sticky_doc_date' => $stickydate,       'startup_tab' => $startup_tab
188                 );
189
190                 if(!$allow_demo_mode) {
191                         update_user_display_prefs($this->user, $price_dec, 
192                                 $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes, 
193                                 $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, 
194                                 $show_hints, $profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
195                 }
196                 $this->prefs = new user_prefs($user);
197         }
198 }
199
200 //--------------------------------------------------------------------------
201
202 function round2($number, $decimals=0)
203 {
204         $delta = ($number < 0 ? -.000001 : .000001);
205         return round($number+$delta, $decimals);
206 }
207
208 function number_format2($number, $decimals=0)
209 {
210         global $thoseps, $decseps;
211         $tsep = $thoseps[$_SESSION["wa_current_user"]->prefs->tho_sep()];
212         $dsep = $decseps[$_SESSION["wa_current_user"]->prefs->dec_sep()];
213         //return number_format($number, $decimals, $dsep,       $tsep);
214         $delta = ($number < 0 ? -.000001 : .000001);
215         return number_format($number+$delta, $decimals, $dsep,  $tsep);
216 }
217 //
218 //      Current ui mode.
219 //
220 function fallback_mode() {
221     return $_SESSION["wa_current_user"]->ui_mode==0;
222 }
223
224 function price_format($number) {
225     return number_format2($number,
226         $_SESSION["wa_current_user"]->prefs->price_dec());
227 }
228
229 function price_decimal_format($number, &$dec)
230 {
231         $dec = user_price_dec();
232         $str = strval($number);
233         $pos = strpos($str, '.');
234         if ($pos !== false)
235         {
236                 $len = strlen(substr($str, $pos + 1));
237                 if ($len > $dec)
238                         $dec = $len;
239         }
240         return number_format2($number, $dec);
241 }
242 // function money_format doesn't exist in OS Win.
243 if (!function_exists('money_format'))
244 {
245         function money_format($format, $number) 
246         {
247                 return price_format($number);
248         } 
249 }       
250
251 // 2008-06-15. Added extra parameter $stock_id and reference for $dec
252 //--------------------------------------------------------------------
253 function qty_format($number, $stock_id=null, &$dec) {
254         $dec = get_qty_dec($stock_id);
255     return number_format2($number, $dec);
256 }
257 // and get_qty_dec
258 function get_qty_dec($stock_id=null)
259 {
260         global $path_to_root;
261         include_once($path_to_root."/inventory/includes/db/items_units_db.inc");
262         if ($stock_id != null)
263                 $dec = get_unit_dec($stock_id);
264         if ($stock_id == null || $dec == -1 || $dec == null)
265                 $dec = $_SESSION["wa_current_user"]->prefs->qty_dec();
266         return $dec;
267 }
268 //-------------------------------------------------------------------
269 function exrate_format($number) {
270     return number_format2($number,
271         $_SESSION["wa_current_user"]->prefs->exrate_dec());
272 }
273
274 function percent_format($number) {
275     return number_format2($number,
276         $_SESSION["wa_current_user"]->prefs->percent_dec());
277 }
278
279 function user_numeric($input) {
280     global $decseps, $thoseps;
281
282     $num = trim($input);
283     $sep = $thoseps[user_tho_sep()];
284     if ($sep!='')
285         $num = str_replace( $sep, '', $num);
286
287     $sep = $decseps[user_dec_sep()];
288     if ($sep!='.')
289         $num = str_replace( $sep, '.', $num);
290
291     if (!is_numeric($num))
292           return false;
293     $num = (float)$num;
294     if ($num == (int)$num)
295           return (int)$num;
296     else
297           return $num;
298 }
299
300 function user_company()
301 {
302         return $_SESSION["wa_current_user"]->company;
303 }
304
305 function user_pos()
306 {
307         return $_SESSION["wa_current_user"]->pos;
308 }
309
310 function user_language()
311 {
312         return $_SESSION["wa_current_user"]->prefs->language();
313 }
314
315 function user_qty_dec()
316 {
317         return $_SESSION["wa_current_user"]->prefs->qty_dec();
318 }
319
320 function user_price_dec()
321 {
322         return $_SESSION["wa_current_user"]->prefs->price_dec();
323 }
324
325 function user_exrate_dec()
326 {
327         return $_SESSION["wa_current_user"]->prefs->exrate_dec();
328 }
329
330 function user_percent_dec()
331 {
332         return $_SESSION["wa_current_user"]->prefs->percent_dec();
333 }
334
335 function user_show_gl_info()
336 {
337         return $_SESSION["wa_current_user"]->prefs->show_gl_info();
338 }
339
340 function user_show_codes()
341 {
342         return $_SESSION["wa_current_user"]->prefs->show_codes();
343 }
344
345 function user_date_format()
346 {
347         return $_SESSION["wa_current_user"]->prefs->date_format();
348 }
349
350 function user_date_display()
351 {
352         return $_SESSION["wa_current_user"]->prefs->date_display();
353 }
354
355 function user_date_sep()
356 {
357         return $_SESSION["wa_current_user"]->prefs->date_sep();
358 }
359
360 function user_tho_sep()
361 {
362         return $_SESSION["wa_current_user"]->prefs->tho_sep();
363 }
364
365 function user_dec_sep()
366 {
367         return $_SESSION["wa_current_user"]->prefs->dec_sep();
368 }
369
370 function user_theme()
371 {
372         return $_SESSION["wa_current_user"]->prefs->get_theme();
373 }
374
375 function user_pagesize()
376 {
377         return $_SESSION["wa_current_user"]->prefs->get_pagesize();
378 }
379
380 function user_hints()
381 {
382         return $_SESSION["wa_current_user"]->prefs->show_hints();
383 }
384
385 function user_print_profile()
386 {
387         return $_SESSION["wa_current_user"]->prefs->print_profile();
388 }
389
390 function user_rep_popup()
391 {
392         return $_SESSION["wa_current_user"]->prefs->rep_popup();
393 }
394
395 function user_query_size()
396 {
397         return $_SESSION["wa_current_user"]->prefs->query_size();
398 }
399
400 function user_graphic_links()
401 {
402         return $_SESSION["wa_current_user"]->prefs->graphic_links();
403 }
404
405 function sticky_doc_date()
406 {
407         return $_SESSION["wa_current_user"]->prefs->sticky_date();
408 }
409
410 function user_startup_tab()
411 {
412         return $_SESSION["wa_current_user"]->prefs->start_up_tab();
413 }
414
415 function set_user_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
416         $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
417         $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab)
418 {
419
420         $_SESSION["wa_current_user"]->update_prefs($price_dec, $qty_dec, $exrate_dec, $percent_dec, $showgl, $showcodes,
421                 $date_format, $date_sep, $tho_sep, $dec_sep, $theme, $pagesize, $show_hints,
422                 $print_profile, $rep_popup, $query_size, $graphic_links, $lang, $stickydate, $startup_tab);
423 }
424
425 function add_user_js_data() {
426         global $path_to_root, $thoseps, $decseps, $date_system, $dateseps;
427
428         $ts = $thoseps[user_tho_sep()];
429         $ds = $decseps[user_dec_sep()];
430
431     $js = "\n"
432           . "var user = {\n"
433           . "theme: '". $path_to_root . '/themes/'. user_theme().'/'."',\n"
434           . "loadtxt: '"._('Requesting data...')."',\n"
435           . "date: '".Today()."',\n"    // server date
436           . "datesys: ".$date_system.",\n"
437           . "datefmt: ".user_date_format().",\n"
438           . "datesep: '".$dateseps[user_date_sep()]."',\n"
439           . "ts: '$ts',\n"
440           . "ds: '$ds',\n"
441           . "pdec : " . user_price_dec() . "}\n";
442
443   add_js_source($js);
444 }
445
446 //--------------------------------------------------------------------------
447
448 function session_timeout()
449 {
450         $tout = @get_company_pref('login_tout'); // mask warning for db ver. 2.2
451         return $tout ? $tout : ini_get('session.gc_maxlifetime');
452 }
453
454 //-----------------------------------------------------------------------------
455 //      Inserts $elements into $array at position $index.
456 //      $elements is list of any objects
457 //
458 function array_insert(&$array, $index, $elements)
459 {
460         if (!is_array($elements)) $elements = array($elements);
461
462         $head  = array_splice($array, 0, $index);
463         $array = array_merge($head, $elements, $array);
464 }
465
466 function array_remove(&$array, $index, $len=1)
467 {
468         array_splice($array, $index, $len);
469 }
470
471 function array_substitute(&$array, $index, $len, $elements)
472 {
473         array_splice($array, $index, $len);
474         array_insert($array, $index, $elements);
475 }
476
477 function array_append(&$array, $elements)
478 {
479         foreach($elements as $key => $el) {
480                 if(is_int($key))
481                         $array[] = $el;
482                 else
483                         $array[$key] = $el;
484         }
485 }
486
487 function array_search_value($needle, $haystack, $valuekey=null)
488 {
489         foreach($haystack as $key => $value) {
490                 $val = isset($valuekey) ? $value[$valuekey] : $value;
491                 if ($needle == $val){
492                         return $value;
493                 }
494         }
495         return null;
496 }
497
498 function array_search_key($needle, $haystack, $valuekey=null)
499 {
500         foreach($haystack as $key => $value) {
501                 $val = isset($valuekey) ? $value[$valuekey] : $value;
502                 if ($needle == $val){
503                         return $key;
504                 }
505         }
506         return null;
507 }
508 ?>