Merge pull request #56180 from nextcloud/backport/56035/stable31

[stable31] fix(pagination): render multistatus to XML before caching

Author: salmart-dev

apps/dav/lib/Paginate/PaginatePlugin.php

@@ -11,6 +11,7 @@
 
 use Sabre\DAV\Server;
 use Sabre\DAV\ServerPlugin;
+use Sabre\DAV\Xml\Element\Response;
 use Sabre\HTTP\RequestInterface;
 use Sabre\HTTP\ResponseInterface;
 
@@ -54,8 +55,13 @@ public function onMultiStatus(&$fileProperties): void {
 		) {
 			$pageSize = (int)$request->getHeader(self::PAGINATE_COUNT_HEADER) ?: $this->pageSize;
 			$offset = (int)$request->getHeader(self::PAGINATE_OFFSET_HEADER);
+
 			$copyIterator = new LimitedCopyIterator($fileProperties, $pageSize, $offset);
-			['token' => $token, 'count' => $count] = $this->cache->store($url, $copyIterator);
+			// wrap the iterator with another that renders XML, this way we
+			// cache XML, but we keep the first $pageSize elements as objects
+			// to use for the response of the first page.
+			$rendererGenerator = $this->getXmlRendererGenerator($copyIterator);
+			['token' => $token, 'count' => $count] = $this->cache->store($url, $rendererGenerator);
 
 			$fileProperties = $copyIterator->getRequestedItems();
 			$this->server->httpResponse->addHeader(self::PAGINATE_HEADER, 'true');
@@ -65,6 +71,44 @@ public function onMultiStatus(&$fileProperties): void {
 		}
 	}
 
+	/**
+	 * Returns a generator that yields rendered XML entries for the provided
+	 * $fileProperties, as they would appear in the MultiStatus response.
+	 */
+	private function getXmlRendererGenerator(iterable $fileProperties): \Generator {
+		$writer = $this->server->xml->getWriter();
+		$prefer = $this->server->getHTTPPrefer();
+		$minimal = $prefer['return'] === 'minimal';
+		$writer->contextUri = $this->server->getBaseUri();
+
+		$writer->openMemory();
+		$writer->startDocument();
+		$writer->startElement('{DAV:}multistatus');
+
+		// throw away the beginning of the document
+		$writer->flush();
+
+		foreach ($fileProperties as $entry) {
+			$href = $entry['href'];
+			unset($entry['href']);
+			if ($minimal) {
+				unset($entry[404]);
+			}
+			$response = new Response(
+				ltrim($href, '/'),
+				$entry
+			);
+			$writer->write([
+				'name' => '{DAV:}response',
+				'value' => $response,
+			]);
+
+			// flushing does not remove the > for the previous element
+			// (multistatus)
+			yield ltrim($writer->flush(), '>');
+		}
+	}
+
 	public function onMethod(RequestInterface $request, ResponseInterface $response) {
 		$url = $this->server->httpRequest->getUrl();
 		if (
@@ -83,11 +127,20 @@ public function onMethod(RequestInterface $request, ResponseInterface $response)
 			$response->setHeader('Content-Type', 'application/xml; charset=utf-8');
 			$response->setHeader('Vary', 'Brief,Prefer');
 
-			$prefer = $this->server->getHTTPPrefer();
-			$minimal = $prefer['return'] === 'minimal';
-
-			$data = $this->server->generateMultiStatus($items, $minimal);
-			$response->setBody($data);
+			// as we cached strings of XML, rebuild the multistatus response
+			// and output the RAW entries, as stored in the cache
+			$writer = $this->server->xml->getWriter();
+			$writer->contextUri = $this->server->getBaseUri();
+			$writer->openMemory();
+			$writer->startDocument();
+			$writer->startElement('{DAV:}multistatus');
+			foreach ($items as $item) {
+				$writer->writeRaw($item);
+			}
+			$writer->endElement();
+			$writer->endDocument();
+
+			$response->setBody($writer->flush());
 
 			return false;
 		}