1 files changed, 19 insertions, 370 deletions

diff --git a/apps/dav/lib/BackgroundJob/RefreshWebcalJob.php b/apps/dav/lib/BackgroundJob/RefreshWebcalJob.php
index 89f941c14d5..710dd09da86 100644
--- a/apps/dav/lib/BackgroundJob/RefreshWebcalJob.php
+++ b/apps/dav/lib/BackgroundJob/RefreshWebcalJob.php
@@ -7,6 +7,7 @@ declare(strict_types=1);
  *
  * @author Georg Ehrke <oc.list@georgehrke.com>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Thomas Citharel <nextcloud@tcit.fr>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -27,36 +28,20 @@ declare(strict_types=1);
 
 namespace OCA\DAV\BackgroundJob;
 
-use GuzzleHttp\HandlerStack;
-use GuzzleHttp\Middleware;
+use DateInterval;
 use OC\BackgroundJob\Job;
-use OCA\DAV\CalDAV\CalDavBackend;
+use OCA\DAV\CalDAV\WebcalCaching\RefreshWebcalService;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\Http\Client\IClientService;
-use OCP\IConfig;
 use OCP\ILogger;
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use Sabre\DAV\Exception\BadRequest;
-use Sabre\DAV\PropPatch;
-use Sabre\DAV\Xml\Property\Href;
-use Sabre\VObject\Component;
 use Sabre\VObject\DateTimeParser;
 use Sabre\VObject\InvalidDataException;
