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) {
45 if (!$user->show_holidays) return false;
47 // $date is expected as string in DB_DATEFORMAT.
48 $month = date('m', strtotime($date));
49 $day = date('d', strtotime($date));
50 if (in_array($month.'/'.$day, $i18n->holidays))
56 // isHoliday determines if $date falls on a holiday.
57 static function isHoliday2($date) {
60 $holidays = $user->getHolidays();
64 $holiday_dates = explode(',', $holidays);
65 foreach ($holiday_dates as $holiDateSpec) {
66 if (ttTimeHelper::holidayMatch($date, $holiDateSpec))
72 // holidayMatch determines if $date matches a single $holiDateSpec.
73 static function holidayMatch($date, $holiDateSpec) {
75 $dateArray = explode('-', $date);
76 $holiDateSpecArray = explode('-', $holiDateSpec);
79 if ($dateArray[0] != $holiDateSpecArray[0] && $holiDateSpecArray[0] != '****') // **** means all years.
82 if ($dateArray[1] != $holiDateSpecArray[1])
85 if ($dateArray[2] != $holiDateSpecArray[2])
91 // isValidTime validates a value as a time string.
92 static function isValidTime($value) {
93 if (strlen($value)==0 || !isset($value)) return false;
96 if ($value == '24:00' || $value == '2400') return true;
98 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
101 if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-4])$/', $value )) { // 0 - 24
106 if (preg_match('/^[1-9]\s?(am|AM|pm|PM)$/', $value)) { // 1 - 9 am
109 if (preg_match('/^(0[1-9]|1[0-2])\s?(am|AM|pm|PM)$/', $value)) { // 01 - 12 am
112 if (preg_match('/^[1-9]:?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 1:00 - 9:59 am, 100 - 959 am
115 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
122 // isValidDuration validates a value as a time duration string (in hours and minutes).
123 static function isValidDuration($value) {
124 if (strlen($value) == 0 || !isset($value)) return false;
126 if ($value == '24:00' || $value == '2400') return true;
128 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
131 if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
136 $localizedPattern = '/^([0-1]{0,1}[0-9]|2[0-3])?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
137 if (preg_match($localizedPattern, $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h (or with comma)
144 // postedDurationToMinutes - converts a value representing a duration
145 // (usually enetered in a form by a user) to an integer number of minutes.
148 // $duration - user entered duration string. Valid strings are:
149 // 3 or 3h - means 3 hours. Note: h and m letters are not localized.
150 // 0.25 or 0.25h or .25 or .25h - means a quarter of hour.
151 // 0,25 or 0,25h or ,25 or ,25h - same as above for users with comma ad decimal mark.
152 // 1:30 - means 1 hour 30 minutes.
153 // 25m - means 25 minutes.
154 // $max - maximum number of minutes that is valid.
156 // At the moment, we have 2 variations of duration types:
157 // 1) A duration within a day, such as in a time entry.
158 // These are less or equal to 24*60 minutes.
160 // 2) A duration of a monthly quota, with max value of 31*24*60 minutes.
162 // This function is generic to be used for both types.
164 // Returns false if the value cannot be converted.
165 static function postedDurationToMinutes($duration, $max = 1440) {
166 // Handle empty value.
167 if (!isset($duration) || strlen($duration) == 0)
168 return null; // Value is not set. Caller decides whether it is valid or not.
170 // We allow negative durations, similar to negative expenses (installments).
171 $signMultiplier = ttStartsWith($duration, '-') ? -1 : 1;
172 if ($signMultiplier == -1) $duration = ltrim($duration, '-');
174 // Handle whole hours.
175 if (preg_match('/^\d{1,3}h?$/', $duration )) { // 0 - 999, 0h - 999h
176 $minutes = 60 * trim($duration, 'h');
177 return $minutes > $max ? false : $signMultiplier * $minutes;
180 // Handle a normalized duration value.
181 if (preg_match('/^\d{1,3}:[0-5][0-9]$/', $duration )) { // 0:00 - 999:59
182 $time_array = explode(':', $duration);
183 $minutes = (int)@$time_array[1] + ((int)@$time_array[0]) * 60;
184 return $minutes > $max ? false : $signMultiplier * $minutes;
187 // Handle localized fractional hours.
189 $localizedPattern = '/^(\d{1,3})?['.$user->getDecimalMark().'][0-9]{1,4}h?$/';
190 if (preg_match($localizedPattern, $duration )) { // decimal values like .5, 1.25h, ... .. 999.9999h (or with comma)
191 if ($user->getDecimalMark() == ',')
192 $duration = str_replace (',', '.', $duration);
194 $minutes = (int)round(60 * floatval($duration));
195 return $minutes > $max ? false : $signMultiplier * $minutes;
198 // Handle minutes. Some users enter durations like 10m (meaning 10 minutes).
199 if (preg_match('/^\d{1,5}m$/', $duration )) { // 0m - 99999m
200 $minutes = (int) trim($duration, 'm');
201 return $minutes > $max ? false : $signMultiplier * $minutes;
204 // Everything else is not a valid duration.
208 // minutesToDuration converts an integer number of minutes into duration string.
209 // Formats returned HH:MM, HHH:MM, HH, or HHH.
210 static function minutesToDuration($minutes, $abbreviate = false) {
211 $sign = $minutes >= 0 ? '' : '-';
212 $minutes = abs($minutes);
214 $hours = (string) (int)($minutes / 60);
215 $mins = (string) round(fmod($minutes, 60));
216 if (strlen($mins) == 1)
218 if ($abbreviate && $mins == '00')
221 return $sign.$hours.':'.$mins;
224 // toMinutes - converts a time string in format 00:00 to a number of minutes.
225 static function toMinutes($value) {
226 $signMultiplier = ttStartsWith($value, '-') ? -1 : 1;
227 if ($signMultiplier == -1) $value = ltrim($value, '-');
229 $time_a = explode(':', $value);
230 return $signMultiplier * ((int)@$time_a[1] + ((int)@$time_a[0]) * 60);
233 // toAbsDuration - converts a number of minutes to format 0:00
234 // even if $minutes is negative.
235 static function toAbsDuration($minutes, $abbreviate = false){
236 $hours = (string)((int)abs($minutes / 60));
237 $mins = (string) round(abs(fmod($minutes, 60)));
238 if (strlen($mins) == 1)
240 if ($abbreviate && $mins == '00')
243 return $hours.':'.$mins;
246 // toDuration - calculates duration between start and finish times in 00:00 format.
247 static function toDuration($start, $finish) {
248 $duration_minutes = ttTimeHelper::toMinutes($finish) - ttTimeHelper::toMinutes($start);
249 if ($duration_minutes <= 0) return false;
251 return ttTimeHelper::toAbsDuration($duration_minutes);
254 // The to12HourFormat function converts a 24-hour time value (such as 15:23) to 12 hour format (03:23 PM).
255 static function to12HourFormat($value) {
256 if ('24:00' == $value) return '12:00 AM';
258 $time_a = explode(':', $value);
260 $res = (string)((int)$time_a[0] - 12).':'.$time_a[1].' PM';
261 elseif ($time_a[0] == 12)
263 elseif ($time_a[0] == 0)
264 $res = '12:'.$time_a[1].' AM';
270 // The to24HourFormat function attempts to convert a string value (human readable notation of time of day)
271 // to a 24-hour time format HH:MM.
272 static function to24HourFormat($value) {
275 // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
276 $tmp_val = trim($value);
279 if (preg_match('/^([01][0-9]|2[0-3]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 23:59
280 // We already have a 24-hour format. Just return it.
284 if (preg_match('/^[0-9]:[0-5][0-9]$/', $tmp_val)) { // 0:00 - 9:59
285 // This is a 24-hour format without a leading zero. Add 0 and return.
289 if (preg_match('/^[0-9]$/', $tmp_val)) { // 0 - 9
290 // Single digit. Assuming hour number.
291 $res = '0'.$tmp_val.':00';
294 if (preg_match('/^([01][0-9]|2[0-4])$/', $tmp_val)) { // 00 - 24
295 // Two digit hour number.
296 $res = $tmp_val.':00';
299 if (preg_match('/^[0-9][0-5][0-9]$/', $tmp_val)) { // 000 - 959
300 // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
301 $tmp_arr = str_split($tmp_val);
302 $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
305 if (preg_match('/^([01][0-9]|2[0-3])[0-5][0-9]$/', $tmp_val)) { // 0000 - 2359
306 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
307 $tmp_arr = str_split($tmp_val);
308 $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
311 // Special handling for midnight.
312 if ($tmp_val == '24:00' || $tmp_val == '2400')
315 // 12 hour AM patterns.
316 if (preg_match('/.(am|AM)$/', $tmp_val)) {
318 // The $value ends in am or AM. Strip it.
319 $tmp_val = rtrim(substr($tmp_val, 0, -2));
321 // Special case to handle 12, 12:MM, and 12MM AM.
322 if (preg_match('/^12:?([0-5][0-9])?$/', $tmp_val))
323 $tmp_val = '00'.substr($tmp_val, 2);
325 // We are ready to convert AM time.
326 if (preg_match('/^(0[0-9]|1[0-1]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 11:59
327 // We already have a 24-hour format. Just return it.
331 if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
332 // This is a 24-hour format without a leading zero. Add 0 and return.
336 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
337 // Single digit. Assuming hour number.
338 $res = '0'.$tmp_val.':00';
341 if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
342 // Two digit hour number.
343 $res = $tmp_val.':00';
346 if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
347 // Missing colon. Assume the first digit is the hour, the rest is minutes.
348 $tmp_arr = str_split($tmp_val);
349 $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
352 if (preg_match('/^(0[0-9]|1[0-1])[0-5][0-9]$/', $tmp_val)) { // 0000 - 1159
353 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
354 $tmp_arr = str_split($tmp_val);
355 $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
358 } // AM cases handling.
360 // 12 hour PM patterns.
361 if (preg_match('/.(pm|PM)$/', $tmp_val)) {
363 // The $value ends in pm or PM. Strip it.
364 $tmp_val = rtrim(substr($tmp_val, 0, -2));
366 if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
367 // Single digit. Assuming hour number.
368 $hour = (string)(12 + (int)$tmp_val);
372 if (preg_match('/^((0[1-9])|(1[0-2]))$/', $tmp_val)) { // 01 - 12
373 // Double digit hour.
374 if ('12' != $tmp_val)
375 $tmp_val = (string)(12 + (int)$tmp_val);
376 $res = $tmp_val.':00';
379 if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
380 // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
381 $tmp_arr = str_split($tmp_val);
382 $hour = (string)(12 + (int)$tmp_arr[0]);
383 $res = $hour.':'.$tmp_arr[1].$tmp_arr[2];
386 if (preg_match('/^(0[1-9]|1[0-2])[0-5][0-9]$/', $tmp_val)) { // 0100 - 1259
387 // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
388 $hour = substr($tmp_val, 0, -2);
389 $min = substr($tmp_val, 2);
391 $hour = (string)(12 + (int)$hour);
392 $res = $hour.':'.$min;
395 if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
396 $hour = substr($tmp_val, 0, -3);
397 $min = substr($tmp_val, 2);
398 $hour = (string)(12 + (int)$hour);
399 $res = $hour.':'.$min;
402 if (preg_match('/^(0[1-9]|1[0-2]):[0-5][0-9]$/', $tmp_val)) { // 01:00 - 12:59
403 $hour = substr($tmp_val, 0, -3);
404 $min = substr($tmp_val, 3);
406 $hour = (string)(12 + (int)$hour);
407 $res = $hour.':'.$min;
410 } // PM cases handling.
415 // isValidInterval - checks if finish time is greater than start time.
416 static function isValidInterval($start, $finish) {
417 $start = ttTimeHelper::to24HourFormat($start);
418 $finish = ttTimeHelper::to24HourFormat($finish);
419 if ('00:00' == $finish) $finish = '24:00';
421 $minutesStart = ttTimeHelper::toMinutes($start);
422 $minutesFinish = ttTimeHelper::toMinutes($finish);
423 if ($minutesFinish > $minutesStart)
429 // insert - inserts a time record into tt_log table. Does not deal with custom fields.
430 static function insert($fields)
433 $mdb2 = getConnection();
435 $user_id = (int) $fields['user_id'];
436 $group_id = (int) $fields['group_id'];
437 $org_id = (int) $fields['org_id'];
438 $date = $fields['date'];
439 $start = $fields['start'];
440 $finish = $fields['finish'];
441 $duration = $fields['duration'];
443 $minutes = ttTimeHelper::postedDurationToMinutes($duration);
444 $duration = ttTimeHelper::minutesToDuration($minutes);
446 $client = $fields['client'];
447 $project = $fields['project'];
448 $task = $fields['task'];
449 $invoice = $fields['invoice'];
450 $note = $fields['note'];
451 $billable = $fields['billable'];
452 $paid = $fields['paid'];
453 if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
454 $status_f = ', status';
455 $status_v = ', '.$mdb2->quote($fields['status']);
458 $start = ttTimeHelper::to24HourFormat($start);
460 $finish = ttTimeHelper::to24HourFormat($finish);
461 if ('00:00' == $finish) $finish = '24:00';
464 $created_v = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$user->id;
466 if (!$billable) $billable = 0;
467 if (!$paid) $paid = 0;
470 $sql = "insert into tt_log (user_id, group_id, org_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid, created, created_ip, created_by $status_f) ".
471 "values ($user_id, $group_id, $org_id, ".$mdb2->quote($date).", '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable, $paid $created_v $status_v)";
472 $affected = $mdb2->exec($sql);
473 if (is_a($affected, 'PEAR_Error'))
476 $duration = ttTimeHelper::toDuration($start, $finish);
477 if ($duration === false) $duration = 0;
478 if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
480 $sql = "insert into tt_log (user_id, group_id, org_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid, created, created_ip, created_by $status_f) ".
481 "values ($user_id, $group_id, $org_id, ".$mdb2->quote($date).", '$start', '$duration', ".$mdb2->quote($client).", ".$mdb2->quote($project).", ".$mdb2->quote($task).", ".$mdb2->quote($invoice).", ".$mdb2->quote($note).", $billable, $paid $created_v $status_v)";
482 $affected = $mdb2->exec($sql);
483 if (is_a($affected, 'PEAR_Error'))
487 $id = $mdb2->lastInsertID('tt_log', 'id');
491 // update - updates a record in log table. Does not update its custom fields.
492 static function update($fields)
495 $mdb2 = getConnection();
498 $date = $fields['date'];
499 $user_id = $fields['user_id'];
500 $client = $fields['client'];
501 $project = $fields['project'];
502 $task = $fields['task'];
503 $start = $fields['start'];
504 $finish = $fields['finish'];
505 $duration = $fields['duration'];
507 $minutes = ttTimeHelper::postedDurationToMinutes($duration);
508 $duration = ttTimeHelper::minutesToDuration($minutes);
510 $note = $fields['note'];
513 if ($user->isPluginEnabled('iv')) {
514 $billable_part = $fields['billable'] ? ', billable = 1' : ', billable = 0';
517 if ($user->can('manage_invoices') && $user->isPluginEnabled('ps')) {
518 $paid_part = $fields['paid'] ? ', paid = 1' : ', paid = 0';
520 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
522 $start = ttTimeHelper::to24HourFormat($start);
523 $finish = ttTimeHelper::to24HourFormat($finish);
524 if ('00:00' == $finish) $finish = '24:00';
526 if ($start) $duration = '';
529 $sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
530 "comment = ".$mdb2->quote($note)."$billable_part $paid_part $modified_part, date = '$date' WHERE id = $id";
531 $affected = $mdb2->exec($sql);
532 if (is_a($affected, 'PEAR_Error'))
535 $duration = ttTimeHelper::toDuration($start, $finish);
536 if ($duration === false)
538 $uncompleted = ttTimeHelper::getUncompleted($user_id);
539 if (!$duration && $uncompleted && ($uncompleted['id'] != $id))
542 $sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
543 "comment = ".$mdb2->quote($note)."$billable_part $paid_part $modified_part, date = '$date' WHERE id = $id";
544 $affected = $mdb2->exec($sql);
545 if (is_a($affected, 'PEAR_Error'))
551 // delete - deletes a record from tt_log table and its associated custom field values.
552 static function delete($id) {
554 $mdb2 = getConnection();
556 // Delete associated files.
557 if ($user->isPluginEnabled('at')) {
558 import('ttFileHelper');
560 $fileHelper = new ttFileHelper($err);
561 if (!$fileHelper->deleteEntityFiles($id, 'time'))
565 $user_id = $user->getUser();
566 $group_id = $user->getGroup();
567 $org_id = $user->org_id;
569 $sql = "update tt_log set status = null".
570 " where id = $id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
571 $affected = $mdb2->exec($sql);
572 if (is_a($affected, 'PEAR_Error'))
575 $sql = "update tt_custom_field_log set status = null".
576 " where log_id = $id and group_id = $group_id and org_id = $org_id";
577 $affected = $mdb2->exec($sql);
578 if (is_a($affected, 'PEAR_Error'))
584 // getTimeForDay - gets total time for a user for a specific date.
585 static function getTimeForDay($date) {
587 $mdb2 = getConnection();
589 $user_id = $user->getUser();
590 $group_id = $user->getGroup();
591 $org_id = $user->org_id;
593 $sql = "select sum(time_to_sec(duration)) as sm from tt_log".
594 " where user_id = $user_id and group_id = $group_id and org_id = $org_id and date = '$date' and status = 1";
595 $res = $mdb2->query($sql);
596 if (!is_a($res, 'PEAR_Error')) {
597 $val = $res->fetchRow();
598 return ttTimeHelper::minutesToDuration($val['sm'] / 60);
603 // getTimeForWeek - gets total time for a user for a given week.
604 static function getTimeForWeek($date) {
607 $mdb2 = getConnection();
609 $user_id = $user->getUser();
610 $group_id = $user->getGroup();
611 $org_id = $user->org_id;
613 $period = new Period(INTERVAL_THIS_WEEK, $date);
614 $sql = "select sum(time_to_sec(duration)) as sm from tt_log".
615 " where user_id = $user_id and group_id = $group_id and org_id = $org_id".
616 " and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
617 $res = $mdb2->query($sql);
618 if (!is_a($res, 'PEAR_Error')) {
619 $val = $res->fetchRow();
620 return ttTimeHelper::minutesToDuration($val['sm'] / 60);
625 // getTimeForMonth - gets total time for a user for a given month.
626 static function getTimeForMonth($date) {
629 $mdb2 = getConnection();
631 $user_id = $user->getUser();
632 $group_id = $user->getGroup();
633 $org_id = $user->org_id;
635 $period = new Period(INTERVAL_THIS_MONTH, $date);
636 $sql = "select sum(time_to_sec(duration)) as sm from tt_log".
637 " where user_id = $user_id and group_id = $group_id and org_id = $org_id".
638 " and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
639 $res = $mdb2->query($sql);
640 if (!is_a($res, 'PEAR_Error')) {
641 $val = $res->fetchRow();
642 return ttTimeHelper::minutesToDuration($val['sm'] / 60);
647 // getUncompleted - retrieves an uncompleted record for user, if one exists.
648 static function getUncompleted($user_id) {
649 $mdb2 = getConnection();
651 $sql = "select id, start from tt_log
652 where user_id = $user_id and start is not null and time_to_sec(duration) = 0 and status = 1";
653 $res = $mdb2->query($sql);
654 if (!is_a($res, 'PEAR_Error')) {
655 if (!$res->numRows()) {
658 if ($val = $res->fetchRow()) {
665 // overlaps - determines if a record overlaps with an already existing record.
668 // $user_id - user id for whom to determine overlap
670 // $start - new record start time
671 // $finish - new record finish time, may be null
672 // $record_id - optional record id we may be editing, excluded from overlap set
673 static function overlaps($user_id, $date, $start, $finish, $record_id = null) {
674 // Do not bother checking if we allow overlaps.
676 if ($user->allow_overlap) return false;
678 $mdb2 = getConnection();
680 $start = ttTimeHelper::to24HourFormat($start);
682 $finish = ttTimeHelper::to24HourFormat($finish);
683 if ('00:00' == $finish) $finish = '24:00';
685 // Handle these 3 overlap situations:
686 // - start time in existing record
687 // - end time in existing record
688 // - record fully encloses existing record
689 $sql = "select id from tt_log
690 where user_id = $user_id and date = ".$mdb2->quote($date)."
691 and start is not null and duration is not null and status = 1 and (
692 (cast(".$mdb2->quote($start)." as time) >= start and cast(".$mdb2->quote($start)." as time) < addtime(start, duration))";
694 $sql .= " or (cast(".$mdb2->quote($finish)." as time) <= addtime(start, duration) and cast(".$mdb2->quote($finish)." as time) > start)
695 or (cast(".$mdb2->quote($start)." as time) < start and cast(".$mdb2->quote($finish)." as time) > addtime(start, duration))";
699 $sql .= " and id <> $record_id";
701 $res = $mdb2->query($sql);
702 if (!is_a($res, 'PEAR_Error')) {
703 if (!$res->numRows()) {
706 if ($val = $res->fetchRow()) {
713 // getRecord - retrieves a time record identified by its id.
714 static function getRecord($id) {
717 $user_id = $user->getUser();
718 $group_id = $user->getGroup();
719 $org_id = $user->org_id;
721 $sql_time_format = "'%k:%i'"; // 24 hour format.
722 if ('%I:%M %p' == $user->time_format)
723 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
725 $mdb2 = getConnection();
727 $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,".
728 " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
729 " TIME_FORMAT(l.duration, '%k:%i') as duration,".
730 " p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id,".
731 " l.timesheet_id, l.invoice_id, l.billable, l.approved, l.paid, l.date from tt_log l".
732 " left join tt_projects p on (p.id = l.project_id)".
733 " left join tt_tasks t on (t.id = l.task_id)".
734 " where l.id = $id and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1";
735 $res = $mdb2->query($sql);
736 if (!is_a($res, 'PEAR_Error')) {
737 if (!$res->numRows()) {
740 if ($val = $res->fetchRow()) {
747 // getRecordForFileView - retrieves a time record identified by its id for
748 // attachment view operation.
750 // It is different from getRecord, as we want users with appropriate rights
751 // to be able to see other users files, without changing "on behalf" user.
752 // For example, viewing reports for all users and their attached files
753 // from report links.
754 static function getRecordForFileView($id) {
755 // There are several possible situations:
757 // Record is ours. Check "view_own_reports" or "view_all_reports".
758 // Record is for the current on behalf user. Check "view_reports" or "view_all_reports".
759 // Record is for someone else. Check "view_reports" or "view_all_reports" and rank.
761 // It looks like the best way is to use 2 queries, obtain user_id first, then check rank.
765 $group_id = $user->getGroup();
766 $org_id = $user->org_id;
768 $mdb2 = getConnection();
770 // Obtain user_id for the time record.
771 $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved from tt_log l ".
772 " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1";
773 $res = $mdb2->query($sql);
774 if (is_a($res, 'PEAR_Error')) return false;
775 if (!$res->numRows()) return false;
777 $val = $res->fetchRow();
778 $user_id = $val['user_id'];
780 // If record is ours.
781 if ($user_id == $user->id) {
782 if ($user->can('view_own_reports') || $user->can('view_all_reports')) {
783 $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
786 return false; // No rights.
789 // If record belongs to a user we impersonate.
790 if ($user->behalfUser && $user_id == $user->behalfUser->id) {
791 if ($user->can('view_reports') || $user->can('view_all_reports')) {
792 $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
795 return false; // No rights.
798 // Record belongs to someone else. We need to check user rank.
799 if (!($user->can('view_reports') || $user->can('view_all_reports'))) return false;
800 $max_rank = $user->can('view_all_reports') ? MAX_RANK : $user->getMaxRankForGroup($group_id);
802 $left_joins = ' left join tt_users u on (l.user_id = u.id)';
803 $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
805 $where_part = " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
806 $where_part .= " and r.rank <= $max_rank";
808 $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved".
809 " from tt_log l $left_joins $where_part";
810 $res = $mdb2->query($sql);
811 if (!is_a($res, 'PEAR_Error')) {
812 if (!$res->numRows()) {
815 if ($val = $res->fetchRow()) {
816 $val['can_edit'] = false;
823 // getAllRecords - returns all time records for a certain user.
824 static function getAllRecords($user_id) {
827 $mdb2 = getConnection();
829 $sql = "select l.id, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
830 TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
831 TIME_FORMAT(l.duration, '%k:%i') as duration,
832 l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.paid, l.status
833 from tt_log l where l.user_id = $user_id order by l.id";
834 $res = $mdb2->query($sql);
835 if (!is_a($res, 'PEAR_Error')) {
836 while ($val = $res->fetchRow()) {
844 // getRecords - returns time records for a user for a given date.
845 static function getRecords($date, $includeFiles = false) {
847 $mdb2 = getConnection();
849 $user_id = $user->getUser();
850 $group_id = $user->getGroup();
851 $org_id = $user->org_id;
853 $sql_time_format = "'%k:%i'"; // 24 hour format.
854 if ('%I:%M %p' == $user->getTimeFormat())
855 $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
857 $client_field = null;
858 if ($user->isPluginEnabled('cl'))
859 $client_field = ", c.name as client";
861 $include_cf_1 = $user->isPluginEnabled('cf');
863 $custom_fields = new CustomFields();
864 $cf_1_type = $custom_fields->fields[0]['type'];
865 if ($cf_1_type == CustomFields::TYPE_TEXT) {
866 $custom_field = ", cfl.value as cf_1";
867 } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
868 $custom_field = ", cfo.value as cf_1";
873 $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
874 $fileJoin = " left join (select distinct entity_id from tt_files".
875 " where entity_type = 'time' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
876 " on (l.id = Sub1.entity_id)";
879 $left_joins = " left join tt_projects p on (l.project_id = p.id)".
880 " left join tt_tasks t on (l.task_id = t.id)";
881 if ($user->isPluginEnabled('cl'))
882 $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
884 if ($cf_1_type == CustomFields::TYPE_TEXT)
885 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
886 elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
887 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)".
888 " left join tt_custom_field_options cfo on (cfl.option_id = cfo.id)";
891 $left_joins .= $fileJoin;
894 $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,".
895 " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
896 " TIME_FORMAT(l.duration, '%k:%i') as duration, p.name as project, t.name as task, l.comment,".
897 " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field $custom_field $filePart from tt_log l $left_joins".
898 " where l.date = '$date' and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
899 " order by l.start, l.id";
900 $res = $mdb2->query($sql);
901 if (!is_a($res, 'PEAR_Error')) {
902 while ($val = $res->fetchRow()) {
903 if($val['duration']=='0:00')
912 // canAdd determines if we can add a record in case there is a limit.
913 static function canAdd() {
914 $mdb2 = getConnection();
915 $sql = "select param_value from tt_site_config where param_name = 'exp_date'";
916 $res = $mdb2->query($sql);
917 $val = $res->fetchRow();
918 if (!$val) return true; // No expiration date.
920 if (strtotime($val['param_value']) > time())
921 return true; // Expiration date exists but not reached.