// 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;
+ global $user;
+
+ $holidays = $user->getHolidays();
+ if (!$holidays)
+ return false;
+ $holiday_dates = explode(',', $holidays);
+ foreach ($holiday_dates as $holiDateSpec) {
+ if (ttTimeHelper::holidayMatch($date, $holiDateSpec))
+ return true;
+ }
return false;
}
+ // holidayMatch determines if $date matches a single $holiDateSpec.
+ static function holidayMatch($date, $holiDateSpec) {
+
+ $dateArray = explode('-', $date);
+ $holiDateSpecArray = explode('-', $holiDateSpec);
+
+ // Check year.
+ if ($dateArray[0] != $holiDateSpecArray[0] && $holiDateSpecArray[0] != '****') // **** means all years.
+ return false;
+ // Check month.
+ if ($dateArray[1] != $holiDateSpecArray[1])
+ return false;
+ // Check day.
+ if ($dateArray[2] != $holiDateSpecArray[2])
+ return false;
+
+ return true;
+ }
+
+ // dateInDatabaseFormat prepares a date string in DB_DATEFORMAT out of year, month, and day.
+ static function dateInDatabaseFormat($year, $month, $day) {
+ $date = "$year-";
+ if (strlen($month) == 1) $date .= '0';
+ $date .= "$month-";
+ if (strlen($day) == 1) $date .= '0';
+ $date .= $day;
+ return $date;
+ }
+
// isValidTime validates a value as a time string.
static function isValidTime($value) {
if (strlen($value)==0 || !isset($value)) 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 (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.
+
+ // We allow negative durations, similar to negative expenses (installments).
+ $signMultiplier = ttStartsWith($duration, '-') ? -1 : 1;
+ if ($signMultiplier == -1) $duration = ltrim($duration, '-');
- // 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 ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- if (strlen($mins) == 1)
- $mins = '0' . $mins;
- return $hours.':'.$mins;
+ // Handle whole hours.
+ if (preg_match('/^\d{1,3}h?$/', $duration )) { // 0 - 999, 0h - 999h
+ $minutes = 60 * trim($duration, 'h');
+ return $minutes > $max ? false : $signMultiplier * $minutes;
}
- $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 ($leadingZero && strlen($hours) == 1)
- $hours = '0'.$hours;
- return $hours.':00';
+ // 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 : $signMultiplier * $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 localized fractional hours.
+ global $user;
+ $localizedPattern = '/^(\d{1,3})?['.$user->getDecimalMark().'][0-9]{1,4}h?$/';
+ if (preg_match($localizedPattern, $duration )) { // decimal values like .5, 1.25h, ... .. 999.9999h (or with comma)
+ if ($user->getDecimalMark() == ',')
+ $duration = str_replace (',', '.', $duration);
+
+ $minutes = (int)round(60 * floatval($duration));
+ return $minutes > $max ? false : $signMultiplier * $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];
+ // 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 : $signMultiplier * $minutes;
}
- return $res;
+ // Everything else is not a valid duration.
+ return false;
+ }
+
+ // 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) {
+ $sign = $minutes >= 0 ? '' : '-';
+ $minutes = abs($minutes);
+
+ $hours = (string) (int)($minutes / 60);
+ $mins = (string) round(fmod($minutes, 60));
+ if (strlen($mins) == 1)
+ $mins = '0' . $mins;
+ if ($abbreviate && $mins == '00')
+ return $sign.$hours;
+
+ return $sign.$hours.':'.$mins;
}
// toMinutes - converts a time string in format 00:00 to a number of minutes.
static function toMinutes($value) {
+ $signMultiplier = ttStartsWith($value, '-') ? -1 : 1;
+ if ($signMultiplier == -1) $value = ltrim($value, '-');
+
$time_a = explode(':', $value);
- return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
+ return $signMultiplier * ((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){
+ 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;
}
return false;
}
- // insert - inserts a time record into log table. Does not deal with custom fields.
+ // insert - inserts a time record into tt_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'];
+ $user_id = (int) $fields['user_id'];
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_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']).', '.$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, group_id, org_id, date, duration, client_id, project_id, task_id, invoice_id, comment, billable, paid, created, created_ip, created_by $status_f) ".
+ "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)";
$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, 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) ".
+ "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)";
$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 = '.$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;
}
// delete - deletes a record from tt_log table and its associated custom field values.
- static function delete($id, $user_id) {
+ static function delete($id) {
+ global $user;
$mdb2 = getConnection();
- $sql = "update tt_log set status = NULL where id = $id and user_id = $user_id";
+ // Delete associated files.
+ if ($user->isPluginEnabled('at')) {
+ import('ttFileHelper');
+ global $err;
+ $fileHelper = new ttFileHelper($err);
+ if (!$fileHelper->deleteEntityFiles($id, 'time'))
+ return false;
+ }
+
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "update tt_log set status = null".
+ " where id = $id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
$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";
+ $sql = "update tt_custom_field_log set status = null".
+ " where log_id = $id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
}
// getTimeForDay - gets total time for a user for a specific date.
- static function getTimeForDay($user_id, $date) {
+ static function getTimeForDay($date) {
+ global $user;
$mdb2 = getConnection();
- $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date = '$date' and status = 1";
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "select sum(time_to_sec(duration)) as sm from tt_log".
+ " where user_id = $user_id and group_id = $group_id and org_id = $org_id and date = '$date' 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 ttTimeHelper::minutesToDuration($val['sm'] / 60);
}
return false;
}
// getTimeForWeek - gets total time for a user for a given week.
- static function getTimeForWeek($user_id, $date) {
+ static function getTimeForWeek($date) {
+ global $user;
import('Period');
$mdb2 = getConnection();
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
$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->getStartDate(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 group_id = $group_id and org_id = $org_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 ttTimeHelper::minutesToDuration($val['sm'] / 60);
}
- return 0;
+ return false;
}
// getTimeForMonth - gets total time for a user for a given month.
- static function getTimeForMonth($user_id, $date){
+ static function getTimeForMonth($date) {
+ global $user;
import('Period');
$mdb2 = getConnection();
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
$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";
+ $sql = "select sum(time_to_sec(duration)) as sm from tt_log".
+ " where user_id = $user_id and group_id = $group_id and org_id = $org_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 ttTimeHelper::minutesToDuration($val['sm'] / 60);
}
- return 0;
+ return false;
}
// getUncompleted - retrieves an uncompleted record for user, if one exists.
// $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;
+ // getRecord - retrieves a time record identified by its id.
+ static function getRecord($id) {
+ global $user;
+
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $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();
- // 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";
+ $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.timesheet_id, l.invoice_id, l.billable, l.approved, 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)".
+ " 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";
$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.
+ if ($val = $res->fetchRow()) {
+ return $val;
+ }
}
+ return false;
+ }
- // 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;
- }
+ // getRecordForFileView - retrieves a time record identified by its id for
+ // attachment view operation.
+ //
+ // It is different from getRecord, as we want users with appropriate rights
+ // to be able to see other users files, without changing "on behalf" user.
+ // For example, viewing reports for all users and their attached files
+ // from report links.
+ static function getRecordForFileView($id) {
+ // There are several possible situations:
+ //
+ // Record is ours. Check "view_own_reports" or "view_all_reports".
+ // Record is for the current on behalf user. Check "view_reports" or "view_all_reports".
+ // Record is for someone else. Check "view_reports" or "view_all_reports" and rank.
+ //
+ // It looks like the best way is to use 2 queries, obtain user_id first, then check rank.
- // Does the new duration causes the record to overlap with others?
+ global $user;
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $mdb2 = getConnection();
+
+ // Obtain user_id for the time record.
+ $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved from tt_log l ".
+ " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1";
+ $res = $mdb2->query($sql);
+ if (is_a($res, 'PEAR_Error')) return false;
+ if (!$res->numRows()) return false;
+
+ $val = $res->fetchRow();
$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;
+
+ // If record is ours.
+ if ($user_id == $user->id) {
+ if ($user->can('view_own_reports') || $user->can('view_all_reports')) {
+ $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
+ return $val;
+ }
+ return false; // No rights.
}
- return true; // There are no conflicts, safe to modify.
- }
+ // If record belongs to a user we impersonate.
+ if ($user->behalfUser && $user_id == $user->behalfUser->id) {
+ if ($user->can('view_reports') || $user->can('view_all_reports')) {
+ $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
+ return $val;
+ }
+ return false; // No rights.
+ }
- // 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.
+ // Record belongs to someone else. We need to check user rank.
+ if (!($user->can('view_reports') || $user->can('view_all_reports'))) return false;
+ $max_rank = $user->can('view_all_reports') ? MAX_RANK : $user->getMaxRankForGroup($group_id);
- $mdb2 = getConnection();
+ $left_joins = ' left join tt_users u on (l.user_id = u.id)';
+ $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
- $sql = "select l.id as id, l.timestamp as timestamp, 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
- 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)
- where l.id = $id and l.user_id = $user_id and l.status = 1";
+ $where_part = " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
+ $where_part .= " and r.rank <= $max_rank";
+
+ $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved".
+ " from tt_log l $left_joins $where_part";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
if (!$res->numRows()) {
return false;
}
if ($val = $res->fetchRow()) {
+ $val['can_edit'] = false;
return $val;
}
}
$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')) {
}
// getRecords - returns time records for a user for a given date.
- static function getRecords($user_id, $date) {
+ static function getRecords($date, $includeFiles = false) {
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.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 ($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,
- 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, t.name as task, l.comment, l.billable, l.invoice_id $client_field
- from tt_log l
- $left_joins
- where l.date = '$date' and l.user_id = $user_id and l.status = 1
- order by 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;
- }
+ $user_id = $user->getUser();
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
- // 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)
+ if ('%I:%M %p' == $user->getTimeFormat())
$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';
+ $client_field = ", c.name as client";
- $custom_field_1 = null;
- if ($user->isPluginEnabled('cf')) {
- $custom_fields = new CustomFields($user->team_id);
+ $include_cf_1 = $user->isPluginEnabled('cf');
+ if ($include_cf_1) {
+ $custom_fields = new CustomFields();
$cf_1_type = $custom_fields->fields[0]['type'];
if ($cf_1_type == CustomFields::TYPE_TEXT) {
- $custom_field_1 = ', cfl.value as cf_1_value';
+ $custom_field = ", cfl.value as cf_1";
} elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
- $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
+ $custom_field = ", cfo.value as cf_1";
}
}
+ if ($includeFiles) {
+ $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
+ $fileJoin = " left join (select distinct entity_id from tt_files".
+ " where entity_type = 'time' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
+ " on (l.id = Sub1.entity_id)";
+ }
+
$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) ';
+ if ($include_cf_1) {
+ if ($cf_1_type == CustomFields::TYPE_TEXT)
+ $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
+ elseif ($cf_1_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)";
+ }
}
+ $left_joins .= $fileJoin;
- $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";
+ $result = array();
+ $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, t.name as task, l.comment,".
+ " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field $custom_field $filePart from tt_log l $left_joins".
+ " 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".
+ " order by l.start, l.id";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
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);
- }
+ // canAdd determines if we can add a record in case there is a limit.
+ static function canAdd() {
+ $mdb2 = getConnection();
+ $sql = "select param_value from tt_site_config where param_name = 'exp_date'";
+ $res = $mdb2->query($sql);
+ $val = $res->fetchRow();
+ if (!$val) return true; // No expiration date.
- // 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;
- }
+ if (strtotime($val['param_value']) > time())
+ return true; // Expiration date exists but not reached.
- // 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;
- }
-
- // 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