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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 import('ttConfigHelper');
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 $group_name = null; // Group name.
45 var $behalf_group_name = null;// Group name, on behalf of which we are working.
46 var $email = null; // User email.
47 var $lang = null; // Language.
48 var $decimal_mark = null; // Decimal separator.
49 var $date_format = null; // Date format.
50 var $time_format = null; // Time format.
51 var $week_start = 0; // Week start day.
52 var $show_holidays = 0; // Whether to show holidays in calendar.
53 var $tracking_mode = 0; // Tracking mode.
54 var $project_required = 0; // Whether project selection is required on time entires.
55 var $task_required = 0; // Whether task selection is required on time entires.
56 var $record_type = 0; // Record type (duration vs start and finish, or both).
57 var $punch_mode = 0; // Whether punch mode is enabled for user.
58 var $allow_overlap = 0; // Whether to allow overlapping time entries.
59 var $future_entries = 0; // Whether to allow creating future entries.
60 var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
61 var $bcc_email = null; // Bcc email.
62 var $allow_ip = null; // Specification from where user is allowed access.
63 var $password_complexity = null; // Password complexity example.
64 var $currency = null; // Currency.
65 var $plugins = null; // Comma-separated list of enabled plugins.
66 var $config = null; // Comma-separated list of miscellaneous config options.
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.
77 function __construct($login, $id = null) {
78 if (!$login && !$id) {
79 // nothing to initialize
83 $mdb2 = getConnection();
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 ";
93 $sql .= "u.login = ".$mdb2->quote($login);
94 $sql .= " AND u.status = 1";
96 $res = $mdb2->query($sql);
97 if (is_a($res, 'PEAR_Error')) {
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_name = $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'];
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');
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'];
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_name = $_SESSION['behalf_group_name'];
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);
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);
173 // can - determines whether user has a right to do something.
174 function can($do_something) {
175 return in_array($do_something, $this->rights);
178 // isClient - determines whether current user is a client.
179 function isClient() {
180 return $this->is_client;
183 // isPluginEnabled checks whether a plugin is enabled for user.
184 function isPluginEnabled($plugin)
186 return in_array($plugin, explode(',', $this->plugins));
189 // getAssignedProjects - returns an array of assigned projects.
190 function getAssignedProjects()
193 $mdb2 = getConnection();
195 $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
196 // Do a query with inner join to get assigned projects.
197 $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
198 inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
199 where p.group_id = $group_id and p.status = 1 order by p.name";
200 $res = $mdb2->query($sql);
201 if (!is_a($res, 'PEAR_Error')) {
202 while ($val = $res->fetchRow()) {
209 // getAssignedTasks - returns an array of assigned tasks.
210 function getAssignedTasks()
212 // Start with projects;
213 $projects = $this->getAssignedProjects();
214 if (!$projects) return false;
216 // Build an array of task ids.
218 foreach($projects as $project) {
219 $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
220 $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
222 if (!$task_ids) return false;
224 // Get task descriptions.
226 $mdb2 = getConnection();
227 $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
229 $sql = "select id, name, description from tt_tasks".
230 " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
231 $res = $mdb2->query($sql);
232 if (!is_a($res, 'PEAR_Error')) {
233 while ($val = $res->fetchRow()) {
240 // getAssignedClients - returns an array of clients assigned to own projects.
241 function getAssignedClients()
243 // Start with projects;
244 $projects = $this->getAssignedProjects();
245 if (!$projects) return false;
246 $assigned_project_ids = array();
247 foreach($projects as $project) {
248 $assigned_project_ids[] = $project['id'];
251 $mdb2 = getConnection();
253 // Get active clients for group.
255 $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
256 $res = $mdb2->query($sql);
257 if (!is_a($res, 'PEAR_Error')) {
258 while ($val = $res->fetchRow()) {
259 $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
260 if (array_intersect($assigned_project_ids, $client_project_ids))
261 $clients[] = $val; // Add client if one of user projects is a client project, too.
267 // isDateLocked checks whether a specifc date is locked for modifications.
268 function isDateLocked($date)
270 if (!$this->isPluginEnabled('lk'))
271 return false; // Locking feature is disabled.
273 if (!$this->lock_spec)
274 return false; // There is no lock specification.
276 if (!$this->behalf_id && $this->can('override_own_date_lock'))
277 return false; // User is working as self and can override own date lock.
279 if ($this->behalf_id && $this->can('override_date_lock'))
280 return false; // User is working on behalf of someone else and can override date lock.
282 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
283 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
285 // Calculate the last occurrence of a lock.
286 $last = tdCron::getLastOccurrence($this->lock_spec, time());
287 $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
288 if ($date->before($lockdate))
294 // canOverridePunchMode checks whether a user can override punch mode in a situation.
295 function canOverridePunchMode()
297 if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
298 return false; // User is working as self and cannot override for self.
300 if ($this->behalf_id && !$this->can('override_punch_mode'))
301 return false; // User is working on behalf of someone else and cannot override.
306 // getUsers obtains users in a group, as specififed by options.
307 function getUsers($options) {
309 $mdb2 = getConnection();
311 $skipClients = !isset($options['include_clients']);
312 $includeSelf = isset($options['include_self']);
313 $group_id = isset($options['group_id']) ? $options['group_id'] : $this->group_id;
315 $select_part = 'select u.id, u.name';
316 if (isset($options['include_login'])) $select_part .= ', u.login';
317 if (!isset($options['include_clients'])) $select_part .= ', r.rights';
318 if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
320 $from_part = ' from tt_users u';
323 if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
324 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
326 $where_part = " where u.org_id = $this->org_id and u.group_id = $group_id";
327 if (isset($options['status']))
328 $where_part .= ' and u.status = '.(int)$options['status'];
330 $where_part .= ' and u.status is not null';
332 $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
334 if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
337 $order_part = " order by upper(u.name)";
339 $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
340 $res = $mdb2->query($sql);
341 $user_list = array();
342 if (is_a($res, 'PEAR_Error'))
345 while ($val = $res->fetchRow()) {
347 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
349 continue; // Skip adding clients.
354 if (isset($options['self_first'])) {
355 // Put own entry at the front.
356 $cnt = count($user_list);
357 for($i = 0; $i < $cnt; $i++) {
358 if ($user_list[$i]['id'] == $this->id) {
359 $self = $user_list[$i]; // Found self.
360 array_unshift($user_list, $self); // Put own entry at the front.
361 array_splice($user_list, $i+1, 1); // Remove duplicate.
368 // getGroups obtains an array consisting of:
369 // - A parent group (..) of a currently selected group, if available.
370 // - A currently selected group (.) represented by $behalf_group_id.
371 // - All subgroups (only immediate children) of a currently selected group.
372 function getGroups() {
373 $mdb2 = getConnection();
375 $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
376 $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
378 // Start with parent group.
379 if ($selected_group_id != $this->group_id) {
380 // We are in one of subgroups, and a parent exists.
381 // Get parent group info.
382 $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $selected_group_id";
383 $res = $mdb2->query($sql);
384 if (!is_a($res, 'PEAR_Error')) {
385 $val = $res->fetchRow();
386 $parent_id = $val['parent_id'];
388 // Get parent group name.
389 $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id";
390 $res = $mdb2->query($sql);
391 if (!is_a($res, 'PEAR_Error')) {
392 $val = $res->fetchRow();
393 $groups[] = array('id'=>$parent_id,'name'=>$val['name']);
399 // Add current group.
400 $groups[] = array('id'=>$selected_group_id,'name'=>$selected_group_name);
403 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $selected_group_id";
404 $res = $mdb2->query($sql);
405 if (!is_a($res, 'PEAR_Error')) {
406 while ($val = $res->fetchRow()) {
407 $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
413 // getSubgroups obtains a list of immediate subgroups.
414 function getSubgroups() {
415 $mdb2 = getConnection();
417 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = ".$this->getActiveGroup();;
418 $res = $mdb2->query($sql);
419 if (!is_a($res, 'PEAR_Error')) {
420 while ($val = $res->fetchRow()) {
421 $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
427 // getUser function is used to manage users in group and returns user details.
428 // At the moment, the function is used for user edits and deletes.
429 function getUser($user_id) {
430 if (!$this->can('manage_users')) return false;
432 $mdb2 = getConnection();
434 $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
435 " left join tt_roles r on (u.role_id = r.id)".
436 " where u.id = $user_id and u.group_id = $this->group_id and u.status is not null".
437 " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
438 $res = $mdb2->query($sql);
439 if (!is_a($res, 'PEAR_Error')) {
440 $val = $res->fetchRow();
446 // checkBehalfId checks whether behalf_id is appropriate.
447 // On behalf user must be active and have lower rank if the user is from home group,
449 // - subgroup must ve valid;
450 // - user should be a member of it.
451 function checkBehalfId() {
452 if (!$this->behalf_group_id) {
453 // Checking user from home group.
454 $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
455 $users = $this->getUsers($options);
456 foreach($users as $one_user) {
457 if ($one_user['id'] == $this->behalf_id)
461 // Checking user from a subgroup.
462 $group_id = $this->behalf_group_id;
463 if (!$this->isSubgroupValid($group_id))
466 // So far, so good. Check user now.
467 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
468 $users = $this->getUsers($options);
469 foreach($users as $one_user) {
470 if ($one_user['id'] == $this->behalf_id)
477 // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
480 // Needed for situations when user does not have do_own_something right.
481 // Example: has view_charts but does not have view_own_charts.
482 // In this case we still allow access to charts, but set behalf_id to someone else.
483 // Another example: working in a subgroup on behalf of someone else.
484 function adjustBehalfId() {
485 $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
486 $rank = $this->getMaxRankForGroup($group_id);
488 // Adjust to first found user in group.
489 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
490 $users = $this->getUsers($options);
491 foreach($users as $one_user) {
492 // Fake loop to access first element.
493 $this->behalf_id = $one_user['id'];
494 $this->behalf_name = $one_user['name'];
495 $_SESSION['behalf_id'] = $this->behalf_id;
496 $_SESSION['behalf_name'] = $this->behalf_name;
502 // updateGroup updates group information with new data.
503 function updateGroup($fields) {
504 if (!($this->can('manage_basic_settings') ||
505 $this->can('manage_advanced_settings') ||
506 $this->can('manage_features'))) return false;
508 $mdb2 = getConnection();
510 if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
511 if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
512 if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
513 if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
514 if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
515 if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
516 if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
517 if (isset($fields['tracking_mode'])) {
518 $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
519 $project_required_part = ' , project_required = '.(int) $fields['project_required'];
520 $task_required_part = ' , task_required = '.(int) $fields['task_required'];
522 if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
523 if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
524 if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
525 if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
526 if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
527 if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
528 if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
529 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
531 $parts = trim($name_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
532 $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
533 $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
535 $sql = "update tt_groups set $parts where id = $this->group_id";
536 $affected = $mdb2->exec($sql);
537 if (is_a($affected, 'PEAR_Error')) return false;
542 // markUserDeleted marks a user in group as deleted.
543 function markUserDeleted($user_id) {
544 if (!$this->can('manage_users') || $this->id == $user_id)
547 // Make sure we operate on a legit user.
548 $user_details = $this->getUser($user_id);
549 if (!$user_details) return false;
551 $mdb2 = getConnection();
553 // Mark user to project binds as deleted.
554 $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
555 $affected = $mdb2->exec($sql);
556 if (is_a($affected, 'PEAR_Error'))
559 // Mark user favorite reports as deleted.
560 $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
561 $affected = $mdb2->exec($sql);
562 if (is_a($affected, 'PEAR_Error'))
565 // Mark user as deleted.
566 $sql = "update tt_users set status = NULL where id = $user_id and group_id = ".$this->group_id;
567 $affected = $mdb2->exec($sql);
568 if (is_a($affected, 'PEAR_Error'))
574 // enablePlugin either enables or disables a specific plugin for group.
575 function enablePlugin($plugin, $enable = true)
577 if (!$this->can('manage_advanced_settings'))
578 return false; // Note: enablePlugin is currently only used on week_view.php.
579 // So, it's not really a plugin we are enabling, but rather week view display options.
580 // Therefore, a check for manage_advanced_settings, not manage_features.
582 $plugin_array = explode(',', $this->plugins);
583 if ($enable && !in_array($plugin, $plugin_array))
584 $plugin_array[] = $plugin; // Add plugin to array.
586 if (!$enable && in_array($plugin, $plugin_array)) {
587 $key = array_search($plugin, $plugin_array);
589 unset($plugin_array[$key]); // Remove plugin from array.
592 $plugins = implode(',', $plugin_array);
593 if ($plugins != $this->plugins) {
594 if (!$this->updateGroup(array('plugins' => $plugins)))
596 $this->plugins = $plugins;
602 // isSubgroupValid determines if a subgroup is valid for user.
603 // A subgroup is valid if:
604 // - user can manage_subgroups;
605 // - subgroup is either a direct child of user group, or "on the path"
606 // to it (grand-child, etc.).
607 function isSubgroupValid($subgroup_id) {
608 if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
610 $current_group_id = $subgroup_id;
611 while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
612 if ($parent_group_id == $this->group_id) {
613 return true; // Found it.
615 $current_group_id = $parent_group_id;
620 // getMaxRankForGroup determines effective user rank for a user in a given group.
621 // For home group it is the existing user rank (as per role) minus 1.
622 // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
623 function getMaxRankForGroup($group_id) {
625 $max_rank = 0; // Start safely.
626 if ($this->group_id == $group_id) {
627 $max_rank = $this->rank - 1;
631 if ($this->isSubgroupValid($group_id))
632 $max_rank = MAX_RANK;