Improved users page a bit in accordance with user rights.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index f468f55..5321e74 100644 (file)
@@ -31,8 +31,8 @@ class ttUser {
   var $name = null;             // User name.
   var $id = null;               // User id.
   var $team_id = null;          // Team id.
-  var $role = null;             // User role (user, client, comanager, manager, admin). TODO: remove when new roles are done.
   var $role_id = null;          // Role id.
+  var $role_name = null;        // Role name.
   var $rank = null;             // User role rank.
   var $client_id = null;        // Client id for client user role.
   var $behalf_id = null;        // User id, on behalf of whom we are working.
@@ -72,7 +72,7 @@ class ttUser {
 
     $mdb2 = getConnection();
 
-    $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role, u.role_id, r.rank, r.rights, u.client_id, u.email, t.name as team_name,
+    $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role_id, r.rank, r.name as role_name, r.rights, u.client_id, u.email, t.name as team_name,
       t.currency, t.lang, t.decimal_mark, t.date_format, t.time_format, t.week_start,
       t.tracking_mode, t.project_required, t.task_required, t.record_type,
       t.bcc_email, t.plugins, t.config, t.lock_spec, t.workday_minutes, t.custom_logo
@@ -94,17 +94,11 @@ class ttUser {
       $this->name = $val['name'];
       $this->id = $val['id'];
       $this->team_id = $val['team_id'];
-      $this->role = $val['role'];
       $this->role_id = $val['role_id'];
+      $this->role_name = $val['role_name'];
       $this->rights = explode(',', $val['rights']);
       $this->is_client = !in_array('track_own_time', $this->rights);
       $this->rank = $val['rank'];
-      // Downgrade rank to legacy role, if it is still in use.
-      if ($this->role > 0 && $this->rank > $this->role)
-        $this->rank = $this->role; // TODO: remove after roles revamp.
-      // Upgrade rank from legacy role, for user who does not yet have a role_id.
-      if (!$this->rank && !$this->role_id && $this->role > 0)
-        $this->rank = $this->role; // TODO: remove after roles revamp.
       $this->client_id = $val['client_id'];
       $this->email = $val['email'];
       $this->lang = $val['lang'];
@@ -158,13 +152,17 @@ class ttUser {
   }
 
   // isManager - determines whether current user is team manager.
+  // This is a legacy function that we are getting rid of by replacing with rights check.
   function isManager() {
-    return (ROLE_MANAGER == $this->role);
+    return $this->can('export_data'); // By default this is assigned to managers but not co-managers.
+                                      // Which is sufficient for now until we refactor all calls
+                                      // to this function and then remove it.
   }
 
   // isCoManager - determines whether current user is team comanager.
+  // This is a legacy function that we are getting rid of by replacing with rights check.
   function isCoManager() {
-    return (ROLE_COMANAGER == $this->role);
+    return ($this->can('manage_users') && !$this->can('export_data'));
   }
 
   // isClient - determines whether current user is a client.
@@ -173,8 +171,11 @@ class ttUser {
   }
 
   // canManageTeam - determines whether current user is manager or co-manager.
+  // This is a legacy function that we are getting rid of by replacing with rights check.
   function canManageTeam() {
-    return (right_manage_team & $this->role);
+    return $this->can('manage_users'); // By default this is assigned to co-managers (an managers).
+                                       // Which is sufficient for now until we refactor all calls
+                                       // to this function and then remove it.
   }
 
   // isPluginEnabled checks whether a plugin is enabled for user.
@@ -205,45 +206,127 @@ class ttUser {
   // isDateLocked checks whether a specifc date is locked for modifications.
   function isDateLocked($date)
   {
-    if ($this->isPluginEnabled('lk') && $this->lock_spec) {
+    if (!$this->isPluginEnabled('lk'))
+      return false; // Locking feature is disabled.
 
-      // Override.
-      if ($this->can('override_date_lock')) return false;
+    if (!$this->lock_spec)
+      return false; // There is no lock specification.
 
-      require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
-      require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
+    if (!$this->behalf_id && $this->can('override_own_date_lock'))
+      return false; // User is working as self and can override own date lock.
+
+    if ($this->behalf_id && $this->can('override_date_lock'))
+      return false; // User is working on behalf of someone else and can override date lock.
+
+    require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
+    require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
+
+    // Calculate the last occurrence of a lock.
+    $last = tdCron::getLastOccurrence($this->lock_spec, time());
+    $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
+    if ($date->before($lockdate))
+      return true;
 
-      // Calculate the last occurrence of a lock.
-      $last = tdCron::getLastOccurrence($this->lock_spec, time());
-      $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
-      if ($date->before($lockdate)) {
-        return true;
-      }
-    }
     return false;
   }
 
-  // migrateLegacyRole makes changes to user database record and assigns a user to
-  // one of pre-defined roles, which are created if necessary.
-  // No changes to $this instance are done.
-  function migrateLegacyRole() {
-    // Do nothing if we already have a role_id.
-    if ($this->role_id) return false;
+  // canOverridePunchMode checks whether a user can override punch mode in a situation.
+  function canOverridePunchMode()
+  {
+    if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
+      return false; // User is working as self and cannot override for self.
 
-    // Create default roles if necessary.
-    import ('ttRoleHelper');
-    if (!ttRoleHelper::rolesExist()) ttRoleHelper::createDefaultRoles(); // TODO: refactor or remove after roles revamp.
+    if ($this->behalf_id && !$this->can('override_punch_mode'))
+      return false; // User is working on behalf of someone else and cannot override.
 
-    // Obtain new role id based on legacy role.
-    $role_id = ttRoleHelper::getRoleByRank($this->role);
-    if (!$role_id) return false; // Role not found, nothing to do.
+    return true;
+  }
+
+  // getUsers obtains users in a group, as specififed by options.
+  function getUsers($options) {
 
     $mdb2 = getConnection();
-    $sql = "update tt_users set role_id = $role_id where id = $this->id and team_id = $this->team_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error'))
+
+    $skipClients = !isset($options['include_clients']);
+    $includeSelf = isset($options['include_self']);
+
+    $select_part = 'select u.id, u.name';
+    if (isset($options['include_login'])) $select_part .= ', u.login';
+    if (!isset($options['include_clients'])) $select_part .= ', r.rights';
+    if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
+
+    $from_part = ' from tt_users u';
+
+    $left_joins = null;
+    if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
+        $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
+
+    $where_part = " where u.team_id = $this->team_id";
+    if (isset($options['status'])) $where_part .= ' and u.status = '.(int)$options['status'];
+    if ($includeSelf) {
+      $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
+    } else {
+      if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
+    }
+
+    $sql = $select_part.$from_part.$left_joins.$where_part;
+    $res = $mdb2->query($sql);
+    $user_list = array();
+    if (is_a($res, 'PEAR_Error'))
       return false;
 
-    return true;
+    while ($val = $res->fetchRow()) {
+      if ($skipClients) {
+        $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
+        if ($isClient)
+          continue; // Skip adding clients.
+      }
+      $user_list[] = $val;
+    }
+
+    if (isset($options['self_first'])) {
+      // Put own entry at the front.
+      $cnt = count($user_list);
+      for($i = 0; $i < $cnt; $i++) {
+        if ($user_list[$i]['id'] == $this->id) {
+          $self = $user_list[$i]; // Found self.
+          array_unshift($user_list, $self); // Put own entry at the front.
+          array_splice($user_list, $i+1, 1); // Remove duplicate.
+        }
+      }
+    }
+    return $user_list;
+  }
+
+  // checkBehalfId checks whether behalf_id is appropriate.
+  // On behalf user must be active and have lower rank.
+  function checkBehalfId() {
+    $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
+    $users = $this->getUsers($options);
+    foreach($users as $one_user) {
+      if ($one_user['id'] == $this->behalf_id)
+        return true;
+    }
+    return false;
+  }
+
+  // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
+  // apropriate user.
+  //
+  // Needed for situations when user does not have do_own_something right.
+  // Example: has view_charts but does not have view_own_charts.
+  // In this case we still allow access to charts, but set behalf_id to someone else.
+  function adjustBehalfId() {
+    $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
+    $users = $this->getUsers($options);
+    foreach($users as $one_user) {
+      // Fake loop to access first element.
+      $this->behalf_id = $one_user['id'];
+      $this->behalf_name = $one_user['name'];
+      $_SESSION['behalf_id'] = $this->behalf_id;
+      $_SESSION['behalf_name'] = $this->behalf_name;
+      return true;
+    }
+    return false;
   }
 }