Refactored monthly quota config for subgroups.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index 968a1f1..5a32891 100644 (file)
@@ -59,7 +59,6 @@ class ttUser {
   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 $allow_ip = null;         // Specification from where user is allowed access.
   var $password_complexity = null; // Password complexity example.
@@ -142,7 +141,6 @@ class ttUser {
       $this->punch_mode = $config->getDefinedValue('punch_mode');
       $this->allow_overlap = $config->getDefinedValue('allow_overlap');
       $this->future_entries = $config->getDefinedValue('future_entries');
-      $this->uncompleted_indicators = $config->getDefinedValue('uncompleted_indicators');
       if ($this->isPluginEnabled('wu')) {
         $minutes_in_unit = $config->getIntValue('minutes_in_unit');
         if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
@@ -166,8 +164,13 @@ class ttUser {
     }
   }
 
+  // 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 getGroup returns group id on behalf of which the current user is operating.
-   function getGroup() {
+  function getGroup() {
     return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
   }
 
@@ -176,6 +179,16 @@ class ttUser {
     return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
   }
 
+  // getDateFormat returns date format for active group.
+  function getDateFormat() {
+    return ($this->behalfGroup ? $this->behalfGroup->date_format : $this->date_format);
+  }
+
+  // getTimeFormat returns time format for active group.
+  function getTimeFormat() {
+    return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
+  }
+
   // getTrackingMode returns tracking mode for active group.
   function getTrackingMode() {
     return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
@@ -186,19 +199,38 @@ class ttUser {
     return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
   }
 
+  // getCurrency returns currency string for active group.
+  function getCurrency() {
+    return ($this->behalfGroup ? $this->behalfGroup->currency : $this->currency);
+  }
+
   // getPlugins returns plugins string for active group.
   function getPlugins() {
     return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
   }
 
+  // getLockSpec returns lock specification for active group.
+  function getLockSpec() {
+    return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
+  }
+
+  // getWorkdayMinutes returns workday_minutes for active group.
+  function getWorkdayMinutes() {
+    return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
+  }
+
   // getConfig returns config string for active group.
   function getConfig() {
     return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
   }
 
-  // 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);
+  // getConfigOption returns true if an option is defined for group.
+  // This helps us keeping a set of user attributes smaller.
+  // We determine whether the option is set only on pages that need to know.
+  // For example: confirm_save is used only on time and expense edit pages.
+  function getConfigOption($name) {
+    $config = new ttConfigHelper($this->getConfig());
+    return $config->getDefinedValue($name);
   }
 
   // can - determines whether user has a right to do something.
@@ -223,11 +255,14 @@ class ttUser {
     $result = array();
     $mdb2 = getConnection();
 
-    $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
+    $user_id = $this->getUser();
+    $group_id = $this->getGroup();
+    $org_id = $this->org_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)
-      where p.group_id = $group_id and p.status = 1 order by p.name";
+    $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 = $user_id and upb.project_id = p.id and upb.status = 1)".
+      " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -281,9 +316,12 @@ class ttUser {
 
     $mdb2 = getConnection();
 
+    $group_id = $this->getGroup();
+    $org_id = $this->org_id;
+
     // 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";
+    $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -301,7 +339,7 @@ class ttUser {
     if (!$this->isPluginEnabled('lk'))
       return false; // Locking feature is disabled.
 
-    if (!$this->lock_spec)
+    if (!$this->getLockSpec())
       return false; // There is no lock specification.
 
     if (!$this->behalf_id && $this->can('override_own_date_lock'))
@@ -314,7 +352,7 @@ class ttUser {
     require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
 
     // Calculate the last occurrence of a lock.
-    $last = tdCron::getLastOccurrence($this->lock_spec, time());
+    $last = tdCron::getLastOccurrence($this->getLockSpec(), time());
     $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
     if ($date->before($lockdate))
       return true;
@@ -344,7 +382,7 @@ class ttUser {
     $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';
@@ -479,19 +517,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->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();
@@ -506,7 +548,7 @@ class ttUser {
   // - subgroup must ve valid;
   // - user should be a member of it.
   function checkBehalfId() {
-    if (!$this->behalf_group_id) {
+    if (!$this->behalfGroup) {
       // Checking user from home group.
       $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
       $users = $this->getUsers($options);
@@ -516,7 +558,7 @@ class ttUser {
       }
     } else {
       // Checking user from a subgroup.
-      $group_id = $this->behalf_group_id;
+      $group_id = $this->behalfGroup->id;
       if (!$this->isSubgroupValid($group_id))
         return false;
 
@@ -539,11 +581,10 @@ class ttUser {
   // In this case we still allow access to charts, but set behalf_id to someone else.
   // Another example: working in a subgroup on behalf of someone else.
   function adjustBehalfId() {
-    $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
-    $rank = $this->getMaxRankForGroup($group_id);
+    $rank = $this->getMaxRankForGroup($this->getGroup());
 
     // Adjust to first found user in group.
-    $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
+    $options = array('status'=>ACTIVE,'max_rank'=>$rank);
     $users = $this->getUsers($options);
     foreach($users as $one_user) {
       // Fake loop to access first element.
@@ -558,15 +599,10 @@ class ttUser {
 
   // updateGroup updates group information with new data.
   function updateGroup($fields) {
-    if (!($this->can('manage_basic_settings') ||
-      $this->can('manage_advanced_settings') ||
-      $this->can('manage_features'))) return false;
-    // TODO: update the above for subgroup updates.
+    $mdb2 = getConnection();
 
     $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']);
@@ -608,7 +644,7 @@ 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();
@@ -671,14 +707,7 @@ class ttUser {
   function isUserValid($user_id) {
     if ($user_id == $this->id)
       return true;
-
-    $user_details = $this->getUser($user_id); // TODO: this will probably not work for higher ranks.
-                                              // In this case we'll need another function.
-                                              // Or adjust getUser for max rank.
-    if (!$user_details)
-      return false;
-
-    return true;
+    return ($this->getUserDetails($user_id) != null);
   }
 
   // isGroupValid determines if a group is valid for user.
@@ -736,7 +765,7 @@ class ttUser {
       $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>';
+      $user_part .= ',  <span class="onBehalf">'.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;
@@ -776,12 +805,12 @@ class ttUser {
 
     $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
 
-    // Adjust on behalf user.
+    // Adjust on behalf user to first found user in subgroup.
     $this->adjustBehalfId();
     return;
   }
 
-   // setOnBehalfUser sets on behalf user both the object and the session.
+  // setOnBehalfUser sets on behalf user both the object and the session.
   function setOnBehalfUser($user_id) {
 
     // Unset things first.
@@ -804,4 +833,17 @@ class ttUser {
     $this->behalf_name = $onBehalfUserName;
     return;
   }
+
+  // The exists() function determines if an active user exists in context of a page.
+  // If we are working as self, true.
+  // If we are working in a subgroup with active users, true.
+  // If we are working in a subgroup without active users, false.
+  function exists() {
+    if (!$this->behalfGroup)
+      return true; // Working as self.
+    else if ($this->behalfGroup->active_users)
+      return true; // Subgroup has users.
+
+    return false;
+  }
 }