A bit more progress with renaming.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index 9a4dee4..e3de5b4 100644 (file)
@@ -30,12 +30,9 @@ class ttUser {
   var $login = null;            // User login.
   var $name = null;             // User name.
   var $id = null;               // User id.
-  var $team_id = null;          // Team id.
-  var $legacy_role = null;      // Old user role (user, client, comanager, manager, admin). TODO: remove when new roles are done.
-                                // Complete removal requires refactoring migrateLegacyRole, which is used in dbinstall.php.
-                                // Perhaps, after doing an installer?
-
+  var $group_id = null;         // Group id.
   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.
@@ -56,6 +53,7 @@ class ttUser {
   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 $allow_ip = null;         // Specification from where user is allowed access.
   var $currency = null;         // Currency.
   var $plugins = null;          // Comma-separated list of enabled plugins.
   var $config = null;           // Comma-separated list of miscellaneous config options.
@@ -75,11 +73,11 @@ 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,
-      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 ";
+    $sql = "SELECT u.id, u.login, u.name, u.group_id, u.role_id, r.rank, r.name as role_name, r.rights, u.client_id, u.email, g.name as group_name,
+      g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
+      g.tracking_mode, g.project_required, g.task_required, g.record_type,
+      g.bcc_email, g.allow_ip, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
+      FROM tt_users u LEFT JOIN tt_groups g ON (u.group_id = g.id) LEFT JOIN tt_roles r on (r.id = u.role_id) WHERE ";
     if ($id)
       $sql .= "u.id = $id";
     else
@@ -96,14 +94,12 @@ class ttUser {
       $this->login = $val['login'];
       $this->name = $val['name'];
       $this->id = $val['id'];
-      $this->team_id = $val['team_id'];
-      $this->legacy_role = $val['role'];
+      $this->group_id = $val['group_id'];
       $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_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'];
@@ -116,7 +112,8 @@ class ttUser {
       $this->task_required = $val['task_required'];
       $this->record_type = $val['record_type'];
       $this->bcc_email = $val['bcc_email'];
-      $this->team = $val['team_name'];
+      $this->allow_ip = $val['allow_ip'];
+      $this->team = $val['group_name'];
       $this->currency = $val['currency'];
       $this->plugins = $val['plugins'];
       $this->lock_spec = $val['lock_spec'];
@@ -198,7 +195,7 @@ class ttUser {
     // Do a query with inner join to get assigned projects.
     $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
       inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
-      where p.team_id = $this->team_id and p.status = 1 order by p.name";
+      where p.group_id = $this->group_id and p.status = 1 order by p.name";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -208,23 +205,211 @@ class ttUser {
     return $result;
   }
 
+  // getAssignedTasks - returns an array of assigned tasks.
+  function getAssignedTasks()
+  {
+    // Start with projects;
+    $projects = $this->getAssignedProjects();
+    if (!$projects) return false;
+
+    // Build an array of task ids.
+    $task_ids = array();
+    foreach($projects as $project) {
+      $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
+      $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
+    }
+    if (!$task_ids) return false;
+
+    // Get task descriptions.
+    $result = array();
+    $mdb2 = getConnection();
+    $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
+
+    $sql = "select id, name, description from tt_tasks".
+      " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      while ($val = $res->fetchRow()) {
+        $result[] = $val;
+      }
+    }
+    return $result;
+  }
+
+  // getAssignedClients - returns an array of clients assigned to own projects.
+  function getAssignedClients()
+  {
+    // Start with projects;
+    $projects = $this->getAssignedProjects();
+    if (!$projects) return false;
+    $assigned_project_ids = array();
+    foreach($projects as $project) {
+      $assigned_project_ids[] = $project['id'];
+    }
+
+    $mdb2 = getConnection();
+
+    // Get active clients for group.
+    $clients = array();
+    $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      while ($val = $res->fetchRow()) {
+        $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
+        if (array_intersect($assigned_project_ids, $client_project_ids))
+          $clients[] = $val; // Add client if one of user projects is a client project, too.
+      }
+    }
+    return $clients;
+  }
+
   // 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.
 
-      // 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->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;
+  }
+
+  // getUsers obtains users in a group, as specififed by options.
+  function getUsers($options) {
+
+    $mdb2 = getConnection();
+
+    $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.group_id = $this->group_id";
+    if (isset($options['status']))
+      $where_part .= ' and u.status = '.(int)$options['status'];
+    else
+      $where_part .= ' and u.status is not null';
+    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'];
+    }
+
+    $order_part = " order by upper(u.name)";
+
+    $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
+    $res = $mdb2->query($sql);
+    $user_list = array();
+    if (is_a($res, 'PEAR_Error'))
+      return false;
+
+    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;
+  }
+
+  // getUser function is used to manage users in group and returns user details.
+  // At the moment, the function is used for user edits and deletes.
+  function getUser($user_id) {
+    if (!$this->can('manage_users')) return false;
+
+    $mdb2 = getConnection();
+
+    $sql =  "select u.id, u.name, u.login, u.role_id, u.status, u.rate, u.email from tt_users u".
+            " left join tt_roles r on (u.role_id = r.id)".
+            " where u.id = $user_id and u.group_id = $this->group_id and u.status is not null".
+            " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      $val = $res->fetchRow();
+      return $val;
+    }
+    return false;
+  }
+
+  // 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;
   }