A bit more refactoring for subgroups.
[timetracker.git] / WEB-INF / lib / ttReportHelper.class.php
index 11f8841..26478c3 100644 (file)
@@ -40,6 +40,9 @@ class ttReportHelper {
   static function getWhere($options) {
     global $user;
 
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     // Prepare dropdown parts.
     $dropdown_parts = '';
     if ($options['client_id'])
@@ -61,17 +64,18 @@ class ttReportHelper {
     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
       $user_list_part = " and l.user_id in ($userlist)";
     else
-      $user_list_part = " and l.user_id = ".$user->id;
-    $user_list_part .= " and l.group_id = ".$user->getActiveGroup();
+      $user_list_part = " and l.user_id = ".$user->getUser();
+    $user_list_part .= " and l.group_id = $group_id and l.org_id = $org_id";
 
     // Prepare sql query part for where.
+    $dateFormat = $user->getDateFormat();
     if ($options['period'])
-      $period = new Period($options['period'], new DateAndTime($user->date_format));
+      $period = new Period($options['period'], new DateAndTime($dateFormat));
     else {
       $period = new Period();
       $period->setPeriod(
-        new DateAndTime($user->date_format, $options['period_start']),
-        new DateAndTime($user->date_format, $options['period_end']));
+        new DateAndTime($dateFormat, $options['period_start']),
+        new DateAndTime($dateFormat, $options['period_end']));
     }
     $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
       " $user_list_part $dropdown_parts";
@@ -100,7 +104,7 @@ class ttReportHelper {
       $user_list_part = " and ei.user_id in ($userlist)";
     else
       $user_list_part = " and ei.user_id = ".$user->id;
-    $user_list_part .= " and ei.group_id = ".$user->getActiveGroup();
+    $user_list_part .= " and ei.group_id = ".$user->getGroup();
 
     // Prepare sql query part for where.
     if ($options['period'])
@@ -128,14 +132,14 @@ class ttReportHelper {
     $isClient = $user->isClient();
 
     $grouping = ttReportHelper::grouping($options);
-    $grouping_by_date = ($options['group_by1'] == 'date'|| $options['group_by2'] == 'date' || $options['group_by3'] == 'date');
-    $grouping_by_client = ($options['group_by1'] == 'client'|| $options['group_by2'] == 'client' || $options['group_by3'] == 'client');
-    $grouping_by_project = ($options['group_by1'] == 'project'|| $options['group_by2'] == 'project' || $options['group_by3'] == 'project');
-    $grouping_by_task = ($options['group_by1'] == 'task'|| $options['group_by2'] == 'task' || $options['group_by3'] == 'task');
-    $grouping_by_user = ($options['group_by1'] == 'user'|| $options['group_by2'] == 'user' || $options['group_by3'] == 'user');
-    $grouping_by_cf_1 = ($options['group_by1'] == 'cf_1'|| $options['group_by2'] == 'cf_1' || $options['group_by3'] == 'cf_1');
-
-    $group_by_option = $options['group_by1'];
+    if ($grouping) {
+      $grouping_by_date = ttReportHelper::groupingBy('date', $options);
+      $grouping_by_client = ttReportHelper::groupingBy('client', $options);
+      $grouping_by_project = ttReportHelper::groupingBy('project', $options);
+      $grouping_by_task = ttReportHelper::groupingBy('task', $options);
+      $grouping_by_user = ttReportHelper::groupingBy('user', $options);
+      $grouping_by_cf_1 = ttReportHelper::groupingBy('cf_1', $options);
+    }
     $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($options['show_start'] || $options['show_end']);
 
     // Prepare a query for time items in tt_log table.
@@ -157,7 +161,7 @@ class ttReportHelper {
     // Add custom field.
     $include_cf_1 = $options['show_custom_field_1'] || $grouping_by_cf_1;
     if ($include_cf_1) {
-      $custom_fields = new CustomFields($user->group_id);
+      $custom_fields = new CustomFields();
       $cf_1_type = $custom_fields->fields[0]['type'];
       if ($cf_1_type == CustomFields::TYPE_TEXT) {
         array_push($fields, 'cfl.value as cf_1');
@@ -403,7 +407,7 @@ class ttReportHelper {
     $group_by_part = ttReportHelper::makeGroupByPart($options);
     if ($options['show_cost']) {
       if (MODE_TIME == $user->tracking_mode) {
-        if (!ttReportHelper::groupingByUser($options))
+        if (!ttReportHelper::groupingBy('user', $options))
           $left_join = 'left join tt_users u on (l.user_id = u.id)';
         $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time";
         if ($options['show_work_units']) {
@@ -564,35 +568,45 @@ class ttReportHelper {
   }
 
   // The assignToInvoice assigns a set of records to a specific invoice.
-  static function assignToInvoice($invoice_id, $time_log_ids, $expense_item_ids)
-  {
+  static function assignToInvoice($invoice_id, $time_log_ids, $expense_item_ids) {
+    global $user;
     $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     if ($time_log_ids) {
       $sql = "update tt_log set invoice_id = ".$mdb2->quote($invoice_id).
-        " where id in(".join(', ', $time_log_ids).")";
+        " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
     }
     if ($expense_item_ids) {
       $sql = "update tt_expense_items set invoice_id = ".$mdb2->quote($invoice_id).
-        " where id in(".join(', ', $expense_item_ids).")";
+        " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
     }
   }
 
   // The markPaid marks a set of records as either paid or unpaid.
-  static function markPaid($time_log_ids, $expense_item_ids, $paid = true)
-  {
+  static function markPaid($time_log_ids, $expense_item_ids, $paid = true) {
+    global $user;
     $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $paid_val = (int) $paid;
     if ($time_log_ids) {
-      $sql = "update tt_log set paid = $paid_val where id in(".join(', ', $time_log_ids).")";
+      $sql = "update tt_log set paid = $paid_val".
+        " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
     }
     if ($expense_item_ids) {
-      $sql = "update tt_expense_items set paid = $paid_val where id in(".join(', ', $expense_item_ids).")";
+      $sql = "update tt_expense_items set paid = $paid_val".
+        " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
     }
@@ -609,14 +623,14 @@ class ttReportHelper {
     $isClient = $user->isClient();
 
     $items = ttReportHelper::getItems($options);
-    $group_by = $options['group_by1'];
-    if ($group_by && 'no_grouping' != $group_by)
+    $grouping = ttReportHelper::grouping($options);
+    if ($grouping)
       $subtotals = ttReportHelper::getSubtotals($options);
     $totals = ttReportHelper::getTotals($options);
 
     // Use custom fields plugin if it is enabled.
     if ($user->isPluginEnabled('cf'))
-      $custom_fields = new CustomFields($user->group_id);
+      $custom_fields = new CustomFields();
 
     // Define some styles to use in email.
     $style_title = 'text-align: center; font-size: 15pt; font-family: Arial, Helvetica, sans-serif;';
@@ -643,14 +657,7 @@ class ttReportHelper {
 
     if ($options['show_totals_only']) {
       // Totals only report. Output subtotals.
-
-      // Determine group_by header.
-      if ('cf_1' == $group_by)
-        $group_by_header = htmlspecialchars($custom_fields->fields[0]['label']);
-      else {
-        $key = 'label.'.$group_by;
-        $group_by_header = $i18n->get($key);
-      }
+      $group_by_header = ttReportHelper::makeGroupByHeader($options);
 
       $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
       $body .= '<tr>';
@@ -743,7 +750,7 @@ class ttReportHelper {
       $body .= '</tr>';
 
       // Initialize variables to print subtotals.
-      if ($items && 'no_grouping' != $group_by) {
+      if ($items && $grouping) {
         $print_subtotals = true;
         $first_pass = true;
         $prev_grouped_by = '';
@@ -765,11 +772,11 @@ class ttReportHelper {
               $body .= '<tr style="'.$rowSubtotal.'">';
               $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
               $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']);
-              if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
-              if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
-              if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
-              if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
-              if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'cf_1' ? $subtotal_name : '').'</td>';
+              if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
+              if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
+              if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
+              if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
+              if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
               if ($options['show_start']) $body .= '<td></td>';
               if ($options['show_end']) $body .= '<td></td>';
               if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['time'].'</td>';
@@ -841,11 +848,11 @@ class ttReportHelper {
         $body .= '<tr style="'.$rowSubtotal.'">';
         $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
         $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']);
-        if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
-        if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
-        if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
-        if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
-        if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'cf_1' ? $subtotal_name : '').'</td>';
+        if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
+        if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
+        if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
+        if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
+        if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
         if ($options['show_start']) $body .= '<td></td>';
         if ($options['show_end']) $body .= '<td></td>';
         if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['time'].'</td>';
@@ -1017,7 +1024,7 @@ class ttReportHelper {
     // Check users.
     $users_in_bean = $bean->getAttribute('users');
     if (is_array($users_in_bean)) {
-      $users_in_group = ttTeamHelper::getUsers();
+      $users_in_group = ttGroupHelper::getUsers();
       foreach ($users_in_group as $user_in_group) {
         $valid_ids[] = $user_in_group['id'];
       }
@@ -1452,28 +1459,22 @@ class ttReportHelper {
 
   // makeJoinPart builds a left join part for getSubtotals query (for time items).
   static function makeJoinPart($options) {
-    global $custom_fields; // TODO: is it safe to assume the object is there when needed?
+    global $user;
 
-    $group_by_fields = ttReportHelper::makeGroupByFieldsPart($options); // TODO: refactor this, perhaps?
-    if (strpos($group_by_fields, 'user') !== false) {
-      // Grouping by user, add a join on tt_users table.
+    if (ttReportHelper::groupingBy('user', $options)) {
       $join .= ' left join tt_users u on (l.user_id = u.id)';
     }
-    if (strpos($group_by_fields, 'client') !== false) {
-      // Grouping by client, add a join on tt_clients table.
+    if (ttReportHelper::groupingBy('client', $options)) {
       $join .= ' left join tt_clients c on (l.client_id = c.id)';
     }
-    if (strpos($group_by_fields, 'project') !== false) {
-      // Grouping by project, add a join on tt_projects table.
+    if (ttReportHelper::groupingBy('project', $options)) {
       $join .= ' left join tt_projects p on (l.project_id = p.id)';
     }
-    if (strpos($group_by_fields, 'task') !== false) {
-      // Grouping by task, add a join on tt_tasks table.
+    if (ttReportHelper::groupingBy('task', $options)) {
       $join .= ' left join tt_tasks t on (l.task_id = t.id)';
     }
-    if (strpos($group_by_fields, 'cf_1') !== false) {
-      // Grouping by custom field 1, add a join for it.
-      // $custom_fields = new CustomFields($user->group_id);
+    if (ttReportHelper::groupingBy('cf_1', $options)) {
+      $custom_fields = new CustomFields();
       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
         $join .= ' left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.value = cfo.id)';
       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
@@ -1484,45 +1485,17 @@ class ttReportHelper {
 
   // makeJoinExpensesPart builds a left join part for getSubtotals query for expense items.
   static function makeJoinExpensesPart($options) {
-    $group_by_fields = ttReportHelper::makeGroupByFieldsPart($options); // TODO: refactor this, perhaps?
-    if (strpos($group_by_fields, 'user') !== false) {
-      // Grouping by user, add a join on tt_users table.
+    if (ttReportHelper::groupingBy('user', $options)) {
       $join .= ' left join tt_users u on (ei.user_id = u.id)';
     }
-    if (strpos($group_by_fields, 'client') !== false) {
-      // Grouping by client, add a join on tt_clients table.
+    if (ttReportHelper::groupingBy('client', $options)) {
       $join .= ' left join tt_clients c on (ei.client_id = c.id)';
     }
-    if (strpos($group_by_fields, 'project') !== false) {
-      // Grouping by project, add a join on tt_projects table.
+    if (ttReportHelper::groupingBy('project', $options)) {
       $join .= ' left join tt_projects p on (ei.project_id = p.id)';
     }
     return $join;
   }
-  
-  // makeGroupByFieldsPart builds a commma-separated list of fields for sql query using group_by1,
-  // group_by2, and group_by3 values passed in $options.
-  static function makeGroupByFieldsPart($options) {
-    $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') &&
-      ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') &&
-      ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping');
-    if ($no_grouping) return null;
-
-    if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
-      // We have group_by1.
-      $group_by_fields .= ', '.$options['group_by1'];
-    }
-    if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
-      // We have group_by2.
-      $group_by_fields .= ', '.$options['group_by2'];
-    }
-    if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
-      // We have group_by3.
-      $group_by_fields .= ', '.$options['group_by3'];
-    }
-    $group_by_fields = ltrim($group_by_fields, ', ');
-    return $group_by_fields;
-  }
 
   // grouping determines if we are grouping the report by either group_by1,
   // group_by2, or group_by3 values passed in $options.
@@ -1533,20 +1506,11 @@ class ttReportHelper {
     return $grouping;
   }
 
-  // groupingByUser determines if we are grouping a report by user.
-  static function groupingByUser($options) {
-    if ($options['group_by1'] == 'user' || $options['group_by2'] == 'user' || $options['group_by3'] == 'user') return true;
-
-    return false;
-  }
-  
   // groupingBy determines if we are grouping a report by a value of $what
-  // ('user', 'project', etc.) by checking group_by1, group_by2, and group_by3
-  // values passed in $options.
+  // ('date', 'user', 'project', etc.) by checking group_by1, group_by2,
+  // and group_by3 values passed in $options.
   static function groupingBy($what, $options) {
-    $grouping = ($options['group_by1'] != null && $options['group_by1'] != $what) ||
-      ($options['group_by2'] != null && $options['group_by2'] != $what) ||
-      ($options['group_by3'] != null && $options['group_by3'] != $what);
+    $grouping = ($options['group_by1'] == $what) || ($options['group_by2'] == $what) || ($options['group_by3'] == $what);
     return $grouping;
   }