Inserting new cells from already existing week view rows should now work with custom...
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
1 <?php
2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
10 // |
11 // | There are only two ways to violate the license:
12 // |
13 // | 1. To redistribute this code in source form, with the copyright
14 // |    notice or license removed or altered. (Distributing in compiled
15 // |    forms without embedded copyright notices is permitted).
16 // |
17 // | 2. To redistribute modified versions of this code in *any* form
18 // |    that bears insufficient indications that the modifications are
19 // |    not the work of the original author(s).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 import('DateAndTime');
30
31 // The ttTimeHelper is a class to help with time-related values.
32 class ttTimeHelper {
33
34   // isWeekend determines if $date falls on weekend.
35   static function isWeekend($date) {
36     $weekDay = date('w', strtotime($date));
37     return ($weekDay == WEEKEND_START_DAY || $weekDay == (WEEKEND_START_DAY + 1) % 7);
38   }
39
40   // isHoliday determines if $date falls on a holiday.
41   static function isHoliday($date) {
42     global $i18n;
43     // $date is expected as string in DB_DATEFORMAT.
44     $month = date('m', strtotime($date));
45     $day = date('d', strtotime($date));
46     if (in_array($month.'/'.$day, $i18n->holidays))
47       return true;
48
49     return false;
50   }
51
52   // isValidTime validates a value as a time string.
53   static function isValidTime($value) {
54     if (strlen($value)==0 || !isset($value)) return false;
55
56     // 24 hour patterns.
57     if ($value == '24:00' || $value == '2400') return true;
58
59     if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
60       return true;
61     }
62     if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-4])$/', $value )) { // 0 - 24
63       return true;
64     }
65
66     // 12 hour patterns
67     if (preg_match('/^[1-9]\s?(am|AM|pm|PM)$/', $value)) { // 1 - 9 am
68       return true;
69     }
70     if (preg_match('/^(0[1-9]|1[0-2])\s?(am|AM|pm|PM)$/', $value)) { // 01 - 12 am
71       return true;
72     }
73     if (preg_match('/^[1-9]:?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 1:00 - 9:59 am, 100 - 959 am
74       return true;
75     }
76     if (preg_match('/^(0[1-9]|1[0-2]):?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 01:00 - 12:59 am, 0100 - 1259 am
77       return true;
78     }
79
80     return false;
81   }
82
83   // isValidDuration validates a value as a time duration string (in hours and minutes).
84   static function isValidDuration($value) {
85     if (strlen($value)==0 || !isset($value)) return false;
86
87     if ($value == '24:00' || $value == '2400') return true;
88
89     if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
90       return true;
91     }
92     if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
93       return true;
94     }
95
96     global $user;
97     $localizedPattern = '/^([0-1]{0,1}[0-9]|2[0-3])?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
98     if (preg_match($localizedPattern, $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h (or with comma)
99       return true;
100     }
101
102     return false;
103   }
104
105   // normalizeDuration - converts a valid time duration string to format 00:00.
106   static function normalizeDuration($value, $leadingZero = true) {
107     $time_value = $value;
108
109     // If we have a decimal format - convert to time format 00:00.
110     global $user;
111     if ($user->decimal_mark == ',')
112       $time_value = str_replace (',', '.', $time_value);
113
114     if((strpos($time_value, '.') !== false) || (strpos($time_value, 'h') !== false)) {
115       $val = floatval($time_value);
116       $mins = round($val * 60);
117       $hours = (string)((int)($mins / 60));
118       $mins = (string)($mins % 60);
119       if ($leadingZero && strlen($hours) == 1)
120         $hours = '0'.$hours;
121       if (strlen($mins) == 1)
122         $mins = '0' . $mins;
123       return $hours.':'.$mins;
124     }
125
126     $time_a = explode(':', $time_value);
127     $res = '';
128
129     // 0-99
130     if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
131       $hours = $time_a[0];
132       if ($leadingZero && strlen($hours) == 1)
133         $hours = '0'.$hours;
134        return $hours.':00';
135     }
136
137     // 000-2359 (2400)
138     if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) {
139       if (strlen($time_value)==3) $time_value = '0'.$time_value;
140       $hours = substr($time_value,0,2);
141       if ($leadingZero && strlen($hours) == 1)
142         $hours = '0'.$hours;
143       return $hours.':'.substr($time_value,2,2);
144     }
145
146     // 0:00-23:59 (24:00)
147     if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
148       $hours = $time_a[0];
149       if ($leadingZero && strlen($hours) == 1)
150         $hours = '0'.$hours;
151       return $hours.':'.$time_a[1];
152     }
153
154     return $res;
155   }
156
157   // toMinutes - converts a time string in format 00:00 to a number of minutes.
158   static function toMinutes($value) {
159     $time_a = explode(':', $value);
160     return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
161   }
162
163   // toAbsDuration - converts a number of minutes to format 0:00
164   // even if $minutes is negative.
165   static function toAbsDuration($minutes){
166     $hours = (string)((int)abs($minutes / 60));
167     $mins = (string)(abs($minutes % 60));
168     if (strlen($mins) == 1)
169       $mins = '0' . $mins;
170     return $hours.':'.$mins;
171   }
172
173   // toDuration - calculates duration between start and finish times in 00:00 format.
174   static function toDuration($start, $finish) {
175     $duration_minutes = ttTimeHelper::toMinutes($finish) - ttTimeHelper::toMinutes($start);
176     if ($duration_minutes <= 0) return false;
177
178     return ttTimeHelper::toAbsDuration($duration_minutes);
179   }
180
181   // The to12HourFormat function converts a 24-hour time value (such as 15:23) to 12 hour format (03:23 PM).
182   static function to12HourFormat($value) {
183     if ('24:00' == $value) return '12:00 AM';
184
185     $time_a = explode(':', $value);
186     if ($time_a[0] > 12)
187       $res = (string)((int)$time_a[0] - 12).':'.$time_a[1].' PM';
188     elseif ($time_a[0] == 12)
189       $res = $value.' PM';
190     elseif ($time_a[0] == 0)
191       $res = '12:'.$time_a[1].' AM';
192     else
193       $res = $value.' AM';
194     return $res;
195   }
196
197   // The to24HourFormat function attempts to convert a string value (human readable notation of time of day)
198   // to a 24-hour time format HH:MM.
199   static function to24HourFormat($value) {
200     $res = null;
201
202     // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
203     $tmp_val = trim($value);
204
205     // 24 hour patterns.
206     if (preg_match('/^([01][0-9]|2[0-3]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 23:59
207       // We already have a 24-hour format. Just return it.
208       $res = $tmp_val;
209       return $res;
210     }
211     if (preg_match('/^[0-9]:[0-5][0-9]$/', $tmp_val)) { // 0:00 - 9:59
212       // This is a 24-hour format without a leading zero. Add 0 and return.
213       $res = '0'.$tmp_val;
214       return $res;
215     }
216     if (preg_match('/^[0-9]$/', $tmp_val)) { // 0 - 9
217       // Single digit. Assuming hour number.
218       $res = '0'.$tmp_val.':00';
219       return $res;
220     }
221     if (preg_match('/^([01][0-9]|2[0-4])$/', $tmp_val)) { // 00 - 24
222       // Two digit hour number.
223       $res = $tmp_val.':00';
224       return $res;
225     }
226     if (preg_match('/^[0-9][0-5][0-9]$/', $tmp_val)) { // 000 - 959
227       // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
228       $tmp_arr = str_split($tmp_val);
229       $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
230       return $res;
231     }
232     if (preg_match('/^([01][0-9]|2[0-3])[0-5][0-9]$/', $tmp_val)) { // 0000 - 2359
233       // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
234       $tmp_arr = str_split($tmp_val);
235       $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
236       return $res;
237     }
238     // Special handling for midnight.
239     if ($tmp_val == '24:00' || $tmp_val == '2400')
240       return '24:00';
241
242     // 12 hour AM patterns.
243     if (preg_match('/.(am|AM)$/', $tmp_val)) {
244
245       // The $value ends in am or AM. Strip it.
246       $tmp_val = rtrim(substr($tmp_val, 0, -2));
247
248       // Special case to handle 12, 12:MM, and 12MM AM.
249       if (preg_match('/^12:?([0-5][0-9])?$/', $tmp_val))
250         $tmp_val = '00'.substr($tmp_val, 2);
251
252       // We are ready to convert AM time.
253       if (preg_match('/^(0[0-9]|1[0-1]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 11:59
254         // We already have a 24-hour format. Just return it.
255         $res = $tmp_val;
256         return $res;
257       }
258       if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
259         // This is a 24-hour format without a leading zero. Add 0 and return.
260         $res = '0'.$tmp_val;
261         return $res;
262       }
263       if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
264         // Single digit. Assuming hour number.
265         $res = '0'.$tmp_val.':00';
266         return $res;
267       }
268       if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
269         // Two digit hour number.
270         $res = $tmp_val.':00';
271         return $res;
272       }
273       if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
274         // Missing colon. Assume the first digit is the hour, the rest is minutes.
275         $tmp_arr = str_split($tmp_val);
276         $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
277         return $res;
278       }
279       if (preg_match('/^(0[0-9]|1[0-1])[0-5][0-9]$/', $tmp_val)) { // 0000 - 1159
280         // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
281         $tmp_arr = str_split($tmp_val);
282         $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
283         return $res;
284       }
285     } // AM cases handling.
286
287     // 12 hour PM patterns.
288     if (preg_match('/.(pm|PM)$/', $tmp_val)) {
289
290       // The $value ends in pm or PM. Strip it.
291       $tmp_val = rtrim(substr($tmp_val, 0, -2));
292
293       if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
294         // Single digit. Assuming hour number.
295         $hour = (string)(12 + (int)$tmp_val);
296         $res = $hour.':00';
297         return $res;
298       }
299       if (preg_match('/^((0[1-9])|(1[0-2]))$/', $tmp_val)) { // 01 - 12
300         // Double digit hour.
301         if ('12' != $tmp_val)
302           $tmp_val = (string)(12 + (int)$tmp_val);
303         $res = $tmp_val.':00';
304         return $res;
305       }
306       if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
307         // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
308         $tmp_arr = str_split($tmp_val);
309         $hour = (string)(12 + (int)$tmp_arr[0]);
310         $res = $hour.':'.$tmp_arr[1].$tmp_arr[2];
311         return $res;
312       }
313       if (preg_match('/^(0[1-9]|1[0-2])[0-5][0-9]$/', $tmp_val)) { // 0100 - 1259
314         // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
315         $hour = substr($tmp_val, 0, -2);
316         $min = substr($tmp_val, 2);
317         if ('12' != $hour)
318           $hour = (string)(12 + (int)$hour);
319         $res = $hour.':'.$min;
320         return $res;
321       }
322       if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
323         $hour = substr($tmp_val, 0, -3);
324         $min = substr($tmp_val, 2);
325         $hour = (string)(12 + (int)$hour);
326         $res = $hour.':'.$min;
327         return $res;
328       }
329       if (preg_match('/^(0[1-9]|1[0-2]):[0-5][0-9]$/', $tmp_val)) { // 01:00 - 12:59
330         $hour = substr($tmp_val, 0, -3);
331         $min = substr($tmp_val, 3);
332         if ('12' != $hour)
333           $hour = (string)(12 + (int)$hour);
334         $res = $hour.':'.$min;
335         return $res;
336       }
337     } // PM cases handling.
338
339     return $res;
340   }
341
342   // isValidInterval - checks if finish time is greater than start time.
343   static function isValidInterval($start, $finish) {
344     $start = ttTimeHelper::to24HourFormat($start);
345     $finish = ttTimeHelper::to24HourFormat($finish);
346     if ('00:00' == $finish) $finish = '24:00';
347
348     $minutesStart = ttTimeHelper::toMinutes($start);
349     $minutesFinish = ttTimeHelper::toMinutes($finish);
350     if ($minutesFinish > $minutesStart)
351       return true;
352
353     return false;
354   }
355
356   // insert - inserts a time record into log table. Does not deal with custom fields.
357   static function insert($fields)
358   {
359     $mdb2 = getConnection();
360
361     $timestamp = isset($fields['timestamp']) ? $fields['timestamp'] : '';
362     $user_id = $fields['user_id'];
363     $date = $fields['date'];
364     $start = $fields['start'];
365     $finish = $fields['finish'];
366     $duration = $fields['duration'];
367     $client = $fields['client'];
368     $project = $fields['project'];
369     $task = $fields['task'];
370     $invoice = $fields['invoice'];
371     $note = $fields['note'];
372     $billable = $fields['billable'];
373     if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
374       $status_f = ', status';
375       $status_v = ', '.$mdb2->quote($fields['status']);
376     }
377
378     $start = ttTimeHelper::to24HourFormat($start);
379     if ($finish) {
380       $finish = ttTimeHelper::to24HourFormat($finish);
381       if ('00:00' == $finish) $finish = '24:00';
382     }
383     $duration = ttTimeHelper::normalizeDuration($duration);
384
385     if (!$timestamp) {
386       $timestamp = date('YmdHis'); //yyyymmddhhmmss
387       // TODO: this timestamp could be illegal if we hit inside DST switch deadzone, such as '2016-03-13 02:30:00'
388       // Anything between 2am and 3am on DST introduction date will not work if we run on a system with DST on.
389       // We need to address this properly to avoid potential complications.
390     }
391
392     if (!$billable) $billable = 0;
393
394     if ($duration) {
395       $sql = "insert into tt_log (timestamp, user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
396         "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)";
397       $affected = $mdb2->exec($sql);
398       if (is_a($affected, 'PEAR_Error'))
399         return false;
400     } else {
401       $duration = ttTimeHelper::toDuration($start, $finish);
402       if ($duration === false) $duration = 0;
403       if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
404
405       $sql = "insert into tt_log (timestamp, user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
406         "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)";
407       $affected = $mdb2->exec($sql);
408       if (is_a($affected, 'PEAR_Error'))
409         return false;
410     }
411
412     $id = $mdb2->lastInsertID('tt_log', 'id');
413     return $id;
414   }
415
416   // update - updates a record in log table. Does not update its custom fields.
417   static function update($fields)
418   {
419     $mdb2 = getConnection();
420
421     $id = $fields['id'];
422     $date = $fields['date'];
423     $user_id = $fields['user_id'];
424     $client = $fields['client'];
425     $project = $fields['project'];
426     $task = $fields['task'];
427     $start = $fields['start'];
428     $finish = $fields['finish'];
429     $duration = $fields['duration'];
430     $note = $fields['note'];
431     $billable = $fields['billable'];
432
433     $start = ttTimeHelper::to24HourFormat($start);
434     $finish = ttTimeHelper::to24HourFormat($finish);
435     if ('00:00' == $finish) $finish = '24:00';
436     $duration = ttTimeHelper::normalizeDuration($duration);
437
438     if (!$billable) $billable = 0;
439     if ($start) $duration = '';
440
441     if ($duration) {
442       $sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
443         "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
444       $affected = $mdb2->exec($sql);
445       if (is_a($affected, 'PEAR_Error'))
446         return false;
447     } else {
448       $duration = ttTimeHelper::toDuration($start, $finish);
449       if ($duration === false)
450         $duration = 0;
451       $uncompleted = ttTimeHelper::getUncompleted($user_id);
452       if (!$duration && $uncompleted && ($uncompleted['id'] != $id))
453         return false;
454
455       $sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
456         "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
457       $affected = $mdb2->exec($sql);
458       if (is_a($affected, 'PEAR_Error'))
459         return false;
460     }
461     return true;
462   }
463
464   // delete - deletes a record from tt_log table and its associated custom field values.
465   static function delete($id, $user_id) {
466     $mdb2 = getConnection();
467
468     $sql = "update tt_log set status = NULL where id = $id and user_id = $user_id";
469     $affected = $mdb2->exec($sql);
470     if (is_a($affected, 'PEAR_Error'))
471       return false;
472
473     $sql = "update tt_custom_field_log set status = NULL where log_id = $id";
474     $affected = $mdb2->exec($sql);
475     if (is_a($affected, 'PEAR_Error'))
476       return false;
477
478     return true;
479   }
480
481   // getTimeForDay - gets total time for a user for a specific date.
482   static function getTimeForDay($user_id, $date) {
483     $mdb2 = getConnection();
484
485     $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date = '$date' and status = 1";
486     $res = $mdb2->query($sql);
487     if (!is_a($res, 'PEAR_Error')) {
488       $val = $res->fetchRow();
489       return sec_to_time_fmt_hm($val['sm']);
490     }
491     return false;
492   }
493
494   // getTimeForWeek - gets total time for a user for a given week.
495   static function getTimeForWeek($user_id, $date) {
496     import('Period');
497     $mdb2 = getConnection();
498
499     $period = new Period(INTERVAL_THIS_WEEK, $date);
500     $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
501     $res = $mdb2->query($sql);
502     if (!is_a($res, 'PEAR_Error')) {
503       $val = $res->fetchRow();
504       return sec_to_time_fmt_hm($val['sm']);
505     }
506     return 0;
507   }
508
509   // getTimeForMonth - gets total time for a user for a given month.
510   static function getTimeForMonth($user_id, $date){
511     import('Period');
512     $mdb2 = getConnection();
513
514     $period = new Period(INTERVAL_THIS_MONTH, $date);
515     $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
516     $res = $mdb2->query($sql);
517     if (!is_a($res, 'PEAR_Error')) {
518       $val = $res->fetchRow();
519       return sec_to_time_fmt_hm($val['sm']);
520     }
521     return 0;
522   }
523
524   // getUncompleted - retrieves an uncompleted record for user, if one exists.
525   static function getUncompleted($user_id) {
526     $mdb2 = getConnection();
527
528     $sql = "select id, start from tt_log  
529       where user_id = $user_id and start is not null and time_to_sec(duration) = 0 and status = 1";
530     $res = $mdb2->query($sql);
531     if (!is_a($res, 'PEAR_Error')) {
532       if (!$res->numRows()) {
533         return false;
534       }
535       if ($val = $res->fetchRow()) {
536         return $val;
537       }
538     }
539     return false;
540   }
541
542   // overlaps - determines if a record overlaps with an already existing record.
543   //
544   // Parameters:
545   //   $user_id - user id for whom to determine overlap
546   //   $date - date
547   //   $start - new record start time
548   //   $finish - new record finish time, may be null
549   //   $record_id - optional record id we may be editing, excluded from overlap set
550   static function overlaps($user_id, $date, $start, $finish, $record_id = null) {
551     // Do not bother checking if we allow overlaps.
552     if (defined('ALLOW_OVERLAP') && ALLOW_OVERLAP == true)
553       return false;
554
555     $mdb2 = getConnection();
556
557     $start = ttTimeHelper::to24HourFormat($start);
558     if ($finish) {
559       $finish = ttTimeHelper::to24HourFormat($finish);
560       if ('00:00' == $finish) $finish = '24:00';
561     }
562     // Handle these 3 overlap situations:
563     // - start time in existing record
564     // - end time in existing record
565     // - record fully encloses existing record
566     $sql = "select id from tt_log  
567       where user_id = $user_id and date = ".$mdb2->quote($date)."
568       and start is not null and duration is not null and status = 1 and (
569       (cast(".$mdb2->quote($start)." as time) >= start and cast(".$mdb2->quote($start)." as time) < addtime(start, duration))";
570     if ($finish) {
571       $sql .= " or (cast(".$mdb2->quote($finish)." as time) <= addtime(start, duration) and cast(".$mdb2->quote($finish)." as time) > start)
572       or (cast(".$mdb2->quote($start)." as time) < start and cast(".$mdb2->quote($finish)." as time) > addtime(start, duration))";
573     }
574     $sql .= ")";
575     if ($record_id) {
576       $sql .= " and id <> $record_id";
577     }
578     $res = $mdb2->query($sql);
579     if (!is_a($res, 'PEAR_Error')) {
580       if (!$res->numRows()) {
581         return false;
582       }
583       if ($val = $res->fetchRow()) {
584         return $val;
585       }
586     }
587     return false;
588   }
589
590   // getRecord - retrieves a time record identified by its id.
591   static function getRecord($id, $user_id) {
592     global $user;
593     $sql_time_format = "'%k:%i'"; //  24 hour format.
594     if ('%I:%M %p' == $user->time_format)
595       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
596
597     $mdb2 = getConnection();
598
599     $sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
600       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
601       TIME_FORMAT(l.duration, '%k:%i') as duration,
602       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
603       from tt_log l
604       left join tt_projects p on (p.id = l.project_id)
605       left join tt_tasks t on (t.id = l.task_id)
606       where l.id = $id and l.user_id = $user_id and l.status = 1";
607     $res = $mdb2->query($sql);
608     if (!is_a($res, 'PEAR_Error')) {
609       if (!$res->numRows()) {
610         return false;
611       }
612       if ($val = $res->fetchRow()) {
613         return $val;
614       }
615     }
616     return false;
617   }
618
619   // getAllRecords - returns all time records for a certain user.
620   static function getAllRecords($user_id) {
621     $result = array();
622
623     $mdb2 = getConnection();
624
625     $sql = "select l.id, l.timestamp, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
626       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
627       TIME_FORMAT(l.duration, '%k:%i') as duration,
628       l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.status
629       from tt_log l where l.user_id = $user_id order by l.id";
630     $res = $mdb2->query($sql);
631     if (!is_a($res, 'PEAR_Error')) {
632       while ($val = $res->fetchRow()) {
633         $result[] = $val;
634       }
635     } else return false;
636
637     return $result;
638   }
639
640   // getRecords - returns time records for a user for a given date.
641   static function getRecords($user_id, $date) {
642     global $user;
643     $sql_time_format = "'%k:%i'"; //  24 hour format.
644     if ('%I:%M %p' == $user->time_format)
645       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
646
647     $result = array();
648     $mdb2 = getConnection();
649
650     $client_field = null;
651     if ($user->isPluginEnabled('cl'))
652       $client_field = ", c.name as client";
653
654     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
655       " left join tt_tasks t on (l.task_id = t.id)";
656     if ($user->isPluginEnabled('cl'))
657       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
658
659     $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
660       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
661       TIME_FORMAT(l.duration, '%k:%i') as duration, p.name as project, t.name as task, l.comment, l.billable, l.invoice_id $client_field
662       from tt_log l
663       $left_joins
664       where l.date = '$date' and l.user_id = $user_id and l.status = 1
665       order by l.start, l.id";
666     $res = $mdb2->query($sql);
667     if (!is_a($res, 'PEAR_Error')) {
668       while ($val = $res->fetchRow()) {
669         if($val['duration']=='0:00')
670           $val['finish'] = '';
671         $result[] = $val;
672       }
673     } else return false;
674
675     return $result;
676   }
677
678   // getRecordsForInterval - returns time records for a user for a given interval of dates.
679   static function getRecordsForInterval($user_id, $start_date, $end_date) {
680     global $user;
681     $sql_time_format = "'%k:%i'"; //  24 hour format.
682     if ('%I:%M %p' == $user->time_format)
683       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
684
685     $result = array();
686     $mdb2 = getConnection();
687
688     $client_field = null;
689     if ($user->isPluginEnabled('cl'))
690       $client_field = ', c.id as client_id, c.name as client';
691
692     $custom_field_1 = null;
693     if ($user->isPluginEnabled('cf')) {
694       $custom_fields = new CustomFields($user->team_id);
695       $cf_1_type = $custom_fields->fields[0]['type'];
696       if ($cf_1_type == CustomFields::TYPE_TEXT) {
697         $custom_field_1 = ', cfl.value as cf_1_value';
698       } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
699         $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
700       }
701     }
702
703     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
704       " left join tt_tasks t on (l.task_id = t.id)";
705     if ($user->isPluginEnabled('cl'))
706       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
707     if ($user->isPluginEnabled('cf')) {
708       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
709         $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) ';
710       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
711         $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) ';
712     }
713
714     $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
715       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
716       TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
717       t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
718       from tt_log l
719       $left_joins
720       where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
721       order by p.name, t.name, l.date, l.start, l.id";
722     $res = $mdb2->query($sql);
723     if (!is_a($res, 'PEAR_Error')) {
724       while ($val = $res->fetchRow()) {
725         if($val['duration']=='0:00')
726           $val['finish'] = '';
727         $result[] = $val;
728       }
729     } else return false;
730
731     return $result;
732   }
733
734   // getDataForWeekView - builds an array to render a table of durations for week view.
735   // In a week view we want one row representing the same attributes to have 7 values for each day of week.
736   // We identify simlar records by a combination of client, billable, project, task, and custom field values.
737   // This will allow us to extend the feature when more custom fields are added.
738   //
739   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
740   // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
741   //
742   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
743   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
744   //
745   // Description of $dataArray format that the function returns.
746   // $dataArray = array(
747   //   array( // Row 0.
748   //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
749   //     'label' => 'Anuko - Time Tracker - Coding',              // Human readable label for the row describing what this time entry is for.
750   //     'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
751   //     'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
752   //     'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
753   //     'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
754   //     'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
755   //     'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
756   //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
757   //   ),
758   //   array( // Row 1.
759   //     'row_id' => 'bl:0_0',
760   //     'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
761   //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'duration' => null),
762   //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
763   //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'duration' => null),
764   //     'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
765   //     'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
766   //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'duration' => null),
767   //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
768   //   )
769   // );
770   static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
771     // Start by obtaining all records in interval.
772     $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
773
774     $dataArray = array();
775
776     // Iterate through records and build $dataArray cell by cell.
777     foreach ($records as $record) {
778       // Create record id without suffix.
779       $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
780       // Handle potential multiple records with the same attributes by using a numerical suffix.
781       $suffix = 0;
782       $record_id = $record_id_no_suffix.'_'.$suffix;
783       $day_header = substr($record['date'], 8); // Day number in month.
784       while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
785         $suffix++;
786         $record_id = $record_id_no_suffix.'_'.$suffix;
787       }
788       // Find row.
789       $pos = ttTimeHelper::findRow($record_id, $dataArray);
790       if ($pos < 0) {
791         $dataArray[] = array('row_id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
792         $pos = ttTimeHelper::findRow($record_id, $dataArray);
793         // Insert empty cells with proper control ids.
794         for ($i = 0; $i < 7; $i++) {
795           $control_id = $pos.'_'. $dayHeaders[$i];
796           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
797         }
798       }
799       // Insert actual cell data from $record (one cell only).
800       $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
801     }
802     return $dataArray;
803   }
804
805   // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
806   // and a day header already exists.
807   static function cellExists($row_id, $day_header, $dataArray) {
808     foreach($dataArray as $row) {
809       if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
810         return true;
811     }
812     return false;
813   }
814
815   // findRow returns an existing row position in $dataArray, -1 otherwise.
816   static function findRow($row_id, $dataArray) {
817     $pos = 0; // Row position in array.
818     foreach($dataArray as $row) {
819       if ($row['row_id'] == $row_id)
820         return $pos;
821       $pos++; // Increment for search.
822     }
823     return -1; // Row not found.
824   }
825
826   // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
827   // For example:
828   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
829   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
830   // See comment for getGroupedRecordsForInterval.
831   static function makeRecordIdentifier($record) {
832     global $user;
833     // Start with client.
834     if ($user->isPluginEnabled('cl'))
835       $record_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
836     // Add billable flag.
837     if (!empty($record_identifier)) $record_identifier .= ',';
838     $record_identifier .= 'bl:'.$record['billable'];
839     // Add project.
840     $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
841     // Add task.
842     $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
843     // Add custom field 1. This requires modifying the query to get the data we need.
844     if ($user->isPluginEnabled('cf')) {
845       if ($record['cf_1_id'])
846         $record_identifier .= ',cf_1:'.$record['cf_1_id'];
847       else if ($record['cf_1_value'])
848         $record_identifier .= ',cf_1:'.$record['cf_1_value'];
849     }
850
851     return $record_identifier;
852   }
853
854   // parseFromWeekViewRow - obtains field value encoded in row identifier.
855   // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
856   // requesting a client "cl" should return 546.
857   static function parseFromWeekViewRow($row_id, $field_label) {
858     // Find beginning of label.
859     $pos = strpos($row_id, $field_label);
860     if ($pos === false) return null; // Not found.
861
862     // Strip suffix from row id.
863     $suffixPos = strrpos($row_id, '_');
864     if ($suffixPos)
865       $remaninder = substr($row_id, 0, $suffixPos);
866
867     // Find beginning of value.
868     $posBegin = 1 + strpos($remaninder, ':', $pos);
869     // Find end of value.
870     $posEnd = strpos($remaninder, ',', $posBegin);
871     if ($posEnd === false) $posEnd = strlen($remaninder);
872     // Return value.
873     return substr($remaninder, $posBegin, $posEnd - $posBegin);
874   }
875
876   // makeRecordLabel - builds a human readable label for a row in week view,
877   // which is a combination ot record properties.
878   // Client - Project - Task - Custom field 1.
879   // Note that billable property is not part of the label. Instead, we intend to
880   // identify such records with a different color in week view.
881   static function makeRecordLabel($record) {
882     global $user;
883     // Start with client.
884     if ($user->isPluginEnabled('cl'))
885       $label = $record['client'];
886
887     // Add project.
888     if (!empty($label) && !empty($record['project'])) $label .= ' - ';
889     $label .= $record['project'];
890
891     // Add task.
892     if (!empty($label) && !empty($record['task'])) $label .= ' - ';
893     $label .= $record['task'];
894
895     // Add custom field 1.
896     if ($user->isPluginEnabled('cf')) {
897       if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
898       $label .= $record['cf_1_value'];
899     }
900
901     return $label;
902   }
903
904   // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
905   static function getDayHeadersForWeek($start_date) {
906     $dayHeaders = array();
907     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
908     $dayHeaders[] = (string) $objDate->getDate(); // It returns an int on first call.
909     if (strlen($dayHeaders[0]) == 1)              // Which is an implementation detail of DateAndTime class.
910       $dayHeaders[0] = '0'.$dayHeaders[0];        // Add a 0 for single digit day.
911     $objDate->incDay();
912     $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
913     $objDate->incDay();
914     $dayHeaders[] = $objDate->getDate();
915     $objDate->incDay();
916     $dayHeaders[] = $objDate->getDate();
917     $objDate->incDay();
918     $dayHeaders[] = $objDate->getDate();
919     $objDate->incDay();
920     $dayHeaders[] = $objDate->getDate();
921     $objDate->incDay();
922     $dayHeaders[] = $objDate->getDate();
923     unset($objDate);
924     return $dayHeaders;
925   }
926
927     // getLockedDaysForWeek - builds an array of locked days in week.
928   static function getLockedDaysForWeek($start_date) {
929     global $user;
930     $lockedDays = array();
931     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
932     for ($i = 0; $i < 7; $i++) {
933       $lockedDays[] = $user->isDateLocked($objDate);
934       $objDate->incDay();
935     }
936     unset($objDate);
937     return $lockedDays;
938   }
939
940   // getDayTotals calculates total durations for each day from the existing data in $dataArray.
941   static function getDayTotals($dataArray, $dayHeaders) {
942     $dayTotals = array();
943
944     // Insert label.
945     global $i18n;
946     $dayTotals['label'] = $i18n->getKey('label.total');
947
948     foreach ($dataArray as $row) {
949       foreach($dayHeaders as $dayHeader) {
950         if (array_key_exists($dayHeader, $row)) {
951           $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
952           $dayTotals[$dayHeader] += $minutes;
953         }
954       }
955     }
956     // Convert minutes to hh:mm for display.
957     foreach($dayHeaders as $dayHeader) {
958       $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
959     }
960     return $dayTotals;
961   }
962
963   // dateFromDayHeader calculates date from start date and day header in week view.
964   static function dateFromDayHeader($start_date, $day_header) {
965     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
966     $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
967     if (strlen($currentDayHeader) == 1)               // Which is an implementation detail of DateAndTime class.
968       $currentDayHeader = '0'.$currentDayHeader;      // Add a 0 for single digit day.
969     $i = 1;
970     while ($currentDayHeader != $day_header && $i < 7) {
971       // Iterate through remaining days to find a match.
972       $objDate->incDay();
973       $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
974       $i++;
975     }
976     return $objDate->toString(DB_DATEFORMAT);
977   }
978
979   // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
980   static function insertDurationFromWeekView($fields, $custom_fields, $err) {
981     global $i18n;
982     global $user;
983
984     // Determine date for a new entry.
985     $entry_date = ttTimeHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
986     $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
987
988     // Prohibit creating entries in future.
989     if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
990       $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
991       if ($objEntryDate->after($objBrowserToday)) {
992         $err->add($i18n->getKey('error.future_date'));
993         return false;
994       }
995     }
996
997     // Prepare an array of fields for regular insert function.
998     $fields4insert = array();
999     $fields4insert['user_id'] = $user->getActiveUser();
1000     $fields4insert['date'] = $entry_date;
1001     $fields4insert['duration'] = $fields['duration'];
1002     $fields4insert['client'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
1003     $fields4insert['billable'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
1004     $fields4insert['project'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
1005     $fields4insert['task'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
1006
1007     // Try to insert a record.
1008     $id = ttTimeHelper::insert($fields4insert);
1009     if (!$id) return false; // Something failed.
1010
1011     // Insert custom field if we have it.
1012     $result = true;
1013     $cf_1 = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
1014     if ($custom_fields && $cf_1) {
1015       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
1016         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
1017       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
1018         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
1019     }
1020
1021     return $result;
1022   }
1023
1024
1025   // modifyFromWeekView - modifies a duration of an existing record from a week view post.
1026   static function modifyDurationFromWeekView($fields, $err) {
1027
1028     // Possible error conditions. Overlap? What else?
1029
1030     $err->add("Week view is work in progress. Editing records is not yet implemented. Try deleting and then inserting a record instead.");
1031     return false;
1032
1033   // static function modifyDurationFromWeekView($tt_log_id, $new_duration, $user_id) {
1034
1035     // TODO: handle overlaps and potential other error conditions such as going beyond 24 hr mark. Other errors?
1036     // If the entry has start time, check if new duration goes beyond the existing day.
1037
1038     // Future entries. Possibly do this check out of this function.
1039     /*
1040      *     // Prohibit creating entries in future.
1041     if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES)) {
1042       $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
1043       if ($selected_date->after($browser_today))
1044         $err->add($i18n->getKey('error.future_date'));
1045     }
1046      */
1047
1048     /*
1049      *     // Prohibit creating an overlapping record.
1050     if ($err->no()) {
1051       if (ttTimeHelper::overlaps($user->getActiveUser(), $cl_date, $cl_start, $cl_finish))
1052         $err->add($i18n->getKey('error.overlap'));
1053     }
1054      */
1055
1056     $mdb2 = getConnection();
1057
1058     $sql = "update tt_log set duration = '$new_duration' where id = $tt_log_id and user_id = $user_id";
1059     $affected = $mdb2->exec($sql);
1060     if (is_a($affected, 'PEAR_Error'))
1061       return false;
1062
1063     return true;
1064   }
1065 }
1066