|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | +/** |
| 5 | + * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
| 6 | + * SPDX-License-Identifier: AGPL-3.0-or-later |
| 7 | + */ |
| 8 | +namespace OCA\DAV\CalDAV\Import; |
| 9 | + |
| 10 | +use Generator; |
| 11 | +use InvalidArgumentException; |
| 12 | +use OCA\DAV\CalDAV\CalDavBackend; |
| 13 | +use Sabre\VObject\Component\VCalendar; |
| 14 | +use Sabre\VObject\Reader; |
| 15 | + |
| 16 | +/** |
| 17 | + * Calendar Import Service |
| 18 | + */ |
| 19 | +class ImportService { |
| 20 | + |
| 21 | + public function __construct( |
| 22 | + private CalDavBackend $backend, |
| 23 | + ) { |
| 24 | + } |
| 25 | + |
| 26 | + /** |
| 27 | + * Generates object stream from a text formatted source (ical) |
| 28 | + * |
| 29 | + * @param resource $source |
| 30 | + * |
| 31 | + * @return Generator<\Sabre\VObject\Component\VCalendar> |
| 32 | + */ |
| 33 | + public function importText($source): Generator { |
| 34 | + if (!is_resource($source)) { |
| 35 | + throw new InvalidArgumentException('Invalid import source must be a file resource'); |
| 36 | + } |
| 37 | + $importer = new TextImporter($source); |
| 38 | + $structure = $importer->structure(); |
| 39 | + $sObjectPrefix = $importer::OBJECT_PREFIX; |
| 40 | + $sObjectSuffix = $importer::OBJECT_SUFFIX; |
| 41 | + // calendar properties |
| 42 | + foreach ($structure['VCALENDAR'] as $entry) { |
| 43 | + if (!str_ends_with($entry, "\n") || !str_ends_with($entry, "\r\n")) { |
| 44 | + $sObjectPrefix .= PHP_EOL; |
| 45 | + } |
| 46 | + } |
| 47 | + // calendar time zones |
| 48 | + $timezones = []; |
| 49 | + foreach ($structure['VTIMEZONE'] as $tid => $collection) { |
| 50 | + $instance = $collection[0]; |
| 51 | + $sObjectContents = $importer->extract((int)$instance[2], (int)$instance[3]); |
| 52 | + $vObject = Reader::read($sObjectPrefix . $sObjectContents . $sObjectSuffix); |
| 53 | + $timezones[$tid] = clone $vObject->VTIMEZONE; |
| 54 | + } |
| 55 | + // calendar components |
| 56 | + // for each component type, construct a full calendar object with all components |
| 57 | + // that match the same UID and appropriate time zones that are used in the components |
| 58 | + foreach (['VEVENT', 'VTODO', 'VJOURNAL'] as $type) { |
| 59 | + foreach ($structure[$type] as $cid => $instances) { |
| 60 | + /** @var array<int,VCalendar> $instances */ |
| 61 | + // extract all instances of component and unserialize to object |
| 62 | + $sObjectContents = ''; |
| 63 | + foreach ($instances as $instance) { |
| 64 | + $sObjectContents .= $importer->extract($instance[2], $instance[3]); |
| 65 | + } |
| 66 | + /** @var VCalendar $vObject */ |
| 67 | + $vObject = Reader::read($sObjectPrefix . $sObjectContents . $sObjectSuffix); |
| 68 | + // add time zones to object |
| 69 | + foreach ($this->findTimeZones($vObject) as $zone) { |
| 70 | + if (isset($timezones[$zone])) { |
| 71 | + $vObject->add(clone $timezones[$zone]); |
| 72 | + } |
| 73 | + } |
| 74 | + yield $vObject; |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * Generates object stream from a xml formatted source (xcal) |
| 81 | + * |
| 82 | + * @param resource $source |
| 83 | + * |
| 84 | + * @return Generator<\Sabre\VObject\Component\VCalendar> |
| 85 | + */ |
| 86 | + public function importXml($source): Generator { |
| 87 | + if (!is_resource($source)) { |
| 88 | + throw new InvalidArgumentException('Invalid import source must be a file resource'); |
| 89 | + } |
| 90 | + $importer = new XmlImporter($source); |
| 91 | + $structure = $importer->structure(); |
| 92 | + $sObjectPrefix = $importer::OBJECT_PREFIX; |
| 93 | + $sObjectSuffix = $importer::OBJECT_SUFFIX; |
| 94 | + // calendar time zones |
| 95 | + $timezones = []; |
| 96 | + foreach ($structure['VTIMEZONE'] as $tid => $collection) { |
| 97 | + $instance = $collection[0]; |
| 98 | + $sObjectContents = $importer->extract((int)$instance[2], (int)$instance[3]); |
| 99 | + $vObject = Reader::readXml($sObjectPrefix . $sObjectContents . $sObjectSuffix); |
| 100 | + $timezones[$tid] = clone $vObject->VTIMEZONE; |
| 101 | + } |
| 102 | + // calendar components |
| 103 | + // for each component type, construct a full calendar object with all components |
| 104 | + // that match the same UID and appropriate time zones that are used in the components |
| 105 | + foreach (['VEVENT', 'VTODO', 'VJOURNAL'] as $type) { |
| 106 | + foreach ($structure[$type] as $cid => $instances) { |
| 107 | + /** @var array<int,VCalendar> $instances */ |
| 108 | + // extract all instances of component and unserialize to object |
| 109 | + $sObjectContents = ''; |
| 110 | + foreach ($instances as $instance) { |
| 111 | + $sObjectContents .= $importer->extract($instance[2], $instance[3]); |
| 112 | + } |
| 113 | + /** @var VCalendar $vObject */ |
| 114 | + $vObject = Reader::readXml($sObjectPrefix . $sObjectContents . $sObjectSuffix); |
| 115 | + // add time zones to object |
| 116 | + foreach ($this->findTimeZones($vObject) as $zone) { |
| 117 | + if (isset($timezones[$zone])) { |
| 118 | + $vObject->add(clone $timezones[$zone]); |
| 119 | + } |
| 120 | + } |
| 121 | + yield $vObject; |
| 122 | + } |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | + /** |
| 127 | + * Generates object stream from a json formatted source (jcal) |
| 128 | + * |
| 129 | + * @param resource $source |
| 130 | + * |
| 131 | + * @return Generator<\Sabre\VObject\Component\VCalendar> |
| 132 | + */ |
| 133 | + public function importJson($source): Generator { |
| 134 | + if (!is_resource($source)) { |
| 135 | + throw new InvalidArgumentException('Invalid import source must be a file resource'); |
| 136 | + } |
| 137 | + /** @var VCALENDAR $importer */ |
| 138 | + $importer = Reader::readJson($source); |
| 139 | + // calendar time zones |
| 140 | + $timezones = []; |
| 141 | + foreach ($importer->VTIMEZONE as $timezone) { |
| 142 | + $tzid = $timezone->TZID?->getValue(); |
| 143 | + if ($tzid !== null) { |
| 144 | + $timezones[$tzid] = clone $timezone; |
| 145 | + } |
| 146 | + } |
| 147 | + // calendar components |
| 148 | + foreach ($importer->getBaseComponents() as $base) { |
| 149 | + $vObject = new VCalendar; |
| 150 | + $vObject->VERSION = clone $importer->VERSION; |
| 151 | + $vObject->PRODID = clone $importer->PRODID; |
| 152 | + // extract all instances of component |
| 153 | + foreach ($importer->getByUID($base->UID->getValue()) as $instance) { |
| 154 | + $vObject->add(clone $instance); |
| 155 | + } |
| 156 | + // add time zones to object |
| 157 | + foreach ($this->findTimeZones($vObject) as $zone) { |
| 158 | + if (isset($timezones[$zone])) { |
| 159 | + $vObject->add(clone $timezones[$zone]); |
| 160 | + } |
| 161 | + } |
| 162 | + yield $vObject; |
| 163 | + } |
| 164 | + } |
| 165 | + |
| 166 | + /** |
| 167 | + * Searches through all component properties looking for defined timezones |
| 168 | + * |
| 169 | + * @return array<string> |
| 170 | + */ |
| 171 | + private function findTimeZones(VCalendar $vObject): array { |
| 172 | + $timezones = []; |
| 173 | + foreach ($vObject->getComponents() as $vComponent) { |
| 174 | + if ($vComponent->name !== 'VTIMEZONE') { |
| 175 | + foreach (['DTSTART', 'DTEND', 'DUE', 'RDATE', 'EXDATE'] as $property) { |
| 176 | + if (isset($vComponent->$property?->parameters['TZID'])) { |
| 177 | + $tid = $vComponent->$property->parameters['TZID']->getValue(); |
| 178 | + $timezones[$tid] = true; |
| 179 | + } |
| 180 | + } |
| 181 | + } |
| 182 | + } |
| 183 | + return array_keys($timezones); |
| 184 | + } |
| 185 | + |
| 186 | +} |
0 commit comments