-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Proper 304 response #1121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Proper 304 response #1121
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,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 changes: 109 additions & 0 deletions
109
tests/lib/AppFramework/Http/FileDisplayResponseTest.php
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,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); | ||
| } | ||
| } |
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.
@icewind1991: @BernhardPosselt noted here that this might not be very efficient. We might want to use something like http://php.net/manual/en/function.fpassthru.php
But i'd say that is a later optimization
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.
On the filesystem side we can already do
$this->file->fopen('r'), so we just need to have the appframework be able to handle streams as outputThere 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.
Yeah fair enough. But like I say I'll do that later. This is already much better then the current stuff.