* * @author Jonathan Treffler * @author Thomas Müller * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OCA\DavPush\Dav; use OCA\DavPush\Transport\TransportManager; use OCA\DavPush\Db\Subscription; use OCA\DavPush\Db\SubscriptionMapper; use OCP\IUserSession; use OCP\IURLGenerator; use OCP\AppFramework\Http; use Sabre\DAV\Server; use Sabre\DAV\ServerPlugin; use Sabre\HTTP\RequestInterface; use Sabre\HTTP\ResponseInterface; class SubscriptionManagementPlugin extends ServerPlugin { public const PUSH_PREFIX = '{DAV:Push}'; public const PUSH_REGISTER = self::PUSH_PREFIX . "push-register"; public const PUSH_SUBSCRIPTION = self::PUSH_PREFIX . "subscription"; public const PUSH_EXPIRES = self::PUSH_PREFIX . "expires"; public const IMF_FIXDATE_FORMAT = "D, d M Y H:i:s O+"; /** * Reference to SabreDAV server object. * * @var \Sabre\DAV\Server */ protected $server; public function __construct( private IUserSession $userSession, private TransportManager $transportManager, private IURLGenerator $URLGenerator, private SubscriptionMapper $subscriptionMapper, private $userId, ) { } public function initialize(Server $server): void { $this->server = $server; $this->server->on('method:POST', [$this, 'httpPost']); } public function httpPost(RequestInterface $request, ResponseInterface $response) { // Only handle xml $contentType = (string) $request->getHeader('Content-Type'); if (!(str_contains($contentType, 'application/xml') || str_contains($contentType, 'text/xml'))) { return; } $node = $this->server->tree->getNodeForPath($this->server->getRequestUri()); $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); $parameters = $this->server->xml->parse($requestBody, $request->getUrl(), $documentType); if($documentType == self::PUSH_REGISTER) { $errors = []; $subscriptionParameterIncluded = False; $subscriptionType = ""; $subscriptionOptions = []; $subscriptionExpires = False; foreach($parameters as $parameter) { if($parameter["name"] == self::PUSH_SUBSCRIPTION && !$subscriptionParameterIncluded) { $subscriptionParameterIncluded = True; if(sizeof($parameter["value"]) == 1) { $subscriptionType = $parameter["value"][0]["name"]; $subscriptionOptions = $parameter["value"][0]["value"]; } else { $errors[] = "only one subscription allowed"; } } elseif($parameter["name"] == self::PUSH_EXPIRES && !$subscriptionExpires) { $subscriptionExpires = \DateTime::createFromFormat(self::IMF_FIXDATE_FORMAT, $parameter["value"]); } } if(!$subscriptionParameterIncluded) { $errors[] = "no subscription included"; } $transport = $this->transportManager->getTransport(preg_replace('/^\{DAV:Push\}/', '', $subscriptionType)); if($transport === null) { $errors[] = $subscriptionType . " transport does not exist"; } [ 'success' => $registerSuccess, 'error' => $registerError, 'responseStatus' => $responseStatus, 'response' => $responseContent, 'unsubscribeLink' => $unsubscribeLink, 'data' => $data ] = $transport->registerSubscription($subscriptionOptions); $responseStatus = $responseStatus ?? Http::STATUS_CREATED; $data = $data ?? False; if(!$registerSuccess) { $errors[] = $registerError; } if(sizeof($errors) == 0) { $response->setStatus($responseStatus); // create subscription entry in db $subscription = new Subscription(); $subscription->setUserId($this->userId); $subscription->setCollectionName($node->getName()); $subscription->setCreationTimestamp(time()); if(!$subscriptionExpires) { $subscription->setExpirationTimestamp(0); } else { $subscription->setExpirationTimestamp($subscriptionExpires->getTimestamp()); } $subscription->setData(json_encode($data)); $subscription = $this->subscriptionMapper->insert($subscription); // generate default unsubscribe link, unless transport requested a custom url $unsubscribeLink = $unsubscribeLink ?? $this->URLGenerator->getAbsoluteURL("/apps/dav_push/subscriptions/" . $subscription->getId()); $response->setHeader("Location", $unsubscribeLink); $xml = $this->server->xml->write(self::PUSH_REGISTER, $responseContent); $response->setBody($xml); } else { $response->setStatus(Http::STATUS_BAD_REQUEST); $errorsXML = []; foreach($errors as $error) { $errorsXML[] = [ "name" => "error", "value" => $error ]; } $xml = $this->server->xml->write( '{DAV:}error', $errorsXML ); $response->setBody($xml); } return false; } } }