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
  32 class ttUser {
  33   var $login = null;            // User login.
  34   var $name = null;             // User name.
  35   var $id = null;               // User id.
  36   var $org_id = null;           // Organization id.
  37   var $group_id = null;         // Group id.
  38   var $role_id = null;          // Role id.
  39   var $role_name = null;        // Role name.
  40   var $rank = null;             // User role rank.
  41   var $client_id = null;        // Client id for client user role.
  42   var $behalf_id = null;        // User id, on behalf of whom we are working.
  43   var $behalf_group_id = null;  // Group id, on behalf of which we are working.
  44   var $behalf_name = null;      // User name, on behalf of whom we are working.
  45   var $group_name = null;       // Group name.
  46   var $behalf_group_name = null;// Group name, on behalf of which we are working.
  47   var $email = null;            // User email.
  48   var $lang = null;             // Language.
  49   var $decimal_mark = null;     // Decimal separator.
  50   var $date_format = null;      // Date format.
  51   var $time_format = null;      // Time format.
  52   var $week_start = 0;          // Week start day.
  53   var $show_holidays = 0;       // Whether to show holidays in calendar.
  54   var $tracking_mode = 0;       // Tracking mode.
  55   var $project_required = 0;    // Whether project selection is required on time entires.
  56   var $task_required = 0;       // Whether task selection is required on time entires.
  57   var $record_type = 0;         // Record type (duration vs start and finish, or both).
  58   var $punch_mode = 0;          // Whether punch mode is enabled for user.
  59   var $allow_overlap = 0;       // Whether to allow overlapping time entries.
  60   var $future_entries = 0;      // Whether to allow creating future entries.
  61   var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
  62   var $bcc_email = null;        // Bcc email.
  63   var $allow_ip = null;         // Specification from where user is allowed access.
  64   var $password_complexity = null; // Password complexity example.
  65   var $currency = null;         // Currency.
  66   var $plugins = null;          // Comma-separated list of enabled plugins.
  67   var $config = null;           // Comma-separated list of miscellaneous config options.
  68   var $custom_logo = 0;         // Whether to use a custom logo for group.
  69   var $lock_spec = null;        // Cron specification for record locking.
  70   var $workday_minutes = 480;   // Number of work minutes in a regular day.
  71   var $rights = array();        // An array of user rights such as 'track_own_time', etc.
  72   var $is_client = false;       // Whether user is a client as determined by missing 'track_own_time' right.
  73   var $minutes_in_unit = 15;    // Number of minutes in unit for Work units plugin.
  74   var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
  75   var $unit_totals_only = 0;    // Totals only option for the Work units plugin.
  76
  77   // Constructor.
  78   function __construct($login, $id = null) {
  79     if (!$login && !$id) {
  80       // nothing to initialize
  81       return;
  82     }
  83
  84     $mdb2 = getConnection();
  85
  86     $sql = "SELECT u.id, u.login, u.name, u.group_id, u.role_id, r.rank, r.name as role_name, r.rights, u.client_id, u.email,
  87       g.org_id, g.name as group_name, g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
  88       g.tracking_mode, g.project_required, g.task_required, g.record_type,
  89       g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
  90       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 ";
  91     if ($id)
  92       $sql .= "u.id = $id";
  93     else
  94       $sql .= "u.login = ".$mdb2->quote($login);
  95     $sql .= " AND u.status = 1";
  96
  97     $res = $mdb2->query($sql);
  98     if (is_a($res, 'PEAR_Error')) {
  99       return;
 100     }
 101
 102     $val = $res->fetchRow();
 103     if ($val['id'] > 0) {
 104       $this->login = $val['login'];
 105       $this->name = $val['name'];
 106       $this->id = $val['id'];
 107       $this->org_id = $val['org_id'];
 108       $this->group_id = $val['group_id'];
 109       $this->role_id = $val['role_id'];
 110       $this->role_name = $val['role_name'];
 111       $this->rights = explode(',', $val['rights']);
 112       $this->is_client = !in_array('track_own_time', $this->rights);
 113       $this->rank = $val['rank'];
 114       $this->client_id = $val['client_id'];
 115       $this->email = $val['email'];
 116       $this->lang = $val['lang'];
 117       $this->decimal_mark = $val['decimal_mark'];
 118       $this->date_format = $val['date_format'];
 119       $this->time_format = $val['time_format'];
 120       $this->week_start = $val['week_start'];
 121       $this->tracking_mode = $val['tracking_mode'];
 122       $this->project_required = $val['project_required'];
 123       $this->task_required = $val['task_required'];
 124       $this->record_type = $val['record_type'];
 125       $this->bcc_email = $val['bcc_email'];
 126       $this->allow_ip = $val['allow_ip'];
 127       $this->password_complexity = $val['password_complexity'];
 128       $this->group_name = $val['group_name'];
 129       $this->currency = $val['currency'];
 130       $this->plugins = $val['plugins'];
 131       $this->lock_spec = $val['lock_spec'];
 132       $this->workday_minutes = $val['workday_minutes'];
 133       $this->custom_logo = $val['custom_logo'];
 134
 135       $this->config = $val['config'];
 136       $config = new ttConfigHelper($this->config);
 137       // Set user config options.
 138       $this->show_holidays = $config->getDefinedValue('show_holidays');
 139       $this->punch_mode = $config->getDefinedValue('punch_mode');
 140       $this->allow_overlap = $config->getDefinedValue('allow_overlap');
 141       $this->future_entries = $config->getDefinedValue('future_entries');
 142       $this->uncompleted_indicators = $config->getDefinedValue('uncompleted_indicators');
 143       if ($this->isPluginEnabled('wu')) {
 144         $minutes_in_unit = $config->getIntValue('minutes_in_unit');
 145         if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
 146         $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
 147         if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
 148         $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
 149       }
 150
 151       // Set "on behalf" id and name (user).
 152       if (isset($_SESSION['behalf_id'])) {
 153           $this->behalf_id = $_SESSION['behalf_id'];
 154           $this->behalf_name = $_SESSION['behalf_name'];
 155       }
 156       // Set "on behalf" id and name (group).
 157       if (isset($_SESSION['behalf_group_id'])) {
 158           $this->behalf_group_id = $_SESSION['behalf_group_id'];
 159           $this->behalf_group_name = $_SESSION['behalf_group_name'];
 160       }
 161     }
 162   }
 163
 164   // The getActiveUser returns user id on behalf of whom the current user is operating.
 165   function getActiveUser() {
 166     return ($this->behalf_id ? $this->behalf_id : $this->id);
 167   }
 168
 169   // The getActiveGroup returns group id on behalf of which the current user is operating.
 170   function getActiveGroup() {
 171     return ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
 172   }
 173
 174   // can - determines whether user has a right to do something.
 175   function can($do_something) {
 176     return in_array($do_something, $this->rights);
 177   }
 178
 179   // isClient - determines whether current user is a client.
 180   function isClient() {
 181     return $this->is_client;
 182   }
 183
 184   // isPluginEnabled checks whether a plugin is enabled for user.
 185   function isPluginEnabled($plugin)
 186   {
 187     return in_array($plugin, explode(',', $this->plugins));
 188   }
 189
 190   // getAssignedProjects - returns an array of assigned projects.
 191   function getAssignedProjects()
 192   {
 193     $result = array();
 194     $mdb2 = getConnection();
 195
 196     $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
 197     // Do a query with inner join to get assigned projects.
 198     $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
 199       inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
 200       where p.group_id = $group_id and p.status = 1 order by p.name";
 201     $res = $mdb2->query($sql);
 202     if (!is_a($res, 'PEAR_Error')) {
 203       while ($val = $res->fetchRow()) {
 204         $result[] = $val;
 205       }
 206     }
 207     return $result;
 208   }
 209
 210   // getAssignedTasks - returns an array of assigned tasks.
 211   function getAssignedTasks()
 212   {
 213     // Start with projects;
 214     $projects = $this->getAssignedProjects();
 215     if (!$projects) return false;
 216
 217     // Build an array of task ids.
 218     $task_ids = array();
 219     foreach($projects as $project) {
 220       $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
 221       $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
 222     }
 223     if (!$task_ids) return false;
 224
 225     // Get task descriptions.
 226     $result = array();
 227     $mdb2 = getConnection();
 228     $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
 229
 230     $sql = "select id, name, description from tt_tasks".
 231       " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
 232     $res = $mdb2->query($sql);
 233     if (!is_a($res, 'PEAR_Error')) {
 234       while ($val = $res->fetchRow()) {
 235         $result[] = $val;
 236       }
 237     }
 238     return $result;
 239   }
 240
 241   // getAssignedClients - returns an array of clients assigned to own projects.
 242   function getAssignedClients()
 243   {
 244     // Start with projects;
 245     $projects = $this->getAssignedProjects();
 246     if (!$projects) return false;
 247     $assigned_project_ids = array();
 248     foreach($projects as $project) {
 249       $assigned_project_ids[] = $project['id'];
 250     }
 251
 252     $mdb2 = getConnection();
 253
 254     // Get active clients for group.
 255     $clients = array();
 256     $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
 257     $res = $mdb2->query($sql);
 258     if (!is_a($res, 'PEAR_Error')) {
 259       while ($val = $res->fetchRow()) {
 260         $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
 261         if (array_intersect($assigned_project_ids, $client_project_ids))
 262           $clients[] = $val; // Add client if one of user projects is a client project, too.
 263       }
 264     }
 265     return $clients;
 266   }
 267
 268   // isDateLocked checks whether a specifc date is locked for modifications.
 269   function isDateLocked($date)
 270   {
 271     if (!$this->isPluginEnabled('lk'))
 272       return false; // Locking feature is disabled.
 273
 274     if (!$this->lock_spec)
 275       return false; // There is no lock specification.
 276
 277     if (!$this->behalf_id && $this->can('override_own_date_lock'))
 278       return false; // User is working as self and can override own date lock.
 279
 280     if ($this->behalf_id && $this->can('override_date_lock'))
 281       return false; // User is working on behalf of someone else and can override date lock.
 282
 283     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
 284     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
 285
 286     // Calculate the last occurrence of a lock.
 287     $last = tdCron::getLastOccurrence($this->lock_spec, time());
 288     $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
 289     if ($date->before($lockdate))
 290       return true;
 291
 292     return false;
 293   }
 294
 295   // canOverridePunchMode checks whether a user can override punch mode in a situation.
 296   function canOverridePunchMode()
 297   {
 298     if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
 299       return false; // User is working as self and cannot override for self.
 300
 301     if ($this->behalf_id && !$this->can('override_punch_mode'))
 302       return false; // User is working on behalf of someone else and cannot override.
 303
 304     return true;
 305   }
 306
 307   // getUsers obtains users in a group, as specififed by options.
 308   function getUsers($options) {
 309     $mdb2 = getConnection();
 310
 311     $group_id = $this->getActiveGroup();
 312     $org_id = $this->org_id;
 313
 314     $skipClients = !isset($options['include_clients']);
 315     $includeSelf = isset($options['include_self']);
 316
 317     $select_part = 'select u.id, u.name';
 318     if (isset($options['include_login'])) $select_part .= ', u.login';
 319     if (!isset($options['include_clients'])) $select_part .= ', r.rights';
 320     if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
 321
 322     $from_part = ' from tt_users u';
 323
 324     $left_joins = null;
 325     if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
 326         $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
 327
 328     $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
 329     if (isset($options['status']))
 330       $where_part .= ' and u.status = '.(int)$options['status'];
 331     else
 332       $where_part .= ' and u.status is not null';
 333     if ($includeSelf) {
 334       $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
 335     } else {
 336       if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
 337     }
 338
 339     $order_part = " order by upper(u.name)";
 340
 341     $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
 342     $res = $mdb2->query($sql);
 343     $user_list = array();
 344     if (is_a($res, 'PEAR_Error'))
 345       return false;
 346
 347     while ($val = $res->fetchRow()) {
 348       if ($skipClients) {
 349         $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
 350         if ($isClient)
 351           continue; // Skip adding clients.
 352       }
 353       $user_list[] = $val;
 354     }
 355
 356     if (isset($options['self_first'])) {
 357       // Put own entry at the front.
 358       $cnt = count($user_list);
 359       for($i = 0; $i < $cnt; $i++) {
 360         if ($user_list[$i]['id'] == $this->id) {
 361           $self = $user_list[$i]; // Found self.
 362           array_unshift($user_list, $self); // Put own entry at the front.
 363           array_splice($user_list, $i+1, 1); // Remove duplicate.
 364         }
 365       }
 366     }
 367     return $user_list;
 368   }
 369
 370   // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
 371   // It consists of:
 372   //   - User home group.
 373   //   - The entire stack of groups all the way down to current on behalf group.
 374   //   - All immediate children of the current on behalf group.
 375   // This allows user to navigate easily to home group, anything in between, and 1 level below.
 376   function getGroupsForDropdown() {
 377     $mdb2 = getConnection();
 378
 379     // Start with subgroups.
 380     $groups = array();
 381     $group_id = $this->getActiveGroup();
 382     $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
 383     $res = $mdb2->query($sql);
 384     if (!is_a($res, 'PEAR_Error')) {
 385       while ($val = $res->fetchRow()) {
 386         $groups[] = $val;
 387       }
 388     }
 389
 390     // Add current on behalf group to the beginning of array.
 391     $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
 392     $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
 393     array_unshift($groups,  array('id'=>$selected_group_id,'name'=>$selected_group_name));
 394
 395     // Iterate all the way to the home group, starting with selected ("on behalf") group.
 396     $current_group_id = $selected_group_id;
 397     while ($current_group_id != $this->group_id) {
 398       $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
 399       $res = $mdb2->query($sql);
 400       if (is_a($res, 'PEAR_Error')) return false;
 401
 402       $val = $res->fetchRow();
 403       $parent_id = $val['parent_id'];
 404       if ($parent_id) {
 405         // Get parent group name.
 406         $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
 407         $res = $mdb2->query($sql);
 408         if (is_a($res, 'PEAR_Error')) return false;
 409         $val = $res->fetchRow();
 410         if (!$val) return false;
 411         array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
 412         $current_group_id = $parent_id;
 413       } else {
 414         return false;
 415       }
 416     }
 417     return $groups;
 418   }
 419
 420   // getSubgroups obtains a list of immediate subgroups.
 421   function getSubgroups($group_id = null) {
 422     $mdb2 = getConnection();
 423
 424     if (!$group_id) $group_id = $this->getActiveGroup();
 425
 426     $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
 427       " and parent_id = $group_id and status is not null order by upper(name)";
 428     $res = $mdb2->query($sql);
 429     if (!is_a($res, 'PEAR_Error')) {
 430       while ($val = $res->fetchRow()) {
 431         $groups[] = $val;
 432       }
 433     }
 434     return $groups;
 435   }
 436
 437   // getUser function is used to manage users in group and returns user details.
 438   // At the moment, the function is used for user edits and deletes.
 439   function getUser($user_id) {
 440     if (!$this->can('manage_users')) return false;
 441
 442     $mdb2 = getConnection();
 443
 444     $sql =  "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.email from tt_users u".
 445             " left join tt_roles r on (u.role_id = r.id)".
 446             " where u.id = $user_id and u.group_id = $this->group_id and u.status is not null".
 447             " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
 448     $res = $mdb2->query($sql);
 449     if (!is_a($res, 'PEAR_Error')) {
 450       $val = $res->fetchRow();
 451       return $val;
 452     }
 453     return false;
 454   }
 455
 456   // checkBehalfId checks whether behalf_id is appropriate.
 457   // On behalf user must be active and have lower rank if the user is from home group,
 458   // otherwise:
 459   // - subgroup must ve valid;
 460   // - user should be a member of it.
 461   function checkBehalfId() {
 462     if (!$this->behalf_group_id) {
 463       // Checking user from home group.
 464       $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
 465       $users = $this->getUsers($options);
 466       foreach($users as $one_user) {
 467         if ($one_user['id'] == $this->behalf_id)
 468           return true;
 469       }
 470     } else {
 471       // Checking user from a subgroup.
 472       $group_id = $this->behalf_group_id;
 473       if (!$this->isSubgroupValid($group_id))
 474         return false;
 475
 476       // So far, so good. Check user now.
 477       $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
 478       $users = $this->getUsers($options);
 479       foreach($users as $one_user) {
 480         if ($one_user['id'] == $this->behalf_id)
 481           return true;
 482       }
 483     }
 484     return false;
 485   }
 486
 487   // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
 488   // apropriate user.
 489   //
 490   // Needed for situations when user does not have do_own_something right.
 491   // Example: has view_charts but does not have view_own_charts.
 492   // In this case we still allow access to charts, but set behalf_id to someone else.
 493   // Another example: working in a subgroup on behalf of someone else.
 494   function adjustBehalfId() {
 495     $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
 496     $rank = $this->getMaxRankForGroup($group_id);
 497
 498     // Adjust to first found user in group.
 499     $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
 500     $users = $this->getUsers($options);
 501     foreach($users as $one_user) {
 502       // Fake loop to access first element.
 503       $this->behalf_id = $one_user['id'];
 504       $this->behalf_name = $one_user['name'];
 505       $_SESSION['behalf_id'] = $this->behalf_id;
 506       $_SESSION['behalf_name'] = $this->behalf_name;
 507       return true;
 508     }
 509     return false;
 510   }
 511
 512   // updateGroup updates group information with new data.
 513   function updateGroup($fields) {
 514     if (!($this->can('manage_basic_settings') ||
 515       $this->can('manage_advanced_settings') ||
 516       $this->can('manage_features'))) return false;
 517     // TODO: update the above for subgroup updates.
 518
 519     $group_id = $fields['group_id'];
 520     if ($group_id && !$this->isGroupValid($group_id)) return false;
 521
 522     $mdb2 = getConnection();
 523     if (!$group_id) $group_id = $this->getActiveGroup();
 524
 525     if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
 526     if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
 527     if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
 528     if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
 529     if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
 530     if (isset($fields['date_format'])) $date_format_part = ', date_format = '.$mdb2->quote($fields['date_format']);
 531     if (isset($fields['time_format'])) $time_format_part = ', time_format = '.$mdb2->quote($fields['time_format']);
 532     if (isset($fields['week_start'])) $week_start_part = ', week_start = '.(int) $fields['week_start'];
 533     if (isset($fields['tracking_mode'])) {
 534       $tracking_mode_part = ', tracking_mode = '.(int) $fields['tracking_mode'];
 535       $project_required_part = ' , project_required = '.(int) $fields['project_required'];
 536       $task_required_part = ' , task_required = '.(int) $fields['task_required'];
 537     }
 538     if (isset($fields['record_type'])) $record_type_part = ', record_type = '.(int) $fields['record_type'];
 539     if (isset($fields['bcc_email'])) $bcc_email_part = ', bcc_email = '.$mdb2->quote($fields['bcc_email']);
 540     if (isset($fields['allow_ip'])) $allow_ip_part = ', allow_ip = '.$mdb2->quote($fields['allow_ip']);
 541     if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
 542     if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
 543     if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
 544     if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
 545     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
 546
 547     $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
 548       $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
 549       $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
 550
 551     $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
 552     $affected = $mdb2->exec($sql);
 553     if (is_a($affected, 'PEAR_Error')) return false;
 554
 555     return true;
 556   }
 557
 558   // markUserDeleted marks a user in group as deleted.
 559   function markUserDeleted($user_id) {
 560     if (!$this->can('manage_users') || $this->id == $user_id)
 561       return false;
 562
 563     // Make sure we operate on a legit user.
 564     $user_details = $this->getUser($user_id);
 565     if (!$user_details) return false;
 566
 567     $mdb2 = getConnection();
 568
 569     // Mark user to project binds as deleted.
 570     $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
 571     $affected = $mdb2->exec($sql);
 572     if (is_a($affected, 'PEAR_Error'))
 573       return false;
 574
 575     // Mark user favorite reports as deleted.
 576     $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
 577     $affected = $mdb2->exec($sql);
 578     if (is_a($affected, 'PEAR_Error'))
 579       return false;
 580
 581     // Mark user as deleted.
 582     $sql = "update tt_users set status = NULL where id = $user_id and group_id = ".$this->group_id;
 583     $affected = $mdb2->exec($sql);
 584     if (is_a($affected, 'PEAR_Error'))
 585       return false;
 586
 587     return true;
 588   }
 589
 590   // enablePlugin either enables or disables a specific plugin for group.
 591   function enablePlugin($plugin, $enable = true)
 592   {
 593     if (!$this->can('manage_advanced_settings'))
 594       return false; // Note: enablePlugin is currently only used on week_view.php.
 595                     // So, it's not really a plugin we are enabling, but rather week view display options.
 596                     // Therefore, a check for manage_advanced_settings, not manage_features.
 597
 598     $plugin_array = explode(',', $this->plugins);
 599     if ($enable && !in_array($plugin, $plugin_array))
 600       $plugin_array[] = $plugin; // Add plugin to array.
 601
 602     if (!$enable && in_array($plugin, $plugin_array)) {
 603       $key = array_search($plugin, $plugin_array);
 604       if ($key !== false)
 605         unset($plugin_array[$key]); // Remove plugin from array.
 606     }
 607
 608     $plugins = implode(',', $plugin_array);
 609     if ($plugins != $this->plugins) {
 610       if (!$this->updateGroup(array('plugins' => $plugins)))
 611         return false;
 612       $this->plugins = $plugins;
 613     }
 614
 615     return true;
 616   }
 617
 618   // isGroupValid determines if a group is valid for user.
 619   function isGroupValid($group_id) {
 620     if ($group_id == $this->group_id)
 621       return true;
 622     else
 623       return $this->isSubgroupValid($group_id);
 624   }
 625
 626   // isSubgroupValid determines if a subgroup is valid for user.
 627   // A subgroup is valid if:
 628   //   - user can manage_subgroups;
 629   //   - subgroup is either a direct child of user group, or "on the path"
 630   //   to it (grand-child, etc.).
 631   function isSubgroupValid($subgroup_id) {
 632     if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
 633
 634     $current_group_id = $subgroup_id;
 635     while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
 636       if ($parent_group_id == $this->group_id) {
 637         return true; // Found it.
 638       }
 639       $current_group_id = $parent_group_id;
 640     }
 641     return false;
 642   }
 643
 644   // getMaxRankForGroup determines effective user rank for a user in a given group.
 645   // For home group it is the existing user rank (as per role) minus 1.
 646   // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
 647   function getMaxRankForGroup($group_id) {
 648
 649     $max_rank = 0; // Start safely.
 650     if ($this->group_id == $group_id) {
 651       $max_rank = $this->rank - 1;
 652       return $max_rank;
 653     }
 654
 655     if ($this->isSubgroupValid($group_id))
 656       $max_rank = MAX_RANK;
 657
 658     return $max_rank;
 659   }
 660
 661   // getUserPartForHeader constructs a string for user to display on pages header.
 662   // It changes with "on behalf" attributes for both user and group.
 663   function getUserPartForHeader() {
 664     global $i18n;
 665     if (!$this->id) return null;
 666
 667     $user_part = htmlspecialchars($this->name);
 668     $user_part .= ' - '.htmlspecialchars($this->role_name);
 669     if ($this->behalf_id) {
 670       $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
 671     }
 672     if ($this->behalf_group_id) {
 673       $user_part .= ',  <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_group_name).'</span>';
 674     } else {
 675       if ($this->group_name) // Note: we did not require group names in the past.
 676         $user_part .= ', '.$this->group_name;
 677     }
 678     return $user_part;
 679   }
 680
 681   // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
 682   function setOnBehalfGroup($group_id) {
 683
 684     // Unset things first.
 685     $this->behalf_group_id = null;
 686     $this->behalf_group_name = null;
 687     unset($_SESSION['behalf_group_id']);
 688     unset($_SESSION['behalf_group_name']);
 689
 690     // Do not do anything if we don't have rights.
 691     if (!$this->can('manage_subgroups')) return;
 692
 693     // No need to set if the group is our home group.
 694     if ($group_id == $this->group_id) return;
 695
 696     // No need to set if the subgroup is not valid.
 697     if (!$this->isSubgroupValid($group_id)) return;
 698
 699     // We are good to set on behalf group.
 700     $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
 701     $_SESSION['behalf_group_id'] = $group_id;
 702     $_SESSION['behalf_group_name'] = $onBehalfGroupName;
 703     $this->behalf_group_id = $group_id;
 704     $this->behalf_group_name = $onBehalfGroupName;
 705
 706     // Question remains whether or not we need to adjust on behalf user.
 707     // Adjusting for now. Test it and redesign if necessary.
 708     unset($_SESSION['behalf_id']);
 709     unset($_SESSION['behalf_name']);
 710     $this->adjustBehalfId();
 711     return;
 712   }
 713 }