More work on week view done. Editing of existing records is now working.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index 0e27c72..45a60b4 100644 (file)
@@ -587,6 +587,56 @@ class ttTimeHelper {
     return false;
   }
 
+  // wvCanModify (weekViewCanModify) - determines if an  already existing tt_log record
+  // can be modified with a new user-provided duration.
+  static function wvCanModify($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.
+  }
+
   // getRecord - retrieves a time record identified by its id.
   static function getRecord($id, $user_id) {
     global $user;
@@ -832,7 +882,7 @@ class ttTimeHelper {
     global $user;
     // Start with client.
     if ($user->isPluginEnabled('cl'))
-      $record_identifier = $record['client_id'] ? 'cl'.$record['client_id'] : '';
+      $record_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
     // Add billable flag.
     if (!empty($record_identifier)) $record_identifier .= ',';
     $record_identifier .= 'bl:'.$record['billable'];
@@ -851,6 +901,28 @@ class ttTimeHelper {
     return $record_identifier;
   }
 
+  // parseFromWeekViewRow - obtains field value encoded in row identifier.
+  // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
+  // requesting a client "cl" should return 546.
+  static function parseFromWeekViewRow($row_id, $field_label) {
+    // Find beginning of label.
+    $pos = strpos($row_id, $field_label);
+    if ($pos === false) return null; // Not found.
+
+    // Strip suffix from row id.
+    $suffixPos = strrpos($row_id, '_');
+    if ($suffixPos)
+      $remaninder = substr($row_id, 0, $suffixPos);
+
+    // Find beginning of value.
+    $posBegin = 1 + strpos($remaninder, ':', $pos);
+    // Find end of value.
+    $posEnd = strpos($remaninder, ',', $posBegin);
+    if ($posEnd === false) $posEnd = strlen($remaninder);
+    // Return value.
+    return substr($remaninder, $posBegin, $posEnd - $posBegin);
+  }
+
   // makeRecordLabel - builds a human readable label for a row in week view,
   // which is a combination ot record properties.
   // Client - Project - Task - Custom field 1.
@@ -902,24 +974,15 @@ class ttTimeHelper {
     return $dayHeaders;
   }
 
-    // getLockedDaysForWeek - builds an arrays of locked days in week.
+    // getLockedDaysForWeek - builds an array of locked days in week.
   static function getLockedDaysForWeek($start_date) {
     global $user;
     $lockedDays = array();
     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
-    $objDate->incDay();
-    $lockedDays[] = $user->isDateLocked($objDate);
+    for ($i = 0; $i < 7; $i++) {
+      $lockedDays[] = $user->isDateLocked($objDate);
+      $objDate->incDay();
+    }
     unset($objDate);
     return $lockedDays;
   }
@@ -947,46 +1010,86 @@ class ttTimeHelper {
     return $dayTotals;
   }
 
+  // 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, $err) {
-    $err->add("Week view is work in progress. Inserting records is not yet implemented. Try again later.");
-    // $row_id, $day_header, $posted_duration, $start_date) { // TODO: potential fields?
+  static function insertDurationFromWeekView($fields, $custom_fields, $err) {
+    global $i18n;
+    global $user;
 
-    return false; // Not implemented.
-  }
+    // Determine date for a new entry.
+    $entry_date = ttTimeHelper::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;
+      }
+    }
 
-  // modifyFromWeekView - modifies a duration of an existing record from a week view post.
-  static function modifyDurationFromWeekView($fields, $err) {
-    $err->add("Week view is work in progress. Editing records is not yet implemented. Try again later.");
-    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'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
+    $fields4insert['billable'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
+    $fields4insert['project'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
+    $fields4insert['task'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
+
+    // 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 = ttTimeHelper::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);
+    }
 
-  // static function modifyDurationFromWeekView($tt_log_id, $new_duration, $user_id) {
+    return $result;
+  }
 
-    // TODO: handle overlaps and potential other error conditions such as going beyond 24 hr mark. Other errors?
-    // If the entry has start time, check if new duration goes beyond the existing day.
 
-    // Future entries. Possibly do this check out of this function.
-    /*
-     *     // Prohibit creating entries in future.
-    if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES)) {
-      $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
-      if ($selected_date->after($browser_today))
-        $err->add($i18n->getKey('error.future_date'));
-    }
-     */
+  // modifyFromWeekView - modifies a duration of an existing record from a week view post.
+  static function modifyDurationFromWeekView($fields, $err) {
+    global $i18n;
+    global $user;
 
-    /*
-     *     // Prohibit creating an overlapping record.
-    if ($err->no()) {
-      if (ttTimeHelper::overlaps($user->getActiveUser(), $cl_date, $cl_start, $cl_finish))
-        $err->add($i18n->getKey('error.overlap'));
+    // 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 (!ttTimeHelper::wvCanModify($fields['tt_log_id'], $fields['duration'], $err)) {
+      // $err->add($i18n->getKey('error.overlap'));
+      return false;
     }
-     */
 
     $mdb2 = getConnection();
-
-    $sql = "update tt_log set duration = '$new_duration' where id = $tt_log_id and user_id = $user_id";
+    $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;