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');
31 import('ttBehalfUser');
34 import('form.ActionForm');
37 var $login = null; // User login.
38 var $name = null; // User name.
39 var $id = null; // User id.
40 var $org_id = null; // Organization id.
41 var $group_id = null; // Group id.
42 var $role_id = null; // Role id.
43 var $role_name = null; // Role name.
44 var $rank = null; // User role rank.
45 var $client_id = null; // Client id for client user role.
46 var $quota_percent = 100.0; // Time quota percent for quotas plugin.
47 var $behalf_id = null; // User id, on behalf of whom we are working.
48 var $behalf_group_id = null; // Group id, on behalf of which we are working.
49 var $behalf_name = null; // User name, on behalf of whom we are working.
50 var $group_name = null; // Group name.
51 var $behalf_group_name = null;// Group name, on behalf of which we are working.
52 var $email = null; // User email.
53 var $lang = null; // Language.
54 var $decimal_mark = null; // Decimal separator.
55 var $date_format = null; // Date format.
56 var $time_format = null; // Time format.
57 var $week_start = 0; // Week start day.
58 var $show_holidays = 0; // Whether to show holidays in calendar.
59 var $tracking_mode = 0; // Tracking mode.
60 var $project_required = 0; // Whether project selection is required on time entires.
61 var $task_required = 0; // Whether task selection is required on time entires.
62 var $record_type = 0; // Record type (duration vs start and finish, or both).
63 var $punch_mode = 0; // Whether punch mode is enabled for user.
64 var $allow_overlap = 0; // Whether to allow overlapping time entries.
65 var $future_entries = 0; // Whether to allow creating future entries.
66 var $bcc_email = null; // Bcc email.
67 var $allow_ip = null; // Specification from where user is allowed access.
68 var $password_complexity = null; // Password complexity example.
69 var $currency = null; // Currency.
70 var $plugins = null; // Comma-separated list of enabled plugins.
71 var $config = null; // Comma-separated list of miscellaneous config options.
72 var $custom_logo = 0; // Whether to use a custom logo for group.
73 var $lock_spec = null; // Cron specification for record locking.
74 var $workday_minutes = 480; // Number of work minutes in a regular day.
75 var $rights = array(); // An array of user rights such as 'track_own_time', etc.
76 var $is_client = false; // Whether user is a client as determined by missing 'track_own_time' right.
78 var $behalfUser = null; // A ttBehalfUser instance with on behalf user attributes.
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,".
91 " u.quota_percent, u.email, g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format,".
92 " g.time_format, g.week_start, 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->rank = $val['rank'];
117 $this->client_id = $val['client_id'];
118 $this->is_client = $this->client_id && !in_array('track_own_time', $this->rights);
119 if ($val['quota_percent']) $this->quota_percent = $val['quota_percent'];
120 $this->email = $val['email'];
121 $this->lang = $val['lang'];
122 $this->decimal_mark = $val['decimal_mark'];
123 $this->date_format = $val['date_format'];
124 $this->time_format = $val['time_format'];
125 $this->week_start = $val['week_start'];
126 $this->tracking_mode = $val['tracking_mode'];
127 $this->project_required = $val['project_required'];
128 $this->task_required = $val['task_required'];
129 $this->record_type = $val['record_type'];
130 $this->bcc_email = $val['bcc_email'];
131 $this->allow_ip = $val['allow_ip'];
132 $this->password_complexity = $val['password_complexity'];
133 $this->group_name = $val['group_name'];
134 $this->currency = $val['currency'];
135 $this->plugins = $val['plugins'];
136 $this->lock_spec = $val['lock_spec'];
137 $this->workday_minutes = $val['workday_minutes'];
138 $this->custom_logo = $val['custom_logo'];
140 $this->config = $val['config'];
141 $config = new ttConfigHelper($this->config);
142 // Set user config options.
143 $this->show_holidays = $config->getDefinedValue('show_holidays');
144 $this->punch_mode = $config->getDefinedValue('punch_mode');
145 $this->allow_overlap = $config->getDefinedValue('allow_overlap');
146 $this->future_entries = $config->getDefinedValue('future_entries');
148 // Set "on behalf" id and name (user).
149 if (isset($_SESSION['behalf_id'])) {
150 $this->behalf_id = $_SESSION['behalf_id'];
151 $this->behalf_name = $_SESSION['behalf_name'];
153 $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
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'];
160 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
165 // getUser returns user id on behalf of whom the current user is operating.
167 return ($this->behalfUser ? $this->behalfUser->id : $this->id);
170 // getQuotaPercent returns quota percent for active user.
171 function getQuotaPercent() {
172 return ($this->behalfUser ? $this->behalfUser->quota_percent : $this->quota_percent);
175 // The getGroup returns group id on behalf of which the current user is operating.
176 function getGroup() {
177 return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
180 // getDecimalMark returns decimal mark for active group.
181 function getDecimalMark() {
182 return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
185 // getDateFormat returns date format for active group.
186 function getDateFormat() {
187 return ($this->behalfGroup ? $this->behalfGroup->date_format : $this->date_format);
190 // getTimeFormat returns time format for active group.
191 function getTimeFormat() {
192 return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
195 // getTrackingMode returns tracking mode for active group.
196 function getTrackingMode() {
197 return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
200 // getRecordType returns record type for active group.
201 function getRecordType() {
202 return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
205 // getCurrency returns currency string for active group.
206 function getCurrency() {
207 return ($this->behalfGroup ? $this->behalfGroup->currency : $this->currency);
210 // getPlugins returns plugins string for active group.
211 function getPlugins() {
212 return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
215 // getLockSpec returns lock specification for active group.
216 function getLockSpec() {
217 return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
220 // getWorkdayMinutes returns workday_minutes for active group.
221 function getWorkdayMinutes() {
222 return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
225 // getConfig returns config string for active group.
226 function getConfig() {
227 return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
230 // getConfigOption returns true if an option is defined for group.
231 // This helps us keeping a set of user attributes smaller.
232 // We determine whether the option is set only on pages that need to know.
233 // For example: confirm_save is used only on time and expense edit pages.
234 function getConfigOption($name) {
235 $config = new ttConfigHelper($this->getConfig());
236 return $config->getDefinedValue($name);
239 // getConfigInt retruns an integer value defined in a group, or false.
240 function getConfigInt($name, $defaultVal) {
241 $config = new ttConfigHelper($this->getConfig());
242 return $config->getIntValue($name, $defaultVal);
245 // can - determines whether user has a right to do something.
246 function can($do_something) {
247 return in_array($do_something, $this->rights);
250 // isClient - determines whether current user is a client.
251 function isClient() {
252 return $this->is_client;
255 // isPluginEnabled checks whether a plugin is enabled for user.
256 function isPluginEnabled($plugin)
258 return in_array($plugin, explode(',', $this->getPlugins()));
261 // getAssignedProjects - returns an array of assigned projects.
262 function getAssignedProjects()
265 $mdb2 = getConnection();
267 $user_id = $this->getUser();
268 $group_id = $this->getGroup();
269 $org_id = $this->org_id;
271 // Do a query with inner join to get assigned projects.
272 $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p".
273 " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id and upb.status = 1)".
274 " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
275 $res = $mdb2->query($sql);
276 if (!is_a($res, 'PEAR_Error')) {
277 while ($val = $res->fetchRow()) {
284 // getAssignedTasks - returns an array of assigned tasks.
285 function getAssignedTasks()
287 // Start with projects;
288 $projects = $this->getAssignedProjects();
289 if (!$projects) return false;
291 // Build an array of task ids.
293 foreach($projects as $project) {
294 $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
295 $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
297 if (!$task_ids) return false;
299 // Get task descriptions.
301 $mdb2 = getConnection();
302 $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
304 $group_id = $this->getGroup();
305 $org_id = $this->org_id;
307 $sql = "select id, name, description from tt_tasks".
308 " where group_id = $group_id and org_id = $org_id and status = 1 and id in ($tasks) order by name";
309 $res = $mdb2->query($sql);
310 if (!is_a($res, 'PEAR_Error')) {
311 while ($val = $res->fetchRow()) {
318 // getAssignedClients - returns an array of clients assigned to own projects.
319 function getAssignedClients()
321 // Start with projects;
322 $projects = $this->getAssignedProjects();
323 if (!$projects) return false;
324 $assigned_project_ids = array();
325 foreach($projects as $project) {
326 $assigned_project_ids[] = $project['id'];
329 $mdb2 = getConnection();
331 $group_id = $this->getGroup();
332 $org_id = $this->org_id;
334 // Get active clients for group.
336 $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
337 $res = $mdb2->query($sql);
338 if (!is_a($res, 'PEAR_Error')) {
339 while ($val = $res->fetchRow()) {
340 $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
341 if (array_intersect($assigned_project_ids, $client_project_ids))
342 $clients[] = $val; // Add client if one of user projects is a client project, too.
348 // isDateLocked checks whether a specifc date is locked for modifications.
349 function isDateLocked($date)
351 if (!$this->isPluginEnabled('lk'))
352 return false; // Locking feature is disabled.
354 if (!$this->getLockSpec())
355 return false; // There is no lock specification.
357 if (!$this->behalf_id && $this->can('override_own_date_lock'))
358 return false; // User is working as self and can override own date lock.
360 if ($this->behalf_id && $this->can('override_date_lock'))
361 return false; // User is working on behalf of someone else and can override date lock.
363 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
364 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
366 // Calculate the last occurrence of a lock.
367 $last = tdCron::getLastOccurrence($this->getLockSpec(), time());
368 $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
369 if ($date->before($lockdate))
375 // canOverridePunchMode checks whether a user can override punch mode in a situation.
376 function canOverridePunchMode()
378 if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
379 return false; // User is working as self and cannot override for self.
381 if ($this->behalf_id && !$this->can('override_punch_mode'))
382 return false; // User is working on behalf of someone else and cannot override.
387 // getUsers obtains users in a group, as specififed by options.
388 function getUsers($options) {
389 $mdb2 = getConnection();
391 $group_id = $this->getGroup();
392 $org_id = $this->org_id;
394 $skipClients = !isset($options['include_clients']);
395 $includeSelf = isset($options['include_self']);
397 $select_part = 'select u.id, u.group_id, u.name';
398 if (isset($options['include_login'])) {
399 $select_part .= ', u.login';
400 // Piggy-back on include_login to see if we must also include quota_percent.
401 $include_quota = $this->isPluginEnabled('mq');
402 if ($include_quota) {
403 $decimal_mark = $this->getDecimalMark();
404 $replaceDecimalMark = ('.' != $decimal_mark);
405 $select_part .= ', u.quota_percent';
408 if (!isset($options['include_clients'])) $select_part .= ', r.rights';
409 if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
411 $from_part = ' from tt_users u';
414 if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
415 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
417 $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
418 if (isset($options['status']))
419 $where_part .= ' and u.status = '.(int)$options['status'];
421 $where_part .= ' and u.status is not null';
423 $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
425 if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
428 $order_part = " order by upper(u.name)";
430 $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
431 $res = $mdb2->query($sql);
432 $user_list = array();
433 if (is_a($res, 'PEAR_Error'))
436 while ($val = $res->fetchRow()) {
438 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
440 continue; // Skip adding clients.
442 if ($include_quota) {
443 $quota = $val['quota_percent'];
445 $quota = '100'; // Null means 100%. Perhaps enforce not NULLs in db and eliminate this check.
446 elseif (ttEndsWith($quota, '.00'))
447 $quota = substr($quota, 0, strlen($quota)-3); // Trim trailing ".00";
448 elseif ($replaceDecimalMark)
449 $quota = str_replace('.', $decimal_mark, $quota);
450 $val['quota_percent'] = $quota.'%';
455 if (isset($options['self_first'])) {
456 // Put own entry at the front.
457 $cnt = count($user_list);
458 for($i = 0; $i < $cnt; $i++) {
459 if ($user_list[$i]['id'] == $this->id) {
460 $self = $user_list[$i]; // Found self.
461 array_unshift($user_list, $self); // Put own entry at the front.
462 array_splice($user_list, $i+1, 1); // Remove duplicate.
469 // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
471 // - User home group.
472 // - The entire stack of groups all the way down to current on behalf group.
473 // - All immediate children of the current on behalf group.
474 // This allows user to navigate easily to home group, anything in between, and 1 level below.
476 // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
477 // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
478 // in some groups. We should check for feature availability on group change
479 // in post and redirect to feature_disabled.php when this happens.
480 // This will allow us to keep dropdown content consistent on all pages.
481 // Filtering content of the dropdown does not seem right.
483 // Note 2: Menu should display according to $user home group settings.
484 // Pages, should look according to $user->behalfGroup settings (if set).
485 // For example, if home group allows tasks, menu should display Tasks,
486 // even when we are on behalf of a subgroup without tasks.
488 // Note 3: Language of all pages should be as in $user home group even when
489 // subgroups have a different language.
490 function getGroupsForDropdown() {
491 $mdb2 = getConnection();
493 // Start with subgroups.
495 $group_id = $this->getGroup();
496 $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
497 $res = $mdb2->query($sql);
498 if (!is_a($res, 'PEAR_Error')) {
499 while ($val = $res->fetchRow()) {
504 // Add current on behalf group to the beginning of array.
505 $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
506 $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
507 array_unshift($groups, array('id'=>$selected_group_id,'name'=>$selected_group_name));
509 // Iterate all the way to the home group, starting with selected ("on behalf") group.
510 $current_group_id = $selected_group_id;
511 while ($current_group_id != $this->group_id) {
512 $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
513 $res = $mdb2->query($sql);
514 if (is_a($res, 'PEAR_Error')) return false;
516 $val = $res->fetchRow();
517 $parent_id = $val['parent_id'];
519 // Get parent group name.
520 $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
521 $res = $mdb2->query($sql);
522 if (is_a($res, 'PEAR_Error')) return false;
523 $val = $res->fetchRow();
524 if (!$val) return false;
525 array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
526 $current_group_id = $parent_id;
534 // getSubgroups obtains a list of immediate subgroups.
535 function getSubgroups($group_id = null) {
536 $mdb2 = getConnection();
538 if (!$group_id) $group_id = $this->getGroup();
540 $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
541 " and parent_id = $group_id and status is not null order by upper(name)";
542 $res = $mdb2->query($sql);
543 if (!is_a($res, 'PEAR_Error')) {
544 while ($val = $res->fetchRow()) {
551 // getUserDetails function is used to manage users in group and returns user details.
552 // At the moment, the function is used for user edits and deletes.
553 function getUserDetails($user_id) {
554 if (!$this->can('manage_users')) return false;
556 $mdb2 = getConnection();
557 $group_id = $this->getGroup();
558 $org_id = $this->org_id;
560 // Determine max rank. If we are searching in on behalf group
561 // then rank restriction does not apply.
562 $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
564 $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.quota_percent, u.email from tt_users u".
565 " left join tt_roles r on (u.role_id = r.id)".
566 " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
567 " and (r.rank < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self.
568 $res = $mdb2->query($sql);
569 if (!is_a($res, 'PEAR_Error')) {
570 $val = $res->fetchRow();
576 // checkBehalfId checks whether behalf_id is appropriate.
577 // On behalf user must be active and have lower rank if the user is from home group,
579 // - subgroup must ve valid;
580 // - user should be a member of it.
581 function checkBehalfId() {
582 if (!$this->behalfGroup) {
583 // Checking user from home group.
584 $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
585 $users = $this->getUsers($options);
586 foreach($users as $one_user) {
587 if ($one_user['id'] == $this->behalf_id)
591 // Checking user from a subgroup.
592 $group_id = $this->behalfGroup->id;
593 if (!$this->isSubgroupValid($group_id))
596 // So far, so good. Check user now.
597 $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
598 $users = $this->getUsers($options);
599 foreach($users as $one_user) {
600 if ($one_user['id'] == $this->behalf_id)
607 // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
610 // Needed for situations when user does not have do_own_something right.
611 // Example: has view_charts but does not have view_own_charts.
612 // In this case we still allow access to charts, but set behalf_id to someone else.
613 // Another example: working in a subgroup on behalf of someone else.
614 function adjustBehalfId() {
615 $rank = $this->getMaxRankForGroup($this->getGroup());
617 // Adjust to first found user in group.
618 $options = array('status'=>ACTIVE,'max_rank'=>$rank);
619 $users = $this->getUsers($options);
620 foreach($users as $one_user) {
621 // Fake loop to access first element.
622 $this->behalf_id = $one_user['id'];
623 $this->behalf_name = $one_user['name'];
624 $_SESSION['behalf_id'] = $this->behalf_id;
625 $_SESSION['behalf_name'] = $this->behalf_name;
631 // updateGroup updates group information with new data.
632 function updateGroup($fields) {
633 $mdb2 = getConnection();
635 $group_id = $fields['group_id'];
636 if ($group_id && !$this->isGroupValid($group_id)) return false;
637 if (!$group_id) $group_id = $this->getGroup();
639 if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
640 if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
641 if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
642 if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
643 if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
644 if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
645 if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
646 if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
647 if (isset($fields['tracking_mode'])) {
648 $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
649 $project_required_part = ' , project_required = '.(int) $fields['project_required'];
650 $task_required_part = ' , task_required = '.(int) $fields['task_required'];
652 if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
653 if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
654 if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
655 if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
656 if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
657 if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
658 if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
659 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
661 $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
662 $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
663 $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
665 $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
666 $affected = $mdb2->exec($sql);
667 if (is_a($affected, 'PEAR_Error')) return false;
672 // markUserDeleted marks a user in group as deleted.
673 function markUserDeleted($user_id) {
674 if (!$this->can('manage_users') || $this->id == $user_id)
677 // Make sure we operate on a legit user.
678 $user_details = $this->getUserDetails($user_id);
679 if (!$user_details) return false;
681 $mdb2 = getConnection();
682 $group_id = $this->getGroup();
683 $org_id = $this->org_id;
685 // Mark user to project binds as deleted.
686 $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
687 " and group_id = $group_id and org_id = $org_id";
688 $affected = $mdb2->exec($sql);
689 if (is_a($affected, 'PEAR_Error'))
692 // Mark user favorite reports as deleted.
693 $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
694 " and group_id = $group_id and org_id = $org_id";
695 $affected = $mdb2->exec($sql);
696 if (is_a($affected, 'PEAR_Error'))
699 // Mark user as deleted.
700 $sql = "update tt_users set status = NULL where id = $user_id".
701 " and group_id = $group_id and org_id = $org_id";
702 $affected = $mdb2->exec($sql);
703 if (is_a($affected, 'PEAR_Error'))
709 // enablePlugin either enables or disables a specific plugin for group.
710 function enablePlugin($plugin, $enable = true)
712 if (!$this->can('manage_advanced_settings'))
713 return false; // Note: enablePlugin is currently only used on week_view.php.
714 // So, it's not really a plugin we are enabling, but rather week view display options.
715 // Therefore, a check for manage_advanced_settings, not manage_features.
717 $plugin_array = explode(',', $this->plugins);
718 if ($enable && !in_array($plugin, $plugin_array))
719 $plugin_array[] = $plugin; // Add plugin to array.
721 if (!$enable && in_array($plugin, $plugin_array)) {
722 $key = array_search($plugin, $plugin_array);
724 unset($plugin_array[$key]); // Remove plugin from array.
727 $plugins = implode(',', $plugin_array);
728 if ($plugins != $this->plugins) {
729 if (!$this->updateGroup(array('plugins' => $plugins)))
731 $this->plugins = $plugins;
737 // isUserValid determines if a user is valid for on behalf work.
738 function isUserValid($user_id) {
739 if ($user_id == $this->id)
741 return ($this->getUserDetails($user_id) != null);
744 // isGroupValid determines if a group is valid for user.
745 function isGroupValid($group_id) {
746 if ($group_id == $this->group_id)
749 return $this->isSubgroupValid($group_id);
752 // isSubgroupValid determines if a subgroup is valid for user.
753 // A subgroup is valid if:
754 // - user can manage_subgroups;
755 // - subgroup is either a direct child of user group, or "on the path"
756 // to it (grand-child, etc.).
757 function isSubgroupValid($subgroup_id) {
758 if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
760 $current_group_id = $subgroup_id;
761 while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
762 if ($parent_group_id == $this->group_id) {
763 return true; // Found it.
765 $current_group_id = $parent_group_id;
770 // getMaxRankForGroup determines effective user rank for a user in a given group.
771 // For home group it is the existing user rank (as per role) minus 1.
772 // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
773 function getMaxRankForGroup($group_id) {
775 $max_rank = 0; // Start safely.
776 if ($this->group_id == $group_id) {
777 $max_rank = $this->rank - 1;
781 if ($this->isSubgroupValid($group_id))
782 $max_rank = MAX_RANK;
787 // getUserPartForHeader constructs a string for user to display on pages header.
788 // It changes with "on behalf" attributes for both user and group.
789 function getUserPartForHeader() {
791 if (!$this->id) return null;
793 $user_part = htmlspecialchars($this->name);
794 $user_part .= ' - '.htmlspecialchars($this->role_name);
795 if ($this->behalf_id) {
796 $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
798 if ($this->behalf_group_id) {
799 $user_part .= ', <span class="onBehalf">'.htmlspecialchars($this->behalf_group_name).'</span>';
801 if ($this->group_name) // Note: we did not require group names in the past.
802 $user_part .= ', '.$this->group_name;
807 // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
808 function setOnBehalfGroup($group_id) {
810 // Unset things first.
811 $this->behalf_group_id = null;
812 $this->behalf_group_name = null;
813 $this->behalf_id = null;
814 $this->behalf_name = null;
815 unset($this->behalfGroup);
816 unset($_SESSION['behalf_group_id']);
817 unset($_SESSION['behalf_group_name']);
818 unset($_SESSION['behalf_id']);
819 unset($_SESSION['behalf_name']);
821 // Destroy report bean if it was set in session.
822 $form = new Form('dummyForm');
823 $bean = new ActionForm('reportBean', $form, $request);
824 if ($bean->isSaved()) {
825 $bean->destroyBean();
828 // Do not do anything if we don't have rights.
829 if (!$this->can('manage_subgroups')) return;
831 // No need to set if group is our home group.
832 if ($group_id == $this->group_id) return;
834 // No need to set if subgroup is not valid.
835 if (!$this->isSubgroupValid($group_id)) return;
837 // We are good to set on behalf group.
838 $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
839 $_SESSION['behalf_group_id'] = $group_id;
840 $_SESSION['behalf_group_name'] = $onBehalfGroupName;
841 $this->behalf_group_id = $group_id;
842 $this->behalf_group_name = $onBehalfGroupName;
844 $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
846 // Adjust on behalf user to first found user in subgroup.
847 $this->adjustBehalfId();
851 // setOnBehalfUser sets on behalf user both the object and the session.
852 function setOnBehalfUser($user_id) {
854 // Unset things first.
855 $this->behalf_id = null;
856 $this->behalf_name = null;
857 unset($this->behalfUser);
858 unset($_SESSION['behalf_id']);
859 unset($_SESSION['behalf_name']);
861 // No need to set if user is us.
862 if ($user_id == $this->id) return;
864 // No need to set if user id is not valid.
865 if (!$this->isUserValid($user_id)) return;
867 // We are good to set on behalf user.
868 $onBehalfUserName = ttUserHelper::getUserName($user_id);
869 $_SESSION['behalf_id'] = $user_id;
870 $_SESSION['behalf_name'] = $onBehalfUserName;
871 $this->behalf_id = $user_id;
872 $this->behalf_name = $onBehalfUserName;
874 $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
878 // The exists() function determines if an active user exists in context of a page.
879 // If we are working as self, true.
880 // If we are working in a subgroup with active users, true.
881 // If we are working in a subgroup without active users, false.
883 if (!$this->behalfGroup)
884 return true; // Working as self.
885 else if ($this->behalfGroup->active_users)
886 return true; // Subgroup has users.