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');
33 import('form.ActionForm');
36 var $login = null; // User login.
37 var $name = null; // User name.
38 var $id = null; // User id.
39 var $org_id = null; // Organization id.
40 var $group_id = null; // Group id.
41 var $role_id = null; // Role id.
42 var $role_name = null; // Role name.
43 var $rank = null; // User role rank.
44 var $client_id = null; // Client id for client user role.
45 var $behalf_id = null; // User id, on behalf of whom we are working.
46 var $behalf_group_id = null; // Group id, on behalf of which we are working.
47 var $behalf_name = null; // User name, on behalf of whom we are working.
48 var $group_name = null; // Group name.
49 var $behalf_group_name = null;// Group name, on behalf of which we are working.
50 var $email = null; // User email.
51 var $lang = null; // Language.
52 var $decimal_mark = null; // Decimal separator.
53 var $date_format = null; // Date format.
54 var $time_format = null; // Time format.
55 var $week_start = 0; // Week start day.
56 var $show_holidays = 0; // Whether to show holidays in calendar.
57 var $tracking_mode = 0; // Tracking mode.
58 var $project_required = 0; // Whether project selection is required on time entires.
59 var $task_required = 0; // Whether task selection is required on time entires.
60 var $record_type = 0; // Record type (duration vs start and finish, or both).
61 var $punch_mode = 0; // Whether punch mode is enabled for user.
62 var $allow_overlap = 0; // Whether to allow overlapping time entries.
63 var $future_entries = 0; // Whether to allow creating future entries.
64 var $bcc_email = null; // Bcc email.
65 var $allow_ip = null; // Specification from where user is allowed access.
66 var $password_complexity = null; // Password complexity example.
67 var $currency = null; // Currency.
68 var $plugins = null; // Comma-separated list of enabled plugins.
69 var $config = null; // Comma-separated list of miscellaneous config options.
70 var $custom_logo = 0; // Whether to use a custom logo for group.
71 var $lock_spec = null; // Cron specification for record locking.
72 var $workday_minutes = 480; // Number of work minutes in a regular day.
73 var $rights = array(); // An array of user rights such as 'track_own_time', etc.
74 var $is_client = false; // Whether user is a client as determined by missing 'track_own_time' right.
75 var $minutes_in_unit = 15; // Number of minutes in unit for Work units plugin.
76 var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
77 var $unit_totals_only = 0; // Totals only option for the Work units plugin.
79 var $behalfGroup = null; // A ttGroup instance with on behalf group attributes.
82 function __construct($login, $id = null) {
83 if (!$login && !$id) {
84 // nothing to initialize
88 $mdb2 = getConnection();
90 $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,
91 g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
92 g.tracking_mode, g.project_required, g.task_required, g.record_type,
93 g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
94 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 ";
98 $sql .= "u.login = ".$mdb2->quote($login);
99 $sql .= " AND u.status = 1";
101 $res = $mdb2->query($sql);
102 if (is_a($res, 'PEAR_Error')) {
106 $val = $res->fetchRow();
107 if ($val['id'] > 0) {
108 $this->login = $val['login'];
109 $this->name = $val['name'];
110 $this->id = $val['id'];
111 $this->org_id = $val['org_id'];
112 $this->group_id = $val['group_id'];
113 $this->role_id = $val['role_id'];
114 $this->role_name = $val['role_name'];
115 $this->rights = explode(',', $val['rights']);
116 $this->is_client = !in_array('track_own_time', $this->rights);
117 $this->rank = $val['rank'];
118 $this->client_id = $val['client_id'];
119 $this->email = $val['email'];
120 $this->lang = $val['lang'];
121 $this->decimal_mark = $val['decimal_mark'];
122 $this->date_format = $val['date_format'];
123 $this->time_format = $val['time_format'];
124 $this->week_start = $val['week_start'];
125 $this->tracking_mode = $val['tracking_mode'];
126 $this->project_required = $val['project_required'];
127 $this->task_required = $val['task_required'];
128 $this->record_type = $val['record_type'];
129 $this->bcc_email = $val['bcc_email'];
130 $this->allow_ip = $val['allow_ip'];
131 $this->password_complexity = $val['password_complexity'];
132 $this->group_name = $val['group_name'];
133 $this->currency = $val['currency'];
134 $this->plugins = $val['plugins'];
135 $this->lock_spec = $val['lock_spec'];
136 $this->workday_minutes = $val['workday_minutes'];
137 $this->custom_logo = $val['custom_logo'];
139 $this->config = $val['config'];
140 $config = new ttConfigHelper($this->config);
141 // Set user config options.
142 $this->show_holidays = $config->getDefinedValue('show_holidays');
143 $this->punch_mode = $config->getDefinedValue('punch_mode');
144 $this->allow_overlap = $config->getDefinedValue('allow_overlap');
145 $this->future_entries = $config->getDefinedValue('future_entries');
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 getUser returns user id on behalf of whom the current user is operating.
171 return ($this->behalf_id ? $this->behalf_id : $this->id);
174 // The getGroup returns group id on behalf of which the current user is operating.
175 function getGroup() {
176 return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
179 // getDecimalMark returns decimal mark for active group.
180 function getDecimalMark() {
181 return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
184 // getDateFormat returns date format for active group.
185 function getDateFormat() {
186 return ($this->behalfGroup ? $this->behalfGroup->date_format : $this->date_format);
189 // getTimeFormat returns time format for active group.
190 function getTimeFormat() {
191 return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
194 // getTrackingMode returns tracking mode for active group.
195 function getTrackingMode() {
196 return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
199 // getRecordType returns record type for active group.
200 function getRecordType() {
201 return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
204 // getCurrency returns currency string for active group.
205 function getCurrency() {
206 return ($this->behalfGroup ? $this->behalfGroup->currency : $this->currency);
209 // getPlugins returns plugins string for active group.
210 function getPlugins() {
211 return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
214 // getLockSpec returns lock specification for active group.
215 function getLockSpec() {
216 return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
219 // getWorkdayMinutes returns workday_minutes for active group.
220 function getWorkdayMinutes() {
221 return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
224 // getConfig returns config string for active group.
225 function getConfig() {
226 return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
229 // getConfigOption returns true if an option is defined for group.
230 // This helps us keeping a set of user attributes smaller.
231 // We determine whether the option is set only on pages that need to know.
232 // For example: confirm_save is used only on time and expense edit pages.
233 function getConfigOption($name) {
234 $config = new ttConfigHelper($this->getConfig());
235 return $config->getDefinedValue($name);
238 // can - determines whether user has a right to do something.
239 function can($do_something) {
240 return in_array($do_something, $this->rights);
243 // isClient - determines whether current user is a client.
244 function isClient() {
245 return $this->is_client;
248 // isPluginEnabled checks whether a plugin is enabled for user.
249 function isPluginEnabled($plugin)
251 return in_array($plugin, explode(',', $this->getPlugins()));
254 // getAssignedProjects - returns an array of assigned projects.
255 function getAssignedProjects()
258 $mdb2 = getConnection();
260 $user_id = $this->getUser();
261 $group_id = $this->getGroup();
262 $org_id = $this->org_id;
264 // Do a query with inner join to get assigned projects.
265 $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p".
266 " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id and upb.status = 1)".
267 " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
268 $res = $mdb2->query($sql);
269 if (!is_a($res, 'PEAR_Error')) {
270 while ($val = $res->fetchRow()) {
277 // getAssignedTasks - returns an array of assigned tasks.
278 function getAssignedTasks()
280 // Start with projects;
281 $projects = $this->getAssignedProjects();
282 if (!$projects) return false;
284 // Build an array of task ids.
286 foreach($projects as $project) {
287 $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
288 $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
290 if (!$task_ids) return false;
292 // Get task descriptions.
294 $mdb2 = getConnection();
295 $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
297 $sql = "select id, name, description from tt_tasks".
298 " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
299 $res = $mdb2->query($sql);
300 if (!is_a($res, 'PEAR_Error')) {
301 while ($val = $res->fetchRow()) {
308 // getAssignedClients - returns an array of clients assigned to own projects.
309 function getAssignedClients()
311 // Start with projects;
312 $projects = $this->getAssignedProjects();
313 if (!$projects) return false;
314 $assigned_project_ids = array();
315 foreach($projects as $project) {
316 $assigned_project_ids[] = $project['id'];
319 $mdb2 = getConnection();
321 $group_id = $this->getGroup();
322 $org_id = $this->org_id;
324 // Get active clients for group.
326 $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
327 $res = $mdb2->query($sql);
328 if (!is_a($res, 'PEAR_Error')) {
329 while ($val = $res->fetchRow()) {
330 $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
331 if (array_intersect($assigned_project_ids, $client_project_ids))
332 $clients[] = $val; // Add client if one of user projects is a client project, too.
338 // isDateLocked checks whether a specifc date is locked for modifications.
339 function isDateLocked($date)
341 if (!$this->isPluginEnabled('lk'))
342 return false; // Locking feature is disabled.
344 if (!$this->getLockSpec())
345 return false; // There is no lock specification.
347 if (!$this->behalf_id && $this->can('override_own_date_lock'))
348 return false; // User is working as self and can override own date lock.
350 if ($this->behalf_id && $this->can('override_date_lock'))
351 return false; // User is working on behalf of someone else and can override date lock.
353 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
354 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
356 // Calculate the last occurrence of a lock.
357 $last = tdCron::getLastOccurrence($this->getLockSpec(), time());
358 $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
359 if ($date->before($lockdate))
365 // canOverridePunchMode checks whether a user can override punch mode in a situation.
366 function canOverridePunchMode()
368 if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
369 return false; // User is working as self and cannot override for self.
371 if ($this->behalf_id && !$this->can('override_punch_mode'))
372 return false; // User is working on behalf of someone else and cannot override.
377 // getUsers obtains users in a group, as specififed by options.
378 function getUsers($options) {
379 $mdb2 = getConnection();
381 $group_id = $this->getGroup();
382 $org_id = $this->org_id;
384 $skipClients = !isset($options['include_clients']);
385 $includeSelf = isset($options['include_self']);
387 $select_part = 'select u.id, u.group_id, u.name';
388 if (isset($options['include_login'])) $select_part .= ', u.login';
389 if (!isset($options['include_clients'])) $select_part .= ', r.rights';
390 if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
392 $from_part = ' from tt_users u';
395 if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
396 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
398 $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
399 if (isset($options['status']))
400 $where_part .= ' and u.status = '.(int)$options['status'];
402 $where_part .= ' and u.status is not null';
404 $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
406 if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
409 $order_part = " order by upper(u.name)";
411 $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
412 $res = $mdb2->query($sql);
413 $user_list = array();
414 if (is_a($res, 'PEAR_Error'))
417 while ($val = $res->fetchRow()) {
419 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
421 continue; // Skip adding clients.
426 if (isset($options['self_first'])) {
427 // Put own entry at the front.
428 $cnt = count($user_list);
429 for($i = 0; $i < $cnt; $i++) {
430 if ($user_list[$i]['id'] == $this->id) {
431 $self = $user_list[$i]; // Found self.
432 array_unshift($user_list, $self); // Put own entry at the front.
433 array_splice($user_list, $i+1, 1); // Remove duplicate.
440 // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
442 // - User home group.
443 // - The entire stack of groups all the way down to current on behalf group.
444 // - All immediate children of the current on behalf group.
445 // This allows user to navigate easily to home group, anything in between, and 1 level below.
447 // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
448 // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
449 // in some groups. We should check for feature availability on group change
450 // in post and redirect to feature_disabled.php when this happens.
451 // This will allow us to keep dropdown content consistent on all pages.
452 // Filtering content of the dropdown does not seem right.
454 // Note 2: Menu should display according to $user home group settings.
455 // Pages, should look according to $user->behalfGroup settings (if set).
456 // For example, if home group allows tasks, menu should display Tasks,
457 // even when we are on behalf of a subgroup without tasks.
459 // Note 3: Language of all pages should be as in $user home group even when
460 // subgroups have a different language.
461 function getGroupsForDropdown() {
462 $mdb2 = getConnection();
464 // Start with subgroups.
466 $group_id = $this->getGroup();
467 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
468 $res = $mdb2->query($sql);
469 if (!is_a($res, 'PEAR_Error')) {
470 while ($val = $res->fetchRow()) {
475 // Add current on behalf group to the beginning of array.
476 $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
477 $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
478 array_unshift($groups, array('id'=>$selected_group_id,'name'=>$selected_group_name));
480 // Iterate all the way to the home group, starting with selected ("on behalf") group.
481 $current_group_id = $selected_group_id;
482 while ($current_group_id != $this->group_id) {
483 $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
484 $res = $mdb2->query($sql);
485 if (is_a($res, 'PEAR_Error')) return false;
487 $val = $res->fetchRow();
488 $parent_id = $val['parent_id'];
490 // Get parent group name.
491 $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
492 $res = $mdb2->query($sql);
493 if (is_a($res, 'PEAR_Error')) return false;
494 $val = $res->fetchRow();
495 if (!$val) return false;
496 array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
497 $current_group_id = $parent_id;
505 // getSubgroups obtains a list of immediate subgroups.
506 function getSubgroups($group_id = null) {
507 $mdb2 = getConnection();
509 if (!$group_id) $group_id = $this->getGroup();
511 $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
512 " and parent_id = $group_id and status is not null order by upper(name)";
513 $res = $mdb2->query($sql);
514 if (!is_a($res, 'PEAR_Error')) {
515 while ($val = $res->fetchRow()) {
522 // getUserDetails function is used to manage users in group and returns user details.
523 // At the moment, the function is used for user edits and deletes.
524 function getUserDetails($user_id) {
525 if (!$this->can('manage_users')) return false;
527 $mdb2 = getConnection();
528 $group_id = $this->getGroup();
529 $org_id = $this->org_id;
531 // Determine max rank. If we are searching in on behalf group
532 // then rank restriction does not apply.
533 $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
535 $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
536 " left join tt_roles r on (u.role_id = r.id)".
537 " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
538 " and (r.rank < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self.
539 $res = $mdb2->query($sql);
540 if (!is_a($res, 'PEAR_Error')) {
541 $val = $res->fetchRow();
547 // checkBehalfId checks whether behalf_id is appropriate.
548 // On behalf user must be active and have lower rank if the user is from home group,
550 // - subgroup must ve valid;
551 // - user should be a member of it.
552 function checkBehalfId() {
553 if (!$this->behalfGroup) {
554 // Checking user from home group.
555 $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
556 $users = $this->getUsers($options);
557 foreach($users as $one_user) {
558 if ($one_user['id'] == $this->behalf_id)
562 // Checking user from a subgroup.
563 $group_id = $this->behalfGroup->id;
564 if (!$this->isSubgroupValid($group_id))
567 // So far, so good. Check user now.
568 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
569 $users = $this->getUsers($options);
570 foreach($users as $one_user) {
571 if ($one_user['id'] == $this->behalf_id)
578 // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
581 // Needed for situations when user does not have do_own_something right.
582 // Example: has view_charts but does not have view_own_charts.
583 // In this case we still allow access to charts, but set behalf_id to someone else.
584 // Another example: working in a subgroup on behalf of someone else.
585 function adjustBehalfId() {
586 $rank = $this->getMaxRankForGroup($this->getGroup());
588 // Adjust to first found user in group.
589 $options = array('status'=>ACTIVE,'max_rank'=>$rank);
590 $users = $this->getUsers($options);
591 foreach($users as $one_user) {
592 // Fake loop to access first element.
593 $this->behalf_id = $one_user['id'];
594 $this->behalf_name = $one_user['name'];
595 $_SESSION['behalf_id'] = $this->behalf_id;
596 $_SESSION['behalf_name'] = $this->behalf_name;
602 // updateGroup updates group information with new data.
603 function updateGroup($fields) {
604 $mdb2 = getConnection();
606 $group_id = $fields['group_id'];
607 if ($group_id && !$this->isGroupValid($group_id)) return false;
608 if (!$group_id) $group_id = $this->getGroup();
610 if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
611 if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
612 if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
613 if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
614 if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
615 if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
616 if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
617 if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
618 if (isset($fields['tracking_mode'])) {
619 $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
620 $project_required_part = ' , project_required = '.(int) $fields['project_required'];
621 $task_required_part = ' , task_required = '.(int) $fields['task_required'];
623 if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
624 if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
625 if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
626 if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
627 if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
628 if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
629 if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
630 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
632 $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
633 $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
634 $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
636 $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
637 $affected = $mdb2->exec($sql);
638 if (is_a($affected, 'PEAR_Error')) return false;
643 // markUserDeleted marks a user in group as deleted.
644 function markUserDeleted($user_id) {
645 if (!$this->can('manage_users') || $this->id == $user_id)
648 // Make sure we operate on a legit user.
649 $user_details = $this->getUserDetails($user_id);
650 if (!$user_details) return false;
652 $mdb2 = getConnection();
653 $group_id = $this->getGroup();
654 $org_id = $this->org_id;
656 // Mark user to project binds as deleted.
657 $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
658 " and group_id = $group_id and org_id = $org_id";
659 $affected = $mdb2->exec($sql);
660 if (is_a($affected, 'PEAR_Error'))
663 // Mark user favorite reports as deleted.
664 $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
665 " and group_id = $group_id and org_id = $org_id";
666 $affected = $mdb2->exec($sql);
667 if (is_a($affected, 'PEAR_Error'))
670 // Mark user as deleted.
671 $sql = "update tt_users set status = NULL where id = $user_id".
672 " and group_id = $group_id and org_id = $org_id";
673 $affected = $mdb2->exec($sql);
674 if (is_a($affected, 'PEAR_Error'))
680 // enablePlugin either enables or disables a specific plugin for group.
681 function enablePlugin($plugin, $enable = true)
683 if (!$this->can('manage_advanced_settings'))
684 return false; // Note: enablePlugin is currently only used on week_view.php.
685 // So, it's not really a plugin we are enabling, but rather week view display options.
686 // Therefore, a check for manage_advanced_settings, not manage_features.
688 $plugin_array = explode(',', $this->plugins);
689 if ($enable && !in_array($plugin, $plugin_array))
690 $plugin_array[] = $plugin; // Add plugin to array.
692 if (!$enable && in_array($plugin, $plugin_array)) {
693 $key = array_search($plugin, $plugin_array);
695 unset($plugin_array[$key]); // Remove plugin from array.
698 $plugins = implode(',', $plugin_array);
699 if ($plugins != $this->plugins) {
700 if (!$this->updateGroup(array('plugins' => $plugins)))
702 $this->plugins = $plugins;
708 // isUserValid determines if a user is valid for on behalf work.
709 function isUserValid($user_id) {
710 if ($user_id == $this->id)
712 return ($this->getUserDetails($user_id) != null);
715 // isGroupValid determines if a group is valid for user.
716 function isGroupValid($group_id) {
717 if ($group_id == $this->group_id)
720 return $this->isSubgroupValid($group_id);
723 // isSubgroupValid determines if a subgroup is valid for user.
724 // A subgroup is valid if:
725 // - user can manage_subgroups;
726 // - subgroup is either a direct child of user group, or "on the path"
727 // to it (grand-child, etc.).
728 function isSubgroupValid($subgroup_id) {
729 if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
731 $current_group_id = $subgroup_id;
732 while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
733 if ($parent_group_id == $this->group_id) {
734 return true; // Found it.
736 $current_group_id = $parent_group_id;
741 // getMaxRankForGroup determines effective user rank for a user in a given group.
742 // For home group it is the existing user rank (as per role) minus 1.
743 // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
744 function getMaxRankForGroup($group_id) {
746 $max_rank = 0; // Start safely.
747 if ($this->group_id == $group_id) {
748 $max_rank = $this->rank - 1;
752 if ($this->isSubgroupValid($group_id))
753 $max_rank = MAX_RANK;
758 // getUserPartForHeader constructs a string for user to display on pages header.
759 // It changes with "on behalf" attributes for both user and group.
760 function getUserPartForHeader() {
762 if (!$this->id) return null;
764 $user_part = htmlspecialchars($this->name);
765 $user_part .= ' - '.htmlspecialchars($this->role_name);
766 if ($this->behalf_id) {
767 $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
769 if ($this->behalf_group_id) {
770 $user_part .= ', <span class="onBehalf">'.htmlspecialchars($this->behalf_group_name).'</span>';
772 if ($this->group_name) // Note: we did not require group names in the past.
773 $user_part .= ', '.$this->group_name;
778 // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
779 function setOnBehalfGroup($group_id) {
781 // Unset things first.
782 $this->behalf_group_id = null;
783 $this->behalf_group_name = null;
784 $this->behalf_id = null;
785 $this->behalf_name = null;
786 unset($this->behalfGroup);
787 unset($_SESSION['behalf_group_id']);
788 unset($_SESSION['behalf_group_name']);
789 unset($_SESSION['behalf_id']);
790 unset($_SESSION['behalf_name']);
792 // Destroy report bean if it was set in session.
793 $form = new Form('dummyForm');
794 $bean = new ActionForm('reportBean', $form, $request);
795 if ($bean->isSaved()) {
796 $bean->destroyBean();
799 // Do not do anything if we don't have rights.
800 if (!$this->can('manage_subgroups')) return;
802 // No need to set if group is our home group.
803 if ($group_id == $this->group_id) return;
805 // No need to set if subgroup is not valid.
806 if (!$this->isSubgroupValid($group_id)) return;
808 // We are good to set on behalf group.
809 $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
810 $_SESSION['behalf_group_id'] = $group_id;
811 $_SESSION['behalf_group_name'] = $onBehalfGroupName;
812 $this->behalf_group_id = $group_id;
813 $this->behalf_group_name = $onBehalfGroupName;
815 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
817 // Adjust on behalf user to first found user in subgroup.
818 $this->adjustBehalfId();
822 // setOnBehalfUser sets on behalf user both the object and the session.
823 function setOnBehalfUser($user_id) {
825 // Unset things first.
826 $this->behalf_id = null;
827 $this->behalf_name = null;
828 unset($_SESSION['behalf_id']);
829 unset($_SESSION['behalf_name']);
831 // No need to set if user is us.
832 if ($user_id == $this->id) return;
834 // No need to set if user id is not valid.
835 if (!$this->isUserValid($user_id)) return;
837 // We are good to set on behalf user.
838 $onBehalfUserName = ttUserHelper::getUserName($user_id);
839 $_SESSION['behalf_id'] = $user_id;
840 $_SESSION['behalf_name'] = $onBehalfUserName;
841 $this->behalf_id = $user_id;
842 $this->behalf_name = $onBehalfUserName;
846 // The exists() function determines if an active user exists in context of a page.
847 // If we are working as self, true.
848 // If we are working in a subgroup with active users, true.
849 // If we are working in a subgroup without active users, false.
851 if (!$this->behalfGroup)
852 return true; // Working as self.
853 else if ($this->behalfGroup->active_users)
854 return true; // Subgroup has users.