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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 import('DateAndTime');
31 // The ttTimeHelper is a class to help with time-related values.
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);
40 // isValidTime validates a value as a time string.
41 static function isValidTime($value) {
42 if (strlen($value)==0 || !isset($value)) return false;
45 if ($value == '24:00' || $value == '2400') return true;
47 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
50 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-4])$/', $value )) { // 0 - 24
55 if (preg_match('/^[1-9]\s?(am|AM|pm|PM)$/', $value)) { // 1 - 9 am
58 if (preg_match('/^(0[1-9]|1[0-2])\s?(am|AM|pm|PM)$/', $value)) { // 01 - 12 am
61 if (preg_match('/^[1-9]:?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 1:00 - 9:59 am, 100 - 959 am
64 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
71 // isValidDuration validates a value as a time duration string (in hours and minutes).
72 static function isValidDuration($value) {
73 if (strlen($value)==0 || !isset($value)) return false;
75 if ($value == '24:00' || $value == '2400') return true;
77 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
78 if ('00:00' == ttTimeHelper::normalizeDuration($value))
82 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
83 if ('00:00' == ttTimeHelper::normalizeDuration($value))
87 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3])?[.][0-9]{1,4}h?$/', $value )) { // Decimal values like 0.5, 1.25h, ... .. 23.9999h
88 if ('00:00' == ttTimeHelper::normalizeDuration($value))
95 // normalizeDuration - converts a valid time duration string to format 00:00.
96 static function normalizeDuration($value) {
99 // If we have a decimal format - convert to time format 00:00.
100 if((strpos($time_value, '.') !== false) || (strpos($time_value, 'h') !== false)) {
101 $val = floatval($time_value);
102 $mins = round($val * 60);
103 $hours = (string)((int)($mins / 60));
104 $mins = (string)($mins % 60);
105 if (strlen($hours) == 1)
107 if (strlen($mins) == 1)
109 return $hours.':'.$mins;
112 $time_a = explode(':', $time_value);
116 if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
118 if (strlen($hours) == 1)
124 if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) {
125 if (strlen($time_value)==3) $time_value = '0'.$time_value;
126 $hours = substr($time_value,0,2);
127 if (strlen($hours) == 1)
129 return $hours.':'.substr($time_value,2,2);
132 // 0:00-23:59 (24:00)
133 if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
135 if (strlen($hours) == 1)
137 return $hours.':'.$time_a[1];
143 // toMinutes - converts a time string in format 00:00 to a number of minutes.
144 static function toMinutes($value) {
145 $time_a = explode(':', $value);
146 return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
149 // toDuration - calculates duration between start and finish times in 00:00 format.
150 static function toDuration($start, $finish) {
151 $duration_minutes = ttTimeHelper::toMinutes($finish) - ttTimeHelper::toMinutes($start);
152 if ($duration_minutes <= 0) return false;
154 $hours = (string)((int)($duration_minutes / 60));
155 $mins = (string)($duration_minutes % 60);
156 if (strlen($hours) == 1)
158 if (strlen($mins) == 1)
160 return $hours.':'.$mins;
163 // The to12HourFormat function converts a 24-hour time value (such as 15:23) to 12 hour format (03:23 PM).
164 static function to12HourFormat($value) {
165 if ('24:00' == $value) return '12:00 AM';
167 $time_a = explode(':', $value);
169 $res = (string)((int)$time_a[0] - 12).':'.$time_a[1].' PM';
170 else if ($time_a[0] == 12)
172 else if ($time_a[0] == 0)
173 $res = '12:'.$time_a[1].' AM';
179 // The to24HourFormat function attempts to convert a string value (human readable notation of time of day)
180 // to a 24-hour time format HH:MM.
181 static function to24HourFormat($value) {
184 // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
185 $tmp_val = trim($value);
188 if (preg_match('/^([01][0-9]|2[0-3]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 23:59
189 // We already have a 24-hour format. Just return it.
193 if (preg_match('/^[0-9]:[0-5][0-9]$/', $tmp_val)) { // 0:00 - 9:59
194 // This is a 24-hour format without a leading zero. Add 0 and return.
198 if (preg_match('/^[0-9]$/', $tmp_val)) { // 0 - 9
199 // Single digit. Assuming hour number.
200 $res = '0'.$tmp_val.':00';
203 if (preg_match('/^([01][0-9]|2[0-4])$/', $tmp_val)) { // 00 - 24
204 // Two digit hour number.
205 $res = $tmp_val.':00';
208 if (preg_match('/^[0-9][0-5][0-9]$/', $tmp_val)) { // 000 - 959
209 // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
210 $tmp_arr = str_split($tmp_val);
211 $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
214 if (preg_match('/^([01][0-9]|2[0-3])[0-5][0-9]$/', $tmp_val)) { // 0000 - 2359
215 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
216 $tmp_arr = str_split($tmp_val);
217 $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
220 // Special handling for midnight.
221 if ($tmp_val == '24:00' || $tmp_val == '2400')
224 // 12 hour AM patterns.
225 if (preg_match('/.(am|AM)$/', $tmp_val)) {
227 // The $value ends in am or AM. Strip it.
228 $tmp_val = rtrim(substr($tmp_val, 0, -2));
230 // Special case to handle 12, 12:MM, and 12MM AM.
231 if (preg_match('/^12:?([0-5][0-9])?$/', $tmp_val))
232 $tmp_val = '00'.substr($tmp_val, 2);
234 // We are ready to convert AM time.
235 if (preg_match('/^(0[0-9]|1[0-1]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 11:59
236 // We already have a 24-hour format. Just return it.
240 if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
241 // This is a 24-hour format without a leading zero. Add 0 and return.
245 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
246 // Single digit. Assuming hour number.
247 $res = '0'.$tmp_val.':00';
250 if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
251 // Two digit hour number.
252 $res = $tmp_val.':00';
255 if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
256 // Missing colon. Assume the first digit is the hour, the rest is minutes.
257 $tmp_arr = str_split($tmp_val);
258 $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
261 if (preg_match('/^(0[0-9]|1[0-1])[0-5][0-9]$/', $tmp_val)) { // 0000 - 1159
262 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
263 $tmp_arr = str_split($tmp_val);
264 $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
267 } // AM cases handling.
269 // 12 hour PM patterns.
270 if (preg_match('/.(pm|PM)$/', $tmp_val)) {
272 // The $value ends in pm or PM. Strip it.
273 $tmp_val = rtrim(substr($tmp_val, 0, -2));
275 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
276 // Single digit. Assuming hour number.
277 $hour = (string)(12 + (int)$tmp_val);
281 if (preg_match('/^((0[1-9])|(1[0-2]))$/', $tmp_val)) { // 01 - 12
282 // Double digit hour.
283 if ('12' != $tmp_val)
284 $tmp_val = (string)(12 + (int)$tmp_val);
285 $res = $tmp_val.':00';
288 if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
289 // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
290 $tmp_arr = str_split($tmp_val);
291 $hour = (string)(12 + (int)$tmp_arr[0]);
292 $res = $hour.':'.$tmp_arr[1].$tmp_arr[2];
295 if (preg_match('/^(0[1-9]|1[0-2])[0-5][0-9]$/', $tmp_val)) { // 0100 - 1259
296 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
297 $hour = substr($tmp_val, 0, -2);
298 $min = substr($tmp_val, 2);
300 $hour = (string)(12 + (int)$hour);
301 $res = $hour.':'.$min;
304 if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
305 $hour = substr($tmp_val, 0, -3);
306 $min = substr($tmp_val, 2);
307 $hour = (string)(12 + (int)$hour);
308 $res = $hour.':'.$min;
311 if (preg_match('/^(0[1-9]|1[0-2]):[0-5][0-9]$/', $tmp_val)) { // 01:00 - 12:59
312 $hour = substr($tmp_val, 0, -3);
313 $min = substr($tmp_val, 3);
315 $hour = (string)(12 + (int)$hour);
316 $res = $hour.':'.$min;
319 } // PM cases handling.
324 // isValidInterval - checks if finish time is greater than start time.
325 static function isValidInterval($start, $finish) {
326 $start = ttTimeHelper::to24HourFormat($start);
327 $finish = ttTimeHelper::to24HourFormat($finish);
328 if ('00:00' == $finish) $finish = '24:00';
330 $minutesStart = ttTimeHelper::toMinutes($start);
331 $minutesFinish = ttTimeHelper::toMinutes($finish);
332 if ($minutesFinish > $minutesStart)
338 // insert - inserts a time record into log table. Does not deal with custom fields.
339 static function insert($fields)
341 $mdb2 = getConnection();
343 $timestamp = isset($fields['timestamp']) ? $fields['timestamp'] : '';
344 $user_id = $fields['user_id'];
345 $date = $fields['date'];
346 $start = $fields['start'];
347 $finish = $fields['finish'];
348 $duration = $fields['duration'];
349 $client = $fields['client'];
350 $project = $fields['project'];
351 $task = $fields['task'];
352 $invoice = $fields['invoice'];
353 $note = $fields['note'];
354 $billable = $fields['billable'];
355 if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
356 $status_f = ', status';
357 $status_v = ', '.$mdb2->quote($fields['status']);
360 $start = ttTimeHelper::to24HourFormat($start);
362 $finish = ttTimeHelper::to24HourFormat($finish);
363 if ('00:00' == $finish) $finish = '24:00';
365 $duration = ttTimeHelper::normalizeDuration($duration);
368 $timestamp = date('YmdHis');//yyyymmddhhmmss
371 if (!$billable) $billable = 0;
374 $sql = "insert into tt_log (timestamp, user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
375 "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)";
376 $affected = $mdb2->exec($sql);
377 if (is_a($affected, 'PEAR_Error'))
380 $duration = ttTimeHelper::toDuration($start, $finish);
381 if ($duration === false) $duration = 0;
382 if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
384 $sql = "insert into tt_log (timestamp, user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
385 "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)";
386 $affected = $mdb2->exec($sql);
387 if (is_a($affected, 'PEAR_Error'))
391 $id = $mdb2->lastInsertID('tt_log', 'id');
395 // update - updates a record in log table. Does not update its custom fields.
396 static function update($fields)
398 $mdb2 = getConnection();
401 $date = $fields['date'];
402 $user_id = $fields['user_id'];
403 $client = $fields['client'];
404 $project = $fields['project'];
405 $task = $fields['task'];
406 $start = $fields['start'];
407 $finish = $fields['finish'];
408 $duration = $fields['duration'];
409 $note = $fields['note'];
410 $billable = $fields['billable'];
412 $start = ttTimeHelper::to24HourFormat($start);
413 $finish = ttTimeHelper::to24HourFormat($finish);
414 if ('00:00' == $finish) $finish = '24:00';
415 $duration = ttTimeHelper::normalizeDuration($duration);
417 if (!$billable) $billable = 0;
418 if ($start) $duration = '';
421 $sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
422 "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
423 $affected = $mdb2->exec($sql);
424 if (is_a($affected, 'PEAR_Error'))
427 $duration = ttTimeHelper::toDuration($start, $finish);
428 if ($duration === false)
430 $uncompleted = ttTimeHelper::getUncompleted($user_id);
431 if (!$duration && $uncompleted && ($uncompleted['id'] != $id))
434 $sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
435 "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
436 $affected = $mdb2->exec($sql);
437 if (is_a($affected, 'PEAR_Error'))
443 // delete - deletes a record from tt_log table and its associated custom field values.
444 static function delete($id, $user_id) {
445 $mdb2 = getConnection();
447 $sql = "update tt_log set status = NULL where id = $id and user_id = $user_id";
448 $affected = $mdb2->exec($sql);
449 if (is_a($affected, 'PEAR_Error'))
452 $sql = "update tt_custom_field_log set status = NULL where log_id = $id";
453 $affected = $mdb2->exec($sql);
454 if (is_a($affected, 'PEAR_Error'))
460 // getTimeForDay - gets total time for a user for a specific date.
461 static function getTimeForDay($user_id, $date) {
462 $mdb2 = getConnection();
464 $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date = '$date' and status = 1";
465 $res = $mdb2->query($sql);
466 if (!is_a($res, 'PEAR_Error')) {
467 $val = $res->fetchRow();
468 return sec_to_time_fmt_hm($val['sm']);
473 // getTimeForWeek - gets total time for a user for a given week.
474 static function getTimeForWeek($user_id, $date) {
476 $mdb2 = getConnection();
478 $period = new Period(INTERVAL_THIS_WEEK, $date);
479 $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getBeginDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
480 $res = $mdb2->query($sql);
481 if (!is_a($res, 'PEAR_Error')) {
482 $val = $res->fetchRow();
483 return sec_to_time_fmt_hm($val['sm']);
488 // getUncompleted - retrieves an uncompleted record for user, if one exists.
489 static function getUncompleted($user_id) {
490 $mdb2 = getConnection();
492 $sql = "select id from tt_log
493 where user_id = $user_id and start is not null and time_to_sec(duration) = 0 and status = 1";
494 $res = $mdb2->query($sql);
495 if (!is_a($res, 'PEAR_Error')) {
496 if (!$res->numRows()) {
499 if ($val = $res->fetchRow()) {
506 // overlaps - determines if a record overlaps with an already existing record.
509 // $user_id - user id for whom to determine overlap
511 // $start - new record start time
512 // $finish - new record finish time, may be null
513 // $record_id - optional record id we may be editing, excluded from overlap set
514 static function overlaps($user_id, $date, $start, $finish, $record_id = null) {
515 $mdb2 = getConnection();
517 $start = ttTimeHelper::to24HourFormat($start);
519 $finish = ttTimeHelper::to24HourFormat($finish);
520 if ('00:00' == $finish) $finish = '24:00';
522 // Handle these 3 overlap situations:
523 // - start time in existing record
524 // - end time in existing record
525 // - record fully encloses existing record
526 $sql = "select id from tt_log
527 where user_id = $user_id and date = ".$mdb2->quote($date)."
528 and start is not null and duration is not null and status = 1 and (
529 (cast(".$mdb2->quote($start)." as time) >= start and cast(".$mdb2->quote($start)." as time) < addtime(start, duration))";
531 $sql .= " or (cast(".$mdb2->quote($finish)." as time) <= addtime(start, duration) and cast(".$mdb2->quote($finish)." as time) > start)
532 or (cast(".$mdb2->quote($start)." as time) < start and cast(".$mdb2->quote($finish)." as time) > addtime(start, duration))";
536 $sql .= " and id <> $record_id";
538 $res = $mdb2->query($sql);
539 if (!is_a($res, 'PEAR_Error')) {
540 if (!$res->numRows()) {
543 if ($val = $res->fetchRow()) {
550 // getRecord - retrieves a time record identified by its id.
551 static function getRecord($id, $user_id) {
553 $sql_time_format = "'%k:%i'"; // 24 hour format.
554 if ('%I:%M %p' == $user->time_format)
555 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
557 $mdb2 = getConnection();
559 $sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
560 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
561 TIME_FORMAT(l.duration, '%k:%i') as duration,
562 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
564 left join tt_projects p on (p.id = l.project_id)
565 left join tt_tasks t on (t.id = l.task_id)
566 where l.id = $id and l.user_id = $user_id and l.status = 1";
567 $res = $mdb2->query($sql);
568 if (!is_a($res, 'PEAR_Error')) {
569 if (!$res->numRows()) {
572 if ($val = $res->fetchRow()) {
579 // getAllRecords - returns all time records for a certain user.
580 static function getAllRecords($user_id) {
583 $mdb2 = getConnection();
585 $sql = "select l.id, l.timestamp, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
586 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
587 TIME_FORMAT(l.duration, '%k:%i') as duration,
588 l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.status
589 from tt_log l where l.user_id = $user_id order by l.id";
590 $res = $mdb2->query($sql);
591 if (!is_a($res, 'PEAR_Error')) {
592 while ($val = $res->fetchRow()) {
600 // getRecords - returns time records for a user for a given date.
601 static function getRecords($user_id, $date) {
603 $sql_time_format = "'%k:%i'"; // 24 hour format.
604 if ('%I:%M %p' == $user->time_format)
605 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
608 $mdb2 = getConnection();
610 $client_field = null;
611 if (in_array('cl', explode(',', $user->plugins)))
612 $client_field = ", c.name as client";
614 $left_joins = " left join tt_projects p on (l.project_id = p.id)".
615 " left join tt_tasks t on (l.task_id = t.id)";
616 if (in_array('cl', explode(',', $user->plugins)))
617 $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
619 $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
620 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
621 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
624 where l.date = '$date' and l.user_id = $user_id and l.status = 1
625 order by l.start, l.id";
626 $res = $mdb2->query($sql);
627 if (!is_a($res, 'PEAR_Error')) {
628 while ($val = $res->fetchRow()) {
629 if($val['duration']=='0:00')