X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttTimeHelper.class.php;h=4e10f4ed749b8d9d89faf9ba8a474d22beb878e0;hb=54bb71ed8e6b7f79e3b26bc1c8a70a95793950c8;hp=9d3f8bbe258d0c7002cbf67b47fa610b87e23e7d;hpb=0cc1dc50345b052d65274c4e686bf3b4cd621c4d;p=timetracker.git diff --git a/WEB-INF/lib/ttTimeHelper.class.php b/WEB-INF/lib/ttTimeHelper.class.php index 9d3f8bbe..4e10f4ed 100644 --- a/WEB-INF/lib/ttTimeHelper.class.php +++ b/WEB-INF/lib/ttTimeHelper.class.php @@ -39,7 +39,11 @@ class ttTimeHelper { // 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)); @@ -82,7 +86,7 @@ class ttTimeHelper { // 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; @@ -102,56 +106,79 @@ class ttTimeHelper { 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->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); - // 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. @@ -162,11 +189,14 @@ class ttTimeHelper { // 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; } @@ -353,23 +383,30 @@ class ttTimeHelper { 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']); @@ -380,20 +417,15 @@ class ttTimeHelper { $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; @@ -402,8 +434,8 @@ class ttTimeHelper { 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; @@ -416,6 +448,7 @@ class ttTimeHelper { // update - updates a record in log table. Does not update its custom fields. static function update($fields) { + global $user; $mdb2 = getConnection(); $id = $fields['id']; @@ -427,20 +460,31 @@ class ttTimeHelper { $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; @@ -453,7 +497,7 @@ class ttTimeHelper { 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; @@ -462,15 +506,22 @@ class ttTimeHelper { } // 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"; + $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; @@ -479,10 +530,16 @@ class ttTimeHelper { } // 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(); @@ -492,33 +549,47 @@ class ttTimeHelper { } // 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 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 0; + return false; } // getUncompleted - retrieves an uncompleted record for user, if one exists. @@ -549,8 +620,8 @@ class ttTimeHelper { // $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(); @@ -596,10 +667,10 @@ class ttTimeHelper { $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) @@ -622,10 +693,10 @@ class ttTimeHelper { $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')) { @@ -640,13 +711,15 @@ class ttTimeHelper { // getRecords - returns time records for a user for a given date. static function getRecords($user_id, $date) { global $user; + $mdb2 = getConnection(); + + $group_id = $user->getGroup(); + $org_id = $user->org_id; + $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.name as client"; @@ -656,12 +729,13 @@ class ttTimeHelper { if ($user->isPluginEnabled('cl')) $left_joins .= " left join tt_clients c on (l.client_id = c.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.invoice_id $client_field from tt_log l $left_joins - where l.date = '$date' and l.user_id = $user_id and l.status = 1 + 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')) {