-
Notifications
You must be signed in to change notification settings - Fork 236
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5339 from nextcloud/fix/add-tz-to-appointment-ics
fix: add VTIMEZONE to Appointments
- Loading branch information
Showing
5 changed files
with
259 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <?php | ||
| /* | ||
| * * | ||
| * * calendar App | ||
| * * | ||
| * * @copyright 2023 Anna Larch <[email protected]> | ||
| * * | ||
| * * @author Anna Larch <[email protected]> | ||
| * * | ||
| * * This library is free software; you can redistribute it and/or | ||
| * * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE | ||
| * * License as published by the Free Software Foundation; either | ||
| * * version 3 of the License, or any later version. | ||
| * * | ||
| * * This library is distributed in the hope that it will be useful, | ||
| * * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * * GNU AFFERO GENERAL PUBLIC LICENSE for more details. | ||
| * * | ||
| * * You should have received a copy of the GNU Affero General Public | ||
| * * License along with this library. If not, see <http://www.gnu.org/licenses/>. | ||
| * * | ||
| * | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * @copyright 2023 Anna Larch <[email protected]> | ||
| * | ||
| * @author 2023 Anna Larch <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| namespace OCA\Calendar\Service\Appointments; | ||
|
|
||
| use Sabre\VObject\Component; | ||
| use Sabre\VObject\Component\VCalendar; | ||
| use Sabre\VObject\Component\VTimeZone; | ||
| use Sabre\VObject\TimeZoneUtil; | ||
| use function max; | ||
| use function min; | ||
|
|
||
| class TimezoneGenerator { | ||
| /** | ||
| * Returns a VTIMEZONE component for a Olson timezone identifier | ||
| * with daylight transitions covering the given date range. | ||
| * | ||
| * @link https://gist.github.com/thomascube/47ff7d530244c669825736b10877a200 | ||
| * | ||
| * @param string $timezone Timezone | ||
| * @param integer $from Unix timestamp with first date/time in this timezone | ||
| * @param integer $to Unix timestap with last date/time in this timezone | ||
| * @psalm-suppress NoValue | ||
| * | ||
| * @return null|VTimeZone A Sabre\VObject\Component object representing a VTIMEZONE definition | ||
| * or null if no timezone information is available | ||
| */ | ||
| public function generateVtimezone(string $timezone, int $from, int $to): ?VTimeZone { | ||
| try { | ||
| $tz = new \DateTimeZone($timezone); | ||
| } catch (\Exception $e) { | ||
| return null; | ||
| } | ||
|
|
||
| // get all transitions for one year back/ahead | ||
| $year = 86400 * 360; | ||
| $transitions = $tz->getTransitions($from - $year, $to + $year); | ||
|
|
||
| $vcalendar = new VCalendar(); | ||
| $vtimezone = $vcalendar->createComponent('VTIMEZONE'); | ||
| $vtimezone->TZID = $timezone; | ||
|
|
||
| $standard = $daylightStart = null; | ||
| foreach ($transitions as $i => $trans) { | ||
| $component = null; | ||
|
|
||
| // skip the first entry... | ||
| if ($i === 0) { | ||
| // ... but remember the offset for the next TZOFFSETFROM value | ||
| $tzfrom = $trans['offset'] / 3600; | ||
| continue; | ||
| } | ||
|
|
||
| // daylight saving time definition | ||
| if ($trans['isdst']) { | ||
| $daylightDefinition = $trans['ts']; | ||
| $daylightStart = $vcalendar->createComponent('DAYLIGHT'); | ||
| $component = $daylightStart; | ||
| } | ||
| // standard time definition | ||
| else { | ||
| $standardDefinition = $trans['ts']; | ||
| $standard = $vcalendar->createComponent('STANDARD'); | ||
| $component = $standard; | ||
| } | ||
|
|
||
| if ($component) { | ||
| $date = new \DateTime($trans['time']); | ||
| $offset = $trans['offset'] / 3600; | ||
|
|
||
| $component->DTSTART = $date->format('Ymd\THis'); | ||
| $component->TZOFFSETFROM = sprintf('%s%02d%02d', $tzfrom >= 0 ? '+' : '-', abs(floor($tzfrom)), ($tzfrom - floor($tzfrom)) * 60); | ||
| $component->TZOFFSETTO = sprintf('%s%02d%02d', $offset >= 0 ? '+' : '-', abs(floor($offset)), ($offset - floor($offset)) * 60); | ||
|
|
||
| // add abbreviated timezone name if available | ||
| if (!empty($trans['abbr'])) { | ||
| $component->TZNAME = $trans['abbr']; | ||
| } | ||
|
|
||
| $tzfrom = $offset; | ||
| $vtimezone->add($component); | ||
| } | ||
|
|
||
| // we covered the entire date range | ||
| if ($standard && $daylightStart && min($standardDefinition, $daylightDefinition) < $from && max($standardDefinition, $daylightDefinition) > $to) { | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| // add X-MICROSOFT-CDO-TZID if available | ||
| $microsoftExchangeMap = array_flip(TimeZoneUtil::$microsoftExchangeMap); | ||
| if (!empty($microsoftExchangeMap) && array_key_exists($tz->getName(), $microsoftExchangeMap)) { | ||
| $vtimezone->add('X-MICROSOFT-CDO-TZID', $microsoftExchangeMap[$tz->getName()]); | ||
| } | ||
|
|
||
| return $vtimezone; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
tests/php/unit/Service/Appointments/TimezoneGeneratorTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * Calendar App | ||
| * | ||
| * @author 2023 Anna Larch <[email protected]> | ||
| * @copyright 2023 Anna Larch <[email protected]> | ||
| * | ||
| * This library is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or any later version. | ||
| * | ||
| * This library is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU AFFERO GENERAL PUBLIC LICENSE for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public | ||
| * License along with this library. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
| namespace OCA\Calendar\Tests\Unit\Service\Appointments; | ||
|
|
||
| use ChristophWurst\Nextcloud\Testing\TestCase; | ||
| use OCA\Calendar\Service\Appointments\TimezoneGenerator; | ||
| use Sabre\VObject\Component\VTimeZone; | ||
| use Sabre\VObject\TimeZoneUtil; | ||
|
|
||
| class TimezoneGeneratorTest extends TestCase { | ||
|
|
||
| protected TimezoneGenerator $timezoneGenerator; | ||
| protected function setUp(): void { | ||
| $this->timezoneGenerator = new TimezoneGenerator(); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider providerDaylightSaving | ||
| */ | ||
| public function testWithDaylightSaving($timezone, $daytime, $standard, $msTimezoneId): void { | ||
| /** @var VTimeZone $generated */ | ||
| $generated = $this->timezoneGenerator->generateVtimezone($timezone, 1640991600, 1672527600); | ||
|
|
||
| $this->assertEquals($timezone, $generated->TZID->getValue()); | ||
| $this->assertNotNull($generated->DAYLIGHT); | ||
| $this->assertCount($daytime, $generated->DAYLIGHT->getIterator()); | ||
| $this->assertNotNull($generated->STANDARD); | ||
| $this->assertCount($standard, $generated->STANDARD->getIterator()); | ||
| $this->assertEquals($generated->{'X-MICROSOFT-CDO-TZID'}->getValue(), $msTimezoneId); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider providerNoDaylightSaving | ||
| */ | ||
| public function testNoDaylightSaving($timezone, $daytime, $standard, $msTimezoneId): void { | ||
| /** @var VTimeZone $generated */ | ||
| $generated = $this->timezoneGenerator->generateVtimezone($timezone, 1640991600, 1672527600); | ||
|
|
||
| $this->assertEquals($timezone, $generated->TZID->getValue()); | ||
| $this->assertNull($generated->DAYLIGHT); | ||
| $this->assertNull($generated->STANDARD); | ||
| $this->assertEquals($generated->{'X-MICROSOFT-CDO-TZID'}->getValue(), $msTimezoneId); | ||
| } | ||
|
|
||
| public function testInvalid(): void { | ||
| /** @var VTimeZone $generated */ | ||
| $generated = $this->timezoneGenerator->generateVtimezone('Nonsense', 1640991600, 1672527600); | ||
|
|
||
| $this->assertNull($generated); | ||
| } | ||
|
|
||
| public function providerDaylightSaving(): array { | ||
| $microsoftExchangeMap = array_flip(TimeZoneUtil::$microsoftExchangeMap); | ||
| return [ | ||
| ['Europe/Berlin', 3, 3, $microsoftExchangeMap['Europe/Berlin']], | ||
| ['Europe/London', 3, 3, $microsoftExchangeMap['Europe/London']], | ||
| ['Australia/Adelaide', 3, 3, $microsoftExchangeMap['Australia/Adelaide']], | ||
| ]; | ||
| } | ||
|
|
||
| public function providerNoDaylightSaving(): array { | ||
| $microsoftExchangeMap = array_flip(TimeZoneUtil::$microsoftExchangeMap); | ||
| return [ | ||
| ['Pacific/Midway', null, null, $microsoftExchangeMap['Pacific/Midway']], | ||
| ['Asia/Singapore', null, null, $microsoftExchangeMap['Asia/Singapore']], | ||
| ]; | ||
| } | ||
|
|
||
|
|
||
| } |