Fixed a problem with English label introduced in previous commit.
[timetracker.git] / WEB-INF / lib / ttWeekViewHelper.class.php
index 4880970..5c03a37 100644 (file)
@@ -72,7 +72,7 @@ class ttWeekViewHelper {
       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 p.name, t.name, l.date, l.start, l.id";
+      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()) {
@@ -110,7 +110,7 @@ class ttWeekViewHelper {
   //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
   //   ),
   //   array( // Row 1.
-  //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
+  //     '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'),
@@ -132,12 +132,9 @@ class ttWeekViewHelper {
   //     'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
   //   )
   // );
-  static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
+  static function getDataForWeekView($records, $dayHeaders) {
     global $i18n;
 
-    // Start by obtaining all records in interval.
-    $records = ttWeekViewHelper::getRecordsForInterval($user_id, $start_date, $end_date);
-
     $dataArray = array();
 
     // Construct the first row for a brand new entry.
@@ -151,20 +148,20 @@ class ttWeekViewHelper {
     // Iterate through records and build $dataArray cell by cell.
     foreach ($records as $record) {
       // Create record id without suffix.
-      $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
+      $row_id_no_suffix = ttWeekViewHelper::makeRowIdentifier($record);
       // Handle potential multiple records with the same attributes by using a numerical suffix.
       $suffix = 0;
-      $record_id = $record_id_no_suffix.'_'.$suffix;
+      $row_id = $row_id_no_suffix.'_'.$suffix;
       $day_header = substr($record['date'], 8); // Day number in month.
-      while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
+      while (ttWeekViewHelper::cellExists($row_id, $day_header, $dataArray)) {
         $suffix++;
-        $record_id = $record_id_no_suffix.'_'.$suffix;
+        $row_id = $row_id_no_suffix.'_'.$suffix;
       }
       // Find row.
-      $pos = ttTimeHelper::findRow($record_id, $dataArray);
+      $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
       if ($pos < 0) {
-        $dataArray[] = array('row_id' => $record_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
-        $pos = ttTimeHelper::findRow($record_id, $dataArray);
+        $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
+        $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
         // Insert empty cells with proper control ids.
         for ($i = 0; $i < 7; $i++) {
           $control_id = $pos.'_'. $dayHeaders[$i];
@@ -177,6 +174,50 @@ class ttWeekViewHelper {
     return $dataArray;
   }
 
+  // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
+  // and a day header already exists.
+  static function cellExists($row_id, $day_header, $dataArray) {
+    foreach($dataArray as $row) {
+      if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
+        return true;
+    }
+    return false;
+  }
+
+  // findRow returns an existing row position in $dataArray, -1 otherwise.
+  static function findRow($row_id, $dataArray) {
+    $pos = 0; // Row position in array.
+    foreach($dataArray as $row) {
+      if ($row['row_id'] == $row_id)
+        return $pos;
+      $pos++; // Increment for search.
+    }
+    return -1; // Row not found.
+  }
+
+  // getDayTotals calculates total durations for each day from the existing data in $dataArray.
+  static function getDayTotals($dataArray, $dayHeaders) {
+    $dayTotals = array();
+
+    // Insert label.
+    global $i18n;
+    $dayTotals['label'] = $i18n->getKey('label.day_total');
+
+    foreach ($dataArray as $row) {
+      foreach($dayHeaders as $dayHeader) {
+        if (array_key_exists($dayHeader, $row)) {
+          $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
+          $dayTotals[$dayHeader] += $minutes;
+        }
+      }
+    }
+    // Convert minutes to hh:mm for display.
+    foreach($dayHeaders as $dayHeader) {
+      $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
+    }
+    return $dayTotals;
+  }
+
   // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
   static function getDayHeadersForWeek($start_date) {
     $dayHeaders = array();
@@ -213,6 +254,34 @@ class ttWeekViewHelper {
     return $lockedDays;
   }
 
+  // makeRowIdentifier - builds a string identifying a row for a week view from a single record properties.
+  //                     Note that the return value is without a suffix.
+  // For example:
+  // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
+  // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
+  static function makeRowIdentifier($record) {
+    global $user;
+    // Start with client.
+    if ($user->isPluginEnabled('cl'))
+      $row_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
+    // Add billable flag.
+    if (!empty($row_identifier)) $row_identifier .= ',';
+    $row_identifier .= 'bl:'.$record['billable'];
+    // Add project.
+    $row_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
+    // Add task.
+    $row_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
+    // Add custom field 1.
+    if ($user->isPluginEnabled('cf')) {
+      if ($record['cf_1_id'])
+        $row_identifier .= ',cf_1:'.$record['cf_1_id'];
+      else if ($record['cf_1_value'])
+        $row_identifier .= ',cf_1:'.$record['cf_1_value'];
+    }
+
+    return $row_identifier;
+  }
+
   // makeRowLabel - builds a human readable label for a row in week view,
   // which is a combination ot record properties.
   // Client - Project - Task - Custom field 1.
@@ -262,4 +331,141 @@ class ttWeekViewHelper {
     // Return value.
     return substr($remaninder, $posBegin, $posEnd - $posBegin);
   }
+
+  // dateFromDayHeader calculates date from start date and day header in week view.
+  static function dateFromDayHeader($start_date, $day_header) {
+    $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+    $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
+    if (strlen($currentDayHeader) == 1)               // Which is an implementation detail of DateAndTime class.
+      $currentDayHeader = '0'.$currentDayHeader;      // Add a 0 for single digit day.
+    $i = 1;
+    while ($currentDayHeader != $day_header && $i < 7) {
+      // Iterate through remaining days to find a match.
+      $objDate->incDay();
+      $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
+      $i++;
+    }
+    return $objDate->toString(DB_DATEFORMAT);
+  }
+
+  // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
+  static function insertDurationFromWeekView($fields, $custom_fields, $err) {
+    global $i18n;
+    global $user;
+
+    // Determine date for a new entry.
+    $entry_date = ttWeekViewHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
+    $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
+
+    // Prohibit creating entries in future.
+    if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
+      $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
+      if ($objEntryDate->after($objBrowserToday)) {
+        $err->add($i18n->getKey('error.future_date'));
+        return false;
+      }
+    }
+
+    // Prepare an array of fields for regular insert function.
+    $fields4insert = array();
+    $fields4insert['user_id'] = $user->getActiveUser();
+    $fields4insert['date'] = $entry_date;
+    $fields4insert['duration'] = $fields['duration'];
+    $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
+    $fields4insert['billable'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
+    $fields4insert['project'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
+    $fields4insert['task'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
+    $fields4insert['note'] = $fields['note'];
+
+    // Try to insert a record.
+    $id = ttTimeHelper::insert($fields4insert);
+    if (!$id) return false; // Something failed.
+
+    // Insert custom field if we have it.
+    $result = true;
+    $cf_1 = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
+    if ($custom_fields && $cf_1) {
+      if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
+        $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
+      elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
+        $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
+    }
+
+    return $result;
+  }
+
+  // modifyDurationFromWeekView - modifies a duration of an existing record from a week view post.
+  static function modifyDurationFromWeekView($fields, $err) {
+    global $i18n;
+    global $user;
+
+    // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
+    // TODO: rename this function.
+    // Handle different errors with specific error messages.
+    if (!ttWeekViewHelper::canModify($fields['tt_log_id'], $fields['duration'], $err)) {
+      // $err->add($i18n->getKey('error.overlap'));
+      return false;
+    }
+
+    $mdb2 = getConnection();
+    $duration = $fields['duration'];
+    $tt_log_id = $fields['tt_log_id'];
+    $user_id = $user->getActiveUser();
+    $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'))
+      return false;
+
+    return true;
+  }
+
+  // canModify - determines if an  already existing tt_log record
+  // can be modified with a new user-provided duration.
+  static function canModify($tt_log_id, $new_duration, $err) {
+    global $i18n;
+    $mdb2 = getConnection();
+
+    // Determine if we have start time in record, as further checking does not makes sense otherwise.
+    $sql = "select user_id, date, start, duration from tt_log  where id = $tt_log_id";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      if (!$res->numRows()) {
+        $err->add($i18n->getKey('error.db')); // This is not expected.
+        return false;
+      }
+      $val = $res->fetchRow();
+      $oldDuration = $val['duration'];
+      if (!$val['start'])
+        return true; // There is no start time in the record, therefore safe to modify.
+    }
+
+    // We do have start time.
+    // Quick test if new duration is less then already existing.
+    $newMinutes = ttTimeHelper::toMinutes($new_duration);
+    $oldMinutes = ttTimeHelper::toMinutes($oldDuration);
+    if ($newMinutes < $oldMinutes)
+      return true; // Safe to modify.
+
+    // Does the new duration put the record beyond 24:00 boundary?
+    $startMinutes = ttTimeHelper::toMinutes($val['start']);
+    $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'));
+      return false;
+    }
+
+    // Does the new duration causes the record to overlap with others?
+    $user_id = $val['user_id'];
+    $date = $val['date'];
+    $startMinutes = ttTimeHelper::toMinutes($val['start']);
+    $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'));
+      return false;
+    }
+
+    return true; // There are no conflicts, safe to modify.
+  }
 }