nextcloud/lib/public/AppFramework/Http/ZipResponse.php

93 lines
2.3 KiB
PHP
Raw Normal View History

2018-09-02 16:48:13 +03:00
<?php
declare(strict_types=1);
2018-09-02 16:48:13 +03:00
/**
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
2018-09-02 16:48:13 +03:00
*
* @author Jakob Sack <mail@jakobsack.de>
* @author Morris Jobke <hey@morrisjobke.de>
2018-09-02 16:48:13 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
2018-09-02 16:48:13 +03:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
2018-09-02 16:48:13 +03:00
*
* 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
2018-09-02 16:48:13 +03:00
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2018-09-02 16:48:13 +03:00
*
*/
namespace OCP\AppFramework\Http;
use OC\Streamer;
use OCP\IRequest;
2018-09-02 16:48:13 +03:00
/**
* Public library to send several files in one zip archive.
*
* @since 15.0.0
*/
2018-09-02 16:48:13 +03:00
class ZipResponse extends Response implements ICallbackResponse {
/** @var resource[] Files to be added to the zip response */
private $resources = [];
2018-09-02 16:48:13 +03:00
/** @var string Filename that the zip file should have */
private $name;
private $request;
/**
* @since 15.0.0
*/
public function __construct(IRequest $request, string $name = 'output') {
parent::__construct();
2018-09-02 16:48:13 +03:00
$this->name = $name;
$this->request = $request;
}
/**
* @since 15.0.0
*/
2018-09-02 16:48:13 +03:00
public function addResource($r, string $internalName, int $size, int $time = -1) {
if (!\is_resource($r)) {
throw new \InvalidArgumentException('No resource provided');
2018-09-02 16:48:13 +03:00
}
$this->resources[] = [
'resource' => $r,
'internalName' => $internalName,
'size' => $size,
'time' => $time,
];
}
/**
* @since 15.0.0
*/
2018-09-02 16:48:13 +03:00
public function callback(IOutput $output) {
$size = 0;
$files = count($this->resources);
foreach ($this->resources as $resource) {
$size += $resource['size'];
2018-09-02 16:48:13 +03:00
}
$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();
}
}