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
1 parent
d013a13
commit 582f9ee
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,26 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\BackgroundJob; | ||
|
|
||
| use OCA\DAV\Paginate\PaginateCache; | ||
| use OCP\BackgroundJob\Job; | ||
|
|
||
| class CleanupPaginateCacheJob extends Job { | ||
| /** @var PaginateCache */ | ||
| private $cache; | ||
|
|
||
| public function __construct(PaginateCache $cache) { | ||
| $this->cache = $cache; | ||
| } | ||
|
|
||
| public function run($argument): void { | ||
| $this->cache->cleanup(); | ||
| } | ||
| } |
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,63 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Migration; | ||
|
|
||
| use OCP\DB\ISchemaWrapper; | ||
| use OCP\DB\Types; | ||
| use OCP\Migration\IOutput; | ||
| use OCP\Migration\SimpleMigrationStep; | ||
|
|
||
| class Version1032Date20241011093632 extends SimpleMigrationStep { | ||
| public function name(): string { | ||
| return 'Add dav_page_cache table'; | ||
| } | ||
|
|
||
| public function description(): string { | ||
| return 'Add table to cache webdav multistatus responses for pagination purpose'; | ||
| } | ||
|
|
||
| public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { | ||
| /** @var ISchemaWrapper $schema */ | ||
| $schema = $schemaClosure(); | ||
|
|
||
| if (!$schema->hasTable('dav_page_cache')) { | ||
| $table = $schema->createTable('dav_page_cache'); | ||
|
|
||
| $table->addColumn('id', Types::BIGINT, [ | ||
| 'autoincrement' => true | ||
| ]); | ||
| $table->addColumn('url_hash', Types::STRING, [ | ||
| 'notnull' => true, | ||
| 'length' => 32, | ||
| ]); | ||
| $table->addColumn('token', Types::STRING, [ | ||
| 'notnull' => true, | ||
| 'length' => 32 | ||
| ]); | ||
| $table->addColumn('result_index', Types::INTEGER, [ | ||
| 'notnull' => true | ||
| ]); | ||
| $table->addColumn('result_value', Types::TEXT, [ | ||
| 'notnull' => false, | ||
| ]); | ||
| $table->addColumn('insert_time', Types::DATETIME, [ | ||
| 'notnull' => true, | ||
| ]); | ||
|
|
||
| $table->setPrimaryKey(['id'], 'dav_page_cache_id_index'); | ||
| $table->addIndex(['token', 'url_hash'], 'dav_page_cache_token_url'); | ||
| $table->addUniqueIndex(['token', 'url_hash', 'result_index'], 'dav_page_cache_url_index'); | ||
| $table->addIndex(['result_index'], 'dav_page_cache_index'); | ||
| $table->addIndex(['insert_time'], 'dav_page_cache_time'); | ||
| } | ||
|
|
||
| return $schema; | ||
| } | ||
| } |
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,42 @@ | ||
| <?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 first X items | ||
| */ | ||
| class LimitedCopyIterator extends \AppendIterator { | ||
|
Check failure on line 18 in apps/dav/lib/Paginate/LimitedCopyIterator.php
|
||
| /** @var array */ | ||
| private array $copy = []; | ||
|
|
||
| public function __construct(\Traversable $iterator, int $count) { | ||
| parent::__construct(); | ||
|
|
||
| if (!$iterator instanceof \Iterator) { | ||
| $iterator = new \IteratorIterator($iterator); | ||
| } | ||
| $iterator = new \NoRewindIterator($iterator); | ||
|
|
||
| while ($iterator->valid() && count($this->copy) < $count) { | ||
| $this->copy[] = $iterator->current(); | ||
| $iterator->next(); | ||
| } | ||
|
|
||
| $this->append($this->getFirstItems()); | ||
| $this->append($iterator); | ||
| } | ||
|
|
||
| public function getFirstItems(): \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,94 @@ | ||
| <?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 OCP\AppFramework\Utility\ITimeFactory; | ||
| use OCP\DB\QueryBuilder\IQueryBuilder; | ||
| use OCP\IDBConnection; | ||
| use OCP\Security\ISecureRandom; | ||
|
|
||
| class PaginateCache { | ||
| public const TTL = 3600; | ||
|
|
||
| public function __construct( | ||
| private IDBConnection $database, | ||
| private ISecureRandom $random, | ||
| private ITimeFactory $timeFactory, | ||
| ) { | ||
| } | ||
|
|
||
| /** | ||
| * @param string $uri | ||
| * @param \Iterator $items | ||
| * @return array{'token': int, 'count': int} | ||
|
Check failure on line 30 in apps/dav/lib/Paginate/PaginateCache.php
|
||
| */ | ||
| public function store(string $uri, \Iterator $items): array { | ||
| $token = $this->random->generate(32); | ||
| $now = $this->timeFactory->getTime(); | ||
|
|
||
| $query = $this->database->getQueryBuilder(); | ||
| $query->insert('dav_page_cache') | ||
| ->values([ | ||
| 'url_hash' => $query->createNamedParameter(md5($uri), IQueryBuilder::PARAM_STR), | ||
| 'token' => $query->createNamedParameter($token, IQueryBuilder::PARAM_STR), | ||
| 'insert_time' => $query->createNamedParameter($now, IQueryBuilder::PARAM_INT), | ||
| 'result_index' => $query->createParameter('index'), | ||
| 'result_value' => $query->createParameter('value'), | ||
| ]); | ||
|
|
||
| $count = 0; | ||
| foreach ($items as $item) { | ||
| $value = json_encode($item); | ||
| $query->setParameter('index', $count, IQueryBuilder::PARAM_INT); | ||
| $query->setParameter('value', $value); | ||
| $query->executeStatement(); | ||
| $count++; | ||
| } | ||
|
|
||
| return [$token, $count]; | ||
|
Check failure on line 55 in apps/dav/lib/Paginate/PaginateCache.php
|
||
| } | ||
|
|
||
| /** | ||
| * @param string $url | ||
| * @param string $token | ||
| * @param int $offset | ||
| * @param int $count | ||
| * @return array|\Traversable | ||
| */ | ||
| public function get(string $url, string $token, int $offset, int $count) { | ||
| $query = $this->database->getQueryBuilder(); | ||
| $query->select(['result_value']) | ||
| ->from('dav_page_cache') | ||
| ->where($query->expr()->eq('token', $query->createNamedParameter($token))) | ||
| ->andWhere($query->expr()->eq('url_hash', $query->createNamedParameter(md5($url)))) | ||
| ->andWhere($query->expr()->gte('result_index', $query->createNamedParameter($offset, IQueryBuilder::PARAM_INT))) | ||
| ->andWhere($query->expr()->lt('result_index', $query->createNamedParameter($offset + $count, IQueryBuilder::PARAM_INT))); | ||
|
|
||
| $result = $query->executeQuery(); | ||
| return array_map(function (string $entry) { | ||
| return json_decode($entry, true); | ||
| }, $result->fetchAll(\PDO::FETCH_COLUMN)); | ||
| } | ||
|
|
||
| public function cleanup(): void { | ||
| $now = $this->timeFactory->getTime(); | ||
|
|
||
| $query = $this->database->getQueryBuilder(); | ||
| $query->delete('dav_page_cache') | ||
| ->where($query->expr()->lt('insert_time', $query->createNamedParameter($now - self::TTL))); | ||
| $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,92 @@ | ||
| <?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); | ||
| } | ||
| if ( | ||
| $request->hasHeader(self::PAGINATE_HEADER) && | ||
| !$request->hasHeader(self::PAGINATE_TOKEN_HEADER) | ||
| ) { | ||
| $url = $request->getUrl(); | ||
|
|
||
| $pageSize = (int)$request->getHeader(self::PAGINATE_COUNT_HEADER) ?: $this->pageSize; | ||
| $copyIterator = new LimitedCopyIterator($fileProperties, $pageSize); | ||
| ['token' => $token, 'count' => $count] = $this->cache->store($url, $copyIterator); | ||
|
|
||
| $fileProperties = $copyIterator->getFirstItems(); | ||
| $this->server->httpResponse->addHeader(self::PAGINATE_HEADER, 'true'); | ||
| $this->server->httpResponse->addHeader(self::PAGINATE_TOKEN_HEADER, $token); | ||
|
Check failure on line 62 in apps/dav/lib/Paginate/PaginatePlugin.php
|
||
| $this->server->httpResponse->addHeader(self::PAGINATE_TOTAL_HEADER, $count); | ||
|
Check failure on line 63 in apps/dav/lib/Paginate/PaginatePlugin.php
|
||
| } | ||
| } | ||
|
|
||
| public function onMethod(RequestInterface $request, ResponseInterface $response) { | ||
| if ( | ||
| $request->hasHeader(self::PAGINATE_TOKEN_HEADER) && | ||
| $request->hasHeader(self::PAGINATE_OFFSET_HEADER) | ||
| ) { | ||
| $url = $this->server->httpRequest->getUrl(); | ||
| $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; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.