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