Started to replace canManageTeam calls with right checks.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index 20efe25..dd42a64 100644 (file)
@@ -31,7 +31,9 @@ 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 = 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.
   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.
@@ -41,20 +43,25 @@ class ttUser {
   var $date_format = null;      // Date format.
   var $time_format = null;      // Time format.
   var $week_start = 0;          // Week start day.
+  var $show_holidays = 0;       // Whether to show holidays in calendar.
   var $tracking_mode = 0;       // Tracking mode.
   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.
   var $plugins = null;          // Comma-separated list of enabled plugins.
+  var $config = null;           // Comma-separated list of miscellaneous config options.
   var $team = null;             // Team name.
   var $custom_logo = 0;         // Whether to use a custom logo for team.
-  var $address = null;          // Address for invoices.
   var $lock_spec = null;        // Cron specification for record locking.
-  var $workday_hours = 8;       // Number of work hours in a regular day.
-  var $rights = 0;              // A mask of user rights.
+  var $workday_minutes = 480;   // Number of work minutes in a regular day.
+  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) {
@@ -65,11 +72,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, 
-      t.address, 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.uncompleted_indicators,
-      t.bcc_email, t.plugins, t.lock_spec, t.workday_hours, t.custom_logo
-      FROM tt_users u LEFT JOIN tt_teams t ON (u.team_id = t.id) WHERE ";
+    $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,
+      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) LEFT JOIN tt_roles r on (r.id = u.role_id) WHERE ";
     if ($id)
       $sql .= "u.id = $id";
     else
@@ -88,6 +95,16 @@ class ttUser {
       $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.
       $this->client_id = $val['client_id'];
       $this->email = $val['email'];
       $this->lang = $val['lang'];
@@ -99,45 +116,45 @@ class ttUser {
       $this->project_required = $val['project_required'];
       $this->task_required = $val['task_required'];
       $this->record_type = $val['record_type'];
-      $this->uncompleted_indicators = $val['uncompleted_indicators'];
       $this->bcc_email = $val['bcc_email'];
       $this->team = $val['team_name'];
-      $this->address = $val['address'];
       $this->currency = $val['currency'];
       $this->plugins = $val['plugins'];
       $this->lock_spec = $val['lock_spec'];
-      $this->workday_hours = $val['workday_hours'];
+      $this->workday_minutes = $val['workday_minutes'];
       $this->custom_logo = $val['custom_logo'];
 
+      $this->config = $val['config'];
+      $config_array = explode(',', $this->config);
+
+      // 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.
       if (isset($_SESSION['behalf_id'])) {
           $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.
@@ -152,7 +169,7 @@ class ttUser {
 
   // 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.
@@ -204,4 +221,28 @@ 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;
+  }
 }