X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttTimeHelper.class.php;h=d7278c69e747f621c8b3deff9b2f194f97787cf0;hb=d18d90a3f3050def6c646eef7d5420c2d2091393;hp=f98d67572febece955e7a115f46f86a93e4587b1;hpb=1c2cf98a7a062d53e6988f042da2530e1f5d172e;p=timetracker.git diff --git a/WEB-INF/lib/ttTimeHelper.class.php b/WEB-INF/lib/ttTimeHelper.class.php index f98d6757..d7278c69 100644 --- a/WEB-INF/lib/ttTimeHelper.class.php +++ b/WEB-INF/lib/ttTimeHelper.class.php @@ -30,27 +30,79 @@ import('DateAndTime'); // 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)); + // NOTE: this does not work for subgroups with different WEEKEND_START_DAY + // as the setting is per server. Example: a parent group in USA, with a subgroup + // in Saudi Arabia. Their weekends are the same. + // Decided NOT to introduce a configurable WEEKEND_START_DAY for groups in UI + // to keep UI simple, for now. See also Calendar class with the same issue. + $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 $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. + for($i = 0; $i < 4; $i++) { + if ($dateArray[0][$i] != $holiDateSpecArray[0][$i] && $holiDateSpecArray[0][$i] != '*') // * means any digit matches + 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; - + // 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; @@ -60,115 +112,150 @@ class ttTimeHelper { } 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 (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) { - $time_value = $value; - - // If we have a decimal format - convert to time format 00:00. - 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) - $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) - $hours = '0'.$hours; - return $hours.':00'; - } - - // 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 (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) - $hours = '0'.$hours; - return $hours.':'.$time_a[1]; + + // 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, '-'); + + // 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; } - return $res; + // 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; + } + + // 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; + } + + // 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; + } + + // 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); } - - // fromMinutes - converts a number of minutes to format 00:00 - static function fromMinutes($minutes){ + + // toAbsDuration - converts a number of minutes to format 0:00 + // even if $minutes is negative. + static function toAbsDuration($minutes, $abbreviate = false){ $hours = (string)((int)abs($minutes / 60)); - $mins = (string)(abs($minutes % 60)); - if (strlen($hours) == 1) - $hours = '0'.$hours; + $mins = (string) round(abs(fmod($minutes, 60))); if (strlen($mins) == 1) $mins = '0' . $mins; + if ($abbreviate && $mins == '00') + return $hours; + 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; - - return ttTimeHelper::fromMinutes($duration_minutes); + + 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'; @@ -180,103 +267,103 @@ class ttTimeHelper { $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); @@ -289,49 +376,49 @@ class ttTimeHelper { $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) @@ -339,24 +426,31 @@ 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']; + $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']); @@ -367,20 +461,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; @@ -389,8 +478,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; @@ -399,10 +488,11 @@ class ttTimeHelper { $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) { + global $user; $mdb2 = getConnection(); $id = $fields['id']; @@ -414,20 +504,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; @@ -440,80 +541,116 @@ 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; } return true; } - + // 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; - + return true; } - + // 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->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 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->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 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. static function getUncompleted($user_id) { $mdb2 = getConnection(); - $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"; + $sql = "select id, start, date 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')) { if (!$res->numRows()) { @@ -525,7 +662,7 @@ class ttTimeHelper { } return false; } - + // overlaps - determines if a record overlaps with an already existing record. // // Parameters: @@ -536,11 +673,11 @@ 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(); - + $start = ttTimeHelper::to24HourFormat($start); if ($finish) { $finish = ttTimeHelper::to24HourFormat($finish); @@ -573,24 +710,29 @@ class ttTimeHelper { } return false; } - + // 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. - + 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(); - $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"; + $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()) { @@ -602,17 +744,93 @@ class ttTimeHelper { } 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. + + 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']; + + // 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. + } + + // 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. + } + + // 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); + + $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)'; + + $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; + } + } + return false; + } + // getAllRecords - returns all time records for a certain user. static function getAllRecords($user_id) { $result = array(); $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')) { @@ -623,33 +841,63 @@ class ttTimeHelper { 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. - - $result = array(); + static function getRecords($date, $includeFiles = false) { + global $user; $mdb2 = getConnection(); + $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->getTimeFormat()) + $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function. + $client_field = null; if ($user->isPluginEnabled('cl')) $client_field = ", c.name as client"; - + + $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 = ", cfl.value as cf_1"; + } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) { + $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 ($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, 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"; + $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()) { @@ -662,4 +910,17 @@ class ttTimeHelper { return $result; } + // 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. + + if (strtotime($val['param_value']) > time()) + return true; // Expiration date exists but not reached. + + return false; + } }