// isHoliday determines if $date falls on a holiday.
static function isHoliday($date) {
+ global $user;
global $i18n;
+
+ if (!$user->show_holidays) return false;
+
// $date is expected as string in DB_DATEFORMAT.
$month = date('m', strtotime($date));
$day = date('d', strtotime($date));
// 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 (strlen($value) == 0 || !isset($value)) return false;
if ($value == '24:00' || $value == '2400') return true;
return false;
}
- // normalizeDuration - converts a valid time duration string to format 00:00.
- static function normalizeDuration($value, $leadingZero = true) {
- $time_value = $value;
+ // postedDurationToMinutes - converts a value representing a duration
+ // (usually enetered in a form by a user) to an integer number of minutes.
+ //
+ // Parameters:
+ // $duration - user entered duration string. Valid strings are:
+ // 3 or 3h - means 3 hours. Note: h and m letters are not localized.
+ // 0.25 or 0.25h or .25 or .25h - means a quarter of hour.
+ // 0,25 or 0,25h or ,25 or ,25h - same as above for users with comma ad decimal mark.
+ // 1:30 - means 1 hour 30 minutes.
+ // 25m - means 25 minutes.
+ // $max - maximum number of minutes that is valid.
+ //
+ // At the moment, we have 2 variations of duration types:
+ // 1) A duration within a day, such as in a time entry.
+ // These are less or equal to 24*60 minutes.
+ //
+ // 2) A duration of a monthly quota, with max value of 31*24*60 minutes.
+ //
+ // This function is generic to be used for both types.
+ //
+ // Returns false if the value cannot be converted.
+ static function postedDurationToMinutes($duration, $max = 1440) {
+ // Handle empty value.
+ if (!isset($duration) || strlen($duration) == 0)
+ return null; // Value is not set. Caller decides whether it is valid or not.
- // If we have a decimal format - convert to time format 00:00.
- global $user;
- if ($user->decimal_mark == ',')
- $time_value = str_replace (',', '.', $time_value);
+ // Handle whole hours.
+ if (preg_match('/^\d{1,3}h?$/', $duration )) { // 0 - 999, 0h - 999h
+ $minutes = 60 * trim($duration, 'h');
+ return $minutes > $max ? false : $minutes;
+ }
- 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 ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- if (strlen($mins) == 1)
- $mins = '0' . $mins;
- return $hours.':'.$mins;
+ // Handle a normalized duration value.
+ if (preg_match('/^\d{1,3}:[0-5][0-9]$/', $duration )) { // 0:00 - 999:59
+ $time_array = explode(':', $duration);
+ $minutes = (int)@$time_array[1] + ((int)@$time_array[0]) * 60;
+ return $minutes > $max ? false : $minutes;
}
- $time_a = explode(':', $time_value);
- $res = '';
+ // Handle localized fractional hours.
+ global $user;
+ $localizedPattern = '/^(\d{1,3})?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+ if (preg_match($localizedPattern, $duration )) { // decimal values like .5, 1.25h, ... .. 999.9999h (or with comma)
+ if ($user->decimal_mark == ',')
+ $duration = str_replace (',', '.', $duration);
- // 0-99
- if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
- $hours = $time_a[0];
- if ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- return $hours.':00';
+ $minutes = (int)round(60 * floatval($duration));
+ return $minutes > $max ? false : $minutes;
}
- // 000-2359 (2400)
- 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 ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- return $hours.':'.substr($time_value,2,2);
+ // Handle minutes. Some users enter durations like 10m (meaning 10 minutes).
+ if (preg_match('/^\d{1,5}m$/', $duration )) { // 0m - 99999m
+ $minutes = (int) trim($duration, 'm');
+ return $minutes > $max ? false : $minutes;
}
- // 0:00-23:59 (24:00)
- if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
- $hours = $time_a[0];
- if ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- return $hours.':'.$time_a[1];
- }
+ // Everything else is not a valid duration.
+ return false;
+ }
- return $res;
+ // minutesToDuration converts an integer number of minutes into duration string.
+ // Formats returned HH:MM, HHH:MM, HH, or HHH.
+ static function minutesToDuration($minutes, $abbreviate = false) {
+ if ($minutes < 0) return false;
+
+ $hours = (string) (int)($minutes / 60);
+ $mins = (string) round(fmod($minutes, 60));
+ if (strlen($mins) == 1)
+ $mins = '0' . $mins;
+ if ($abbreviate && $mins == '00')
+ return $hours;
+
+ return $hours.':'.$mins;
}
// toMinutes - converts a time string in format 00:00 to a number of minutes.
// toAbsDuration - converts a number of minutes to format 0:00
// even if $minutes is negative.
- static function toAbsDuration($minutes){
+ static function toAbsDuration($minutes, $abbreviate = false){
$hours = (string)((int)abs($minutes / 60));
- $mins = (string)(abs($minutes % 60));
+ $mins = (string) round(abs(fmod($minutes, 60)));
if (strlen($mins) == 1)
$mins = '0' . $mins;
+ if ($abbreviate && $mins == '00')
+ return $hours;
+
return $hours.':'.$mins;
}
// insert - inserts a time record into log table. Does not deal with custom fields.
static function insert($fields)
{
+ global $user;
$mdb2 = getConnection();
- $timestamp = isset($fields['timestamp']) ? $fields['timestamp'] : '';
$user_id = $fields['user_id'];
$date = $fields['date'];
$start = $fields['start'];
$finish = $fields['finish'];
$duration = $fields['duration'];
+ if ($duration) {
+ $minutes = ttTimeHelper::postedDurationToMinutes($duration);
+ $duration = ttTimeHelper::minutesToDuration($minutes);
+ }
$client = $fields['client'];
$project = $fields['project'];
$task = $fields['task'];
$invoice = $fields['invoice'];
$note = $fields['note'];
$billable = $fields['billable'];
+ $paid = $fields['paid'];
if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
$status_f = ', status';
$status_v = ', '.$mdb2->quote($fields['status']);
$finish = ttTimeHelper::to24HourFormat($finish);
if ('00:00' == $finish) $finish = '24:00';
}
- $duration = ttTimeHelper::normalizeDuration($duration);
- if (!$timestamp) {
- $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.
- }
+ $created_v = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id);
if (!$billable) $billable = 0;
+ if (!$paid) $paid = 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)";
+ $sql = "insert into tt_log (user_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid, created, created_ip, created_by $status_f) ".
+ "values ($user_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)";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
if ($duration === false) $duration = 0;
if (!$duration && ttTimeHelper::getUncompleted($user_id)) return false;
- $sql = "insert into tt_log (timestamp, user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable $status_f) ".
- "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)";
+ $sql = "insert into tt_log (user_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid, created, created_ip, created_by $status_f) ".
+ "values ($user_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)";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
// update - updates a record in log table. Does not update its custom fields.
static function update($fields)
{
+ global $user;
$mdb2 = getConnection();
$id = $fields['id'];
$start = $fields['start'];
$finish = $fields['finish'];
$duration = $fields['duration'];
+ if ($duration) {
+ $minutes = ttTimeHelper::postedDurationToMinutes($duration);
+ $duration = ttTimeHelper::minutesToDuration($minutes);
+ }
$note = $fields['note'];
- $billable = $fields['billable'];
+
+ $billable_part = '';
+ if ($user->isPluginEnabled('iv')) {
+ $billable_part = $fields['billable'] ? ', billable = 1' : ', billable = 0';
+ }
+ $paid_part = '';
+ if ($user->can('manage_invoices') && $user->isPluginEnabled('ps')) {
+ $paid_part = $fields['paid'] ? ', paid = 1' : ', paid = 0';
+ }
+ $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
$start = ttTimeHelper::to24HourFormat($start);
$finish = ttTimeHelper::to24HourFormat($finish);
if ('00:00' == $finish) $finish = '24:00';
- $duration = ttTimeHelper::normalizeDuration($duration);
-
- if (!$billable) $billable = 0;
+
if ($start) $duration = '';
if ($duration) {
$sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
- "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+ "comment = ".$mdb2->quote($note)."$billable_part $paid_part $modified_part, date = '$date' WHERE id = $id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
return false;
$sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
- "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+ "comment = ".$mdb2->quote($note)."$billable_part $paid_part $modified_part, date = '$date' WHERE id = $id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
// $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;
+ global $user;
+ if ($user->allow_overlap) return false;
$mdb2 = getConnection();
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;
$mdb2 = getConnection();
- $sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
+ $sql = "select l.id as id, 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.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
+ 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.paid, l.date
from tt_log l
left join tt_projects p on (p.id = l.project_id)
left join tt_tasks t on (t.id = l.task_id)
$mdb2 = getConnection();
- $sql = "select l.id, l.timestamp, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
+ $sql = "select l.id, l.user_id, l.date, TIME_FORMAT(l.start, '%k:%i') as start,
TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish,
TIME_FORMAT(l.duration, '%k:%i') as duration,
- l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.status
+ l.client_id, l.project_id, l.task_id, l.invoice_id, l.comment, l.billable, l.paid, l.status
from tt_log l where l.user_id = $user_id order by l.id";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
return $result;
}
-
- // 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.
- }
-
- // 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;
- }
}
-