Finished refactoring ttAdmin class.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index ccd1f96..eae6b83 100644 (file)
@@ -166,14 +166,39 @@ class ttUser {
     }
   }
 
-  // The getActiveUser returns user id on behalf of whom the current user is operating.
-  function getActiveUser() {
+  // The getUser returns user id on behalf of whom the current user is operating.
+  function getUser() {
     return ($this->behalf_id ? $this->behalf_id : $this->id);
   }
 
-  // The getActiveGroup returns group id on behalf of which the current user is operating.
-  function getActiveGroup() {
-    return ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
+  // The getGroup returns group id on behalf of which the current user is operating.
+  function getGroup() {
+    return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
+  }
+
+  // getDecimalMark returns decimal mark for active group.
+  function getDecimalMark() {
+    return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
+  }
+
+  // getTrackingMode returns tracking mode for active group.
+  function getTrackingMode() {
+    return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
+  }
+
+  // getRecordType returns record type for active group.
+  function getRecordType() {
+    return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
+  }
+
+  // getPlugins returns plugins string for active group.
+  function getPlugins() {
+    return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
+  }
+
+  // getConfig returns config string for active group.
+  function getConfig() {
+    return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
   }
 
   // can - determines whether user has a right to do something.
@@ -189,7 +214,7 @@ class ttUser {
   // isPluginEnabled checks whether a plugin is enabled for user.
   function isPluginEnabled($plugin)
   {
-    return in_array($plugin, explode(',', $this->plugins));
+    return in_array($plugin, explode(',', $this->getPlugins()));
   }
 
   // getAssignedProjects - returns an array of assigned projects.
@@ -201,7 +226,7 @@ class ttUser {
     $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
     // 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)
+      inner join tt_user_project_binds upb on (upb.user_id = ".$this->getUser()." and upb.project_id = p.id and upb.status = 1)
       where p.group_id = $group_id and p.status = 1 order by p.name";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
@@ -313,13 +338,13 @@ class ttUser {
   function getUsers($options) {
     $mdb2 = getConnection();
 
-    $group_id = $this->getActiveGroup();
+    $group_id = $this->getGroup();
     $org_id = $this->org_id;
 
     $skipClients = !isset($options['include_clients']);
     $includeSelf = isset($options['include_self']);
 
-    $select_part = 'select u.id, u.name';
+    $select_part = 'select u.id, u.group_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';
@@ -378,12 +403,27 @@ class ttUser {
   //   - The entire stack of groups all the way down to current on behalf group.
   //   - All immediate children of the current on behalf group.
   // This allows user to navigate easily to home group, anything in between, and 1 level below.
+  //
+  // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
+  // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
+  // in some groups. We should check for feature availability on group change
+  // in post and redirect to feature_disabled.php when this happens.
+  // This will allow us to keep dropdown content consistent on all pages.
+  // Filtering content of the dropdown does not seem right.
+  //
+  // Note 2: Menu should display according to $user home group settings.
+  //         Pages, should look according to $user->behalfGroup settings (if set).
+  //         For example, if home group allows tasks, menu should display Tasks,
+  //         even when we are on behalf of a subgroup without tasks.
+  //
+  // Note 3: Language of all pages should be as in $user home group even when
+  //         subgroups have a different language.
   function getGroupsForDropdown() {
     $mdb2 = getConnection();
 
     // Start with subgroups.
     $groups = array();
-    $group_id = $this->getActiveGroup();
+    $group_id = $this->getGroup();
     $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
@@ -426,7 +466,7 @@ class ttUser {
   function getSubgroups($group_id = null) {
     $mdb2 = getConnection();
 
-    if (!$group_id) $group_id = $this->getActiveGroup();
+    if (!$group_id) $group_id = $this->getGroup();
 
     $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
       " and parent_id = $group_id and status is not null order by upper(name)";
@@ -439,19 +479,23 @@ class ttUser {
     return $groups;
   }
 
-  // getUser function is used to manage users in group and returns user details.
+  // getUserDetails 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) {
+  function getUserDetails($user_id) {
     if (!$this->can('manage_users')) return false;
 
     $mdb2 = getConnection();
-    $group_id = $this->getActiveGroup();
+    $group_id = $this->getGroup();
     $org_id = $this->org_id;
 
+    // Determine max rank. If we are searching in on behalf group
+    // then rank restriction does not apply.
+    $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
+
     $sql =  "select u.id, u.name, u.login, u.role_id, u.client_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 = $group_id and u.org_id = $org_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.
+      " and (r.rank < $max_rank or (r.rank = $max_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();
@@ -527,7 +571,7 @@ class ttUser {
     if ($group_id && !$this->isGroupValid($group_id)) return false;
 
     $mdb2 = getConnection();
-    if (!$group_id) $group_id = $this->getActiveGroup();
+    if (!$group_id) $group_id = $this->getGroup();
 
     if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
     if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
@@ -568,11 +612,11 @@ class ttUser {
       return false;
 
     // Make sure we operate on a legit user.
-    $user_details = $this->getUser($user_id);
+    $user_details = $this->getUserDetails($user_id);
     if (!$user_details) return false;
 
     $mdb2 = getConnection();
-    $group_id = $this->getActiveGroup();
+    $group_id = $this->getGroup();
     $org_id = $this->org_id;
 
     // Mark user to project binds as deleted.
@@ -627,6 +671,13 @@ class ttUser {
     return true;
   }
 
+  // isUserValid determines if a user is valid for on behalf work.
+  function isUserValid($user_id) {
+    if ($user_id == $this->id)
+      return true;
+    return ($this->getUserDetails($user_id) != null);
+  }
+
   // isGroupValid determines if a group is valid for user.
   function isGroupValid($group_id) {
     if ($group_id == $this->group_id)
@@ -698,6 +749,7 @@ class ttUser {
     $this->behalf_group_name = null;
     $this->behalf_id = null;
     $this->behalf_name = null;
+    unset($this->behalfGroup);
     unset($_SESSION['behalf_group_id']);
     unset($_SESSION['behalf_group_name']);
     unset($_SESSION['behalf_id']);
@@ -706,10 +758,10 @@ class ttUser {
     // Do not do anything if we don't have rights.
     if (!$this->can('manage_subgroups')) return;
 
-    // No need to set if the group is our home group.
+    // No need to set if group is our home group.
     if ($group_id == $this->group_id) return;
 
-    // No need to set if the subgroup is not valid.
+    // No need to set if subgroup is not valid.
     if (!$this->isSubgroupValid($group_id)) return;
 
     // We are good to set on behalf group.
@@ -719,11 +771,34 @@ class ttUser {
     $this->behalf_group_id = $group_id;
     $this->behalf_group_name = $onBehalfGroupName;
 
-    unset($this->behalfGroup);
     $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
 
     // Adjust on behalf user.
     $this->adjustBehalfId();
     return;
   }
+
+   // setOnBehalfUser sets on behalf user both the object and the session.
+  function setOnBehalfUser($user_id) {
+
+    // Unset things first.
+    $this->behalf_id = null;
+    $this->behalf_name = null;
+    unset($_SESSION['behalf_id']);
+    unset($_SESSION['behalf_name']);
+
+    // No need to set if user is us.
+    if ($user_id == $this->id) return;
+
+    // No need to set if user id is not valid.
+    if (!$this->isUserValid($user_id)) return;
+
+    // We are good to set on behalf user.
+    $onBehalfUserName = ttUserHelper::getUserName($user_id);
+    $_SESSION['behalf_id'] = $user_id;
+    $_SESSION['behalf_name'] = $onBehalfUserName;
+    $this->behalf_id = $user_id;
+    $this->behalf_name = $onBehalfUserName;
+    return;
+  }
 }