Implementation of delta-sync support on server-side. #29404
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,147 @@ | ||
| <?php | ||
| /* | ||
| * Copyright (C) by Ahmed Ammar <ahmed.a.ammar@gmail.com> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to | ||
| * permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
| * Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
| * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| * | ||
| */ | ||
| namespace OCA\DAV\Files; | ||
|
|
||
| use OC\AppFramework\Http; | ||
| use OCP\Files\NotFoundException; | ||
| use OCP\Files\NotPermittedException; | ||
| use Sabre\DAV\Server; | ||
| use Sabre\DAV\ServerPlugin; | ||
| use Sabre\DAV\PropFind; | ||
| use Sabre\HTTP\RequestInterface; | ||
| use Sabre\HTTP\ResponseInterface; | ||
| use OC\Files\View; | ||
| use \Exception; | ||
|
|
||
| class ZsyncPlugin extends ServerPlugin { | ||
|
|
||
| // namespace | ||
| const ZSYNC_PROPERTYNAME = '{http://owncloud.org/ns}zsync'; | ||
|
|
||
| /** @var OC\Files\View */ | ||
| private $view; | ||
|
|
||
| public function __construct(View $view) { | ||
| $this->view = $view; | ||
| $this->view->mkdir('files_zsync'); | ||
| } | ||
|
|
||
| /** | ||
| * Initializes the plugin and registers event handlers | ||
| * | ||
| * @param Server $server | ||
| * @return void | ||
| */ | ||
| function initialize(Server $server) { | ||
| $server->on('method:GET', [$this, 'httpGet'], 90); | ||
| $server->on('method:DELETE', [$this, 'httpDelete'], 90); | ||
| $server->on('propFind', [$this, 'handleGetProperties']); | ||
| } | ||
|
|
||
| /** | ||
| * Intercepts GET requests on file urls ending with ?zsync. | ||
| * | ||
| * @param RequestInterface $request | ||
| * @param ResponseInterface $response | ||
| */ | ||
| function httpGet(RequestInterface $request, ResponseInterface $response) { | ||
|
|
||
| $queryParams = $request->getQueryParameters(); | ||
| if (!array_key_exists('zsync', $queryParams)) { | ||
| return true; | ||
| } | ||
|
|
||
| $path = ltrim($request->getPath(), '/'); | ||
| /* remove files/$user */ | ||
| $path = implode('/', array_slice(explode('/', $path), 2)); | ||
| /* If basefile not found this is an error */ | ||
| if (!$this->view->file_exists('files/'.$path)) { | ||
| $response->setStatus(Http::STATUS_NOT_FOUND); | ||
| return false; | ||
| } | ||
|
|
||
| $info = $this->view->getFileInfo('files/'.$path); | ||
| $zsyncMetadataFile = 'files_zsync/'.$info->getId(); | ||
| if ($this->view->file_exists($zsyncMetadataFile)) { | ||
| $content = $this->view->file_get_contents($zsyncMetadataFile); | ||
| $response->setHeader('OC-ETag', $info->getEtag()); | ||
| $response->setStatus(Http::STATUS_OK); | ||
| $response->setBody($content); | ||
| } else { | ||
| $response->setStatus(Http::STATUS_NOT_FOUND); | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Intercepts DELETE requests on file urls ending with ?zsync. | ||
| * | ||
| * @param RequestInterface $request | ||
| * @param ResponseInterface $response | ||
| */ | ||
| function httpDelete(RequestInterface $request, ResponseInterface $response) { | ||
|
Contributor
There was a problem hiding this comment. I would love to see at some point some relations here.. without integrity contraints it can be a mess and corruption on corruption. I need to test what happens when I terminate script in very bad moment. |
||
|
|
||
| $queryParams = $request->getQueryParameters(); | ||
| if (!array_key_exists('zsync', $queryParams)) { | ||
| return true; | ||
| } | ||
|
|
||
| $path = ltrim($request->getPath(), '/'); | ||
| /* remove files/$user */ | ||
| $path = implode('/', array_slice(explode('/', $path), 2)); | ||
| /* If basefile not found this is an error */ | ||
| if (!$this->view->file_exists('files/'.$path)) { | ||
| $response->setStatus(Http::STATUS_NOT_FOUND); | ||
| return false; | ||
| } | ||
|
|
||
| $info = $this->view->getFileInfo('files/'.$path); | ||
| $zsyncMetadataFile = 'files_zsync/'.$info->getId(); | ||
| if ($this->view->file_exists($zsyncMetadataFile)) { | ||
| $this->view->unlink($zsyncMetadataFile); | ||
| $response->setStatus(Http::STATUS_OK); | ||
| } else { | ||
| $response->setStatus(Http::STATUS_NOT_FOUND); | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Adds zsync property if metadata exists | ||
| * | ||
| * @param PropFind $propFind | ||
| * @param \Sabre\DAV\INode $node | ||
| * @return void | ||
| */ | ||
| public function handleGetProperties(PropFind $propFind, \Sabre\DAV\INode $node) { | ||
| if ($node instanceof \OCA\DAV\Connector\Sabre\File) { | ||
| if (!$this->view->is_file('files/'.$node->getPath())) | ||
| return; | ||
| $info = $this->view->getFileInfo('files/'.$node->getPath()); | ||
| $zsyncMetadataFile = 'files_zsync/'.$info->getId(); | ||
| if ($this->view->file_exists($zsyncMetadataFile)) { | ||
| $propFind->handle(self::ZSYNC_PROPERTYNAME, function() use ($node) { | ||
| return 'true'; | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, it is just style thing probably, but I think in the rest of the codebase we use ||. @DeepDiver1975 .
About logic - makes sense as it is a similar scenario as in chunking.