Improved ttUser::markUserDeleted by marking user custom fields as deleted also.

[timetracker.git] / WEB-INF / lib / ttUser.class.php

diff --git a/WEB-INF/lib/ttUser.class.php b/WEB-INF/lib/ttUser.class.php
index 28eeebcfd6a04366be31fc25a28c9d8ef629405e..6db627884cd71996fdb41d660e8ebcfcf5e98048 100644 (file)
--- a/WEB-INF/lib/ttUser.class.php
+++ b/WEB-INF/lib/ttUser.class.php
@@ -55,7 +55,6 @@ class ttUser {
   var $date_format = null;      // Date format.
   var $time_format = null;      // Time format.
   var $week_start = 0;          // Week start day.
   var $date_format = null;      // Date format.
   var $time_format = null;      // Time format.
   var $week_start = 0;          // Week start day.

-  var $show_holidays = 0;       // Whether to show holidays in calendar.

   var $tracking_mode = 0;       // Tracking mode.
   var $project_required = 0;    // Whether project selection is required on time entires.
   var $task_required = 0;       // Whether task selection is required on time entires.
   var $tracking_mode = 0;       // Tracking mode.
   var $project_required = 0;    // Whether project selection is required on time entires.
   var $task_required = 0;       // Whether task selection is required on time entires.


@@ -68,9 +67,14 @@ class ttUser {
   var $password_complexity = null; // Password complexity example.
   var $currency = null;         // Currency.
   var $plugins = null;          // Comma-separated list of enabled plugins.
   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 $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 $custom_logo = 0;         // Whether to use a custom logo for group.
   var $lock_spec = null;        // Cron specification for record locking.

+  var $holidays = null;         // Holidays specification.

   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 $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.


@@ -90,7 +94,7 @@ class ttUser {
     $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,".
     $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".
+      " g.bcc_email, g.allow_ip, g.password_complexity, g.plugins, g.config, g.lock_spec, g.holidays, 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";
       " 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";


@@ -134,16 +138,18 @@ class ttUser {
       $this->currency = $val['currency'];
       $this->plugins = $val['plugins'];
       $this->lock_spec = $val['lock_spec'];
       $this->currency = $val['currency'];
       $this->plugins = $val['plugins'];
       $this->lock_spec = $val['lock_spec'];

+      $this->holidays = $val['holidays'];

       $this->workday_minutes = $val['workday_minutes'];
       $this->custom_logo = $val['custom_logo'];
 
       $this->workday_minutes = $val['workday_minutes'];
       $this->custom_logo = $val['custom_logo'];
 

+      // TODO: refactor this.

       $this->config = $val['config'];
       $this->config = $val['config'];

-      $config = new ttConfigHelper($this->config);
+      $this->configHelper = new ttConfigHelper($val['config']);
+

       // Set user config options.
       // 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');
+      $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'])) {
       
       // Set "on behalf" id and name (user).
       if (isset($_SESSION['behalf_id'])) {


@@ -167,6 +173,11 @@ class ttUser {
     return ($this->behalfUser ? $this->behalfUser->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);
   // getQuotaPercent returns quota percent for active user.
   function getQuotaPercent() {
     return ($this->behalfUser ? $this->behalfUser->quota_percent : $this->quota_percent);


@@ -192,6 +203,11 @@ class ttUser {
     return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
   }
 
     return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
   }
 

+  // getWeekStart returns week start day for active group.
+  function getWeekStart() {
+    return ($this->behalfGroup ? $this->behalfGroup->week_start : $this->week_start);
+  }
+

   // getTrackingMode returns tracking mode for active group.
   function getTrackingMode() {
     return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
   // getTrackingMode returns tracking mode for active group.
   function getTrackingMode() {
     return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);


@@ -217,6 +233,11 @@ class ttUser {
     return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
   }
 
     return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
   }
 

+  // getHolidays returns holidays specification for active group.
+  function getHolidays() {
+    return ($this->behalfGroup ? $this->behalfGroup->holidays : $this->holidays);
+  }
+

   // getWorkdayMinutes returns workday_minutes for active group.
   function getWorkdayMinutes() {
     return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
   // getWorkdayMinutes returns workday_minutes for active group.
   function getWorkdayMinutes() {
     return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);


@@ -224,7 +245,12 @@ class ttUser {
 
   // getConfig returns config string for active group.
   function getConfig() {
 
   // 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());
+  }
+
+  // getConfigHelper returns ttConfigHelper instance for active group.
+  function getConfigHelper() {
+    return ($this->behalfGroup ? $this->behalfGroup->configHelper : $this->configHelper);

   }
 
   // getConfigOption returns true if an option is defined for group.
   }
 
   // getConfigOption returns true if an option is defined for group.


@@ -258,8 +284,21 @@ class ttUser {
     return in_array($plugin, explode(',', $this->getPlugins()));
   }
 
     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.
   // getAssignedProjects - returns an array of assigned projects.

-  function getAssignedProjects()
+  function getAssignedProjects($includeFiles = false)

   {
     $result = array();
     $mdb2 = getConnection();
   {
     $result = array();
     $mdb2 = getConnection();


@@ -268,8 +307,15 @@ class ttUser {
     $group_id = $this->getGroup();
     $org_id = $this->org_id;
 
     $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.
     // 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);
       " 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);


@@ -412,7 +458,7 @@ class ttUser {
 
     $left_joins = null;
     if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
 
     $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']))
 
     $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
     if (isset($options['status']))


@@ -464,69 +510,36 @@ class ttUser {
     return $user_list;
   }
 
     return $user_list;
   }
 

-  // 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.
+  // getGroupsForDropdown obtains an array of groups to populate the "Group" dropdown.
+  // It consists of the entire tree starting from user home group.
+  // Group name is prefixed with additional characters to indicate subgroups level.

   function getGroupsForDropdown() {
   function getGroupsForDropdown() {

-    $mdb2 = getConnection();
+    global $user;

 
 

-    // Start with subgroups.
+    // Start with user home group.

     $groups = array();
     $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;
-      }
-    }
+    $subgroup_level = 0;
+    $group_id = $user->group_id;

 
 

-    // 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));
+    $this->addGroupToDropdown($groups, $group_id, $subgroup_level);
+    return $groups;
+  }

 
 

-    // 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')) return false;
+  // addGroupToDropdown is a recursive function to populate a tree of groups, used with getGroupsForDropdown().
+  function addGroupToDropdown(&$groups, $group_id, $subgroup_level) {
+    // Add indentation markup to indicate subdirectory level.
+    for ($i = 0; $i < $subgroup_level; $i++) {
+      $name .= '🛑'; // Unicode stop sign.
+    }
+    if ($subgroup_level) $name .= ' '; // Add an extra space.
+    $name .= ttGroupHelper::getGroupName($group_id);

 
 

-      $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;
-      }
+    $groups[] = array('id'=>$group_id, 'name'=>$name);
+
+    $subgroups = $this->getSubgroups($group_id);
+    foreach($subgroups as $subgroup) {
+      $this->addGroupToDropdown($groups, $subgroup['id'], $subgroup_level+1);

     }
     }

-    return $groups;

   }
 
   // getSubgroups obtains a list of immediate subgroups.
   }
 
   // getSubgroups obtains a list of immediate subgroups.


@@ -653,12 +666,13 @@ class ttUser {
     if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
     if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
     if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);
     if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']);
     if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']);
     if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']);

+    if (isset($fields['holidays'])) $holidays_part = ', holidays = '.$mdb2->quote($fields['holidays']);

     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.$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.
     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.$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, ',');
+      $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$holidays_part.$workday_minutes_part.$modified_part, ',');

 
     $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
     $affected = $mdb2->exec($sql);
 
     $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
     $affected = $mdb2->exec($sql);


@@ -694,14 +708,26 @@ class ttUser {
     if (is_a($affected, 'PEAR_Error'))
       return false;
 
     if (is_a($affected, 'PEAR_Error'))
       return false;
 

-    // Mark user as deleted.
+    // Mark user custom fields as deleted,
+    require_once('plugins/CustomFields.class.php');
+    $entity_type = CustomFields::ENTITY_USER;

     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);

+    $sql = "update tt_entity_custom_fields set status = null $modified_part".
+      " where entity_type = $entity_type and entity_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 $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'))
       return false;
 
     $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'))
       return false;
 

+
+

     return true;
   }
 
     return true;
   }