Added code to migrate legacy role on user entry to the system.

[timetracker.git] / WEB-INF / lib / ttUser.class.php

diff --git a/WEB-INF/lib/ttUser.class.php b/WEB-INF/lib/ttUser.class.php
index 37907c4d4ffc96aa8a7e8b73f7b2d2b86b853d0b..5ead08bc8ca0bec895f513af4ade4a5373fb35f5 100644 (file)
--- a/WEB-INF/lib/ttUser.class.php
+++ b/WEB-INF/lib/ttUser.class.php
@@ -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.
@@ -52,7 +54,6 @@ class ttUser {
   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 $roles = 1;               // Whether we use configurable roles.
   var $plugins = null;          // Comma-separated list of enabled plugins.
   var $config = null;           // Comma-separated list of miscellaneous config options.
   var $team = null;             // Team name.
@@ -71,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, 
+    $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role, u.role_id, r.rank, 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
@@ -94,6 +95,14 @@ class ttUser {
       $this->id = $val['id'];
       $this->team_id = $val['team_id'];
       $this->role = $val['role'];
+      $this->role_id = $val['role_id'];
+      $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'];
@@ -117,7 +126,6 @@ class ttUser {
       $config_array = explode(',', $this->config);
 
       // Set user config options.
-      $this->roles = in_array('roles', $config_array);
       $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);
@@ -261,4 +269,28 @@ define('ROLE_SITE_ADMIN', 1024); // Site administrator.
     }
     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;
+  }
 }