-use Sabre\VObject\ParseException;
-use Sabre\VObject\Reader;
-use Sabre\VObject\Splitter\ICalendar;
 
 class RefreshWebcalJob extends Job {
 
-	/** @var CalDavBackend */
-	private $calDavBackend;
-
-	/** @var IClientService */
-	private $clientService;
-
-	/** @var IConfig */
-	private $config;
+	/**
+	 * @var RefreshWebcalService
+	 */
+	private $refreshWebcalService;
 
 	/** @var ILogger */
 	private $logger;
@@ -64,27 +49,15 @@ class RefreshWebcalJob extends Job {
 	/** @var ITimeFactory */
 	private $timeFactory;
 
-	/** @var array */
-	private $subscription;
-
-	private const REFRESH_RATE = '{http://apple.com/ns/ical/}refreshrate';
-	private const STRIP_ALARMS = '{http://calendarserver.org/ns/}subscribed-strip-alarms';
-	private const STRIP_ATTACHMENTS = '{http://calendarserver.org/ns/}subscribed-strip-attachments';
-	private const STRIP_TODOS = '{http://calendarserver.org/ns/}subscribed-strip-todos';
-
 	/**
 	 * RefreshWebcalJob constructor.
 	 *
-	 * @param CalDavBackend $calDavBackend
-	 * @param IClientService $clientService
-	 * @param IConfig $config
+	 * @param RefreshWebcalService $refreshWebcalService
 	 * @param ILogger $logger
 	 * @param ITimeFactory $timeFactory
 	 */
-	public function __construct(CalDavBackend $calDavBackend, IClientService $clientService, IConfig $config, ILogger $logger, ITimeFactory $timeFactory) {
-		$this->calDavBackend = $calDavBackend;
-		$this->clientService = $clientService;
-		$this->config = $config;
+	public function __construct(RefreshWebcalService $refreshWebcalService, ILogger $logger, ITimeFactory $timeFactory) {
+		$this->refreshWebcalService = $refreshWebcalService;
 		$this->logger = $logger;
 		$this->timeFactory = $timeFactory;
 	}
@@ -95,7 +68,7 @@ class RefreshWebcalJob extends Job {
 	 * @inheritdoc
 	 */
 	public function execute($jobList, ILogger $logger = null) {
-		$subscription = $this->getSubscription($this->argument['principaluri'], $this->argument['uri']);
+		$subscription = $this->refreshWebcalService->getSubscription($this->argument['principaluri'], $this->argument['uri']);
 		if (!$subscription) {
 			return;
 		}
@@ -104,10 +77,10 @@ class RefreshWebcalJob extends Job {
 
 		// if no refresh rate was configured, just refresh once a week
 		$subscriptionId = $subscription['id'];
-		$refreshrate = $subscription[self::REFRESH_RATE] ?? 'P1W';
+		$refreshrate = $subscription[RefreshWebcalService::REFRESH_RATE] ?? 'P1W';
 
 		try {
-			/** @var \DateInterval $dateInterval */
+			/** @var DateInterval $dateInterval */
 			$dateInterval = DateTimeParser::parseDuration($refreshrate);
 		} catch(InvalidDataException $ex) {
 			$this->logger->logException($ex);
@@ -127,243 +100,16 @@ class RefreshWebcalJob extends Job {
 	 * @param array $argument
 	 */
 	protected function run($argument) {
-		$subscription = $this->getSubscription($argument['principaluri'], $argument['uri']);
-		$mutations = [];
-		if (!$subscription) {
-			return;
-		}
-
-		$webcalData = $this->queryWebcalFeed($subscription, $mutations);
-		if (!$webcalData) {
-			return;
-		}
-
-		$stripTodos = ($subscription[self::STRIP_TODOS] ?? 1) === 1;
-		$stripAlarms = ($subscription[self::STRIP_ALARMS] ?? 1) === 1;
-		$stripAttachments = ($subscription[self::STRIP_ATTACHMENTS] ?? 1) === 1;
-
-		try {
-			$splitter = new ICalendar($webcalData, Reader::OPTION_FORGIVING);
-
-			// we wait with deleting all outdated events till we parsed the new ones
-			// in case the new calendar is broken and `new ICalendar` throws a ParseException
-			// the user will still see the old data
-			$this->calDavBackend->purgeAllCachedEventsForSubscription($subscription['id']);
-
-			while ($vObject = $splitter->getNext()) {
-				/** @var Component $vObject */
-				$uid = null;
-				$compName = null;
-
-				foreach ($vObject->getComponents() as $component) {
-					if ($component->name === 'VTIMEZONE') {
-						continue;
-					}
-
-					$uid = $component->{'UID'}->getValue();
-					$compName = $component->name;
-
-					if ($stripAlarms) {
-						unset($component->{'VALARM'});
-					}
-					if ($stripAttachments) {
-						unset($component->{'ATTACH'});
-					}
-				}
-
-				if ($stripTodos && $compName === 'VTODO') {
-					continue;
-				}
-
-				$uri = $uid . '.ics';
-				$calendarData = $vObject->serialize();
-				try {
-					$this->calDavBackend->createCalendarObject($subscription['id'], $uri, $calendarData, CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION);
-				} catch(BadRequest $ex) {
-					$this->logger->logException($ex);
-				}
-			}
-
-			$newRefreshRate = $this->checkWebcalDataForRefreshRate($subscription, $webcalData);
-			if ($newRefreshRate) {
-				$mutations[self::REFRESH_RATE] = $newRefreshRate;
-			}
-
-			$this->updateSubscription($subscription, $mutations);
-		} catch(ParseException $ex) {
-			$subscriptionId = $subscription['id'];
-
-			$this->logger->logException($ex);
-			$this->logger->warning("Subscription $subscriptionId could not be refreshed due to a parsing error");
-		}
-	}
-
-	/**
-	 * gets webcal feed from remote server
-	 *
-	 * @param array $subscription
-	 * @param array &$mutations
-	 * @return null|string
-	 */
-	private function queryWebcalFeed(array $subscription, array &$mutations) {
-		$client = $this->clientService->newClient();
-
-		$didBreak301Chain = false;
-		$latestLocation = null;
-
-		$handlerStack = HandlerStack::create();
-		$handlerStack->push(Middleware::mapRequest(function (RequestInterface $request) {
-			return $request
-				->withHeader('Accept', 'text/calendar, application/calendar+json, application/calendar+xml')
-				->withHeader('User-Agent', 'Nextcloud Webcal Crawler');
-		}));
-		$handlerStack->push(Middleware::mapResponse(function(ResponseInterface $response) use (&$didBreak301Chain, &$latestLocation) {
-			if (!$didBreak301Chain) {
-				if ($response->getStatusCode() !== 301) {
-					$didBreak301Chain = true;
-				} else {
-					$latestLocation = $response->getHeader('Location');
-				}
-			}
-			return $response;
-		}));
-
-		$allowLocalAccess = $this->config->getAppValue('dav', 'webcalAllowLocalAccess', 'no');
-		$subscriptionId = $subscription['id'];
-		$url = $this->cleanURL($subscription['source']);
-		if ($url === null) {
-			return null;
-		}
-
-		if ($allowLocalAccess !== 'yes') {
-			$host = strtolower(parse_url($url, PHP_URL_HOST));
-			// remove brackets from IPv6 addresses
-			if (strpos($host, '[') === 0 && substr($host, -1) === ']') {
-				$host = substr($host, 1, -1);
-			}
-
-			// Disallow localhost and local network
-			if ($host === 'localhost' || substr($host, -6) === '.local' || substr($host, -10) === '.localhost') {
-				$this->logger->warning("Subscription $subscriptionId was not refreshed because it violates local access rules");
-				return null;
-			}
-
-			// Disallow hostname only
-			if (substr_count($host, '.') === 0) {
-				$this->logger->warning("Subscription $subscriptionId was not refreshed because it violates local access rules");
-				return null;
-			}
-
-			if ((bool)filter_var($host, FILTER_VALIDATE_IP) && !filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)) {
-				$this->logger->warning("Subscription $subscriptionId was not refreshed because it violates local access rules");
-				return null;
-			}
-
-			// Also check for IPv6 IPv4 nesting, because that's not covered by filter_var
-			if ((bool)filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) && substr_count($host, '.') > 0) {
-				$delimiter = strrpos($host, ':'); // Get last colon
-				$ipv4Address = substr($host, $delimiter + 1);
-
-				if (!filter_var($ipv4Address, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)) {
-					$this->logger->warning("Subscription $subscriptionId was not refreshed because it violates local access rules");
-					return null;
-				}
-			}
-		}
-
-		try {
-			$params = [
-				'allow_redirects' => [
-					'redirects' => 10
-				],
-				'handler' => $handlerStack,
-			];
-
-			$user = parse_url($subscription['source'], PHP_URL_USER);
-			$pass = parse_url($subscription['source'], PHP_URL_PASS);
-			if ($user !== null && $pass !== null) {
-				$params['auth'] = [$user, $pass];
-			}
-
-			$response = $client->get($url, $params);
-			$body = $response->getBody();
-
-			if ($latestLocation) {
-				$mutations['{http://calendarserver.org/ns/}source'] = new Href($latestLocation);
-			}
-
-			$contentType = $response->getHeader('Content-Type');
-			$contentType = explode(';', $contentType, 2)[0];
-			switch($contentType) {
-				case 'application/calendar+json':
-					try {
-						$jCalendar = Reader::readJson($body, Reader::OPTION_FORGIVING);
-					} catch(\Exception $ex) {
-						// In case of a parsing error return null
-						$this->logger->debug("Subscription $subscriptionId could not be parsed");
-						return null;
-					}
-					return $jCalendar->serialize();
-
-				case 'application/calendar+xml':
-					try {
-						$xCalendar = Reader::readXML($body);
-					} catch(\Exception $ex) {
-						// In case of a parsing error return null
-						$this->logger->debug("Subscription $subscriptionId could not be parsed");
-						return null;
-					}
-					return $xCalendar->serialize();
-
-				case 'text/calendar':
-				default:
-					try {
-						$vCalendar = Reader::read($body);
-					} catch(\Exception $ex) {
-						// In case of a parsing error return null
-						$this->logger->debug("Subscription $subscriptionId could not be parsed");
-						return null;
-					}
-					return $vCalendar->serialize();
-			}
-		} catch(\Exception $ex) {
-			$this->logger->logException($ex);
-			$this->logger->warning("Subscription $subscriptionId could not be refreshed due to a network error");
-
-			return null;
-		}
-	}
-
-	/**
-	 * loads subscription from backend
-	 *
-	 * @param string $principalUri
-	 * @param string $uri
-	 * @return array|null
-	 */
-	private function getSubscription(string $principalUri, string $uri) {
-		$subscriptions = array_values(array_filter(
-			$this->calDavBackend->getSubscriptionsForUser($principalUri),
-			function($sub) use ($uri) {
-				return $sub['uri'] === $uri;
-			}
-		));
-
-		if (\count($subscriptions) === 0) {
-			return null;
-		}
-
-		$this->subscription = $subscriptions[0];
-		return $this->subscription;
+		$this->refreshWebcalService->refreshSubscription($argument['principaluri'], $argument['uri']);
 	}
 
 	/**
 	 * get total number of seconds from DateInterval object
 	 *
-	 * @param \DateInterval $interval
+	 * @param DateInterval $interval
 	 * @return int
 	 */
-	private function getIntervalFromDateInterval(\DateInterval $interval):int {
+	private function getIntervalFromDateInterval(DateInterval $interval):int {
 		return $interval->s
 			+ ($interval->i * 60)
 			+ ($interval->h * 60 * 60)
@@ -373,103 +119,6 @@ class RefreshWebcalJob extends Job {
 	}
 
 	/**
-	 * check if:
-	 *  - current subscription stores a refreshrate
-	 *  - the webcal feed suggests a refreshrate
-	 *  - return suggested refreshrate if user didn't set a custom one
-	 *
-	 * @param array $subscription
-	 * @param string $webcalData
-	 * @return string|null
-	 */
-	private function checkWebcalDataForRefreshRate($subscription, $webcalData) {
-		// if there is no refreshrate stored in the database, check the webcal feed
-		// whether it suggests any refresh rate and store that in the database
-		if (isset($subscription[self::REFRESH_RATE]) && $subscription[self::REFRESH_RATE] !== null) {
-			return null;
-		}
-
-		/** @var Component\VCalendar $vCalendar */
-		$vCalendar = Reader::read($webcalData);
-
-		$newRefreshRate = null;
-		if (isset($vCalendar->{'X-PUBLISHED-TTL'})) {
-			$newRefreshRate = $vCalendar->{'X-PUBLISHED-TTL'}->getValue();
-		}
-		if (isset($vCalendar->{'REFRESH-INTERVAL'})) {
-			$newRefreshRate = $vCalendar->{'REFRESH-INTERVAL'}->getValue();
-		}
-
-		if (!$newRefreshRate) {
-			return null;
-		}
-
-		// check if new refresh rate is even valid
-		try {
-			DateTimeParser::parseDuration($newRefreshRate);
-		} catch(InvalidDataException $ex) {
-			return null;
-		}
-
-		return $newRefreshRate;
-	}
-
-	/**
-	 * update subscription stored in database
-	 * used to set:
-	 *  - refreshrate
-	 *  - source
-	 *
-	 * @param array $subscription
-	 * @param array $mutations
-	 */
-	private function updateSubscription(array $subscription, array $mutations) {
-		if (empty($mutations)) {
-			return;
-		}
-
-		$propPatch = new PropPatch($mutations);
-		$this->calDavBackend->updateSubscription($subscription['id'], $propPatch);
-		$propPatch->commit();
-	}
-
-	/**
-	 * This method will strip authentication information and replace the
-	 * 'webcal' or 'webcals' protocol scheme
-	 *
-	 * @param string $url
-	 * @return string|null
-	 */
-	private function cleanURL(string $url) {
-		$parsed = parse_url($url);
-		if ($parsed === false) {
-			return null;
-		}
-
-		if (isset($parsed['scheme']) && $parsed['scheme'] === 'http') {
-			$scheme = 'http';
-		} else {
-			$scheme = 'https';
-		}
-
-		$host = $parsed['host'] ?? '';
-		$port = isset($parsed['port']) ? ':' . $parsed['port'] : '';
-		$path = $parsed['path'] ?? '';
-		$query = isset($parsed['query']) ? '?' . $parsed['query'] : '';
-		$fragment = isset($parsed['fragment']) ? '#' . $parsed['fragment'] : '';
-
-		$cleanURL = "$scheme://$host$port$path$query$fragment";
-		// parse_url is giving some weird results if no url and no :// is given,
-		// so let's test the url again
-		$parsedClean = parse_url($cleanURL);
-		if ($parsedClean === false || !isset($parsedClean['host'])) {
-			return null;
-		}
-
-		return $cleanURL;
-	}
-
-	/**
 	 * Fixes types of rows
 	 *
 	 * @param array $row
@@ -478,9 +127,9 @@ class RefreshWebcalJob extends Job {
 		$forceInt = [
 			'id',
 			'lastmodified',
-			self::STRIP_ALARMS,
-			self::STRIP_ATTACHMENTS,
-			self::STRIP_TODOS,
+			RefreshWebcalService::STRIP_ALARMS,
+			RefreshWebcalService::STRIP_ATTACHMENTS,
+			RefreshWebcalService::STRIP_TODOS,
 		];
 
 		foreach($forceInt as $column) {