mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add FileDisplayResponse 

A lazy implementation of the DisplayResponse that only hits the
filesystem if the etag and mtime do not match.
This commit is contained in:
Roeland Jago Douma 2016-08-23 21:43:13 +02:00
parent 06fa486706
commit 777c3ee325
No known key found for this signature in database
GPG Key ID: 1E152838F164D13B
2 changed files with 179 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
lib/public/AppFramework/Http/FileDisplayResponse.php Normal file
View File

@ -0,0 +1,70 @@
<?php
/**
* @copyright 2016 Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* 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.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\AppFramework\Http;
use OCP\AppFramework\Http;
use OCP\Files\File;
/**
* Class FileDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 9.2.0
*/
class FileDisplayResponse extends Response implements ICallbackResponse {
/** @var File */
private $file;
/**
* FileDisplayResponse constructor.
*
* @param File $file
* @param int $statusCode
* @param array $headers
* @since 9.2.0
*/
public function __construct(File $file, $statusCode=Http::STATUS_OK,
$headers=[]) {
$this->file = $file;
$this->setStatus($statusCode);
$this->setHeaders(array_merge($this->getHeaders(), $headers));
$this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
$this->setETag($file->getEtag());
$lastModified = new \DateTime();
$lastModified->setTimestamp($file->getMTime());
$this->setLastModified($lastModified);
}
/**
* @param IOutput $output
* @since 9.2.0
*/
public function callback(IOutput $output) {
if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
$output->setHeader('Content-Length: ' . $this->file->getSize());
$output->setOutput($this->file->getContent());
}
}
}

109
tests/lib/AppFramework/Http/FileDisplayResponseTest.php Normal file
View File

@ -0,0 +1,109 @@
<?php
/**
* @copyright 2016 Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* 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.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace Test\AppFramework\Http;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\FileDisplayResponse;
use OCP\Files\File;
class FileDisplayResponseTest extends \Test\TestCase {
/** @var File|\PHPUnit_Framework_MockObject_MockObject */
private $file;
/** @var FileDisplayResponse */
private $response;
public function setup() {
$this->file = $this->getMockBuilder('OCP\Files\File')
->getMock();
$this->file->expects($this->once())
->method('getETag')
->willReturn('myETag');
$this->file->expects($this->once())
->method('getName')
->willReturn('myFileName');
$this->file->expects($this->once())
->method('getMTime')
->willReturn(1464825600);
$this->response = new FileDisplayResponse($this->file);
}
public function testHeader() {
$headers = $this->response->getHeaders();
$this->assertArrayHasKey('Content-Disposition', $headers);
$this->assertSame('inline; filename="myFileName"', $headers['Content-Disposition']);
}
public function testETag() {
$this->assertSame('myETag', $this->response->getETag());
}
public function testLastModified() {
$lastModified = $this->response->getLastModified();
$this->assertNotNull($lastModified);
$this->assertSame(1464825600, $lastModified->getTimestamp());
}
public function test304() {
$output = $this->getMockBuilder('OCP\AppFramework\Http\IOutput')
->disableOriginalConstructor()
->getMock();
$output->expects($this->any())
->method('getHttpResponseCode')
->willReturn(Http::STATUS_NOT_MODIFIED);
$output->expects($this->never())
->method('setOutput');
$this->file->expects($this->never())
->method('getContent');
$this->response->callback($output);
}
public function testNon304() {
$output = $this->getMockBuilder('OCP\AppFramework\Http\IOutput')
->disableOriginalConstructor()
->getMock();
$output->expects($this->any())
->method('getHttpResponseCode')
->willReturn(Http::STATUS_OK);
$output->expects($this->once())
->method('setOutput')
->with($this->equalTo('my data'));
$output->expects($this->once())
->method('setHeader')
->with($this->equalTo('Content-Length: 42'));
$this->file->expects($this->once())
->method('getContent')
->willReturn('my data');
$this->file->expects($this->any())
->method('getSize')
->willReturn(42);
$this->response->callback($output);
}
}