Wrote a validation routine for holidays.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
1 <?php
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.
10 // |
11 // | There are only two ways to violate the license:
12 // |
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).
16 // |
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).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 import('ttConfigHelper');
30 import('ttGroupHelper');
31 import('ttBehalfUser');
32 import('ttGroup');
33 import('form.Form');
34 import('form.ActionForm');
35
36 class ttUser {
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
72   // Refactoring ongoing. Towards using helper instead of config string?
73   var $config = null;           // Comma-separated list of miscellaneous config options.
74   var $configHelper = null;     // An instance of ttConfigHelper class.
75
76   var $custom_logo = 0;         // Whether to use a custom logo for group.
77   var $lock_spec = null;        // Cron specification for record locking.
78   var $workday_minutes = 480;   // Number of work minutes in a regular day.
79   var $rights = array();        // An array of user rights such as 'track_own_time', etc.
80   var $is_client = false;       // Whether user is a client as determined by missing 'track_own_time' right.
81
82   var $behalfUser = null;       // A ttBehalfUser instance with on behalf user attributes.
83   var $behalfGroup = null;      // A ttGroup instance with on behalf group attributes.
84
85   // Constructor.
86   function __construct($login, $id = null) {
87     if (!$login && !$id) {
88       // nothing to initialize
89       return;
90     }
91
92     $mdb2 = getConnection();
93
94     $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,".
95       " u.quota_percent, u.email, g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format,".
96       " g.time_format, g.week_start, g.tracking_mode, g.project_required, g.task_required, g.record_type,".
97       " g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo".
98       " 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 ";
99     if ($id)
100       $sql .= "u.id = $id";
101     else
102       $sql .= "u.login = ".$mdb2->quote($login);
103     $sql .= " AND u.status = 1";
104
105     $res = $mdb2->query($sql);
106     if (is_a($res, 'PEAR_Error')) {
107       return;
108     }
109
110     $val = $res->fetchRow();
111     if ($val['id'] > 0) {
112       $this->login = $val['login'];
113       $this->name = $val['name'];
114       $this->id = $val['id'];
115       $this->org_id = $val['org_id'];
116       $this->group_id = $val['group_id'];
117       $this->role_id = $val['role_id'];
118       $this->role_name = $val['role_name'];
119       $this->rights = explode(',', $val['rights']);
120       $this->rank = $val['rank'];
121       $this->client_id = $val['client_id'];
122       $this->is_client = $this->client_id && !in_array('track_own_time', $this->rights);
123       if ($val['quota_percent']) $this->quota_percent = $val['quota_percent'];
124       $this->email = $val['email'];
125       $this->lang = $val['lang'];
126       $this->decimal_mark = $val['decimal_mark'];
127       $this->date_format = $val['date_format'];
128       $this->time_format = $val['time_format'];
129       $this->week_start = $val['week_start'];
130       $this->tracking_mode = $val['tracking_mode'];
131       $this->project_required = $val['project_required'];
132       $this->task_required = $val['task_required'];
133       $this->record_type = $val['record_type'];
134       $this->bcc_email = $val['bcc_email'];
135       $this->allow_ip = $val['allow_ip'];
136       $this->password_complexity = $val['password_complexity'];
137       $this->group_name = $val['group_name'];
138       $this->currency = $val['currency'];
139       $this->plugins = $val['plugins'];
140       $this->lock_spec = $val['lock_spec'];
141       $this->workday_minutes = $val['workday_minutes'];
142       $this->custom_logo = $val['custom_logo'];
143
144       // TODO: refactor this.
145       $this->config = $val['config'];
146       $this->configHelper = new ttConfigHelper($val['config']);
147
148       // Set user config options.
149       $this->show_holidays = $this->configHelper->getDefinedValue('show_holidays');
150       $this->punch_mode = $this->configHelper->getDefinedValue('punch_mode');
151       $this->allow_overlap = $this->configHelper->getDefinedValue('allow_overlap');
152       $this->future_entries = $this->configHelper->getDefinedValue('future_entries');
153       
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'];
158
159         $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
160       }
161       // Set "on behalf" id and name (group).
162       if (isset($_SESSION['behalf_group_id'])) {
163         $this->behalf_group_id = $_SESSION['behalf_group_id'];
164         $this->behalf_group_name = $_SESSION['behalf_group_name'];
165
166         $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
167       }
168     }
169   }
170
171   // getUser returns user id on behalf of whom the current user is operating.
172   function getUser() {
173     return ($this->behalfUser ? $this->behalfUser->id : $this->id);
174   }
175
176   // getName returns user name on behalf of whom the current user is operating.
177   function getName() {
178     return ($this->behalfUser ? $this->behalfUser->name : $this->name);
179   }
180
181   // getQuotaPercent returns quota percent for active user.
182   function getQuotaPercent() {
183     return ($this->behalfUser ? $this->behalfUser->quota_percent : $this->quota_percent);
184   }
185
186   // The getGroup returns group id on behalf of which the current user is operating.
187   function getGroup() {
188     return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
189   }
190
191   // getDecimalMark returns decimal mark for active group.
192   function getDecimalMark() {
193     return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
194   }
195
196   // getDateFormat returns date format for active group.
197   function getDateFormat() {
198     return ($this->behalfGroup ? $this->behalfGroup->date_format : $this->date_format);
199   }
200
201   // getTimeFormat returns time format for active group.
202   function getTimeFormat() {
203     return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
204   }
205
206   // getTrackingMode returns tracking mode for active group.
207   function getTrackingMode() {
208     return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
209   }
210
211   // getRecordType returns record type for active group.
212   function getRecordType() {
213     return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
214   }
215
216   // getCurrency returns currency string for active group.
217   function getCurrency() {
218     return ($this->behalfGroup ? $this->behalfGroup->currency : $this->currency);
219   }
220
221   // getPlugins returns plugins string for active group.
222   function getPlugins() {
223     return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
224   }
225
226   // getLockSpec returns lock specification for active group.
227   function getLockSpec() {
228     return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
229   }
230
231   // getWorkdayMinutes returns workday_minutes for active group.
232   function getWorkdayMinutes() {
233     return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
234   }
235
236   // getConfig returns config string for active group.
237   function getConfig() {
238     return ($this->behalfGroup ? $this->behalfGroup->configHelper->getConfig() : $this->configHelper->getConfig());
239   }
240
241   // getConfigOption returns true if an option is defined for group.
242   // This helps us keeping a set of user attributes smaller.
243   // We determine whether the option is set only on pages that need to know.
244   // For example: confirm_save is used only on time and expense edit pages.
245   function getConfigOption($name) {
246     $config = new ttConfigHelper($this->getConfig());
247     return $config->getDefinedValue($name);
248   }
249
250   // getConfigInt retruns an integer value defined in a group, or false.
251   function getConfigInt($name, $defaultVal) {
252     $config = new ttConfigHelper($this->getConfig());
253     return $config->getIntValue($name, $defaultVal);
254   }
255
256   // can - determines whether user has a right to do something.
257   function can($do_something) {
258     return in_array($do_something, $this->rights);
259   }
260
261   // isClient - determines whether current user is a client.
262   function isClient() {
263     return $this->is_client;
264   }
265
266   // isPluginEnabled checks whether a plugin is enabled for user.
267   function isPluginEnabled($plugin)
268   {
269     return in_array($plugin, explode(',', $this->getPlugins()));
270   }
271
272   // isOptionEnabled checks whether a config option is enabled for user.
273   function isOptionEnabled($option)
274   {
275     return $this->behalfGroup ? $this->behalfGroup->configHelper->getDefinedValue($option) : $this->configHelper->getDefinedValue($option);
276   }
277
278   // setOption sets an option inside of ttConfigHelper instance.
279   // Note that it does not write to the database.
280   function setOption($option, $enable = true)
281   {
282     return $this->behalfGroup ? $this->behalfGroup->configHelper->setDefinedValue($option, $enable) : $this->configHelper->setDefinedValue($option, $enable);
283   }
284
285   // getAssignedProjects - returns an array of assigned projects.
286   function getAssignedProjects($includeFiles = false)
287   {
288     $result = array();
289     $mdb2 = getConnection();
290
291     $user_id = $this->getUser();
292     $group_id = $this->getGroup();
293     $org_id = $this->org_id;
294
295     if ($includeFiles) {
296       $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
297       $fileJoin =  " left join (select distinct entity_id from tt_files".
298       " where entity_type = 'project' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
299       " on (p.id = Sub1.entity_id)";
300     }
301
302     // Do a query with inner join to get assigned projects.
303     $sql = "select p.id, p.name, p.description, p.tasks, upb.rate $filePart from tt_projects p $fileJoin".
304       " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id and upb.status = 1)".
305       " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
306     $res = $mdb2->query($sql);
307     if (!is_a($res, 'PEAR_Error')) {
308       while ($val = $res->fetchRow()) {
309         $result[] = $val;
310       }
311     }
312     return $result;
313   }
314
315   // getAssignedTasks - returns an array of assigned tasks.
316   function getAssignedTasks()
317   {
318     // Start with projects;
319     $projects = $this->getAssignedProjects();
320     if (!$projects) return false;
321
322     // Build an array of task ids.
323     $task_ids = array();
324     foreach($projects as $project) {
325       $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
326       $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
327     }
328     if (!$task_ids) return false;
329
330     // Get task descriptions.
331     $result = array();
332     $mdb2 = getConnection();
333     $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
334
335     $group_id = $this->getGroup();
336     $org_id = $this->org_id;
337
338     $sql = "select id, name, description from tt_tasks".
339       " where group_id = $group_id and org_id = $org_id and status = 1 and id in ($tasks) order by name";
340     $res = $mdb2->query($sql);
341     if (!is_a($res, 'PEAR_Error')) {
342       while ($val = $res->fetchRow()) {
343         $result[] = $val;
344       }
345     }
346     return $result;
347   }
348
349   // getAssignedClients - returns an array of clients assigned to own projects.
350   function getAssignedClients()
351   {
352     // Start with projects;
353     $projects = $this->getAssignedProjects();
354     if (!$projects) return false;
355     $assigned_project_ids = array();
356     foreach($projects as $project) {
357       $assigned_project_ids[] = $project['id'];
358     }
359
360     $mdb2 = getConnection();
361
362     $group_id = $this->getGroup();
363     $org_id = $this->org_id;
364
365     // Get active clients for group.
366     $clients = array();
367     $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
368     $res = $mdb2->query($sql);
369     if (!is_a($res, 'PEAR_Error')) {
370       while ($val = $res->fetchRow()) {
371         $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
372         if (array_intersect($assigned_project_ids, $client_project_ids))
373           $clients[] = $val; // Add client if one of user projects is a client project, too.
374       }
375     }
376     return $clients;
377   }
378
379   // isDateLocked checks whether a specifc date is locked for modifications.
380   function isDateLocked($date)
381   {
382     if (!$this->isPluginEnabled('lk'))
383       return false; // Locking feature is disabled.
384
385     if (!$this->getLockSpec())
386       return false; // There is no lock specification.
387
388     if (!$this->behalf_id && $this->can('override_own_date_lock'))
389       return false; // User is working as self and can override own date lock.
390
391     if ($this->behalf_id && $this->can('override_date_lock'))
392       return false; // User is working on behalf of someone else and can override date lock.
393
394     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
395     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
396
397     // Calculate the last occurrence of a lock.
398     $last = tdCron::getLastOccurrence($this->getLockSpec(), time());
399     $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
400     if ($date->before($lockdate))
401       return true;
402
403     return false;
404   }
405
406   // canOverridePunchMode checks whether a user can override punch mode in a situation.
407   function canOverridePunchMode()
408   {
409     if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
410       return false; // User is working as self and cannot override for self.
411
412     if ($this->behalf_id && !$this->can('override_punch_mode'))
413       return false; // User is working on behalf of someone else and cannot override.
414
415     return true;
416   }
417
418   // getUsers obtains users in a group, as specififed by options.
419   function getUsers($options) {
420     $mdb2 = getConnection();
421
422     $group_id = $this->getGroup();
423     $org_id = $this->org_id;
424
425     $skipClients = !isset($options['include_clients']);
426     $includeSelf = isset($options['include_self']);
427
428     $select_part = 'select u.id, u.group_id, u.name';
429     if (isset($options['include_login'])) {
430       $select_part .= ', u.login';
431       // Piggy-back on include_login to see if we must also include quota_percent.
432       $include_quota = $this->isPluginEnabled('mq');
433       if ($include_quota) {
434         $decimal_mark = $this->getDecimalMark();
435         $replaceDecimalMark = ('.' != $decimal_mark);
436         $select_part .= ', u.quota_percent';
437       }
438     }
439     if (!isset($options['include_clients'])) $select_part .= ', r.rights';
440     if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
441
442     $from_part = ' from tt_users u';
443
444     $left_joins = null;
445     if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
446       $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
447
448     $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
449     if (isset($options['status']))
450       $where_part .= ' and u.status = '.(int)$options['status'];
451     else
452       $where_part .= ' and u.status is not null';
453     if ($includeSelf) {
454       $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
455     } else {
456       if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
457     }
458
459     $order_part = " order by upper(u.name)";
460
461     $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
462     $res = $mdb2->query($sql);
463     $user_list = array();
464     if (is_a($res, 'PEAR_Error'))
465       return false;
466
467     while ($val = $res->fetchRow()) {
468       if ($skipClients) {
469         $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
470         if ($isClient)
471           continue; // Skip adding clients.
472       }
473       if ($include_quota) {
474         $quota = $val['quota_percent'];
475         if (ttEndsWith($quota, '.00'))
476           $quota = substr($quota, 0, strlen($quota)-3); // Trim trailing ".00";
477         elseif ($replaceDecimalMark)
478           $quota = str_replace('.', $decimal_mark, $quota);
479         $val['quota_percent'] = $quota.'%';
480       }
481       $user_list[] = $val;
482     }
483
484     if (isset($options['self_first'])) {
485       // Put own entry at the front.
486       $cnt = count($user_list);
487       for($i = 0; $i < $cnt; $i++) {
488         if ($user_list[$i]['id'] == $this->id) {
489           $self = $user_list[$i]; // Found self.
490           array_unshift($user_list, $self); // Put own entry at the front.
491           array_splice($user_list, $i+1, 1); // Remove duplicate.
492         }
493       }
494     }
495     return $user_list;
496   }
497
498   // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
499   // It consists of:
500   //   - User home group.
501   //   - The entire stack of groups all the way down to current on behalf group.
502   //   - All immediate children of the current on behalf group.
503   // This allows user to navigate easily to home group, anything in between, and 1 level below.
504   function getGroupsForDropdown() {
505     $mdb2 = getConnection();
506
507     // Start with subgroups.
508     $groups = array();
509     $group_id = $this->getGroup();
510     $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
511     $res = $mdb2->query($sql);
512     if (!is_a($res, 'PEAR_Error')) {
513       while ($val = $res->fetchRow()) {
514         $groups[] = $val;
515       }
516     }
517
518     // Add current on behalf group to the beginning of array.
519     $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
520     $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
521     array_unshift($groups,  array('id'=>$selected_group_id,'name'=>$selected_group_name));
522
523     // Iterate all the way to the home group, starting with selected ("on behalf") group.
524     $current_group_id = $selected_group_id;
525     while ($current_group_id != $this->group_id) {
526       $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
527       $res = $mdb2->query($sql);
528       if (is_a($res, 'PEAR_Error')) return false;
529
530       $val = $res->fetchRow();
531       $parent_id = $val['parent_id'];
532       if ($parent_id) {
533         // Get parent group name.
534         $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
535         $res = $mdb2->query($sql);
536         if (is_a($res, 'PEAR_Error')) return false;
537         $val = $res->fetchRow();
538         if (!$val) return false;
539         array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
540         $current_group_id = $parent_id;
541       } else {
542         return false;
543       }
544     }
545     return $groups;
546   }
547
548   // getSubgroups obtains a list of immediate subgroups.
549   function getSubgroups($group_id = null) {
550     $mdb2 = getConnection();
551
552     if (!$group_id) $group_id = $this->getGroup();
553
554     $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
555       " and parent_id = $group_id and status is not null order by upper(name)";
556     $res = $mdb2->query($sql);
557     if (!is_a($res, 'PEAR_Error')) {
558       while ($val = $res->fetchRow()) {
559         $groups[] = $val;
560       }
561     }
562     return $groups;
563   }
564
565   // getUserDetails function is used to manage users in group and returns user details.
566   // At the moment, the function is used for user edits and deletes.
567   function getUserDetails($user_id) {
568     if (!$this->can('manage_users')) return false;
569
570     $mdb2 = getConnection();
571     $group_id = $this->getGroup();
572     $org_id = $this->org_id;
573
574     // Determine max rank. If we are searching in on behalf group
575     // then rank restriction does not apply.
576     $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
577
578     $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".
579       " left join tt_roles r on (u.role_id = r.id)".
580       " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
581       " and (r.rank < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self.
582     $res = $mdb2->query($sql);
583     if (!is_a($res, 'PEAR_Error')) {
584       $val = $res->fetchRow();
585       return $val;
586     }
587     return false;
588   }
589
590   // checkBehalfId checks whether behalf_id is appropriate.
591   // On behalf user must be active and have lower rank if the user is from home group,
592   // otherwise:
593   // - subgroup must ve valid;
594   // - user should be a member of it.
595   function checkBehalfId() {
596     if (!$this->behalfGroup) {
597       // Checking user from home group.
598       $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
599       $users = $this->getUsers($options);
600       foreach($users as $one_user) {
601         if ($one_user['id'] == $this->behalf_id)
602           return true;
603       }
604     } else {
605       // Checking user from a subgroup.
606       $group_id = $this->behalfGroup->id;
607       if (!$this->isSubgroupValid($group_id))
608         return false;
609
610       // So far, so good. Check user now.
611       $options = array('status'=>ACTIVE,'max_rank'=>MAX_RANK);
612       $users = $this->getUsers($options);
613       foreach($users as $one_user) {
614         if ($one_user['id'] == $this->behalf_id)
615           return true;
616       }
617     }
618     return false;
619   }
620
621   // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
622   // apropriate user.
623   //
624   // Needed for situations when user does not have do_own_something right.
625   // Example: has view_charts but does not have view_own_charts.
626   // In this case we still allow access to charts, but set behalf_id to someone else.
627   // Another example: working in a subgroup on behalf of someone else.
628   function adjustBehalfId() {
629     $rank = $this->getMaxRankForGroup($this->getGroup());
630
631     // Adjust to first found user in group.
632     $options = array('status'=>ACTIVE,'max_rank'=>$rank);
633     $users = $this->getUsers($options);
634     foreach($users as $one_user) {
635       // Fake loop to access first element.
636       $this->behalf_id = $one_user['id'];
637       $this->behalf_name = $one_user['name'];
638       $_SESSION['behalf_id'] = $this->behalf_id;
639       $_SESSION['behalf_name'] = $this->behalf_name;
640       return true;
641     }
642     return false;
643   }
644
645   // updateGroup updates group information with new data.
646   function updateGroup($fields) {
647     $mdb2 = getConnection();
648
649     $group_id = $fields['group_id'];
650     if ($group_id && !$this->isGroupValid($group_id)) return false;
651     if (!$group_id) $group_id = $this->getGroup();
652
653     if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
654     if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
655     if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
656     if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
657     if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
658     if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
659     if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
660     if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
661     if (isset($fields['tracking_mode'])) {
662       $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
663       $project_required_part = ' , project_required = '.(int) $fields['project_required'];
664       $task_required_part = ' , task_required = '.(int) $fields['task_required'];
665     }
666     if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
667     if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
668     if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
669     if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
670     if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
671     if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
672     if (isset($fields['holidays'])) $holidays_part = ', holidays = '.$mdb2->quote($fields['holidays']);
673     if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
674     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
675
676     $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
677       $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
678       $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$holidays_part.$workday_minutes_part.$modified_part, ',');
679
680     $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
681     $affected = $mdb2->exec($sql);
682     if (is_a($affected, 'PEAR_Error')) return false;
683
684     return true;
685   }
686
687   // markUserDeleted marks a user in group as deleted.
688   function markUserDeleted($user_id) {
689     if (!$this->can('manage_users') || $this->id == $user_id)
690       return false;
691
692     // Make sure we operate on a legit user.
693     $user_details = $this->getUserDetails($user_id);
694     if (!$user_details) return false;
695
696     $mdb2 = getConnection();
697     $group_id = $this->getGroup();
698     $org_id = $this->org_id;
699
700     // Mark user to project binds as deleted.
701     $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
702       " and group_id = $group_id and org_id = $org_id";
703     $affected = $mdb2->exec($sql);
704     if (is_a($affected, 'PEAR_Error'))
705       return false;
706
707     // Mark user favorite reports as deleted.
708     $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
709       " and group_id = $group_id and org_id = $org_id";
710     $affected = $mdb2->exec($sql);
711     if (is_a($affected, 'PEAR_Error'))
712       return false;
713
714     // Mark user as deleted.
715     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
716     $sql = "update tt_users set status = null $modified_part where id = $user_id".
717       " and group_id = $group_id and org_id = $org_id";
718     $affected = $mdb2->exec($sql);
719     if (is_a($affected, 'PEAR_Error'))
720       return false;
721
722     return true;
723   }
724
725   // enablePlugin either enables or disables a specific plugin for group.
726   function enablePlugin($plugin, $enable = true)
727   {
728     if (!$this->can('manage_advanced_settings'))
729       return false; // Note: enablePlugin is currently only used on week_view.php.
730                     // So, it's not really a plugin we are enabling, but rather week view display options.
731                     // Therefore, a check for manage_advanced_settings, not manage_features.
732
733     $plugin_array = explode(',', $this->plugins);
734     if ($enable && !in_array($plugin, $plugin_array))
735       $plugin_array[] = $plugin; // Add plugin to array.
736
737     if (!$enable && in_array($plugin, $plugin_array)) {
738       $key = array_search($plugin, $plugin_array);
739       if ($key !== false)
740         unset($plugin_array[$key]); // Remove plugin from array.
741     }
742
743     $plugins = implode(',', $plugin_array);
744     if ($plugins != $this->plugins) {
745       if (!$this->updateGroup(array('plugins' => $plugins)))
746         return false;
747       $this->plugins = $plugins;
748     }
749
750     return true;
751   }
752
753   // isUserValid determines if a user is valid for on behalf work.
754   function isUserValid($user_id) {
755     if ($user_id == $this->id)
756       return true;
757     return ($this->getUserDetails($user_id) != null);
758   }
759
760   // isGroupValid determines if a group is valid for user.
761   function isGroupValid($group_id) {
762     if ($group_id == $this->group_id)
763       return true;
764     else
765       return $this->isSubgroupValid($group_id);
766   }
767
768   // isSubgroupValid determines if a subgroup is valid for user.
769   // A subgroup is valid if:
770   //   - user can manage_subgroups;
771   //   - subgroup is either a direct child of user group, or "on the path"
772   //   to it (grand-child, etc.).
773   function isSubgroupValid($subgroup_id) {
774     if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
775
776     $current_group_id = $subgroup_id;
777     while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
778       if ($parent_group_id == $this->group_id) {
779         return true; // Found it.
780       }
781       $current_group_id = $parent_group_id;
782     }
783     return false;
784   }
785
786   // getMaxRankForGroup determines effective user rank for a user in a given group.
787   // For home group it is the existing user rank (as per role) minus 1.
788   // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
789   function getMaxRankForGroup($group_id) {
790
791     $max_rank = 0; // Start safely.
792     if ($this->group_id == $group_id) {
793       $max_rank = $this->rank - 1;
794       return $max_rank;
795     }
796
797     if ($this->isSubgroupValid($group_id))
798       $max_rank = MAX_RANK;
799
800     return $max_rank;
801   }
802
803   // getUserPartForHeader constructs a string for user to display on pages header.
804   // It changes with "on behalf" attributes for both user and group.
805   function getUserPartForHeader() {
806     global $i18n;
807     if (!$this->id) return null;
808
809     $user_part = htmlspecialchars($this->name);
810     $user_part .= ' - '.htmlspecialchars($this->role_name);
811     if ($this->behalf_id) {
812       $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
813     }
814     if ($this->behalf_group_id) {
815       $user_part .= ',  <span class="onBehalf">'.htmlspecialchars($this->behalf_group_name).'</span>';
816     } else {
817       if ($this->group_name) // Note: we did not require group names in the past.
818         $user_part .= ', '.$this->group_name;
819     }
820     return $user_part;
821   }
822
823   // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
824   function setOnBehalfGroup($group_id) {
825
826     // Unset things first.
827     $this->behalf_group_id = null;
828     $this->behalf_group_name = null;
829     $this->behalf_id = null;
830     $this->behalf_name = null;
831     unset($this->behalfGroup);
832     unset($_SESSION['behalf_group_id']);
833     unset($_SESSION['behalf_group_name']);
834     unset($_SESSION['behalf_id']);
835     unset($_SESSION['behalf_name']);
836
837     // Destroy report bean if it was set in session.
838     $form = new Form('dummyForm');
839     $bean = new ActionForm('reportBean', $form, $request);
840     if ($bean->isSaved()) {
841       $bean->destroyBean();
842     }
843
844     // Do not do anything if we don't have rights.
845     if (!$this->can('manage_subgroups')) return;
846
847     // No need to set if group is our home group.
848     if ($group_id == $this->group_id) return;
849
850     // No need to set if subgroup is not valid.
851     if (!$this->isSubgroupValid($group_id)) return;
852
853     // We are good to set on behalf group.
854     $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
855     $_SESSION['behalf_group_id'] = $group_id;
856     $_SESSION['behalf_group_name'] = $onBehalfGroupName;
857     $this->behalf_group_id = $group_id;
858     $this->behalf_group_name = $onBehalfGroupName;
859
860     $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
861
862     // Adjust on behalf user to first found user in subgroup.
863     $this->adjustBehalfId();
864     return;
865   }
866
867   // setOnBehalfUser sets on behalf user both the object and the session.
868   function setOnBehalfUser($user_id) {
869
870     // Unset things first.
871     $this->behalf_id = null;
872     $this->behalf_name = null;
873     unset($this->behalfUser);
874     unset($_SESSION['behalf_id']);
875     unset($_SESSION['behalf_name']);
876
877     // No need to set if user is us.
878     if ($user_id == $this->id) return;
879
880     // No need to set if user id is not valid.
881     if (!$this->isUserValid($user_id)) return;
882
883     // We are good to set on behalf user.
884     $onBehalfUserName = ttUserHelper::getUserName($user_id);
885     $_SESSION['behalf_id'] = $user_id;
886     $_SESSION['behalf_name'] = $onBehalfUserName;
887     $this->behalf_id = $user_id;
888     $this->behalf_name = $onBehalfUserName;
889
890     $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
891     return;
892   }
893
894   // The exists() function determines if an active user exists in context of a page.
895   // If we are working as self, true.
896   // If we are working in a subgroup with active users, true.
897   // If we are working in a subgroup without active users, false.
898   function exists() {
899     if (!$this->behalfGroup)
900       return true; // Working as self.
901     else if ($this->behalfGroup->active_users)
902       return true; // Subgroup has users.
903
904     return false;
905   }
906 }