X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttTimeHelper.class.php;h=5a868364e5f311f9ae569e1e42bb80aa0d4e12b9;hb=14304210865aab4372e8e726f64d830c0a077de5;hp=50904886b8c5556cca9b0e5de5203fd0077dd4f5;hpb=f9c733be2744ccc1264291760aa9b02a3c861193;p=timetracker.git diff --git a/WEB-INF/lib/ttTimeHelper.class.php b/WEB-INF/lib/ttTimeHelper.class.php index 50904886..5a868364 100644 --- a/WEB-INF/lib/ttTimeHelper.class.php +++ b/WEB-INF/lib/ttTimeHelper.class.php @@ -103,7 +103,7 @@ class ttTimeHelper { } // normalizeDuration - converts a valid time duration string to format 00:00. - static function normalizeDuration($value) { + static function normalizeDuration($value, $leadingZero = true) { $time_value = $value; // If we have a decimal format - convert to time format 00:00. @@ -116,7 +116,7 @@ class ttTimeHelper { $mins = round($val * 60); $hours = (string)((int)($mins / 60)); $mins = (string)($mins % 60); - if (strlen($hours) == 1) + if ($leadingZero && strlen($hours) == 1) $hours = '0'.$hours; if (strlen($mins) == 1) $mins = '0' . $mins; @@ -129,7 +129,7 @@ class ttTimeHelper { // 0-99 if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) { $hours = $time_a[0]; - if (strlen($hours) == 1) + if ($leadingZero && strlen($hours) == 1) $hours = '0'.$hours; return $hours.':00'; } @@ -138,7 +138,7 @@ class ttTimeHelper { if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) { if (strlen($time_value)==3) $time_value = '0'.$time_value; $hours = substr($time_value,0,2); - if (strlen($hours) == 1) + if ($leadingZero && strlen($hours) == 1) $hours = '0'.$hours; return $hours.':'.substr($time_value,2,2); } @@ -146,7 +146,7 @@ class ttTimeHelper { // 0:00-23:59 (24:00) if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) { $hours = $time_a[0]; - if (strlen($hours) == 1) + if ($leadingZero && strlen($hours) == 1) $hours = '0'.$hours; return $hours.':'.$time_a[1]; } @@ -160,13 +160,11 @@ class ttTimeHelper { return (int)@$time_a[1] + ((int)@$time_a[0]) * 60; } - // toAbsDuration - converts a number of minutes to format 00:00 + // toAbsDuration - converts a number of minutes to format 0:00 // even if $minutes is negative. static function toAbsDuration($minutes){ $hours = (string)((int)abs($minutes / 60)); $mins = (string)(abs($minutes % 60)); - if (strlen($hours) == 1) - $hours = '0'.$hours; if (strlen($mins) == 1) $mins = '0' . $mins; return $hours.':'.$mins; @@ -589,6 +587,56 @@ class ttTimeHelper { return false; } + // wvCanModify (weekViewCanModify) - determines if an already existing tt_log record + // can be modified with a new user-provided duration. + static function wvCanModify($tt_log_id, $new_duration, $err) { + global $i18n; + $mdb2 = getConnection(); + + // Determine if we have start time in record, as further checking does not makes sense otherwise. + $sql = "select user_id, date, start, duration from tt_log where id = $tt_log_id"; + $res = $mdb2->query($sql); + if (!is_a($res, 'PEAR_Error')) { + if (!$res->numRows()) { + $err->add($i18n->getKey('error.db')); // This is not expected. + return false; + } + $val = $res->fetchRow(); + $oldDuration = $val['duration']; + if (!$val['start']) + return true; // There is no start time in the record, therefore safe to modify. + } + + // We do have start time. + // Quick test if new duration is less then already existing. + $newMinutes = ttTimeHelper::toMinutes($new_duration); + $oldMinutes = ttTimeHelper::toMinutes($oldDuration); + if ($newMinutes < $oldMinutes) + return true; // Safe to modify. + + // Does the new duration put the record beyond 24:00 boundary? + $startMinutes = ttTimeHelper::toMinutes($val['start']); + $newEndMinutes = $startMinutes + $newMinutes; + if ($newEndMinutes > 1440) { + // Invalid duration, as new duration puts the record beyond current day. + $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration')); + return false; + } + + // Does the new duration causes the record to overlap with others? + $user_id = $val['user_id']; + $date = $val['date']; + $startMinutes = ttTimeHelper::toMinutes($val['start']); + $start = ttTimeHelper::toAbsDuration($startMinutes); + $finish = ttTimeHelper::toAbsDuration($newEndMinutes); + if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) { + $err->add($i18n->getKey('error.overlap')); + return false; + } + + return true; // There are no conflicts, safe to modify. + } + // getRecord - retrieves a time record identified by its id. static function getRecord($id, $user_id) { global $user; @@ -677,95 +725,25 @@ class ttTimeHelper { return $result; } - // getRecordsForInterval - returns time records for a user for a given interval of dates. - static function getRecordsForInterval($user_id, $start_date, $end_date) { - global $user; - $sql_time_format = "'%k:%i'"; // 24 hour format. - if ('%I:%M %p' == $user->time_format) - $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function. - - $result = array(); - $mdb2 = getConnection(); - - $client_field = null; - if ($user->isPluginEnabled('cl')) - $client_field = ', c.id as client_id, c.name as client'; - - $custom_field_1 = null; - if ($user->isPluginEnabled('cf')) { - $custom_fields = new CustomFields($user->team_id); - $cf_1_type = $custom_fields->fields[0]['type']; - if ($cf_1_type == CustomFields::TYPE_TEXT) { - $custom_field_1 = ', cfl.value as cf_1_value'; - } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) { - $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value'; - } + // 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; } - - $left_joins = " left join tt_projects p on (l.project_id = p.id)". - " left join tt_tasks t on (l.task_id = t.id)"; - if ($user->isPluginEnabled('cl')) - $left_joins .= " left join tt_clients c on (l.client_id = c.id)"; - if ($user->isPluginEnabled('cf')) { - if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) - $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.value = cfo.id) '; - elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) - $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.option_id = cfo.id) '; - } - - $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start, - TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish, - TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project, - t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1 - from tt_log l - $left_joins - where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1 - order by p.name, t.name, l.date, l.start, l.id"; - $res = $mdb2->query($sql); - if (!is_a($res, 'PEAR_Error')) { - while ($val = $res->fetchRow()) { - if($val['duration']=='0:00') - $val['finish'] = ''; - $result[] = $val; - } - } else return false; - - return $result; + return false; } - // getGroupedRecordsForInterval - returns time records for a user for a given interval of dates grouped in an array of dates. - // Example: for 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. - static function getGroupedRecordsForInterval($user_id, $start_date, $end_date) { - // Start by obtaining all records in interval. - // Then, iterate through them to build an array. - $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date); - $groupedRecords = array(); - foreach ($records as $record) { - $record_identifier_no_suffix = ttTimeHelper::makeRecordIdentifier($record); - // Handle potential multiple records with the same attributes by using a numerical suffix. - $suffix = 0; - $record_identifier = $record_identifier_no_suffix.'_'.$suffix; - while (!empty($groupedRecords[$record_identifier][$record['date']])) { - $suffix++; - $record_identifier = $record_identifier_no_suffix.'_'.$suffix; - } - $groupedRecords[$record_identifier][$record['date']] = array('id'=>$record['id'], 'duration'=>$record['duration']); - $groupedRecords[$record_identifier]['client'] = $record['client']; - $groupedRecords[$record_identifier]['cf_1_value'] = $record['cf_1_value']; - $groupedRecords[$record_identifier]['project'] = $record['project']; - $groupedRecords[$record_identifier]['task'] = $record['task']; - $groupedRecords[$record_identifier]['billable'] = $record['billable']; + // 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 $groupedRecords; + return -1; // Row not found. } // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view). @@ -777,7 +755,7 @@ class ttTimeHelper { global $user; // Start with client. if ($user->isPluginEnabled('cl')) - $record_identifier = $record['client_id'] ? 'cl'.$record['client_id'] : ''; + $record_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : ''; // Add billable flag. if (!empty($record_identifier)) $record_identifier .= ','; $record_identifier .= 'bl:'.$record['billable']; @@ -795,4 +773,116 @@ class ttTimeHelper { 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; + } } +