A few bugs fixed related to role revamp.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index 3d85023..f7b6234 100644 (file)
@@ -31,7 +31,6 @@ 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 $rank = null;             // User role rank.
   var $client_id = null;        // Client id for client user role.
@@ -60,8 +59,8 @@ class ttUser {
   var $custom_logo = 0;         // Whether to use a custom logo for team.
   var $lock_spec = null;        // Cron specification for record locking.
   var $workday_minutes = 480;   // Number of work minutes in a regular day.
-  var $rights_mask = 0;         // A mask of user rights. TODO: remove after roles revamp.
-  var $rights = array();        // An array of user rights, planned replacement of $rights_mask.
+  var $rights = array();        // An array of user rights such as 'track_own_time', etc.
+  var $is_client = false;       // Whether user is a client as determined by missing 'track_own_time' right.
 
   // Constructor.
   function __construct($login, $id = null) {
@@ -94,16 +93,12 @@ 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->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.
+      // Downgrade rank to legacy ROLE_MANAGER rank, until we have sub-groups implemented.
+      if ($this->rank > ROLE_MANAGER) $this->rank = ROLE_MANAGER;
       $this->client_id = $val['client_id'];
       $this->email = $val['email'];
       $this->lang = $val['lang'];
@@ -138,50 +133,49 @@ class ttUser {
           $this->behalf_id = $_SESSION['behalf_id'];
           $this->behalf_name = $_SESSION['behalf_name'];
       }
-
-      // Set user rights. TODO: remove during roles revamp, whe we redo access checks.
-      if ($this->role == ROLE_USER) {
-        $this->rights_mask = right_data_entry|right_view_charts|right_view_reports;
-      } elseif ($this->role == ROLE_CLIENT) {
-        $this->rights_mask = right_view_reports|right_view_invoices;
-      } elseif ($this->role == ROLE_COMANAGER) {
-        $this->rights_mask = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team;
-      } elseif ($this->role == ROLE_MANAGER) {
-        $this->rights_mask = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team|right_assign_roles|right_export_team;
-      } elseif ($this->role == ROLE_SITE_ADMIN) {
-        $this->rights_mask = right_administer_site;
-      }
     }
   }
 
-  // The getActiveUser returns user id on behalf of whom current user is operating.
+  // The getActiveUser returns user id on behalf of whom the current user is operating.
   function getActiveUser() {
     return ($this->behalf_id ? $this->behalf_id : $this->id);
   }
 
+  // can - determines whether user has a right to do something.
+  function can($do_something) {
+    return in_array($do_something, $this->rights);
+  }
+
   // isAdmin - determines whether current user is admin (has right_administer_site).
   function isAdmin() {
-    return (right_administer_site & $this->role);
+    return $this->can('administer_site');
   }
 
   // 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.
   function isClient() {
-    return (ROLE_CLIENT == $this->role);
+    return $this->is_client;
   }
 
   // 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.
@@ -213,8 +207,9 @@ class ttUser {
   function isDateLocked($date)
   {
     if ($this->isPluginEnabled('lk') && $this->lock_spec) {
-      // Override for managers.
-      if ($this->canManageTeam()) return false;
+
+      // Override.
+      if ($this->can('override_date_lock')) return false;
 
       require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
       require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
@@ -228,28 +223,4 @@ class ttUser {
     }
     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;
-
-    // Create default roles if necessary.
-    import ('ttRoleHelper');
-    if (!ttRoleHelper::rolesExist()) ttRoleHelper::createDefaultRoles(); // TODO: refactor or remove after roles revamp.
-
-    // 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.
-
-    $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'))
-      return false;
-
-    return true;
-  }
 }