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