-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Add Write support to OCP/ICalendar #23234
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
rotdrop
wants to merge
3
commits into
nextcloud:master
from
rotdrop:update-ocp-calendar-write-support
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,154 @@ | ||
| <?php | ||
| /** | ||
| * @copyright 2020, Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @author Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @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\DAV\CalDAV; | ||
|
|
||
| use OCP\Calendar\ICalendarObjectV2; | ||
| use OCP\Calendar\ICalendarV2; | ||
| use OCP\Constants; | ||
| use Sabre\DAV\Exception\BadRequest; | ||
| use Sabre\VObject\Component\VCalendar; | ||
| use Sabre\VObject\Reader; | ||
| use Sabre\VObject\UUIDUtil; | ||
|
|
||
| class CalendarImplV2 implements ICalendarV2 { | ||
|
|
||
| /** @var CalDavBackend */ | ||
| private $backend; | ||
|
|
||
| /** @var Calendar */ | ||
| private $calendar; | ||
|
|
||
| /** @var array */ | ||
| private $calendarInfo; | ||
|
|
||
| /** | ||
| * CalendarImpl constructor. | ||
| * | ||
| * @param Calendar $calendar | ||
| * @param array $calendarInfo | ||
| * @param CalDavBackend $backend | ||
| */ | ||
| public function __construct(Calendar $calendar, array $calendarInfo, | ||
| CalDavBackend $backend) { | ||
| $this->calendar = $calendar; | ||
| $this->calendarInfo = $calendarInfo; | ||
| $this->backend = $backend; | ||
| } | ||
|
|
||
| /** | ||
| * @return string defining the technical unique key | ||
| * @since 21.0.0 | ||
| */ | ||
| public function getKey(): string { | ||
| return $this->calendarInfo['id']; | ||
| } | ||
|
|
||
| /** | ||
| * In comparison to getKey() this function returns a human readable (maybe translated) name | ||
| * @return null|string | ||
| * @since 21.0.0 | ||
| */ | ||
| public function getDisplayName(): ?string { | ||
| return $this->calendarInfo['{DAV:}displayname']; | ||
| } | ||
|
|
||
| /** | ||
| * Calendar color | ||
| * @return null|string | ||
| * @since 21.0.0 | ||
| */ | ||
| public function getDisplayColor(): ?string { | ||
| return $this->calendarInfo['{http://apple.com/ns/ical/}calendar-color']; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $pattern which should match within the $searchProperties | ||
| * @param array $searchProperties defines the properties within the query pattern should match | ||
| * @param array $options - optional parameters: | ||
| * ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] | ||
| * @param integer|null $limit - limit number of search results | ||
| * @param integer|null $offset - offset for paging of search results | ||
| * @return array an array of events/journals/todos which are arrays of key-value-pairs | ||
| * @since 21.0.0 | ||
| */ | ||
| public function search($pattern, array $searchProperties=[], array $options=[], int $limit = null, int $offset = null): array { | ||
| return $this->backend->search($this->calendarInfo, $pattern, | ||
| $searchProperties, $options, $limit, $offset); | ||
| } | ||
|
|
||
| /** | ||
| * @return bool | ||
| * @since 21.0.0 | ||
| */ | ||
| public function isWriteable(): bool { | ||
| $permissions = $this->calendar->getACL(); | ||
| $result = 0; | ||
| foreach ($permissions as $permission) { | ||
| switch ($permission['privilege']) { | ||
| case '{DAV:}read': | ||
| $result |= Constants::PERMISSION_READ; | ||
| break; | ||
| case '{DAV:}write': | ||
| $result |= Constants::PERMISSION_CREATE; | ||
| $result |= Constants::PERMISSION_UPDATE; | ||
| break; | ||
| case '{DAV:}all': | ||
| $result |= Constants::PERMISSION_ALL; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return $result > Constants::PERMISSION_READ; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $uri | ||
| * @return ICalendarObjectV2|null | ||
| * @since 21.0.0 | ||
| */ | ||
| public function getByUri(string $uri): ?ICalendarObjectV2 { | ||
| if ($calendarObjectData = $this->backend->getCalendarObject($this->getKey(), $uri)) { | ||
| if (isset($calendarObjectData['calendardata'])) { | ||
| $calendarData = Reader::read($calendarObjectData['calendardata']); | ||
| if ($calendarData instanceof VCalendar) { | ||
| return new CalendarObjectImplV2($calendarObjectData['calendarid'], $calendarObjectData['uri'], $calendarData, $this->backend); | ||
| } | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * @param VCalendar $vObject | ||
| * @return ICalendarObjectV2|null | ||
| * @throws BadRequest | ||
| * @since 21.0.0 | ||
| */ | ||
| public function create(VCalendar $vObject): ?ICalendarObjectV2 { | ||
| CalendarObjectImplV2::validateCalendarData($vObject); | ||
| $uuid = UUIDUtil::getUUID() . '.ics'; | ||
| $this->backend->createCalendarObject($this->getKey(), $uuid, $vObject->serialize()); | ||
| return $this->getByUri($uuid); | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check failure
Code scanning / Psalm
UndefinedClass