-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Louis Chemineau <[email protected]>
- Loading branch information
Showing
15 changed files
with
952 additions
and
1,949 deletions.
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,101 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2021, Louis Chemineau <[email protected]> | ||
| * | ||
| * @author Louis Chemineau <[email protected]> | ||
| * | ||
| * @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\BulkUpload; | ||
|
|
||
| use Psr\Log\LoggerInterface; | ||
| use Sabre\DAV\ServerPlugin; | ||
| use Sabre\HTTP\RequestInterface; | ||
| use Sabre\HTTP\ResponseInterface; | ||
| use Sabre\DAV\Exception\BadRequest; | ||
| use Sabre\DAV\Exception\Forbidden; | ||
| use OCP\Files\Folder; | ||
| use OCP\AppFramework\Http; | ||
|
|
||
| class BulkUploadPlugin extends ServerPlugin { | ||
|
|
||
| /** @var Folder */ | ||
| private $userFolder; | ||
|
|
||
| /** @var LoggerInterface */ | ||
| private $logger; | ||
|
|
||
| public function __construct(Folder $userFolder, LoggerInterface $logger) { | ||
| $this->userFolder = $userFolder; | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| /** | ||
| * Register listener on POST requests with the handleBundle method. | ||
| * | ||
| * @param \Sabre\DAV\Server $server | ||
| */ | ||
| public function initialize(\Sabre\DAV\Server $server): void { | ||
| $server->on('method:POST', [$this, 'handleBundle']); | ||
| } | ||
|
|
||
| /** | ||
| * Handle POST requests on /dav/files/bundle | ||
| * - parsing is done with a MultipartContentsParser object | ||
| * - writing is done with the userFolder service | ||
| * - files content are checked against the submitted md5 hash | ||
| * | ||
| * Will respond with an object containing the write status of every files. | ||
| * | ||
| * @throws BadRequest | ||
| * @throws Forbidden | ||
| */ | ||
| public function handleBundle(RequestInterface $request, ResponseInterface $response): bool { | ||
| // Limit bundle upload to the /dav/files/bundle endpoint | ||
| if ($request->getPath() !== "files/bundle") { | ||
| return true; | ||
| } | ||
|
|
||
| $multiPartParser = new MultipartRequestParser($request); | ||
| $writtenFiles = []; | ||
|
|
||
| while (!$multiPartParser->isAtLastBoundary()) { | ||
| try { | ||
| [$headers, $content] = $multiPartParser->parseNextPart(); | ||
| } catch (\Exception $e) { | ||
| // Return early if an error occurs during parsing. | ||
| $this->logger->error($e->getMessage()); | ||
| $response->setStatus(400); | ||
| $response->setBody(json_encode($writtenFiles)); | ||
| return false; | ||
| } | ||
|
|
||
| try { | ||
| $node = $this->userFolder->newFile($headers['x-file-path'], $content); | ||
| $writtenFiles[$headers['x-file-path']] = $node->getETag(); | ||
| } catch (\Exception $e) { | ||
| $this->logger->error($e->getMessage(), ['path' => $headers['x-file-path']]); | ||
| $writtenFiles[$headers['x-file-path']] = $e->getMessage(); | ||
| } | ||
| } | ||
|
|
||
| $response->setStatus(Http::STATUS_OK); | ||
| $response->setBody(json_encode($writtenFiles)); | ||
|
|
||
| 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,226 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2021, Louis Chemineau <[email protected]> | ||
| * | ||
| * @author Louis Chemineau <[email protected]> | ||
| * | ||
| * @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\BulkUpload; | ||
|
|
||
| use Sabre\HTTP\RequestInterface; | ||
| use Sabre\DAV\Exception; | ||
| use Sabre\DAV\Exception\BadRequest; | ||
| use Sabre\DAV\Exception\LengthRequired; | ||
|
|
||
| class MultipartRequestParser { | ||
|
|
||
| /** @var resource */ | ||
| private $stream; | ||
|
|
||
| /** @var string */ | ||
| private $boundary = ""; | ||
|
|
||
| /** @var string */ | ||
| private $lastBoundary = ""; | ||
|
|
||
| /** | ||
| * @throws BadRequest | ||
| */ | ||
| public function __construct(RequestInterface $request) { | ||
| $stream = $request->getBody(); | ||
| $contentType = $request->getHeader('Content-Type'); | ||
|
|
||
| if (gettype($stream) !== 'resource') { | ||
| throw new BadRequest('Body should be of type resource'); | ||
| } | ||
|
|
||
| if ($contentType === null) { | ||
| throw new BadRequest("Content-Type can not be null"); | ||
| } | ||
|
|
||
| $this->stream = $stream; | ||
|
|
||
| $boundary = $this->parseBoundaryFromHeaders($contentType); | ||
| $this->boundary = '--'.$boundary."\r\n"; | ||
| $this->lastBoundary = '--'.$boundary."--\r\n"; | ||
| } | ||
|
|
||
| /** | ||
| * Parse the boundary from the Content-Type header. | ||
| * Example: Content-Type: "multipart/related; boundary=boundary_bf38b9b4b10a303a28ed075624db3978" | ||
| * | ||
| * @throws BadRequest | ||
| */ | ||
| private function parseBoundaryFromHeaders(string $contentType): string { | ||
| [$mimeType, $boundary] = explode(';', $contentType); | ||
| [$boundaryKey, $boundaryValue] = explode('=', $boundary); | ||
| $boundaryValue = trim($boundaryValue); | ||
|
|
||
| // Remove potential quotes around boundary value. | ||
| if (substr($boundaryValue, 0, 1) == '"' && substr($boundaryValue, -1) == '"') { | ||
| $boundaryValue = substr($boundaryValue, 1, -1); | ||
| } | ||
|
|
||
| if (trim($mimeType) !== 'multipart/related') { | ||
| throw new BadRequest('Content-Type must be multipart/related'); | ||
| } | ||
|
|
||
| if (trim($boundaryKey) !== 'boundary') { | ||
| throw new BadRequest('Boundary is invalid'); | ||
| } | ||
|
|
||
| return $boundaryValue; | ||
| } | ||
|
|
||
| /** | ||
| * Check wether the stream's cursor is seating right before the provided string. | ||
| * | ||
| * @throws Exception | ||
| */ | ||
| private function isAt(string $content): bool { | ||
| $contentLength = strlen($content); | ||
|
|
||
| $expectedContentString = fread($this->stream, $contentLength); | ||
|
|
||
| $seekBackResult = fseek($this->stream, -$contentLength, SEEK_CUR); | ||
| if ($seekBackResult === -1) { | ||
| throw new Exception("Unknown error while seeking content", 500); | ||
| } | ||
|
|
||
| return $expectedContentString !== $content; | ||
| } | ||
|
|
||
| /** | ||
| * Check wether the stream's cursor is seating right before the boundary. | ||
| */ | ||
| private function isAtBoundary(): bool { | ||
| return $this->isAt($this->boundary); | ||
| } | ||
|
|
||
| /** | ||
| * Check wether the stream's cursor is seating right before the last boundary. | ||
| */ | ||
| public function isAtLastBoundary(): bool { | ||
| return $this->isAt($this->lastBoundary); | ||
| } | ||
|
|
||
| /** | ||
| * Parse and return the next part of the multipart headers. | ||
| */ | ||
| public function parseNextPart(): array { | ||
| $this->readBoundary(); | ||
|
|
||
| $headers = $this->readPartHeaders(); | ||
|
|
||
| $content = $this->readPartContent($headers["content-length"], $headers["x-file-md5"]); | ||
|
|
||
| return [$headers, $content]; | ||
| } | ||
|
|
||
| /** | ||
| * Read the boundary and check its content. | ||
| * | ||
| * @throws BadRequest | ||
| */ | ||
| private function readBoundary(): string { | ||
| if (!$this->isAtBoundary()) { | ||
| throw new BadRequest("Boundary not found where it should be."); | ||
| } | ||
|
|
||
| return fread($this->stream, strlen($this->boundary)); | ||
| } | ||
|
|
||
| /** | ||
| * Return the headers of a part of the multipart body. | ||
| * | ||
| * @throws Exception | ||
| * @throws BadRequest | ||
| * @throws LengthRequired | ||
| */ | ||
| private function readPartHeaders(): array { | ||
| $headers = []; | ||
| $blankLineCount = 0; | ||
|
|
||
| while ($blankLineCount < 1) { | ||
| $line = fgets($this->stream); | ||
|
|
||
| if ($line === false) { | ||
| throw new Exception('An error appears while reading headers of a part'); | ||
| } | ||
|
|
||
| if ($line === "\r\n") { | ||
| break; | ||
| } | ||
|
|
||
| try { | ||
| [$key, $value] = explode(':', $line, 2); | ||
| $headers[strtolower(trim($key))] = trim($value); | ||
| } catch (Exception $e) { | ||
| throw new BadRequest('An error appears while parsing headers of a part', 400, $e); | ||
| } | ||
| } | ||
|
|
||
| if (!isset($headers["content-length"])) { | ||
| throw new LengthRequired("The Content-Length header must not be null."); | ||
| } | ||
|
|
||
| if (!isset($headers["x-file-md5"])) { | ||
| throw new BadRequest("The X-File-MD5 header must not be null."); | ||
| } | ||
|
|
||
| return $headers; | ||
| } | ||
|
|
||
| /** | ||
| * Return the content of a part of the multipart body. | ||
| * | ||
| * @throws Exception | ||
| * @throws BadRequest | ||
| */ | ||
| private function readPartContent(int $length, string $md5): string { | ||
| $computedMd5 = $this->computeMd5Hash($length); | ||
|
|
||
| if ($md5 !== $computedMd5) { | ||
| throw new BadRequest("Computed md5 hash is incorrect."); | ||
| } | ||
|
|
||
| $content = stream_get_line($this->stream, $length); | ||
|
|
||
| if ($content === false) { | ||
| throw new Exception("Fail to read part's content."); | ||
| } | ||
|
|
||
| if (feof($this->stream)) { | ||
| throw new Exception("Unexpected EOF while reading stream."); | ||
| } | ||
|
|
||
| // Read '\r\n'. | ||
| stream_get_contents($this->stream, 2); | ||
|
|
||
| return $content; | ||
| } | ||
|
|
||
| /** | ||
| * Compute the MD5 hash of the next x bytes. | ||
| */ | ||
| private function computeMd5Hash(int $length): string { | ||
| $context = hash_init('md5'); | ||
| hash_update_stream($context, $this->stream, $length); | ||
| return hash_final($context); | ||
| } | ||
| } |
Oops, something went wrong.