Another fix for negative hours.
[timetracker.git] / WEB-INF / lib / ttWeekViewHelper.class.php
index 2741a57..a790268 100644 (file)
 class ttWeekViewHelper {
 
   // getRecordsForInterval - returns time records for a user for a given interval of dates.
-  static function getRecordsForInterval($user_id, $start_date, $end_date) {
+  static function getRecordsForInterval($start_date, $end_date, $includeFiles = false) {
     global $user;
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $sql_time_format = "'%k:%i'"; //  24 hour format.
     if ('%I:%M %p' == $user->time_format)
       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
@@ -45,7 +50,7 @@ class ttWeekViewHelper {
 
     $custom_field_1 = null;
     if ($user->isPluginEnabled('cf')) {
-      $custom_fields = new CustomFields($user->team_id);
+      $custom_fields = new CustomFields();
       $cf_1_type = $custom_fields->fields[0]['type'];
       if ($cf_1_type == CustomFields::TYPE_TEXT) {
         $custom_field_1 = ', cfl.value as cf_1_value';
@@ -54,6 +59,13 @@ class ttWeekViewHelper {
       }
     }
 
+    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 = 'time' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
+      " on (l.id = Sub1.entity_id)";
+    }
+
     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
       " left join tt_tasks t on (l.task_id = t.id)";
     if ($user->isPluginEnabled('cl'))
@@ -64,15 +76,16 @@ class ttWeekViewHelper {
       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
         $left_joins .= '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.option_id = cfo.id) ';
     }
-
-    $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
-      TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
-      TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
-      t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
-      from tt_log l
-      $left_joins
-      where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
-      order by l.date, p.name, t.name, l.start, l.id";
+    $left_joins .= $fileJoin;
+
+    $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,".
+      " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
+      " TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,".
+      " t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1 $filePart".
+      " from tt_log l $left_joins".
+      " where l.date >= '$start_date' and l.date <= '$end_date'".
+      " and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
+      " order by l.date, p.name, t.name, l.start, l.id";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -85,9 +98,9 @@ class ttWeekViewHelper {
     return $result;
   }
 
-  // getDataForWeekView - builds an array to render a table of durations and comments for week view.
+  // getDataForWeekView - builds an array to render a table of durations and comments for week view.
   // In a week view we want one row representing the same attributes to have 7 values for each day of week.
-  // We identify simlar records by a combination of client, billable, project, task, and custom field values.
+  // We identify similar records by a combination of client, billable, project, task, and custom field values.
   // This will allow us to extend the feature when more custom fields are added.
   //
   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
@@ -96,7 +109,7 @@ class ttWeekViewHelper {
   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
   //
-  // Daily comments are implemented as alternate rows following week durations.
+  // Daily comments are implemented as alternate rows following week durations (when enabled).
   // For example: row_0 - new entry durations, row_1 - new entry daily comments,
   //              row_2 - existing entry durations, row_3 - existing entry comments, etc.
   //
@@ -104,7 +117,7 @@ class ttWeekViewHelper {
   // $dataArray = array(
   //   array( // Row 0. This is a special, one-off row for a new week entry with empty values.
   //     'row_id' => null, // Row identifier. Null for a new entry.
-  //     'label' => 'New entry', // Human readable label for the row describing what this time entry is for.
+  //     'label' => 'New entry:', // Human readable label for the row describing what this time entry is for.
   //     'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => null, 'duration' => null), // control_id is row_id plus day header for column.
   //     'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => null, 'duration' => null),
   //     'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => null, 'duration' => null),
@@ -114,10 +127,9 @@ class ttWeekViewHelper {
   //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
   //   ),
   //
-  //   TODO: work in progress re-documenting the array for improved week view. Trying to implement this now.
   //   array( // Row 1. This row represents daily comments for a new entry in row above (row 0).
-  //     'row_id' => null, // Row identifier. See ttWeekViewHelper::makeRowIdentifier().
-  //     'label' => 'Notes', // Human readable label.
+  //     'row_id' => null,
+  //     'label' => 'Notes:',
   //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'note' => null),
   //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => null, 'note' => null),
   //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'note' => null),
@@ -126,49 +138,51 @@ class ttWeekViewHelper {
   //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'note' => null),
   //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'note' => null)
   //   ),
-  //   TODO: work in progress...
   //
-  //   array( // Row 1.
-  //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttWeekViewHelper::makeRowIdentifier().
-  //     'label' => 'Anuko - Time Tracker - Coding',              // Human readable label for the row describing what this time entry is for.
-  //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
-  //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
-  //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
-  //     'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'duration' => null),
-  //     'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
-  //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
-  //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
-  //   ),
   //   array( // Row 2.
-  //     'row_id' => 'bl:0_0',
-  //     'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
-  //     'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => null, 'duration' => null),
-  //     'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
-  //     'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => null, 'duration' => null),
-  //     'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
-  //     'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
-  //     'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => null, 'duration' => null),
+  //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0',
+  //     'label' => 'Anuko - Time Tracker - Coding - Option 2',
+  //     'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'),
+  //     'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
+  //     'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
+  //     'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => null, 'duration' => null),
+  //     'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
+  //     'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
   //     'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
+  //   ),
+  //   array( // Row 3.
+  //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0_notes',
+  //     'label' => 'Notes:',
+  //     'day_0' => array('control_id' => '3_day_0', 'tt_log_id' => 12345, 'note' => 'Comment one'),
+  //     'day_1' => array('control_id' => '3_day_1', 'tt_log_id' => 12346, 'note' => 'Comment two'),
+  //     'day_2' => array('control_id' => '3_day_2', 'tt_log_id' => 12347, 'note' => 'Comment three'),
+  //     'day_3' => array('control_id' => '3_day_3', 'tt_log_id' => null, 'note' => null),
+  //     'day_4' => array('control_id' => '3_day_4', 'tt_log_id' => 12348, 'note' => 'Comment four'),
+  //     'day_5' => array('control_id' => '3_day_5', 'tt_log_id' => 12349, 'note' => 'Comment five'),
+  //     'day_6' => array('control_id' => '3_day_6', 'tt_log_id' => null, 'note' => null)
   //   )
   // );
   static function getDataForWeekView($records, $dayHeaders) {
+    global $user;
     global $i18n;
 
     $dataArray = array();
 
     // Construct the first row for a brand new entry.
-    $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry').':'); // Insert row.
+    $dataArray[] = array('row_id' => null,'label' => $i18n->get('form.week.new_entry').':'); // Insert row.
     // Insert empty cells with proper control ids.
     for ($i = 0; $i < 7; $i++) {
       $control_id = '0_'. $dayHeaders[$i];
       $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
     }
-    // Construct the second row for daily comments for a brand new entry.
-    $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('label.notes').':'); // Insert row.
-    // Insert empty cells with proper control ids.
-    for ($i = 0; $i < 7; $i++) {
-      $control_id = '1_'. $dayHeaders[$i];
-      $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+    if ($user->isPluginEnabled('wvns')) {
+      // Construct the second row for daily comments for a brand new entry.
+      $dataArray[] = array('row_id' => null,'label' => $i18n->get('label.notes').':'); // Insert row.
+      // Insert empty cells with proper control ids.
+      for ($i = 0; $i < 7; $i++) {
+        $control_id = '1_'. $dayHeaders[$i];
+        $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+      }
     }
 
     // Iterate through records and build $dataArray cell by cell.
@@ -195,27 +209,31 @@ class ttWeekViewHelper {
           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
         }
         // Insert row for comments.
-        $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->getKey('label.notes').':');
-        $pos++;
-        // Insert empty cells with proper control ids.
-        for ($i = 0; $i < 7; $i++) {
-          $control_id = $pos.'_'. $dayHeaders[$i];
-          $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+        if ($user->isPluginEnabled('wvns')) {
+          $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->get('label.notes').':');
+          $pos++;
+          // Insert empty cells with proper control ids.
+          for ($i = 0; $i < 7; $i++) {
+            $control_id = $pos.'_'. $dayHeaders[$i];
+            $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+          }
+          $pos--;
         }
-        $pos--;
       }
       // Insert actual cell data from $record (one cell only).
       $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
-      // Insert existing comment from $record into the duration cell.
-      $pos++;
-      $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'note' => $record['comment']);
+      // Insert existing comment from $record into the comment cell.
+      if ($user->isPluginEnabled('wvns')) {
+        $pos++;
+        $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'note' => $record['comment']);
+      }
     }
     return $dataArray;
   }
 
   // prePopulateFromPastWeeks - is a complementary function to getDataForWeekView.
-  // It build an "empty" $dataArray with only labels present. Labels are taken from
-  // the most recent past week, up to 5 weeks back from this week.
+  // It builds an "empty" $dataArray with only labels present. Labels are taken from
+  // the most recent active past week, up to 5 weeks back from now.
   // This is a data entry acceleration feature to help users quickly populate their
   // regular entry list for a new week, even after a long vacation.
   static function prePopulateFromPastWeeks($startDate, $dayHeaders) {
@@ -231,7 +249,7 @@ class ttWeekViewHelper {
     unset($objDate);
 
     // Obtain past week(s) records.
-    $records = ttWeekViewHelper::getRecordsForInterval($user->getActiveUser(), $pastWeekStartDate, $pastWeekEndDate);
+    $records = ttWeekViewHelper::getRecordsForInterval($pastWeekStartDate, $pastWeekEndDate);
     // Handle potential situation of no records by re-trying for up to 4 more previous weeks (after a long vacation, etc.).
     if (!$records) {
       for ($i = 0; $i < 4; $i++) {
@@ -242,26 +260,27 @@ class ttWeekViewHelper {
         $pastWeekEndDate = $objDate->toString(DB_DATEFORMAT);
         unset($objDate);
 
-        $records = ttWeekViewHelper::getRecordsForInterval($user->getActiveUser(), $pastWeekStartDate, $pastWeekEndDate);
+        $records = ttWeekViewHelper::getRecordsForInterval($pastWeekStartDate, $pastWeekEndDate);
         // Break out of the loop if we found something.
         if ($records) break;
       }
     }
 
-    // TODO: consider refactoring, this block of code is used 2 times.
     // Construct the first row for a brand new entry.
-    $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry').':'); // Insert row.
+    $dataArray[] = array('row_id' => null,'label' => $i18n->get('form.week.new_entry').':'); // Insert row.
     // Insert empty cells with proper control ids.
     for ($i = 0; $i < 7; $i++) {
       $control_id = '0_'. $dayHeaders[$i];
       $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
     }
-    // Construct the second row for daily comments for a brand new entry.
-    $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('label.notes').':'); // Insert row.
-    // Insert empty cells with proper control ids.
-    for ($i = 0; $i < 7; $i++) {
-      $control_id = '1_'. $dayHeaders[$i];
-      $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+    if ($user->isPluginEnabled('wvns')) {
+      // Construct the second row for daily comments for a brand new entry.
+      $dataArray[] = array('row_id' => null,'label' => $i18n->get('label.notes').':'); // Insert row.
+      // Insert empty cells with proper control ids.
+      for ($i = 0; $i < 7; $i++) {
+        $control_id = '1_'. $dayHeaders[$i];
+        $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+      }
     }
 
     // Iterate through records and build an "empty" $dataArray.
@@ -280,14 +299,16 @@ class ttWeekViewHelper {
           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
         }
         // Insert row for comments.
-        $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->getKey('label.notes').':');
-        $pos++;
-        // Insert empty cells with proper control ids.
-        for ($i = 0; $i < 7; $i++) {
-          $control_id = $pos.'_'. $dayHeaders[$i];
-          $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+        if ($user->isPluginEnabled('wvns')) {
+          $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->get('label.notes').':');
+          $pos++;
+          // Insert empty cells with proper control ids.
+          for ($i = 0; $i < 7; $i++) {
+            $control_id = $pos.'_'. $dayHeaders[$i];
+            $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+          }
+          $pos--;
         }
-        $pos--;
       }
     }
 
@@ -321,7 +342,7 @@ class ttWeekViewHelper {
 
     // Insert label.
     global $i18n;
-    $dayTotals['label'] = $i18n->getKey('label.day_total').':';
+    $dayTotals['label'] = $i18n->get('label.day_total').':';
 
     foreach ($dataArray as $row) {
       foreach($dayHeaders as $dayHeader) {
@@ -333,7 +354,7 @@ class ttWeekViewHelper {
     }
     // Convert minutes to hh:mm for display.
     foreach($dayHeaders as $dayHeader) {
-      $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
+      $dayTotals[$dayHeader] = ttTimeHelper::minutesToDuration($dayTotals[$dayHeader]); // This breaks for negative hours.
     }
     return $dayTotals;
   }
@@ -478,17 +499,19 @@ class ttWeekViewHelper {
     $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
 
     // Prohibit creating entries in future.
-    if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
+    if (!$user->future_entries && $fields['browser_today']) {
       $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
       if ($objEntryDate->after($objBrowserToday)) {
-        $err->add($i18n->getKey('error.future_date'));
+        $err->add($i18n->get('error.future_date'));
         return false;
       }
     }
 
     // Prepare an array of fields for regular insert function.
     $fields4insert = array();
-    $fields4insert['user_id'] = $user->getActiveUser();
+    $fields4insert['user_id'] = $user->getUser();
+    $fields4insert['group_id'] = $user->getGroup();
+    $fields4insert['org_id'] = $user->org_id;
     $fields4insert['date'] = $entry_date;
     $fields4insert['duration'] = $fields['duration'];
     $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
@@ -526,7 +549,7 @@ class ttWeekViewHelper {
     $mdb2 = getConnection();
     $duration = $fields['duration'];
     $tt_log_id = $fields['tt_log_id'];
-    $user_id = $user->getActiveUser();
+    $user_id = $user->getUser();
     $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
@@ -546,7 +569,7 @@ class ttWeekViewHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if (!$res->numRows()) {
-        $err->add($i18n->getKey('error.db')); // This is not expected.
+        $err->add($i18n->get('error.db')); // This is not expected.
         return false;
       }
       $val = $res->fetchRow();
@@ -567,7 +590,7 @@ class ttWeekViewHelper {
     $newEndMinutes = $startMinutes + $newMinutes;
     if ($newEndMinutes > 1440) {
       // Invalid duration, as new duration puts the record beyond current day.
-      $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
+      $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
       return false;
     }
 
@@ -578,7 +601,7 @@ class ttWeekViewHelper {
     $start = ttTimeHelper::toAbsDuration($startMinutes);
     $finish = ttTimeHelper::toAbsDuration($newEndMinutes);
     if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) {
-      $err->add($i18n->getKey('error.overlap'));
+      $err->add($i18n->get('error.overlap'));
       return false;
     }
 
@@ -592,7 +615,7 @@ class ttWeekViewHelper {
     $mdb2 = getConnection();
     $tt_log_id = $fields['tt_log_id'];
     $comment = $fields['comment'];
-    $user_id = $user->getActiveUser();
+    $user_id = $user->getUser();
     $sql = "update tt_log set comment = ".$mdb2->quote($fields['comment'])." where id = $tt_log_id and user_id = $user_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))