mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-26 02:10:19 +08:00
356 lines
12 KiB
PHP
356 lines
12 KiB
PHP
<?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\Uploads\AttachmentService;
|
|
use Illuminate\Http\UploadedFile;
|
|
use Tests\TestCase;
|
|
|
|
class AttachmentTest extends TestCase
|
|
{
|
|
/**
|
|
* Get a test file that can be uploaded.
|
|
*/
|
|
protected function getTestFile(string $fileName): UploadedFile
|
|
{
|
|
return new UploadedFile(base_path('tests/test-data/test-file.txt'), $fileName, 'text/plain', null, true);
|
|
}
|
|
|
|
/**
|
|
* Uploads a file with the given name.
|
|
*/
|
|
protected function uploadFile(string $name, int $uploadedTo = 0): \Illuminate\Testing\TestResponse
|
|
{
|
|
$file = $this->getTestFile($name);
|
|
|
|
return $this->call('POST', '/attachments/upload', ['uploaded_to' => $uploadedTo], [], ['file' => $file], []);
|
|
}
|
|
|
|
/**
|
|
* Create a new attachment.
|
|
*/
|
|
protected function createAttachment(Page $page): Attachment
|
|
{
|
|
$this->post('attachments/link', [
|
|
'attachment_link_url' => 'https://example.com',
|
|
'attachment_link_name' => 'Example Attachment Link',
|
|
'attachment_link_uploaded_to' => $page->id,
|
|
]);
|
|
|
|
return Attachment::query()->latest()->first();
|
|
}
|
|
|
|
/**
|
|
* Create a new upload attachment from the given data.
|
|
*/
|
|
protected function createUploadAttachment(Page $page, string $filename, string $content, string $mimeType): Attachment
|
|
{
|
|
$file = tmpfile();
|
|
$filePath = stream_get_meta_data($file)['uri'];
|
|
file_put_contents($filePath, $content);
|
|
$upload = new UploadedFile($filePath, $filename, $mimeType, null, true);
|
|
|
|
$this->call('POST', '/attachments/upload', ['uploaded_to' => $page->id], [], ['file' => $upload], []);
|
|
|
|
return $page->attachments()->latest()->firstOrFail();
|
|
}
|
|
|
|
/**
|
|
* Delete all uploaded files.
|
|
* To assist with cleanup.
|
|
*/
|
|
protected function deleteUploads()
|
|
{
|
|
$fileService = $this->app->make(AttachmentService::class);
|
|
foreach (Attachment::all() as $file) {
|
|
$fileService->deleteFile($file);
|
|
}
|
|
}
|
|
|
|
public function test_file_upload()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
$admin = $this->users->admin();
|
|
$fileName = 'upload_test_file.txt';
|
|
|
|
$expectedResp = [
|
|
'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->assertStatus(200);
|
|
|
|
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
|
|
$upload->assertJson($expectedResp);
|
|
|
|
$expectedResp['path'] = $attachment->path;
|
|
$this->assertDatabaseHas('attachments', $expectedResp);
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_file_upload_does_not_use_filename()
|
|
{
|
|
$page = $this->entities->page();
|
|
$fileName = 'upload_test_file.txt';
|
|
|
|
$upload = $this->asAdmin()->uploadFile($fileName, $page->id);
|
|
$upload->assertStatus(200);
|
|
|
|
$attachment = Attachment::query()->orderBy('id', 'desc')->first();
|
|
$this->assertStringNotContainsString($fileName, $attachment->path);
|
|
$this->assertStringEndsWith('-txt', $attachment->path);
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_file_display_and_access()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
$fileName = 'upload_test_file.txt';
|
|
|
|
$upload = $this->uploadFile($fileName, $page->id);
|
|
$upload->assertStatus(200);
|
|
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
|
|
|
|
$pageGet = $this->get($page->getUrl());
|
|
$pageGet->assertSeeText($fileName);
|
|
$pageGet->assertSee($attachment->getUrl());
|
|
|
|
$attachmentGet = $this->get($attachment->getUrl());
|
|
$content = $attachmentGet->streamedContent();
|
|
$this->assertStringContainsString('Hi, This is a test file for testing the upload process.', $content);
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_attaching_link_to_page()
|
|
{
|
|
$page = $this->entities->page();
|
|
$admin = $this->users->admin();
|
|
$this->asAdmin();
|
|
|
|
$linkReq = $this->call('POST', 'attachments/link', [
|
|
'attachment_link_url' => 'https://example.com',
|
|
'attachment_link_name' => 'Example Attachment Link',
|
|
'attachment_link_uploaded_to' => $page->id,
|
|
]);
|
|
|
|
$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' => '',
|
|
];
|
|
|
|
$linkReq->assertStatus(200);
|
|
$this->assertDatabaseHas('attachments', $expectedData);
|
|
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
|
|
|
|
$pageGet = $this->get($page->getUrl());
|
|
$pageGet->assertSeeText('Example Attachment Link');
|
|
$pageGet->assertSee($attachment->getUrl());
|
|
|
|
$attachmentGet = $this->get($attachment->getUrl());
|
|
$attachmentGet->assertRedirect('https://example.com');
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_attachment_updating()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
|
|
$attachment = $this->createAttachment($page);
|
|
$update = $this->call('PUT', 'attachments/' . $attachment->id, [
|
|
'attachment_edit_name' => 'My new attachment name',
|
|
'attachment_edit_url' => 'https://test.example.com',
|
|
]);
|
|
|
|
$expectedData = [
|
|
'id' => $attachment->id,
|
|
'path' => 'https://test.example.com',
|
|
'name' => 'My new attachment name',
|
|
'uploaded_to' => $page->id,
|
|
];
|
|
|
|
$update->assertStatus(200);
|
|
$this->assertDatabaseHas('attachments', $expectedData);
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_file_deletion()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
$fileName = 'deletion_test.txt';
|
|
$this->uploadFile($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 = Attachment::first();
|
|
$this->delete($attachment->getUrl());
|
|
|
|
$this->assertDatabaseMissing('attachments', [
|
|
'name' => $fileName,
|
|
]);
|
|
$this->assertFalse(file_exists($filePath), 'File at path ' . $filePath . ' was not deleted as expected');
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_attachment_deletion_on_page_deletion()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
$fileName = 'deletion_test.txt';
|
|
$this->uploadFile($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,
|
|
]);
|
|
|
|
app(PageRepo::class)->destroy($page);
|
|
app(TrashCan::class)->empty();
|
|
|
|
$this->assertDatabaseMissing('attachments', [
|
|
'name' => $fileName,
|
|
]);
|
|
$this->assertFalse(file_exists($filePath), 'File at path ' . $filePath . ' was not deleted as expected');
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
public function test_attachment_access_without_permission_shows_404()
|
|
{
|
|
$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);
|
|
$attachment = Attachment::orderBy('id', 'desc')->take(1)->first();
|
|
|
|
$this->permissions->setEntityPermissions($page, [], []);
|
|
|
|
$this->actingAs($viewer);
|
|
$attachmentGet = $this->get($attachment->getUrl());
|
|
$attachmentGet->assertStatus(404);
|
|
$attachmentGet->assertSee('Attachment not found');
|
|
|
|
$this->deleteUploads();
|
|
}
|
|
|
|
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 = $this->createAttachment($page);
|
|
|
|
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->uploadFile($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->deleteUploads();
|
|
}
|
|
|
|
public function test_html_file_access_with_open_forces_plain_content_type()
|
|
{
|
|
$page = $this->entities->page();
|
|
$this->asAdmin();
|
|
|
|
$attachment = $this->createUploadAttachment($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->deleteUploads();
|
|
}
|
|
|
|
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';
|
|
|
|
$upload = $this->asAdmin()->uploadFile($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->deleteUploads();
|
|
}
|
|
}
|