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');
30 import('ttGroupHelper');
34 var $login = null; // User login.
35 var $name = null; // User name.
36 var $id = null; // User id.
37 var $org_id = null; // Organization id.
38 var $group_id = null; // Group id.
39 var $role_id = null; // Role id.
40 var $role_name = null; // Role name.
41 var $rank = null; // User role rank.
42 var $client_id = null; // Client id for client user role.
43 var $behalf_id = null; // User id, on behalf of whom we are working.
44 var $behalf_group_id = null; // Group id, on behalf of which we are working.
45 var $behalf_name = null; // User name, on behalf of whom we are working.
46 var $group_name = null; // Group name.
47 var $behalf_group_name = null;// Group name, on behalf of which we are working.
48 var $email = null; // User email.
49 var $lang = null; // Language.
50 var $decimal_mark = null; // Decimal separator.
51 var $date_format = null; // Date format.
52 var $time_format = null; // Time format.
53 var $week_start = 0; // Week start day.
54 var $show_holidays = 0; // Whether to show holidays in calendar.
55 var $tracking_mode = 0; // Tracking mode.
56 var $project_required = 0; // Whether project selection is required on time entires.
57 var $task_required = 0; // Whether task selection is required on time entires.
58 var $record_type = 0; // Record type (duration vs start and finish, or both).
59 var $punch_mode = 0; // Whether punch mode is enabled for user.
60 var $allow_overlap = 0; // Whether to allow overlapping time entries.
61 var $future_entries = 0; // Whether to allow creating future entries.
62 var $bcc_email = null; // Bcc email.
63 var $allow_ip = null; // Specification from where user is allowed access.
64 var $password_complexity = null; // Password complexity example.
65 var $currency = null; // Currency.
66 var $plugins = null; // Comma-separated list of enabled plugins.
67 var $config = null; // Comma-separated list of miscellaneous config options.
68 var $custom_logo = 0; // Whether to use a custom logo for group.
69 var $lock_spec = null; // Cron specification for record locking.
70 var $workday_minutes = 480; // Number of work minutes in a regular day.
71 var $rights = array(); // An array of user rights such as 'track_own_time', etc.
72 var $is_client = false; // Whether user is a client as determined by missing 'track_own_time' right.
73 var $minutes_in_unit = 15; // Number of minutes in unit for Work units plugin.
74 var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
75 var $unit_totals_only = 0; // Totals only option for the Work units plugin.
77 var $behalfGroup = null; // A ttGroup instance with on behalf group attributes.
80 function __construct($login, $id = null) {
81 if (!$login && !$id) {
82 // nothing to initialize
86 $mdb2 = getConnection();
88 $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,
89 g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
90 g.tracking_mode, g.project_required, g.task_required, g.record_type,
91 g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
92 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 ";
96 $sql .= "u.login = ".$mdb2->quote($login);
97 $sql .= " AND u.status = 1";
99 $res = $mdb2->query($sql);
100 if (is_a($res, 'PEAR_Error')) {
104 $val = $res->fetchRow();
105 if ($val['id'] > 0) {
106 $this->login = $val['login'];
107 $this->name = $val['name'];
108 $this->id = $val['id'];
109 $this->org_id = $val['org_id'];
110 $this->group_id = $val['group_id'];
111 $this->role_id = $val['role_id'];
112 $this->role_name = $val['role_name'];
113 $this->rights = explode(',', $val['rights']);
114 $this->is_client = !in_array('track_own_time', $this->rights);
115 $this->rank = $val['rank'];
116 $this->client_id = $val['client_id'];
117 $this->email = $val['email'];
118 $this->lang = $val['lang'];
119 $this->decimal_mark = $val['decimal_mark'];
120 $this->date_format = $val['date_format'];
121 $this->time_format = $val['time_format'];
122 $this->week_start = $val['week_start'];
123 $this->tracking_mode = $val['tracking_mode'];
124 $this->project_required = $val['project_required'];
125 $this->task_required = $val['task_required'];
126 $this->record_type = $val['record_type'];
127 $this->bcc_email = $val['bcc_email'];
128 $this->allow_ip = $val['allow_ip'];
129 $this->password_complexity = $val['password_complexity'];
130 $this->group_name = $val['group_name'];
131 $this->currency = $val['currency'];
132 $this->plugins = $val['plugins'];
133 $this->lock_spec = $val['lock_spec'];
134 $this->workday_minutes = $val['workday_minutes'];
135 $this->custom_logo = $val['custom_logo'];
137 $this->config = $val['config'];
138 $config = new ttConfigHelper($this->config);
139 // Set user config options.
140 $this->show_holidays = $config->getDefinedValue('show_holidays');
141 $this->punch_mode = $config->getDefinedValue('punch_mode');
142 $this->allow_overlap = $config->getDefinedValue('allow_overlap');
143 $this->future_entries = $config->getDefinedValue('future_entries');
144 if ($this->isPluginEnabled('wu')) {
145 $minutes_in_unit = $config->getIntValue('minutes_in_unit');
146 if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
147 $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
148 if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
149 $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
152 // Set "on behalf" id and name (user).
153 if (isset($_SESSION['behalf_id'])) {
154 $this->behalf_id = $_SESSION['behalf_id'];
155 $this->behalf_name = $_SESSION['behalf_name'];
157 // Set "on behalf" id and name (group).
158 if (isset($_SESSION['behalf_group_id'])) {
159 $this->behalf_group_id = $_SESSION['behalf_group_id'];
160 $this->behalf_group_name = $_SESSION['behalf_group_name'];
162 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
167 // The getUser returns user id on behalf of whom the current user is operating.
169 return ($this->behalf_id ? $this->behalf_id : $this->id);
172 // The getGroup returns group id on behalf of which the current user is operating.
173 function getGroup() {
174 return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
177 // getDecimalMark returns decimal mark for active group.
178 function getDecimalMark() {
179 return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
182 // getTrackingMode returns tracking mode for active group.
183 function getTrackingMode() {
184 return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
187 // getRecordType returns record type for active group.
188 function getRecordType() {
189 return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
192 // getPlugins returns plugins string for active group.
193 function getPlugins() {
194 return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
197 // getConfig returns config string for active group.
198 function getConfig() {
199 return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
202 // getConfigOption returns true if an option is defined for group.
203 // This helps us keeping a set of user attributes smaller.
204 // We determine whether the option is set only on pages that need to know.
205 // For example: confirm_save is used only on time and expense edit pages.
206 function getConfigOption($name) {
207 $config = new ttConfigHelper($this->getConfig());
208 return $config->getDefinedValue($name);
211 // can - determines whether user has a right to do something.
212 function can($do_something) {
213 return in_array($do_something, $this->rights);
216 // isClient - determines whether current user is a client.
217 function isClient() {
218 return $this->is_client;
221 // isPluginEnabled checks whether a plugin is enabled for user.
222 function isPluginEnabled($plugin)
224 return in_array($plugin, explode(',', $this->getPlugins()));
227 // getAssignedProjects - returns an array of assigned projects.
228 function getAssignedProjects()
231 $mdb2 = getConnection();
233 $group_id = $this->getGroup();
234 $org_id = $this->org_id;
235 $user_id = $this->getUser();
237 // Do a query with inner join to get assigned projects.
238 $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p".
239 " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id and upb.status = 1)".
240 " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
241 $res = $mdb2->query($sql);
242 if (!is_a($res, 'PEAR_Error')) {
243 while ($val = $res->fetchRow()) {
250 // getAssignedTasks - returns an array of assigned tasks.
251 function getAssignedTasks()
253 // Start with projects;
254 $projects = $this->getAssignedProjects();
255 if (!$projects) return false;
257 // Build an array of task ids.
259 foreach($projects as $project) {
260 $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
261 $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
263 if (!$task_ids) return false;
265 // Get task descriptions.
267 $mdb2 = getConnection();
268 $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
270 $sql = "select id, name, description from tt_tasks".
271 " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
272 $res = $mdb2->query($sql);
273 if (!is_a($res, 'PEAR_Error')) {
274 while ($val = $res->fetchRow()) {
281 // getAssignedClients - returns an array of clients assigned to own projects.
282 function getAssignedClients()
284 // Start with projects;
285 $projects = $this->getAssignedProjects();
286 if (!$projects) return false;
287 $assigned_project_ids = array();
288 foreach($projects as $project) {
289 $assigned_project_ids[] = $project['id'];
292 $mdb2 = getConnection();
294 $group_id = $this->getGroup();
295 $org_id = $this->org_id;
297 // Get active clients for group.
299 $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
300 $res = $mdb2->query($sql);
301 if (!is_a($res, 'PEAR_Error')) {
302 while ($val = $res->fetchRow()) {
303 $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
304 if (array_intersect($assigned_project_ids, $client_project_ids))
305 $clients[] = $val; // Add client if one of user projects is a client project, too.
311 // isDateLocked checks whether a specifc date is locked for modifications.
312 function isDateLocked($date)
314 if (!$this->isPluginEnabled('lk'))
315 return false; // Locking feature is disabled.
317 if (!$this->lock_spec)
318 return false; // There is no lock specification.
320 if (!$this->behalf_id && $this->can('override_own_date_lock'))
321 return false; // User is working as self and can override own date lock.
323 if ($this->behalf_id && $this->can('override_date_lock'))
324 return false; // User is working on behalf of someone else and can override date lock.
326 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
327 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
329 // Calculate the last occurrence of a lock.
330 $last = tdCron::getLastOccurrence($this->lock_spec, time());
331 $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
332 if ($date->before($lockdate))
338 // canOverridePunchMode checks whether a user can override punch mode in a situation.
339 function canOverridePunchMode()
341 if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
342 return false; // User is working as self and cannot override for self.
344 if ($this->behalf_id && !$this->can('override_punch_mode'))
345 return false; // User is working on behalf of someone else and cannot override.
350 // getUsers obtains users in a group, as specififed by options.
351 function getUsers($options) {
352 $mdb2 = getConnection();
354 $group_id = $this->getGroup();
355 $org_id = $this->org_id;
357 $skipClients = !isset($options['include_clients']);
358 $includeSelf = isset($options['include_self']);
360 $select_part = 'select u.id, u.group_id, u.name';
361 if (isset($options['include_login'])) $select_part .= ', u.login';
362 if (!isset($options['include_clients'])) $select_part .= ', r.rights';
363 if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
365 $from_part = ' from tt_users u';
368 if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
369 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
371 $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
372 if (isset($options['status']))
373 $where_part .= ' and u.status = '.(int)$options['status'];
375 $where_part .= ' and u.status is not null';
377 $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
379 if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
382 $order_part = " order by upper(u.name)";
384 $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
385 $res = $mdb2->query($sql);
386 $user_list = array();
387 if (is_a($res, 'PEAR_Error'))
390 while ($val = $res->fetchRow()) {
392 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
394 continue; // Skip adding clients.
399 if (isset($options['self_first'])) {
400 // Put own entry at the front.
401 $cnt = count($user_list);
402 for($i = 0; $i < $cnt; $i++) {
403 if ($user_list[$i]['id'] == $this->id) {
404 $self = $user_list[$i]; // Found self.
405 array_unshift($user_list, $self); // Put own entry at the front.
406 array_splice($user_list, $i+1, 1); // Remove duplicate.
413 // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
415 // - User home group.
416 // - The entire stack of groups all the way down to current on behalf group.
417 // - All immediate children of the current on behalf group.
418 // This allows user to navigate easily to home group, anything in between, and 1 level below.
420 // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
421 // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
422 // in some groups. We should check for feature availability on group change
423 // in post and redirect to feature_disabled.php when this happens.
424 // This will allow us to keep dropdown content consistent on all pages.
425 // Filtering content of the dropdown does not seem right.
427 // Note 2: Menu should display according to $user home group settings.
428 // Pages, should look according to $user->behalfGroup settings (if set).
429 // For example, if home group allows tasks, menu should display Tasks,
430 // even when we are on behalf of a subgroup without tasks.
432 // Note 3: Language of all pages should be as in $user home group even when
433 // subgroups have a different language.
434 function getGroupsForDropdown() {
435 $mdb2 = getConnection();
437 // Start with subgroups.
439 $group_id = $this->getGroup();
440 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
441 $res = $mdb2->query($sql);
442 if (!is_a($res, 'PEAR_Error')) {
443 while ($val = $res->fetchRow()) {
448 // Add current on behalf group to the beginning of array.
449 $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
450 $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
451 array_unshift($groups, array('id'=>$selected_group_id,'name'=>$selected_group_name));
453 // Iterate all the way to the home group, starting with selected ("on behalf") group.
454 $current_group_id = $selected_group_id;
455 while ($current_group_id != $this->group_id) {
456 $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
457 $res = $mdb2->query($sql);
458 if (is_a($res, 'PEAR_Error')) return false;
460 $val = $res->fetchRow();
461 $parent_id = $val['parent_id'];
463 // Get parent group name.
464 $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
465 $res = $mdb2->query($sql);
466 if (is_a($res, 'PEAR_Error')) return false;
467 $val = $res->fetchRow();
468 if (!$val) return false;
469 array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
470 $current_group_id = $parent_id;
478 // getSubgroups obtains a list of immediate subgroups.
479 function getSubgroups($group_id = null) {
480 $mdb2 = getConnection();
482 if (!$group_id) $group_id = $this->getGroup();
484 $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
485 " and parent_id = $group_id and status is not null order by upper(name)";
486 $res = $mdb2->query($sql);
487 if (!is_a($res, 'PEAR_Error')) {
488 while ($val = $res->fetchRow()) {
495 // getUserDetails function is used to manage users in group and returns user details.
496 // At the moment, the function is used for user edits and deletes.
497 function getUserDetails($user_id) {
498 if (!$this->can('manage_users')) return false;
500 $mdb2 = getConnection();
501 $group_id = $this->getGroup();
502 $org_id = $this->org_id;
504 // Determine max rank. If we are searching in on behalf group
505 // then rank restriction does not apply.
506 $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
508 $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
509 " left join tt_roles r on (u.role_id = r.id)".
510 " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
511 " and (r.rank < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self.
512 $res = $mdb2->query($sql);
513 if (!is_a($res, 'PEAR_Error')) {
514 $val = $res->fetchRow();
520 // checkBehalfId checks whether behalf_id is appropriate.
521 // On behalf user must be active and have lower rank if the user is from home group,
523 // - subgroup must ve valid;
524 // - user should be a member of it.
525 function checkBehalfId() {
526 if (!$this->behalf_group_id) {
527 // Checking user from home group.
528 $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
529 $users = $this->getUsers($options);
530 foreach($users as $one_user) {
531 if ($one_user['id'] == $this->behalf_id)
535 // Checking user from a subgroup.
536 $group_id = $this->behalf_group_id;
537 if (!$this->isSubgroupValid($group_id))
540 // So far, so good. Check user now.
541 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
542 $users = $this->getUsers($options);
543 foreach($users as $one_user) {
544 if ($one_user['id'] == $this->behalf_id)
551 // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
554 // Needed for situations when user does not have do_own_something right.
555 // Example: has view_charts but does not have view_own_charts.
556 // In this case we still allow access to charts, but set behalf_id to someone else.
557 // Another example: working in a subgroup on behalf of someone else.
558 function adjustBehalfId() {
559 $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
560 $rank = $this->getMaxRankForGroup($group_id);
562 // Adjust to first found user in group.
563 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
564 $users = $this->getUsers($options);
565 foreach($users as $one_user) {
566 // Fake loop to access first element.
567 $this->behalf_id = $one_user['id'];
568 $this->behalf_name = $one_user['name'];
569 $_SESSION['behalf_id'] = $this->behalf_id;
570 $_SESSION['behalf_name'] = $this->behalf_name;
576 // updateGroup updates group information with new data.
577 function updateGroup($fields) {
578 if (!($this->can('manage_basic_settings') ||
579 $this->can('manage_advanced_settings') ||
580 $this->can('manage_features'))) return false;
581 // TODO: update the above for subgroup updates.
583 $group_id = $fields['group_id'];
584 if ($group_id && !$this->isGroupValid($group_id)) return false;
586 $mdb2 = getConnection();
587 if (!$group_id) $group_id = $this->getGroup();
589 if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
590 if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
591 if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
592 if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
593 if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
594 if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
595 if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
596 if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
597 if (isset($fields['tracking_mode'])) {
598 $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
599 $project_required_part = ' , project_required = '.(int) $fields['project_required'];
600 $task_required_part = ' , task_required = '.(int) $fields['task_required'];
602 if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
603 if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
604 if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
605 if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
606 if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
607 if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
608 if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
609 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
611 $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
612 $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
613 $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
615 $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
616 $affected = $mdb2->exec($sql);
617 if (is_a($affected, 'PEAR_Error')) return false;
622 // markUserDeleted marks a user in group as deleted.
623 function markUserDeleted($user_id) {
624 if (!$this->can('manage_users') || $this->id == $user_id)
627 // Make sure we operate on a legit user.
628 $user_details = $this->getUserDetails($user_id);
629 if (!$user_details) return false;
631 $mdb2 = getConnection();
632 $group_id = $this->getGroup();
633 $org_id = $this->org_id;
635 // Mark user to project binds as deleted.
636 $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
637 " and group_id = $group_id and org_id = $org_id";
638 $affected = $mdb2->exec($sql);
639 if (is_a($affected, 'PEAR_Error'))
642 // Mark user favorite reports as deleted.
643 $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
644 " and group_id = $group_id and org_id = $org_id";
645 $affected = $mdb2->exec($sql);
646 if (is_a($affected, 'PEAR_Error'))
649 // Mark user as deleted.
650 $sql = "update tt_users set status = NULL where id = $user_id".
651 " and group_id = $group_id and org_id = $org_id";
652 $affected = $mdb2->exec($sql);
653 if (is_a($affected, 'PEAR_Error'))
659 // enablePlugin either enables or disables a specific plugin for group.
660 function enablePlugin($plugin, $enable = true)
662 if (!$this->can('manage_advanced_settings'))
663 return false; // Note: enablePlugin is currently only used on week_view.php.
664 // So, it's not really a plugin we are enabling, but rather week view display options.
665 // Therefore, a check for manage_advanced_settings, not manage_features.
667 $plugin_array = explode(',', $this->plugins);
668 if ($enable && !in_array($plugin, $plugin_array))
669 $plugin_array[] = $plugin; // Add plugin to array.
671 if (!$enable && in_array($plugin, $plugin_array)) {
672 $key = array_search($plugin, $plugin_array);
674 unset($plugin_array[$key]); // Remove plugin from array.
677 $plugins = implode(',', $plugin_array);
678 if ($plugins != $this->plugins) {
679 if (!$this->updateGroup(array('plugins' => $plugins)))
681 $this->plugins = $plugins;
687 // isUserValid determines if a user is valid for on behalf work.
688 function isUserValid($user_id) {
689 if ($user_id == $this->id)
691 return ($this->getUserDetails($user_id) != null);
694 // isGroupValid determines if a group is valid for user.
695 function isGroupValid($group_id) {
696 if ($group_id == $this->group_id)
699 return $this->isSubgroupValid($group_id);
702 // isSubgroupValid determines if a subgroup is valid for user.
703 // A subgroup is valid if:
704 // - user can manage_subgroups;
705 // - subgroup is either a direct child of user group, or "on the path"
706 // to it (grand-child, etc.).
707 function isSubgroupValid($subgroup_id) {
708 if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
710 $current_group_id = $subgroup_id;
711 while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
712 if ($parent_group_id == $this->group_id) {
713 return true; // Found it.
715 $current_group_id = $parent_group_id;
720 // getMaxRankForGroup determines effective user rank for a user in a given group.
721 // For home group it is the existing user rank (as per role) minus 1.
722 // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
723 function getMaxRankForGroup($group_id) {
725 $max_rank = 0; // Start safely.
726 if ($this->group_id == $group_id) {
727 $max_rank = $this->rank - 1;
731 if ($this->isSubgroupValid($group_id))
732 $max_rank = MAX_RANK;
737 // getUserPartForHeader constructs a string for user to display on pages header.
738 // It changes with "on behalf" attributes for both user and group.
739 function getUserPartForHeader() {
741 if (!$this->id) return null;
743 $user_part = htmlspecialchars($this->name);
744 $user_part .= ' - '.htmlspecialchars($this->role_name);
745 if ($this->behalf_id) {
746 $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
748 if ($this->behalf_group_id) {
749 $user_part .= ', <span class="onBehalf">'.htmlspecialchars($this->behalf_group_name).'</span>';
751 if ($this->group_name) // Note: we did not require group names in the past.
752 $user_part .= ', '.$this->group_name;
757 // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
758 function setOnBehalfGroup($group_id) {
760 // Unset things first.
761 $this->behalf_group_id = null;
762 $this->behalf_group_name = null;
763 $this->behalf_id = null;
764 $this->behalf_name = null;
765 unset($this->behalfGroup);
766 unset($_SESSION['behalf_group_id']);
767 unset($_SESSION['behalf_group_name']);
768 unset($_SESSION['behalf_id']);
769 unset($_SESSION['behalf_name']);
771 // Do not do anything if we don't have rights.
772 if (!$this->can('manage_subgroups')) return;
774 // No need to set if group is our home group.
775 if ($group_id == $this->group_id) return;
777 // No need to set if subgroup is not valid.
778 if (!$this->isSubgroupValid($group_id)) return;
780 // We are good to set on behalf group.
781 $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
782 $_SESSION['behalf_group_id'] = $group_id;
783 $_SESSION['behalf_group_name'] = $onBehalfGroupName;
784 $this->behalf_group_id = $group_id;
785 $this->behalf_group_name = $onBehalfGroupName;
787 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
789 // Adjust on behalf user.
790 $this->adjustBehalfId();
794 // setOnBehalfUser sets on behalf user both the object and the session.
795 function setOnBehalfUser($user_id) {
797 // Unset things first.
798 $this->behalf_id = null;
799 $this->behalf_name = null;
800 unset($_SESSION['behalf_id']);
801 unset($_SESSION['behalf_name']);
803 // No need to set if user is us.
804 if ($user_id == $this->id) return;
806 // No need to set if user id is not valid.
807 if (!$this->isUserValid($user_id)) return;
809 // We are good to set on behalf user.
810 $onBehalfUserName = ttUserHelper::getUserName($user_id);
811 $_SESSION['behalf_id'] = $user_id;
812 $_SESSION['behalf_name'] = $onBehalfUserName;
813 $this->behalf_id = $user_id;
814 $this->behalf_name = $onBehalfUserName;