From a9fa220e6824a76bbb8d4b65a9b80f25383cdee4 Mon Sep 17 00:00:00 2001 From: Jakob Sack Date: Sun, 2 Sep 2018 15:48:13 +0200 Subject: [PATCH 1/5] Add fix response implements #7589 --- lib/composer/composer/autoload_classmap.php | 1 + lib/composer/composer/autoload_static.php | 11 +-- lib/public/AppFramework/Http/ZipResponse.php | 75 ++++++++++++++++++++ 3 files changed, 82 insertions(+), 5 deletions(-) create mode 100644 lib/public/AppFramework/Http/ZipResponse.php diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 121f52998e..fe68bbe630 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -50,6 +50,7 @@ return array( 'OCP\\AppFramework\\Http\\Template\\LinkMenuAction' => $baseDir . '/lib/public/AppFramework/Http/Template/LinkMenuAction.php', 'OCP\\AppFramework\\Http\\Template\\PublicTemplateResponse' => $baseDir . '/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php', 'OCP\\AppFramework\\Http\\Template\\SimpleMenuAction' => $baseDir . '/lib/public/AppFramework/Http/Template/SimpleMenuAction.php', + 'OCP\\AppFramework\\Http\\ZipResponse' => $baseDir . '/lib/public/AppFramework/Http/ZipResponse.php', 'OCP\\AppFramework\\IAppContainer' => $baseDir . '/lib/public/AppFramework/IAppContainer.php', 'OCP\\AppFramework\\Middleware' => $baseDir . '/lib/public/AppFramework/Middleware.php', 'OCP\\AppFramework\\OCSController' => $baseDir . '/lib/public/AppFramework/OCSController.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index ae5b70380f..257efa3d93 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -7,7 +7,7 @@ namespace Composer\Autoload; class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c { public static $prefixLengthsPsr4 = array ( - 'O' => + 'O' => array ( 'OC\\Settings\\' => 12, 'OC\\Core\\' => 8, @@ -17,19 +17,19 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c ); public static $prefixDirsPsr4 = array ( - 'OC\\Settings\\' => + 'OC\\Settings\\' => array ( 0 => __DIR__ . '/../../..' . '/settings', ), - 'OC\\Core\\' => + 'OC\\Core\\' => array ( 0 => __DIR__ . '/../../..' . '/core', ), - 'OC\\' => + 'OC\\' => array ( 0 => __DIR__ . '/../../..' . '/lib/private', ), - 'OCP\\' => + 'OCP\\' => array ( 0 => __DIR__ . '/../../..' . '/lib/public', ), @@ -80,6 +80,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\AppFramework\\Http\\Template\\LinkMenuAction' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/Template/LinkMenuAction.php', 'OCP\\AppFramework\\Http\\Template\\PublicTemplateResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php', 'OCP\\AppFramework\\Http\\Template\\SimpleMenuAction' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/Template/SimpleMenuAction.php', + 'OCP\\AppFramework\\Http\\ZipResponse' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Http/ZipResponse.php', 'OCP\\AppFramework\\IAppContainer' => __DIR__ . '/../../..' . '/lib/public/AppFramework/IAppContainer.php', 'OCP\\AppFramework\\Middleware' => __DIR__ . '/../../..' . '/lib/public/AppFramework/Middleware.php', 'OCP\\AppFramework\\OCSController' => __DIR__ . '/../../..' . '/lib/public/AppFramework/OCSController.php', diff --git a/lib/public/AppFramework/Http/ZipResponse.php b/lib/public/AppFramework/Http/ZipResponse.php new file mode 100644 index 0000000000..27ff30d401 --- /dev/null +++ b/lib/public/AppFramework/Http/ZipResponse.php @@ -0,0 +1,75 @@ + + * @author Roeland Jago Douma + * + * @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 + * + */ + +/** + * Public library to send several files in one zip archive. + */ + +namespace OCP\AppFramework\Http; + +use OCP\IRequest; +use OC\Streamer; + +class ZipResponse extends Response implements ICallbackResponse { + /** @var resource[] Files to be added to the zip response */ + private $resources; + /** @var string Filename that the zip file should have */ + private $name; + private $request; + + public function __construct(string $name = 'output', IRequest $request) { + $this->name = $name; + $this->request = $request; + } + + public function addResource($r, string $internalName, int $size, int $time = -1) { + if (!\is_resource($r)) { + return; + } + + $this->resources[] = [ + 'resource' => $r, + 'internalName' => $internalName, + 'size' => $size, + 'time' => $time, + ]; + } + + public function callback(IOutput $output) { + $size = 0; + $files = count($this->resources); + + foreach ($this->resources as $resource) { + $size = $size + $resource['size']; + } + + $zip = new Streamer($this->request, $size, $files); + $zip->sendHeaders($this->name); + + foreach ($this->resources as $resource) { + $zip->addFileFromStream($resource['resource'], $resource['internalName'], $resource['size'], $resource['time']); + } + + $zip->finalize(); + } +} From dc6ff14ca0233ae876d103191c76d2f729c94834 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Tue, 2 Oct 2018 08:14:18 +0200 Subject: [PATCH 2/5] fixup! Add fix response Signed-off-by: Roeland Jago Douma --- lib/composer/composer/autoload_static.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 257efa3d93..544cedba12 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -7,7 +7,7 @@ namespace Composer\Autoload; class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c { public static $prefixLengthsPsr4 = array ( - 'O' => + 'O' => array ( 'OC\\Settings\\' => 12, 'OC\\Core\\' => 8, @@ -17,19 +17,19 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c ); public static $prefixDirsPsr4 = array ( - 'OC\\Settings\\' => + 'OC\\Settings\\' => array ( 0 => __DIR__ . '/../../..' . '/settings', ), - 'OC\\Core\\' => + 'OC\\Core\\' => array ( 0 => __DIR__ . '/../../..' . '/core', ), - 'OC\\' => + 'OC\\' => array ( 0 => __DIR__ . '/../../..' . '/lib/private', ), - 'OCP\\' => + 'OCP\\' => array ( 0 => __DIR__ . '/../../..' . '/lib/public', ), From a891f42a5de0b0a2a67d03525d81c028fdb3caf1 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Tue, 2 Oct 2018 08:16:28 +0200 Subject: [PATCH 3/5] fixup! Add fix response Signed-off-by: Roeland Jago Douma --- lib/public/AppFramework/Http/ZipResponse.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/public/AppFramework/Http/ZipResponse.php b/lib/public/AppFramework/Http/ZipResponse.php index 27ff30d401..c70482a0a9 100644 --- a/lib/public/AppFramework/Http/ZipResponse.php +++ b/lib/public/AppFramework/Http/ZipResponse.php @@ -1,6 +1,8 @@ * * @author Jakob Sack * @author Roeland Jago Douma @@ -37,7 +39,7 @@ class ZipResponse extends Response implements ICallbackResponse { private $name; private $request; - public function __construct(string $name = 'output', IRequest $request) { + public function __construct(IRequest $request, string $name = 'output') { $this->name = $name; $this->request = $request; } @@ -60,7 +62,7 @@ class ZipResponse extends Response implements ICallbackResponse { $files = count($this->resources); foreach ($this->resources as $resource) { - $size = $size + $resource['size']; + $size += $resource['size']; } $zip = new Streamer($this->request, $size, $files); From 7d9052d4b9d4ac690c32d7f9e79da2a06b0df055 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Tue, 2 Oct 2018 08:17:27 +0200 Subject: [PATCH 4/5] fixup! Add fix response Signed-off-by: Roeland Jago Douma --- lib/public/AppFramework/Http/ZipResponse.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/public/AppFramework/Http/ZipResponse.php b/lib/public/AppFramework/Http/ZipResponse.php index c70482a0a9..712af17d2d 100644 --- a/lib/public/AppFramework/Http/ZipResponse.php +++ b/lib/public/AppFramework/Http/ZipResponse.php @@ -46,7 +46,7 @@ class ZipResponse extends Response implements ICallbackResponse { public function addResource($r, string $internalName, int $size, int $time = -1) { if (!\is_resource($r)) { - return; + throw new \InvalidArgumentException('No resource provided'); } $this->resources[] = [ From bcbffdb644a125e436d40ba83fdd45dba8362181 Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Tue, 2 Oct 2018 22:35:31 +0200 Subject: [PATCH 5/5] Add PHPDoc Signed-off-by: Morris Jobke --- lib/public/AppFramework/Http/ZipResponse.php | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/lib/public/AppFramework/Http/ZipResponse.php b/lib/public/AppFramework/Http/ZipResponse.php index 712af17d2d..630efb38c7 100644 --- a/lib/public/AppFramework/Http/ZipResponse.php +++ b/lib/public/AppFramework/Http/ZipResponse.php @@ -23,15 +23,16 @@ declare(strict_types=1); * */ -/** - * Public library to send several files in one zip archive. - */ - namespace OCP\AppFramework\Http; use OCP\IRequest; use OC\Streamer; +/** + * Public library to send several files in one zip archive. + * + * @since 15.0.0 + */ class ZipResponse extends Response implements ICallbackResponse { /** @var resource[] Files to be added to the zip response */ private $resources; @@ -39,11 +40,17 @@ class ZipResponse extends Response implements ICallbackResponse { private $name; private $request; + /** + * @since 15.0.0 + */ public function __construct(IRequest $request, string $name = 'output') { $this->name = $name; $this->request = $request; } + /** + * @since 15.0.0 + */ public function addResource($r, string $internalName, int $size, int $time = -1) { if (!\is_resource($r)) { throw new \InvalidArgumentException('No resource provided'); @@ -57,6 +64,9 @@ class ZipResponse extends Response implements ICallbackResponse { ]; } + /** + * @since 15.0.0 + */ public function callback(IOutput $output) { $size = 0; $files = count($this->resources);