nextcloud / server

apps/dav/lib/CalDAV/Reminder/ReminderService.php

Indentation +734 added lines, -734 removed lines

@@ -45,738 +45,738 @@
 
 class ReminderService {
 
-	/** @var Backend */
-	private $backend;
-
-	/** @var NotificationProviderManager */
-	private $notificationProviderManager;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var CalDavBackend */
-	private $caldavBackend;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	public const REMINDER_TYPE_EMAIL = 'EMAIL';
-	public const REMINDER_TYPE_DISPLAY = 'DISPLAY';
-	public const REMINDER_TYPE_AUDIO = 'AUDIO';
-
-	/**
-	 * @var String[]
-	 *
-	 * Official RFC5545 reminder types
-	 */
-	public const REMINDER_TYPES = [
-		self::REMINDER_TYPE_EMAIL,
-		self::REMINDER_TYPE_DISPLAY,
-		self::REMINDER_TYPE_AUDIO
-	];
-
-	/**
-	 * ReminderService constructor.
-	 *
-	 * @param Backend $backend
-	 * @param NotificationProviderManager $notificationProviderManager
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param CalDavBackend $caldavBackend
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(Backend $backend,
-								NotificationProviderManager $notificationProviderManager,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								CalDavBackend $caldavBackend,
-								ITimeFactory $timeFactory) {
-		$this->backend = $backend;
-		$this->notificationProviderManager = $notificationProviderManager;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->caldavBackend = $caldavBackend;
-		$this->timeFactory = $timeFactory;
-	}
-
-	/**
-	 * Process reminders to activate
-	 *
-	 * @throws NotificationProvider\ProviderNotAvailableException
-	 * @throws NotificationTypeDoesNotExistException
-	 */
-	public function processReminders():void {
-		$reminders = $this->backend->getRemindersToProcess();
-
-		foreach($reminders as $reminder) {
-			$calendarData = is_resource($reminder['calendardata'])
-				? stream_get_contents($reminder['calendardata'])
-				: $reminder['calendardata'];
-
-			$vcalendar = $this->parseCalendarData($calendarData);
-			if (!$vcalendar) {
-				$this->backend->removeReminder($reminder['id']);
-				continue;
-			}
-
-			$vevent = $this->getVEventByRecurrenceId($vcalendar, $reminder['recurrence_id'], $reminder['is_recurrence_exception']);
-			if (!$vevent) {
-				$this->backend->removeReminder($reminder['id']);
-				continue;
-			}
-
-			if ($this->wasEventCancelled($vevent)) {
-				$this->deleteOrProcessNext($reminder, $vevent);
-				continue;
-			}
-
-			if (!$this->notificationProviderManager->hasProvider($reminder['type'])) {
-				$this->deleteOrProcessNext($reminder, $vevent);
-				continue;
-			}
-
-			$users = $this->getAllUsersWithWriteAccessToCalendar($reminder['calendar_id']);
-			$user = $this->getUserFromPrincipalURI($reminder['principaluri']);
-			if ($user) {
-				$users[] = $user;
-			}
-
-			$notificationProvider = $this->notificationProviderManager->getProvider($reminder['type']);
-			$notificationProvider->send($vevent, $reminder['displayname'], $users);
-
-			$this->deleteOrProcessNext($reminder, $vevent);
-		}
-	}
-
-	/**
-	 * @param string $action
-	 * @param array $objectData
-	 * @throws VObject\InvalidDataException
-	 */
-	public function onTouchCalendarObject(string $action,
-										  array $objectData):void {
-		// We only support VEvents for now
-		if (strcasecmp($objectData['component'], 'vevent') !== 0) {
-			return;
-		}
-
-		switch($action) {
-			case '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject':
-				$this->onCalendarObjectCreate($objectData);
-				break;
-
-			case '\OCA\DAV\CalDAV\CalDavBackend::updateCalendarObject':
-				$this->onCalendarObjectEdit($objectData);
-				break;
-
-			case '\OCA\DAV\CalDAV\CalDavBackend::deleteCalendarObject':
-				$this->onCalendarObjectDelete($objectData);
-				break;
-
-			default:
-				break;
-		}
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectCreate(array $objectData):void {
-		$calendarData = is_resource($objectData['calendardata'])
-			? stream_get_contents($objectData['calendardata'])
-			: $objectData['calendardata'];
-
-		/** @var VObject\Component\VCalendar $vcalendar */
-		$vcalendar = $this->parseCalendarData($calendarData);
-		if (!$vcalendar) {
-			return;
-		}
-
-		$vevents = $this->getAllVEventsFromVCalendar($vcalendar);
-		if (count($vevents) === 0) {
-			return;
-		}
-
-		$uid = (string) $vevents[0]->UID;
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$masterItem = $this->getMasterItemFromListOfVEvents($vevents);
-		$now = $this->timeFactory->getDateTime();
-		$isRecurring = $masterItem ? $this->isRecurring($masterItem) : false;
-
-		foreach($recurrenceExceptions as $recurrenceException) {
-			$eventHash = $this->getEventHash($recurrenceException);
-
-			if (!isset($recurrenceException->VALARM)) {
-				continue;
-			}
-
-			foreach($recurrenceException->VALARM as $valarm) {
-				/** @var VAlarm $valarm */
-				$alarmHash = $this->getAlarmHash($valarm);
-				$triggerTime = $valarm->getEffectiveTriggerTime();
-				$diff = $now->diff($triggerTime);
-				if ($diff->invert === 1) {
-					continue;
-				}
-
-				$alarms = $this->getRemindersForVAlarm($valarm, $objectData,
-					$eventHash, $alarmHash, true, true);
-				$this->writeRemindersToDatabase($alarms);
-			}
-		}
-
-		if ($masterItem) {
-			$processedAlarms = [];
-			$masterAlarms = [];
-			$masterHash = $this->getEventHash($masterItem);
-
-			if (!isset($masterItem->VALARM)) {
-				return;
-			}
-
-			foreach($masterItem->VALARM as $valarm) {
-				$masterAlarms[] = $this->getAlarmHash($valarm);
-			}
-
-			try {
-				$iterator = new EventIterator($vevents, $uid);
-			} catch (NoInstancesException $e) {
-				// This event is recurring, but it doesn't have a single
-				// instance. We are skipping this event from the output
-				// entirely.
-				return;
-			}
-
-			while($iterator->valid() && count($processedAlarms) < count($masterAlarms)) {
-				$event = $iterator->getEventObject();
-
-				// Recurrence-exceptions are handled separately, so just ignore them here
-				if (\in_array($event, $recurrenceExceptions, true)) {
-					$iterator->next();
-					continue;
-				}
-
-				foreach($event->VALARM as $valarm) {
-					/** @var VAlarm $valarm */
-					$alarmHash = $this->getAlarmHash($valarm);
-					if (\in_array($alarmHash, $processedAlarms, true)) {
-						continue;
-					}
-
-					if (!\in_array((string) $valarm->ACTION, self::REMINDER_TYPES, true)) {
-						// Action allows x-name, we don't insert reminders
-						// into the database if they are not standard
-						$processedAlarms[] = $alarmHash;
-						continue;
-					}
-
-					$triggerTime = $valarm->getEffectiveTriggerTime();
-
-					// If effective trigger time is in the past
-					// just skip and generate for next event
-					$diff = $now->diff($triggerTime);
-					if ($diff->invert === 1) {
-						// If an absolute alarm is in the past,
-						// just add it to processedAlarms, so
-						// we don't extend till eternity
-						if (!$this->isAlarmRelative($valarm)) {
-							$processedAlarms[] = $alarmHash;
-						}
-
-						continue;
-					}
-
-					$alarms = $this->getRemindersForVAlarm($valarm, $objectData, $masterHash, $alarmHash, $isRecurring, false);
-					$this->writeRemindersToDatabase($alarms);
-					$processedAlarms[] = $alarmHash;
-				}
-
-				$iterator->next();
-			}
-		}
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectEdit(array $objectData):void {
-		// TODO - this can be vastly improved
-		//  - get cached reminders
-		//  - ...
-
-		$this->onCalendarObjectDelete($objectData);
-		$this->onCalendarObjectCreate($objectData);
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectDelete(array $objectData):void {
-		$this->backend->cleanRemindersForEvent((int) $objectData['id']);
-	}
-
-	/**
-	 * @param VAlarm $valarm
-	 * @param array $objectData
-	 * @param string|null $eventHash
-	 * @param string|null $alarmHash
-	 * @param bool $isRecurring
-	 * @param bool $isRecurrenceException
-	 * @return array
-	 */
-	private function getRemindersForVAlarm(VAlarm $valarm,
-										   array $objectData,
-										   string $eventHash=null,
-										   string $alarmHash=null,
-										   bool $isRecurring=false,
-										   bool $isRecurrenceException=false):array {
-		if ($eventHash === null) {
-			$eventHash = $this->getEventHash($valarm->parent);
-		}
-		if ($alarmHash === null) {
-			$alarmHash = $this->getAlarmHash($valarm);
-		}
-
-		$recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($valarm->parent);
-		$isRelative = $this->isAlarmRelative($valarm);
-		/** @var DateTimeImmutable $notificationDate */
-		$notificationDate = $valarm->getEffectiveTriggerTime();
-		$clonedNotificationDate = new \DateTime('now', $notificationDate->getTimezone());
-		$clonedNotificationDate->setTimestamp($notificationDate->getTimestamp());
-
-		$alarms = [];
-
-		$alarms[] = [
-			'calendar_id' => $objectData['calendarid'],
-			'object_id' => $objectData['id'],
-			'uid' => (string) $valarm->parent->UID,
-			'is_recurring' => $isRecurring,
-			'recurrence_id' => $recurrenceId,
-			'is_recurrence_exception' => $isRecurrenceException,
-			'event_hash' => $eventHash,
-			'alarm_hash' => $alarmHash,
-			'type' => (string) $valarm->ACTION,
-			'is_relative' => $isRelative,
-			'notification_date' => $notificationDate->getTimestamp(),
-			'is_repeat_based' => false,
-		];
-
-		$repeat = isset($valarm->REPEAT) ? (int) $valarm->REPEAT->getValue() : 0;
-		for($i = 0; $i < $repeat; $i++) {
-			if ($valarm->DURATION === null) {
-				continue;
-			}
-
-			$clonedNotificationDate->add($valarm->DURATION->getDateInterval());
-			$alarms[] = [
-				'calendar_id' => $objectData['calendarid'],
-				'object_id' => $objectData['id'],
-				'uid' => (string) $valarm->parent->UID,
-				'is_recurring' => $isRecurring,
-				'recurrence_id' => $recurrenceId,
-				'is_recurrence_exception' => $isRecurrenceException,
-				'event_hash' => $eventHash,
-				'alarm_hash' => $alarmHash,
-				'type' => (string) $valarm->ACTION,
-				'is_relative' => $isRelative,
-				'notification_date' => $clonedNotificationDate->getTimestamp(),
-				'is_repeat_based' => true,
-			];
-		}
-
-		return $alarms;
-	}
-
-	/**
-	 * @param array $reminders
-	 */
-	private function writeRemindersToDatabase(array $reminders): void {
-		foreach($reminders as $reminder) {
-			$this->backend->insertReminder(
-				(int) $reminder['calendar_id'],
-				(int) $reminder['object_id'],
-				$reminder['uid'],
-				$reminder['is_recurring'],
-				(int) $reminder['recurrence_id'],
-				$reminder['is_recurrence_exception'],
-				$reminder['event_hash'],
-				$reminder['alarm_hash'],
-				$reminder['type'],
-				$reminder['is_relative'],
-				(int) $reminder['notification_date'],
-				$reminder['is_repeat_based']
-			);
-		}
-	}
-
-	/**
-	 * @param array $reminder
-	 * @param VEvent $vevent
-	 */
-	private function deleteOrProcessNext(array $reminder,
-										 VObject\Component\VEvent $vevent):void {
-		if ($reminder['is_repeat_based'] ||
-			!$reminder['is_recurring'] ||
-			!$reminder['is_relative'] ||
-			$reminder['is_recurrence_exception']) {
-
-			$this->backend->removeReminder($reminder['id']);
-			return;
-		}
-
-		$vevents = $this->getAllVEventsFromVCalendar($vevent->parent);
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$now = $this->timeFactory->getDateTime();
-
-		try {
-			$iterator = new EventIterator($vevents, $reminder['uid']);
-		} catch (NoInstancesException $e) {
-			// This event is recurring, but it doesn't have a single
-			// instance. We are skipping this event from the output
-			// entirely.
-			return;
-		}
-
-		while($iterator->valid()) {
-			$event = $iterator->getEventObject();
-
-			// Recurrence-exceptions are handled separately, so just ignore them here
-			if (\in_array($event, $recurrenceExceptions, true)) {
-				$iterator->next();
-				continue;
-			}
-
-			$recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($event);
-			if ($reminder['recurrence_id'] >= $recurrenceId) {
-				$iterator->next();
-				continue;
-			}
-
-			foreach($event->VALARM as $valarm) {
-				/** @var VAlarm $valarm */
-				$alarmHash = $this->getAlarmHash($valarm);
-				if ($alarmHash !== $reminder['alarm_hash']) {
-					continue;
-				}
-
-				$triggerTime = $valarm->getEffectiveTriggerTime();
-
-				// If effective trigger time is in the past
-				// just skip and generate for next event
-				$diff = $now->diff($triggerTime);
-				if ($diff->invert === 1) {
-					continue;
-				}
-
-				$this->backend->removeReminder($reminder['id']);
-				$alarms = $this->getRemindersForVAlarm($valarm, [
-					'calendarid' => $reminder['calendar_id'],
-					'id' => $reminder['object_id'],
-				], $reminder['event_hash'], $alarmHash, true, false);
-				$this->writeRemindersToDatabase($alarms);
-
-				// Abort generating reminders after creating one successfully
-				return;
-			}
-
-			$iterator->next();
-		}
-
-		$this->backend->removeReminder($reminder['id']);
-	}
-
-	/**
-	 * @param int $calendarId
-	 * @return IUser[]
-	 */
-	private function getAllUsersWithWriteAccessToCalendar(int $calendarId):array {
-		$shares = $this->caldavBackend->getShares($calendarId);
-
-		$users = [];
-		$userIds = [];
-		$groups = [];
-		foreach ($shares as $share) {
-			// Only consider writable shares
-			if ($share['readOnly']) {
-				continue;
-			}
-
-			$principal = explode('/', $share['{http://owncloud.org/ns}principal']);
-			if ($principal[1] === 'users') {
-				$user = $this->userManager->get($principal[2]);
-				if ($user) {
-					$users[] = $user;
-					$userIds[] = $principal[2];
-				}
-			} else if ($principal[1] === 'groups') {
-				$groups[] = $principal[2];
-			}
-		}
-
-		foreach ($groups as $gid) {
-			$group = $this->groupManager->get($gid);
-			if ($group instanceof IGroup) {
-				foreach ($group->getUsers() as $user) {
-					if (!\in_array($user->getUID(), $userIds, true)) {
-						$users[] = $user;
-						$userIds[] = $user->getUID();
-					}
-				}
-			}
-		}
-
-		return $users;
-	}
-
-	/**
-	 * Gets a hash of the event.
-	 * If the hash changes, we have to update all relative alarms.
-	 *
-	 * @param VEvent $vevent
-	 * @return string
-	 */
-	private function getEventHash(VEvent $vevent):string {
-		$properties = [
-			(string) $vevent->DTSTART->serialize(),
-		];
-
-		if ($vevent->DTEND) {
-			$properties[] = (string) $vevent->DTEND->serialize();
-		}
-		if ($vevent->DURATION) {
-			$properties[] = (string) $vevent->DURATION->serialize();
-		}
-		if ($vevent->{'RECURRENCE-ID'}) {
-			$properties[] = (string) $vevent->{'RECURRENCE-ID'}->serialize();
-		}
-		if ($vevent->RRULE) {
-			$properties[] = (string) $vevent->RRULE->serialize();
-		}
-		if ($vevent->EXDATE) {
-			$properties[] = (string) $vevent->EXDATE->serialize();
-		}
-		if ($vevent->RDATE) {
-			$properties[] = (string) $vevent->RDATE->serialize();
-		}
-
-		return md5(implode('::', $properties));
-	}
-
-	/**
-	 * Gets a hash of the alarm.
-	 * If the hash changes, we have to update oc_dav_reminders.
-	 *
-	 * @param VAlarm $valarm
-	 * @return string
-	 */
-	private function getAlarmHash(VAlarm $valarm):string {
-		$properties = [
-			(string) $valarm->ACTION->serialize(),
-			(string) $valarm->TRIGGER->serialize(),
-		];
-
-		if ($valarm->DURATION) {
-			$properties[] = (string) $valarm->DURATION->serialize();
-		}
-		if ($valarm->REPEAT) {
-			$properties[] = (string) $valarm->REPEAT->serialize();
-		}
-
-		return md5(implode('::', $properties));
-	}
-
-	/**
-	 * @param VObject\Component\VCalendar $vcalendar
-	 * @param int $recurrenceId
-	 * @param bool $isRecurrenceException
-	 * @return VEvent|null
-	 */
-	private function getVEventByRecurrenceId(VObject\Component\VCalendar $vcalendar,
-											 int $recurrenceId,
-											 bool $isRecurrenceException):?VEvent {
-		$vevents = $this->getAllVEventsFromVCalendar($vcalendar);
-		if (count($vevents) === 0) {
-			return null;
-		}
-
-		$uid = (string) $vevents[0]->UID;
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$masterItem = $this->getMasterItemFromListOfVEvents($vevents);
-
-		// Handle recurrence-exceptions first, because recurrence-expansion is expensive
-		if ($isRecurrenceException) {
-			foreach($recurrenceExceptions as $recurrenceException) {
-				if ($this->getEffectiveRecurrenceIdOfVEvent($recurrenceException) === $recurrenceId) {
-					return $recurrenceException;
-				}
-			}
-
-			return null;
-		}
-
-		if ($masterItem) {
-			try {
-				$iterator = new EventIterator($vevents, $uid);
-			} catch (NoInstancesException $e) {
-				// This event is recurring, but it doesn't have a single
-				// instance. We are skipping this event from the output
-				// entirely.
-				return null;
-			}
-
-			while ($iterator->valid()) {
-				$event = $iterator->getEventObject();
-
-				// Recurrence-exceptions are handled separately, so just ignore them here
-				if (\in_array($event, $recurrenceExceptions, true)) {
-					$iterator->next();
-					continue;
-				}
-
-				if ($this->getEffectiveRecurrenceIdOfVEvent($event) === $recurrenceId) {
-					return $event;
-				}
-
-				$iterator->next();
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return string
-	 */
-	private function getStatusOfEvent(VEvent $vevent):string {
-		if ($vevent->STATUS) {
-			return (string) $vevent->STATUS;
-		}
-
-		// Doesn't say so in the standard,
-		// but we consider events without a status
-		// to be confirmed
-		return 'CONFIRMED';
-	}
-
-	/**
-	 * @param VObject\Component\VEvent $vevent
-	 * @return bool
-	 */
-	private function wasEventCancelled(VObject\Component\VEvent $vevent):bool {
-		return $this->getStatusOfEvent($vevent) === 'CANCELLED';
-	}
-
-	/**
-	 * @param string $calendarData
-	 * @return VObject\Component\VCalendar|null
-	 */
-	private function parseCalendarData(string $calendarData):?VObject\Component\VCalendar {
-		try {
-			return VObject\Reader::read($calendarData,
-				VObject\Reader::OPTION_FORGIVING);
-		} catch(ParseException $ex) {
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $principalUri
-	 * @return IUser|null
-	 */
-	private function getUserFromPrincipalURI(string $principalUri):?IUser {
-		if (!$principalUri) {
-			return null;
-		}
-
-		if (stripos($principalUri, 'principals/users/') !== 0) {
-			return null;
-		}
-
-		$userId = substr($principalUri, 17);
-		return $this->userManager->get($userId);
-	}
-
-	/**
-	 * @param VObject\Component\VCalendar $vcalendar
-	 * @return VObject\Component\VEvent[]
-	 */
-	private function getAllVEventsFromVCalendar(VObject\Component\VCalendar $vcalendar):array {
-		$vevents = [];
-
-		foreach($vcalendar->children() as $child) {
-			if (!($child instanceof VObject\Component)) {
-				continue;
-			}
-
-			if ($child->name !== 'VEVENT') {
-				continue;
-			}
-
-			$vevents[] = $child;
-		}
-
-		return $vevents;
-	}
-
-	/**
-	 * @param array $vevents
-	 * @return VObject\Component\VEvent[]
-	 */
-	private function getRecurrenceExceptionFromListOfVEvents(array $vevents):array {
-		return array_values(array_filter($vevents, function (VEvent $vevent) {
-			return $vevent->{'RECURRENCE-ID'} !== null;
-		}));
-	}
-
-	/**
-	 * @param array $vevents
-	 * @return VEvent|null
-	 */
-	private function getMasterItemFromListOfVEvents(array $vevents):?VEvent {
-		$elements = array_values(array_filter($vevents, function (VEvent $vevent) {
-			return $vevent->{'RECURRENCE-ID'} === null;
-		}));
-
-		if (count($elements) === 0) {
-			return null;
-		}
-		if (count($elements) > 1) {
-			throw new \TypeError('Multiple master objects');
-		}
-
-		return $elements[0];
-	}
-
-	/**
-	 * @param VAlarm $valarm
-	 * @return bool
-	 */
-	private function isAlarmRelative(VAlarm $valarm):bool {
-		$trigger = $valarm->TRIGGER;
-		return $trigger instanceof VObject\Property\ICalendar\Duration;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return int
-	 */
-	private function getEffectiveRecurrenceIdOfVEvent(VEvent $vevent):int {
-		if (isset($vevent->{'RECURRENCE-ID'})) {
-			return $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimestamp();
-		}
-
-		return $vevent->DTSTART->getDateTime()->getTimestamp();
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return bool
-	 */
-	private function isRecurring(VEvent $vevent):bool {
-		return isset($vevent->RRULE) || isset($vevent->RDATE);
-	}
+    /** @var Backend */
+    private $backend;
+
+    /** @var NotificationProviderManager */
+    private $notificationProviderManager;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var CalDavBackend */
+    private $caldavBackend;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    public const REMINDER_TYPE_EMAIL = 'EMAIL';
+    public const REMINDER_TYPE_DISPLAY = 'DISPLAY';
+    public const REMINDER_TYPE_AUDIO = 'AUDIO';
+
+    /**
+     * @var String[]
+     *
+     * Official RFC5545 reminder types
+     */
+    public const REMINDER_TYPES = [
+        self::REMINDER_TYPE_EMAIL,
+        self::REMINDER_TYPE_DISPLAY,
+        self::REMINDER_TYPE_AUDIO
+    ];
+
+    /**
+     * ReminderService constructor.
+     *
+     * @param Backend $backend
+     * @param NotificationProviderManager $notificationProviderManager
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param CalDavBackend $caldavBackend
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(Backend $backend,
+                                NotificationProviderManager $notificationProviderManager,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                CalDavBackend $caldavBackend,
+                                ITimeFactory $timeFactory) {
+        $this->backend = $backend;
+        $this->notificationProviderManager = $notificationProviderManager;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->caldavBackend = $caldavBackend;
+        $this->timeFactory = $timeFactory;
+    }
+
+    /**
+     * Process reminders to activate
+     *
+     * @throws NotificationProvider\ProviderNotAvailableException
+     * @throws NotificationTypeDoesNotExistException
+     */
+    public function processReminders():void {
+        $reminders = $this->backend->getRemindersToProcess();
+
+        foreach($reminders as $reminder) {
+            $calendarData = is_resource($reminder['calendardata'])
+                ? stream_get_contents($reminder['calendardata'])
+                : $reminder['calendardata'];
+
+            $vcalendar = $this->parseCalendarData($calendarData);
+            if (!$vcalendar) {
+                $this->backend->removeReminder($reminder['id']);
+                continue;
+            }
+
+            $vevent = $this->getVEventByRecurrenceId($vcalendar, $reminder['recurrence_id'], $reminder['is_recurrence_exception']);
+            if (!$vevent) {
+                $this->backend->removeReminder($reminder['id']);
+                continue;
+            }
+
+            if ($this->wasEventCancelled($vevent)) {
+                $this->deleteOrProcessNext($reminder, $vevent);
+                continue;
+            }
+
+            if (!$this->notificationProviderManager->hasProvider($reminder['type'])) {
+                $this->deleteOrProcessNext($reminder, $vevent);
+                continue;
+            }
+
+            $users = $this->getAllUsersWithWriteAccessToCalendar($reminder['calendar_id']);
+            $user = $this->getUserFromPrincipalURI($reminder['principaluri']);
+            if ($user) {
+                $users[] = $user;
+            }
+
+            $notificationProvider = $this->notificationProviderManager->getProvider($reminder['type']);
+            $notificationProvider->send($vevent, $reminder['displayname'], $users);
+
+            $this->deleteOrProcessNext($reminder, $vevent);
+        }
+    }
+
+    /**
+     * @param string $action
+     * @param array $objectData
+     * @throws VObject\InvalidDataException
+     */
+    public function onTouchCalendarObject(string $action,
+                                            array $objectData):void {
+        // We only support VEvents for now
+        if (strcasecmp($objectData['component'], 'vevent') !== 0) {
+            return;
+        }
+
+        switch($action) {
+            case '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject':
+                $this->onCalendarObjectCreate($objectData);
+                break;
+
+            case '\OCA\DAV\CalDAV\CalDavBackend::updateCalendarObject':
+                $this->onCalendarObjectEdit($objectData);
+                break;
+
+            case '\OCA\DAV\CalDAV\CalDavBackend::deleteCalendarObject':
+                $this->onCalendarObjectDelete($objectData);
+                break;
+
+            default:
+                break;
+        }
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectCreate(array $objectData):void {
+        $calendarData = is_resource($objectData['calendardata'])
+            ? stream_get_contents($objectData['calendardata'])
+            : $objectData['calendardata'];
+
+        /** @var VObject\Component\VCalendar $vcalendar */
+        $vcalendar = $this->parseCalendarData($calendarData);
+        if (!$vcalendar) {
+            return;
+        }
+
+        $vevents = $this->getAllVEventsFromVCalendar($vcalendar);
+        if (count($vevents) === 0) {
+            return;
+        }
+
+        $uid = (string) $vevents[0]->UID;
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $masterItem = $this->getMasterItemFromListOfVEvents($vevents);
+        $now = $this->timeFactory->getDateTime();
+        $isRecurring = $masterItem ? $this->isRecurring($masterItem) : false;
+
+        foreach($recurrenceExceptions as $recurrenceException) {
+            $eventHash = $this->getEventHash($recurrenceException);
+
+            if (!isset($recurrenceException->VALARM)) {
+                continue;
+            }
+
+            foreach($recurrenceException->VALARM as $valarm) {
+                /** @var VAlarm $valarm */
+                $alarmHash = $this->getAlarmHash($valarm);
+                $triggerTime = $valarm->getEffectiveTriggerTime();
+                $diff = $now->diff($triggerTime);
+                if ($diff->invert === 1) {
+                    continue;
+                }
+
+                $alarms = $this->getRemindersForVAlarm($valarm, $objectData,
+                    $eventHash, $alarmHash, true, true);
+                $this->writeRemindersToDatabase($alarms);
+            }
+        }
+
+        if ($masterItem) {
+            $processedAlarms = [];
+            $masterAlarms = [];
+            $masterHash = $this->getEventHash($masterItem);
+
+            if (!isset($masterItem->VALARM)) {
+                return;
+            }
+
+            foreach($masterItem->VALARM as $valarm) {
+                $masterAlarms[] = $this->getAlarmHash($valarm);
+            }
+
+            try {
+                $iterator = new EventIterator($vevents, $uid);
+            } catch (NoInstancesException $e) {
+                // This event is recurring, but it doesn't have a single
+                // instance. We are skipping this event from the output
+                // entirely.
+                return;
+            }
+
+            while($iterator->valid() && count($processedAlarms) < count($masterAlarms)) {
+                $event = $iterator->getEventObject();
+
+                // Recurrence-exceptions are handled separately, so just ignore them here
+                if (\in_array($event, $recurrenceExceptions, true)) {
+                    $iterator->next();
+                    continue;
+                }
+
+                foreach($event->VALARM as $valarm) {
+                    /** @var VAlarm $valarm */
+                    $alarmHash = $this->getAlarmHash($valarm);
+                    if (\in_array($alarmHash, $processedAlarms, true)) {
+                        continue;
+                    }
+
+                    if (!\in_array((string) $valarm->ACTION, self::REMINDER_TYPES, true)) {
+                        // Action allows x-name, we don't insert reminders
+                        // into the database if they are not standard
+                        $processedAlarms[] = $alarmHash;
+                        continue;
+                    }
+
+                    $triggerTime = $valarm->getEffectiveTriggerTime();
+
+                    // If effective trigger time is in the past
+                    // just skip and generate for next event
+                    $diff = $now->diff($triggerTime);
+                    if ($diff->invert === 1) {
+                        // If an absolute alarm is in the past,
+                        // just add it to processedAlarms, so
+                        // we don't extend till eternity
+                        if (!$this->isAlarmRelative($valarm)) {
+                            $processedAlarms[] = $alarmHash;
+                        }
+
+                        continue;
+                    }
+
+                    $alarms = $this->getRemindersForVAlarm($valarm, $objectData, $masterHash, $alarmHash, $isRecurring, false);
+                    $this->writeRemindersToDatabase($alarms);
+                    $processedAlarms[] = $alarmHash;
+                }
+
+                $iterator->next();
+            }
+        }
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectEdit(array $objectData):void {
+        // TODO - this can be vastly improved
+        //  - get cached reminders
+        //  - ...
+
+        $this->onCalendarObjectDelete($objectData);
+        $this->onCalendarObjectCreate($objectData);
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectDelete(array $objectData):void {
+        $this->backend->cleanRemindersForEvent((int) $objectData['id']);
+    }
+
+    /**
+     * @param VAlarm $valarm
+     * @param array $objectData
+     * @param string|null $eventHash
+     * @param string|null $alarmHash
+     * @param bool $isRecurring
+     * @param bool $isRecurrenceException
+     * @return array
+     */
+    private function getRemindersForVAlarm(VAlarm $valarm,
+                                            array $objectData,
+                                            string $eventHash=null,
+                                            string $alarmHash=null,
+                                            bool $isRecurring=false,
+                                            bool $isRecurrenceException=false):array {
+        if ($eventHash === null) {
+            $eventHash = $this->getEventHash($valarm->parent);
+        }
+        if ($alarmHash === null) {
+            $alarmHash = $this->getAlarmHash($valarm);
+        }
+
+        $recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($valarm->parent);
+        $isRelative = $this->isAlarmRelative($valarm);
+        /** @var DateTimeImmutable $notificationDate */
+        $notificationDate = $valarm->getEffectiveTriggerTime();
+        $clonedNotificationDate = new \DateTime('now', $notificationDate->getTimezone());
+        $clonedNotificationDate->setTimestamp($notificationDate->getTimestamp());
+
+        $alarms = [];
+
+        $alarms[] = [
+            'calendar_id' => $objectData['calendarid'],
+            'object_id' => $objectData['id'],
+            'uid' => (string) $valarm->parent->UID,
+            'is_recurring' => $isRecurring,
+            'recurrence_id' => $recurrenceId,
+            'is_recurrence_exception' => $isRecurrenceException,
+            'event_hash' => $eventHash,
+            'alarm_hash' => $alarmHash,
+            'type' => (string) $valarm->ACTION,
+            'is_relative' => $isRelative,
+            'notification_date' => $notificationDate->getTimestamp(),
+            'is_repeat_based' => false,
+        ];
+
+        $repeat = isset($valarm->REPEAT) ? (int) $valarm->REPEAT->getValue() : 0;
+        for($i = 0; $i < $repeat; $i++) {
+            if ($valarm->DURATION === null) {
+                continue;
+            }
+
+            $clonedNotificationDate->add($valarm->DURATION->getDateInterval());
+            $alarms[] = [
+                'calendar_id' => $objectData['calendarid'],
+                'object_id' => $objectData['id'],
+                'uid' => (string) $valarm->parent->UID,
+                'is_recurring' => $isRecurring,
+                'recurrence_id' => $recurrenceId,
+                'is_recurrence_exception' => $isRecurrenceException,
+                'event_hash' => $eventHash,
+                'alarm_hash' => $alarmHash,
+                'type' => (string) $valarm->ACTION,
+                'is_relative' => $isRelative,
+                'notification_date' => $clonedNotificationDate->getTimestamp(),
+                'is_repeat_based' => true,
+            ];
+        }
+
+        return $alarms;
+    }
+
+    /**
+     * @param array $reminders
+     */
+    private function writeRemindersToDatabase(array $reminders): void {
+        foreach($reminders as $reminder) {
+            $this->backend->insertReminder(
+                (int) $reminder['calendar_id'],
+                (int) $reminder['object_id'],
+                $reminder['uid'],
+                $reminder['is_recurring'],
+                (int) $reminder['recurrence_id'],
+                $reminder['is_recurrence_exception'],
+                $reminder['event_hash'],
+                $reminder['alarm_hash'],
+                $reminder['type'],
+                $reminder['is_relative'],
+                (int) $reminder['notification_date'],
+                $reminder['is_repeat_based']
+            );
+        }
+    }
+
+    /**
+     * @param array $reminder
+     * @param VEvent $vevent
+     */
+    private function deleteOrProcessNext(array $reminder,
+                                            VObject\Component\VEvent $vevent):void {
+        if ($reminder['is_repeat_based'] ||
+            !$reminder['is_recurring'] ||
+            !$reminder['is_relative'] ||
+            $reminder['is_recurrence_exception']) {
+
+            $this->backend->removeReminder($reminder['id']);
+            return;
+        }
+
+        $vevents = $this->getAllVEventsFromVCalendar($vevent->parent);
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $now = $this->timeFactory->getDateTime();
+
+        try {
+            $iterator = new EventIterator($vevents, $reminder['uid']);
+        } catch (NoInstancesException $e) {
+            // This event is recurring, but it doesn't have a single
+            // instance. We are skipping this event from the output
+            // entirely.
+            return;
+        }
+
+        while($iterator->valid()) {
+            $event = $iterator->getEventObject();
+
+            // Recurrence-exceptions are handled separately, so just ignore them here
+            if (\in_array($event, $recurrenceExceptions, true)) {
+                $iterator->next();
+                continue;
+            }
+
+            $recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($event);
+            if ($reminder['recurrence_id'] >= $recurrenceId) {
+                $iterator->next();
+                continue;
+            }
+
+            foreach($event->VALARM as $valarm) {
+                /** @var VAlarm $valarm */
+                $alarmHash = $this->getAlarmHash($valarm);
+                if ($alarmHash !== $reminder['alarm_hash']) {
+                    continue;
+                }
+
+                $triggerTime = $valarm->getEffectiveTriggerTime();
+
+                // If effective trigger time is in the past
+                // just skip and generate for next event
+                $diff = $now->diff($triggerTime);
+                if ($diff->invert === 1) {
+                    continue;
+                }
+
+                $this->backend->removeReminder($reminder['id']);
+                $alarms = $this->getRemindersForVAlarm($valarm, [
+                    'calendarid' => $reminder['calendar_id'],
+                    'id' => $reminder['object_id'],
+                ], $reminder['event_hash'], $alarmHash, true, false);
+                $this->writeRemindersToDatabase($alarms);
+
+                // Abort generating reminders after creating one successfully
+                return;
+            }
+
+            $iterator->next();
+        }
+
+        $this->backend->removeReminder($reminder['id']);
+    }
+
+    /**
+     * @param int $calendarId
+     * @return IUser[]
+     */
+    private function getAllUsersWithWriteAccessToCalendar(int $calendarId):array {
+        $shares = $this->caldavBackend->getShares($calendarId);
+
+        $users = [];
+        $userIds = [];
+        $groups = [];
+        foreach ($shares as $share) {
+            // Only consider writable shares
+            if ($share['readOnly']) {
+                continue;
+            }
+
+            $principal = explode('/', $share['{http://owncloud.org/ns}principal']);
+            if ($principal[1] === 'users') {
+                $user = $this->userManager->get($principal[2]);
+                if ($user) {
+                    $users[] = $user;
+                    $userIds[] = $principal[2];
+                }
+            } else if ($principal[1] === 'groups') {
+                $groups[] = $principal[2];
+            }
+        }
+
+        foreach ($groups as $gid) {
+            $group = $this->groupManager->get($gid);
+            if ($group instanceof IGroup) {
+                foreach ($group->getUsers() as $user) {
+                    if (!\in_array($user->getUID(), $userIds, true)) {
+                        $users[] = $user;
+                        $userIds[] = $user->getUID();
+                    }
+                }
+            }
+        }
+
+        return $users;
+    }
+
+    /**
+     * Gets a hash of the event.
+     * If the hash changes, we have to update all relative alarms.
+     *
+     * @param VEvent $vevent
+     * @return string
+     */
+    private function getEventHash(VEvent $vevent):string {
+        $properties = [
+            (string) $vevent->DTSTART->serialize(),
+        ];
+
+        if ($vevent->DTEND) {
+            $properties[] = (string) $vevent->DTEND->serialize();
+        }
+        if ($vevent->DURATION) {
+            $properties[] = (string) $vevent->DURATION->serialize();
+        }
+        if ($vevent->{'RECURRENCE-ID'}) {
+            $properties[] = (string) $vevent->{'RECURRENCE-ID'}->serialize();
+        }
+        if ($vevent->RRULE) {
+            $properties[] = (string) $vevent->RRULE->serialize();
+        }
+        if ($vevent->EXDATE) {
+            $properties[] = (string) $vevent->EXDATE->serialize();
+        }
+        if ($vevent->RDATE) {
+            $properties[] = (string) $vevent->RDATE->serialize();
+        }
+
+        return md5(implode('::', $properties));
+    }
+
+    /**
+     * Gets a hash of the alarm.
+     * If the hash changes, we have to update oc_dav_reminders.
+     *
+     * @param VAlarm $valarm
+     * @return string
+     */
+    private function getAlarmHash(VAlarm $valarm):string {
+        $properties = [
+            (string) $valarm->ACTION->serialize(),
+            (string) $valarm->TRIGGER->serialize(),
+        ];
+
+        if ($valarm->DURATION) {
+            $properties[] = (string) $valarm->DURATION->serialize();
+        }
+        if ($valarm->REPEAT) {
+            $properties[] = (string) $valarm->REPEAT->serialize();
+        }
+
+        return md5(implode('::', $properties));
+    }
+
+    /**
+     * @param VObject\Component\VCalendar $vcalendar
+     * @param int $recurrenceId
+     * @param bool $isRecurrenceException
+     * @return VEvent|null
+     */
+    private function getVEventByRecurrenceId(VObject\Component\VCalendar $vcalendar,
+                                                int $recurrenceId,
+                                                bool $isRecurrenceException):?VEvent {
+        $vevents = $this->getAllVEventsFromVCalendar($vcalendar);
+        if (count($vevents) === 0) {
+            return null;
+        }
+
+        $uid = (string) $vevents[0]->UID;
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $masterItem = $this->getMasterItemFromListOfVEvents($vevents);
+
+        // Handle recurrence-exceptions first, because recurrence-expansion is expensive
+        if ($isRecurrenceException) {
+            foreach($recurrenceExceptions as $recurrenceException) {
+                if ($this->getEffectiveRecurrenceIdOfVEvent($recurrenceException) === $recurrenceId) {
+                    return $recurrenceException;
+                }
+            }
+
+            return null;
+        }
+
+        if ($masterItem) {
+            try {
+                $iterator = new EventIterator($vevents, $uid);
+            } catch (NoInstancesException $e) {
+                // This event is recurring, but it doesn't have a single
+                // instance. We are skipping this event from the output
+                // entirely.
+                return null;
+            }
+
+            while ($iterator->valid()) {
+                $event = $iterator->getEventObject();
+
+                // Recurrence-exceptions are handled separately, so just ignore them here
+                if (\in_array($event, $recurrenceExceptions, true)) {
+                    $iterator->next();
+                    continue;
+                }
+
+                if ($this->getEffectiveRecurrenceIdOfVEvent($event) === $recurrenceId) {
+                    return $event;
+                }
+
+                $iterator->next();
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return string
+     */
+    private function getStatusOfEvent(VEvent $vevent):string {
+        if ($vevent->STATUS) {
+            return (string) $vevent->STATUS;
+        }
+
+        // Doesn't say so in the standard,
+        // but we consider events without a status
+        // to be confirmed
+        return 'CONFIRMED';
+    }
+
+    /**
+     * @param VObject\Component\VEvent $vevent
+     * @return bool
+     */
+    private function wasEventCancelled(VObject\Component\VEvent $vevent):bool {
+        return $this->getStatusOfEvent($vevent) === 'CANCELLED';
+    }
+
+    /**
+     * @param string $calendarData
+     * @return VObject\Component\VCalendar|null
+     */
+    private function parseCalendarData(string $calendarData):?VObject\Component\VCalendar {
+        try {
+            return VObject\Reader::read($calendarData,
+                VObject\Reader::OPTION_FORGIVING);
+        } catch(ParseException $ex) {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $principalUri
+     * @return IUser|null
+     */
+    private function getUserFromPrincipalURI(string $principalUri):?IUser {
+        if (!$principalUri) {
+            return null;
+        }
+
+        if (stripos($principalUri, 'principals/users/') !== 0) {
+            return null;
+        }
+
+        $userId = substr($principalUri, 17);
+        return $this->userManager->get($userId);
+    }
+
+    /**
+     * @param VObject\Component\VCalendar $vcalendar
+     * @return VObject\Component\VEvent[]
+     */
+    private function getAllVEventsFromVCalendar(VObject\Component\VCalendar $vcalendar):array {
+        $vevents = [];
+
+        foreach($vcalendar->children() as $child) {
+            if (!($child instanceof VObject\Component)) {
+                continue;
+            }
+
+            if ($child->name !== 'VEVENT') {
+                continue;
+            }
+
+            $vevents[] = $child;
+        }
+
+        return $vevents;
+    }
+
+    /**
+     * @param array $vevents
+     * @return VObject\Component\VEvent[]
+     */
+    private function getRecurrenceExceptionFromListOfVEvents(array $vevents):array {
+        return array_values(array_filter($vevents, function (VEvent $vevent) {
+            return $vevent->{'RECURRENCE-ID'} !== null;
+        }));
+    }
+
+    /**
+     * @param array $vevents
+     * @return VEvent|null
+     */
+    private function getMasterItemFromListOfVEvents(array $vevents):?VEvent {
+        $elements = array_values(array_filter($vevents, function (VEvent $vevent) {
+            return $vevent->{'RECURRENCE-ID'} === null;
+        }));
+
+        if (count($elements) === 0) {
+            return null;
+        }
+        if (count($elements) > 1) {
+            throw new \TypeError('Multiple master objects');
+        }
+
+        return $elements[0];
+    }
+
+    /**
+     * @param VAlarm $valarm
+     * @return bool
+     */
+    private function isAlarmRelative(VAlarm $valarm):bool {
+        $trigger = $valarm->TRIGGER;
+        return $trigger instanceof VObject\Property\ICalendar\Duration;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return int
+     */
+    private function getEffectiveRecurrenceIdOfVEvent(VEvent $vevent):int {
+        if (isset($vevent->{'RECURRENCE-ID'})) {
+            return $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimestamp();
+        }
+
+        return $vevent->DTSTART->getDateTime()->getTimestamp();
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return bool
+     */
+    private function isRecurring(VEvent $vevent):bool {
+        return isset($vevent->RRULE) || isset($vevent->RDATE);
+    }
 }

apps/dav/lib/CalDAV/Publishing/PublishPlugin.php

Indentation +190 added lines, -190 removed lines

@@ -40,197 +40,197 @@
 use Sabre\HTTP\ResponseInterface;
 
 class PublishPlugin extends ServerPlugin {
-	const NS_CALENDARSERVER = 'http://calendarserver.org/ns/';
-
-	/**
-	 * Reference to SabreDAV server object.
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	protected $server;
-
-	/**
-	 * Config instance to get instance secret.
-	 *
-	 * @var IConfig
-	 */
-	protected $config;
-
-	/**
-	 * URL Generator for absolute URLs.
-	 *
-	 * @var IURLGenerator
-	 */
-	protected $urlGenerator;
-
-	/**
-	 * PublishPlugin constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IURLGenerator $urlGenerator
-	 */
-	public function __construct(IConfig $config, IURLGenerator $urlGenerator) {
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-	}
-
-	/**
-	 * This method should return a list of server-features.
-	 *
-	 * This is for example 'versioning' and is added to the DAV: header
-	 * in an OPTIONS response.
-	 *
-	 * @return string[]
-	 */
-	public function getFeatures() {
-		// May have to be changed to be detected
-		return ['oc-calendar-publishing', 'calendarserver-sharing'];
-	}
-
-	/**
-	 * Returns a plugin name.
-	 *
-	 * Using this name other plugins will be able to access other plugins
-	 * using Sabre\DAV\Server::getPlugin
-	 *
-	 * @return string
-	 */
-	public function getPluginName() {
-		return 'oc-calendar-publishing';
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param Server $server
-	 */
-	public function initialize(Server $server) {
-		$this->server = $server;
-
-		$this->server->on('method:POST', [$this, 'httpPost']);
-		$this->server->on('propFind',    [$this, 'propFind']);
-	}
-
-	public function propFind(PropFind $propFind, INode $node) {
-		if ($node instanceof Calendar) {
-			$propFind->handle('{'.self::NS_CALENDARSERVER.'}publish-url', function () use ($node) {
-				if ($node->getPublishStatus()) {
-					// We return the publish-url only if the calendar is published.
-					$token = $node->getPublishStatus();
-					$publishUrl = $this->urlGenerator->getAbsoluteURL($this->server->getBaseUri().'public-calendars/').$token;
-
-					return new Publisher($publishUrl, true);
-				}
-			});
-
-			$propFind->handle('{'.self::NS_CALENDARSERVER.'}allowed-sharing-modes', function () use ($node) {
-				$canShare = (!$node->isSubscription() && $node->canWrite());
-				$canPublish = (!$node->isSubscription() && $node->canWrite());
-
-				return new AllowedSharingModes($canShare, $canPublish);
-			});
-		}
-	}
-
-	/**
-	 * We intercept this to handle POST requests on calendars.
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 *
-	 * @return void|bool
-	 */
-	public function httpPost(RequestInterface $request, ResponseInterface $response) {
-		$path = $request->getPath();
-
-		// Only handling xml
-		$contentType = $request->getHeader('Content-Type');
-		if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) {
-			return;
-		}
-
-		// Making sure the node exists
-		try {
-			$node = $this->server->tree->getNodeForPath($path);
-		} catch (NotFound $e) {
-			return;
-		}
-
-		$requestBody = $request->getBodyAsString();
-
-		// If this request handler could not deal with this POST request, it
-		// will return 'null' and other plugins get a chance to handle the
-		// request.
-		//
-		// However, we already requested the full body. This is a problem,
-		// because a body can only be read once. This is why we preemptively
-		// re-populated the request body with the existing data.
-		$request->setBody($requestBody);
-
-		$this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
-
-		switch ($documentType) {
-
-			case '{'.self::NS_CALENDARSERVER.'}publish-calendar' :
-
-			// We can only deal with IShareableCalendar objects
-			if (!$node instanceof Calendar) {
-				return;
-			}
-			$this->server->transactionType = 'post-publish-calendar';
-
-			// Getting ACL info
-			$acl = $this->server->getPlugin('acl');
-
-			// If there's no ACL support, we allow everything
-			if ($acl) {
-				$acl->checkPrivileges($path, '{DAV:}write');
-			}
-
-			$node->setPublishStatus(true);
-
-			// iCloud sends back the 202, so we will too.
-			$response->setStatus(202);
-
-			// Adding this because sending a response body may cause issues,
-			// and I wanted some type of indicator the response was handled.
-			$response->setHeader('X-Sabre-Status', 'everything-went-well');
-
-			// Breaking the event chain
-			return false;
-
-			case '{'.self::NS_CALENDARSERVER.'}unpublish-calendar' :
-
-			// We can only deal with IShareableCalendar objects
-			if (!$node instanceof Calendar) {
-				return;
-			}
-			$this->server->transactionType = 'post-unpublish-calendar';
-
-			// Getting ACL info
-			$acl = $this->server->getPlugin('acl');
-
-			// If there's no ACL support, we allow everything
-			if ($acl) {
-				$acl->checkPrivileges($path, '{DAV:}write');
-			}
-
-			$node->setPublishStatus(false);
-
-			$response->setStatus(200);
+    const NS_CALENDARSERVER = 'http://calendarserver.org/ns/';
+
+    /**
+     * Reference to SabreDAV server object.
+     *
+     * @var \Sabre\DAV\Server
+     */
+    protected $server;
+
+    /**
+     * Config instance to get instance secret.
+     *
+     * @var IConfig
+     */
+    protected $config;
+
+    /**
+     * URL Generator for absolute URLs.
+     *
+     * @var IURLGenerator
+     */
+    protected $urlGenerator;
+
+    /**
+     * PublishPlugin constructor.
+     *
+     * @param IConfig $config
+     * @param IURLGenerator $urlGenerator
+     */
+    public function __construct(IConfig $config, IURLGenerator $urlGenerator) {
+        $this->config = $config;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * This method should return a list of server-features.
+     *
+     * This is for example 'versioning' and is added to the DAV: header
+     * in an OPTIONS response.
+     *
+     * @return string[]
+     */
+    public function getFeatures() {
+        // May have to be changed to be detected
+        return ['oc-calendar-publishing', 'calendarserver-sharing'];
+    }
+
+    /**
+     * Returns a plugin name.
+     *
+     * Using this name other plugins will be able to access other plugins
+     * using Sabre\DAV\Server::getPlugin
+     *
+     * @return string
+     */
+    public function getPluginName() {
+        return 'oc-calendar-publishing';
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param Server $server
+     */
+    public function initialize(Server $server) {
+        $this->server = $server;
+
+        $this->server->on('method:POST', [$this, 'httpPost']);
+        $this->server->on('propFind',    [$this, 'propFind']);
+    }
+
+    public function propFind(PropFind $propFind, INode $node) {
+        if ($node instanceof Calendar) {
+            $propFind->handle('{'.self::NS_CALENDARSERVER.'}publish-url', function () use ($node) {
+                if ($node->getPublishStatus()) {
+                    // We return the publish-url only if the calendar is published.
+                    $token = $node->getPublishStatus();
+                    $publishUrl = $this->urlGenerator->getAbsoluteURL($this->server->getBaseUri().'public-calendars/').$token;
+
+                    return new Publisher($publishUrl, true);
+                }
+            });
+
+            $propFind->handle('{'.self::NS_CALENDARSERVER.'}allowed-sharing-modes', function () use ($node) {
+                $canShare = (!$node->isSubscription() && $node->canWrite());
+                $canPublish = (!$node->isSubscription() && $node->canWrite());
+
+                return new AllowedSharingModes($canShare, $canPublish);
+            });
+        }
+    }
+
+    /**
+     * We intercept this to handle POST requests on calendars.
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return void|bool
+     */
+    public function httpPost(RequestInterface $request, ResponseInterface $response) {
+        $path = $request->getPath();
+
+        // Only handling xml
+        $contentType = $request->getHeader('Content-Type');
+        if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) {
+            return;
+        }
+
+        // Making sure the node exists
+        try {
+            $node = $this->server->tree->getNodeForPath($path);
+        } catch (NotFound $e) {
+            return;
+        }
+
+        $requestBody = $request->getBodyAsString();
+
+        // If this request handler could not deal with this POST request, it
+        // will return 'null' and other plugins get a chance to handle the
+        // request.
+        //
+        // However, we already requested the full body. This is a problem,
+        // because a body can only be read once. This is why we preemptively
+        // re-populated the request body with the existing data.
+        $request->setBody($requestBody);
+
+        $this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
+
+        switch ($documentType) {
+
+            case '{'.self::NS_CALENDARSERVER.'}publish-calendar' :
+
+            // We can only deal with IShareableCalendar objects
+            if (!$node instanceof Calendar) {
+                return;
+            }
+            $this->server->transactionType = 'post-publish-calendar';
+
+            // Getting ACL info
+            $acl = $this->server->getPlugin('acl');
+
+            // If there's no ACL support, we allow everything
+            if ($acl) {
+                $acl->checkPrivileges($path, '{DAV:}write');
+            }
+
+            $node->setPublishStatus(true);
+
+            // iCloud sends back the 202, so we will too.
+            $response->setStatus(202);
+
+            // Adding this because sending a response body may cause issues,
+            // and I wanted some type of indicator the response was handled.
+            $response->setHeader('X-Sabre-Status', 'everything-went-well');
+
+            // Breaking the event chain
+            return false;
+
+            case '{'.self::NS_CALENDARSERVER.'}unpublish-calendar' :
+
+            // We can only deal with IShareableCalendar objects
+            if (!$node instanceof Calendar) {
+                return;
+            }
+            $this->server->transactionType = 'post-unpublish-calendar';
+
+            // Getting ACL info
+            $acl = $this->server->getPlugin('acl');
+
+            // If there's no ACL support, we allow everything
+            if ($acl) {
+                $acl->checkPrivileges($path, '{DAV:}write');
+            }
+
+            $node->setPublishStatus(false);
+
+            $response->setStatus(200);
 
-			// Adding this because sending a response body may cause issues,
-			// and I wanted some type of indicator the response was handled.
-			$response->setHeader('X-Sabre-Status', 'everything-went-well');
+            // Adding this because sending a response body may cause issues,
+            // and I wanted some type of indicator the response was handled.
+            $response->setHeader('X-Sabre-Status', 'everything-went-well');
 
-			// Breaking the event chain
-			return false;
+            // Breaking the event chain
+            return false;
 
-		}
-	}
+        }
+    }
 }

apps/dav/lib/Upload/UploadHome.php

Indentation +66 added lines, -66 removed lines

@@ -33,70 +33,70 @@
 
 class UploadHome implements ICollection {
 
-	/** @var array */
-	private $principalInfo;
-	/** @var CleanupService */
-	private $cleanupService;
-
-	public function __construct(array $principalInfo, CleanupService $cleanupService) {
-		$this->principalInfo = $principalInfo;
-		$this->cleanupService = $cleanupService;
-	}
-
-	public function createFile($name, $data = null) {
-		throw new Forbidden('Permission denied to create file (filename ' . $name . ')');
-	}
-
-	public function createDirectory($name) {
-		$this->impl()->createDirectory($name);
-
-		// Add a cleanup job
-		$this->cleanupService->addJob($name);
-	}
-
-	public function getChild($name): UploadFolder {
-		return new UploadFolder($this->impl()->getChild($name), $this->cleanupService);
-	}
-
-	public function getChildren(): array {
-		return array_map(function ($node) {
-			return new UploadFolder($node, $this->cleanupService);
-		}, $this->impl()->getChildren());
-	}
-
-	public function childExists($name): bool {
-		return !is_null($this->getChild($name));
-	}
-
-	public function delete() {
-		$this->impl()->delete();
-	}
-
-	public function getName() {
-		list(,$name) = \Sabre\Uri\split($this->principalInfo['uri']);
-		return $name;
-	}
-
-	public function setName($name) {
-		throw new Forbidden('Permission denied to rename this folder');
-	}
-
-	public function getLastModified() {
-		return $this->impl()->getLastModified();
-	}
-
-	/**
-	 * @return Directory
-	 */
-	private function impl() {
-		$rootView = new View();
-		$user = \OC::$server->getUserSession()->getUser();
-		Filesystem::initMountPoints($user->getUID());
-		if (!$rootView->file_exists('/' . $user->getUID() . '/uploads')) {
-			$rootView->mkdir('/' . $user->getUID() . '/uploads');
-		}
-		$view = new View('/' . $user->getUID() . '/uploads');
-		$rootInfo = $view->getFileInfo('');
-		return new Directory($view, $rootInfo);
-	}
+    /** @var array */
+    private $principalInfo;
+    /** @var CleanupService */
+    private $cleanupService;
+
+    public function __construct(array $principalInfo, CleanupService $cleanupService) {
+        $this->principalInfo = $principalInfo;
+        $this->cleanupService = $cleanupService;
+    }
+
+    public function createFile($name, $data = null) {
+        throw new Forbidden('Permission denied to create file (filename ' . $name . ')');
+    }
+
+    public function createDirectory($name) {
+        $this->impl()->createDirectory($name);
+
+        // Add a cleanup job
+        $this->cleanupService->addJob($name);
+    }
+
+    public function getChild($name): UploadFolder {
+        return new UploadFolder($this->impl()->getChild($name), $this->cleanupService);
+    }
+
+    public function getChildren(): array {
+        return array_map(function ($node) {
+            return new UploadFolder($node, $this->cleanupService);
+        }, $this->impl()->getChildren());
+    }
+
+    public function childExists($name): bool {
+        return !is_null($this->getChild($name));
+    }
+
+    public function delete() {
+        $this->impl()->delete();
+    }
+
+    public function getName() {
+        list(,$name) = \Sabre\Uri\split($this->principalInfo['uri']);
+        return $name;
+    }
+
+    public function setName($name) {
+        throw new Forbidden('Permission denied to rename this folder');
+    }
+
+    public function getLastModified() {
+        return $this->impl()->getLastModified();
+    }
+
+    /**
+     * @return Directory
+     */
+    private function impl() {
+        $rootView = new View();
+        $user = \OC::$server->getUserSession()->getUser();
+        Filesystem::initMountPoints($user->getUID());
+        if (!$rootView->file_exists('/' . $user->getUID() . '/uploads')) {
+            $rootView->mkdir('/' . $user->getUID() . '/uploads');
+        }
+        $view = new View('/' . $user->getUID() . '/uploads');
+        $rootInfo = $view->getFileInfo('');
+        return new Directory($view, $rootInfo);
+    }
 }

apps/dav/lib/Upload/FutureFile.php

Indentation +72 added lines, -72 removed lines

@@ -38,87 +38,87 @@
  */
 class FutureFile implements \Sabre\DAV\IFile {
 
-	/** @var Directory */
-	private $root;
-	/** @var string */
-	private $name;
+    /** @var Directory */
+    private $root;
+    /** @var string */
+    private $name;
 
-	/**
-	 * @param Directory $root
-	 * @param string $name
-	 */
-	function __construct(Directory $root, $name) {
-		$this->root = $root;
-		$this->name = $name;
-	}
+    /**
+     * @param Directory $root
+     * @param string $name
+     */
+    function __construct(Directory $root, $name) {
+        $this->root = $root;
+        $this->name = $name;
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function put($data) {
-		throw new Forbidden('Permission denied to put into this file');
-	}
+    /**
+     * @inheritdoc
+     */
+    function put($data) {
+        throw new Forbidden('Permission denied to put into this file');
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function get() {
-		$nodes = $this->root->getChildren();
-		return AssemblyStream::wrap($nodes);
-	}
+    /**
+     * @inheritdoc
+     */
+    function get() {
+        $nodes = $this->root->getChildren();
+        return AssemblyStream::wrap($nodes);
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getContentType() {
-		return 'application/octet-stream';
-	}
+    /**
+     * @inheritdoc
+     */
+    function getContentType() {
+        return 'application/octet-stream';
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getETag() {
-		return $this->root->getETag();
-	}
+    /**
+     * @inheritdoc
+     */
+    function getETag() {
+        return $this->root->getETag();
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getSize() {
-		$children = $this->root->getChildren();
-		$sizes = array_map(function ($node) {
-			/** @var IFile $node */
-			return $node->getSize();
-		}, $children);
+    /**
+     * @inheritdoc
+     */
+    function getSize() {
+        $children = $this->root->getChildren();
+        $sizes = array_map(function ($node) {
+            /** @var IFile $node */
+            return $node->getSize();
+        }, $children);
 
-		return array_sum($sizes);
-	}
+        return array_sum($sizes);
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function delete() {
-		$this->root->delete();
-	}
+    /**
+     * @inheritdoc
+     */
+    function delete() {
+        $this->root->delete();
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getName() {
-		return $this->name;
-	}
+    /**
+     * @inheritdoc
+     */
+    function getName() {
+        return $this->name;
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function setName($name) {
-		throw new Forbidden('Permission denied to rename this file');
-	}
+    /**
+     * @inheritdoc
+     */
+    function setName($name) {
+        throw new Forbidden('Permission denied to rename this file');
+    }
 
-	/**
-	 * @inheritdoc
-	 */
-	function getLastModified() {
-		return $this->root->getLastModified();
-	}
+    /**
+     * @inheritdoc
+     */
+    function getLastModified() {
+        return $this->root->getLastModified();
+    }
 }

apps/dav/lib/Connector/Sabre/FakeLockerPlugin.php

Indentation +99 added lines, -99 removed lines

@@ -47,114 +47,114 @@
  * @package OCA\DAV\Connector\Sabre
  */
 class FakeLockerPlugin extends ServerPlugin {
-	/** @var \Sabre\DAV\Server */
-	private $server;
+    /** @var \Sabre\DAV\Server */
+    private $server;
 
-	/** {@inheritDoc} */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$this->server = $server;
-		$this->server->on('method:LOCK', [$this, 'fakeLockProvider'], 1);
-		$this->server->on('method:UNLOCK', [$this, 'fakeUnlockProvider'], 1);
-		$server->on('propFind', [$this, 'propFind']);
-		$server->on('validateTokens', [$this, 'validateTokens']);
-	}
+    /** {@inheritDoc} */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $this->server = $server;
+        $this->server->on('method:LOCK', [$this, 'fakeLockProvider'], 1);
+        $this->server->on('method:UNLOCK', [$this, 'fakeUnlockProvider'], 1);
+        $server->on('propFind', [$this, 'propFind']);
+        $server->on('validateTokens', [$this, 'validateTokens']);
+    }
 
-	/**
-	 * Indicate that we support LOCK and UNLOCK
-	 *
-	 * @param string $path
-	 * @return string[]
-	 */
-	public function getHTTPMethods($path) {
-		return [
-			'LOCK',
-			'UNLOCK',
-		];
-	}
+    /**
+     * Indicate that we support LOCK and UNLOCK
+     *
+     * @param string $path
+     * @return string[]
+     */
+    public function getHTTPMethods($path) {
+        return [
+            'LOCK',
+            'UNLOCK',
+        ];
+    }
 
-	/**
-	 * Indicate that we support locking
-	 *
-	 * @return integer[]
-	 */
-	function getFeatures() {
-		return [2];
-	}
+    /**
+     * Indicate that we support locking
+     *
+     * @return integer[]
+     */
+    function getFeatures() {
+        return [2];
+    }
 
-	/**
-	 * Return some dummy response for PROPFIND requests with regard to locking
-	 *
-	 * @param PropFind $propFind
-	 * @param INode $node
-	 * @return void
-	 */
-	function propFind(PropFind $propFind, INode $node) {
-		$propFind->handle('{DAV:}supportedlock', function () {
-			return new SupportedLock(true);
-		});
-		$propFind->handle('{DAV:}lockdiscovery', function () use ($propFind) {
-			return new LockDiscovery([]);
-		});
-	}
+    /**
+     * Return some dummy response for PROPFIND requests with regard to locking
+     *
+     * @param PropFind $propFind
+     * @param INode $node
+     * @return void
+     */
+    function propFind(PropFind $propFind, INode $node) {
+        $propFind->handle('{DAV:}supportedlock', function () {
+            return new SupportedLock(true);
+        });
+        $propFind->handle('{DAV:}lockdiscovery', function () use ($propFind) {
+            return new LockDiscovery([]);
+        });
+    }
 
-	/**
-	 * Mark a locking token always as valid
-	 *
-	 * @param RequestInterface $request
-	 * @param array $conditions
-	 */
-	public function validateTokens(RequestInterface $request, &$conditions) {
-		foreach($conditions as &$fileCondition) {
-			if(isset($fileCondition['tokens'])) {
-				foreach($fileCondition['tokens'] as &$token) {
-					if(isset($token['token'])) {
-						if(substr($token['token'], 0, 16) === 'opaquelocktoken:') {
-							$token['validToken'] = true;
-						}
-					}
-				}
-			}
-		}
-	}
+    /**
+     * Mark a locking token always as valid
+     *
+     * @param RequestInterface $request
+     * @param array $conditions
+     */
+    public function validateTokens(RequestInterface $request, &$conditions) {
+        foreach($conditions as &$fileCondition) {
+            if(isset($fileCondition['tokens'])) {
+                foreach($fileCondition['tokens'] as &$token) {
+                    if(isset($token['token'])) {
+                        if(substr($token['token'], 0, 16) === 'opaquelocktoken:') {
+                            $token['validToken'] = true;
+                        }
+                    }
+                }
+            }
+        }
+    }
 
-	/**
-	 * Fakes a successful LOCK
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 * @return bool
-	 */
-	public function fakeLockProvider(RequestInterface $request,
-									 ResponseInterface $response) {
+    /**
+     * Fakes a successful LOCK
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return bool
+     */
+    public function fakeLockProvider(RequestInterface $request,
+                                        ResponseInterface $response) {
 
-		$lockInfo = new LockInfo();
-		$lockInfo->token = md5($request->getPath());
-		$lockInfo->uri = $request->getPath();
-		$lockInfo->depth = \Sabre\DAV\Server::DEPTH_INFINITY;
-		$lockInfo->timeout = 1800;
+        $lockInfo = new LockInfo();
+        $lockInfo->token = md5($request->getPath());
+        $lockInfo->uri = $request->getPath();
+        $lockInfo->depth = \Sabre\DAV\Server::DEPTH_INFINITY;
+        $lockInfo->timeout = 1800;
 
-		$body = $this->server->xml->write('{DAV:}prop', [
-			'{DAV:}lockdiscovery' =>
-					new LockDiscovery([$lockInfo])
-		]);
+        $body = $this->server->xml->write('{DAV:}prop', [
+            '{DAV:}lockdiscovery' =>
+                    new LockDiscovery([$lockInfo])
+        ]);
 
-		$response->setStatus(200);
-		$response->setBody($body);
+        $response->setStatus(200);
+        $response->setBody($body);
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Fakes a successful LOCK
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 * @return bool
-	 */
-	public function fakeUnlockProvider(RequestInterface $request,
-									 ResponseInterface $response) {
-		$response->setStatus(204);
-		$response->setHeader('Content-Length', '0');
-		return false;
-	}
+    /**
+     * Fakes a successful LOCK
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return bool
+     */
+    public function fakeUnlockProvider(RequestInterface $request,
+                                        ResponseInterface $response) {
+        $response->setStatus(204);
+        $response->setHeader('Content-Length', '0');
+        return false;
+    }
 }

apps/dav/lib/Connector/Sabre/SharesPlugin.php

Indentation +177 added lines, -177 removed lines

@@ -36,181 +36,181 @@
  */
 class SharesPlugin extends \Sabre\DAV\ServerPlugin {
 
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
-	const SHARETYPES_PROPERTYNAME = '{http://owncloud.org/ns}share-types';
-	const SHAREES_PROPERTYNAME = '{http://nextcloud.org/ns}sharees';
-
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
-
-	/**
-	 * @var \OCP\Share\IManager
-	 */
-	private $shareManager;
-
-	/**
-	 * @var \Sabre\DAV\Tree
-	 */
-	private $tree;
-
-	/**
-	 * @var string
-	 */
-	private $userId;
-
-	/**
-	 * @var \OCP\Files\Folder
-	 */
-	private $userFolder;
-
-	/** @var IShare[] */
-	private $cachedShares = [];
-
-	private $cachedFolders = [];
-
-	/**
-	 * @param \Sabre\DAV\Tree $tree tree
-	 * @param IUserSession $userSession user session
-	 * @param \OCP\Files\Folder $userFolder user home folder
-	 * @param \OCP\Share\IManager $shareManager share manager
-	 */
-	public function __construct(
-		\Sabre\DAV\Tree $tree,
-		IUserSession $userSession,
-		\OCP\Files\Folder $userFolder,
-		\OCP\Share\IManager $shareManager
-	) {
-		$this->tree = $tree;
-		$this->shareManager = $shareManager;
-		$this->userFolder = $userFolder;
-		$this->userId = $userSession->getUser()->getUID();
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$server->xml->namespacesMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->elementMap[self::SHARETYPES_PROPERTYNAME] = ShareTypeList::class;
-		$server->protectedProperties[] = self::SHARETYPES_PROPERTYNAME;
-		$server->protectedProperties[] = self::SHAREES_PROPERTYNAME;
-
-		$this->server = $server;
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-	}
-
-	private function getShare(\OCP\Files\Node $node): array {
-		$result = [];
-		$requestedShareTypes = [
-			\OCP\Share::SHARE_TYPE_USER,
-			\OCP\Share::SHARE_TYPE_GROUP,
-			\OCP\Share::SHARE_TYPE_LINK,
-			\OCP\Share::SHARE_TYPE_REMOTE,
-			\OCP\Share::SHARE_TYPE_EMAIL,
-			\OCP\Share::SHARE_TYPE_ROOM,
-			\OCP\Share::SHARE_TYPE_CIRCLE,
-		];
-		foreach ($requestedShareTypes as $requestedShareType) {
-			$shares = $this->shareManager->getSharesBy(
-				$this->userId,
-				$requestedShareType,
-				$node,
-				false,
-				-1
-			);
-			foreach ($shares as $share) {
-				$result[] = $share;
-			}
-		}
-		return $result;
-	}
-
-	private function getSharesFolder(\OCP\Files\Folder $node): array {
-		return $this->shareManager->getSharesInFolder(
-			$this->userId,
-			$node,
-			true
-		);
-	}
-
-	private function getShares(\Sabre\DAV\INode $sabreNode): array {
-		if (isset($this->cachedShares[$sabreNode->getId()])) {
-			$shares = $this->cachedShares[$sabreNode->getId()];
-		} else {
-			list($parentPath,) = \Sabre\Uri\split($sabreNode->getPath());
-			if ($parentPath === '') {
-				$parentPath = '/';
-			}
-			// if we already cached the folder this file is in we know there are no shares for this file
-			if (array_search($parentPath, $this->cachedFolders) === false) {
-				$node = $this->userFolder->get($sabreNode->getPath());
-				$shares = $this->getShare($node);
-				$this->cachedShares[$sabreNode->getId()] = $shares;
-			} else {
-				return [];
-			}
-		}
-
-		return $shares;
-	}
-
-	/**
-	 * Adds shares to propfind response
-	 *
-	 * @param PropFind $propFind propfind object
-	 * @param \Sabre\DAV\INode $sabreNode sabre node
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $sabreNode
-	) {
-		if (!($sabreNode instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
-
-		// need prefetch ?
-		if ($sabreNode instanceof \OCA\DAV\Connector\Sabre\Directory
-			&& $propFind->getDepth() !== 0
-			&& (
-				!is_null($propFind->getStatus(self::SHARETYPES_PROPERTYNAME)) ||
-				!is_null($propFind->getStatus(self::SHAREES_PROPERTYNAME))
-			)
-		) {
-			$folderNode = $this->userFolder->get($sabreNode->getPath());
-
-			$this->cachedFolders[] = $sabreNode->getPath();
-			$childShares = $this->getSharesFolder($folderNode);
-			foreach ($childShares as $id => $shares) {
-				$this->cachedShares[$id] = $shares;
-			}
-		}
-
-		$propFind->handle(self::SHARETYPES_PROPERTYNAME, function () use ($sabreNode) {
-			$shares = $this->getShares($sabreNode);
-
-			$shareTypes = array_unique(array_map(function (IShare $share) {
-				return $share->getShareType();
-			}, $shares));
-
-			return new ShareTypeList($shareTypes);
-		});
-
-		$propFind->handle(self::SHAREES_PROPERTYNAME, function () use ($sabreNode) {
-			$shares = $this->getShares($sabreNode);
-
-			return new ShareeList($shares);
-		});
-	}
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
+    const SHARETYPES_PROPERTYNAME = '{http://owncloud.org/ns}share-types';
+    const SHAREES_PROPERTYNAME = '{http://nextcloud.org/ns}sharees';
+
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
+
+    /**
+     * @var \OCP\Share\IManager
+     */
+    private $shareManager;
+
+    /**
+     * @var \Sabre\DAV\Tree
+     */
+    private $tree;
+
+    /**
+     * @var string
+     */
+    private $userId;
+
+    /**
+     * @var \OCP\Files\Folder
+     */
+    private $userFolder;
+
+    /** @var IShare[] */
+    private $cachedShares = [];
+
+    private $cachedFolders = [];
+
+    /**
+     * @param \Sabre\DAV\Tree $tree tree
+     * @param IUserSession $userSession user session
+     * @param \OCP\Files\Folder $userFolder user home folder
+     * @param \OCP\Share\IManager $shareManager share manager
+     */
+    public function __construct(
+        \Sabre\DAV\Tree $tree,
+        IUserSession $userSession,
+        \OCP\Files\Folder $userFolder,
+        \OCP\Share\IManager $shareManager
+    ) {
+        $this->tree = $tree;
+        $this->shareManager = $shareManager;
+        $this->userFolder = $userFolder;
+        $this->userId = $userSession->getUser()->getUID();
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $server->xml->namespacesMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->elementMap[self::SHARETYPES_PROPERTYNAME] = ShareTypeList::class;
+        $server->protectedProperties[] = self::SHARETYPES_PROPERTYNAME;
+        $server->protectedProperties[] = self::SHAREES_PROPERTYNAME;
+
+        $this->server = $server;
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+    }
+
+    private function getShare(\OCP\Files\Node $node): array {
+        $result = [];
+        $requestedShareTypes = [
+            \OCP\Share::SHARE_TYPE_USER,
+            \OCP\Share::SHARE_TYPE_GROUP,
+            \OCP\Share::SHARE_TYPE_LINK,
+            \OCP\Share::SHARE_TYPE_REMOTE,
+            \OCP\Share::SHARE_TYPE_EMAIL,
+            \OCP\Share::SHARE_TYPE_ROOM,
+            \OCP\Share::SHARE_TYPE_CIRCLE,
+        ];
+        foreach ($requestedShareTypes as $requestedShareType) {
+            $shares = $this->shareManager->getSharesBy(
+                $this->userId,
+                $requestedShareType,
+                $node,
+                false,
+                -1
+            );
+            foreach ($shares as $share) {
+                $result[] = $share;
+            }
+        }
+        return $result;
+    }
+
+    private function getSharesFolder(\OCP\Files\Folder $node): array {
+        return $this->shareManager->getSharesInFolder(
+            $this->userId,
+            $node,
+            true
+        );
+    }
+
+    private function getShares(\Sabre\DAV\INode $sabreNode): array {
+        if (isset($this->cachedShares[$sabreNode->getId()])) {
+            $shares = $this->cachedShares[$sabreNode->getId()];
+        } else {
+            list($parentPath,) = \Sabre\Uri\split($sabreNode->getPath());
+            if ($parentPath === '') {
+                $parentPath = '/';
+            }
+            // if we already cached the folder this file is in we know there are no shares for this file
+            if (array_search($parentPath, $this->cachedFolders) === false) {
+                $node = $this->userFolder->get($sabreNode->getPath());
+                $shares = $this->getShare($node);
+                $this->cachedShares[$sabreNode->getId()] = $shares;
+            } else {
+                return [];
+            }
+        }
+
+        return $shares;
+    }
+
+    /**
+     * Adds shares to propfind response
+     *
+     * @param PropFind $propFind propfind object
+     * @param \Sabre\DAV\INode $sabreNode sabre node
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $sabreNode
+    ) {
+        if (!($sabreNode instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
+
+        // need prefetch ?
+        if ($sabreNode instanceof \OCA\DAV\Connector\Sabre\Directory
+            && $propFind->getDepth() !== 0
+            && (
+                !is_null($propFind->getStatus(self::SHARETYPES_PROPERTYNAME)) ||
+                !is_null($propFind->getStatus(self::SHAREES_PROPERTYNAME))
+            )
+        ) {
+            $folderNode = $this->userFolder->get($sabreNode->getPath());
+
+            $this->cachedFolders[] = $sabreNode->getPath();
+            $childShares = $this->getSharesFolder($folderNode);
+            foreach ($childShares as $id => $shares) {
+                $this->cachedShares[$id] = $shares;
+            }
+        }
+
+        $propFind->handle(self::SHARETYPES_PROPERTYNAME, function () use ($sabreNode) {
+            $shares = $this->getShares($sabreNode);
+
+            $shareTypes = array_unique(array_map(function (IShare $share) {
+                return $share->getShareType();
+            }, $shares));
+
+            return new ShareTypeList($shareTypes);
+        });
+
+        $propFind->handle(self::SHAREES_PROPERTYNAME, function () use ($sabreNode) {
+            $shares = $this->getShares($sabreNode);
+
+            return new ShareeList($shares);
+        });
+    }
 }

apps/dav/lib/Connector/Sabre/TagsPlugin.php

Indentation +217 added lines, -217 removed lines

@@ -55,246 +55,246 @@
 class TagsPlugin extends \Sabre\DAV\ServerPlugin
 {
 
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
-	const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const TAGS_PROPERTYNAME = '{http://owncloud.org/ns}tags';
+    const FAVORITE_PROPERTYNAME = '{http://owncloud.org/ns}favorite';
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
 
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
 
-	/**
-	 * @var \OCP\ITagManager
-	 */
-	private $tagManager;
+    /**
+     * @var \OCP\ITagManager
+     */
+    private $tagManager;
 
-	/**
-	 * @var \OCP\ITags
-	 */
-	private $tagger;
+    /**
+     * @var \OCP\ITags
+     */
+    private $tagger;
 
-	/**
-	 * Array of file id to tags array
-	 * The null value means the cache wasn't initialized.
-	 *
-	 * @var array
-	 */
-	private $cachedTags;
+    /**
+     * Array of file id to tags array
+     * The null value means the cache wasn't initialized.
+     *
+     * @var array
+     */
+    private $cachedTags;
 
-	/**
-	 * @var \Sabre\DAV\Tree
-	 */
-	private $tree;
+    /**
+     * @var \Sabre\DAV\Tree
+     */
+    private $tree;
 
-	/**
-	 * @param \Sabre\DAV\Tree $tree tree
-	 * @param \OCP\ITagManager $tagManager tag manager
-	 */
-	public function __construct(\Sabre\DAV\Tree $tree, \OCP\ITagManager $tagManager) {
-		$this->tree = $tree;
-		$this->tagManager = $tagManager;
-		$this->tagger = null;
-		$this->cachedTags = [];
-	}
+    /**
+     * @param \Sabre\DAV\Tree $tree tree
+     * @param \OCP\ITagManager $tagManager tag manager
+     */
+    public function __construct(\Sabre\DAV\Tree $tree, \OCP\ITagManager $tagManager) {
+        $this->tree = $tree;
+        $this->tagManager = $tagManager;
+        $this->tagger = null;
+        $this->cachedTags = [];
+    }
 
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
 
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->elementMap[self::TAGS_PROPERTYNAME] = TagList::class;
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->elementMap[self::TAGS_PROPERTYNAME] = TagList::class;
 
-		$this->server = $server;
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-		$this->server->on('propPatch', [$this, 'handleUpdateProperties']);
-	}
+        $this->server = $server;
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+        $this->server->on('propPatch', [$this, 'handleUpdateProperties']);
+    }
 
-	/**
-	 * Returns the tagger
-	 *
-	 * @return \OCP\ITags tagger
-	 */
-	private function getTagger() {
-		if (!$this->tagger) {
-			$this->tagger = $this->tagManager->load('files');
-		}
-		return $this->tagger;
-	}
+    /**
+     * Returns the tagger
+     *
+     * @return \OCP\ITags tagger
+     */
+    private function getTagger() {
+        if (!$this->tagger) {
+            $this->tagger = $this->tagManager->load('files');
+        }
+        return $this->tagger;
+    }
 
-	/**
-	 * Returns tags and favorites.
-	 *
-	 * @param integer $fileId file id
-	 * @return array list($tags, $favorite) with $tags as tag array
-	 * and $favorite is a boolean whether the file was favorited
-	 */
-	private function getTagsAndFav($fileId) {
-		$isFav = false;
-		$tags = $this->getTags($fileId);
-		if ($tags) {
-			$favPos = array_search(self::TAG_FAVORITE, $tags);
-			if ($favPos !== false) {
-				$isFav = true;
-				unset($tags[$favPos]);
-			}
-		}
-		return [$tags, $isFav];
-	}
+    /**
+     * Returns tags and favorites.
+     *
+     * @param integer $fileId file id
+     * @return array list($tags, $favorite) with $tags as tag array
+     * and $favorite is a boolean whether the file was favorited
+     */
+    private function getTagsAndFav($fileId) {
+        $isFav = false;
+        $tags = $this->getTags($fileId);
+        if ($tags) {
+            $favPos = array_search(self::TAG_FAVORITE, $tags);
+            if ($favPos !== false) {
+                $isFav = true;
+                unset($tags[$favPos]);
+            }
+        }
+        return [$tags, $isFav];
+    }
 
-	/**
-	 * Returns tags for the given file id
-	 *
-	 * @param integer $fileId file id
-	 * @return array list of tags for that file
-	 */
-	private function getTags($fileId) {
-		if (isset($this->cachedTags[$fileId])) {
-			return $this->cachedTags[$fileId];
-		} else {
-			$tags = $this->getTagger()->getTagsForObjects([$fileId]);
-			if ($tags !== false) {
-				if (empty($tags)) {
-					return [];
-				}
-				return current($tags);
-			}
-		}
-		return null;
-	}
+    /**
+     * Returns tags for the given file id
+     *
+     * @param integer $fileId file id
+     * @return array list of tags for that file
+     */
+    private function getTags($fileId) {
+        if (isset($this->cachedTags[$fileId])) {
+            return $this->cachedTags[$fileId];
+        } else {
+            $tags = $this->getTagger()->getTagsForObjects([$fileId]);
+            if ($tags !== false) {
+                if (empty($tags)) {
+                    return [];
+                }
+                return current($tags);
+            }
+        }
+        return null;
+    }
 
-	/**
-	 * Updates the tags of the given file id
-	 *
-	 * @param int $fileId
-	 * @param array $tags array of tag strings
-	 */
-	private function updateTags($fileId, $tags) {
-		$tagger = $this->getTagger();
-		$currentTags = $this->getTags($fileId);
+    /**
+     * Updates the tags of the given file id
+     *
+     * @param int $fileId
+     * @param array $tags array of tag strings
+     */
+    private function updateTags($fileId, $tags) {
+        $tagger = $this->getTagger();
+        $currentTags = $this->getTags($fileId);
 
-		$newTags = array_diff($tags, $currentTags);
-		foreach ($newTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->tagAs($fileId, $tag);
-		}
-		$deletedTags = array_diff($currentTags, $tags);
-		foreach ($deletedTags as $tag) {
-			if ($tag === self::TAG_FAVORITE) {
-				continue;
-			}
-			$tagger->unTag($fileId, $tag);
-		}
-	}
+        $newTags = array_diff($tags, $currentTags);
+        foreach ($newTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->tagAs($fileId, $tag);
+        }
+        $deletedTags = array_diff($currentTags, $tags);
+        foreach ($deletedTags as $tag) {
+            if ($tag === self::TAG_FAVORITE) {
+                continue;
+            }
+            $tagger->unTag($fileId, $tag);
+        }
+    }
 
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node
-	) {
-		if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node
+    ) {
+        if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
 
-		// need prefetch ?
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
-			&& $propFind->getDepth() !== 0
-			&& (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
-			|| !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
-		)) {
-			// note: pre-fetching only supported for depth <= 1
-			$folderContent = $node->getChildren();
-			$fileIds[] = (int)$node->getId();
-			foreach ($folderContent as $info) {
-				$fileIds[] = (int)$info->getId();
-			}
-			$tags = $this->getTagger()->getTagsForObjects($fileIds);
-			if ($tags === false) {
-				// the tags API returns false on error...
-				$tags = [];
-			}
+        // need prefetch ?
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
+            && $propFind->getDepth() !== 0
+            && (!is_null($propFind->getStatus(self::TAGS_PROPERTYNAME))
+            || !is_null($propFind->getStatus(self::FAVORITE_PROPERTYNAME))
+        )) {
+            // note: pre-fetching only supported for depth <= 1
+            $folderContent = $node->getChildren();
+            $fileIds[] = (int)$node->getId();
+            foreach ($folderContent as $info) {
+                $fileIds[] = (int)$info->getId();
+            }
+            $tags = $this->getTagger()->getTagsForObjects($fileIds);
+            if ($tags === false) {
+                // the tags API returns false on error...
+                $tags = [];
+            }
 
-			$this->cachedTags = $this->cachedTags + $tags;
-			$emptyFileIds = array_diff($fileIds, array_keys($tags));
-			// also cache the ones that were not found
-			foreach ($emptyFileIds as $fileId) {
-				$this->cachedTags[$fileId] = [];
-			}
-		}
+            $this->cachedTags = $this->cachedTags + $tags;
+            $emptyFileIds = array_diff($fileIds, array_keys($tags));
+            // also cache the ones that were not found
+            foreach ($emptyFileIds as $fileId) {
+                $this->cachedTags[$fileId] = [];
+            }
+        }
 
-		$isFav = null;
+        $isFav = null;
 
-		$propFind->handle(self::TAGS_PROPERTYNAME, function () use (&$isFav, $node) {
-			list($tags, $isFav) = $this->getTagsAndFav($node->getId());
-			return new TagList($tags);
-		});
+        $propFind->handle(self::TAGS_PROPERTYNAME, function () use (&$isFav, $node) {
+            list($tags, $isFav) = $this->getTagsAndFav($node->getId());
+            return new TagList($tags);
+        });
 
-		$propFind->handle(self::FAVORITE_PROPERTYNAME, function () use ($isFav, $node) {
-			if (is_null($isFav)) {
-				list(, $isFav) = $this->getTagsAndFav($node->getId());
-			}
-			if ($isFav) {
-				return 1;
-			} else {
-				return 0;
-			}
-		});
-	}
+        $propFind->handle(self::FAVORITE_PROPERTYNAME, function () use ($isFav, $node) {
+            if (is_null($isFav)) {
+                list(, $isFav) = $this->getTagsAndFav($node->getId());
+            }
+            if ($isFav) {
+                return 1;
+            } else {
+                return 0;
+            }
+        });
+    }
 
-	/**
-	 * Updates tags and favorites properties, if applicable.
-	 *
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 *
-	 * @return void
-	 */
-	public function handleUpdateProperties($path, PropPatch $propPatch) {
-		$node = $this->tree->getNodeForPath($path);
-		if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
+    /**
+     * Updates tags and favorites properties, if applicable.
+     *
+     * @param string $path
+     * @param PropPatch $propPatch
+     *
+     * @return void
+     */
+    public function handleUpdateProperties($path, PropPatch $propPatch) {
+        $node = $this->tree->getNodeForPath($path);
+        if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
 
-		$propPatch->handle(self::TAGS_PROPERTYNAME, function ($tagList) use ($node) {
-			$this->updateTags($node->getId(), $tagList->getTags());
-			return true;
-		});
+        $propPatch->handle(self::TAGS_PROPERTYNAME, function ($tagList) use ($node) {
+            $this->updateTags($node->getId(), $tagList->getTags());
+            return true;
+        });
 
-		$propPatch->handle(self::FAVORITE_PROPERTYNAME, function ($favState) use ($node) {
-			if ((int)$favState === 1 || $favState === 'true') {
-				$this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE);
-			} else {
-				$this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE);
-			}
+        $propPatch->handle(self::FAVORITE_PROPERTYNAME, function ($favState) use ($node) {
+            if ((int)$favState === 1 || $favState === 'true') {
+                $this->getTagger()->tagAs($node->getId(), self::TAG_FAVORITE);
+            } else {
+                $this->getTagger()->unTag($node->getId(), self::TAG_FAVORITE);
+            }
 
-			if (is_null($favState)) {
-				// confirm deletion
-				return 204;
-			}
+            if (is_null($favState)) {
+                // confirm deletion
+                return 204;
+            }
 
-			return 200;
-		});
-	}
+            return 200;
+        });
+    }
 }

apps/dav/lib/Connector/Sabre/FilesPlugin.php

Indentation +466 added lines, -466 removed lines

@@ -53,470 +53,470 @@
 
 class FilesPlugin extends ServerPlugin {
 
-	// namespace
-	const NS_OWNCLOUD = 'http://owncloud.org/ns';
-	const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
-	const FILEID_PROPERTYNAME = '{http://owncloud.org/ns}id';
-	const INTERNAL_FILEID_PROPERTYNAME = '{http://owncloud.org/ns}fileid';
-	const PERMISSIONS_PROPERTYNAME = '{http://owncloud.org/ns}permissions';
-	const SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-collaboration-services.org/ns}share-permissions';
-	const OCM_SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-cloud-mesh.org/ns}share-permissions';
-	const DOWNLOADURL_PROPERTYNAME = '{http://owncloud.org/ns}downloadURL';
-	const SIZE_PROPERTYNAME = '{http://owncloud.org/ns}size';
-	const GETETAG_PROPERTYNAME = '{DAV:}getetag';
-	const LASTMODIFIED_PROPERTYNAME = '{DAV:}lastmodified';
-	const OWNER_ID_PROPERTYNAME = '{http://owncloud.org/ns}owner-id';
-	const OWNER_DISPLAY_NAME_PROPERTYNAME = '{http://owncloud.org/ns}owner-display-name';
-	const CHECKSUMS_PROPERTYNAME = '{http://owncloud.org/ns}checksums';
-	const DATA_FINGERPRINT_PROPERTYNAME = '{http://owncloud.org/ns}data-fingerprint';
-	const HAS_PREVIEW_PROPERTYNAME = '{http://nextcloud.org/ns}has-preview';
-	const MOUNT_TYPE_PROPERTYNAME = '{http://nextcloud.org/ns}mount-type';
-	const IS_ENCRYPTED_PROPERTYNAME = '{http://nextcloud.org/ns}is-encrypted';
-	const METADATA_ETAG_PROPERTYNAME = '{http://nextcloud.org/ns}metadata_etag';
-	const UPLOAD_TIME_PROPERTYNAME = '{http://nextcloud.org/ns}upload_time';
-	const CREATION_TIME_PROPERTYNAME = '{http://nextcloud.org/ns}creation_time';
-	const SHARE_NOTE = '{http://nextcloud.org/ns}note';
-
-	/**
-	 * Reference to main server object
-	 *
-	 * @var \Sabre\DAV\Server
-	 */
-	private $server;
-
-	/**
-	 * @var Tree
-	 */
-	private $tree;
-
-	/**
-	 * Whether this is public webdav.
-	 * If true, some returned information will be stripped off.
-	 *
-	 * @var bool
-	 */
-	private $isPublic;
-
-	/**
-	 * @var bool
-	 */
-	private $downloadAttachment;
-
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-
-	/**
-	 * @var IRequest
-	 */
-	private $request;
-
-	/**
-	 * @var IPreview
-	 */
-	private $previewManager;
-
-	/**
-	 * @param Tree $tree
-	 * @param IConfig $config
-	 * @param IRequest $request
-	 * @param IPreview $previewManager
-	 * @param bool $isPublic
-	 * @param bool $downloadAttachment
-	 */
-	public function __construct(Tree $tree,
-								IConfig $config,
-								IRequest $request,
-								IPreview $previewManager,
-								$isPublic = false,
-								$downloadAttachment = true) {
-		$this->tree = $tree;
-		$this->config = $config;
-		$this->request = $request;
-		$this->isPublic = $isPublic;
-		$this->downloadAttachment = $downloadAttachment;
-		$this->previewManager = $previewManager;
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by \Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
-		$server->xml->namespaceMap[self::NS_NEXTCLOUD] = 'nc';
-		$server->protectedProperties[] = self::FILEID_PROPERTYNAME;
-		$server->protectedProperties[] = self::INTERNAL_FILEID_PROPERTYNAME;
-		$server->protectedProperties[] = self::PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::SHARE_PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::OCM_SHARE_PERMISSIONS_PROPERTYNAME;
-		$server->protectedProperties[] = self::SIZE_PROPERTYNAME;
-		$server->protectedProperties[] = self::DOWNLOADURL_PROPERTYNAME;
-		$server->protectedProperties[] = self::OWNER_ID_PROPERTYNAME;
-		$server->protectedProperties[] = self::OWNER_DISPLAY_NAME_PROPERTYNAME;
-		$server->protectedProperties[] = self::CHECKSUMS_PROPERTYNAME;
-		$server->protectedProperties[] = self::DATA_FINGERPRINT_PROPERTYNAME;
-		$server->protectedProperties[] = self::HAS_PREVIEW_PROPERTYNAME;
-		$server->protectedProperties[] = self::MOUNT_TYPE_PROPERTYNAME;
-		$server->protectedProperties[] = self::IS_ENCRYPTED_PROPERTYNAME;
-		$server->protectedProperties[] = self::SHARE_NOTE;
-
-		// normally these cannot be changed (RFC4918), but we want them modifiable through PROPPATCH
-		$allowedProperties = ['{DAV:}getetag'];
-		$server->protectedProperties = array_diff($server->protectedProperties, $allowedProperties);
-
-		$this->server = $server;
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-		$this->server->on('propPatch', [$this, 'handleUpdateProperties']);
-		$this->server->on('afterBind', [$this, 'sendFileIdHeader']);
-		$this->server->on('afterWriteContent', [$this, 'sendFileIdHeader']);
-		$this->server->on('afterMethod:GET', [$this,'httpGet']);
-		$this->server->on('afterMethod:GET', [$this, 'handleDownloadToken']);
-		$this->server->on('afterResponse', function ($request, ResponseInterface $response) {
-			$body = $response->getBody();
-			if (is_resource($body)) {
-				fclose($body);
-			}
-		});
-		$this->server->on('beforeMove', [$this, 'checkMove']);
-	}
-
-	/**
-	 * Plugin that checks if a move can actually be performed.
-	 *
-	 * @param string $source source path
-	 * @param string $destination destination path
-	 * @throws Forbidden
-	 * @throws NotFound
-	 */
-	function checkMove($source, $destination) {
-		$sourceNode = $this->tree->getNodeForPath($source);
-		if (!$sourceNode instanceof Node) {
-			return;
-		}
-		list($sourceDir,) = \Sabre\Uri\split($source);
-		list($destinationDir,) = \Sabre\Uri\split($destination);
-
-		if ($sourceDir !== $destinationDir) {
-			$sourceNodeFileInfo = $sourceNode->getFileInfo();
-			if ($sourceNodeFileInfo === null) {
-				throw new NotFound($source . ' does not exist');
-			}
-
-			if (!$sourceNodeFileInfo->isDeletable()) {
-				throw new Forbidden($source . " cannot be deleted");
-			}
-		}
-	}
-
-	/**
-	 * This sets a cookie to be able to recognize the start of the download
-	 * the content must not be longer than 32 characters and must only contain
-	 * alphanumeric characters
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 */
-	function handleDownloadToken(RequestInterface $request, ResponseInterface $response) {
-		$queryParams = $request->getQueryParameters();
-
-		/**
-		 * this sets a cookie to be able to recognize the start of the download
-		 * the content must not be longer than 32 characters and must only contain
-		 * alphanumeric characters
-		 */
-		if (isset($queryParams['downloadStartSecret'])) {
-			$token = $queryParams['downloadStartSecret'];
-			if (!isset($token[32])
-				&& preg_match('!^[a-zA-Z0-9]+$!', $token) === 1) {
-				// FIXME: use $response->setHeader() instead
-				setcookie('ocDownloadStarted', $token, time() + 20, '/');
-			}
-		}
-	}
-
-	/**
-	 * Add headers to file download
-	 *
-	 * @param RequestInterface $request
-	 * @param ResponseInterface $response
-	 */
-	function httpGet(RequestInterface $request, ResponseInterface $response) {
-		// Only handle valid files
-		$node = $this->tree->getNodeForPath($request->getPath());
-		if (!($node instanceof IFile)) return;
-
-		// adds a 'Content-Disposition: attachment' header in case no disposition
-		// header has been set before
-		if ($this->downloadAttachment &&
-			$response->getHeader('Content-Disposition') === null) {
-			$filename = $node->getName();
-			if ($this->request->isUserAgent(
-				[
-					Request::USER_AGENT_IE,
-					Request::USER_AGENT_ANDROID_MOBILE_CHROME,
-					Request::USER_AGENT_FREEBOX,
-				])) {
-				$response->addHeader('Content-Disposition', 'attachment; filename="' . rawurlencode($filename) . '"');
-			} else {
-				$response->addHeader('Content-Disposition', 'attachment; filename*=UTF-8\'\'' . rawurlencode($filename)
-													 . '; filename="' . rawurlencode($filename) . '"');
-			}
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
-			//Add OC-Checksum header
-			/** @var $node File */
-			$checksum = $node->getChecksum();
-			if ($checksum !== null && $checksum !== '') {
-				$response->addHeader('OC-Checksum', $checksum);
-			}
-		}
-	}
-
-	/**
-	 * Adds all ownCloud-specific properties
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node) {
-
-		$httpRequest = $this->server->httpRequest;
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			/**
-			 * This was disabled, because it made dir listing throw an exception,
-			 * so users were unable to navigate into folders where one subitem
-			 * is blocked by the files_accesscontrol app, see:
-			 * https://github.com/nextcloud/files_accesscontrol/issues/65
-			 * if (!$node->getFileInfo()->isReadable()) {
-			 *     // avoid detecting files through this means
-			 *     throw new NotFound();
-			 * }
-			 */
-
-			$propFind->handle(self::FILEID_PROPERTYNAME, function () use ($node) {
-				return $node->getFileId();
-			});
-
-			$propFind->handle(self::INTERNAL_FILEID_PROPERTYNAME, function () use ($node) {
-				return $node->getInternalFileId();
-			});
-
-			$propFind->handle(self::PERMISSIONS_PROPERTYNAME, function () use ($node) {
-				$perms = $node->getDavPermissions();
-				if ($this->isPublic) {
-					// remove mount information
-					$perms = str_replace(['S', 'M'], '', $perms);
-				}
-				return $perms;
-			});
-
-			$propFind->handle(self::SHARE_PERMISSIONS_PROPERTYNAME, function () use ($node, $httpRequest) {
-				return $node->getSharePermissions(
-					$httpRequest->getRawServerValue('PHP_AUTH_USER')
-				);
-			});
-
-			$propFind->handle(self::OCM_SHARE_PERMISSIONS_PROPERTYNAME, function () use ($node, $httpRequest) {
-				$ncPermissions = $node->getSharePermissions(
-					$httpRequest->getRawServerValue('PHP_AUTH_USER')
-				);
-				$ocmPermissions = $this->ncPermissions2ocmPermissions($ncPermissions);
-				return json_encode($ocmPermissions);
-			});
-
-			$propFind->handle(self::GETETAG_PROPERTYNAME, function () use ($node) {
-				return $node->getETag();
-			});
-
-			$propFind->handle(self::OWNER_ID_PROPERTYNAME, function () use ($node) {
-				$owner = $node->getOwner();
-				if (!$owner) {
-					return null;
-				} else {
-					return $owner->getUID();
-				}
-			});
-			$propFind->handle(self::OWNER_DISPLAY_NAME_PROPERTYNAME, function () use ($node) {
-				$owner = $node->getOwner();
-				if (!$owner) {
-					return null;
-				} else {
-					return $owner->getDisplayName();
-				}
-			});
-
-			$propFind->handle(self::HAS_PREVIEW_PROPERTYNAME, function () use ($node) {
-				return json_encode($this->previewManager->isAvailable($node->getFileInfo()));
-			});
-			$propFind->handle(self::SIZE_PROPERTYNAME, function () use ($node) {
-				return $node->getSize();
-			});
-			$propFind->handle(self::MOUNT_TYPE_PROPERTYNAME, function () use ($node) {
-				return $node->getFileInfo()->getMountPoint()->getMountType();
-			});
-
-			$propFind->handle(self::SHARE_NOTE, function () use ($node, $httpRequest) {
-				return $node->getNoteFromShare(
-					$httpRequest->getRawServerValue('PHP_AUTH_USER')
-				);
-			});
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			$propFind->handle(self::DATA_FINGERPRINT_PROPERTYNAME, function () use ($node) {
-				return $this->config->getSystemValue('data-fingerprint', '');
-			});
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
-			$propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function () use ($node) {
-				/** @var $node \OCA\DAV\Connector\Sabre\File */
-				try {
-					$directDownloadUrl = $node->getDirectDownload();
-					if (isset($directDownloadUrl['url'])) {
-						return $directDownloadUrl['url'];
-					}
-				} catch (StorageNotAvailableException $e) {
-					return false;
-				} catch (ForbiddenException $e) {
-					return false;
-				}
-				return false;
-			});
-
-			$propFind->handle(self::CHECKSUMS_PROPERTYNAME, function () use ($node) {
-				$checksum = $node->getChecksum();
-				if ($checksum === null || $checksum === '') {
-					return null;
-				}
-
-				return new ChecksumList($checksum);
-			});
-
-			$propFind->handle(self::CREATION_TIME_PROPERTYNAME, function () use ($node) {
-				return $node->getFileInfo()->getCreationTime();
-			});
-
-			$propFind->handle(self::UPLOAD_TIME_PROPERTYNAME, function () use ($node) {
-				return $node->getFileInfo()->getUploadTime();
-			});
-
-		}
-
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory) {
-			$propFind->handle(self::SIZE_PROPERTYNAME, function () use ($node) {
-				return $node->getSize();
-			});
-
-			$propFind->handle(self::IS_ENCRYPTED_PROPERTYNAME, function () use ($node) {
-				return $node->getFileInfo()->isEncrypted() ? '1' : '0';
-			});
-		}
-	}
-
-	/**
-	 * translate Nextcloud permissions to OCM Permissions
-	 *
-	 * @param $ncPermissions
-	 * @return array
-	 */
-	protected function ncPermissions2ocmPermissions($ncPermissions) {
-
-		$ocmPermissions = [];
-
-		if ($ncPermissions & Constants::PERMISSION_SHARE) {
-			$ocmPermissions[] = 'share';
-		}
-
-		if ($ncPermissions & Constants::PERMISSION_READ) {
-			$ocmPermissions[] = 'read';
-		}
-
-		if (($ncPermissions & Constants::PERMISSION_CREATE) ||
-			($ncPermissions & Constants::PERMISSION_UPDATE)) {
-			$ocmPermissions[] = 'write';
-		}
-
-		return $ocmPermissions;
-
-	}
-
-	/**
-	 * Update ownCloud-specific properties
-	 *
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 *
-	 * @return void
-	 */
-	public function handleUpdateProperties($path, PropPatch $propPatch) {
-		$node = $this->tree->getNodeForPath($path);
-		if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
-			return;
-		}
-
-		$propPatch->handle(self::LASTMODIFIED_PROPERTYNAME, function ($time) use ($node) {
-			if (empty($time)) {
-				return false;
-			}
-			$node->touch($time);
-			return true;
-		});
-		$propPatch->handle(self::GETETAG_PROPERTYNAME, function ($etag) use ($node) {
-			if (empty($etag)) {
-				return false;
-			}
-			if ($node->setEtag($etag) !== -1) {
-				return true;
-			}
-			return false;
-		});
-		$propPatch->handle(self::CREATION_TIME_PROPERTYNAME, function ($time) use ($node) {
-			if (empty($time)) {
-				return false;
-			}
-			$node->setCreationTime((int) $time);
-			return true;
-		});
-	}
-
-	/**
-	 * @param string $filePath
-	 * @param \Sabre\DAV\INode $node
-	 * @throws \Sabre\DAV\Exception\BadRequest
-	 */
-	public function sendFileIdHeader($filePath, \Sabre\DAV\INode $node = null) {
-		// chunked upload handling
-		if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-			list($path, $name) = \Sabre\Uri\split($filePath);
-			$info = \OC_FileChunking::decodeName($name);
-			if (!empty($info)) {
-				$filePath = $path . '/' . $info['name'];
-			}
-		}
-
-		// we get the node for the given $filePath here because in case of afterCreateFile $node is the parent folder
-		if (!$this->server->tree->nodeExists($filePath)) {
-			return;
-		}
-		$node = $this->server->tree->getNodeForPath($filePath);
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
-			$fileId = $node->getFileId();
-			if (!is_null($fileId)) {
-				$this->server->httpResponse->setHeader('OC-FileId', $fileId);
-			}
-		}
-	}
+    // namespace
+    const NS_OWNCLOUD = 'http://owncloud.org/ns';
+    const NS_NEXTCLOUD = 'http://nextcloud.org/ns';
+    const FILEID_PROPERTYNAME = '{http://owncloud.org/ns}id';
+    const INTERNAL_FILEID_PROPERTYNAME = '{http://owncloud.org/ns}fileid';
+    const PERMISSIONS_PROPERTYNAME = '{http://owncloud.org/ns}permissions';
+    const SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-collaboration-services.org/ns}share-permissions';
+    const OCM_SHARE_PERMISSIONS_PROPERTYNAME = '{http://open-cloud-mesh.org/ns}share-permissions';
+    const DOWNLOADURL_PROPERTYNAME = '{http://owncloud.org/ns}downloadURL';
+    const SIZE_PROPERTYNAME = '{http://owncloud.org/ns}size';
+    const GETETAG_PROPERTYNAME = '{DAV:}getetag';
+    const LASTMODIFIED_PROPERTYNAME = '{DAV:}lastmodified';
+    const OWNER_ID_PROPERTYNAME = '{http://owncloud.org/ns}owner-id';
+    const OWNER_DISPLAY_NAME_PROPERTYNAME = '{http://owncloud.org/ns}owner-display-name';
+    const CHECKSUMS_PROPERTYNAME = '{http://owncloud.org/ns}checksums';
+    const DATA_FINGERPRINT_PROPERTYNAME = '{http://owncloud.org/ns}data-fingerprint';
+    const HAS_PREVIEW_PROPERTYNAME = '{http://nextcloud.org/ns}has-preview';
+    const MOUNT_TYPE_PROPERTYNAME = '{http://nextcloud.org/ns}mount-type';
+    const IS_ENCRYPTED_PROPERTYNAME = '{http://nextcloud.org/ns}is-encrypted';
+    const METADATA_ETAG_PROPERTYNAME = '{http://nextcloud.org/ns}metadata_etag';
+    const UPLOAD_TIME_PROPERTYNAME = '{http://nextcloud.org/ns}upload_time';
+    const CREATION_TIME_PROPERTYNAME = '{http://nextcloud.org/ns}creation_time';
+    const SHARE_NOTE = '{http://nextcloud.org/ns}note';
+
+    /**
+     * Reference to main server object
+     *
+     * @var \Sabre\DAV\Server
+     */
+    private $server;
+
+    /**
+     * @var Tree
+     */
+    private $tree;
+
+    /**
+     * Whether this is public webdav.
+     * If true, some returned information will be stripped off.
+     *
+     * @var bool
+     */
+    private $isPublic;
+
+    /**
+     * @var bool
+     */
+    private $downloadAttachment;
+
+    /**
+     * @var IConfig
+     */
+    private $config;
+
+    /**
+     * @var IRequest
+     */
+    private $request;
+
+    /**
+     * @var IPreview
+     */
+    private $previewManager;
+
+    /**
+     * @param Tree $tree
+     * @param IConfig $config
+     * @param IRequest $request
+     * @param IPreview $previewManager
+     * @param bool $isPublic
+     * @param bool $downloadAttachment
+     */
+    public function __construct(Tree $tree,
+                                IConfig $config,
+                                IRequest $request,
+                                IPreview $previewManager,
+                                $isPublic = false,
+                                $downloadAttachment = true) {
+        $this->tree = $tree;
+        $this->config = $config;
+        $this->request = $request;
+        $this->isPublic = $isPublic;
+        $this->downloadAttachment = $downloadAttachment;
+        $this->previewManager = $previewManager;
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by \Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc';
+        $server->xml->namespaceMap[self::NS_NEXTCLOUD] = 'nc';
+        $server->protectedProperties[] = self::FILEID_PROPERTYNAME;
+        $server->protectedProperties[] = self::INTERNAL_FILEID_PROPERTYNAME;
+        $server->protectedProperties[] = self::PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::SHARE_PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::OCM_SHARE_PERMISSIONS_PROPERTYNAME;
+        $server->protectedProperties[] = self::SIZE_PROPERTYNAME;
+        $server->protectedProperties[] = self::DOWNLOADURL_PROPERTYNAME;
+        $server->protectedProperties[] = self::OWNER_ID_PROPERTYNAME;
+        $server->protectedProperties[] = self::OWNER_DISPLAY_NAME_PROPERTYNAME;
+        $server->protectedProperties[] = self::CHECKSUMS_PROPERTYNAME;
+        $server->protectedProperties[] = self::DATA_FINGERPRINT_PROPERTYNAME;
+        $server->protectedProperties[] = self::HAS_PREVIEW_PROPERTYNAME;
+        $server->protectedProperties[] = self::MOUNT_TYPE_PROPERTYNAME;
+        $server->protectedProperties[] = self::IS_ENCRYPTED_PROPERTYNAME;
+        $server->protectedProperties[] = self::SHARE_NOTE;
+
+        // normally these cannot be changed (RFC4918), but we want them modifiable through PROPPATCH
+        $allowedProperties = ['{DAV:}getetag'];
+        $server->protectedProperties = array_diff($server->protectedProperties, $allowedProperties);
+
+        $this->server = $server;
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+        $this->server->on('propPatch', [$this, 'handleUpdateProperties']);
+        $this->server->on('afterBind', [$this, 'sendFileIdHeader']);
+        $this->server->on('afterWriteContent', [$this, 'sendFileIdHeader']);
+        $this->server->on('afterMethod:GET', [$this,'httpGet']);
+        $this->server->on('afterMethod:GET', [$this, 'handleDownloadToken']);
+        $this->server->on('afterResponse', function ($request, ResponseInterface $response) {
+            $body = $response->getBody();
+            if (is_resource($body)) {
+                fclose($body);
+            }
+        });
+        $this->server->on('beforeMove', [$this, 'checkMove']);
+    }
+
+    /**
+     * Plugin that checks if a move can actually be performed.
+     *
+     * @param string $source source path
+     * @param string $destination destination path
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    function checkMove($source, $destination) {
+        $sourceNode = $this->tree->getNodeForPath($source);
+        if (!$sourceNode instanceof Node) {
+            return;
+        }
+        list($sourceDir,) = \Sabre\Uri\split($source);
+        list($destinationDir,) = \Sabre\Uri\split($destination);
+
+        if ($sourceDir !== $destinationDir) {
+            $sourceNodeFileInfo = $sourceNode->getFileInfo();
+            if ($sourceNodeFileInfo === null) {
+                throw new NotFound($source . ' does not exist');
+            }
+
+            if (!$sourceNodeFileInfo->isDeletable()) {
+                throw new Forbidden($source . " cannot be deleted");
+            }
+        }
+    }
+
+    /**
+     * This sets a cookie to be able to recognize the start of the download
+     * the content must not be longer than 32 characters and must only contain
+     * alphanumeric characters
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     */
+    function handleDownloadToken(RequestInterface $request, ResponseInterface $response) {
+        $queryParams = $request->getQueryParameters();
+
+        /**
+         * this sets a cookie to be able to recognize the start of the download
+         * the content must not be longer than 32 characters and must only contain
+         * alphanumeric characters
+         */
+        if (isset($queryParams['downloadStartSecret'])) {
+            $token = $queryParams['downloadStartSecret'];
+            if (!isset($token[32])
+                && preg_match('!^[a-zA-Z0-9]+$!', $token) === 1) {
+                // FIXME: use $response->setHeader() instead
+                setcookie('ocDownloadStarted', $token, time() + 20, '/');
+            }
+        }
+    }
+
+    /**
+     * Add headers to file download
+     *
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     */
+    function httpGet(RequestInterface $request, ResponseInterface $response) {
+        // Only handle valid files
+        $node = $this->tree->getNodeForPath($request->getPath());
+        if (!($node instanceof IFile)) return;
+
+        // adds a 'Content-Disposition: attachment' header in case no disposition
+        // header has been set before
+        if ($this->downloadAttachment &&
+            $response->getHeader('Content-Disposition') === null) {
+            $filename = $node->getName();
+            if ($this->request->isUserAgent(
+                [
+                    Request::USER_AGENT_IE,
+                    Request::USER_AGENT_ANDROID_MOBILE_CHROME,
+                    Request::USER_AGENT_FREEBOX,
+                ])) {
+                $response->addHeader('Content-Disposition', 'attachment; filename="' . rawurlencode($filename) . '"');
+            } else {
+                $response->addHeader('Content-Disposition', 'attachment; filename*=UTF-8\'\'' . rawurlencode($filename)
+                                                        . '; filename="' . rawurlencode($filename) . '"');
+            }
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
+            //Add OC-Checksum header
+            /** @var $node File */
+            $checksum = $node->getChecksum();
+            if ($checksum !== null && $checksum !== '') {
+                $response->addHeader('OC-Checksum', $checksum);
+            }
+        }
+    }
+
+    /**
+     * Adds all ownCloud-specific properties
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node) {
+
+        $httpRequest = $this->server->httpRequest;
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            /**
+             * This was disabled, because it made dir listing throw an exception,
+             * so users were unable to navigate into folders where one subitem
+             * is blocked by the files_accesscontrol app, see:
+             * https://github.com/nextcloud/files_accesscontrol/issues/65
+             * if (!$node->getFileInfo()->isReadable()) {
+             *     // avoid detecting files through this means
+             *     throw new NotFound();
+             * }
+             */
+
+            $propFind->handle(self::FILEID_PROPERTYNAME, function () use ($node) {
+                return $node->getFileId();
+            });
+
+            $propFind->handle(self::INTERNAL_FILEID_PROPERTYNAME, function () use ($node) {
+                return $node->getInternalFileId();
+            });
+
+            $propFind->handle(self::PERMISSIONS_PROPERTYNAME, function () use ($node) {
+                $perms = $node->getDavPermissions();
+                if ($this->isPublic) {
+                    // remove mount information
+                    $perms = str_replace(['S', 'M'], '', $perms);
+                }
+                return $perms;
+            });
+
+            $propFind->handle(self::SHARE_PERMISSIONS_PROPERTYNAME, function () use ($node, $httpRequest) {
+                return $node->getSharePermissions(
+                    $httpRequest->getRawServerValue('PHP_AUTH_USER')
+                );
+            });
+
+            $propFind->handle(self::OCM_SHARE_PERMISSIONS_PROPERTYNAME, function () use ($node, $httpRequest) {
+                $ncPermissions = $node->getSharePermissions(
+                    $httpRequest->getRawServerValue('PHP_AUTH_USER')
+                );
+                $ocmPermissions = $this->ncPermissions2ocmPermissions($ncPermissions);
+                return json_encode($ocmPermissions);
+            });
+
+            $propFind->handle(self::GETETAG_PROPERTYNAME, function () use ($node) {
+                return $node->getETag();
+            });
+
+            $propFind->handle(self::OWNER_ID_PROPERTYNAME, function () use ($node) {
+                $owner = $node->getOwner();
+                if (!$owner) {
+                    return null;
+                } else {
+                    return $owner->getUID();
+                }
+            });
+            $propFind->handle(self::OWNER_DISPLAY_NAME_PROPERTYNAME, function () use ($node) {
+                $owner = $node->getOwner();
+                if (!$owner) {
+                    return null;
+                } else {
+                    return $owner->getDisplayName();
+                }
+            });
+
+            $propFind->handle(self::HAS_PREVIEW_PROPERTYNAME, function () use ($node) {
+                return json_encode($this->previewManager->isAvailable($node->getFileInfo()));
+            });
+            $propFind->handle(self::SIZE_PROPERTYNAME, function () use ($node) {
+                return $node->getSize();
+            });
+            $propFind->handle(self::MOUNT_TYPE_PROPERTYNAME, function () use ($node) {
+                return $node->getFileInfo()->getMountPoint()->getMountType();
+            });
+
+            $propFind->handle(self::SHARE_NOTE, function () use ($node, $httpRequest) {
+                return $node->getNoteFromShare(
+                    $httpRequest->getRawServerValue('PHP_AUTH_USER')
+                );
+            });
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            $propFind->handle(self::DATA_FINGERPRINT_PROPERTYNAME, function () use ($node) {
+                return $this->config->getSystemValue('data-fingerprint', '');
+            });
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\File) {
+            $propFind->handle(self::DOWNLOADURL_PROPERTYNAME, function () use ($node) {
+                /** @var $node \OCA\DAV\Connector\Sabre\File */
+                try {
+                    $directDownloadUrl = $node->getDirectDownload();
+                    if (isset($directDownloadUrl['url'])) {
+                        return $directDownloadUrl['url'];
+                    }
+                } catch (StorageNotAvailableException $e) {
+                    return false;
+                } catch (ForbiddenException $e) {
+                    return false;
+                }
+                return false;
+            });
+
+            $propFind->handle(self::CHECKSUMS_PROPERTYNAME, function () use ($node) {
+                $checksum = $node->getChecksum();
+                if ($checksum === null || $checksum === '') {
+                    return null;
+                }
+
+                return new ChecksumList($checksum);
+            });
+
+            $propFind->handle(self::CREATION_TIME_PROPERTYNAME, function () use ($node) {
+                return $node->getFileInfo()->getCreationTime();
+            });
+
+            $propFind->handle(self::UPLOAD_TIME_PROPERTYNAME, function () use ($node) {
+                return $node->getFileInfo()->getUploadTime();
+            });
+
+        }
+
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory) {
+            $propFind->handle(self::SIZE_PROPERTYNAME, function () use ($node) {
+                return $node->getSize();
+            });
+
+            $propFind->handle(self::IS_ENCRYPTED_PROPERTYNAME, function () use ($node) {
+                return $node->getFileInfo()->isEncrypted() ? '1' : '0';
+            });
+        }
+    }
+
+    /**
+     * translate Nextcloud permissions to OCM Permissions
+     *
+     * @param $ncPermissions
+     * @return array
+     */
+    protected function ncPermissions2ocmPermissions($ncPermissions) {
+
+        $ocmPermissions = [];
+
+        if ($ncPermissions & Constants::PERMISSION_SHARE) {
+            $ocmPermissions[] = 'share';
+        }
+
+        if ($ncPermissions & Constants::PERMISSION_READ) {
+            $ocmPermissions[] = 'read';
+        }
+
+        if (($ncPermissions & Constants::PERMISSION_CREATE) ||
+            ($ncPermissions & Constants::PERMISSION_UPDATE)) {
+            $ocmPermissions[] = 'write';
+        }
+
+        return $ocmPermissions;
+
+    }
+
+    /**
+     * Update ownCloud-specific properties
+     *
+     * @param string $path
+     * @param PropPatch $propPatch
+     *
+     * @return void
+     */
+    public function handleUpdateProperties($path, PropPatch $propPatch) {
+        $node = $this->tree->getNodeForPath($path);
+        if (!($node instanceof \OCA\DAV\Connector\Sabre\Node)) {
+            return;
+        }
+
+        $propPatch->handle(self::LASTMODIFIED_PROPERTYNAME, function ($time) use ($node) {
+            if (empty($time)) {
+                return false;
+            }
+            $node->touch($time);
+            return true;
+        });
+        $propPatch->handle(self::GETETAG_PROPERTYNAME, function ($etag) use ($node) {
+            if (empty($etag)) {
+                return false;
+            }
+            if ($node->setEtag($etag) !== -1) {
+                return true;
+            }
+            return false;
+        });
+        $propPatch->handle(self::CREATION_TIME_PROPERTYNAME, function ($time) use ($node) {
+            if (empty($time)) {
+                return false;
+            }
+            $node->setCreationTime((int) $time);
+            return true;
+        });
+    }
+
+    /**
+     * @param string $filePath
+     * @param \Sabre\DAV\INode $node
+     * @throws \Sabre\DAV\Exception\BadRequest
+     */
+    public function sendFileIdHeader($filePath, \Sabre\DAV\INode $node = null) {
+        // chunked upload handling
+        if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+            list($path, $name) = \Sabre\Uri\split($filePath);
+            $info = \OC_FileChunking::decodeName($name);
+            if (!empty($info)) {
+                $filePath = $path . '/' . $info['name'];
+            }
+        }
+
+        // we get the node for the given $filePath here because in case of afterCreateFile $node is the parent folder
+        if (!$this->server->tree->nodeExists($filePath)) {
+            return;
+        }
+        $node = $this->server->tree->getNodeForPath($filePath);
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Node) {
+            $fileId = $node->getFileId();
+            if (!is_null($fileId)) {
+                $this->server->httpResponse->setHeader('OC-FileId', $fileId);
+            }
+        }
+    }
 }

apps/dav/lib/Connector/Sabre/Principal.php

Indentation +478 added lines, -478 removed lines

@@ -50,482 +50,482 @@
 
 class Principal implements BackendInterface {
 
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IShareManager */
-	private $shareManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var string */
-	private $principalPrefix;
-
-	/** @var bool */
-	private $hasGroups;
-
-	/** @var bool */
-	private $hasCircles;
-
-	/** @var ProxyMapper */
-	private $proxyMapper;
-
-	/** @var IConfig */
-	private $config;
-
-	/**
-	 * Principal constructor.
-	 *
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param IShareManager $shareManager
-	 * @param IUserSession $userSession
-	 * @param IAppManager $appManager
-	 * @param ProxyMapper $proxyMapper
-	 * @param IConfig $config
-	 * @param string $principalPrefix
-	 */
-	public function __construct(IUserManager $userManager,
-								IGroupManager $groupManager,
-								IShareManager $shareManager,
-								IUserSession $userSession,
-								IAppManager $appManager,
-								ProxyMapper $proxyMapper,
-								IConfig $config,
-								string $principalPrefix = 'principals/users/') {
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->shareManager = $shareManager;
-		$this->userSession = $userSession;
-		$this->appManager = $appManager;
-		$this->principalPrefix = trim($principalPrefix, '/');
-		$this->hasGroups = $this->hasCircles = ($principalPrefix === 'principals/users/');
-		$this->proxyMapper = $proxyMapper;
-		$this->config = $config;
-	}
-
-	use PrincipalProxyTrait {
-		getGroupMembership as protected traitGetGroupMembership;
-	}
-
-	/**
-	 * Returns a list of principals based on a prefix.
-	 *
-	 * This prefix will often contain something like 'principals'. You are only
-	 * expected to return principals that are in this base path.
-	 *
-	 * You are expected to return at least a 'uri' for every user, you can
-	 * return any additional properties if you wish so. Common properties are:
-	 *   {DAV:}displayname
-	 *
-	 * @param string $prefixPath
-	 * @return string[]
-	 */
-	public function getPrincipalsByPrefix($prefixPath) {
-		$principals = [];
-
-		if ($prefixPath === $this->principalPrefix) {
-			foreach($this->userManager->search('') as $user) {
-				$principals[] = $this->userToPrincipal($user);
-			}
-		}
-
-		return $principals;
-	}
-
-	/**
-	 * Returns a specific principal, specified by it's path.
-	 * The returned structure should be the exact same as from
-	 * getPrincipalsByPrefix.
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	public function getPrincipalByPath($path) {
-		list($prefix, $name) = \Sabre\Uri\split($path);
-
-		if ($name === 'calendar-proxy-write' || $name === 'calendar-proxy-read') {
-			list($prefix2, $name2) = \Sabre\Uri\split($prefix);
-
-			if ($prefix2 === $this->principalPrefix) {
-				$user = $this->userManager->get($name2);
-
-				if ($user !== null) {
-					return [
-						'uri' => 'principals/users/' . $user->getUID() . '/' . $name,
-					];
-				}
-				return null;
-			}
-		}
-
-		if ($prefix === $this->principalPrefix) {
-			$user = $this->userManager->get($name);
-
-			if ($user !== null) {
-				return $this->userToPrincipal($user);
-			}
-		} else if ($prefix === 'principals/circles') {
-			try {
-				return $this->circleToPrincipal($name);
-			} catch (QueryException $e) {
-				return null;
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * Returns the list of groups a principal is a member of
-	 *
-	 * @param string $principal
-	 * @param bool $needGroups
-	 * @return array
-	 * @throws Exception
-	 */
-	public function getGroupMembership($principal, $needGroups = false) {
-		list($prefix, $name) = \Sabre\Uri\split($principal);
-
-		if ($prefix !== $this->principalPrefix) {
-			return [];
-		}
-
-		$user = $this->userManager->get($name);
-		if (!$user) {
-			throw new Exception('Principal not found');
-		}
-
-		$groups = [];
-
-		if ($this->hasGroups || $needGroups) {
-			$userGroups = $this->groupManager->getUserGroups($user);
-			foreach($userGroups as $userGroup) {
-				$groups[] = 'principals/groups/' . urlencode($userGroup->getGID());
-			}
-		}
-
-		$groups = array_unique(array_merge(
-			$groups,
-			$this->traitGetGroupMembership($principal, $needGroups)
-		));
-
-		return $groups;
-	}
-
-	/**
-	 * @param string $path
-	 * @param PropPatch $propPatch
-	 * @return int
-	 */
-	function updatePrincipal($path, PropPatch $propPatch) {
-		return 0;
-	}
-
-	/**
-	 * Search user principals
-	 *
-	 * @param array $searchProperties
-	 * @param string $test
-	 * @return array
-	 */
-	protected function searchUserPrincipals(array $searchProperties, $test = 'allof') {
-		$results = [];
-
-		// If sharing is disabled, return the empty array
-		$shareAPIEnabled = $this->shareManager->shareApiEnabled();
-		if (!$shareAPIEnabled) {
-			return [];
-		}
-
-		$allowEnumeration = $this->shareManager->allowEnumeration();
-		$limitEnumeration = $this->shareManager->limitEnumerationToGroups();
-
-		// If sharing is restricted to group members only,
-		// return only members that have groups in common
-		$restrictGroups = false;
-		if ($this->shareManager->shareWithGroupMembersOnly()) {
-			$user = $this->userSession->getUser();
-			if (!$user) {
-				return [];
-			}
-
-			$restrictGroups = $this->groupManager->getUserGroupIds($user);
-		}
-
-		$currentUserGroups = [];
-		if ($limitEnumeration) {
-			$currentUser = $this->userSession->getUser();
-			if ($currentUser) {
-				$currentUserGroups = $this->groupManager->getUserGroupIds($currentUser);
-			}
-		}
-
-		foreach ($searchProperties as $prop => $value) {
-			switch ($prop) {
-				case '{http://sabredav.org/ns}email-address':
-					$users = $this->userManager->getByEmail($value);
-
-					if (!$allowEnumeration) {
-						$users = \array_filter($users, static function (IUser $user) use ($value) {
-							return $user->getEMailAddress() === $value;
-						});
-					}
-
-					if ($limitEnumeration) {
-						$users = \array_filter($users, function (IUser $user) use ($currentUserGroups, $value) {
-							return !empty(array_intersect(
-									$this->groupManager->getUserGroupIds($user),
-									$currentUserGroups
-								)) || $user->getEMailAddress() === $value;
-						});
-					}
-
-					$results[] = array_reduce($users, function (array $carry, IUser $user) use ($restrictGroups) {
-						// is sharing restricted to groups only?
-						if ($restrictGroups !== false) {
-							$userGroups = $this->groupManager->getUserGroupIds($user);
-							if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
-								return $carry;
-							}
-						}
-
-						$carry[] = $this->principalPrefix . '/' . $user->getUID();
-						return $carry;
-					}, []);
-					break;
-
-				case '{DAV:}displayname':
-					$users = $this->userManager->searchDisplayName($value);
-
-					if (!$allowEnumeration) {
-						$users = \array_filter($users, static function (IUser $user) use ($value) {
-							return $user->getDisplayName() === $value;
-						});
-					}
-
-					if ($limitEnumeration) {
-						$users = \array_filter($users, function (IUser $user) use ($currentUserGroups, $value) {
-							return !empty(array_intersect(
-									$this->groupManager->getUserGroupIds($user),
-									$currentUserGroups
-								)) || $user->getDisplayName() === $value;
-						});
-					}
-
-					$results[] = array_reduce($users, function (array $carry, IUser $user) use ($restrictGroups) {
-						// is sharing restricted to groups only?
-						if ($restrictGroups !== false) {
-							$userGroups = $this->groupManager->getUserGroupIds($user);
-							if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
-								return $carry;
-							}
-						}
-
-						$carry[] = $this->principalPrefix . '/' . $user->getUID();
-						return $carry;
-					}, []);
-					break;
-
-				case '{urn:ietf:params:xml:ns:caldav}calendar-user-address-set':
-					// If you add support for more search properties that qualify as a user-address,
-					// please also add them to the array below
-					$results[] = $this->searchUserPrincipals([
-						// In theory this should also search for principal:principals/users/...
-						// but that's used internally only anyway and i don't know of any client querying that
-						'{http://sabredav.org/ns}email-address' => $value,
-					], 'anyof');
-					break;
-
-				default:
-					$results[] = [];
-					break;
-			}
-		}
-
-		// results is an array of arrays, so this is not the first search result
-		// but the results of the first searchProperty
-		if (count($results) === 1) {
-			return $results[0];
-		}
-
-		switch ($test) {
-			case 'anyof':
-				return array_values(array_unique(array_merge(...$results)));
-
-			case 'allof':
-			default:
-				return array_values(array_intersect(...$results));
-		}
-	}
-
-	/**
-	 * @param string $prefixPath
-	 * @param array $searchProperties
-	 * @param string $test
-	 * @return array
-	 */
-	function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-		if (count($searchProperties) === 0) {
-			return [];
-		}
-
-		switch ($prefixPath) {
-			case 'principals/users':
-				return $this->searchUserPrincipals($searchProperties, $test);
-
-			default:
-				return [];
-		}
-	}
-
-	/**
-	 * @param string $uri
-	 * @param string $principalPrefix
-	 * @return string
-	 */
-	function findByUri($uri, $principalPrefix) {
-		// If sharing is disabled, return the empty array
-		$shareAPIEnabled = $this->shareManager->shareApiEnabled();
-		if (!$shareAPIEnabled) {
-			return null;
-		}
-
-		// If sharing is restricted to group members only,
-		// return only members that have groups in common
-		$restrictGroups = false;
-		if ($this->shareManager->shareWithGroupMembersOnly()) {
-			$user = $this->userSession->getUser();
-			if (!$user) {
-				return null;
-			}
-
-			$restrictGroups = $this->groupManager->getUserGroupIds($user);
-		}
-
-		if (strpos($uri, 'mailto:') === 0) {
-			if ($principalPrefix === 'principals/users') {
-				$users = $this->userManager->getByEmail(substr($uri, 7));
-				if (count($users) !== 1) {
-					return null;
-				}
-				$user = $users[0];
-
-				if ($restrictGroups !== false) {
-					$userGroups = $this->groupManager->getUserGroupIds($user);
-					if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
-						return null;
-					}
-				}
-
-				return $this->principalPrefix . '/' . $user->getUID();
-			}
-		}
-		if (substr($uri, 0, 10) === 'principal:') {
-			$principal = substr($uri, 10);
-			$principal = $this->getPrincipalByPath($principal);
-			if ($principal !== null) {
-				return $principal['uri'];
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return array
-	 */
-	protected function userToPrincipal($user) {
-		$userId = $user->getUID();
-		$displayName = $user->getDisplayName();
-		$principal = [
-			'uri' => $this->principalPrefix . '/' . $userId,
-			'{DAV:}displayname' => is_null($displayName) ? $userId : $displayName,
-			'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'INDIVIDUAL',
-		];
-
-		$email = $user->getEMailAddress();
-		if (!empty($email)) {
-			$principal['{http://sabredav.org/ns}email-address'] = $email;
-		}
-
-		return $principal;
-	}
-
-	public function getPrincipalPrefix() {
-		return $this->principalPrefix;
-	}
-
-	/**
-	 * @param string $circleUniqueId
-	 * @return array|null
-	 * @throws \OCP\AppFramework\QueryException
-	 * @suppress PhanUndeclaredClassMethod
-	 * @suppress PhanUndeclaredClassCatch
-	 */
-	protected function circleToPrincipal($circleUniqueId) {
-		if (!$this->appManager->isEnabledForUser('circles') || !class_exists('\OCA\Circles\Api\v1\Circles')) {
-			return null;
-		}
-
-		try {
-			$circle = \OCA\Circles\Api\v1\Circles::detailsCircle($circleUniqueId, true);
-		} catch(QueryException $ex) {
-			return null;
-		} catch(CircleDoesNotExistException $ex) {
-			return null;
-		}
-
-		if (!$circle) {
-			return null;
-		}
-
-		$principal = [
-			'uri' => 'principals/circles/' . $circleUniqueId,
-			'{DAV:}displayname' => $circle->getName(),
-		];
-
-		return $principal;
-	}
-
-	/**
-	 * Returns the list of circles a principal is a member of
-	 *
-	 * @param string $principal
-	 * @return array
-	 * @throws Exception
-	 * @throws \OCP\AppFramework\QueryException
-	 * @suppress PhanUndeclaredClassMethod
-	 */
-	public function getCircleMembership($principal):array {
-		if (!$this->appManager->isEnabledForUser('circles') || !class_exists('\OCA\Circles\Api\v1\Circles')) {
-			return [];
-		}
-
-		list($prefix, $name) = \Sabre\Uri\split($principal);
-		if ($this->hasCircles && $prefix === $this->principalPrefix) {
-			$user = $this->userManager->get($name);
-			if (!$user) {
-				throw new Exception('Principal not found');
-			}
-
-			$circles = \OCA\Circles\Api\v1\Circles::joinedCircles($name, true);
-
-			$circles = array_map(function ($circle) {
-				/** @var \OCA\Circles\Model\Circle $circle */
-				return 'principals/circles/' . urlencode($circle->getUniqueId());
-			}, $circles);
-
-			return $circles;
-		}
-
-		return [];
-	}
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IShareManager */
+    private $shareManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var string */
+    private $principalPrefix;
+
+    /** @var bool */
+    private $hasGroups;
+
+    /** @var bool */
+    private $hasCircles;
+
+    /** @var ProxyMapper */
+    private $proxyMapper;
+
+    /** @var IConfig */
+    private $config;
+
+    /**
+     * Principal constructor.
+     *
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param IShareManager $shareManager
+     * @param IUserSession $userSession
+     * @param IAppManager $appManager
+     * @param ProxyMapper $proxyMapper
+     * @param IConfig $config
+     * @param string $principalPrefix
+     */
+    public function __construct(IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IShareManager $shareManager,
+                                IUserSession $userSession,
+                                IAppManager $appManager,
+                                ProxyMapper $proxyMapper,
+                                IConfig $config,
+                                string $principalPrefix = 'principals/users/') {
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->shareManager = $shareManager;
+        $this->userSession = $userSession;
+        $this->appManager = $appManager;
+        $this->principalPrefix = trim($principalPrefix, '/');
+        $this->hasGroups = $this->hasCircles = ($principalPrefix === 'principals/users/');
+        $this->proxyMapper = $proxyMapper;
+        $this->config = $config;
+    }
+
+    use PrincipalProxyTrait {
+        getGroupMembership as protected traitGetGroupMembership;
+    }
+
+    /**
+     * Returns a list of principals based on a prefix.
+     *
+     * This prefix will often contain something like 'principals'. You are only
+     * expected to return principals that are in this base path.
+     *
+     * You are expected to return at least a 'uri' for every user, you can
+     * return any additional properties if you wish so. Common properties are:
+     *   {DAV:}displayname
+     *
+     * @param string $prefixPath
+     * @return string[]
+     */
+    public function getPrincipalsByPrefix($prefixPath) {
+        $principals = [];
+
+        if ($prefixPath === $this->principalPrefix) {
+            foreach($this->userManager->search('') as $user) {
+                $principals[] = $this->userToPrincipal($user);
+            }
+        }
+
+        return $principals;
+    }
+
+    /**
+     * Returns a specific principal, specified by it's path.
+     * The returned structure should be the exact same as from
+     * getPrincipalsByPrefix.
+     *
+     * @param string $path
+     * @return array
+     */
+    public function getPrincipalByPath($path) {
+        list($prefix, $name) = \Sabre\Uri\split($path);
+
+        if ($name === 'calendar-proxy-write' || $name === 'calendar-proxy-read') {
+            list($prefix2, $name2) = \Sabre\Uri\split($prefix);
+
+            if ($prefix2 === $this->principalPrefix) {
+                $user = $this->userManager->get($name2);
+
+                if ($user !== null) {
+                    return [
+                        'uri' => 'principals/users/' . $user->getUID() . '/' . $name,
+                    ];
+                }
+                return null;
+            }
+        }
+
+        if ($prefix === $this->principalPrefix) {
+            $user = $this->userManager->get($name);
+
+            if ($user !== null) {
+                return $this->userToPrincipal($user);
+            }
+        } else if ($prefix === 'principals/circles') {
+            try {
+                return $this->circleToPrincipal($name);
+            } catch (QueryException $e) {
+                return null;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Returns the list of groups a principal is a member of
+     *
+     * @param string $principal
+     * @param bool $needGroups
+     * @return array
+     * @throws Exception
+     */
+    public function getGroupMembership($principal, $needGroups = false) {
+        list($prefix, $name) = \Sabre\Uri\split($principal);
+
+        if ($prefix !== $this->principalPrefix) {
+            return [];
+        }
+
+        $user = $this->userManager->get($name);
+        if (!$user) {
+            throw new Exception('Principal not found');
+        }
+
+        $groups = [];
+
+        if ($this->hasGroups || $needGroups) {
+            $userGroups = $this->groupManager->getUserGroups($user);
+            foreach($userGroups as $userGroup) {
+                $groups[] = 'principals/groups/' . urlencode($userGroup->getGID());
+            }
+        }
+
+        $groups = array_unique(array_merge(
+            $groups,
+            $this->traitGetGroupMembership($principal, $needGroups)
+        ));
+
+        return $groups;
+    }
+
+    /**
+     * @param string $path
+     * @param PropPatch $propPatch
+     * @return int
+     */
+    function updatePrincipal($path, PropPatch $propPatch) {
+        return 0;
+    }
+
+    /**
+     * Search user principals
+     *
+     * @param array $searchProperties
+     * @param string $test
+     * @return array
+     */
+    protected function searchUserPrincipals(array $searchProperties, $test = 'allof') {
+        $results = [];
+
+        // If sharing is disabled, return the empty array
+        $shareAPIEnabled = $this->shareManager->shareApiEnabled();
+        if (!$shareAPIEnabled) {
+            return [];
+        }
+
+        $allowEnumeration = $this->shareManager->allowEnumeration();
+        $limitEnumeration = $this->shareManager->limitEnumerationToGroups();
+
+        // If sharing is restricted to group members only,
+        // return only members that have groups in common
+        $restrictGroups = false;
+        if ($this->shareManager->shareWithGroupMembersOnly()) {
+            $user = $this->userSession->getUser();
+            if (!$user) {
+                return [];
+            }
+
+            $restrictGroups = $this->groupManager->getUserGroupIds($user);
+        }
+
+        $currentUserGroups = [];
+        if ($limitEnumeration) {
+            $currentUser = $this->userSession->getUser();
+            if ($currentUser) {
+                $currentUserGroups = $this->groupManager->getUserGroupIds($currentUser);
+            }
+        }
+
+        foreach ($searchProperties as $prop => $value) {
+            switch ($prop) {
+                case '{http://sabredav.org/ns}email-address':
+                    $users = $this->userManager->getByEmail($value);
+
+                    if (!$allowEnumeration) {
+                        $users = \array_filter($users, static function (IUser $user) use ($value) {
+                            return $user->getEMailAddress() === $value;
+                        });
+                    }
+
+                    if ($limitEnumeration) {
+                        $users = \array_filter($users, function (IUser $user) use ($currentUserGroups, $value) {
+                            return !empty(array_intersect(
+                                    $this->groupManager->getUserGroupIds($user),
+                                    $currentUserGroups
+                                )) || $user->getEMailAddress() === $value;
+                        });
+                    }
+
+                    $results[] = array_reduce($users, function (array $carry, IUser $user) use ($restrictGroups) {
+                        // is sharing restricted to groups only?
+                        if ($restrictGroups !== false) {
+                            $userGroups = $this->groupManager->getUserGroupIds($user);
+                            if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
+                                return $carry;
+                            }
+                        }
+
+                        $carry[] = $this->principalPrefix . '/' . $user->getUID();
+                        return $carry;
+                    }, []);
+                    break;
+
+                case '{DAV:}displayname':
+                    $users = $this->userManager->searchDisplayName($value);
+
+                    if (!$allowEnumeration) {
+                        $users = \array_filter($users, static function (IUser $user) use ($value) {
+                            return $user->getDisplayName() === $value;
+                        });
+                    }
+
+                    if ($limitEnumeration) {
+                        $users = \array_filter($users, function (IUser $user) use ($currentUserGroups, $value) {
+                            return !empty(array_intersect(
+                                    $this->groupManager->getUserGroupIds($user),
+                                    $currentUserGroups
+                                )) || $user->getDisplayName() === $value;
+                        });
+                    }
+
+                    $results[] = array_reduce($users, function (array $carry, IUser $user) use ($restrictGroups) {
+                        // is sharing restricted to groups only?
+                        if ($restrictGroups !== false) {
+                            $userGroups = $this->groupManager->getUserGroupIds($user);
+                            if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
+                                return $carry;
+                            }
+                        }
+
+                        $carry[] = $this->principalPrefix . '/' . $user->getUID();
+                        return $carry;
+                    }, []);
+                    break;
+
+                case '{urn:ietf:params:xml:ns:caldav}calendar-user-address-set':
+                    // If you add support for more search properties that qualify as a user-address,
+                    // please also add them to the array below
+                    $results[] = $this->searchUserPrincipals([
+                        // In theory this should also search for principal:principals/users/...
+                        // but that's used internally only anyway and i don't know of any client querying that
+                        '{http://sabredav.org/ns}email-address' => $value,
+                    ], 'anyof');
+                    break;
+
+                default:
+                    $results[] = [];
+                    break;
+            }
+        }
+
+        // results is an array of arrays, so this is not the first search result
+        // but the results of the first searchProperty
+        if (count($results) === 1) {
+            return $results[0];
+        }
+
+        switch ($test) {
+            case 'anyof':
+                return array_values(array_unique(array_merge(...$results)));
+
+            case 'allof':
+            default:
+                return array_values(array_intersect(...$results));
+        }
+    }
+
+    /**
+     * @param string $prefixPath
+     * @param array $searchProperties
+     * @param string $test
+     * @return array
+     */
+    function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
+        if (count($searchProperties) === 0) {
+            return [];
+        }
+
+        switch ($prefixPath) {
+            case 'principals/users':
+                return $this->searchUserPrincipals($searchProperties, $test);
+
+            default:
+                return [];
+        }
+    }
+
+    /**
+     * @param string $uri
+     * @param string $principalPrefix
+     * @return string
+     */
+    function findByUri($uri, $principalPrefix) {
+        // If sharing is disabled, return the empty array
+        $shareAPIEnabled = $this->shareManager->shareApiEnabled();
+        if (!$shareAPIEnabled) {
+            return null;
+        }
+
+        // If sharing is restricted to group members only,
+        // return only members that have groups in common
+        $restrictGroups = false;
+        if ($this->shareManager->shareWithGroupMembersOnly()) {
+            $user = $this->userSession->getUser();
+            if (!$user) {
+                return null;
+            }
+
+            $restrictGroups = $this->groupManager->getUserGroupIds($user);
+        }
+
+        if (strpos($uri, 'mailto:') === 0) {
+            if ($principalPrefix === 'principals/users') {
+                $users = $this->userManager->getByEmail(substr($uri, 7));
+                if (count($users) !== 1) {
+                    return null;
+                }
+                $user = $users[0];
+
+                if ($restrictGroups !== false) {
+                    $userGroups = $this->groupManager->getUserGroupIds($user);
+                    if (count(array_intersect($userGroups, $restrictGroups)) === 0) {
+                        return null;
+                    }
+                }
+
+                return $this->principalPrefix . '/' . $user->getUID();
+            }
+        }
+        if (substr($uri, 0, 10) === 'principal:') {
+            $principal = substr($uri, 10);
+            $principal = $this->getPrincipalByPath($principal);
+            if ($principal !== null) {
+                return $principal['uri'];
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param IUser $user
+     * @return array
+     */
+    protected function userToPrincipal($user) {
+        $userId = $user->getUID();
+        $displayName = $user->getDisplayName();
+        $principal = [
+            'uri' => $this->principalPrefix . '/' . $userId,
+            '{DAV:}displayname' => is_null($displayName) ? $userId : $displayName,
+            '{urn:ietf:params:xml:ns:caldav}calendar-user-type' => 'INDIVIDUAL',
+        ];
+
+        $email = $user->getEMailAddress();
+        if (!empty($email)) {
+            $principal['{http://sabredav.org/ns}email-address'] = $email;
+        }
+
+        return $principal;
+    }
+
+    public function getPrincipalPrefix() {
+        return $this->principalPrefix;
+    }
+
+    /**
+     * @param string $circleUniqueId
+     * @return array|null
+     * @throws \OCP\AppFramework\QueryException
+     * @suppress PhanUndeclaredClassMethod
+     * @suppress PhanUndeclaredClassCatch
+     */
+    protected function circleToPrincipal($circleUniqueId) {
+        if (!$this->appManager->isEnabledForUser('circles') || !class_exists('\OCA\Circles\Api\v1\Circles')) {
+            return null;
+        }
+
+        try {
+            $circle = \OCA\Circles\Api\v1\Circles::detailsCircle($circleUniqueId, true);
+        } catch(QueryException $ex) {
+            return null;
+        } catch(CircleDoesNotExistException $ex) {
+            return null;
+        }
+
+        if (!$circle) {
+            return null;
+        }
+
+        $principal = [
+            'uri' => 'principals/circles/' . $circleUniqueId,
+            '{DAV:}displayname' => $circle->getName(),
+        ];
+
+        return $principal;
+    }
+
+    /**
+     * Returns the list of circles a principal is a member of
+     *
+     * @param string $principal
+     * @return array
+     * @throws Exception
+     * @throws \OCP\AppFramework\QueryException
+     * @suppress PhanUndeclaredClassMethod
+     */
+    public function getCircleMembership($principal):array {
+        if (!$this->appManager->isEnabledForUser('circles') || !class_exists('\OCA\Circles\Api\v1\Circles')) {
+            return [];
+        }
+
+        list($prefix, $name) = \Sabre\Uri\split($principal);
+        if ($this->hasCircles && $prefix === $this->principalPrefix) {
+            $user = $this->userManager->get($name);
+            if (!$user) {
+                throw new Exception('Principal not found');
+            }
+
+            $circles = \OCA\Circles\Api\v1\Circles::joinedCircles($name, true);
+
+            $circles = array_map(function ($circle) {
+                /** @var \OCA\Circles\Model\Circle $circle */
+                return 'principals/circles/' . urlencode($circle->getUniqueId());
+            }, $circles);
+
+            return $circles;
+        }
+
+        return [];
+    }
 }