Fixed monthly quotas to properly replace decimal delimiter.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index d186696..f8eadf2 100644 (file)
@@ -82,7 +82,7 @@ class ttTimeHelper {
 
   // isValidDuration validates a value as a time duration string (in hours and minutes).
   static function isValidDuration($value) {
-    if (strlen($value)==0 || !isset($value)) return false;
+    if (strlen($value) == 0 || !isset($value)) return false;
 
     if ($value == '24:00' || $value == '2400') return true;
 
@@ -102,8 +102,55 @@ class ttTimeHelper {
     return false;
   }
 
+  // isValidQuota validates a localized value as an hours quota string (in hours and minutes).
+  static function isValidQuota($value) {
+
+    if (strlen($value) == 0 || !isset($value)) return true;
+
+    if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
+      return true;
+    }
+
+    if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
+      return true;
+    }
+
+    global $user;
+    $localizedPattern = '/^([0-9]{1,3})?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+    if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
+      return true;
+    }
+
+    return false;
+  }
+
+  // quotaToFloat converts a valid quota value to a float.
+  static function quotaToFloat($value) {
+
+    if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
+      return (float) $value;
+    }
+
+    if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
+      $minutes = ttTimeHelper::toMinutes($value);
+      return ($minutes / 60.0);
+    }
+
+    global $user;
+    $localizedPattern = '/^([0-9]{1,3})?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+    if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
+      // Strip optional h in the end.
+      $value = trim($value, 'h');
+      if ($user->decimal_mark == ',')
+        $value = str_replace(',', '.', $value);
+      return (float) $value;
+    }
+
+    return null;
+  }
+
   // normalizeDuration - converts a valid time duration string to format 00:00.
