nextcloud / server

apps/dav/lib/CalDAV/CalendarImpl.php

Indentation +189 added lines, -189 removed lines

@@ -46,193 +46,193 @@
 
 class CalendarImpl implements ICreateFromString {
 
-	private CalDavBackend $backend;
-	private Calendar $calendar;
-	/** @var array<string, mixed> */
-	private array $calendarInfo;
-
-	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 13.0.0
-	 */
-	public function getKey(): string {
-		return (string) $this->calendarInfo['id'];
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	public function getUri(): string {
-		return $this->calendarInfo['uri'];
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 * @since 13.0.0
-	 */
-	public function getDisplayName(): ?string {
-		return $this->calendarInfo['{DAV:}displayname'];
-	}
-
-	/**
-	 * Calendar color
-	 * @since 13.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 int|null $limit - limit number of search results
-	 * @param int|null $offset - offset for paging of search results
-	 * @return array an array of events/journals/todos which are arrays of key-value-pairs
-	 * @since 13.0.0
-	 */
-	public function search(string $pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null): array {
-		return $this->backend->search($this->calendarInfo, $pattern,
-			$searchProperties, $options, $limit, $offset);
-	}
-
-	/**
-	 * @return int build up using \OCP\Constants
-	 * @since 13.0.0
-	 */
-	public function getPermissions(): int {
-		$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;
-	}
-
-	/**
-	 * @since 26.0.0
-	 */
-	public function isDeleted(): bool {
-		return $this->calendar->isDeleted();
-	}
-
-	/**
-	 * Create a new calendar event for this calendar
-	 * by way of an ICS string
-	 *
-	 * @param string $name the file name - needs to contain the .ics ending
-	 * @param string $calendarData a string containing a valid VEVENT ics
-	 *
-	 * @throws CalendarException
-	 */
-	public function createFromString(string $name, string $calendarData): void {
-		$server = new InvitationResponseServer(false);
-
-		/** @var CustomPrincipalPlugin $plugin */
-		$plugin = $server->server->getPlugin('auth');
-		// we're working around the previous implementation
-		// that only allowed the public system principal to be used
-		// so set the custom principal here
-		$plugin->setCurrentPrincipal($this->calendar->getPrincipalURI());
-
-		if (empty($this->calendarInfo['uri'])) {
-			throw new CalendarException('Could not write to calendar as URI parameter is missing');
-		}
-
-		// Build full calendar path
-		[, $user] = uriSplit($this->calendar->getPrincipalURI());
-		$fullCalendarFilename = sprintf('calendars/%s/%s/%s', $user, $this->calendarInfo['uri'], $name);
-
-		// Force calendar change URI
-		/** @var Schedule\Plugin $schedulingPlugin */
-		$schedulingPlugin = $server->server->getPlugin('caldav-schedule');
-		$schedulingPlugin->setPathOfCalendarObjectChange($fullCalendarFilename);
-
-		$stream = fopen('php://memory', 'rb+');
-		fwrite($stream, $calendarData);
-		rewind($stream);
-		try {
-			$server->server->createFile($fullCalendarFilename, $stream);
-		} catch (Conflict $e) {
-			throw new CalendarException('Could not create new calendar event: ' . $e->getMessage(), 0, $e);
-		} finally {
-			fclose($stream);
-		}
-	}
-
-	/**
-	 * @throws CalendarException
-	 */
-	public function handleIMipMessage(string $name, string $calendarData): void {
-		$server = new InvitationResponseServer(false);
-
-		/** @var CustomPrincipalPlugin $plugin */
-		$plugin = $server->server->getPlugin('auth');
-		// we're working around the previous implementation
-		// that only allowed the public system principal to be used
-		// so set the custom principal here
-		$plugin->setCurrentPrincipal($this->calendar->getPrincipalURI());
-
-		if (empty($this->calendarInfo['uri'])) {
-			throw new CalendarException('Could not write to calendar as URI parameter is missing');
-		}
-		// Force calendar change URI
-		/** @var Schedule\Plugin $schedulingPlugin */
-		$schedulingPlugin = $server->server->getPlugin('caldav-schedule');
-		// Let sabre handle the rest
-		$iTipMessage = new Message();
-		/** @var VCalendar $vObject */
-		$vObject = Reader::read($calendarData);
-		/** @var VEvent $vEvent */
-		$vEvent = $vObject->{'VEVENT'};
-
-		if($vObject->{'METHOD'} === null) {
-			throw new CalendarException('No Method provided for scheduling data. Could not process message');
-		}
-
-		if(!isset($vEvent->{'ORGANIZER'}) || !isset($vEvent->{'ATTENDEE'})) {
-			throw new CalendarException('Could not process scheduling data, neccessary data missing from ICAL');
-		}
-		$orgaizer = $vEvent->{'ORGANIZER'}->getValue();
-		$attendee = $vEvent->{'ATTENDEE'}->getValue();
-
-		$iTipMessage->method = $vObject->{'METHOD'}->getValue();
-		if($iTipMessage->method === 'REPLY') {
-			if ($server->isExternalAttendee($vEvent->{'ATTENDEE'}->getValue())) {
-				$iTipMessage->recipient = $orgaizer;
-			} else {
-				$iTipMessage->recipient = $attendee;
-			}
-			$iTipMessage->sender = $attendee;
-		} else if($iTipMessage->method === 'CANCEL') {
-			$iTipMessage->recipient = $attendee;
-			$iTipMessage->sender = $orgaizer;
-		}
-		$iTipMessage->uid = isset($vEvent->{'UID'}) ? $vEvent->{'UID'}->getValue() : '';
-		$iTipMessage->component = 'VEVENT';
-		$iTipMessage->sequence = isset($vEvent->{'SEQUENCE'}) ? (int)$vEvent->{'SEQUENCE'}->getValue() : 0;
-		$iTipMessage->message = $vObject;
-		$schedulingPlugin->scheduleLocalDelivery($iTipMessage);
-	}
+    private CalDavBackend $backend;
+    private Calendar $calendar;
+    /** @var array<string, mixed> */
+    private array $calendarInfo;
+
+    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 13.0.0
+     */
+    public function getKey(): string {
+        return (string) $this->calendarInfo['id'];
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUri(): string {
+        return $this->calendarInfo['uri'];
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     * @since 13.0.0
+     */
+    public function getDisplayName(): ?string {
+        return $this->calendarInfo['{DAV:}displayname'];
+    }
+
+    /**
+     * Calendar color
+     * @since 13.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 int|null $limit - limit number of search results
+     * @param int|null $offset - offset for paging of search results
+     * @return array an array of events/journals/todos which are arrays of key-value-pairs
+     * @since 13.0.0
+     */
+    public function search(string $pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null): array {
+        return $this->backend->search($this->calendarInfo, $pattern,
+            $searchProperties, $options, $limit, $offset);
+    }
+
+    /**
+     * @return int build up using \OCP\Constants
+     * @since 13.0.0
+     */
+    public function getPermissions(): int {
+        $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;
+    }
+
+    /**
+     * @since 26.0.0
+     */
+    public function isDeleted(): bool {
+        return $this->calendar->isDeleted();
+    }
+
+    /**
+     * Create a new calendar event for this calendar
+     * by way of an ICS string
+     *
+     * @param string $name the file name - needs to contain the .ics ending
+     * @param string $calendarData a string containing a valid VEVENT ics
+     *
+     * @throws CalendarException
+     */
+    public function createFromString(string $name, string $calendarData): void {
+        $server = new InvitationResponseServer(false);
+
+        /** @var CustomPrincipalPlugin $plugin */
+        $plugin = $server->server->getPlugin('auth');
+        // we're working around the previous implementation
+        // that only allowed the public system principal to be used
+        // so set the custom principal here
+        $plugin->setCurrentPrincipal($this->calendar->getPrincipalURI());
+
+        if (empty($this->calendarInfo['uri'])) {
+            throw new CalendarException('Could not write to calendar as URI parameter is missing');
+        }
+
+        // Build full calendar path
+        [, $user] = uriSplit($this->calendar->getPrincipalURI());
+        $fullCalendarFilename = sprintf('calendars/%s/%s/%s', $user, $this->calendarInfo['uri'], $name);
+
+        // Force calendar change URI
+        /** @var Schedule\Plugin $schedulingPlugin */
+        $schedulingPlugin = $server->server->getPlugin('caldav-schedule');
+        $schedulingPlugin->setPathOfCalendarObjectChange($fullCalendarFilename);
+
+        $stream = fopen('php://memory', 'rb+');
+        fwrite($stream, $calendarData);
+        rewind($stream);
+        try {
+            $server->server->createFile($fullCalendarFilename, $stream);
+        } catch (Conflict $e) {
+            throw new CalendarException('Could not create new calendar event: ' . $e->getMessage(), 0, $e);
+        } finally {
+            fclose($stream);
+        }
+    }
+
+    /**
+     * @throws CalendarException
+     */
+    public function handleIMipMessage(string $name, string $calendarData): void {
+        $server = new InvitationResponseServer(false);
+
+        /** @var CustomPrincipalPlugin $plugin */
+        $plugin = $server->server->getPlugin('auth');
+        // we're working around the previous implementation
+        // that only allowed the public system principal to be used
+        // so set the custom principal here
+        $plugin->setCurrentPrincipal($this->calendar->getPrincipalURI());
+
+        if (empty($this->calendarInfo['uri'])) {
+            throw new CalendarException('Could not write to calendar as URI parameter is missing');
+        }
+        // Force calendar change URI
+        /** @var Schedule\Plugin $schedulingPlugin */
+        $schedulingPlugin = $server->server->getPlugin('caldav-schedule');
+        // Let sabre handle the rest
+        $iTipMessage = new Message();
+        /** @var VCalendar $vObject */
+        $vObject = Reader::read($calendarData);
+        /** @var VEvent $vEvent */
+        $vEvent = $vObject->{'VEVENT'};
+
+        if($vObject->{'METHOD'} === null) {
+            throw new CalendarException('No Method provided for scheduling data. Could not process message');
+        }
+
+        if(!isset($vEvent->{'ORGANIZER'}) || !isset($vEvent->{'ATTENDEE'})) {
+            throw new CalendarException('Could not process scheduling data, neccessary data missing from ICAL');
+        }
+        $orgaizer = $vEvent->{'ORGANIZER'}->getValue();
+        $attendee = $vEvent->{'ATTENDEE'}->getValue();
+
+        $iTipMessage->method = $vObject->{'METHOD'}->getValue();
+        if($iTipMessage->method === 'REPLY') {
+            if ($server->isExternalAttendee($vEvent->{'ATTENDEE'}->getValue())) {
+                $iTipMessage->recipient = $orgaizer;
+            } else {
+                $iTipMessage->recipient = $attendee;
+            }
+            $iTipMessage->sender = $attendee;
+        } else if($iTipMessage->method === 'CANCEL') {
+            $iTipMessage->recipient = $attendee;
+            $iTipMessage->sender = $orgaizer;
+        }
+        $iTipMessage->uid = isset($vEvent->{'UID'}) ? $vEvent->{'UID'}->getValue() : '';
+        $iTipMessage->component = 'VEVENT';
+        $iTipMessage->sequence = isset($vEvent->{'SEQUENCE'}) ? (int)$vEvent->{'SEQUENCE'}->getValue() : 0;
+        $iTipMessage->message = $vObject;
+        $schedulingPlugin->scheduleLocalDelivery($iTipMessage);
+    }
 }

lib/public/Calendar/ICalendar.php

Indentation +42 added lines, -42 removed lines

@@ -33,52 +33,52 @@
  */
 interface ICalendar {
 
-	/**
-	 * @return string defining the technical unique key
-	 * @since 13.0.0
-	 */
-	public function getKey(): string;
+    /**
+     * @return string defining the technical unique key
+     * @since 13.0.0
+     */
+    public function getKey(): string;
 
-	/**
-	 * @since 24.0.0
-	 */
-	public function getUri(): string;
+    /**
+     * @since 24.0.0
+     */
+    public function getUri(): string;
 
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 * @return null|string
-	 * @since 13.0.0
-	 */
-	public function getDisplayName(): ?string;
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     * @return null|string
+     * @since 13.0.0
+     */
+    public function getDisplayName(): ?string;
 
-	/**
-	 * Calendar color
-	 * @return null|string
-	 * @since 13.0.0
-	 */
-	public function getDisplayColor(): ?string;
+    /**
+     * Calendar color
+     * @return null|string
+     * @since 13.0.0
+     */
+    public function getDisplayColor(): ?string;
 
-	/**
-	 * @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 int|null $limit - limit number of search results
-	 * @param int|null $offset - offset for paging of search results
-	 * @return array an array of events/journals/todos which are arrays of key-value-pairs
-	 * @since 13.0.0
-	 */
-	public function search(string $pattern, array $searchProperties = [], array $options = [], ?int $limit = null, ?int $offset = null): array;
+    /**
+     * @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 int|null $limit - limit number of search results
+     * @param int|null $offset - offset for paging of search results
+     * @return array an array of events/journals/todos which are arrays of key-value-pairs
+     * @since 13.0.0
+     */
+    public function search(string $pattern, array $searchProperties = [], array $options = [], ?int $limit = null, ?int $offset = null): array;
 
-	/**
-	 * @return int build up using \OCP\Constants
-	 * @since 13.0.0
-	 */
-	public function getPermissions(): int;
+    /**
+     * @return int build up using \OCP\Constants
+     * @since 13.0.0
+     */
+    public function getPermissions(): int;
 
-	/**
-	 * Whether the calendar is deleted
-	 * @since 26.0.0
-	 */
-	public function isDeleted(): bool;
+    /**
+     * Whether the calendar is deleted
+     * @since 26.0.0
+     */
+    public function isDeleted(): bool;
 }