// The ttTimeHelper is a class to help with time-related values.
class ttTimeHelper {
-
- /* // isWeekend determines if $date falls on weekend.
+
+ // isWeekend determines if $date falls on weekend.
static function isWeekend($date) {
- $weekDay = date('w', strtotime($date));
+ $weekDay = date('w', strtotime($date));
return ($weekDay == WEEKEND_START_DAY || $weekDay == (WEEKEND_START_DAY + 1) % 7);
- }*/
+ }
+
+ // isHoliday determines if $date falls on a holiday.
+ static function isHoliday($date) {
+ global $i18n;
+ // $date is expected as string in DB_DATEFORMAT.
+ $month = date('m', strtotime($date));
+ $day = date('d', strtotime($date));
+ if (in_array($month.'/'.$day, $i18n->holidays))
+ return true;
+
+ return false;
+ }
// isValidTime validates a value as a time string.
static function isValidTime($value) {
if (strlen($value)==0 || !isset($value)) return false;
-
+
// 24 hour patterns.
if ($value == '24:00' || $value == '2400') return true;
-
+
if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
return true;
}
if (preg_match('/^([0-1]{0,1}[0-9]|[2][0-4])$/', $value )) { // 0 - 24
return true;
- }
-
+ }
+
// 12 hour patterns
if (preg_match('/^[1-9]\s?(am|AM|pm|PM)$/', $value)) { // 1 - 9 am
return true;
}
if (preg_match('/^[1-9]:?[0-5][0-9]\s?(am|AM|pm|PM)$/', $value)) { // 1:00 - 9:59 am, 100 - 959 am
return true;
- }
+ }
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
- return true;
+ return true;
}
return false;
}
-
+
// isValidDuration validates a value as a time duration string (in hours and minutes).
static function isValidDuration($value) {
if (strlen($value)==0 || !isset($value)) return false;
-
+
if ($value == '24:00' || $value == '2400') return true;
if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
return true;
}
if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
return true;
}
- 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
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
+
+ global $user;
+ $localizedPattern = '/^([0-1]{0,1}[0-9]|2[0-3])?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+ if (preg_match($localizedPattern, $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h (or with comma)
return true;
}
+
return false;
}
-
+
// normalizeDuration - converts a valid time duration string to format 00:00.
- static function normalizeDuration($value) {
+ static function normalizeDuration($value, $leadingZero = true) {
$time_value = $value;
-
+
// If we have a decimal format - convert to time format 00:00.
+ global $user;
+ if ($user->decimal_mark == ',')
+ $time_value = str_replace (',', '.', $time_value);
+
if((strpos($time_value, '.') !== false) || (strpos($time_value, 'h') !== false)) {
$val = floatval($time_value);
$mins = round($val * 60);
$hours = (string)((int)($mins / 60));
$mins = (string)($mins % 60);
- if (strlen($hours) == 1)
+ if ($leadingZero && strlen($hours) == 1)
$hours = '0'.$hours;
if (strlen($mins) == 1)
$mins = '0' . $mins;
return $hours.':'.$mins;
}
-
+
$time_a = explode(':', $time_value);
$res = '';
// 0-99
if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
$hours = $time_a[0];
- if (strlen($hours) == 1)
+ if ($leadingZero && strlen($hours) == 1)
$hours = '0'.$hours;
return $hours.':00';
}
if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) {
if (strlen($time_value)==3) $time_value = '0'.$time_value;
$hours = substr($time_value,0,2);
- if (strlen($hours) == 1)
+ if ($leadingZero && strlen($hours) == 1)
$hours = '0'.$hours;
return $hours.':'.substr($time_value,2,2);
}
// 0:00-23:59 (24:00)
if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
$hours = $time_a[0];
- if (strlen($hours) == 1)
+ if ($leadingZero && strlen($hours) == 1)
$hours = '0'.$hours;
return $hours.':'.$time_a[1];
}
return $res;
}
-
+
// toMinutes - converts a time string in format 00:00 to a number of minutes.
static function toMinutes($value) {
$time_a = explode(':', $value);
return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
}
-
+
+ // toAbsDuration - converts a number of minutes to format 0:00
+ // even if $minutes is negative.
+ static function toAbsDuration($minutes){
+ $hours = (string)((int)abs($minutes / 60));
+ $mins = (string)(abs($minutes % 60));
+ if (strlen($mins) == 1)
+ $mins = '0' . $mins;
+ return $hours.':'.$mins;
+ }
+
// toDuration - calculates duration between start and finish times in 00:00 format.
static function toDuration($start, $finish) {
$duration_minutes = ttTimeHelper::toMinutes($finish) - ttTimeHelper::toMinutes($start);
if ($duration_minutes <= 0) return false;
-
- $hours = (string)((int)($duration_minutes / 60));
- $mins = (string)($duration_minutes % 60);
- if (strlen($hours) == 1)
- $hours = '0'.$hours;
- if (strlen($mins) == 1)
- $mins = '0' . $mins;
- return $hours.':'.$mins;
+
+ return ttTimeHelper::toAbsDuration($duration_minutes);
}
-
+
// The to12HourFormat function converts a 24-hour time value (such as 15:23) to 12 hour format (03:23 PM).
static function to12HourFormat($value) {
- if ('24:00' == $value) return '12:00 AM';
-
+ if ('24:00' == $value) return '12:00 AM';
+
$time_a = explode(':', $value);
if ($time_a[0] > 12)
$res = (string)((int)$time_a[0] - 12).':'.$time_a[1].' PM';
- else if ($time_a[0] == 12)
+ elseif ($time_a[0] == 12)
$res = $value.' PM';
- else if ($time_a[0] == 0)
+ elseif ($time_a[0] == 0)
$res = '12:'.$time_a[1].' AM';
else
$res = $value.' AM';
return $res;
}
-
+
// The to24HourFormat function attempts to convert a string value (human readable notation of time of day)
// to a 24-hour time format HH:MM.
static function to24HourFormat($value) {
- $res = null;
-
- // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
- $tmp_val = trim($value);
-
- // 24 hour patterns.
- if (preg_match('/^([01][0-9]|2[0-3]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 23:59
- // We already have a 24-hour format. Just return it.
- $res = $tmp_val;
- return $res;
- }
- if (preg_match('/^[0-9]:[0-5][0-9]$/', $tmp_val)) { // 0:00 - 9:59
- // This is a 24-hour format without a leading zero. Add 0 and return.
- $res = '0'.$tmp_val;
- return $res;
- }
+ $res = null;
+
+ // Algorithm: use regular expressions to find a matching pattern, starting with most popular patterns first.
+ $tmp_val = trim($value);
+
+ // 24 hour patterns.
+ if (preg_match('/^([01][0-9]|2[0-3]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 23:59
+ // We already have a 24-hour format. Just return it.
+ $res = $tmp_val;
+ return $res;
+ }
+ if (preg_match('/^[0-9]:[0-5][0-9]$/', $tmp_val)) { // 0:00 - 9:59
+ // This is a 24-hour format without a leading zero. Add 0 and return.
+ $res = '0'.$tmp_val;
+ return $res;
+ }
if (preg_match('/^[0-9]$/', $tmp_val)) { // 0 - 9
- // Single digit. Assuming hour number.
- $res = '0'.$tmp_val.':00';
- return $res;
- }
+ // Single digit. Assuming hour number.
+ $res = '0'.$tmp_val.':00';
+ return $res;
+ }
if (preg_match('/^([01][0-9]|2[0-4])$/', $tmp_val)) { // 00 - 24
- // Two digit hour number.
- $res = $tmp_val.':00';
- return $res;
- }
+ // Two digit hour number.
+ $res = $tmp_val.':00';
+ return $res;
+ }
if (preg_match('/^[0-9][0-5][0-9]$/', $tmp_val)) { // 000 - 959
- // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
- $tmp_arr = str_split($tmp_val);
- $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
- return $res;
- }
+ // Missing colon. We'll assume the first digit is the hour, the rest is minutes.
+ $tmp_arr = str_split($tmp_val);
+ $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
+ return $res;
+ }
if (preg_match('/^([01][0-9]|2[0-3])[0-5][0-9]$/', $tmp_val)) { // 0000 - 2359
- // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
- $tmp_arr = str_split($tmp_val);
- $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
- return $res;
- }
- // Special handling for midnight.
+ // Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
+ $tmp_arr = str_split($tmp_val);
+ $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
+ return $res;
+ }
+ // Special handling for midnight.
if ($tmp_val == '24:00' || $tmp_val == '2400')
- return '24:00';
-
+ return '24:00';
+
// 12 hour AM patterns.
if (preg_match('/.(am|AM)$/', $tmp_val)) {
-
+
// The $value ends in am or AM. Strip it.
$tmp_val = rtrim(substr($tmp_val, 0, -2));
-
+
// Special case to handle 12, 12:MM, and 12MM AM.
if (preg_match('/^12:?([0-5][0-9])?$/', $tmp_val))
$tmp_val = '00'.substr($tmp_val, 2);
-
+
// We are ready to convert AM time.
if (preg_match('/^(0[0-9]|1[0-1]):[0-5][0-9]$/', $tmp_val)) { // 00:00 - 11:59
- // We already have a 24-hour format. Just return it.
- $res = $tmp_val;
+ // We already have a 24-hour format. Just return it.
+ $res = $tmp_val;
+ return $res;
+ }
+ if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
+ // This is a 24-hour format without a leading zero. Add 0 and return.
+ $res = '0'.$tmp_val;
return $res;
- }
- if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
- // This is a 24-hour format without a leading zero. Add 0 and return.
- $res = '0'.$tmp_val;
- return $res;
- }
+ }
if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
- // Single digit. Assuming hour number.
- $res = '0'.$tmp_val.':00';
- return $res;
- }
- if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
- // Two digit hour number.
- $res = $tmp_val.':00';
- return $res;
- }
+ // Single digit. Assuming hour number.
+ $res = '0'.$tmp_val.':00';
+ return $res;
+ }
+ if (preg_match('/^(0[0-9]|1[0-1])$/', $tmp_val)) { // 00 - 11
+ // Two digit hour number.
+ $res = $tmp_val.':00';
+ return $res;
+ }
if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
// Missing colon. Assume the first digit is the hour, the rest is minutes.
- $tmp_arr = str_split($tmp_val);
- $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
- return $res;
- }
+ $tmp_arr = str_split($tmp_val);
+ $res = '0'.$tmp_arr[0].':'.$tmp_arr[1].$tmp_arr[2];
+ return $res;
+ }
if (preg_match('/^(0[0-9]|1[0-1])[0-5][0-9]$/', $tmp_val)) { // 0000 - 1159
// Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
- $tmp_arr = str_split($tmp_val);
- $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
- return $res;
- }
+ $tmp_arr = str_split($tmp_val);
+ $res = $tmp_arr[0].$tmp_arr[1].':'.$tmp_arr[2].$tmp_arr[3];
+ return $res;
+ }
} // AM cases handling.
// 12 hour PM patterns.
if (preg_match('/.(pm|PM)$/', $tmp_val)) {
-
+
// The $value ends in pm or PM. Strip it.
$tmp_val = rtrim(substr($tmp_val, 0, -2));
-
+
if (preg_match('/^[1-9]$/', $tmp_val)) { // 1 - 9
// Single digit. Assuming hour number.
$hour = (string)(12 + (int)$tmp_val);
$tmp_val = (string)(12 + (int)$tmp_val);
$res = $tmp_val.':00';
return $res;
- }
+ }
if (preg_match('/^[1-9][0-5][0-9]$/', $tmp_val)) { // 100 - 959
// Missing colon. We'll assume the first digit is the hour, the rest is minutes.
- $tmp_arr = str_split($tmp_val);
- $hour = (string)(12 + (int)$tmp_arr[0]);
- $res = $hour.':'.$tmp_arr[1].$tmp_arr[2];
- return $res;
- }
- if (preg_match('/^(0[1-9]|1[0-2])[0-5][0-9]$/', $tmp_val)) { // 0100 - 1259
+ $tmp_arr = str_split($tmp_val);
+ $hour = (string)(12 + (int)$tmp_arr[0]);
+ $res = $hour.':'.$tmp_arr[1].$tmp_arr[2];
+ return $res;
+ }
+ if (preg_match('/^(0[1-9]|1[0-2])[0-5][0-9]$/', $tmp_val)) { // 0100 - 1259
// Missing colon. We'll assume the first 2 digits are the hour, the rest is minutes.
$hour = substr($tmp_val, 0, -2);
$min = substr($tmp_val, 2);
if ('12' != $hour)
- $hour = (string)(12 + (int)$hour);
- $res = $hour.':'.$min;
- return $res;
- }
+ $hour = (string)(12 + (int)$hour);
+ $res = $hour.':'.$min;
+ return $res;
+ }
if (preg_match('/^[1-9]:[0-5][0-9]$/', $tmp_val)) { // 1:00 - 9:59
- $hour = substr($tmp_val, 0, -3);
+ $hour = substr($tmp_val, 0, -3);
$min = substr($tmp_val, 2);
$hour = (string)(12 + (int)$hour);
- $res = $hour.':'.$min;
- return $res;
- }
+ $res = $hour.':'.$min;
+ return $res;
+ }
if (preg_match('/^(0[1-9]|1[0-2]):[0-5][0-9]$/', $tmp_val)) { // 01:00 - 12:59
- $hour = substr($tmp_val, 0, -3);
+ $hour = substr($tmp_val, 0, -3);
$min = substr($tmp_val, 3);
if ('12' != $hour)
$hour = (string)(12 + (int)$hour);
- $res = $hour.':'.$min;
+ $res = $hour.':'.$min;
return $res;
- }
+ }
} // PM cases handling.
return $res;
}
-
+
// isValidInterval - checks if finish time is greater than start time.
static function isValidInterval($start, $finish) {
$start = ttTimeHelper::to24HourFormat($start);
$finish = ttTimeHelper::to24HourFormat($finish);
if ('00:00' == $finish) $finish = '24:00';
-
+
$minutesStart = ttTimeHelper::toMinutes($start);
$minutesFinish = ttTimeHelper::toMinutes($finish);
if ($minutesFinish > $minutesStart)
return false;
}
-
+
// insert - inserts a time record into log table. Does not deal with custom fields.
static function insert($fields)
{
$date = $fields['date'];
$start = $fields['start'];
$finish = $fields['finish'];
- $duration = $fields['duration'];
+ $duration = $fields['duration'];
$client = $fields['client'];
$project = $fields['project'];
$task = $fields['task'];
$duration = ttTimeHelper::normalizeDuration($duration);
if (!$timestamp) {
- $timestamp = date('YmdHis');//yyyymmddhhmmss
+ $timestamp = date('YmdHis'); //yyyymmddhhmmss
+ // TODO: this timestamp could be illegal if we hit inside DST switch deadzone, such as '2016-03-13 02:30:00'
+ // Anything between 2am and 3am on DST introduction date will not work if we run on a system with DST on.
+ // We need to address this properly to avoid potential complications.
}
-
+
if (!$billable) $billable = 0;
-
+
if ($duration) {
$sql = "insert into tt_log (timestamp, user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
"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)";
$id = $mdb2->lastInsertID('tt_log', 'id');
return $id;
}
-
+
// update - updates a record in log table. Does not update its custom fields.
static function update($fields)
{
}
return true;
}
-
+
// delete - deletes a record from tt_log table and its associated custom field values.
static function delete($id, $user_id) {
$mdb2 = getConnection();
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
-
+
$sql = "update tt_custom_field_log set status = NULL where log_id = $id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
-
+
return true;
}
-
+
// getTimeForDay - gets total time for a user for a specific date.
static function getTimeForDay($user_id, $date) {
$mdb2 = getConnection();
}
return false;
}
-
+
// getTimeForWeek - gets total time for a user for a given week.
static function getTimeForWeek($user_id, $date) {
import('Period');
$mdb2 = getConnection();
$period = new Period(INTERVAL_THIS_WEEK, $date);
- $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";
+ $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";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ return sec_to_time_fmt_hm($val['sm']);
+ }
+ return 0;
+ }
+
+ // getTimeForMonth - gets total time for a user for a given month.
+ static function getTimeForMonth($user_id, $date){
+ import('Period');
+ $mdb2 = getConnection();
+
+ $period = new Period(INTERVAL_THIS_MONTH, $date);
+ $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";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
$val = $res->fetchRow();
}
return 0;
}
-
+
// getUncompleted - retrieves an uncompleted record for user, if one exists.
static function getUncompleted($user_id) {
$mdb2 = getConnection();
- $sql = "select id from tt_log
+ $sql = "select id, start from tt_log
where user_id = $user_id and start is not null and time_to_sec(duration) = 0 and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
}
return false;
}
-
+
// overlaps - determines if a record overlaps with an already existing record.
//
// Parameters:
// $finish - new record finish time, may be null
// $record_id - optional record id we may be editing, excluded from overlap set
static function overlaps($user_id, $date, $start, $finish, $record_id = null) {
+ // Do not bother checking if we allow overlaps.
+ if (defined('ALLOW_OVERLAP') && ALLOW_OVERLAP == true)
+ return false;
+
$mdb2 = getConnection();
-
+
$start = ttTimeHelper::to24HourFormat($start);
if ($finish) {
$finish = ttTimeHelper::to24HourFormat($finish);
}
return false;
}
-
+
+ // wvCanModify (weekViewCanModify) - determines if an already existing tt_log record
+ // can be modified with a new user-provided duration.
+ static function wvCanModify($tt_log_id, $new_duration, $err) {
+ global $i18n;
+ $mdb2 = getConnection();
+
+ // Determine if we have start time in record, as further checking does not makes sense otherwise.
+ $sql = "select user_id, date, start, duration from tt_log where id = $tt_log_id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ if (!$res->numRows()) {
+ $err->add($i18n->getKey('error.db')); // This is not expected.
+ return false;
+ }
+ $val = $res->fetchRow();
+ $oldDuration = $val['duration'];
+ if (!$val['start'])
+ return true; // There is no start time in the record, therefore safe to modify.
+ }
+
+ // We do have start time.
+ // Quick test if new duration is less then already existing.
+ $newMinutes = ttTimeHelper::toMinutes($new_duration);
+ $oldMinutes = ttTimeHelper::toMinutes($oldDuration);
+ if ($newMinutes < $oldMinutes)
+ return true; // Safe to modify.
+
+ // Does the new duration put the record beyond 24:00 boundary?
+ $startMinutes = ttTimeHelper::toMinutes($val['start']);
+ $newEndMinutes = $startMinutes + $newMinutes;
+ if ($newEndMinutes > 1440) {
+ // Invalid duration, as new duration puts the record beyond current day.
+ $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
+ return false;
+ }
+
+ // Does the new duration causes the record to overlap with others?
+ $user_id = $val['user_id'];
+ $date = $val['date'];
+ $startMinutes = ttTimeHelper::toMinutes($val['start']);
+ $start = ttTimeHelper::toAbsDuration($startMinutes);
+ $finish = ttTimeHelper::toAbsDuration($newEndMinutes);
+ if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) {
+ $err->add($i18n->getKey('error.overlap'));
+ return false;
+ }
+
+ return true; // There are no conflicts, safe to modify.
+ }
+
// getRecord - retrieves a time record identified by its id.
static function getRecord($id, $user_id) {
- global $user;
- $sql_time_format = "'%k:%i'"; // 24 hour format.
- if ('%I:%M %p' == $user->time_format)
- $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
-
+ global $user;
+ $sql_time_format = "'%k:%i'"; // 24 hour format.
+ if ('%I:%M %p' == $user->time_format)
+ $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
+
$mdb2 = getConnection();
$sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
}
return false;
}
-
+
// getAllRecords - returns all time records for a certain user.
static function getAllRecords($user_id) {
$result = array();
return $result;
}
-
+
// getRecords - returns time records for a user for a given date.
static function getRecords($user_id, $date) {
- global $user;
- $sql_time_format = "'%k:%i'"; // 24 hour format.
- if ('%I:%M %p' == $user->time_format)
- $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
-
+ global $user;
+ $sql_time_format = "'%k:%i'"; // 24 hour format.
+ if ('%I:%M %p' == $user->time_format)
+ $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
+
$result = array();
$mdb2 = getConnection();
$client_field = null;
- if (in_array('cl', explode(',', $user->plugins)))
+ if ($user->isPluginEnabled('cl'))
$client_field = ", c.name as client";
-
+
$left_joins = " left join tt_projects p on (l.project_id = p.id)".
" left join tt_tasks t on (l.task_id = t.id)";
- if (in_array('cl', explode(',', $user->plugins)))
+ if ($user->isPluginEnabled('cl'))
$left_joins .= " left join tt_clients c on (l.client_id = c.id)";
$sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
return $result;
}
+ // getRecordsForInterval - returns time records for a user for a given interval of dates.
+ static function getRecordsForInterval($user_id, $start_date, $end_date) {
+ global $user;
+ $sql_time_format = "'%k:%i'"; // 24 hour format.
+ if ('%I:%M %p' == $user->time_format)
+ $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
+
+ $result = array();
+ $mdb2 = getConnection();
+
+ $client_field = null;
+ if ($user->isPluginEnabled('cl'))
+ $client_field = ', c.id as client_id, c.name as client';
+
+ $custom_field_1 = null;
+ if ($user->isPluginEnabled('cf')) {
+ $custom_fields = new CustomFields($user->team_id);
+ $cf_1_type = $custom_fields->fields[0]['type'];
+ if ($cf_1_type == CustomFields::TYPE_TEXT) {
+ $custom_field_1 = ', cfl.value as cf_1_value';
+ } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
+ $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
+ }
+ }
+
+ $left_joins = " left join tt_projects p on (l.project_id = p.id)".
+ " left join tt_tasks t on (l.task_id = t.id)";
+ if ($user->isPluginEnabled('cl'))
+ $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
+ if ($user->isPluginEnabled('cf')) {
+ if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
+ $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) ';
+ elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
+ $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.option_id = cfo.id) ';
+ }
+
+ $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
+ TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
+ TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
+ t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
+ from tt_log l
+ $left_joins
+ where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
+ order by p.name, t.name, l.date, l.start, l.id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ if($val['duration']=='0:00')
+ $val['finish'] = '';
+ $result[] = $val;
+ }
+ } else return false;
+
+ return $result;
+ }
+
+ // getDataForWeekView - builds an array to render a table of durations for week view.
+ // In a week view we want one row representing the same attributes to have 7 values for each day of week.
+ // We identify simlar records by a combination of client, billable, project, task, and custom field values.
+ // This will allow us to extend the feature when more custom fields are added.
+ //
+ // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
+ // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
+ //
+ // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
+ // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
+ //
+ // Description of $dataArray format that the function returns.
+ // $dataArray = array(
+ // array( // Row 0. This is a special, one-off row for a new week entry with empty values.
+ // 'row_id' => null', // Row identifier. Null for a new entry.
+ // 'label' => 'New entry', // Human readable label for the row describing what this time entry is for.
+ // 'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => null, 'duration' => null), // control_id is row_id plus day header for column.
+ // 'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => null, 'duration' => null),
+ // 'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => null, 'duration' => null),
+ // 'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
+ // 'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => null, 'duration' => null),
+ // 'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => null, 'duration' => null),
+ // 'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
+ // ),
+ // array( // Row 1.
+ // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
+ // 'label' => 'Anuko - Time Tracker - Coding', // Human readable label for the row describing what this time entry is for.
+ // 'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
+ // 'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
+ // 'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
+ // 'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'duration' => null),
+ // 'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
+ // 'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
+ // 'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
+ // ),
+ // array( // Row 2.
+ // 'row_id' => 'bl:0_0',
+ // 'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
+ // 'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => null, 'duration' => null),
+ // 'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
+ // 'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => null, 'duration' => null),
+ // 'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
+ // 'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
+ // 'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => null, 'duration' => null),
+ // 'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
+ // )
+ // );
+ static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
+ global $i18n;
+
+ // Start by obtaining all records in interval.
+ $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
+
+ $dataArray = array();
+
+ // Construct the first row for a brand new entry.
+ $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry')); // Insert row.
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = '0_'. $dayHeaders[$i];
+ $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
+ }
+
+ // Iterate through records and build $dataArray cell by cell.
+ foreach ($records as $record) {
+ // Create record id without suffix.
+ $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
+ // Handle potential multiple records with the same attributes by using a numerical suffix.
+ $suffix = 0;
+ $record_id = $record_id_no_suffix.'_'.$suffix;
+ $day_header = substr($record['date'], 8); // Day number in month.
+ while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
+ $suffix++;
+ $record_id = $record_id_no_suffix.'_'.$suffix;
+ }
+ // Find row.
+ $pos = ttTimeHelper::findRow($record_id, $dataArray);
+ if ($pos < 0) {
+ $dataArray[] = array('row_id' => $record_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
+ $pos = ttTimeHelper::findRow($record_id, $dataArray);
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = $pos.'_'. $dayHeaders[$i];
+ $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
+ }
+ }
+ // Insert actual cell data from $record (one cell only).
+ $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
+ }
+ return $dataArray;
+ }
+
+ // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
+ // and a day header already exists.
+ static function cellExists($row_id, $day_header, $dataArray) {
+ foreach($dataArray as $row) {
+ if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
+ return true;
+ }
+ return false;
+ }
+
+ // findRow returns an existing row position in $dataArray, -1 otherwise.
+ static function findRow($row_id, $dataArray) {
+ $pos = 0; // Row position in array.
+ foreach($dataArray as $row) {
+ if ($row['row_id'] == $row_id)
+ return $pos;
+ $pos++; // Increment for search.
+ }
+ return -1; // Row not found.
+ }
+
+ // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
+ // For example:
+ // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
+ // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
+ // See comment for getGroupedRecordsForInterval.
+ static function makeRecordIdentifier($record) {
+ global $user;
+ // Start with client.
+ if ($user->isPluginEnabled('cl'))
+ $record_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
+ // Add billable flag.
+ if (!empty($record_identifier)) $record_identifier .= ',';
+ $record_identifier .= 'bl:'.$record['billable'];
+ // Add project.
+ $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
+ // Add task.
+ $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
+ // Add custom field 1. This requires modifying the query to get the data we need.
+ if ($user->isPluginEnabled('cf')) {
+ if ($record['cf_1_id'])
+ $record_identifier .= ',cf_1:'.$record['cf_1_id'];
+ else if ($record['cf_1_value'])
+ $record_identifier .= ',cf_1:'.$record['cf_1_value'];
+ }
+
+ return $record_identifier;
+ }
+
+ // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
+ static function getDayHeadersForWeek($start_date) {
+ $dayHeaders = array();
+ $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+ $dayHeaders[] = (string) $objDate->getDate(); // It returns an int on first call.
+ if (strlen($dayHeaders[0]) == 1) // Which is an implementation detail of DateAndTime class.
+ $dayHeaders[0] = '0'.$dayHeaders[0]; // Add a 0 for single digit day.
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders[] = $objDate->getDate();
+ unset($objDate);
+ return $dayHeaders;
+ }
+
+ // getLockedDaysForWeek - builds an array of locked days in week.
+ static function getLockedDaysForWeek($start_date) {
+ global $user;
+ $lockedDays = array();
+ $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+ for ($i = 0; $i < 7; $i++) {
+ $lockedDays[] = $user->isDateLocked($objDate);
+ $objDate->incDay();
+ }
+ unset($objDate);
+ return $lockedDays;
+ }
+
+ // getDayTotals calculates total durations for each day from the existing data in $dataArray.
+ static function getDayTotals($dataArray, $dayHeaders) {
+ $dayTotals = array();
+
+ // Insert label.
+ global $i18n;
+ $dayTotals['label'] = $i18n->getKey('label.day_total');
+
+ foreach ($dataArray as $row) {
+ foreach($dayHeaders as $dayHeader) {
+ if (array_key_exists($dayHeader, $row)) {
+ $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
+ $dayTotals[$dayHeader] += $minutes;
+ }
+ }
+ }
+ // Convert minutes to hh:mm for display.
+ foreach($dayHeaders as $dayHeader) {
+ $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
+ }
+ return $dayTotals;
+ }
+
+ // dateFromDayHeader calculates date from start date and day header in week view.
+ static function dateFromDayHeader($start_date, $day_header) {
+ $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+ $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
+ if (strlen($currentDayHeader) == 1) // Which is an implementation detail of DateAndTime class.
+ $currentDayHeader = '0'.$currentDayHeader; // Add a 0 for single digit day.
+ $i = 1;
+ while ($currentDayHeader != $day_header && $i < 7) {
+ // Iterate through remaining days to find a match.
+ $objDate->incDay();
+ $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
+ $i++;
+ }
+ return $objDate->toString(DB_DATEFORMAT);
+ }
+
+ // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
+ static function insertDurationFromWeekView($fields, $custom_fields, $err) {
+ global $i18n;
+ global $user;
+
+ // Determine date for a new entry.
+ $entry_date = ttTimeHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
+ $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
+
+ // Prohibit creating entries in future.
+ if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
+ $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
+ if ($objEntryDate->after($objBrowserToday)) {
+ $err->add($i18n->getKey('error.future_date'));
+ return false;
+ }
+ }
+
+ // Prepare an array of fields for regular insert function.
+ $fields4insert = array();
+ $fields4insert['user_id'] = $user->getActiveUser();
+ $fields4insert['date'] = $entry_date;
+ $fields4insert['duration'] = $fields['duration'];
+ $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
+ $fields4insert['billable'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
+ $fields4insert['project'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
+ $fields4insert['task'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
+ $fields4insert['note'] = $fields['note'];
+
+ // Try to insert a record.
+ $id = ttTimeHelper::insert($fields4insert);
+ if (!$id) return false; // Something failed.
+
+ // Insert custom field if we have it.
+ $result = true;
+ $cf_1 = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
+ if ($custom_fields && $cf_1) {
+ if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
+ $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
+ elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
+ $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
+ }
+
+ return $result;
+ }
+
+
+ // modifyFromWeekView - modifies a duration of an existing record from a week view post.
+ static function modifyDurationFromWeekView($fields, $err) {
+ global $i18n;
+ global $user;
+
+ // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
+ // TODO: rename this function.
+ // Handle different errors with specific error messages.
+ if (!ttTimeHelper::wvCanModify($fields['tt_log_id'], $fields['duration'], $err)) {
+ // $err->add($i18n->getKey('error.overlap'));
+ return false;
+ }
+
+ $mdb2 = getConnection();
+ $duration = $fields['duration'];
+ $tt_log_id = $fields['tt_log_id'];
+ $user_id = $user->getActiveUser();
+ $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ return true;
+ }
}
+
projects / timetracker.git / blobdiff