Skip to content

Commit

Permalink
Major overhaul of rule calculations.
Browse files Browse the repository at this point in the history 
- Don't generate UNTIL attributes if the rules is only for one year.
- Fix calculating starting offset. This cannot be done with simple logic, but we need to search for the closest, earlier, matching rule.

Still need to correct the other fixtures though.
  • Loading branch information
@yunosh
yunosh committed Apr 14, 2016
1 parent 05c607e commit ee6ddf4
Showing 1 changed file with 200 additions and 77 deletions.
277 changes: 200 additions & 77 deletions framework/Timezone/lib/Horde/Timezone/Rule.php
View file
Expand Up @@ -80,9 +80,8 @@ public function addRules(Horde_Icalendar_Vtimezone $tz, $tzid, $name,
$startOffset,
Horde_Date $start, Horde_Date $end = null)
{
$offset = $startOffset;
foreach ($this->_rules as $rule) {
// The rule offsets are:
foreach ($this->_rules as $ruleNo => $rule) {
// The rule items are:
// 0: "Rule"
// 1: The rule name
// 2: The start year or "minimum"
Expand Down Expand Up @@ -110,85 +109,120 @@ public function addRules(Horde_Icalendar_Vtimezone $tz, $tzid, $name,
if ($rule[2][0] != 'm' && $rule[2] < $start->year) {
$rule[2] = $start->year;
}
if ($rule[8] == 0) {
$component = new Horde_Icalendar_Standard();
$component->setAttribute('TZOFFSETFROM', $offset);
$component->setAttribute('TZOFFSETTO', $startOffset);
$offset = $startOffset;
} else {
$component = new Horde_Icalendar_Daylight();
$component->setAttribute('TZOFFSETFROM', $startOffset);
$offset = $this->_getOffset($startOffset, $rule[8]);
$component->setAttribute('TZOFFSETTO', $offset);
}

// The month of rule start.
$month = Horde_Timezone::getMonth($rule[5]);

// The time of rule start.
preg_match('/(\d+)(?::(\d+))?(?::(\d+))?(w|s|u)?/', $rule[7], $match);
if (!isset($match[2])) {
$match[2] = 0;
preg_match('/(\d+)(?::(\d+))?(?::(\d+))?([wsguz])?/', $rule[7], $match);
$hour = $match[1];
$minute = isset($match[2]) ? $match[2] : 0;
if (!isset($match[4])) {
$modifier = 'w';
} elseif ($match[4] == 'g' || $match[4] == 'z') {
$modifier = 'u';
} else {
$modifier = $match[4];
}

// Find the start and end date.
$first = $this->_getFirstMatch($rule, $rule[2], $match[1], $match[2]);
// Find the start date.
$first = $this->_getFirstMatch($rule, $rule[2]);
$first->hour = $hour;
$first->min = $minute;

$previousOffset = $this->_findPreviousOffset(
$first, $ruleNo, $startOffset
);
if ($rule[8] == 0) {
$component = new Horde_Icalendar_Standard();
$component->setAttribute('TZOFFSETFROM', $previousOffset);
$component->setAttribute('TZOFFSETTO', $startOffset);
} else {
$component = new Horde_Icalendar_Daylight();
$component->setAttribute('TZOFFSETFROM', $previousOffset);
$component->setAttribute(
'TZOFFSETTO', $this->_getOffset($startOffset, $rule[8])
);
}
switch ($modifier) {
case 's':
$first->hour += ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['hour']
- ($startOffset['ahead'] ? 1 : -1) * $startOffset['hour'];
$first->min += ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['minute']
- ($startOffset['ahead'] ? 1 : -1) * $startOffset['minute'];
break;
case 'u':
$first->hour += ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['hour'];
$first->min += ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['minute'];
break;
}
$component->setAttribute('DTSTART', $first);

// Find the end date.
if ($rule[3][0] == 'm') {
$until = '';
} else {
$last = $this->_getFirstMatch($rule, $rule[3], $match[1], $match[2]);
$last->setTimezone('UTC');
$last = $this->_getFirstMatch($rule, $rule[3]);
$last->hour = $hour;
$last->min = $minute;
switch ($modifier) {
case 's':
$last->hour -= ($startOffset['ahead'] ? 1 : -1) * $startOffset['hour'];
$last->min -= ($startOffset['ahead'] ? 1 : -1) * $startOffset['minute'];
break;
case 'w':
$last->hour -= ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['hour'];
$last->min -= ($previousOffset['ahead'] ? 1 : -1) * $previousOffset['minute'];
break;
}
$until = ';UNTIL=' . $last->format('Ymd\THis') . 'Z';
}

if (preg_match('/^\d+$/', $rule[6])) {
// Rule starts on a specific date.
if ($rule[2] != $rule[3] &&
$rule[3][0] != 'm') {
// Rule lasts more than a single year.
if ($rule[2] != $rule[3]) {
if (preg_match('/^\d+$/', $rule[6])) {
// Rule starts on a specific date.
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYMONTH=' . $month
. ';BYMONTHDAY=' . $rule[6]
. $until);
} elseif (substr($rule[6], 0, 4) == 'last') {
// Rule starts on the last of a certain weekday of the month.
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYDAY=-1'
. Horde_String::upper(substr($rule[6], 4, 2))
. ';BYMONTH=' . $month . $until);
} elseif (strpos($rule[6], '>=')) {
// Rule starts on a certain weekday after a certain day of
// month.
list($weekday, $day) = explode('>=', $rule[6]);
for ($days = array(), $i = $day, $lastDay = min(Horde_Date_Utils::daysInMonth($month, $rule[2]), $i + 6);
$day > 1 && $i <= $lastDay;
$i++) {
$days[] = $i;
}
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYMONTH=' . $month
. ($days ? (';BYMONTHDAY=' . implode(',', $days)) : '')
. ';BYDAY=1' . Horde_String::upper(substr($weekday, 0, 2))
. $until);
} elseif (strpos($rule[6], '<=')) {
// Rule starts on a certain weekday before a certain day of
// month.
for ($days = array(), $i = 1; $i <= $day; $i++) {
$days[] = $i;
}
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYMONTH=' . $month
. ';BYMONTHDAY=' . implode(',', $days)
. ';BYDAY=-1' . Horde_String::upper(substr($weekday, 0, 2))
. $until);
} else {
continue;
}
} elseif (substr($rule[6], 0, 4) == 'last') {
// Rule starts on the last of a certain weekday of the month.
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYDAY=-1'
. Horde_String::upper(substr($rule[6], 4, 2))
. ';BYMONTH=' . $month . $until);
} elseif (strpos($rule[6], '>=')) {
// Rule starts on a certain weekday after a certain day of
// month.
list($weekday, $day) = explode('>=', $rule[6]);
for ($days = array(), $i = $day, $lastDay = min(Horde_Date_Utils::daysInMonth($month, $rule[2]), $i + 6);
$day > 1 && $i <= $lastDay;
$i++) {
$days[] = $i;
}
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYMONTH=' . $month
. ($days ? (';BYMONTHDAY=' . implode(',', $days)) : '')
. ';BYDAY=1' . Horde_String::upper(substr($weekday, 0, 2))
. $until);
} elseif (strpos($rule[6], '<=')) {
// Rule starts on a certain weekday before a certain day of
// month.
for ($days = array(), $i = 1; $i <= $day; $i++) {
$days[] = $i;
}
$component->setAttribute(
'RRULE',
'FREQ=YEARLY;BYMONTH=' . $month
. ';BYMONTHDAY=' . implode(',', $days)
. ';BYDAY=-1' . Horde_String::upper(substr($weekday, 0, 2))
. $until);
} else {
continue;
}
$component->setAttribute('TZNAME', sprintf($name, $rule[9]));
$tz->addComponent($component);
Expand All @@ -200,12 +234,10 @@ public function addRules(Horde_Icalendar_Vtimezone $tz, $tzid, $name,
*
* @param array $rule A rule definition hash from addRules().
* @param integer $year A year when the rule should be applied.
* @param integer $hour The hour.
* @param integer $minute The minute.
*
* @return Horde_Date The first matching date.
*/
protected function _getFirstMatch($rule, $year, $hour, $minute)
protected function _getFirstMatch($rule, $year)
{
$month = Horde_Timezone::getMonth($rule[5]);

Expand All @@ -215,9 +247,6 @@ protected function _getFirstMatch($rule, $year, $hour, $minute)
'year' => $year,
'month' => $month,
'mday' => $rule[6],
'hour' => $hour,
'min' => $minute,
'sec' => 0
));
} elseif (substr($rule[6], 0, 4) == 'last') {
// Rule starts on the last of a certain weekday of the month.
Expand All @@ -226,9 +255,6 @@ protected function _getFirstMatch($rule, $year, $hour, $minute)
'year' => $year,
'month' => $month,
'mday' => Horde_Date_Utils::daysInMonth($month, $rule[2]),
'hour' => $hour,
'min' => $minute,
'sec' => 0
));
while ($date->dayOfWeek() != $weekday) {
$date->mday--;
Expand All @@ -241,9 +267,6 @@ protected function _getFirstMatch($rule, $year, $hour, $minute)
'year' => $year,
'month' => $month,
'mday' => $day,
'hour' => $hour,
'min' => $minute,
'sec' => 0
));
while ($date->dayOfWeek() != $weekdayInt) {
$date->mday++;
Expand All @@ -256,18 +279,118 @@ protected function _getFirstMatch($rule, $year, $hour, $minute)
'year' => $year,
'month' => $month,
'mday' => $day,
'hour' => $hour,
'min' => $minute,
'sec' => 0
));
while ($date->dayOfWeek() != $weekdayInt) {
$date->mday--;
}
} else {
throw new Horde_Timezone_Exception('Cannot parse rule ' . $rule[6]);
}

