From 5486a2b14985ee5ea7a971e42f1aa94e51a3a4b3 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Mon, 8 Feb 2016 11:55:07 +0100 Subject: [PATCH] For possible future usage allow multiple checksums Instead of returning TYPE:CHECKSUM Return TYPE:CHECKSUM This will allow us to expand in the future to multiple checksums. Without doing just string concatenation. And even for a single checksum it is now correct. --- apps/dav/lib/connector/sabre/checksumlist.php | 71 +++++++++++++++++++ apps/dav/lib/connector/sabre/filesplugin.php | 12 ++-- 2 files changed, 75 insertions(+), 8 deletions(-) create mode 100644 apps/dav/lib/connector/sabre/checksumlist.php diff --git a/apps/dav/lib/connector/sabre/checksumlist.php b/apps/dav/lib/connector/sabre/checksumlist.php new file mode 100644 index 0000000000..f137222acc --- /dev/null +++ b/apps/dav/lib/connector/sabre/checksumlist.php @@ -0,0 +1,71 @@ + + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see + * + */ +namespace OCA\DAV\Connector\Sabre; + +use Sabre\Xml\XmlSerializable; +use Sabre\Xml\Element; +use Sabre\Xml\Writer; + +/** + * Checksumlist property + * + * This property contains multiple "checksum" elements, each containing a + * checksum name. + */ +class ChecksumList implements XmlSerializable { + const NS_OWNCLOUD = 'http://owncloud.org/ns'; + + /** @var string[] of TYPE:CHECKSUM */ + private $checksums; + + /** + * @param string $checksum + */ + public function __construct($checksum) { + $this->checksums = explode(',', $checksum); + } + + /** + * The xmlSerialize metod is called during xml writing. + * + * Use the $writer argument to write its own xml serialization. + * + * An important note: do _not_ create a parent element. Any element + * implementing XmlSerializble should only ever write what's considered + * its 'inner xml'. + * + * The parent of the current element is responsible for writing a + * containing element. + * + * This allows serializers to be re-used for different element names. + * + * If you are opening new elements, you must also close them again. + * + * @param Writer $writer + * @return void + */ + function xmlSerialize(Writer $writer) { + + foreach ($this->checksums as $checksum) { + $writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); + } + } +} diff --git a/apps/dav/lib/connector/sabre/filesplugin.php b/apps/dav/lib/connector/sabre/filesplugin.php index 82d0001490..2e913ee107 100644 --- a/apps/dav/lib/connector/sabre/filesplugin.php +++ b/apps/dav/lib/connector/sabre/filesplugin.php @@ -47,7 +47,7 @@ class FilesPlugin extends \Sabre\DAV\ServerPlugin { 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 CHECKSUM_PROPERTYNAME = '{http://owncloud.org/ns}checksum'; + const CHECKSUMS_PROPERTYNAME = '{http://owncloud.org/ns}checksums'; /** * Reference to main server object @@ -108,7 +108,7 @@ class FilesPlugin extends \Sabre\DAV\ServerPlugin { $server->protectedProperties[] = self::DOWNLOADURL_PROPERTYNAME; $server->protectedProperties[] = self::OWNER_ID_PROPERTYNAME; $server->protectedProperties[] = self::OWNER_DISPLAY_NAME_PROPERTYNAME; - $server->protectedProperties[] = self::CHECKSUM_PROPERTYNAME; + $server->protectedProperties[] = self::CHECKSUMS_PROPERTYNAME; // normally these cannot be changed (RFC4918), but we want them modifiable through PROPPATCH $allowedProperties = ['{DAV:}getetag']; @@ -248,13 +248,9 @@ class FilesPlugin extends \Sabre\DAV\ServerPlugin { return false; }); - $propFind->handle(self::CHECKSUM_PROPERTYNAME, function() use ($node) { + $propFind->handle(self::CHECKSUMS_PROPERTYNAME, function() use ($node) { $checksum = $node->getChecksum(); - - if ($checksum === null) { - return ''; - } - return $checksum; + return new ChecksumList($checksum); }); }