Adjusted task_add.php and task_edit.php to operate with subgroups.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index 8e9a8f2..2da8f98 100644 (file)
@@ -27,6 +27,8 @@
 // +----------------------------------------------------------------------+
 
 import('ttConfigHelper');
+import('ttGroupHelper');
+import('ttGroup');
 
 class ttUser {
   var $login = null;            // User login.
@@ -73,6 +75,8 @@ class ttUser {
   var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
   var $unit_totals_only = 0;    // Totals only option for the Work units plugin.
 
+  var $behalfGroup = null;      // A ttGroup instance with on behalf group attributes.
+
   // Constructor.
   function __construct($login, $id = null) {
     if (!$login && !$id) {
@@ -149,27 +153,39 @@ class ttUser {
       
       // Set "on behalf" id and name (user).
       if (isset($_SESSION['behalf_id'])) {
-          $this->behalf_id = $_SESSION['behalf_id'];
-          $this->behalf_name = $_SESSION['behalf_name'];
+        $this->behalf_id = $_SESSION['behalf_id'];
+        $this->behalf_name = $_SESSION['behalf_name'];
       }
       // Set "on behalf" id and name (group).
       if (isset($_SESSION['behalf_group_id'])) {
-          $this->behalf_group_id = $_SESSION['behalf_group_id'];
-          $this->behalf_group_name = $_SESSION['behalf_group_name'];
+        $this->behalf_group_id = $_SESSION['behalf_group_id'];
+        $this->behalf_group_name = $_SESSION['behalf_group_name'];
+
+        $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_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);
+  }
+
   // 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);
   }
 
-  // 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);
-  }
-
   // can - determines whether user has a right to do something.
   function can($do_something) {
     return in_array($do_something, $this->rights);
@@ -305,12 +321,13 @@ class ttUser {
 
   // getUsers obtains users in a group, as specififed by options.
   function getUsers($options) {
-
     $mdb2 = getConnection();
 
+    $group_id = $this->getGroup();
+    $org_id = $this->org_id;
+
     $skipClients = !isset($options['include_clients']);
     $includeSelf = isset($options['include_self']);
-    $group_id = isset($options['group_id']) ? $options['group_id'] : $this->group_id;
 
     $select_part = 'select u.id, u.name';
     if (isset($options['include_login'])) $select_part .= ', u.login';
@@ -323,7 +340,7 @@ class ttUser {
     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.org_id = $this->org_id and u.group_id = $group_id";
+    $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
     if (isset($options['status']))
       $where_part .= ' and u.status = '.(int)$options['status'];
     else
@@ -365,60 +382,83 @@ class ttUser {
     return $user_list;
   }
 
-  // getGroups obtains an array consisting of:
-  // - A parent group (..) of a currently selected group, if available.
-  // - A currently selected group (.) represented by $behalf_group_id.
-  // - All subgroups (only immediate children) of a currently selected group.
-  function getGroups() {
+  // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
+  // It consists of:
+  //   - User home group.
+  //   - 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->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')) {
+      while ($val = $res->fetchRow()) {
+        $groups[] = $val;
+      }
+    }
+
+    // Add current on behalf group to the beginning of array.
     $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
     $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
+    array_unshift($groups,  array('id'=>$selected_group_id,'name'=>$selected_group_name));
 
-    // Start with parent group.
-    if ($selected_group_id != $this->group_id) {
-      // We are in one of subgroups, and a parent exists.
-      // Get parent group info.
-      $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $selected_group_id";
+    // Iterate all the way to the home group, starting with selected ("on behalf") group.
+    $current_group_id = $selected_group_id;
+    while ($current_group_id != $this->group_id) {
+      $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
       $res = $mdb2->query($sql);
-      if (!is_a($res, 'PEAR_Error')) {
-        $val = $res->fetchRow();
-        $parent_id = $val['parent_id'];
-        if ($parent_id) {
-          // Get parent group name.
-          $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id";
-          $res = $mdb2->query($sql);
-          if (!is_a($res, 'PEAR_Error')) {
-            $val = $res->fetchRow();
-            $groups[] = array('id'=>$parent_id,'name'=>$val['name']);
-          }
-        }
-      }
-    }
-
-    // Add current group.
-    $groups[] = array('id'=>$selected_group_id,'name'=>$selected_group_name);
+      if (is_a($res, 'PEAR_Error')) return false;
 
-    // Add subgroups.
-    $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $selected_group_id";
-    $res = $mdb2->query($sql);
-    if (!is_a($res, 'PEAR_Error')) {
-      while ($val = $res->fetchRow()) {
-        $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
+      $val = $res->fetchRow();
+      $parent_id = $val['parent_id'];
+      if ($parent_id) {
+        // Get parent group name.
+        $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id and status = 1";
+        $res = $mdb2->query($sql);
+        if (is_a($res, 'PEAR_Error')) return false;
+        $val = $res->fetchRow();
+        if (!$val) return false;
+        array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
+        $current_group_id = $parent_id;
+      } else {
+        return false;
       }
     }
     return $groups;
   }
 
   // getSubgroups obtains a list of immediate subgroups.
-  function getSubgroups() {
+  function getSubgroups($group_id = null) {
     $mdb2 = getConnection();
 
-    $sql = "select id, name, description from tt_groups where org_id = $this->org_id and parent_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)";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
-        $groups[] = $val; // array('id'=>$val['id'],'name'=>$val['name']);
+        $groups[] = $val;
       }
     }
     return $groups;
@@ -430,11 +470,13 @@ class ttUser {
     if (!$this->can('manage_users')) return false;
 
     $mdb2 = getConnection();
+    $group_id = $this->getGroup();
+    $org_id = $this->org_id;
 
     $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 = $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.
+      " 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.
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
@@ -504,10 +546,16 @@ class ttUser {
     if (!($this->can('manage_basic_settings') ||
       $this->can('manage_advanced_settings') ||
       $this->can('manage_features'))) return false;
+    // TODO: update the above for subgroup updates.
+
+    $group_id = $fields['group_id'];
+    if ($group_id && !$this->isGroupValid($group_id)) return false;
 
     $mdb2 = getConnection();
+    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']);
     if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
     if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
     if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
@@ -528,11 +576,11 @@ class ttUser {
     if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
 
-    $parts = trim($name_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
+    $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
       $time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
       $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
 
-    $sql = "update tt_groups set $parts where id = $this->group_id";
+    $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -549,21 +597,26 @@ class ttUser {
     if (!$user_details) return false;
 
     $mdb2 = getConnection();
+    $group_id = $this->getGroup();
+    $org_id = $this->org_id;
 
     // Mark user to project binds as deleted.
-    $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
+    $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
+      " and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
 
     // Mark user favorite reports as deleted.
-    $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
+    $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
+      " and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
 
     // Mark user as deleted.
-    $sql = "update tt_users set status = NULL where id = $user_id and group_id = ".$this->group_id;
+    $sql = "update tt_users set status = NULL where id = $user_id".
+      " and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
@@ -599,6 +652,14 @@ class ttUser {
     return true;
   }
 
+  // isGroupValid determines if a group is valid for user.
+  function isGroupValid($group_id) {
+    if ($group_id == $this->group_id)
+      return true;
+    else
+      return $this->isSubgroupValid($group_id);
+  }
+
   // isSubgroupValid determines if a subgroup is valid for user.
   // A subgroup is valid if:
   //   - user can manage_subgroups;
@@ -633,4 +694,62 @@ class ttUser {
 
     return $max_rank;
   }
+
+  // getUserPartForHeader constructs a string for user to display on pages header.
+  // It changes with "on behalf" attributes for both user and group.
+  function getUserPartForHeader() {
+    global $i18n;
+    if (!$this->id) return null;
+
+    $user_part = htmlspecialchars($this->name);
+    $user_part .= ' - '.htmlspecialchars($this->role_name);
+    if ($this->behalf_id) {
+      $user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
+    }
+    if ($this->behalf_group_id) {
+      $user_part .= ',  <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_group_name).'</span>';
+    } else {
+      if ($this->group_name) // Note: we did not require group names in the past.
+        $user_part .= ', '.$this->group_name;
+    }
+    return $user_part;
+  }
+
+  // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
+  function setOnBehalfGroup($group_id) {
+
+    // Unset things first.
+    $this->behalf_group_id = null;
+    $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']);
+    unset($_SESSION['behalf_name']);
+
+    // 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.
+    if ($group_id == $this->group_id) return;
+
+    // No need to set if the subgroup is not valid.
+    if (!$this->isSubgroupValid($group_id)) return;
+
+    // We are good to set on behalf group.
+    $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
+    $_SESSION['behalf_group_id'] = $group_id;
+    $_SESSION['behalf_group_name'] = $onBehalfGroupName;
+    $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;
+  }
 }