return $date;
}

/**
* Finds the offset of a previous rule.
*
* There may be different potential rules that are "before" the current
* one, and there may even be two sequential daylight rules with different
* offsets. Thus we go through all earlier rules (as in "before the current
* rule in the rule definition", because the rules are ordered by start
* date), and find the one that starts the closest to the start date of the
* current rule.
*
* @param Horde_Date $date The start date of the current rule.
* @param integer $ruleNo The rule number of the current rule.
* @param integer $startOffset The offset to use for the first rule, and
* also the default.
*
* @return integer The offset of the last rule before the current.
*/
protected function _findPreviousOffset($date, $ruleNo, $startOffset)
{
// This is the default.
$offset = $startOffset;

if ($ruleNo == 0) {
return $offset;
}

// Remember the closest found day and year. The year is faster to
// calculate, only fall back to days if necessary. For years we compare
// the end dates, to quickly rule out any rules that even ended earlier
// than the currently closest match. For rules with end dates in the
// future we have to go down to the level of days and calculate the
// distance of the occurrence in the current year.
$diff = $diffYear = null;
for ($i = $ruleNo - 1; $i >= 0; $i--) {
$end = $this->_rules[$i][3][0] == 'o'
? $this->_rules[$i][2]
: $this->_rules[$i][3];
if ($end[0] != 'm') {
if (!is_null($diffYear) &&
($date->year - $end) > $diffYear) {
// We already found a rule that ends closer (by year)
continue;
}
if (is_null($diffYear) ||
($date->year - $end) < $diffYear) {
// This rule ends closer.
$diffYear = $date->year - $end;
$diff = $this->_getDiff($i, $date, min($date->year, $end));
$offset = $this->_rules[$i][8]
? $this->_getOffset($startOffset, $this->_rules[$i][8])
: $startOffset;
continue;
}
}
// On the same year or with an end in the future, now check days.
$year = $date->year;
if ($end[0] != 'm') {
$year = min($year, $end);
}
$diffDays = $this->_getDiff($i, $date, $year);
if (!is_null($diff) && $diffDays > $diff) {
// We already found a rule that ends closer.
continue;
}
if (is_null($diff) || $diffDays < $diff) {
// This rule ends closer.
$diffYear = $date->year - $year;
$diff = $diffDays;
$offset = $this->_rules[$i][8]
? $this->_getOffset($startOffset, $this->_rules[$i][8])
: $startOffset;
}
}

return $offset;
}

protected function _setTime($date, $hour, $minute, $modifier, $utc = false)
{
}

/**
* Helper method to calculate the difference in days between a date and the
* occurence of rule.
*
* @param integer $ruleNo A rule number.
* @param Horde_Date $date A date.
* @param integer $year A year.
*
* @return integer The days between the date and the rule occurrence in
* the year.
*/
protected function _getDiff($ruleNo, $date, $year)
{
$ruleDate = $this->_getFirstMatch($this->_rules[$ruleNo], $year);
if ($ruleDate->after($date)) {
$ruleDate = $this->_getFirstMatch($this->_rules[$ruleNo], $year - 1);
}
return $date->diff($ruleDate);
}

/**
* Calculates the new offset of a timezone.
*
Expand Down

0 comments on commit ee6ddf4

Please sign in to comment.