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