A bit more progress on getting rid of canManageTeam.

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

diff --git a/WEB-INF/lib/ttReportHelper.class.php b/WEB-INF/lib/ttReportHelper.class.php
index 2e2113d..223d8e4 100644 (file)
--- a/WEB-INF/lib/ttReportHelper.class.php
+++ b/WEB-INF/lib/ttReportHelper.class.php
@@ -58,11 +58,11 @@ class ttReportHelper {
 
     // Prepare user list part.
     $userlist = -1;
-    if (($user->canManageTeam() || $user->isClient()) && is_array($bean->getAttribute('users')))
+    if (($user->can('view_reports') || $user->isClient()) && is_array($bean->getAttribute('users')))
       $userlist = join(',', $bean->getAttribute('users'));
     // Prepare sql query part for user list.
     $user_list_part = null;
-    if ($user->canManageTeam() || $user->isClient())
+    if ($user->can('view_reports') || $user->isClient())
       $user_list_part = " and l.user_id in ($userlist)";
     else
       $user_list_part = " and l.user_id = ".$user->id;
@@ -103,7 +103,7 @@ class ttReportHelper {
 
     // Prepare user list part.
     $userlist = -1;
-    if (($user->canManageTeam() || $user->isClient())) {
+    if (($user->can('view_reports') || $user->isClient())) {
       if ($report['users'])
         $userlist = $report['users'];
       else {
@@ -115,7 +115,7 @@ class ttReportHelper {
     }
     // Prepare sql query part for user list.
     $user_list_part = null;
-    if ($user->canManageTeam() || $user->isClient())
+    if ($user->can('view_reports') || $user->isClient())
       $user_list_part = " and l.user_id in ($userlist)";
     else
       $user_list_part = " and l.user_id = ".$user->id;
@@ -147,14 +147,16 @@ class ttReportHelper {
     if ($bean->getAttribute('project')) $dropdown_parts .= ' and ei.project_id = '.$bean->getAttribute('project');
     if ($bean->getAttribute('invoice')=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL';
     if ($bean->getAttribute('invoice')=='2') $dropdown_parts .= ' and ei.invoice_id is NULL';
+    if ($bean->getAttribute('paid_status')=='1') $dropdown_parts .= ' and ei.paid = 1';
+    if ($bean->getAttribute('paid_status')=='2') $dropdown_parts .= ' and ei.paid = 0';
 
     // Prepare user list part.
     $userlist = -1;
-    if (($user->canManageTeam() || $user->isClient()) && is_array($bean->getAttribute('users')))
+    if (($user->can('view_reports') || $user->isClient()) && is_array($bean->getAttribute('users')))
       $userlist = join(',', $bean->getAttribute('users'));
     // Prepare sql query part for user list.
     $user_list_part = null;
-    if ($user->canManageTeam() || $user->isClient())
+    if ($user->can('view_reports') || $user->isClient())
       $user_list_part = " and ei.user_id in ($userlist)";
     else
       $user_list_part = " and ei.user_id = ".$user->id;
@@ -186,10 +188,12 @@ class ttReportHelper {
     if ($report['project_id']) $dropdown_parts .= ' and ei.project_id = '.$report['project_id'];
     if ($report['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL';
     if ($report['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is NULL';
+    if ($report['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1';
+    if ($report['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0';
 
     // Prepare user list part.
     $userlist = -1;
-    if (($user->canManageTeam() || $user->isClient())) {
+    if (($user->can('view_reports') || $user->isClient())) {
       if ($report['users'])
         $userlist = $report['users'];
       else {
@@ -201,7 +205,7 @@ class ttReportHelper {
     }
     // Prepare sql query part for user list.
     $user_list_part = null;
-    if ($user->canManageTeam() || $user->isClient())
+    if ($user->can('view_reports') || $user->isClient())
       $user_list_part = " and ei.user_id in ($userlist)";
     else
       $user_list_part = " and ei.user_id = ".$user->id;
@@ -227,6 +231,10 @@ class ttReportHelper {
     global $user;
     $mdb2 = getConnection();
 
+    // Determine these once as they are used in multiple places in this function.
+    $canViewReports = $user->can('view_reports');
+    $isClient = $user->isClient();
+
     $group_by_option = $bean->getAttribute('group_by');
     $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($bean->getAttribute('chstart') || $bean->getAttribute('chfinish'));
 
@@ -235,7 +243,7 @@ class ttReportHelper {
     array_push($fields, 'l.id as id');
     array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
     array_push($fields, 'l.date as date');
-    if($user->canManageTeam() || $user->isClient())
+    if($canViewReports || $isClient)
       array_push($fields, 'u.name as user');
     // Add client name if it is selected.
     if ($bean->getAttribute('chclient') || 'client' == $group_by_option)
@@ -281,20 +289,20 @@ class ttReportHelper {
       array_push($fields, "null as expense"); 
     }
     // Add paid status.
-    if ($user->canManageTeam() && $bean->getAttribute('chpaid'))
+    if ($canViewReports && $bean->getAttribute('chpaid'))
       array_push($fields, 'l.paid as paid');
 
     // Add invoice name if it is selected.
-    if (($user->canManageTeam() || $user->isClient()) && $bean->getAttribute('chinvoice'))
+    if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
       array_push($fields, 'i.name as invoice');
 
     // Prepare sql query part for left joins.
     $left_joins = null;
     if ($bean->getAttribute('chclient') || 'client' == $group_by_option)
       $left_joins .= " left join tt_clients c on (c.id = l.client_id)";
-    if (($user->canManageTeam() || $user->isClient()) && $bean->getAttribute('chinvoice'))
+    if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
       $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)";
-    if ($user->canManageTeam() || $user->isClient() || $user->isPluginEnabled('ex'))
+    if ($canViewReports || $isClient || $user->isPluginEnabled('ex'))
        $left_joins .= " left join tt_users u on (u.id = l.user_id)";
     if ($bean->getAttribute('chproject') || 'project' == $group_by_option)
       $left_joins .= " left join tt_projects p on (p.id = l.project_id)";
@@ -325,7 +333,7 @@ class ttReportHelper {
       array_push($fields, 'ei.id');
       array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
       array_push($fields, 'ei.date');
-      if($user->canManageTeam() || $user->isClient())
+      if($canViewReports || $isClient)
         array_push($fields, 'u.name as user');
       // Add client name if it is selected.
       if ($bean->getAttribute('chclient') || 'client' == $group_by_option)
@@ -350,19 +358,22 @@ class ttReportHelper {
         array_push($fields, 'ei.name as note');
       array_push($fields, 'ei.cost as cost');
       array_push($fields, 'ei.cost as expense');
+      // Add paid status.
+      if ($canViewReports && $bean->getAttribute('chpaid'))
+        array_push($fields, 'ei.paid as paid');
       // Add invoice name if it is selected.
-      if (($user->canManageTeam() || $user->isClient()) && $bean->getAttribute('chinvoice'))
+      if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
         array_push($fields, 'i.name as invoice');
 
       // Prepare sql query part for left joins.
       $left_joins = null;
-      if ($user->canManageTeam() || $user->isClient())
+      if ($canViewReports || $isClient)
         $left_joins .= " left join tt_users u on (u.id = ei.user_id)";
       if ($bean->getAttribute('chclient') || 'client' == $group_by_option)
         $left_joins .= " left join tt_clients c on (c.id = ei.client_id)";
       if ($bean->getAttribute('chproject') || 'project' == $group_by_option)
         $left_joins .= " left join tt_projects p on (p.id = ei.project_id)";
-      if (($user->canManageTeam() || $user->isClient()) && $bean->getAttribute('chinvoice'))
+      if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
         $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
 
       $where = ttReportHelper::getExpenseWhere($bean);
@@ -380,7 +391,7 @@ class ttReportHelper {
       $sort_part .= 'date';
     else
       $sort_part .= $group_by_option.', date';
-    if (($user->canManageTeam() || $user->isClient()) && is_array($bean->getAttribute('users')) && 'user' != $group_by_option)
+    if (($canViewReports || $isClient) && is_array($bean->getAttribute('users')) && 'user' != $group_by_option)
       $sort_part .= ', user, type';
     if ($bean->getAttribute('chstart'))
       $sort_part .= ', unformatted_start';
@@ -430,6 +441,39 @@ class ttReportHelper {
     return $report_items;
   }
 
+  // putInSession stores tt_log and tt_expense_items ids from a report in user session
+  // as 2 comma-separated lists.
+  static function putInSession($report_items) {
+    unset($_SESSION['report_item_ids']);
+    unset($_SESSION['report_item_expense_ids']);
+
+    // Iterate through records and build 2 comma-separated lists.
+    foreach($report_items as $item) {
+      if ($item['type'] == 1)
+        $report_item_ids .= ','.$item['id'];
+      else if ($item['type'] == 2)
+         $report_item_expense_ids .= ','.$item['id'];
+    }
+    $report_item_ids = trim($report_item_ids, ',');
+    $report_item_expense_ids = trim($report_item_expense_ids, ',');
+
+    // The lists are reqdy. Put them in session.
+    if ($report_item_ids) $_SESSION['report_item_ids'] = $report_item_ids;
+    if ($report_item_expense_ids) $_SESSION['report_item_expense_ids'] = $report_item_expense_ids;
+  }
+
+  // getFromSession obtains tt_log and tt_expense_items ids stored in user session.
+  static function getFromSession() {
+    $items = array();
+    $report_item_ids = $_SESSION['report_item_ids'];
+    if ($report_item_ids)
+      $items['report_item_ids'] = explode(',', $report_item_ids);
+    $report_item_expense_ids = $_SESSION['report_item_expense_ids'];
+    if ($report_item_expense_ids)
+      $items['report_item_expense_ids'] = explode(',', $report_item_expense_ids);
+    return $items;
+  }
+
   // getFavItems retrieves all items associated with a favorite report.
   // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
   // Expense items use the "note" field for item name.
@@ -437,6 +481,10 @@ class ttReportHelper {
     global $user;
     $mdb2 = getConnection();
 
+    // Determine these once as they are used in multiple places in this function.
+    $canViewReports = $user->can('view_reports');
+    $isClient = $user->isClient();
+
     $group_by_option = $report['group_by'];
     $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($report['show_start'] || $report['show_end']);
 
@@ -445,7 +493,7 @@ class ttReportHelper {
     array_push($fields, 'l.id as id');
     array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
     array_push($fields, 'l.date as date');
-    if($user->canManageTeam() || $user->isClient())
+    if($canViewReports || $isClient)
       array_push($fields, 'u.name as user');
     // Add client name if it is selected.
     if ($report['show_client'] || 'client' == $group_by_option)
@@ -491,16 +539,16 @@ class ttReportHelper {
       array_push($fields, "null as expense"); 
     }
     // Add invoice name if it is selected.
-    if (($user->canManageTeam() || $user->isClient()) && $report['show_invoice'])
+    if (($canViewReports || $isClient) && $report['show_invoice'])
       array_push($fields, 'i.name as invoice');
 
     // Prepare sql query part for left joins.
     $left_joins = null;
     if ($report['show_client'] || 'client' == $group_by_option)
       $left_joins .= " left join tt_clients c on (c.id = l.client_id)";
-    if (($user->canManageTeam() || $user->isClient()) && $report['show_invoice'])
+    if (($canViewReports || $isClient) && $report['show_invoice'])
       $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)";
-    if ($user->canManageTeam() || $user->isClient() || $user->isPluginEnabled('ex'))
+    if ($canViewReports || $isClient || $user->isPluginEnabled('ex'))
        $left_joins .= " left join tt_users u on (u.id = l.user_id)";
     if ($report['show_project'] || 'project' == $group_by_option)
       $left_joins .= " left join tt_projects p on (p.id = l.project_id)";
@@ -531,7 +579,7 @@ class ttReportHelper {
       array_push($fields, 'ei.id');
       array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
       array_push($fields, 'ei.date');
-      if($user->canManageTeam() || $user->isClient())
+      if($canViewReports || $isClient)
         array_push($fields, 'u.name as user');
       // Add client name if it is selected.
       if ($report['show_client'] || 'client' == $group_by_option)
@@ -557,18 +605,18 @@ class ttReportHelper {
       array_push($fields, 'ei.cost as cost');
       array_push($fields, 'ei.cost as expense');
       // Add invoice name if it is selected.
-      if (($user->canManageTeam() || $user->isClient()) && $report['show_invoice'])
+      if (($canViewReports || $isClient) && $report['show_invoice'])
         array_push($fields, 'i.name as invoice');
 
       // Prepare sql query part for left joins.
       $left_joins = null;
-      if ($user->canManageTeam() || $user->isClient())
+      if ($canViewReports || $isClient)
         $left_joins .= " left join tt_users u on (u.id = ei.user_id)";
       if ($report['show_client'] || 'client' == $group_by_option)
         $left_joins .= " left join tt_clients c on (c.id = ei.client_id)";
       if ($report['show_project'] || 'project' == $group_by_option)
         $left_joins .= " left join tt_projects p on (p.id = ei.project_id)";
-      if (($user->canManageTeam() || $user->isClient()) && $report['show_invoice'])
+      if (($canViewReports || $isClient) && $report['show_invoice'])
         $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
 
       $where = ttReportHelper::getFavExpenseWhere($report);
@@ -586,7 +634,7 @@ class ttReportHelper {
       $sort_part .= 'date';
     else
       $sort_part .= $group_by_option.', date';
-    if (($user->canManageTeam() || $user->isClient()) /*&& is_array($bean->getAttribute('users'))*/ && 'user' != $group_by_option)
+    if (($canViewReports || $isClient) /*&& is_array($bean->getAttribute('users'))*/ && 'user' != $group_by_option)
       $sort_part .= ', user, type';
     if ($report['show_start'])
       $sort_part .= ', unformatted_start';
@@ -1050,12 +1098,33 @@ class ttReportHelper {
     }
   }
 
+  // The markPaid marks a set of records as either paid or unpaid.
+  static function markPaid($time_log_ids, $expense_item_ids, $paid = true)
+  {
+    $mdb2 = getConnection();
+    $paid_val = (int) $paid;
+    if ($time_log_ids) {
+      $sql = "update tt_log set paid = $paid_val where id in(".join(', ', $time_log_ids).")";
+      $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).")";
+      $affected = $mdb2->exec($sql);
+      if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
+    }
+  }
+
   // prepareReportBody - prepares an email body for report.
   static function prepareReportBody($bean, $comment)
   {
     global $user;
     global $i18n;
 
+    // Determine these once as they are used in multiple places in this function.
+    $canViewReports = $user->can('view_reports');
+    $isClient = $user->isClient();
+
     $items = ttReportHelper::getItems($bean);
     $group_by = $bean->getAttribute('group_by');
     if ($group_by && 'no_grouping' != $group_by)
@@ -1118,7 +1187,7 @@ class ttReportHelper {
         }
         if ($bean->getAttribute('chcost')) {
           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
-          $body .= ($user->canManageTeam() || $user->isClient()) ? $subtotal['cost'] : $subtotal['expenses'];
+          $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses'];
           $body .= '</td>';
         }
         $body .= '</tr>';
@@ -1135,7 +1204,7 @@ class ttReportHelper {
       }
       if ($bean->getAttribute('chcost')) {
         $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
-        $body .= ($user->canManageTeam() || $user->isClient()) ? $totals['cost'] : $totals['expenses'];
+        $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
         $body .= '</td>';
       }
       $body .= '</tr>';
@@ -1148,7 +1217,7 @@ class ttReportHelper {
       $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
       $body .= '<tr>';
       $body .= '<td style="'.$tableHeader.'">'.$i18n->getKey('label.date').'</td>';
-      if ($user->canManageTeam() || $user->isClient())
+      if ($canViewReports || $isClient)
         $body .= '<td style="'.$tableHeader.'">'.$i18n->getKey('label.user').'</td>';
       if ($bean->getAttribute('chclient'))
         $body .= '<td style="'.$tableHeader.'">'.$i18n->getKey('label.client').'</td>';
@@ -1197,7 +1266,7 @@ class ttReportHelper {
               $body .= '<tr style="'.$rowSubtotal.'">';
               $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->getKey('label.subtotal').'</td>';
               $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']);
-              if ($user->canManageTeam() || $user->isClient()) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
+              if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
               if ($bean->getAttribute('chclient')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
               if ($bean->getAttribute('chproject')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
               if ($bean->getAttribute('chtask')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
@@ -1208,7 +1277,7 @@ class ttReportHelper {
               if ($bean->getAttribute('chnote')) $body .= '<td></td>';
               if ($bean->getAttribute('chcost')) {
                 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
-                $body .= ($user->canManageTeam() || $user->isClient()) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses'];
+                $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses'];
                 $body .= '</td>';
               }
               if ($bean->getAttribute('chpaid')) $body .= '<td></td>';
@@ -1224,7 +1293,7 @@ class ttReportHelper {
             $row_style = ($row_style == $rowItem) ? $rowItemAlt : $rowItem;
           $body .= '<tr style="'.$row_style.'">';
           $body .= '<td style="'.$cellLeftAligned.'">'.$record['date'].'</td>';
-          if ($user->canManageTeam() || $user->isClient())
+          if ($canViewReports || $isClient)
             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['user']).'</td>';
           if ($bean->getAttribute('chclient'))
             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['client']).'</td>';
@@ -1264,7 +1333,7 @@ class ttReportHelper {
         $body .= '<tr style="'.$rowSubtotal.'">';
         $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->getKey('label.subtotal').'</td>';
         $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']);
-        if ($user->canManageTeam() || $user->isClient()) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
+        if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
         if ($bean->getAttribute('chclient')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
         if ($bean->getAttribute('chproject')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
         if ($bean->getAttribute('chtask')) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
@@ -1275,7 +1344,7 @@ class ttReportHelper {
         if ($bean->getAttribute('chnote')) $body .= '<td></td>';
         if ($bean->getAttribute('chcost')) {
           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
-          $body .= ($user->canManageTeam() || $user->isClient()) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses'];
+          $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses'];
           $body .= '</td>';
         }
         if ($bean->getAttribute('chpaid')) $body .= '<td></td>';
@@ -1287,7 +1356,7 @@ class ttReportHelper {
       $body .= '<tr><td>&nbsp;</td></tr>';
       $body .= '<tr style="'.$rowSubtotal.'">';
       $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->getKey('label.total').'</td>';
-      if ($user->canManageTeam() || $user->isClient()) $body .= '<td></td>';
+      if ($canViewReports || $isClient) $body .= '<td></td>';
       if ($bean->getAttribute('chclient')) $body .= '<td></td>';
       if ($bean->getAttribute('chproject')) $body .= '<td></td>';
       if ($bean->getAttribute('chtask')) $body .= '<td></td>';
@@ -1298,7 +1367,7 @@ class ttReportHelper {
       if ($bean->getAttribute('chnote')) $body .= '<td></td>';
       if ($bean->getAttribute('chcost')) {
         $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
-        $body .= ($user->canManageTeam() || $user->isClient()) ? $totals['cost'] : $totals['expenses'];
+        $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
         $body .= '</td>';
       }
       if ($bean->getAttribute('chpaid')) $body .= '<td></td>';
@@ -1324,7 +1393,7 @@ class ttReportHelper {
     $items = ttReportHelper::getFavItems($report);
 
     $condition = str_replace('count', '', $condition);
-    $count_required = intval(trim(str_replace('>', '', $condition)));
+    $count_required = (int) trim(str_replace('>', '', $condition));
 
     if (count($items) > $count_required)
       return true; // Condition ok.