BookStack Code Mirror - bookstack/blob - tests/Uploads/ImageTest.php

   1 <?php namespace Tests\Uploads;
   2
   3 use BookStack\Entities\Repos\PageRepo;
   4 use BookStack\Uploads\Image;
   5 use BookStack\Entities\Page;
   6 use BookStack\Uploads\ImageService;
   7 use Tests\TestCase;
   8
   9 class ImageTest extends TestCase
  10 {
  11
  12     use UsesImages;
  13
  14     public function test_image_upload()
  15     {
  16         $page = Page::first();
  17         $admin = $this->getAdmin();
  18         $this->actingAs($admin);
  19
  20         $imageName = 'first-image.png';
  21         $relPath = $this->getTestImagePath('gallery', $imageName);
  22         $this->deleteImage($relPath);
  23
  24         $upload = $this->uploadImage($imageName, $page->id);
  25         $upload->assertStatus(200);
  26
  27         $this->assertTrue(file_exists(public_path($relPath)), 'Uploaded image not found at path: '. public_path($relPath));
  28
  29         $this->deleteImage($relPath);
  30
  31         $this->assertDatabaseHas('images', [
  32             'url' => $this->baseUrl . $relPath,
  33             'type' => 'gallery',
  34             'uploaded_to' => $page->id,
  35             'path' => $relPath,
  36             'created_by' => $admin->id,
  37             'updated_by' => $admin->id,
  38             'name' => $imageName
  39         ]);
  40     }
  41
  42     public function test_php_files_cannot_be_uploaded()
  43     {
  44         $page = Page::first();
  45         $admin = $this->getAdmin();
  46         $this->actingAs($admin);
  47
  48         $fileName = 'bad.php';
  49         $relPath = $this->getTestImagePath('gallery', $fileName);
  50         $this->deleteImage($relPath);
  51
  52         $file = $this->getTestImage($fileName);
  53         $upload = $this->withHeader('Content-Type', 'image/jpeg')->call('POST', '/images/gallery/upload', ['uploaded_to' => $page->id], [], ['file' => $file], []);
  54         $upload->assertStatus(302);
  55
  56         $this->assertFalse(file_exists(public_path($relPath)), 'Uploaded php file was uploaded but should have been stopped');
  57
  58         $this->assertDatabaseMissing('images', [
  59             'type' => 'gallery',
  60             'name' => $fileName
  61         ]);
  62     }
  63
  64     public function test_secure_images_uploads_to_correct_place()
  65     {
  66         config()->set('filesystems.default', 'local_secure');
  67         $this->asEditor();
  68         $galleryFile = $this->getTestImage('my-secure-test-upload');
  69         $page = Page::first();
  70         $expectedPath = storage_path('uploads/images/gallery/' . Date('Y-m-M') . '/my-secure-test-upload');
  71
  72         $upload = $this->call('POST', '/images/gallery/upload', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
  73         $upload->assertStatus(200);
  74
  75         $this->assertTrue(file_exists($expectedPath), 'Uploaded image not found at path: '. $expectedPath);
  76
  77         if (file_exists($expectedPath)) {
  78             unlink($expectedPath);
  79         }
  80     }
  81
  82     public function test_secure_images_included_in_exports()
  83     {
  84         config()->set('filesystems.default', 'local_secure');
  85         $this->asEditor();
  86         $galleryFile = $this->getTestImage('my-secure-test-upload');
  87         $page = Page::first();
  88         $expectedPath = storage_path('uploads/images/gallery/' . Date('Y-m-M') . '/my-secure-test-upload');
  89
  90         $upload = $this->call('POST', '/images/gallery/upload', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
  91         $imageUrl = json_decode($upload->getContent(), true)['url'];
  92         $page->html .= "<img src=\"{$imageUrl}\">";
  93         $page->save();
  94         $upload->assertStatus(200);
  95
  96         $encodedImageContent = base64_encode(file_get_contents($expectedPath));
  97         $export = $this->get($page->getUrl('/export/html'));
  98         $this->assertTrue(str_contains($export->getContent(), $encodedImageContent), 'Uploaded image in export content');
  99
 100         if (file_exists($expectedPath)) {
 101             unlink($expectedPath);
 102         }
 103     }
 104
 105     public function test_system_images_remain_public()
 106     {
 107         config()->set('filesystems.default', 'local_secure');
 108         $this->asEditor();
 109         $galleryFile = $this->getTestImage('my-system-test-upload');
 110         $page = Page::first();
 111         $expectedPath = public_path('uploads/images/system/' . Date('Y-m-M') . '/my-system-test-upload');
 112
 113         $upload = $this->call('POST', '/images/system/upload', ['uploaded_to' => $page->id], [], ['file' => $galleryFile], []);
 114         $upload->assertStatus(200);
 115
 116         $this->assertTrue(file_exists($expectedPath), 'Uploaded image not found at path: '. $expectedPath);
 117
 118         if (file_exists($expectedPath)) {
 119             unlink($expectedPath);
 120         }
 121     }
 122
 123     public function test_image_delete()
 124     {
 125         $page = Page::first();
 126         $this->asAdmin();
 127         $imageName = 'first-image.png';
 128
 129         $this->uploadImage($imageName, $page->id);
 130         $image = Image::first();
 131         $relPath = $this->getTestImagePath('gallery', $imageName);
 132
 133         $delete = $this->delete( '/images/' . $image->id);
 134         $delete->assertStatus(200);
 135
 136         $this->assertDatabaseMissing('images', [
 137             'url' => $this->baseUrl . $relPath,
 138             'type' => 'gallery'
 139         ]);
 140
 141         $this->assertFalse(file_exists(public_path($relPath)), 'Uploaded image has not been deleted as expected');
 142     }
 143
 144     public function testBase64Get()
 145     {
 146         $page = Page::first();
 147         $this->asAdmin();
 148         $imageName = 'first-image.png';
 149
 150         $this->uploadImage($imageName, $page->id);
 151         $image = Image::first();
 152
 153         $imageGet = $this->getJson("/images/base64/{$image->id}");
 154         $imageGet->assertJson([
 155             'content' => 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4gEcDCo5iYNs+gAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAFElEQVQI12O0jN/KgASYGFABqXwAZtoBV6Sl3hIAAAAASUVORK5CYII='
 156         ]);
 157     }
 158
 159     public function test_drawing_base64_upload()
 160     {
 161         $page = Page::first();
 162         $editor = $this->getEditor();
 163         $this->actingAs($editor);
 164
 165         $upload = $this->postJson('images/drawing/upload', [
 166             'uploaded_to' => $page->id,
 167             'image' => 'image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4gEcDCo5iYNs+gAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAFElEQVQI12O0jN/KgASYGFABqXwAZtoBV6Sl3hIAAAAASUVORK5CYII='
 168         ]);
 169
 170         $upload->assertStatus(200);
 171         $upload->assertJson([
 172             'type' => 'drawio',
 173             'uploaded_to' => $page->id,
 174             'created_by' => $editor->id,
 175             'updated_by' => $editor->id,
 176         ]);
 177
 178         $image = Image::where('type', '=', 'drawio')->first();
 179         $this->assertTrue(file_exists(public_path($image->path)), 'Uploaded image not found at path: '. public_path($image->path));
 180
 181         $testImageData = file_get_contents($this->getTestImageFilePath());
 182         $uploadedImageData = file_get_contents(public_path($image->path));
 183         $this->assertTrue($testImageData === $uploadedImageData, "Uploaded image file data does not match our test image as expected");
 184     }
 185
 186     public function test_user_images_deleted_on_user_deletion()
 187     {
 188         $editor = $this->getEditor();
 189         $this->actingAs($editor);
 190
 191         $imageName = 'profile.png';
 192         $relPath = $this->getTestImagePath('gallery', $imageName);
 193         $this->deleteImage($relPath);
 194
 195         $file = $this->getTestImage($imageName);
 196         $this->call('POST', '/images/user/upload', [], [], ['file' => $file], []);
 197         $this->call('POST', '/images/user/upload', [], [], ['file' => $file], []);
 198
 199         $profileImages = Image::where('type', '=', 'user')->where('created_by', '=', $editor->id)->get();
 200         $this->assertTrue($profileImages->count() === 2, "Found profile images does not match upload count");
 201
 202         $userDelete = $this->asAdmin()->delete("/settings/users/{$editor->id}");
 203         $userDelete->assertStatus(302);
 204         $this->assertDatabaseMissing('images', [
 205             'type' => 'user',
 206             'created_by' => $editor->id
 207         ]);
 208     }
 209
 210     public function test_deleted_unused_images()
 211     {
 212         $page = Page::first();
 213         $admin = $this->getAdmin();
 214         $this->actingAs($admin);
 215
 216         $imageName = 'unused-image.png';
 217         $relPath = $this->getTestImagePath('gallery', $imageName);
 218         $this->deleteImage($relPath);
 219
 220         $upload = $this->uploadImage($imageName, $page->id);
 221         $upload->assertStatus(200);
 222         $image = Image::where('type', '=', 'gallery')->first();
 223
 224         $pageRepo = app(PageRepo::class);
 225         $pageRepo->updatePage($page, $page->book_id, [
 226             'name' => $page->name,
 227             'html' => $page->html . "<img src=\"{$image->url}\">",
 228             'summary' => ''
 229         ]);
 230
 231         // Ensure no images are reported as deletable
 232         $imageService = app(ImageService::class);
 233         $toDelete = $imageService->deleteUnusedImages(true, true);
 234         $this->assertCount(0, $toDelete);
 235
 236         // Save a revision of our page without the image;
 237         $pageRepo->updatePage($page, $page->book_id, [
 238             'name' => $page->name,
 239             'html' => "<p>Hello</p>",
 240             'summary' => ''
 241         ]);
 242
 243         // Ensure revision images are picked up okay
 244         $imageService = app(ImageService::class);
 245         $toDelete = $imageService->deleteUnusedImages(true, true);
 246         $this->assertCount(0, $toDelete);
 247         $toDelete = $imageService->deleteUnusedImages(false, true);
 248         $this->assertCount(1, $toDelete);
 249
 250         // Check image is found when revisions are destroyed
 251         $page->revisions()->delete();
 252         $toDelete = $imageService->deleteUnusedImages(true, true);
 253         $this->assertCount(1, $toDelete);
 254
 255         // Check the image is deleted
 256         $absPath = public_path($relPath);
 257         $this->assertTrue(file_exists($absPath), "Existing uploaded file at path {$absPath} exists");
 258         $toDelete = $imageService->deleteUnusedImages(true, false);
 259         $this->assertCount(1, $toDelete);
 260         $this->assertFalse(file_exists($absPath));
 261
 262         $this->deleteImage($relPath);
 263     }
 264
 265 }