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