-<?php namespace Tests;
+<?php
+namespace Tests\Uploads;
+
+use BookStack\Entities\Models\Page;
+use BookStack\Entities\Repos\PageRepo;
+use BookStack\Entities\Tools\TrashCan;
use BookStack\Uploads\Attachment;
-use BookStack\Entities\Page;
-use BookStack\Auth\Permissions\PermissionService;
+use Tests\TestCase;
class AttachmentTest extends TestCase
{
- /**
- * Get a test file that can be uploaded
- * @param $fileName
- * @return \Illuminate\Http\UploadedFile
- */
- protected function getTestFile($fileName)
- {
- return new \Illuminate\Http\UploadedFile(base_path('tests/test-data/test-file.txt'), $fileName, 'text/plain', 55, null, true);
- }
-
- /**
- * Uploads a file with the given name.
- * @param $name
- * @param int $uploadedTo
- * @return \Illuminate\Foundation\Testing\TestResponse
- */
- protected function uploadFile($name, $uploadedTo = 0)
- {
- $file = $this->getTestFile($name);
- return $this->call('POST', '/attachments/upload', ['uploaded_to' => $uploadedTo], [], ['file' => $file], []);
- }
-
- /**
- * Delete all uploaded files.
- * To assist with cleanup.
- */
- protected function deleteUploads()
- {
- $fileService = $this->app->make(\BookStack\Uploads\AttachmentService::class);
- foreach (\BookStack\Uploads\Attachment::all() as $file) {
- $fileService->deleteFile($file);
- }
- }
-
public function test_file_upload()
{
- $page = Page::first();
+ $page = $this->entities->page();
$this->asAdmin();
- $admin = $this->getAdmin();
+ $admin = $this->users->admin();
$fileName = 'upload_test_file.txt';
$expectedResp = [
- 'name' => $fileName,
- 'uploaded_to'=> $page->id,
- 'extension' => 'txt',
- 'order' => 1,
+ 'name' => $fileName,
+ 'uploaded_to' => $page->id,
+ 'extension' => 'txt',
+ 'order' => 1,
'created_by' => $admin->id,
'updated_by' => $admin->id,
];
- $upload = $this->uploadFile($fileName, $page->id);
+ $upload = $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$upload->assertStatus(200);
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
- $expectedResp['path'] = $attachment->path;
-
$upload->assertJson($expectedResp);
+
+ $expectedResp['path'] = $attachment->path;
$this->assertDatabaseHas('attachments', $expectedResp);
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
public function test_file_upload_does_not_use_filename()
{
- $page = Page::first();
+ $page = $this->entities->page();
$fileName = 'upload_test_file.txt';
-
- $upload = $this->asAdmin()->uploadFile($fileName, $page->id);
+ $this->asAdmin();
+ $upload = $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$upload->assertStatus(200);
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
- $this->assertNotContains($fileName, $attachment->path);
- $this->assertStringEndsWith('.txt', $attachment->path);
+ $this->assertStringNotContainsString($fileName, $attachment->path);
+ $this->assertStringEndsWith('-txt', $attachment->path);
+ $this->files->deleteAllAttachmentFiles();
}
public function test_file_display_and_access()
{
- $page = Page::first();
+ $page = $this->entities->page();
$this->asAdmin();
$fileName = 'upload_test_file.txt';
- $upload = $this->uploadFile($fileName, $page->id);
+ $upload = $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$upload->assertStatus(200);
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
$pageGet->assertSee($attachment->getUrl());
$attachmentGet = $this->get($attachment->getUrl());
- $attachmentGet->assertSee('Hi, This is a test file for testing the upload process.');
+ $content = $attachmentGet->streamedContent();
+ $this->assertStringContainsString('Hi, This is a test file for testing the upload process.', $content);
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
public function test_attaching_link_to_page()
{
- $page = Page::first();
- $admin = $this->getAdmin();
+ $page = $this->entities->page();
+ $admin = $this->users->admin();
$this->asAdmin();
$linkReq = $this->call('POST', 'attachments/link', [
- 'link' => 'https://example.com',
- 'name' => 'Example Attachment Link',
- 'uploaded_to' => $page->id,
+ 'attachment_link_url' => 'https://example.com',
+ 'attachment_link_name' => 'Example Attachment Link',
+ 'attachment_link_uploaded_to' => $page->id,
]);
- $expectedResp = [
- 'path' => 'https://example.com',
- 'name' => 'Example Attachment Link',
+ $expectedData = [
+ 'path' => 'https://example.com',
+ 'name' => 'Example Attachment Link',
'uploaded_to' => $page->id,
- 'created_by' => $admin->id,
- 'updated_by' => $admin->id,
- 'external' => true,
- 'order' => 1,
- 'extension' => ''
+ 'created_by' => $admin->id,
+ 'updated_by' => $admin->id,
+ 'external' => true,
+ 'order' => 1,
+ 'extension' => '',
];
$linkReq->assertStatus(200);
- $linkReq->assertJson($expectedResp);
- $this->assertDatabaseHas('attachments', $expectedResp);
+ $this->assertDatabaseHas('attachments', $expectedData);
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
$pageGet = $this->get($page->getUrl());
$attachmentGet = $this->get($attachment->getUrl());
$attachmentGet->assertRedirect('https://example.com');
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
- public function test_attachment_updating()
+ public function test_attaching_long_links_to_a_page()
{
- $page = Page::first();
- $this->asAdmin();
+ $page = $this->entities->page();
+
+ $link = 'https://example.com?query=' . str_repeat('catsIScool', 195);
+ $linkReq = $this->asAdmin()->post('attachments/link', [
+ 'attachment_link_url' => $link,
+ 'attachment_link_name' => 'Example Attachment Link',
+ 'attachment_link_uploaded_to' => $page->id,
+ ]);
- $this->call('POST', 'attachments/link', [
- 'link' => 'https://example.com',
- 'name' => 'Example Attachment Link',
+ $linkReq->assertStatus(200);
+ $this->assertDatabaseHas('attachments', [
'uploaded_to' => $page->id,
+ 'path' => $link,
+ 'external' => true,
]);
- $attachmentId = \BookStack\Uploads\Attachment::first()->id;
+ $attachment = $page->attachments()->where('external', '=', true)->first();
+ $resp = $this->get($attachment->getUrl());
+ $resp->assertRedirect($link);
+ }
- $update = $this->call('PUT', 'attachments/' . $attachmentId, [
- 'uploaded_to' => $page->id,
- 'name' => 'My new attachment name',
- 'link' => 'https://test.example.com'
+ public function test_attachment_updating()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+
+ $attachment = Attachment::factory()->create(['uploaded_to' => $page->id]);
+ $update = $this->call('PUT', 'attachments/' . $attachment->id, [
+ 'attachment_edit_name' => 'My new attachment name',
+ 'attachment_edit_url' => 'https://test.example.com',
]);
- $expectedResp = [
- 'path' => 'https://test.example.com',
- 'name' => 'My new attachment name',
- 'uploaded_to' => $page->id
+ $expectedData = [
+ 'id' => $attachment->id,
+ 'path' => 'https://test.example.com',
+ 'name' => 'My new attachment name',
+ 'uploaded_to' => $page->id,
];
$update->assertStatus(200);
- $update->assertJson($expectedResp);
- $this->assertDatabaseHas('attachments', $expectedResp);
+ $this->assertDatabaseHas('attachments', $expectedData);
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
public function test_file_deletion()
{
- $page = Page::first();
+ $page = $this->entities->page();
$this->asAdmin();
$fileName = 'deletion_test.txt';
- $this->uploadFile($fileName, $page->id);
+ $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
$filePath = storage_path($attachment->path);
$this->assertTrue(file_exists($filePath), 'File at path ' . $filePath . ' does not exist');
- $attachment = \BookStack\Uploads\Attachment::first();
+ $attachment = Attachment::first();
$this->delete($attachment->getUrl());
$this->assertDatabaseMissing('attachments', [
- 'name' => $fileName
+ 'name' => $fileName,
]);
$this->assertFalse(file_exists($filePath), 'File at path ' . $filePath . ' was not deleted as expected');
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
public function test_attachment_deletion_on_page_deletion()
{
- $page = Page::first();
+ $page = $this->entities->page();
$this->asAdmin();
$fileName = 'deletion_test.txt';
- $this->uploadFile($fileName, $page->id);
+ $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
$filePath = storage_path($attachment->path);
$this->assertTrue(file_exists($filePath), 'File at path ' . $filePath . ' does not exist');
$this->assertDatabaseHas('attachments', [
- 'name' => $fileName
+ 'name' => $fileName,
]);
- $this->call('DELETE', $page->getUrl());
+ app(PageRepo::class)->destroy($page);
+ app(TrashCan::class)->empty();
$this->assertDatabaseMissing('attachments', [
- 'name' => $fileName
+ 'name' => $fileName,
]);
$this->assertFalse(file_exists($filePath), 'File at path ' . $filePath . ' was not deleted as expected');
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
public function test_attachment_access_without_permission_shows_404()
{
- $admin = $this->getAdmin();
- $viewer = $this->getViewer();
- $page = Page::first();
-
+ $admin = $this->users->admin();
+ $viewer = $this->users->viewer();
+ $page = $this->entities->page(); /** @var Page $page */
$this->actingAs($admin);
$fileName = 'permission_test.txt';
- $this->uploadFile($fileName, $page->id);
+ $this->files->uploadAttachmentFile($this, $fileName, $page->id);
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
- $page->restricted = true;
- $page->permissions()->delete();
- $page->save();
- $this->app[PermissionService::class]->buildJointPermissionsForEntity($page);
- $page->load('jointPermissions');
+ $this->permissions->setEntityPermissions($page, [], []);
$this->actingAs($viewer);
$attachmentGet = $this->get($attachment->getUrl());
$attachmentGet->assertStatus(404);
- $attachmentGet->assertSee("Attachment not found");
+ $attachmentGet->assertSee('Attachment not found');
+
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_data_and_js_links_cannot_be_attached_to_a_page()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+
+ $badLinks = [
+ 'javascript:alert("bunny")',
+ ' javascript:alert("bunny")',
+ 'JavaScript:alert("bunny")',
+ "\t\n\t\nJavaScript:alert(\"bunny\")",
+ 'data:text/html;<a></a>',
+ 'Data:text/html;<a></a>',
+ 'Data:text/html;<a></a>',
+ ];
+
+ foreach ($badLinks as $badLink) {
+ $linkReq = $this->post('attachments/link', [
+ 'attachment_link_url' => $badLink,
+ 'attachment_link_name' => 'Example Attachment Link',
+ 'attachment_link_uploaded_to' => $page->id,
+ ]);
+ $linkReq->assertStatus(422);
+ $this->assertDatabaseMissing('attachments', [
+ 'path' => $badLink,
+ ]);
+ }
+
+ $attachment = Attachment::factory()->create(['uploaded_to' => $page->id]);
+
+ foreach ($badLinks as $badLink) {
+ $linkReq = $this->put('attachments/' . $attachment->id, [
+ 'attachment_edit_url' => $badLink,
+ 'attachment_edit_name' => 'Example Attachment Link',
+ ]);
+ $linkReq->assertStatus(422);
+ $this->assertDatabaseMissing('attachments', [
+ 'path' => $badLink,
+ ]);
+ }
+ }
+
+ public function test_file_access_with_open_query_param_provides_inline_response_with_correct_content_type()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+ $fileName = 'upload_test_file.txt';
+
+ $upload = $this->files->uploadAttachmentFile($this, $fileName, $page->id);
+ $upload->assertStatus(200);
+ $attachment = Attachment::query()->orderBy('id', 'desc')->take(1)->first();
+
+ $attachmentGet = $this->get($attachment->getUrl(true));
+ // http-foundation/Response does some 'fixing' of responses to add charsets to text responses.
+ $attachmentGet->assertHeader('Content-Type', 'text/plain; charset=UTF-8');
+ $attachmentGet->assertHeader('Content-Disposition', 'inline; filename="upload_test_file.txt"');
+ $attachmentGet->assertHeader('X-Content-Type-Options', 'nosniff');
+
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_html_file_access_with_open_forces_plain_content_type()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+
+ $attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'test_file.html', '<html></html><p>testing</p>', 'text/html');
+
+ $attachmentGet = $this->get($attachment->getUrl(true));
+ // http-foundation/Response does some 'fixing' of responses to add charsets to text responses.
+ $attachmentGet->assertHeader('Content-Type', 'text/plain; charset=UTF-8');
+ $attachmentGet->assertHeader('Content-Disposition', 'inline; filename="test_file.html"');
+
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_file_upload_works_when_local_secure_restricted_is_in_use()
+ {
+ config()->set('filesystems.attachments', 'local_secure_restricted');
+
+ $page = $this->entities->page();
+ $fileName = 'upload_test_file.txt';
+
+ $this->asAdmin();
+ $upload = $this->files->uploadAttachmentFile($this, $fileName, $page->id);
+ $upload->assertStatus(200);
+
+ $attachment = Attachment::query()->orderBy('id', 'desc')->where('uploaded_to', '=', $page->id)->first();
+ $this->assertFileExists(storage_path($attachment->path));
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_file_get_range_access()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+ $attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'my_text.txt', 'abc123456', 'text/plain');
+
+ // Download access
+ $resp = $this->get($attachment->getUrl(), ['Range' => 'bytes=3-5']);
+ $resp->assertStatus(206);
+ $resp->assertStreamedContent('123');
+ $resp->assertHeader('Content-Length', '3');
+ $resp->assertHeader('Content-Range', 'bytes 3-5/9');
+
+ // Inline access
+ $resp = $this->get($attachment->getUrl(true), ['Range' => 'bytes=5-7']);
+ $resp->assertStatus(206);
+ $resp->assertStreamedContent('345');
+ $resp->assertHeader('Content-Length', '3');
+ $resp->assertHeader('Content-Range', 'bytes 5-7/9');
+
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_file_head_range_returns_no_content()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+ $attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'my_text.txt', 'abc123456', 'text/plain');
+
+ $resp = $this->head($attachment->getUrl(), ['Range' => 'bytes=0-9']);
+ $resp->assertStreamedContent('');
+ $resp->assertHeader('Content-Length', '9');
+ $resp->assertStatus(200);
+
+ $this->files->deleteAllAttachmentFiles();
+ }
+
+ public function test_file_head_range_edge_cases()
+ {
+ $page = $this->entities->page();
+ $this->asAdmin();
+
+ // Mime-type "sniffing" happens on first 2k bytes, hence this content (2005 bytes)
+ $content = '01234' . str_repeat('a', 1990) . '0123456789';
+ $attachment = $this->files->uploadAttachmentDataToPage($this, $page, 'my_text.txt', $content, 'text/plain');
+
+ // Test for both inline and download attachment serving
+ foreach ([true, false] as $isInline) {
+ // No end range
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=5-']);
+ $resp->assertStreamedContent(substr($content, 5));
+ $resp->assertHeader('Content-Length', '2000');
+ $resp->assertHeader('Content-Range', 'bytes 5-2004/2005');
+ $resp->assertStatus(206);
+
+ // End only range
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=-10']);
+ $resp->assertStreamedContent('0123456789');
+ $resp->assertHeader('Content-Length', '10');
+ $resp->assertHeader('Content-Range', 'bytes 1995-2004/2005');
+ $resp->assertStatus(206);
+
+ // Range across sniff point
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=1997-2002']);
+ $resp->assertStreamedContent('234567');
+ $resp->assertHeader('Content-Length', '6');
+ $resp->assertHeader('Content-Range', 'bytes 1997-2002/2005');
+ $resp->assertStatus(206);
+
+ // Range up to sniff point
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=0-1997']);
+ $resp->assertHeader('Content-Length', '1998');
+ $resp->assertHeader('Content-Range', 'bytes 0-1997/2005');
+ $resp->assertStreamedContent(substr($content, 0, 1998));
+ $resp->assertStatus(206);
+
+ // Range beyond sniff point
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=2001-2003']);
+ $resp->assertStreamedContent('678');
+ $resp->assertHeader('Content-Length', '3');
+ $resp->assertHeader('Content-Range', 'bytes 2001-2003/2005');
+ $resp->assertStatus(206);
+
+ // Range beyond content
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=0-2010']);
+ $resp->assertStreamedContent($content);
+ $resp->assertHeader('Content-Length', '2005');
+ $resp->assertHeaderMissing('Content-Range');
+ $resp->assertStatus(200);
+
+ // Range start before end
+ $resp = $this->get($attachment->getUrl($isInline), ['Range' => 'bytes=50-10']);
+ $resp->assertStreamedContent($content);
+ $resp->assertHeader('Content-Length', '2005');
+ $resp->assertHeader('Content-Range', 'bytes */2005');
+ $resp->assertStatus(416);
+ }
- $this->deleteUploads();
+ $this->files->deleteAllAttachmentFiles();
}
}
projects / bookstack / blobdiff