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