Improved ttTimeHelper::holidayMatch to allow partial wildcards in year.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index c3ae8d6..f6d8b92 100644 (file)
@@ -33,6 +33,11 @@ class ttTimeHelper {
 
   // isWeekend determines if $date falls on weekend.
   static function isWeekend($date) {
+    // NOTE: this does not work for subgroups with different WEEKEND_START_DAY
+    // as the setting is per server. Example: a parent group in USA, with a subgroup
+    // in Saudi Arabia. Their weekends are the same.
+    // Decided NOT to introduce a configurable WEEKEND_START_DAY for groups in UI
+    // to keep UI simple, for now. See also Calendar class with the same issue.
     $weekDay = date('w', strtotime($date));
     return ($weekDay == WEEKEND_START_DAY || $weekDay == (WEEKEND_START_DAY + 1) % 7);
   }
@@ -40,19 +45,50 @@ class ttTimeHelper {
   // isHoliday determines if $date falls on a holiday.
   static function isHoliday($date) {
     global $user;
-    global $i18n;
 
-    if (!$user->show_holidays) return false;
-
-    // $date is expected as string in DB_DATEFORMAT.
-    $month = date('m', strtotime($date));
-    $day = date('d', strtotime($date));
-    if (in_array($month.'/'.$day, $i18n->holidays))
-      return true;
+    $holidays = $user->getHolidays();
+    if (!$holidays)
+      return false;
 
+    $holiday_dates = explode(',', $holidays);
+    foreach ($holiday_dates as $holiDateSpec) {
+      if (ttTimeHelper::holidayMatch($date, $holiDateSpec))
+        return true;
+    }
     return false;
   }
 
+  // holidayMatch determines if $date matches a single $holiDateSpec.
+  static function holidayMatch($date, $holiDateSpec) {
+
+   $dateArray = explode('-', $date);
+   $holiDateSpecArray = explode('-', $holiDateSpec);
+
+   // Check year.
+   for($i = 0; $i < 4; $i++) {
+     if ($dateArray[0][$i] != $holiDateSpecArray[0][$i] && $holiDateSpecArray[0][$i] != '*') // * means any digit matches
+       return false;
+   }
+   // Check month.
+   if ($dateArray[1] != $holiDateSpecArray[1])
+     return false;
+   // Check day.
+   if ($dateArray[2] != $holiDateSpecArray[2])
+     return false;
+
+    return true;
+  }
+
+  // dateInDatabaseFormat prepares a date string in DB_DATEFORMAT out of year, month, and day.
+  static function dateInDatabaseFormat($year, $month, $day) {
+    $date = "$year-";
+    if (strlen($month) == 1) $date .= '0';
+    $date .= "$month-";
+    if (strlen($day) == 1) $date .= '0';
+    $date .= $day;
+    return $date;
+  }
+
   // isValidTime validates a value as a time string.
   static function isValidTime($value) {
     if (strlen($value)==0 || !isset($value)) return false;
@@ -132,17 +168,21 @@ class ttTimeHelper {
     if (!isset($duration) || strlen($duration) == 0)
       return null; // Value is not set. Caller decides whether it is valid or not.
 
+    // We allow negative durations, similar to negative expenses (installments).
+    $signMultiplier = ttStartsWith($duration, '-') ? -1 : 1;
+    if ($signMultiplier == -1) $duration = ltrim($duration, '-');
+
     // Handle whole hours.
     if (preg_match('/^\d{1,3}h?$/', $duration )) { // 0 - 999, 0h - 999h
       $minutes = 60 * trim($duration, 'h');
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle a normalized duration value.
     if (preg_match('/^\d{1,3}:[0-5][0-9]$/', $duration )) { // 0:00 - 999:59
       $time_array = explode(':', $duration);
       $minutes = (int)@$time_array[1] + ((int)@$time_array[0]) * 60;
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle localized fractional hours.
@@ -153,13 +193,13 @@ class ttTimeHelper {
           $duration = str_replace (',', '.', $duration);
 
         $minutes = (int)round(60 * floatval($duration));
-        return $minutes > $max ? false : $minutes;
+        return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle minutes. Some users enter durations like 10m (meaning 10 minutes).
     if (preg_match('/^\d{1,5}m$/', $duration )) { // 0m - 99999m
       $minutes = (int) trim($duration, 'm');
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Everything else is not a valid duration.
@@ -169,22 +209,26 @@ class ttTimeHelper {
   // minutesToDuration converts an integer number of minutes into duration string.
   // Formats returned HH:MM, HHH:MM, HH, or HHH.
   static function minutesToDuration($minutes, $abbreviate = false) {
-    if ($minutes < 0) return false;
+    $sign = $minutes >= 0 ? '' : '-';
+    $minutes = abs($minutes);
 
     $hours = (string) (int)($minutes / 60);
     $mins = (string) round(fmod($minutes, 60));
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
     if ($abbreviate && $mins == '00')
-      return $hours;
+      return $sign.$hours;
 
-    return $hours.':'.$mins;
+    return $sign.$hours.':'.$mins;
   }
 
   // toMinutes - converts a time string in format 00:00 to a number of minutes.
   static function toMinutes($value) {
+    $signMultiplier = ttStartsWith($value, '-') ? -1 : 1;
+    if ($signMultiplier == -1) $value = ltrim($value, '-');
+
     $time_a = explode(':', $value);
-    return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
+    return $signMultiplier * ((int)@$time_a[1] + ((int)@$time_a[0]) * 60);
   }
 
   // toAbsDuration - converts a number of minutes to format 0:00
@@ -552,7 +596,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -574,7 +618,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -596,7 +640,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -799,10 +843,11 @@ class ttTimeHelper {
   }
 
   // getRecords - returns time records for a user for a given date.
-  static function getRecords($user_id, $date) {
+  static function getRecords($date, $includeFiles = false) {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
@@ -814,63 +859,43 @@ class ttTimeHelper {
     if ($user->isPluginEnabled('cl'))
       $client_field = ", c.name as client";
 
-    $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)";
-
-    $result = array();
-    $sql = "select l.id as id, 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, t.name as task, l.comment,".
-      " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field from tt_log l $left_joins".
-      " where l.date = '$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.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;
+    $include_cf_1 = $user->isPluginEnabled('cf');
+    if ($include_cf_1) {
+      $custom_fields = new CustomFields();
+      $cf_1_type = $custom_fields->fields[0]['type'];
+      if ($cf_1_type == CustomFields::TYPE_TEXT) {
+        $custom_field = ", cfl.value as cf_1";
+      } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
+        $custom_field = ", cfo.value as cf_1";
       }
-    } else return false;
-
-    return $result;
-  }
-
-  // getRecordsWithFiles - returns time records for a user for a given date
-  // with information whether they have attached files (has_files property).
-  // A separate fiunction from getRecords because sql here is more complex.
-  static function getRecordsWithFiles($user_id, $date) {
-    global $user;
-    $mdb2 = getConnection();
-
-    $group_id = $user->getGroup();
-    $org_id = $user->org_id;
-
-    $sql_time_format = "'%k:%i'"; //  24 hour format.
-    if ('%I:%M %p' == $user->getTimeFormat())
-      $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
+    }
 
-    $client_field = null;
-    if ($user->isPluginEnabled('cl'))
-      $client_field = ", c.name as client";
+    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'))
       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
-
-    $left_joins .= " 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)";
+    if ($include_cf_1) {
+      if ($cf_1_type == CustomFields::TYPE_TEXT)
+        $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
+      elseif ($cf_1_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)";
+      }
+    }
+    $left_joins .= $fileJoin;
 
     $result = array();
     $sql = "select l.id as id, 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, t.name as task, l.comment,".
-      " if(Sub1.entity_id is null, 0, 1) as has_files,".
-      " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field from tt_log l $left_joins".
+      " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field $custom_field $filePart from tt_log l $left_joins".
       " where l.date = '$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.start, l.id";
     $res = $mdb2->query($sql);