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