A bit more work in progress on multiple levels of grouping by in reports.
[timetracker.git] / WEB-INF / lib / ttFavReportHelper.class.php
index 111e9b1..305a4fc 100644 (file)
@@ -81,10 +81,10 @@ class ttFavReportHelper {
 
     $sql = "insert into tt_fav_reports (name, user_id, client_id, cf_1_option_id, project_id, task_id,
       billable, invoice, paid_status, users, period, period_start, period_end,
-      show_client, show_invoice, show_paid,
+      show_client, show_invoice, show_paid, show_ip,
       show_project, show_start, show_duration, show_cost,
-      show_task, show_end, show_note, show_custom_field_1,
-      group_by, show_totals_only)
+      show_task, show_end, show_note, show_custom_field_1, show_work_units,
+      group_by1, group_by2, group_by3, show_totals_only)
       values(".
       $mdb2->quote($fields['name']).", ".$fields['user_id'].", ".
       $mdb2->quote($fields['client']).", ".$mdb2->quote($fields['option']).", ".
@@ -93,10 +93,11 @@ class ttFavReportHelper {
       $mdb2->quote($fields['paid_status']).", ".
       $mdb2->quote($fields['users']).", ".$mdb2->quote($fields['period']).", ".
       $mdb2->quote($fields['from']).", ".$mdb2->quote($fields['to']).", ".
-      $fields['chclient'].", ".$fields['chinvoice'].", ".$fields['chpaid'].", ".
+      $fields['chclient'].", ".$fields['chinvoice'].", ".$fields['chpaid'].", ".$fields['chip'].", ".
       $fields['chproject'].", ".$fields['chstart'].", ".$fields['chduration'].", ".$fields['chcost'].", ".
-      $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chcf_1'].", ".
-      $mdb2->quote($fields['group_by']).", ".$fields['chtotalsonly'].")";
+      $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
+      $mdb2->quote($fields['group_by1']).", ".$mdb2->quote($fields['group_by2']).", ".
+      $mdb2->quote($fields['group_by3']).", ".$fields['chtotalsonly'].")";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
@@ -129,6 +130,7 @@ class ttFavReportHelper {
       "show_client = ".$fields['chclient'].", ".
       "show_invoice = ".$fields['chinvoice'].", ".
       "show_paid = ".$fields['chpaid'].", ".
+      "show_ip = ".$fields['chip'].", ".
       "show_project = ".$fields['chproject'].", ".
       "show_start = ".$fields['chstart'].", ".
       "show_duration = ".$fields['chduration'].", ".
@@ -137,7 +139,10 @@ class ttFavReportHelper {
       "show_end = ".$fields['chfinish'].", ".
       "show_note = ".$fields['chnote'].", ".
       "show_custom_field_1 = ".$fields['chcf_1'].", ".
-      "group_by = ".$mdb2->quote($fields['group_by']).", ".
+      "show_work_units = ".$fields['chunits'].", ".
+      "group_by1 = ".$mdb2->quote($fields['group_by1']).", ".
+      "group_by2 = ".$mdb2->quote($fields['group_by2']).", ".
+      "group_by3 = ".$mdb2->quote($fields['group_by3']).", ".
       "show_totals_only = ".$fields['chtotalsonly'].
       " where id = ".$fields['id'];
     $affected = $mdb2->exec($sql);
@@ -156,6 +161,7 @@ class ttFavReportHelper {
     if (!$bean->getAttribute('chclient')) $bean->setAttribute('chclient', 0);
     if (!$bean->getAttribute('chinvoice')) $bean->setAttribute('chinvoice', 0);
     if (!$bean->getAttribute('chpaid')) $bean->setAttribute('chpaid', 0);
+    if (!$bean->getAttribute('chip')) $bean->setAttribute('chip', 0);
     if (!$bean->getAttribute('chproject')) $bean->setAttribute('chproject', 0);
     if (!$bean->getAttribute('chstart')) $bean->setAttribute('chstart', 0);
     if (!$bean->getAttribute('chduration')) $bean->setAttribute('chduration', 0);
@@ -164,26 +170,12 @@ class ttFavReportHelper {
     if (!$bean->getAttribute('chfinish')) $bean->setAttribute('chfinish', 0);
     if (!$bean->getAttribute('chnote')) $bean->setAttribute('chnote', 0);
     if (!$bean->getAttribute('chcf_1')) $bean->setAttribute('chcf_1', 0);
+    if (!$bean->getAttribute('chunits')) $bean->setAttribute('chunits', 0);
     if (!$bean->getAttribute('chtotalsonly')) $bean->setAttribute('chtotalsonly', 0);
 
-    if ($bean->getAttribute('users') && is_array($bean->getAttribute('users'))) {
-      $users_in_bean = $bean->getAttribute('users');
-
-      // If all users are selected - use a null value (which means "all users").
-      $all_users_selected = true;
-      if ($user->can('view_reports')) {
-        $all = ttTeamHelper::getActiveUsers();
-        foreach ($all as $one) {
-          if (!in_array($one['id'], $users_in_bean)) {
-            $all_users_selected = false;
-            break;
-          }
-        }
-      }
-      if ($all_users_selected)
-        $users = null;
-      else
-        $users = join(',', $users_in_bean);
+    $users_in_bean = $bean->getAttribute('users');
+    if ($users_in_bean && is_array($users_in_bean)) {
+      $users = join(',', $users_in_bean);
     }
     if ($bean->getAttribute('start_date')) {
       $dt = new DateAndTime($user->date_format, $bean->getAttribute('start_date'));
@@ -210,6 +202,7 @@ class ttFavReportHelper {
       'chclient'=>$bean->getAttribute('chclient'),
       'chinvoice'=>$bean->getAttribute('chinvoice'),
       'chpaid'=>$bean->getAttribute('chpaid'),
+      'chip'=>$bean->getAttribute('chip'),
       'chproject'=>$bean->getAttribute('chproject'),
       'chstart'=>$bean->getAttribute('chstart'),
       'chduration'=>$bean->getAttribute('chduration'),
@@ -218,7 +211,10 @@ class ttFavReportHelper {
       'chfinish'=>$bean->getAttribute('chfinish'),
       'chnote'=>$bean->getAttribute('chnote'),
       'chcf_1'=>$bean->getAttribute('chcf_1'),
-      'group_by'=>$bean->getAttribute('group_by'),
+      'chunits'=>$bean->getAttribute('chunits'),
+      'group_by1'=>$bean->getAttribute('group_by1'),
+      'group_by2'=>$bean->getAttribute('group_by2'),
+      'group_by3'=>$bean->getAttribute('group_by3'),
       'chtotalsonly'=>$bean->getAttribute('chtotalsonly'));
 
     $id = false;
@@ -256,18 +252,7 @@ class ttFavReportHelper {
       $bean->setAttribute('include_records', $val['billable']);
       $bean->setAttribute('invoice', $val['invoice']);
       $bean->setAttribute('paid_status', $val['paid_status']);
-      if ($val['users'])
-        $bean->setAttribute('users', explode(',', $val['users']));
-      else {
-        // Null users value means "all users". Add them to the bean.
-        if ($user->can('view_reports')) {
-          $all = ttTeamHelper::getActiveUsers();
-          foreach ($all as $one) {
-            $all_user_ids[] = $one['id'];
-          }
-          $bean->setAttribute('users', $all_user_ids);
-        }
-      }
+      $bean->setAttribute('users', explode(',', $val['users']));
       $bean->setAttribute('period', $val['period']);
       if ($val['period_start']) {
         $dt = new DateAndTime(DB_DATEFORMAT, $val['period_start']);
@@ -280,6 +265,7 @@ class ttFavReportHelper {
       $bean->setAttribute('chclient', $val['show_client']);
       $bean->setAttribute('chinvoice', $val['show_invoice']);
       $bean->setAttribute('chpaid', $val['show_paid']);
+      $bean->setAttribute('chip', $val['show_ip']);
       $bean->setAttribute('chproject', $val['show_project']);
       $bean->setAttribute('chstart', $val['show_start']);
       $bean->setAttribute('chduration', $val['show_duration']);
@@ -288,7 +274,10 @@ class ttFavReportHelper {
       $bean->setAttribute('chfinish', $val['show_end']);
       $bean->setAttribute('chnote', $val['show_note']);
       $bean->setAttribute('chcf_1', $val['show_custom_field_1']);
-      $bean->setAttribute('group_by', $val['group_by']);
+      $bean->setAttribute('chunits', $val['show_work_units']);
+      $bean->setAttribute('group_by1', $val['group_by1']);
+      $bean->setAttribute('group_by2', $val['group_by2']);
+      $bean->setAttribute('group_by3', $val['group_by3']);
       $bean->setAttribute('chtotalsonly', $val['show_totals_only']);
       $bean->setAttribute('new_fav_report', $val['name']);
     } else {
@@ -312,10 +301,83 @@ class ttFavReportHelper {
         'chfinish'=>'1',
         'chnote'=>'1',
         'chcf_1'=>'',
-        'group_by'=>'',
+        'chunits'=>'',
+        'group_by1'=>'',
+        'group_by2'=>'',
+        'group_by3'=>'',
         'chtotalsonly'=>'',
         'new_fav_report'=>''));
       $bean->setAttributes($attrs);
     }
   }
+
+  // getReportOptions - returns an array of fav report options from database data.
+  // Note: this function is a part of refactoring to simplify maintenance of report
+  // generating functions, as we currently have 2 sets: normal reporting (from bean),
+  // and fav report emailing (from db fields). Using options obtained from either db or bean
+  // shall allow us to use only one set of functions.
+  static function getReportOptions($id) {
+
+    // Start with getting the fields from the database.
+    $db_fields = ttFavReportHelper::getReport($id);
+    if (!$db_fields) return false;
+
+    // Prepare an array of report options.
+    $options = $db_fields; // For now, use db field names as options.
+    // Drop things we don't need in reports.
+    unset($options['id']);
+    unset($options['report_spec']); // Currently not used.
+    unset($options['status']);
+
+    // Note: special handling for NULL users field is done in cron.php
+
+    // $options now is a subset of db fields from tt_fav_reports table.
+    return $options;
+  }
+
+  // adjustOptions takes and array or report options and adjusts them for current user
+  // (and group) settings. This is needed in situations when a fav report is stored in db
+  // long ago, but user or group attributes are now changed, so we have to adjust.
+  static function adjustOptions($options) {
+    global $user;
+
+    // Check and optionally adjust users.
+    // Special handling of the NULL $options['users'] field (this used to mean "all users").
+    if (!$options['users']) {
+      if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) {
+        if ($user->can('view_reports') || $user->can('view_all_reports')) {
+          $max_rank = $user->rank-1;
+          if ($user->can('view_all_reports')) $max_rank = 512;
+          if ($user->can('view_own_reports'))
+            $user_options = array('max_rank'=>$max_rank,'include_self'=>true);
+          else
+            $user_options = array('max_rank'=>$max_rank);
+          $users = $user->getUsers($user_options); // Active and inactive users.
+        } elseif ($user->isClient()) {
+          $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
+        }
+        foreach ($users as $single_user) {
+          $user_ids[] = $single_user['id'];
+        }
+        $options['users'] = implode(',', $user_ids);
+      }
+    } else {
+      $users_to_adjust = explode(',', $options['users']); // Users to adjust.
+      if ($user->isClient()) {
+        $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
+        foreach ($users as $single_user) {
+          $user_ids[] = $single_user['id'];
+        }
+        foreach ($users_to_adjust as $user_to_adjust) {
+          if (in_array($user_to_adjust['id'], $user_ids)) {
+            $adjusted_user_ids[] = $user_to_adjust['id'];
+          }
+        }
+        $options['users'] = implode(',', $adjusted_user_ids);
+      }
+      // TODO: add checking the existing user list for potentially changed access rights for user.
+    }
+
+    return $options;
+  }
 }