Wrote getGroups function for ttUser class.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
1 <?php
2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
10 // |
11 // | There are only two ways to violate the license:
12 // |
13 // | 1. To redistribute this code in source form, with the copyright
14 // |    notice or license removed or altered. (Distributing in compiled
15 // |    forms without embedded copyright notices is permitted).
16 // |
17 // | 2. To redistribute modified versions of this code in *any* form
18 // |    that bears insufficient indications that the modifications are
19 // |    not the work of the original author(s).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 import('ttConfigHelper');
30
31 class ttUser {
32   var $login = null;            // User login.
33   var $name = null;             // User name.
34   var $id = null;               // User id.
35   var $org_id = null;           // Organization id.
36   var $group_id = null;         // Group id.
37   var $role_id = null;          // Role id.
38   var $role_name = null;        // Role name.
39   var $rank = null;             // User role rank.
40   var $client_id = null;        // Client id for client user role.
41   var $behalf_id = null;        // User id, on behalf of whom we are working.
42   var $behalf_group_id = null;  // Group id, on behalf of which we are working.
43   var $behalf_name = null;      // User name, on behalf of whom we are working.
44   var $behalf_group = null;     // Group name, on behalf of which we are working.
45   var $email = null;            // User email.
46   var $lang = null;             // Language.
47   var $decimal_mark = null;     // Decimal separator.
48   var $date_format = null;      // Date format.
49   var $time_format = null;      // Time format.
50   var $week_start = 0;          // Week start day.
51   var $show_holidays = 0;       // Whether to show holidays in calendar.
52   var $tracking_mode = 0;       // Tracking mode.
53   var $project_required = 0;    // Whether project selection is required on time entires.
54   var $task_required = 0;       // Whether task selection is required on time entires.
55   var $record_type = 0;         // Record type (duration vs start and finish, or both).
56   var $punch_mode = 0;          // Whether punch mode is enabled for user.
57   var $allow_overlap = 0;       // Whether to allow overlapping time entries.
58   var $future_entries = 0;      // Whether to allow creating future entries.
59   var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
60   var $bcc_email = null;        // Bcc email.
61   var $allow_ip = null;         // Specification from where user is allowed access.
62   var $password_complexity = null; // Password complexity example.
63   var $currency = null;         // Currency.
64   var $plugins = null;          // Comma-separated list of enabled plugins.
65   var $config = null;           // Comma-separated list of miscellaneous config options.
66   var $group = null;            // Group name.
67   var $custom_logo = 0;         // Whether to use a custom logo for group.
68   var $lock_spec = null;        // Cron specification for record locking.
69   var $workday_minutes = 480;   // Number of work minutes in a regular day.
70   var $rights = array();        // An array of user rights such as 'track_own_time', etc.
71   var $is_client = false;       // Whether user is a client as determined by missing 'track_own_time' right.
72   var $minutes_in_unit = 15;    // Number of minutes in unit for Work units plugin.
73   var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
74   var $unit_totals_only = 0;    // Totals only option for the Work units plugin.
75
76   // Constructor.
77   function __construct($login, $id = null) {
78     if (!$login && !$id) {
79       // nothing to initialize
80       return;
81     }
82
83     $mdb2 = getConnection();
84
85     $sql = "SELECT u.id, u.login, u.name, u.group_id, u.role_id, r.rank, r.name as role_name, r.rights, u.client_id, u.email,
86       g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
87       g.tracking_mode, g.project_required, g.task_required, g.record_type,
88       g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
89       FROM tt_users u LEFT JOIN tt_groups g ON (u.group_id = g.id) LEFT JOIN tt_roles r on (r.id = u.role_id) WHERE ";
90     if ($id)
91       $sql .= "u.id = $id";
92     else
93       $sql .= "u.login = ".$mdb2->quote($login);
94     $sql .= " AND u.status = 1";
95
96     $res = $mdb2->query($sql);
97     if (is_a($res, 'PEAR_Error')) {
98       return;
99     }
100
101     $val = $res->fetchRow();
102     if ($val['id'] > 0) {
103       $this->login = $val['login'];
104       $this->name = $val['name'];
105       $this->id = $val['id'];
106       $this->org_id = $val['org_id'];
107       $this->group_id = $val['group_id'];
108       $this->role_id = $val['role_id'];
109       $this->role_name = $val['role_name'];
110       $this->rights = explode(',', $val['rights']);
111       $this->is_client = !in_array('track_own_time', $this->rights);
112       $this->rank = $val['rank'];
113       $this->client_id = $val['client_id'];
114       $this->email = $val['email'];
115       $this->lang = $val['lang'];
116       $this->decimal_mark = $val['decimal_mark'];
117       $this->date_format = $val['date_format'];
118       $this->time_format = $val['time_format'];
119       $this->week_start = $val['week_start'];
120       $this->tracking_mode = $val['tracking_mode'];
121       $this->project_required = $val['project_required'];
122       $this->task_required = $val['task_required'];
123       $this->record_type = $val['record_type'];
124       $this->bcc_email = $val['bcc_email'];
125       $this->allow_ip = $val['allow_ip'];
126       $this->password_complexity = $val['password_complexity'];
127       $this->group = $val['group_name'];
128       $this->currency = $val['currency'];
129       $this->plugins = $val['plugins'];
130       $this->lock_spec = $val['lock_spec'];
131       $this->workday_minutes = $val['workday_minutes'];
132       $this->custom_logo = $val['custom_logo'];
133
134       $this->config = $val['config'];
135       $config = new ttConfigHelper($this->config);
136       // Set user config options.
137       $this->show_holidays = $config->getDefinedValue('show_holidays');
138       $this->punch_mode = $config->getDefinedValue('punch_mode');
139       $this->allow_overlap = $config->getDefinedValue('allow_overlap');
140       $this->future_entries = $config->getDefinedValue('future_entries');
141       $this->uncompleted_indicators = $config->getDefinedValue('uncompleted_indicators');
142       if ($this->isPluginEnabled('wu')) {
143         $minutes_in_unit = $config->getIntValue('minutes_in_unit');
144         if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
145         $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
146         if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
147         $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
148       }
149       
150       // Set "on behalf" id and name (user).
151       if (isset($_SESSION['behalf_id'])) {
152           $this->behalf_id = $_SESSION['behalf_id'];
153           $this->behalf_name = $_SESSION['behalf_name'];
154       }
155       // Set "on behalf" id and name (group).
156       if (isset($_SESSION['behalf_group_id'])) {
157           $this->behalf_group_id = $_SESSION['behalf_group_id'];
158           $this->behalf_group = $_SESSION['behalf_group'];
159       }
160     }
161   }
162
163   // The getActiveUser returns user id on behalf of whom the current user is operating.
164   function getActiveUser() {
165     return ($this->behalf_id ? $this->behalf_id : $this->id);
166   }
167
168   // The getActiveGroup returns group id on behalf of which the current user is operating.
169   function getActiveGroup() {
170     return ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
171   }
172
173   // can - determines whether user has a right to do something.
174   function can($do_something) {
175     return in_array($do_something, $this->rights);
176   }
177
178   // isClient - determines whether current user is a client.
179   function isClient() {
180     return $this->is_client;
181   }
182
183   // isPluginEnabled checks whether a plugin is enabled for user.
184   function isPluginEnabled($plugin)
185   {
186     return in_array($plugin, explode(',', $this->plugins));
187   }
188
189   // getAssignedProjects - returns an array of assigned projects.
190   function getAssignedProjects()
191   {
192     $result = array();
193     $mdb2 = getConnection();
194
195     // Do a query with inner join to get assigned projects.
196     $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
197       inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
198       where p.group_id = $this->group_id and p.status = 1 order by p.name";
199     $res = $mdb2->query($sql);
200     if (!is_a($res, 'PEAR_Error')) {
201       while ($val = $res->fetchRow()) {
202         $result[] = $val;
203       }
204     }
205     return $result;
206   }
207
208   // getAssignedTasks - returns an array of assigned tasks.
209   function getAssignedTasks()
210   {
211     // Start with projects;
212     $projects = $this->getAssignedProjects();
213     if (!$projects) return false;
214
215     // Build an array of task ids.
216     $task_ids = array();
217     foreach($projects as $project) {
218       $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
219       $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
220     }
221     if (!$task_ids) return false;
222
223     // Get task descriptions.
224     $result = array();
225     $mdb2 = getConnection();
226     $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
227
228     $sql = "select id, name, description from tt_tasks".
229       " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
230     $res = $mdb2->query($sql);
231     if (!is_a($res, 'PEAR_Error')) {
232       while ($val = $res->fetchRow()) {
233         $result[] = $val;
234       }
235     }
236     return $result;
237   }
238
239   // getAssignedClients - returns an array of clients assigned to own projects.
240   function getAssignedClients()
241   {
242     // Start with projects;
243     $projects = $this->getAssignedProjects();
244     if (!$projects) return false;
245     $assigned_project_ids = array();
246     foreach($projects as $project) {
247       $assigned_project_ids[] = $project['id'];
248     }
249
250     $mdb2 = getConnection();
251
252     // Get active clients for group.
253     $clients = array();
254     $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
255     $res = $mdb2->query($sql);
256     if (!is_a($res, 'PEAR_Error')) {
257       while ($val = $res->fetchRow()) {
258         $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
259         if (array_intersect($assigned_project_ids, $client_project_ids))
260           $clients[] = $val; // Add client if one of user projects is a client project, too.
261       }
262     }
263     return $clients;
264   }
265
266   // isDateLocked checks whether a specifc date is locked for modifications.
267   function isDateLocked($date)
268   {
269     if (!$this->isPluginEnabled('lk'))
270       return false; // Locking feature is disabled.
271
272     if (!$this->lock_spec)
273       return false; // There is no lock specification.
274
275     if (!$this->behalf_id && $this->can('override_own_date_lock'))
276       return false; // User is working as self and can override own date lock.
277
278     if ($this->behalf_id && $this->can('override_date_lock'))
279       return false; // User is working on behalf of someone else and can override date lock.
280
281     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
282     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
283
284     // Calculate the last occurrence of a lock.
285     $last = tdCron::getLastOccurrence($this->lock_spec, time());
286     $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
287     if ($date->before($lockdate))
288       return true;
289
290     return false;
291   }
292
293   // canOverridePunchMode checks whether a user can override punch mode in a situation.
294   function canOverridePunchMode()
295   {
296     if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
297       return false; // User is working as self and cannot override for self.
298
299     if ($this->behalf_id && !$this->can('override_punch_mode'))
300       return false; // User is working on behalf of someone else and cannot override.
301
302     return true;
303   }
304
305   // getUsers obtains users in a group, as specififed by options.
306   function getUsers($options) {
307
308     $mdb2 = getConnection();
309
310     $skipClients = !isset($options['include_clients']);
311     $includeSelf = isset($options['include_self']);
312
313     $select_part = 'select u.id, u.name';
314     if (isset($options['include_login'])) $select_part .= ', u.login';
315     if (!isset($options['include_clients'])) $select_part .= ', r.rights';
316     if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
317
318     $from_part = ' from tt_users u';
319
320     $left_joins = null;
321     if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
322         $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
323
324     $where_part = " where u.group_id = $this->group_id";
325     if (isset($options['status']))
326       $where_part .= ' and u.status = '.(int)$options['status'];
327     else
328       $where_part .= ' and u.status is not null';
329     if ($includeSelf) {
330       $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
331     } else {
332       if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
333     }
334
335     $order_part = " order by upper(u.name)";
336
337     $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
338     $res = $mdb2->query($sql);
339     $user_list = array();
340     if (is_a($res, 'PEAR_Error'))
341       return false;
342
343     while ($val = $res->fetchRow()) {
344       if ($skipClients) {
345         $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
346         if ($isClient)
347           continue; // Skip adding clients.
348       }
349       $user_list[] = $val;
350     }
351
352     if (isset($options['self_first'])) {
353       // Put own entry at the front.
354       $cnt = count($user_list);
355       for($i = 0; $i < $cnt; $i++) {
356         if ($user_list[$i]['id'] == $this->id) {
357           $self = $user_list[$i]; // Found self.
358           array_unshift($user_list, $self); // Put own entry at the front.
359           array_splice($user_list, $i+1, 1); // Remove duplicate.
360         }
361       }
362     }
363     return $user_list;
364   }
365
366   // getGroups obtains an array consisting of:
367   // - A parent group (..) of a currently selected group, if available.
368   // - A currently selected group (.) represented by $behalf_group_id.
369   // - All subgroups (only immediate children) of a currently selected group.
370   function getGroups() {
371     $mdb2 = getConnection();
372
373     $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
374
375     // Start with parent group.
376     if ($selected_group_id != $this->org_id) {
377       // We are in one of the subgroups, and a parent exists.
378       // Get parent group info.
379       $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $selected_group_id";
380       $res = $mdb2->query($sql);
381       if (!is_a($res, 'PEAR_Error')) {
382         $val = $res->fetchRow();
383         $parent_id = $val['parent_id'];
384         if ($parent_id) {
385           // Get parent group name.
386           $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id";
387           $res = $mdb2->query($sql);
388           if (!is_a($res, 'PEAR_Error')) {
389             $val = $res->fetchRow();
390             $groups[] = array('id'=>$parent_id,'name'=>$val['name']);
391           }
392         }
393       }
394     }
395
396     // Add current group.
397     $selected_group_name = ($this->behalf_group_id ? $this->behalf_group : $this->group);
398     $groups[] = array('id'=>$selected_group_id,'name'=>$selected_group_name);
399
400     // Add subgroups.
401     $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $selected_group_id";
402     $res = $mdb2->query($sql);
403     if (!is_a($res, 'PEAR_Error')) {
404       while ($val = $res->fetchRow()) {
405         $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
406       }
407     }
408     return $groups;
409   }
410
411   // getUser function is used to manage users in group and returns user details.
412   // At the moment, the function is used for user edits and deletes.
413   function getUser($user_id) {
414     if (!$this->can('manage_users')) return false;
415
416     $mdb2 = getConnection();
417
418     $sql =  "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
419             " left join tt_roles r on (u.role_id = r.id)".
420             " where u.id = $user_id and u.group_id = $this->group_id and u.status is not null".
421             " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
422     $res = $mdb2->query($sql);
423     if (!is_a($res, 'PEAR_Error')) {
424       $val = $res->fetchRow();
425       return $val;
426     }
427     return false;
428   }
429
430   // checkBehalfId checks whether behalf_id is appropriate.
431   // On behalf user must be active and have lower rank.
432   function checkBehalfId() {
433     $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
434     $users = $this->getUsers($options);
435     foreach($users as $one_user) {
436       if ($one_user['id'] == $this->behalf_id)
437         return true;
438     }
439     return false;
440   }
441
442   // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
443   // apropriate user.
444   //
445   // Needed for situations when user does not have do_own_something right.
446   // Example: has view_charts but does not have view_own_charts.
447   // In this case we still allow access to charts, but set behalf_id to someone else.
448   function adjustBehalfId() {
449     $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
450     $users = $this->getUsers($options);
451     foreach($users as $one_user) {
452       // Fake loop to access first element.
453       $this->behalf_id = $one_user['id'];
454       $this->behalf_name = $one_user['name'];
455       $_SESSION['behalf_id'] = $this->behalf_id;
456       $_SESSION['behalf_name'] = $this->behalf_name;
457       return true;
458     }
459     return false;
460   }
461
462   // updateGroup updates group information with new data.
463   function updateGroup($fields) {
464     if (!($this->can('manage_basic_settings') ||
465       $this->can('manage_advanced_settings') ||
466       $this->can('manage_features'))) return false;
467
468     $mdb2 = getConnection();
469
470     if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
471     if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
472     if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
473     if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
474     if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
475     if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
476     if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
477     if (isset($fields['tracking_mode'])) {
478       $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
479       $project_required_part = ' , project_required = '.(int) $fields['project_required'];
480       $task_required_part = ' , task_required = '.(int) $fields['task_required'];
481     }
482     if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
483     if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
484     if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
485     if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
486     if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
487     if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
488     if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
489     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
490
491     $parts = trim($name_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
492       $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
493       $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
494
495     $sql = "update tt_groups set $parts where id = $this->group_id";
496     $affected = $mdb2->exec($sql);
497     if (is_a($affected, 'PEAR_Error')) return false;
498
499     return true;
500   }
501
502   // markUserDeleted marks a user in group as deleted.
503   function markUserDeleted($user_id) {
504     if (!$this->can('manage_users') || $this->id == $user_id)
505       return false;
506
507     // Make sure we operate on a legit user.
508     $user_details = $this->getUser($user_id);
509     if (!$user_details) return false;
510
511     $mdb2 = getConnection();
512
513     // Mark user to project binds as deleted.
514     $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
515     $affected = $mdb2->exec($sql);
516     if (is_a($affected, 'PEAR_Error'))
517       return false;
518
519     // Mark user favorite reports as deleted.
520     $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
521     $affected = $mdb2->exec($sql);
522     if (is_a($affected, 'PEAR_Error'))
523       return false;
524
525     // Mark user as deleted.
526     $sql = "update tt_users set status = NULL where id = $user_id and group_id = ".$this->group_id;
527     $affected = $mdb2->exec($sql);
528     if (is_a($affected, 'PEAR_Error'))
529       return false;
530
531     return true;
532   }
533
534   // enablePlugin either enables or disables a specific plugin for group.
535   function enablePlugin($plugin, $enable = true)
536   {
537     if (!$this->can('manage_advanced_settings'))
538       return false; // Note: enablePlugin is currently only used on week_view.php.
539                     // So, it's not really a plugin we are enabling, but rather week view display options.
540                     // Therefore, a check for manage_advanced_settings, not manage_features.
541
542     $plugin_array = explode(',', $this->plugins);
543     if ($enable && !in_array($plugin, $plugin_array))
544       $plugin_array[] = $plugin; // Add plugin to array.
545
546     if (!$enable && in_array($plugin, $plugin_array)) {
547       $key = array_search($plugin, $plugin_array);
548       if ($key !== false)
549         unset($plugin_array[$key]); // Remove plugin from array.
550     }
551
552     $plugins = implode(',', $plugin_array);
553     if ($plugins != $this->plugins) {
554       if (!$this->updateGroup(array('plugins' => $plugins)))
555         return false;
556       $this->plugins = $plugins;
557     }
558
559     return true;
560   }
561 }