]> source.dussan.org Git - nextcloud-server.git/commitdiff
For possible future usage allow multiple checksums
authorRoeland Jago Douma <rullzer@owncloud.com>
Mon, 8 Feb 2016 10:55:07 +0000 (11:55 +0100)
committerRoeland Jago Douma <rullzer@owncloud.com>
Mon, 8 Feb 2016 10:55:07 +0000 (11:55 +0100)
Instead of returning

<oc:checksum>TYPE:CHECKSUM</oc:checksum>

Return

<oc:checksums>
  <oc:checksum>TYPE:CHECKSUM</oc:checksum>
</oc:checksums>

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 [new file with mode: 0644]
apps/dav/lib/connector/sabre/filesplugin.php

diff --git a/apps/dav/lib/connector/sabre/checksumlist.php b/apps/dav/lib/connector/sabre/checksumlist.php
new file mode 100644 (file)
index 0000000..f137222
--- /dev/null
@@ -0,0 +1,71 @@
+<?php
+/**
+ * @author Roeland Jago Douma <rullzer@owncloud.com>
+ *
+ * @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 <http://www.gnu.org/licenses/>
+ *
+ */
+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);
+               }
+       }
+}
index 82d0001490507386075994970325bee11684d84b..2e913ee1077b089113b17b9890049dad5b5a752c 100644 (file)
@@ -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);
                        });
 
                }