Refactoring, moving plugin config options into config field.
[timetracker.git] / WEB-INF / lib / ttUser.class.php
index a95fa72..5ee67f5 100644 (file)
@@ -28,6 +28,7 @@
 
 import('ttConfigHelper');
 import('ttGroupHelper');
+import('ttBehalfUser');
 import('ttGroup');
 import('form.Form');
 import('form.ActionForm');
@@ -42,6 +43,7 @@ class ttUser {
   var $role_name = null;        // Role name.
   var $rank = null;             // User role rank.
   var $client_id = null;        // Client id for client user role.
+  var $quota_percent = 100.0;   // Time quota percent for quotas plugin.
   var $behalf_id = null;        // User id, on behalf of whom we are working.
   var $behalf_group_id = null;  // Group id, on behalf of which we are working.
   var $behalf_name = null;      // User name, on behalf of whom we are working.
@@ -66,16 +68,18 @@ class ttUser {
   var $password_complexity = null; // Password complexity example.
   var $currency = null;         // Currency.
   var $plugins = null;          // Comma-separated list of enabled plugins.
+
+  // Refactoring ongoing. Towards using helper instead of config string?
   var $config = null;           // Comma-separated list of miscellaneous config options.
+  var $configHelper = null;     // An instance of ttConfigHelper class.
+
   var $custom_logo = 0;         // Whether to use a custom logo for group.
   var $lock_spec = null;        // Cron specification for record locking.
   var $workday_minutes = 480;   // Number of work minutes in a regular day.
   var $rights = array();        // An array of user rights such as 'track_own_time', etc.
   var $is_client = false;       // Whether user is a client as determined by missing 'track_own_time' right.
-  var $minutes_in_unit = 15;    // Number of minutes in unit for Work units plugin.
-  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 $behalfUser = null;       // A ttBehalfUser instance with on behalf user attributes.
   var $behalfGroup = null;      // A ttGroup instance with on behalf group attributes.
 
   // Constructor.
@@ -87,11 +91,11 @@ class ttUser {
 
     $mdb2 = getConnection();
 
-    $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.org_id, 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.password_complexity, 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 ";
+    $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.quota_percent, u.email, g.org_id, 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.password_complexity, 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
@@ -116,6 +120,7 @@ class ttUser {
       $this->rank = $val['rank'];
       $this->client_id = $val['client_id'];
       $this->is_client = $this->client_id && !in_array('track_own_time', $this->rights);
+      if ($val['quota_percent']) $this->quota_percent = $val['quota_percent'];
       $this->email = $val['email'];
       $this->lang = $val['lang'];
       $this->decimal_mark = $val['decimal_mark'];
@@ -136,25 +141,22 @@ class ttUser {
       $this->workday_minutes = $val['workday_minutes'];
       $this->custom_logo = $val['custom_logo'];
 
+      // TODO: refactor this.
       $this->config = $val['config'];
-      $config = new ttConfigHelper($this->config);
+      $this->configHelper = new ttConfigHelper($val['config']);
+
       // Set user config options.
-      $this->show_holidays = $config->getDefinedValue('show_holidays');
-      $this->punch_mode = $config->getDefinedValue('punch_mode');
-      $this->allow_overlap = $config->getDefinedValue('allow_overlap');
-      $this->future_entries = $config->getDefinedValue('future_entries');
-      if ($this->isPluginEnabled('wu')) {
-        $minutes_in_unit = $config->getIntValue('minutes_in_unit');
-        if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
-        $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
-        if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
-        $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
-      }
+      $this->show_holidays = $this->configHelper->getDefinedValue('show_holidays');
+      $this->punch_mode = $this->configHelper->getDefinedValue('punch_mode');
+      $this->allow_overlap = $this->configHelper->getDefinedValue('allow_overlap');
+      $this->future_entries = $this->configHelper->getDefinedValue('future_entries');
       
       // 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->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
       }
       // Set "on behalf" id and name (group).
       if (isset($_SESSION['behalf_group_id'])) {
@@ -166,9 +168,19 @@ class ttUser {
     }
   }
 
-  // The getUser returns user id on behalf of whom the current user is operating.
+  // getUser returns user id on behalf of whom the current user is operating.
   function getUser() {
-    return ($this->behalf_id ? $this->behalf_id : $this->id);
+    return ($this->behalfUser ? $this->behalfUser->id : $this->id);
+  }
+
+  // getName returns user name on behalf of whom the current user is operating.
+  function getName() {
+    return ($this->behalfUser ? $this->behalfUser->name : $this->name);
+  }
+
+  // getQuotaPercent returns quota percent for active user.
+  function getQuotaPercent() {
+    return ($this->behalfUser ? $this->behalfUser->quota_percent : $this->quota_percent);
   }
 
   // The getGroup returns group id on behalf of which the current user is operating.
@@ -223,7 +235,7 @@ class ttUser {
 
   // getConfig returns config string for active group.
   function getConfig() {
-    return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
+    return ($this->behalfGroup ? $this->behalfGroup->configHelper->getConfig() : $this->configHelper->getConfig());
   }
 
   // getConfigOption returns true if an option is defined for group.
@@ -236,9 +248,9 @@ class ttUser {
   }
 
   // getConfigInt retruns an integer value defined in a group, or false.
-  function getConfigInt($name) {
+  function getConfigInt($name, $defaultVal) {
     $config = new ttConfigHelper($this->getConfig());
-    return $config->getIntValue($name);
+    return $config->getIntValue($name, $defaultVal);
   }
 
   // can - determines whether user has a right to do something.
@@ -257,8 +269,21 @@ class ttUser {
     return in_array($plugin, explode(',', $this->getPlugins()));
   }
 
+  // isOptionEnabled checks whether a config option is enabled for user.
+  function isOptionEnabled($option)
+  {
+    return $this->behalfGroup ? $this->behalfGroup->configHelper->getDefinedValue($option) : $this->configHelper->getDefinedValue($option);
+  }
+
+  // setOption sets an option inside of ttConfigHelper instance.
+  // Note that it does not write to the database.
+  function setOption($option, $enable = true)
+  {
+    return $this->behalfGroup ? $this->behalfGroup->configHelper->setDefinedValue($option, $enable) : $this->configHelper->setDefinedValue($option, $enable);
+  }
+
   // getAssignedProjects - returns an array of assigned projects.
-  function getAssignedProjects()
+  function getAssignedProjects($includeFiles = false)
   {
     $result = array();
     $mdb2 = getConnection();
@@ -267,8 +292,15 @@ class ttUser {
     $group_id = $this->getGroup();
     $org_id = $this->org_id;
 
+    if ($includeFiles) {
+      $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
+      $fileJoin =  " left join (select distinct entity_id from tt_files".
+      " where entity_type = 'project' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
+      " on (p.id = Sub1.entity_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".
+    $sql = "select p.id, p.name, p.description, p.tasks, upb.rate $filePart from tt_projects p $fileJoin".
       " 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);
@@ -394,7 +426,16 @@ class ttUser {
     $includeSelf = isset($options['include_self']);
 
     $select_part = 'select u.id, u.group_id, u.name';
-    if (isset($options['include_login'])) $select_part .= ', u.login';
+    if (isset($options['include_login'])) {
+      $select_part .= ', u.login';
+      // Piggy-back on include_login to see if we must also include quota_percent.
+      $include_quota = $this->isPluginEnabled('mq');
+      if ($include_quota) {
+        $decimal_mark = $this->getDecimalMark();
+        $replaceDecimalMark = ('.' != $decimal_mark);
+        $select_part .= ', u.quota_percent';
+      }
+    }
     if (!isset($options['include_clients'])) $select_part .= ', r.rights';
     if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
 
@@ -402,7 +443,7 @@ class ttUser {
 
     $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)';
+      $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
 
     $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
     if (isset($options['status']))
@@ -429,6 +470,14 @@ class ttUser {
         if ($isClient)
           continue; // Skip adding clients.
       }
+      if ($include_quota) {
+        $quota = $val['quota_percent'];
+        if (ttEndsWith($quota, '.00'))
+          $quota = substr($quota, 0, strlen($quota)-3); // Trim trailing ".00";
+        elseif ($replaceDecimalMark)
+          $quota = str_replace('.', $decimal_mark, $quota);
+        $val['quota_percent'] = $quota.'%';
+      }
       $user_list[] = $val;
     }
 
@@ -452,21 +501,6 @@ 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();
 
@@ -541,7 +575,7 @@ class ttUser {
     // 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".
+    $sql =  "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.quota_percent, 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 < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self.
@@ -574,7 +608,7 @@ class ttUser {
         return false;
 
       // So far, so good. Check user now.
-      $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
+      $options = array('status'=>ACTIVE,'max_rank'=>MAX_RANK);
       $users = $this->getUsers($options);
       foreach($users as $one_user) {
         if ($one_user['id'] == $this->behalf_id)
@@ -677,7 +711,8 @@ class ttUser {
       return false;
 
     // Mark user as deleted.
-    $sql = "update tt_users set status = NULL where id = $user_id".
+    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
+    $sql = "update tt_users set status = null $modified_part where id = $user_id".
       " and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
@@ -834,6 +869,7 @@ class ttUser {
     // Unset things first.
     $this->behalf_id = null;
     $this->behalf_name = null;
+    unset($this->behalfUser);
     unset($_SESSION['behalf_id']);
     unset($_SESSION['behalf_name']);
 
@@ -849,6 +885,8 @@ class ttUser {
     $_SESSION['behalf_name'] = $onBehalfUserName;
     $this->behalf_id = $user_id;
     $this->behalf_name = $onBehalfUserName;
+
+    $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id);
     return;
   }