-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dav): introduce paginate with custom headers
Signed-off-by: Benjamin Gaussorgues <[email protected]>
- Loading branch information
Showing
7 changed files
with
247 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Paginate; | ||
|
|
||
| /** | ||
| * Save a copy of the first X items into a separate iterator | ||
| * | ||
| * This allows us to pass the iterator to the cache while keeping a copy | ||
| * of the required items. | ||
| * | ||
| * @extends \AppendIterator<int, int, \Iterator<int, int>> | ||
| */ | ||
| class LimitedCopyIterator extends \AppendIterator { | ||
| private array $skipped = []; | ||
| private array $copy = []; | ||
|
|
||
| public function __construct(\Traversable $iterator, int $count, int $offset = 0) { | ||
| parent::__construct(); | ||
|
|
||
| if (!$iterator instanceof \Iterator) { | ||
| $iterator = new \IteratorIterator($iterator); | ||
| } | ||
| $iterator = new \NoRewindIterator($iterator); | ||
|
|
||
| $i = 0; | ||
| while ($iterator->valid() && ++$i <= $offset) { | ||
| $this->skipped[] = $iterator->current(); | ||
| $iterator->next(); | ||
| } | ||
|
|
||
| while ($iterator->valid() && count($this->copy) < $count) { | ||
| $this->copy[] = $iterator->current(); | ||
| $iterator->next(); | ||
| } | ||
|
|
||
| $this->append(new \ArrayIterator($this->skipped)); | ||
| $this->append($this->getRequestedItems()); | ||
| $this->append($iterator); | ||
| } | ||
|
|
||
| public function getRequestedItems(): \Iterator { | ||
| return new \ArrayIterator($this->copy); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Paginate; | ||
|
|
||
| use Generator; | ||
| use OCP\DB\QueryBuilder\IQueryBuilder; | ||
| use OCP\ICache; | ||
| use OCP\ICacheFactory; | ||
| use OCP\IDBConnection; | ||
| use OCP\Security\ISecureRandom; | ||
|
|
||
| class PaginateCache { | ||
| public const TTL = 60 * 60; | ||
| private ICache $cache; | ||
|
|
||
| public function __construct( | ||
| private IDBConnection $database, | ||
| private ISecureRandom $random, | ||
| ICacheFactory $cacheFactory, | ||
| ) { | ||
| $this->cache = $cacheFactory->createDistributed('pagination_'); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $uri | ||
| * @param \Iterator $items | ||
| * @return array{'token': string, 'count': int} | ||
| */ | ||
| public function store(string $uri, \Iterator $items): array { | ||
| $token = $this->random->generate(32); | ||
| $cacheKey = $this->buildCacheKey($uri, $token); | ||
|
|
||
| $count = 0; | ||
| foreach ($items as $item) { | ||
| // Add small margin to avoid fetching valid count and then expired entries | ||
| $this->cache->set($cacheKey . $count, $item, self::TTL + 60); | ||
| ++$count; | ||
| } | ||
| $this->cache->set($cacheKey . 'count', $count, self::TTL); | ||
|
|
||
| return ['token' => $token, 'count' => $count]; | ||
| } | ||
|
|
||
| /** | ||
| * @return Generator<mixed> | ||
| */ | ||
| public function get(string $uri, string $token, int $offset, int $count): Generator { | ||
| $cacheKey = $this->buildCacheKey($uri, $token); | ||
| $nbItems = $this->cache->get($token . 'count'); | ||
| if (!$nbItems || $offset > $nbItems) { | ||
| return []; | ||
| } | ||
|
|
||
| $lastItem = min($nbItems, $offset + $count); | ||
| for ($i = $offset; $i < $lastItem; ++$i) { | ||
| yield $this->cache->get($token . $i); | ||
| } | ||
| } | ||
|
|
||
| public function exists(string $uri, string $token): bool { | ||
| return $this->cache->get($this->buildCacheKey($uri, $token) . '_count') > 0; | ||
| } | ||
|
|
||
| private function buildCacheKey(string $uri, string $token): string { | ||
| return $token . '_' . crc32($uri); | ||
| ; | ||
| } | ||
|
|
||
| public function cleanup(): void { | ||
| $now = $this->timeFactory->getDateTime(); | ||
| $minDate = $now->sub(\DateInterval::createFromDateString(self::TTL)); | ||
|
|
||
| $query = $this->database->getQueryBuilder(); | ||
| $query->delete('dav_page_cache') | ||
| ->where($query->expr()->lt('insert_time', $query->createNamedParameter($minDate, IQueryBuilder::PARAM_DATETIME_MUTABLE))); | ||
| $query->executeStatement(); | ||
| } | ||
|
|
||
| public function clear(): void { | ||
| $query = $this->database->getQueryBuilder(); | ||
| $query->delete('dav_page_cache'); | ||
| $query->executeStatement(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-only | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Paginate; | ||
|
|
||
| use Sabre\DAV\Server; | ||
| use Sabre\DAV\ServerPlugin; | ||
| use Sabre\HTTP\RequestInterface; | ||
| use Sabre\HTTP\ResponseInterface; | ||
|
|
||
| class PaginatePlugin extends ServerPlugin { | ||
| public const PAGINATE_HEADER = 'X-NC-Paginate'; | ||
| public const PAGINATE_TOTAL_HEADER = 'X-NC-Paginate-Total'; | ||
| public const PAGINATE_TOKEN_HEADER = 'X-NC-Paginate-Token'; | ||
| public const PAGINATE_OFFSET_HEADER = 'X-NC-Paginate-Offset'; | ||
| public const PAGINATE_COUNT_HEADER = 'X-NC-Paginate-Count'; | ||
|
|
||
| /** @var Server */ | ||
| private $server; | ||
|
|
||
| public function __construct( | ||
| private PaginateCache $cache, | ||
| private int $pageSize = 100, | ||
| ) { | ||
| } | ||
|
|
||
| public function initialize(Server $server): void { | ||
| $this->server = $server; | ||
| $server->on('beforeMultiStatus', [$this, 'onMultiStatus']); | ||
| $server->on('method:SEARCH', [$this, 'onMethod'], 1); | ||
| $server->on('method:PROPFIND', [$this, 'onMethod'], 1); | ||
| $server->on('method:REPORT', [$this, 'onMethod'], 1); | ||
| } | ||
|
|
||
| public function getFeatures(): array { | ||
| return ['nc-paginate']; | ||
| } | ||
|
|
||
| public function onMultiStatus(&$fileProperties): void { | ||
| $request = $this->server->httpRequest; | ||
| if (is_array($fileProperties)) { | ||
| $fileProperties = new \ArrayIterator($fileProperties); | ||
| } | ||
| $url = $request->getUrl(); | ||
| if ( | ||
| $request->hasHeader(self::PAGINATE_HEADER) && | ||
| (!$request->hasHeader(self::PAGINATE_TOKEN_HEADER) || !$this->cache->exists($url, $request->getHeader(self::PAGINATE_TOKEN_HEADER))) | ||
| ) { | ||
| $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); | ||
|
|
||
| $fileProperties = $copyIterator->getRequestedItems(); | ||
| $this->server->httpResponse->addHeader(self::PAGINATE_HEADER, 'true'); | ||
| $this->server->httpResponse->addHeader(self::PAGINATE_TOKEN_HEADER, $token); | ||
| $this->server->httpResponse->addHeader(self::PAGINATE_TOTAL_HEADER, (string)$count); | ||
| $request->setHeader(self::PAGINATE_TOKEN_HEADER, $token); | ||
| } | ||
| } | ||
|
|
||
| public function onMethod(RequestInterface $request, ResponseInterface $response) { | ||
| $url = $this->server->httpRequest->getUrl(); | ||
| if ( | ||
| $request->hasHeader(self::PAGINATE_TOKEN_HEADER) && | ||
| $request->hasHeader(self::PAGINATE_OFFSET_HEADER) && | ||
| $this->cache->exists($url, $request->getHeader(self::PAGINATE_TOKEN_HEADER)) | ||
| ) { | ||
| $token = $request->getHeader(self::PAGINATE_TOKEN_HEADER); | ||
| $offset = (int)$request->getHeader(self::PAGINATE_OFFSET_HEADER); | ||
| $count = (int)$request->getHeader(self::PAGINATE_COUNT_HEADER) ?: $this->pageSize; | ||
|
|
||
| $items = $this->cache->get($url, $token, $offset, $count); | ||
|
|
||
| $response->setStatus(207); | ||
| $response->addHeader(self::PAGINATE_HEADER, 'true'); | ||
| $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); | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters