Refactoring.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index f64a76c..e0bbbe5 100644 (file)
@@ -31,7 +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).
+  var $role_id = null;          // Role id.
+  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.
   var $behalf_name = null;      // User name, on behalf of whom we are working.
@@ -46,7 +47,9 @@ class ttUser {
   var $project_required = 0;    // Whether project selection is required on time entires.
   var $task_required = 0;       // Whether task selection is required on time entires.
   var $record_type = 0;         // Record type (duration vs start and finish, or both).
+  var $punch_mode = 0;          // Whether punch mode is enabled for user.
   var $allow_overlap = 0;       // Whether to allow overlapping time entries.
+  var $future_entries = 0;      // Whether to allow creating future entries.
   var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
   var $bcc_email = null;        // Bcc email.
   var $currency = null;         // Currency.
@@ -56,7 +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 = 0;              // A mask of user rights.
+  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) {
@@ -67,11 +71,11 @@ class ttUser {
 
     $mdb2 = getConnection();
 
-    $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role, 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.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
-      FROM tt_users u LEFT JOIN tt_teams t ON (u.team_id = t.id) WHERE ";
+      FROM tt_users u LEFT JOIN tt_teams t ON (u.team_id = t.id) LEFT JOIN tt_roles r on (r.id = u.role_id) WHERE ";
     if ($id)
       $sql .= "u.id = $id";
     else
@@ -89,7 +93,10 @@ 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'];
       $this->client_id = $val['client_id'];
       $this->email = $val['email'];
       $this->lang = $val['lang'];
@@ -114,7 +121,9 @@ class ttUser {
 
       // Set user config options.
       $this->show_holidays = in_array('show_holidays', $config_array);
+      $this->punch_mode = in_array('punch_mode', $config_array);
       $this->allow_overlap = in_array('allow_overlap', $config_array);
+      $this->future_entries = in_array('future_entries', $config_array);
       $this->uncompleted_indicators = in_array('uncompleted_indicators', $config_array);
 
       // Set "on behalf" id and name.
@@ -122,50 +131,49 @@ class ttUser {
           $this->behalf_id = $_SESSION['behalf_id'];
           $this->behalf_name = $_SESSION['behalf_name'];
       }
-
-      // Set user rights.
-      if ($this->role == ROLE_USER) {
-        $this->rights = right_data_entry|right_view_charts|right_view_reports;
-      } elseif ($this->role == ROLE_CLIENT) {
-        $this->rights = right_view_reports|right_view_invoices; // TODO: how about right_view_charts, too?
-      } elseif ($this->role == ROLE_COMANAGER) {
-        $this->rights = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team;
-      } elseif ($this->role == ROLE_MANAGER) {
-        $this->rights = 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 = 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.
@@ -196,20 +204,39 @@ class ttUser {
   // isDateLocked checks whether a specifc date is locked for modifications.
   function isDateLocked($date)
   {
-    if ($this->isPluginEnabled('lk') && $this->lock_spec) {
-      // Override for managers.
-      if ($this->canManageTeam()) return false;
-
-      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;
-      }
-    }
+    if (!$this->isPluginEnabled('lk'))
+      return false; // Locking feature is disabled.
+
+    if (!$this->lock_spec)
+      return false; // There is no lock specification.
+
+    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;
+
     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.
+
+    if ($this->behalf_id && !$this->can('override_punch_mode'))
+      return false; // User is working on behalf of someone else and cannot override.
+
+    return true;
+  }
 }