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 $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
63 var $bcc_email = null; // Bcc email.
64 var $allow_ip = null; // Specification from where user is allowed access.
65 var $password_complexity = null; // Password complexity example.
66 var $currency = null; // Currency.
67 var $plugins = null; // Comma-separated list of enabled plugins.
68 var $config = null; // Comma-separated list of miscellaneous config options.
69 var $custom_logo = 0; // Whether to use a custom logo for group.
70 var $lock_spec = null; // Cron specification for record locking.
71 var $workday_minutes = 480; // Number of work minutes in a regular day.
72 var $rights = array(); // An array of user rights such as 'track_own_time', etc.
73 var $is_client = false; // Whether user is a client as determined by missing 'track_own_time' right.
74 var $minutes_in_unit = 15; // Number of minutes in unit for Work units plugin.
75 var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
76 var $unit_totals_only = 0; // Totals only option for the Work units plugin.
78 var $behalfGroup = null; // A ttGroup instance with on behalf group attributes.
81 function __construct($login, $id = null) {
82 if (!$login && !$id) {
83 // nothing to initialize
87 $mdb2 = getConnection();
89 $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,
90 g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
91 g.tracking_mode, g.project_required, g.task_required, g.record_type,
92 g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
93 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 ";
97 $sql .= "u.login = ".$mdb2->quote($login);
98 $sql .= " AND u.status = 1";
100 $res = $mdb2->query($sql);
101 if (is_a($res, 'PEAR_Error')) {
105 $val = $res->fetchRow();
106 if ($val['id'] > 0) {
107 $this->login = $val['login'];
108 $this->name = $val['name'];
109 $this->id = $val['id'];
110 $this->org_id = $val['org_id'];
111 $this->group_id = $val['group_id'];
112 $this->role_id = $val['role_id'];
113 $this->role_name = $val['role_name'];
114 $this->rights = explode(',', $val['rights']);
115 $this->is_client = !in_array('track_own_time', $this->rights);
116 $this->rank = $val['rank'];
117 $this->client_id = $val['client_id'];
118 $this->email = $val['email'];
119 $this->lang = $val['lang'];
120 $this->decimal_mark = $val['decimal_mark'];
121 $this->date_format = $val['date_format'];
122 $this->time_format = $val['time_format'];
123 $this->week_start = $val['week_start'];
124 $this->tracking_mode = $val['tracking_mode'];
125 $this->project_required = $val['project_required'];
126 $this->task_required = $val['task_required'];
127 $this->record_type = $val['record_type'];
128 $this->bcc_email = $val['bcc_email'];
129 $this->allow_ip = $val['allow_ip'];
130 $this->password_complexity = $val['password_complexity'];
131 $this->group_name = $val['group_name'];
132 $this->currency = $val['currency'];
133 $this->plugins = $val['plugins'];
134 $this->lock_spec = $val['lock_spec'];
135 $this->workday_minutes = $val['workday_minutes'];
136 $this->custom_logo = $val['custom_logo'];
138 $this->config = $val['config'];
139 $config = new ttConfigHelper($this->config);
140 // Set user config options.
141 $this->show_holidays = $config->getDefinedValue('show_holidays');
142 $this->punch_mode = $config->getDefinedValue('punch_mode');
143 $this->allow_overlap = $config->getDefinedValue('allow_overlap');
144 $this->future_entries = $config->getDefinedValue('future_entries');
145 $this->uncompleted_indicators = $config->getDefinedValue('uncompleted_indicators');
146 if ($this->isPluginEnabled('wu')) {
147 $minutes_in_unit = $config->getIntValue('minutes_in_unit');
148 if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
149 $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
150 if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
151 $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
154 // Set "on behalf" id and name (user).
155 if (isset($_SESSION['behalf_id'])) {
156 $this->behalf_id = $_SESSION['behalf_id'];
157 $this->behalf_name = $_SESSION['behalf_name'];
159 // Set "on behalf" id and name (group).
160 if (isset($_SESSION['behalf_group_id'])) {
161 $this->behalf_group_id = $_SESSION['behalf_group_id'];
162 $this->behalf_group_name = $_SESSION['behalf_group_name'];
164 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
169 // The getGroup returns group id on behalf of which the current user is operating.
170 function getGroup() {
171 return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
174 // getDecimalMark returns decimal mark for active group.
175 function getDecimalMark() {
176 return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
179 // getTrackingMode returns tracking mode for active group.
180 function getTrackingMode() {
181 return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
184 // getPlugins returns plugins string for active group.
185 function getPlugins() {
186 return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
189 // getConfig returns config string for active group.
190 function getConfig() {
191 return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
194 // The getActiveUser returns user id on behalf of whom the current user is operating.
195 function getActiveUser() {
196 return ($this->behalf_id ? $this->behalf_id : $this->id);
199 // can - determines whether user has a right to do something.
200 function can($do_something) {
201 return in_array($do_something, $this->rights);
204 // isClient - determines whether current user is a client.
205 function isClient() {
206 return $this->is_client;
209 // isPluginEnabled checks whether a plugin is enabled for user.
210 function isPluginEnabled($plugin)
212 return in_array($plugin, explode(',', $this->plugins));
215 // getAssignedProjects - returns an array of assigned projects.
216 function getAssignedProjects()
219 $mdb2 = getConnection();
221 $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
222 // Do a query with inner join to get assigned projects.
223 $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
224 inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
225 where p.group_id = $group_id and p.status = 1 order by p.name";
226 $res = $mdb2->query($sql);
227 if (!is_a($res, 'PEAR_Error')) {
228 while ($val = $res->fetchRow()) {
235 // getAssignedTasks - returns an array of assigned tasks.
236 function getAssignedTasks()
238 // Start with projects;
239 $projects = $this->getAssignedProjects();
240 if (!$projects) return false;
242 // Build an array of task ids.
244 foreach($projects as $project) {
245 $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
246 $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
248 if (!$task_ids) return false;
250 // Get task descriptions.
252 $mdb2 = getConnection();
253 $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
255 $sql = "select id, name, description from tt_tasks".
256 " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
257 $res = $mdb2->query($sql);
258 if (!is_a($res, 'PEAR_Error')) {
259 while ($val = $res->fetchRow()) {
266 // getAssignedClients - returns an array of clients assigned to own projects.
267 function getAssignedClients()
269 // Start with projects;
270 $projects = $this->getAssignedProjects();
271 if (!$projects) return false;
272 $assigned_project_ids = array();
273 foreach($projects as $project) {
274 $assigned_project_ids[] = $project['id'];
277 $mdb2 = getConnection();
279 // Get active clients for group.
281 $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
282 $res = $mdb2->query($sql);
283 if (!is_a($res, 'PEAR_Error')) {
284 while ($val = $res->fetchRow()) {
285 $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
286 if (array_intersect($assigned_project_ids, $client_project_ids))
287 $clients[] = $val; // Add client if one of user projects is a client project, too.
293 // isDateLocked checks whether a specifc date is locked for modifications.
294 function isDateLocked($date)
296 if (!$this->isPluginEnabled('lk'))
297 return false; // Locking feature is disabled.
299 if (!$this->lock_spec)
300 return false; // There is no lock specification.
302 if (!$this->behalf_id && $this->can('override_own_date_lock'))
303 return false; // User is working as self and can override own date lock.
305 if ($this->behalf_id && $this->can('override_date_lock'))
306 return false; // User is working on behalf of someone else and can override date lock.
308 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
309 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
311 // Calculate the last occurrence of a lock.
312 $last = tdCron::getLastOccurrence($this->lock_spec, time());
313 $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
314 if ($date->before($lockdate))
320 // canOverridePunchMode checks whether a user can override punch mode in a situation.
321 function canOverridePunchMode()
323 if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
324 return false; // User is working as self and cannot override for self.
326 if ($this->behalf_id && !$this->can('override_punch_mode'))
327 return false; // User is working on behalf of someone else and cannot override.
332 // getUsers obtains users in a group, as specififed by options.
333 function getUsers($options) {
334 $mdb2 = getConnection();
336 $group_id = $this->getGroup();
337 $org_id = $this->org_id;
339 $skipClients = !isset($options['include_clients']);
340 $includeSelf = isset($options['include_self']);
342 $select_part = 'select u.id, u.name';
343 if (isset($options['include_login'])) $select_part .= ', u.login';
344 if (!isset($options['include_clients'])) $select_part .= ', r.rights';
345 if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
347 $from_part = ' from tt_users u';
350 if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
351 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
353 $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
354 if (isset($options['status']))
355 $where_part .= ' and u.status = '.(int)$options['status'];
357 $where_part .= ' and u.status is not null';
359 $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
361 if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
364 $order_part = " order by upper(u.name)";
366 $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
367 $res = $mdb2->query($sql);
368 $user_list = array();
369 if (is_a($res, 'PEAR_Error'))
372 while ($val = $res->fetchRow()) {
374 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
376 continue; // Skip adding clients.
381 if (isset($options['self_first'])) {
382 // Put own entry at the front.
383 $cnt = count($user_list);
384 for($i = 0; $i < $cnt; $i++) {
385 if ($user_list[$i]['id'] == $this->id) {
386 $self = $user_list[$i]; // Found self.
387 array_unshift($user_list, $self); // Put own entry at the front.
388 array_splice($user_list, $i+1, 1); // Remove duplicate.
395 // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
397 // - User home group.
398 // - The entire stack of groups all the way down to current on behalf group.
399 // - All immediate children of the current on behalf group.
400 // This allows user to navigate easily to home group, anything in between, and 1 level below.
402 // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
403 // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
404 // in some groups. We should check for feature availability on group change
405 // in post and redirect to feature_disabled.php when this happens.
406 // This will allow us to keep dropdown content consistent on all pages.
407 // Filtering content of the dropdown does not seem right.
409 // Note 2: Menu should display according to $user home group settings.
410 // Pages, should look according to $user->behalfGroup settings (if set).
411 // For example, if home group allows tasks, menu should display Tasks,
412 // even when we are on behalf of a subgroup without tasks.
414 // Note 3: Language of all pages should be as in $user home group even when
415 // subgroups have a different language.
416 function getGroupsForDropdown() {
417 $mdb2 = getConnection();
419 // Start with subgroups.
421 $group_id = $this->getGroup();
422 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
423 $res = $mdb2->query($sql);
424 if (!is_a($res, 'PEAR_Error')) {
425 while ($val = $res->fetchRow()) {
430 // Add current on behalf group to the beginning of array.
431 $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
432 $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
433 array_unshift($groups, array('id'=>$selected_group_id,'name'=>$selected_group_name));
435 // Iterate all the way to the home group, starting with selected ("on behalf") group.
436 $current_group_id = $selected_group_id;
437 while ($current_group_id != $this->group_id) {
438 $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
439 $res = $mdb2->query($sql);
440 if (is_a($res, 'PEAR_Error')) return false;
442 $val = $res->fetchRow();
443 $parent_id = $val['parent_id'];
445 // Get parent group name.
446 $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
447 $res = $mdb2->query($sql);
448 if (is_a($res, 'PEAR_Error')) return false;
449 $val = $res->fetchRow();
450 if (!$val) return false;
451 array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
452 $current_group_id = $parent_id;
460 // getSubgroups obtains a list of immediate subgroups.
461 function getSubgroups($group_id = null) {
462 $mdb2 = getConnection();
464 if (!$group_id) $group_id = $this->getGroup();
466 $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
467 " and parent_id = $group_id and status is not null order by upper(name)";
468 $res = $mdb2->query($sql);
469 if (!is_a($res, 'PEAR_Error')) {
470 while ($val = $res->fetchRow()) {
477 // getUser function is used to manage users in group and returns user details.
478 // At the moment, the function is used for user edits and deletes.
479 function getUser($user_id) {
480 if (!$this->can('manage_users')) return false;
482 $mdb2 = getConnection();
483 $group_id = $this->getGroup();
484 $org_id = $this->org_id;
486 $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
487 " left join tt_roles r on (u.role_id = r.id)".
488 " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
489 " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
490 $res = $mdb2->query($sql);
491 if (!is_a($res, 'PEAR_Error')) {
492 $val = $res->fetchRow();
498 // checkBehalfId checks whether behalf_id is appropriate.
499 // On behalf user must be active and have lower rank if the user is from home group,
501 // - subgroup must ve valid;
502 // - user should be a member of it.
503 function checkBehalfId() {
504 if (!$this->behalf_group_id) {
505 // Checking user from home group.
506 $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
507 $users = $this->getUsers($options);
508 foreach($users as $one_user) {
509 if ($one_user['id'] == $this->behalf_id)
513 // Checking user from a subgroup.
514 $group_id = $this->behalf_group_id;
515 if (!$this->isSubgroupValid($group_id))
518 // So far, so good. Check user now.
519 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
520 $users = $this->getUsers($options);
521 foreach($users as $one_user) {
522 if ($one_user['id'] == $this->behalf_id)
529 // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
532 // Needed for situations when user does not have do_own_something right.
533 // Example: has view_charts but does not have view_own_charts.
534 // In this case we still allow access to charts, but set behalf_id to someone else.
535 // Another example: working in a subgroup on behalf of someone else.
536 function adjustBehalfId() {
537 $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
538 $rank = $this->getMaxRankForGroup($group_id);
540 // Adjust to first found user in group.
541 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
542 $users = $this->getUsers($options);
543 foreach($users as $one_user) {
544 // Fake loop to access first element.
545 $this->behalf_id = $one_user['id'];
546 $this->behalf_name = $one_user['name'];
547 $_SESSION['behalf_id'] = $this->behalf_id;
548 $_SESSION['behalf_name'] = $this->behalf_name;
554 // updateGroup updates group information with new data.
555 function updateGroup($fields) {
556 if (!($this->can('manage_basic_settings') ||
557 $this->can('manage_advanced_settings') ||
558 $this->can('manage_features'))) return false;
559 // TODO: update the above for subgroup updates.
561 $group_id = $fields['group_id'];
562 if ($group_id && !$this->isGroupValid($group_id)) return false;
564 $mdb2 = getConnection();
565 if (!$group_id) $group_id = $this->getGroup();
567 if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
568 if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
569 if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
570 if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
571 if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
572 if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
573 if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
574 if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
575 if (isset($fields['tracking_mode'])) {
576 $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
577 $project_required_part = ' , project_required = '.(int) $fields['project_required'];
578 $task_required_part = ' , task_required = '.(int) $fields['task_required'];
580 if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
581 if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
582 if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
583 if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
584 if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
585 if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
586 if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
587 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
589 $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
590 $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
591 $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
593 $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
594 $affected = $mdb2->exec($sql);
595 if (is_a($affected, 'PEAR_Error')) return false;
600 // markUserDeleted marks a user in group as deleted.
601 function markUserDeleted($user_id) {
602 if (!$this->can('manage_users') || $this->id == $user_id)
605 // Make sure we operate on a legit user.
606 $user_details = $this->getUser($user_id);
607 if (!$user_details) return false;
609 $mdb2 = getConnection();
610 $group_id = $this->getGroup();
611 $org_id = $this->org_id;
613 // Mark user to project binds as deleted.
614 $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
615 " and group_id = $group_id and org_id = $org_id";
616 $affected = $mdb2->exec($sql);
617 if (is_a($affected, 'PEAR_Error'))
620 // Mark user favorite reports as deleted.
621 $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
622 " and group_id = $group_id and org_id = $org_id";
623 $affected = $mdb2->exec($sql);
624 if (is_a($affected, 'PEAR_Error'))
627 // Mark user as deleted.
628 $sql = "update tt_users set status = NULL where id = $user_id".
629 " and group_id = $group_id and org_id = $org_id";
630 $affected = $mdb2->exec($sql);
631 if (is_a($affected, 'PEAR_Error'))
637 // enablePlugin either enables or disables a specific plugin for group.
638 function enablePlugin($plugin, $enable = true)
640 if (!$this->can('manage_advanced_settings'))
641 return false; // Note: enablePlugin is currently only used on week_view.php.
642 // So, it's not really a plugin we are enabling, but rather week view display options.
643 // Therefore, a check for manage_advanced_settings, not manage_features.
645 $plugin_array = explode(',', $this->plugins);
646 if ($enable && !in_array($plugin, $plugin_array))
647 $plugin_array[] = $plugin; // Add plugin to array.
649 if (!$enable && in_array($plugin, $plugin_array)) {
650 $key = array_search($plugin, $plugin_array);
652 unset($plugin_array[$key]); // Remove plugin from array.
655 $plugins = implode(',', $plugin_array);
656 if ($plugins != $this->plugins) {
657 if (!$this->updateGroup(array('plugins' => $plugins)))
659 $this->plugins = $plugins;
665 // isGroupValid determines if a group is valid for user.
666 function isGroupValid($group_id) {
667 if ($group_id == $this->group_id)
670 return $this->isSubgroupValid($group_id);
673 // isSubgroupValid determines if a subgroup is valid for user.
674 // A subgroup is valid if:
675 // - user can manage_subgroups;
676 // - subgroup is either a direct child of user group, or "on the path"
677 // to it (grand-child, etc.).
678 function isSubgroupValid($subgroup_id) {
679 if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
681 $current_group_id = $subgroup_id;
682 while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
683 if ($parent_group_id == $this->group_id) {
684 return true; // Found it.
686 $current_group_id = $parent_group_id;
691 // getMaxRankForGroup determines effective user rank for a user in a given group.
692 // For home group it is the existing user rank (as per role) minus 1.
693 // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
694 function getMaxRankForGroup($group_id) {
696 $max_rank = 0; // Start safely.
697 if ($this->group_id == $group_id) {
698 $max_rank = $this->rank - 1;
702 if ($this->isSubgroupValid($group_id))
703 $max_rank = MAX_RANK;
708 // getUserPartForHeader constructs a string for user to display on pages header.
709 // It changes with "on behalf" attributes for both user and group.
710 function getUserPartForHeader() {
712 if (!$this->id) return null;
714 $user_part = htmlspecialchars($this->name);
715 $user_part .= ' - '.htmlspecialchars($this->role_name);
716 if ($this->behalf_id) {
717 $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
719 if ($this->behalf_group_id) {
720 $user_part .= ', <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_group_name).'</span>';
722 if ($this->group_name) // Note: we did not require group names in the past.
723 $user_part .= ', '.$this->group_name;
728 // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
729 function setOnBehalfGroup($group_id) {
731 // Unset things first.
732 $this->behalf_group_id = null;
733 $this->behalf_group_name = null;
734 $this->behalf_id = null;
735 $this->behalf_name = null;
736 unset($this->behalfGroup);
737 unset($_SESSION['behalf_group_id']);
738 unset($_SESSION['behalf_group_name']);
739 unset($_SESSION['behalf_id']);
740 unset($_SESSION['behalf_name']);
742 // Do not do anything if we don't have rights.
743 if (!$this->can('manage_subgroups')) return;
745 // No need to set if the group is our home group.
746 if ($group_id == $this->group_id) return;
748 // No need to set if the subgroup is not valid.
749 if (!$this->isSubgroupValid($group_id)) return;
751 // We are good to set on behalf group.
752 $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
753 $_SESSION['behalf_group_id'] = $group_id;
754 $_SESSION['behalf_group_name'] = $onBehalfGroupName;
755 $this->behalf_group_id = $group_id;
756 $this->behalf_group_name = $onBehalfGroupName;
758 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
760 // Adjust on behalf user.
761 $this->adjustBehalfId();