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 // isHoliday determines if $date falls on a holiday.
41 static function isHoliday($date) {
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))
52 // isValidTime validates a value as a time string.
53 static function isValidTime($value) {
54 if (strlen($value)==0 || !isset($value)) return false;
57 if ($value == '24:00' || $value == '2400') return true;
59 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
62 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-4])$/', $value )) { // 0 - 24
67 if (preg_match('/^[1-9]\s?(am|AM|pm|PM)$/', $value)) { // 1 - 9 am
70 if (preg_match('/^(0[1-9]|1[0-2])\s?(am|AM|pm|PM)$/', $value)) { // 01 - 12 am
73 if (preg_match('/^[1-9]:?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 1:00 - 9:59 am, 100 - 959 am
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
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;
87 if ($value == '24:00' || $value == '2400') return true;
89 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
92 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
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)
105 // normalizeDuration - converts a valid time duration string to format 00:00.
106 static function normalizeDuration($value, $leadingZero = true) {
107 $time_value = $value;
109 // If we have a decimal format - convert to time format 00:00.
111 if ($user->decimal_mark == ',')
112 $time_value = str_replace (',', '.', $time_value);
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)
121 if (strlen($mins) == 1)
123 return $hours.':'.$mins;
126 $time_a = explode(':', $time_value);
130 if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
132 if ($leadingZero && strlen($hours) == 1)
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)
143 return $hours.':'.substr($time_value,2,2);
146 // 0:00-23:59 (24:00)
147 if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
149 if ($leadingZero && strlen($hours) == 1)
151 return $hours.':'.$time_a[1];
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;
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)
170 return $hours.':'.$mins;
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;
178 return ttTimeHelper::toAbsDuration($duration_minutes);
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';
185 $time_a = explode(':', $value);
187 $res = (string)((int)$time_a[0] - 12).':'.$time_a[1].' PM';
188 elseif ($time_a[0] == 12)
190 elseif ($time_a[0] == 0)
191 $res = '12:'.$time_a[1].' AM';
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) {
202 // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
203 $tmp_val = trim($value);
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.
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.
216 if (preg_match('/^[0-9]$/', $tmp_val)) { // 0 - 9
217 // Single digit. Assuming hour number.
218 $res = '0'.$tmp_val.':00';
221 if (preg_match('/^([01][0-9]|2[0-4])$/', $tmp_val)) { // 00 - 24
222 // Two digit hour number.
223 $res = $tmp_val.':00';
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];
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];
238 // Special handling for midnight.
239 if ($tmp_val == '24:00' || $tmp_val == '2400')
242 // 12 hour AM patterns.
243 if (preg_match('/.(am|AM)$/', $tmp_val)) {
245 // The $value ends in am or AM. Strip it.
246 $tmp_val = rtrim(substr($tmp_val, 0, -2));
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);
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.
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.
263 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
264 // Single digit. Assuming hour number.
265 $res = '0'.$tmp_val.':00';
268 if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
269 // Two digit hour number.
270 $res = $tmp_val.':00';
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];
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];
285 } // AM cases handling.
287 // 12 hour PM patterns.
288 if (preg_match('/.(pm|PM)$/', $tmp_val)) {
290 // The $value ends in pm or PM. Strip it.
291 $tmp_val = rtrim(substr($tmp_val, 0, -2));
293 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
294 // Single digit. Assuming hour number.
295 $hour = (string)(12 + (int)$tmp_val);
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';
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];
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);
318 $hour = (string)(12 + (int)$hour);
319 $res = $hour.':'.$min;
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;
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);
333 $hour = (string)(12 + (int)$hour);
334 $res = $hour.':'.$min;
337 } // PM cases handling.
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';
348 $minutesStart = ttTimeHelper::toMinutes($start);
349 $minutesFinish = ttTimeHelper::toMinutes($finish);
350 if ($minutesFinish > $minutesStart)
356 // insert - inserts a time record into log table. Does not deal with custom fields.
357 static function insert($fields)
359 $mdb2 = getConnection();
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']);
378 $start = ttTimeHelper::to24HourFormat($start);
380 $finish = ttTimeHelper::to24HourFormat($finish);
381 if ('00:00' == $finish) $finish = '24:00';
383 $duration = ttTimeHelper::normalizeDuration($duration);
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.
392 if (!$billable) $billable = 0;
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'))
401 $duration = ttTimeHelper::toDuration($start, $finish);
402 if ($duration === false) $duration = 0;
403 if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
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'))
412 $id = $mdb2->lastInsertID('tt_log', 'id');
416 // update - updates a record in log table. Does not update its custom fields.
417 static function update($fields)
419 $mdb2 = getConnection();
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'];
433 $start = ttTimeHelper::to24HourFormat($start);
434 $finish = ttTimeHelper::to24HourFormat($finish);
435 if ('00:00' == $finish) $finish = '24:00';
436 $duration = ttTimeHelper::normalizeDuration($duration);
438 if (!$billable) $billable = 0;
439 if ($start) $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'))
448 $duration = ttTimeHelper::toDuration($start, $finish);
449 if ($duration === false)
451 $uncompleted = ttTimeHelper::getUncompleted($user_id);
452 if (!$duration && $uncompleted && ($uncompleted['id'] != $id))
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'))
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();
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'))
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'))
481 // getTimeForDay - gets total time for a user for a specific date.
482 static function getTimeForDay($user_id, $date) {
483 $mdb2 = getConnection();
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']);
494 // getTimeForWeek - gets total time for a user for a given week.
495 static function getTimeForWeek($user_id, $date) {
497 $mdb2 = getConnection();
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']);
509 // getTimeForMonth - gets total time for a user for a given month.
510 static function getTimeForMonth($user_id, $date){
512 $mdb2 = getConnection();
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']);
524 // getUncompleted - retrieves an uncompleted record for user, if one exists.
525 static function getUncompleted($user_id) {
526 $mdb2 = getConnection();
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()) {
535 if ($val = $res->fetchRow()) {
542 // overlaps - determines if a record overlaps with an already existing record.
545 // $user_id - user id for whom to determine overlap
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)
555 $mdb2 = getConnection();
557 $start = ttTimeHelper::to24HourFormat($start);
559 $finish = ttTimeHelper::to24HourFormat($finish);
560 if ('00:00' == $finish) $finish = '24:00';
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))";
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))";
576 $sql .= " and id <> $record_id";
578 $res = $mdb2->query($sql);
579 if (!is_a($res, 'PEAR_Error')) {
580 if (!$res->numRows()) {
583 if ($val = $res->fetchRow()) {
590 // ovelapsWithNewDuration - determines if an already existing tt_log record will overlap others
591 // if we were to change its duration to a new value.
593 // Another error condition we check for is whether new duration puts the existing record beyond the 24:00 day boundary.
594 static function ovelapsWithNewDuration($tt_log_id, $new_duration, $err) {
596 $mdb2 = getConnection();
598 // Determine if we have start time in record, as checking does not makes sense otherwise.
599 $sql = "select start from tt_log where id = $tt_log_id";
600 $res = $mdb2->query($sql);
601 if (!is_a($res, 'PEAR_Error')) {
602 if (!$res->numRows()) {
603 $err->add($i18n->getKey('error.db')); // This is not expected.
606 $val = $res->fetchRow();
608 return false; // No start time, therefore no overlap.
611 // TODO: Determine finish based on the existing record start and $new_duration.
612 // By probably using PHP time functions or toMinutes().
614 // Then check whether new duration puts the existing records beyond 24:00 boundary.
615 // and call the existing overlaps function.
617 // For now return an error, until we implement the above.
619 $err->add("Week view is work in progress. Editing records with existing start times is currently not supported in week view. Try day view instead.");
623 // getRecord - retrieves a time record identified by its id.
624 static function getRecord($id, $user_id) {
626 $sql_time_format = "'%k:%i'"; // 24 hour format.
627 if ('%I:%M %p' == $user->time_format)
628 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
630 $mdb2 = getConnection();
632 $sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
633 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
634 TIME_FORMAT(l.duration, '%k:%i') as duration,
635 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
637 left join tt_projects p on (p.id = l.project_id)
638 left join tt_tasks t on (t.id = l.task_id)
639 where l.id = $id and l.user_id = $user_id and l.status = 1";
640 $res = $mdb2->query($sql);
641 if (!is_a($res, 'PEAR_Error')) {
642 if (!$res->numRows()) {
645 if ($val = $res->fetchRow()) {
652 // getAllRecords - returns all time records for a certain user.
653 static function getAllRecords($user_id) {
656 $mdb2 = getConnection();
658 $sql = "select l.id, l.timestamp, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
659 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
660 TIME_FORMAT(l.duration, '%k:%i') as duration,
661 l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.status
662 from tt_log l where l.user_id = $user_id order by l.id";
663 $res = $mdb2->query($sql);
664 if (!is_a($res, 'PEAR_Error')) {
665 while ($val = $res->fetchRow()) {
673 // getRecords - returns time records for a user for a given date.
674 static function getRecords($user_id, $date) {
676 $sql_time_format = "'%k:%i'"; // 24 hour format.
677 if ('%I:%M %p' == $user->time_format)
678 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
681 $mdb2 = getConnection();
683 $client_field = null;
684 if ($user->isPluginEnabled('cl'))
685 $client_field = ", c.name as client";
687 $left_joins = " left join tt_projects p on (l.project_id = p.id)".
688 " left join tt_tasks t on (l.task_id = t.id)";
689 if ($user->isPluginEnabled('cl'))
690 $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
692 $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
693 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
694 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
697 where l.date = '$date' and l.user_id = $user_id and l.status = 1
698 order by l.start, l.id";
699 $res = $mdb2->query($sql);
700 if (!is_a($res, 'PEAR_Error')) {
701 while ($val = $res->fetchRow()) {
702 if($val['duration']=='0:00')
711 // getRecordsForInterval - returns time records for a user for a given interval of dates.
712 static function getRecordsForInterval($user_id, $start_date, $end_date) {
714 $sql_time_format = "'%k:%i'"; // 24 hour format.
715 if ('%I:%M %p' == $user->time_format)
716 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
719 $mdb2 = getConnection();
721 $client_field = null;
722 if ($user->isPluginEnabled('cl'))
723 $client_field = ', c.id as client_id, c.name as client';
725 $custom_field_1 = null;
726 if ($user->isPluginEnabled('cf')) {
727 $custom_fields = new CustomFields($user->team_id);
728 $cf_1_type = $custom_fields->fields[0]['type'];
729 if ($cf_1_type == CustomFields::TYPE_TEXT) {
730 $custom_field_1 = ', cfl.value as cf_1_value';
731 } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
732 $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
736 $left_joins = " left join tt_projects p on (l.project_id = p.id)".
737 " left join tt_tasks t on (l.task_id = t.id)";
738 if ($user->isPluginEnabled('cl'))
739 $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
740 if ($user->isPluginEnabled('cf')) {
741 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
742 $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) ';
743 elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
744 $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) ';
747 $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
748 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
749 TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
750 t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
753 where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
754 order by p.name, t.name, l.date, l.start, l.id";
755 $res = $mdb2->query($sql);
756 if (!is_a($res, 'PEAR_Error')) {
757 while ($val = $res->fetchRow()) {
758 if($val['duration']=='0:00')
767 // getDataForWeekView - builds an array to render a table of durations for week view.
768 // In a week view we want one row representing the same attributes to have 7 values for each day of week.
769 // We identify simlar records by a combination of client, billable, project, task, and custom field values.
770 // This will allow us to extend the feature when more custom fields are added.
772 // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
773 // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
775 // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
776 // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
778 // Description of $dataArray format that the function returns.
779 // $dataArray = array(
781 // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
782 // 'label' => 'Anuko - Time Tracker - Coding', // Human readable label for the row describing what this time entry is for.
783 // '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.
784 // 'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
785 // 'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
786 // 'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
787 // 'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
788 // 'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
789 // 'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
792 // 'row_id' => 'bl:0_0',
793 // 'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
794 // 'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'duration' => null),
795 // 'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
796 // 'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'duration' => null),
797 // 'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
798 // 'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
799 // 'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'duration' => null),
800 // 'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
803 static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
804 // Start by obtaining all records in interval.
805 $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
807 $dataArray = array();
809 // Iterate through records and build $dataArray cell by cell.
810 foreach ($records as $record) {
811 // Create record id without suffix.
812 $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
813 // Handle potential multiple records with the same attributes by using a numerical suffix.
815 $record_id = $record_id_no_suffix.'_'.$suffix;
816 $day_header = substr($record['date'], 8); // Day number in month.
817 while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
819 $record_id = $record_id_no_suffix.'_'.$suffix;
822 $pos = ttTimeHelper::findRow($record_id, $dataArray);
824 $dataArray[] = array('row_id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
825 $pos = ttTimeHelper::findRow($record_id, $dataArray);
826 // Insert empty cells with proper control ids.
827 for ($i = 0; $i < 7; $i++) {
828 $control_id = $pos.'_'. $dayHeaders[$i];
829 $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
832 // Insert actual cell data from $record (one cell only).
833 $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
838 // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
839 // and a day header already exists.
840 static function cellExists($row_id, $day_header, $dataArray) {
841 foreach($dataArray as $row) {
842 if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
848 // findRow returns an existing row position in $dataArray, -1 otherwise.
849 static function findRow($row_id, $dataArray) {
850 $pos = 0; // Row position in array.
851 foreach($dataArray as $row) {
852 if ($row['row_id'] == $row_id)
854 $pos++; // Increment for search.
856 return -1; // Row not found.
859 // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
861 // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
862 // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
863 // See comment for getGroupedRecordsForInterval.
864 static function makeRecordIdentifier($record) {
866 // Start with client.
867 if ($user->isPluginEnabled('cl'))
868 $record_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
869 // Add billable flag.
870 if (!empty($record_identifier)) $record_identifier .= ',';
871 $record_identifier .= 'bl:'.$record['billable'];
873 $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
875 $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
876 // Add custom field 1. This requires modifying the query to get the data we need.
877 if ($user->isPluginEnabled('cf')) {
878 if ($record['cf_1_id'])
879 $record_identifier .= ',cf_1:'.$record['cf_1_id'];
880 else if ($record['cf_1_value'])
881 $record_identifier .= ',cf_1:'.$record['cf_1_value'];
884 return $record_identifier;
887 // parseFromWeekViewRow - obtains field value encoded in row identifier.
888 // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
889 // requesting a client "cl" should return 546.
890 static function parseFromWeekViewRow($row_id, $field_label) {
891 // Find beginning of label.
892 $pos = strpos($row_id, $field_label);
893 if ($pos === false) return null; // Not found.
895 // Strip suffix from row id.
896 $suffixPos = strrpos($row_id, '_');
898 $remaninder = substr($row_id, 0, $suffixPos);
900 // Find beginning of value.
901 $posBegin = 1 + strpos($remaninder, ':', $pos);
902 // Find end of value.
903 $posEnd = strpos($remaninder, ',', $posBegin);
904 if ($posEnd === false) $posEnd = strlen($remaninder);
906 return substr($remaninder, $posBegin, $posEnd - $posBegin);
909 // makeRecordLabel - builds a human readable label for a row in week view,
910 // which is a combination ot record properties.
911 // Client - Project - Task - Custom field 1.
912 // Note that billable property is not part of the label. Instead, we intend to
913 // identify such records with a different color in week view.
914 static function makeRecordLabel($record) {
916 // Start with client.
917 if ($user->isPluginEnabled('cl'))
918 $label = $record['client'];
921 if (!empty($label) && !empty($record['project'])) $label .= ' - ';
922 $label .= $record['project'];
925 if (!empty($label) && !empty($record['task'])) $label .= ' - ';
926 $label .= $record['task'];
928 // Add custom field 1.
929 if ($user->isPluginEnabled('cf')) {
930 if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
931 $label .= $record['cf_1_value'];
937 // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
938 static function getDayHeadersForWeek($start_date) {
939 $dayHeaders = array();
940 $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
941 $dayHeaders[] = (string) $objDate->getDate(); // It returns an int on first call.
942 if (strlen($dayHeaders[0]) == 1) // Which is an implementation detail of DateAndTime class.
943 $dayHeaders[0] = '0'.$dayHeaders[0]; // Add a 0 for single digit day.
945 $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
947 $dayHeaders[] = $objDate->getDate();
949 $dayHeaders[] = $objDate->getDate();
951 $dayHeaders[] = $objDate->getDate();
953 $dayHeaders[] = $objDate->getDate();
955 $dayHeaders[] = $objDate->getDate();
960 // getLockedDaysForWeek - builds an array of locked days in week.
961 static function getLockedDaysForWeek($start_date) {
963 $lockedDays = array();
964 $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
965 for ($i = 0; $i < 7; $i++) {
966 $lockedDays[] = $user->isDateLocked($objDate);
973 // getDayTotals calculates total durations for each day from the existing data in $dataArray.
974 static function getDayTotals($dataArray, $dayHeaders) {
975 $dayTotals = array();
979 $dayTotals['label'] = $i18n->getKey('label.total');
981 foreach ($dataArray as $row) {
982 foreach($dayHeaders as $dayHeader) {
983 if (array_key_exists($dayHeader, $row)) {
984 $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
985 $dayTotals[$dayHeader] += $minutes;
989 // Convert minutes to hh:mm for display.
990 foreach($dayHeaders as $dayHeader) {
991 $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
996 // dateFromDayHeader calculates date from start date and day header in week view.
997 static function dateFromDayHeader($start_date, $day_header) {
998 $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
999 $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
1000 if (strlen($currentDayHeader) == 1) // Which is an implementation detail of DateAndTime class.
1001 $currentDayHeader = '0'.$currentDayHeader; // Add a 0 for single digit day.
1003 while ($currentDayHeader != $day_header && $i < 7) {
1004 // Iterate through remaining days to find a match.
1006 $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
1009 return $objDate->toString(DB_DATEFORMAT);
1012 // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
1013 static function insertDurationFromWeekView($fields, $custom_fields, $err) {
1017 // Determine date for a new entry.
1018 $entry_date = ttTimeHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
1019 $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
1021 // Prohibit creating entries in future.
1022 if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
1023 $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
1024 if ($objEntryDate->after($objBrowserToday)) {
1025 $err->add($i18n->getKey('error.future_date'));
1030 // Prepare an array of fields for regular insert function.
1031 $fields4insert = array();
1032 $fields4insert['user_id'] = $user->getActiveUser();
1033 $fields4insert['date'] = $entry_date;
1034 $fields4insert['duration'] = $fields['duration'];
1035 $fields4insert['client'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
1036 $fields4insert['billable'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
1037 $fields4insert['project'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
1038 $fields4insert['task'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
1040 // Try to insert a record.
1041 $id = ttTimeHelper::insert($fields4insert);
1042 if (!$id) return false; // Something failed.
1044 // Insert custom field if we have it.
1046 $cf_1 = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
1047 if ($custom_fields && $cf_1) {
1048 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
1049 $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
1050 elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
1051 $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
1058 // modifyFromWeekView - modifies a duration of an existing record from a week view post.
1059 static function modifyDurationFromWeekView($fields, $err) {
1063 // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
1064 // TODO: rename this function.
1065 // Handle different errors with specific error messages.
1066 if (ttTimeHelper::ovelapsWithNewDuration($fields['tt_log_id'], $fields['duration'], $err)) {
1067 // $err->add($i18n->getKey('error.overlap'));
1071 $mdb2 = getConnection();
1072 $duration = $fields['duration'];
1073 $tt_log_id = $fields['tt_log_id'];
1074 $user_id = $user->getActiveUser();
1075 $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
1076 $affected = $mdb2->exec($sql);
1077 if (is_a($affected, 'PEAR_Error'))