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