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