-  static function normalizeDuration($value) {
+  static function normalizeDuration($value, $leadingZero = true) {
     $time_value = $value;
 
     // If we have a decimal format - convert to time format 00:00.
@@ -116,7 +163,7 @@ class ttTimeHelper {
       $mins = round($val * 60);
       $hours = (string)((int)($mins / 60));
       $mins = (string)($mins % 60);
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       if (strlen($mins) == 1)
         $mins = '0' . $mins;
@@ -129,7 +176,7 @@ class ttTimeHelper {
     // 0-99
     if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
       $hours = $time_a[0];
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
        return $hours.':00';
     }
@@ -138,7 +185,7 @@ class ttTimeHelper {
     if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) {
       if (strlen($time_value)==3) $time_value = '0'.$time_value;
       $hours = substr($time_value,0,2);
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       return $hours.':'.substr($time_value,2,2);
     }
@@ -146,7 +193,7 @@ class ttTimeHelper {
     // 0:00-23:59 (24:00)
     if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
       $hours = $time_a[0];
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       return $hours.':'.$time_a[1];
     }
@@ -162,11 +209,14 @@ class ttTimeHelper {
 
   // toAbsDuration - converts a number of minutes to format 0:00
   // even if $minutes is negative.
-  static function toAbsDuration($minutes){
+  static function toAbsDuration($minutes, $abbreviate = false){
     $hours = (string)((int)abs($minutes / 60));
-    $mins = (string)(abs($minutes % 60));
+    $mins = (string) round(abs(fmod($minutes, 60)));
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
+    if ($abbreviate && $mins == '00')
+      return $hours;
+
     return $hours.':'.$mins;
   }
 
@@ -370,6 +420,7 @@ class ttTimeHelper {
     $invoice = $fields['invoice'];
     $note = $fields['note'];
     $billable = $fields['billable'];
+    $paid = $fields['paid'];
     if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
       $status_f = ', status';
       $status_v = ', '.$mdb2->quote($fields['status']);
@@ -390,10 +441,11 @@ class ttTimeHelper {
     }
 
     if (!$billable) $billable = 0;
+    if (!$paid) $paid = 0;
 
     if ($duration) {
-      $sql = "insert into tt_log (timestamp, user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
-        "values ('$timestamp', $user_id, ".$mdb2->quote($date).", '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable $status_v)";
+      $sql = "insert into tt_log (timestamp, user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid $status_f) ".
+        "values ('$timestamp', $user_id, ".$mdb2->quote($date).", '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable, $paid $status_v)";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -402,8 +454,8 @@ class ttTimeHelper {
       if ($duration === false) $duration = 0;
       if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
 
-      $sql = "insert into tt_log (timestamp, user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
-        "values ('$timestamp', $user_id, ".$mdb2->quote($date).", '$start', '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable $status_v)";
+      $sql = "insert into tt_log (timestamp, user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid $status_f) ".
+        "values ('$timestamp', $user_id, ".$mdb2->quote($date).", '$start', '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable, $paid $status_v)";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -416,6 +468,7 @@ class ttTimeHelper {
   // update - updates a record in log table. Does not update its custom fields.
   static function update($fields)
   {
+    global $user;
     $mdb2 = getConnection();
 
     $id = $fields['id'];
@@ -428,19 +481,26 @@ class ttTimeHelper {
     $finish = $fields['finish'];
     $duration = $fields['duration'];
     $note = $fields['note'];
-    $billable = $fields['billable'];
+
+    $billable_part = '';
+    if ($user->isPluginEnabled('iv')) {
+      $billable_part = $fields['billable'] ? ', billable = 1' : ', billable = 0';
+    }
+    $paid_part = '';
+    if ($user->canManageTeam() && $user->isPluginEnabled('ps')) {
+      $paid_part = $fields['paid'] ? ', paid = 1' : ', paid = 0';
+    }
 
     $start = ttTimeHelper::to24HourFormat($start);
     $finish = ttTimeHelper::to24HourFormat($finish);
     if ('00:00' == $finish) $finish = '24:00';
     $duration = ttTimeHelper::normalizeDuration($duration);
 
-    if (!$billable) $billable = 0;
     if ($start) $duration = '';
 
     if ($duration) {
       $sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
-        "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+        "comment = ".$mdb2->quote($note)."$billable_part $paid_part, date = '$date' WHERE id = $id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -453,7 +513,7 @@ class ttTimeHelper {
         return false;
 
       $sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
-        "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+        "comment = ".$mdb2->quote($note)."$billable_part $paid_part, date = '$date' WHERE id = $id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -599,7 +659,7 @@ class ttTimeHelper {
     $sql = "select l.id as id, l.timestamp as timestamp, 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.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id, l.invoice_id, l.billable, l.date
+      p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id, l.invoice_id, l.billable, l.paid, l.date
       from tt_log l
       left join tt_projects p on (p.id = l.project_id)
       left join tt_tasks t on (t.id = l.task_id)
@@ -625,7 +685,7 @@ class ttTimeHelper {
     $sql = "select l.id, l.timestamp, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
       TIME_FORMAT(l.duration, '%k:%i') as duration,
-      l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.status
+      l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.paid, l.status
       from tt_log l where l.user_id = $user_id order by l.id";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
@@ -674,189 +734,4 @@ class ttTimeHelper {
 
     return $result;
   }
-
-  // getRecordsForInterval - returns time records for a user for a given interval of dates.
-  static function getRecordsForInterval($user_id, $start_date, $end_date) {
-    global $user;
-    $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.
-
-    $result = array();
-    $mdb2 = getConnection();
-
-    $client_field = null;
-    if ($user->isPluginEnabled('cl'))
-      $client_field = ', c.id as client_id, c.name as client';
-
-    $custom_field_1 = null;
-    if ($user->isPluginEnabled('cf')) {
-      $custom_fields = new CustomFields($user->team_id);
-      $cf_1_type = $custom_fields->fields[0]['type'];
-      if ($cf_1_type == CustomFields::TYPE_TEXT) {
-        $custom_field_1 = ', cfl.value as cf_1_value';
-      } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
-        $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
-      }
-    }
-
-    $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'))
-      $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
-    if ($user->isPluginEnabled('cf')) {
-      if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
-        $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.value = cfo.id) ';
-      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 p.name, t.name, l.date, l.start, l.id";
-    $res = $mdb2->query($sql);
-    if (!is_a($res, 'PEAR_Error')) {
-      while ($val = $res->fetchRow()) {
-        if($val['duration']=='0:00')
-          $val['finish'] = '';
-        $result[] = $val;
-      }
-    } else return false;
-
-    return $result;
-  }
-
-  // getGroupedRecordsForInterval - returns time records for a user for a given interval of dates grouped in an array of dates.
-  // Example: for 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.
-  // 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"
-  // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
-  //
-  // "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.
-  static function getGroupedRecordsForInterval($user_id, $start_date, $end_date) {
-    // Start by obtaining all records in interval.
-    // Then, iterate through them to build an array.
-    $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
-    $groupedRecords = array();
-    foreach ($records as $record) {
-      $record_identifier_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
-      // Handle potential multiple records with the same attributes by using a numerical suffix.
-      $suffix = 0;
-      $record_identifier = $record_identifier_no_suffix.'_'.$suffix;
-      while (!empty($groupedRecords[$record_identifier][$record['date']])) {
-        $suffix++;
-        $record_identifier = $record_identifier_no_suffix.'_'.$suffix;
-      }
-      $groupedRecords[$record_identifier][$record['date']] = array('id'=>$record['id'], 'duration'=>$record['duration']);
-      $groupedRecords[$record_identifier]['client'] = $record['client'];
-      $groupedRecords[$record_identifier]['cf_1_value'] = $record['cf_1_value'];
-      $groupedRecords[$record_identifier]['project'] = $record['project'];
-      $groupedRecords[$record_identifier]['task'] = $record['task'];
-      $groupedRecords[$record_identifier]['billable'] = $record['billable'];
-    }
-
-    return $groupedRecords;
-  }
-
-  /* This is work in progress, not working properly.
-  static function getDurationsForWeek($user_id, $start_date, $end_date) {
-    // Start by obtaining all records in interval.
-    // Then, iterate through them to build an array.
-    $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
-    $durations_with_labels = array();
-
-    foreach ($records as $record) {
-      $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
-      // Handle potential multiple records with the same attributes by using a numerical suffix.
-      $suffix = 0;
-      $record_id = $record_id_no_suffix.'_'.$suffix;
-      while (!empty($durations_with_labels[$record_id][$record['date']])) {
-        $suffix++;
-        $record_id = $record_id_no_suffix.'_'.$suffix;
-      }
-      $groupedRecords[$record_identifier][$record['date']] = array('id'=>$record['id'], 'duration'=>$record['duration']);
-      $groupedRecords[$record_identifier]['client'] = $record['client'];
-      $groupedRecords[$record_identifier]['cf_1_value'] = $record['cf_1_value'];
-      $groupedRecords[$record_identifier]['project'] = $record['project'];
-      $groupedRecords[$record_identifier]['task'] = $record['task'];
-      $groupedRecords[$record_identifier]['billable'] = $record['billable'];
-    }
-  }
-  */
-
-  // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
-  // 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"
-  // See comment for getGroupedRecordsForInterval.
-  static function makeRecordIdentifier($record) {
-    global $user;
-    // Start with client.
-    if ($user->isPluginEnabled('cl'))
-      $record_identifier = $record['client_id'] ? 'cl'.$record['client_id'] : '';
-    // Add billable flag.
-    if (!empty($record_identifier)) $record_identifier .= ',';
-    $record_identifier .= 'bl:'.$record['billable'];
-    // Add project.
-    $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
-    // Add task.
-    $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
-    // Add custom field 1. This requires modifying the query to get the data we need.
-    if ($user->isPluginEnabled('cf')) {
-      if ($record['cf_1_id'])
-        $record_identifier .= ',cf_1:'.$record['cf_1_id'];
-      else if ($record['cf_1_value'])
-        $record_identifier .= ',cf_1:'.$record['cf_1_value'];
-    }
-
-    return $record_identifier;
-  }
-
-  // getGroupedRecordsTotals - returns day totals for grouped records.
-  static function getGroupedRecordsTotals($groupedRecords) {
-    $groupedRecordsTotals = array();
-    foreach ($groupedRecords as $groupedRecord) {
-      foreach($groupedRecord as $key => $dayEntry) {
-        if ($dayEntry['duration']) {
-          $minutes = ttTimeHelper::toMinutes($dayEntry['duration']);
-          $groupedRecordsTotals[$key] += $minutes;
-        }
-      }
-    }
-    // Convert minutes to hh:mm for display.
-    foreach ($groupedRecordsTotals as $key => $single_total) {
-      $groupedRecordsTotals[$key] = ttTimeHelper::toAbsDuration($single_total);
-    }
-
-    return $groupedRecordsTotals;
-  }
-
-  // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
-  static function getDayHeadersForWeek($start_date) {
-    $dayHeaders = array();
-    $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
-    $dayHeaders['day_header_0'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_1'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_2'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_3'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_4'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_5'] = $objDate->getDate();
-    $objDate->incDay();
-    $dayHeaders['day_header_6'] = $objDate->getDate();
-    unset($objDate);
-    return $dayHeaders;
-  }
 }