BookStack Code Mirror - bookstack/blob - tests/Entity/ExportTest.php

   1 <?php namespace Tests\Entity;
   2
   3 use BookStack\Entities\Models\Book;
   4 use BookStack\Entities\Models\Chapter;
   5 use BookStack\Entities\Models\Page;
   6 use Illuminate\Support\Facades\Storage;
   7 use Illuminate\Support\Str;
   8 use Tests\TestCase;
   9
  10 class ExportTest extends TestCase
  11 {
  12
  13     public function test_page_text_export()
  14     {
  15         $page = Page::query()->first();
  16         $this->asEditor();
  17
  18         $resp = $this->get($page->getUrl('/export/plaintext'));
  19         $resp->assertStatus(200);
  20         $resp->assertSee($page->name);
  21         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $page->slug . '.txt"');
  22     }
  23
  24     public function test_page_pdf_export()
  25     {
  26         $page = Page::query()->first();
  27         $this->asEditor();
  28
  29         $resp = $this->get($page->getUrl('/export/pdf'));
  30         $resp->assertStatus(200);
  31         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $page->slug . '.pdf"');
  32     }
  33
  34     public function test_page_html_export()
  35     {
  36         $page = Page::query()->first();
  37         $this->asEditor();
  38
  39         $resp = $this->get($page->getUrl('/export/html'));
  40         $resp->assertStatus(200);
  41         $resp->assertSee($page->name);
  42         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $page->slug . '.html"');
  43     }
  44
  45     public function test_book_text_export()
  46     {
  47         $page = Page::query()->first();
  48         $book = $page->book;
  49         $this->asEditor();
  50
  51         $resp = $this->get($book->getUrl('/export/plaintext'));
  52         $resp->assertStatus(200);
  53         $resp->assertSee($book->name);
  54         $resp->assertSee($page->name);
  55         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.txt"');
  56     }
  57
  58     public function test_book_pdf_export()
  59     {
  60         $page = Page::query()->first();
  61         $book = $page->book;
  62         $this->asEditor();
  63
  64         $resp = $this->get($book->getUrl('/export/pdf'));
  65         $resp->assertStatus(200);
  66         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.pdf"');
  67     }
  68
  69     public function test_book_html_export()
  70     {
  71         $page = Page::query()->first();
  72         $book = $page->book;
  73         $this->asEditor();
  74
  75         $resp = $this->get($book->getUrl('/export/html'));
  76         $resp->assertStatus(200);
  77         $resp->assertSee($book->name);
  78         $resp->assertSee($page->name);
  79         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.html"');
  80     }
  81
  82     public function test_book_html_export_shows_chapter_descriptions()
  83     {
  84         $chapterDesc = 'My custom test chapter description ' . Str::random(12);
  85         $chapter = Chapter::query()->first();
  86         $chapter->description = $chapterDesc;
  87         $chapter->save();
  88
  89         $book = $chapter->book;
  90         $this->asEditor();
  91
  92         $resp = $this->get($book->getUrl('/export/html'));
  93         $resp->assertSee($chapterDesc);
  94     }
  95
  96     public function test_chapter_text_export()
  97     {
  98         $chapter = Chapter::query()->first();
  99         $page = $chapter->pages[0];
 100         $this->asEditor();
 101
 102         $resp = $this->get($chapter->getUrl('/export/plaintext'));
 103         $resp->assertStatus(200);
 104         $resp->assertSee($chapter->name);
 105         $resp->assertSee($page->name);
 106         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.txt"');
 107     }
 108
 109     public function test_chapter_pdf_export()
 110     {
 111         $chapter = Chapter::query()->first();
 112         $this->asEditor();
 113
 114         $resp = $this->get($chapter->getUrl('/export/pdf'));
 115         $resp->assertStatus(200);
 116         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.pdf"');
 117     }
 118
 119     public function test_chapter_html_export()
 120     {
 121         $chapter = Chapter::query()->first();
 122         $page = $chapter->pages[0];
 123         $this->asEditor();
 124
 125         $resp = $this->get($chapter->getUrl('/export/html'));
 126         $resp->assertStatus(200);
 127         $resp->assertSee($chapter->name);
 128         $resp->assertSee($page->name);
 129         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.html"');
 130     }
 131
 132     public function test_page_html_export_contains_custom_head_if_set()
 133     {
 134         $page = Page::query()->first();
 135
 136         $customHeadContent = "<style>p{color: red;}</style>";
 137         $this->setSettings(['app-custom-head' => $customHeadContent]);
 138
 139         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 140         $resp->assertSee($customHeadContent);
 141     }
 142
 143     public function test_page_html_export_does_not_break_with_only_comments_in_custom_head()
 144     {
 145         $page = Page::query()->first();
 146
 147         $customHeadContent = "<!-- A comment -->";
 148         $this->setSettings(['app-custom-head' => $customHeadContent]);
 149
 150         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 151         $resp->assertStatus(200);
 152         $resp->assertSee($customHeadContent);
 153     }
 154
 155     public function test_page_html_export_use_absolute_dates()
 156     {
 157         $page = Page::query()->first();
 158
 159         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 160         $resp->assertSee($page->created_at->formatLocalized('%e %B %Y %H:%M:%S'));
 161         $resp->assertDontSee($page->created_at->diffForHumans());
 162         $resp->assertSee($page->updated_at->formatLocalized('%e %B %Y %H:%M:%S'));
 163         $resp->assertDontSee($page->updated_at->diffForHumans());
 164     }
 165
 166     public function test_page_export_does_not_include_user_or_revision_links()
 167     {
 168         $page = Page::query()->first();
 169
 170         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 171         $resp->assertDontSee($page->getUrl('/revisions'));
 172         $resp->assertDontSee($page->createdBy->getProfileUrl());
 173         $resp->assertSee($page->createdBy->name);
 174     }
 175
 176     public function test_page_export_sets_right_data_type_for_svg_embeds()
 177     {
 178         $page = Page::query()->first();
 179         Storage::disk('local')->makeDirectory('uploads/images/gallery');
 180         Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', '<svg></svg>');
 181         $page->html = '<img src="http://localhost/uploads/images/gallery/svg_test.svg">';
 182         $page->save();
 183
 184         $this->asEditor();
 185         $resp = $this->get($page->getUrl('/export/html'));
 186         Storage::disk('local')->delete('uploads/images/gallery/svg_test.svg');
 187
 188         $resp->assertStatus(200);
 189         $resp->assertSee('<img src="data:image/svg+xml;base64');
 190     }
 191
 192     public function test_page_image_containment_works_on_multiple_images_within_a_single_line()
 193     {
 194         $page = Page::query()->first();
 195         Storage::disk('local')->makeDirectory('uploads/images/gallery');
 196         Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', '<svg></svg>');
 197         Storage::disk('local')->put('uploads/images/gallery/svg_test2.svg', '<svg></svg>');
 198         $page->html = '<img src="http://localhost/uploads/images/gallery/svg_test.svg" class="a"><img src="http://localhost/uploads/images/gallery/svg_test2.svg" class="b">';
 199         $page->save();
 200
 201         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 202         Storage::disk('local')->delete('uploads/images/gallery/svg_test.svg');
 203         Storage::disk('local')->delete('uploads/images/gallery/svg_test2.svg');
 204
 205         $resp->assertDontSee('http://localhost/uploads/images/gallery/svg_test');
 206     }
 207
 208     public function test_page_export_contained_html_image_fetches_only_run_when_url_points_to_image_upload_folder()
 209     {
 210         $page = Page::query()->first();
 211         $page->html = '<img src="http://localhost/uploads/images/gallery/svg_test.svg"/>'
 212             .'<img src="http://localhost/uploads/svg_test.svg"/>'
 213             .'<img src="/uploads/svg_test.svg"/>';
 214         $storageDisk = Storage::disk('local');
 215         $storageDisk->makeDirectory('uploads/images/gallery');
 216         $storageDisk->put('uploads/images/gallery/svg_test.svg', '<svg>good</svg>');
 217         $storageDisk->put('uploads/svg_test.svg', '<svg>bad</svg>');
 218         $page->save();
 219
 220         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 221
 222         $storageDisk->delete('uploads/images/gallery/svg_test.svg');
 223         $storageDisk->delete('uploads/svg_test.svg');
 224
 225         $resp->assertDontSee('http://localhost/uploads/images/gallery/svg_test.svg');
 226         $resp->assertSee('http://localhost/uploads/svg_test.svg');
 227         $resp->assertSee('src="/uploads/svg_test.svg"');
 228     }
 229
 230     public function test_exports_removes_scripts_from_custom_head()
 231     {
 232         $entities = [
 233             Page::query()->first(), Chapter::query()->first(), Book::query()->first(),
 234         ];
 235         setting()->put('app-custom-head', '<script>window.donkey = "cat";</script><style>.my-test-class { color: red; }</style>');
 236
 237         foreach ($entities as $entity) {
 238             $resp = $this->asEditor()->get($entity->getUrl('/export/html'));
 239             $resp->assertDontSee('window.donkey');
 240             $resp->assertDontSee('script');
 241             $resp->assertSee('.my-test-class { color: red; }');
 242         }
 243     }
 244
 245     public function test_page_export_with_deleted_creator_and_updater()
 246     {
 247         $user = $this->getViewer(['name' => 'ExportWizardTheFifth']);
 248         $page = Page::query()->first();
 249         $page->created_by = $user->id;
 250         $page->updated_by = $user->id;
 251         $page->save();
 252
 253         $resp = $this->asEditor()->get($page->getUrl('/export/html'));
 254         $resp->assertSee('ExportWizardTheFifth');
 255
 256         $user->delete();
 257         $resp = $this->get($page->getUrl('/export/html'));
 258         $resp->assertStatus(200);
 259         $resp->assertDontSee('ExportWizardTheFifth');
 260     }
 261
 262     public function test_page_markdown_export()
 263     {
 264         $page = Page::query()->first();
 265
 266         $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
 267         $resp->assertStatus(200);
 268         $resp->assertSee($page->name);
 269         $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $page->slug . '.md"');
 270     }
 271
 272     public function test_page_markdown_export_uses_existing_markdown_if_apparent()
 273     {
 274         $page = Page::query()->first()->forceFill([
 275             'markdown' => '# A header',
 276             'html' => '<h1>Dogcat</h1>',
 277         ]);
 278         $page->save();
 279
 280         $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
 281         $resp->assertSee('A header');
 282         $resp->assertDontSee('Dogcat');
 283     }
 284
 285     public function test_page_markdown_export_converts_html_where_no_markdown()
 286     {
 287         $page = Page::query()->first()->forceFill([
 288             'markdown' => '',
 289             'html' => "<h1>Dogcat</h1><p>Some <strong>bold</strong> text</p>",
 290         ]);
 291         $page->save();
 292
 293         $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
 294         $resp->assertSee("# Dogcat\n\nSome **bold** text");
 295     }
 296
 297     public function test_page_markdown_export_does_not_convert_callouts()
 298     {
 299         $page = Page::query()->first()->forceFill([
 300             'markdown' => '',
 301             'html' => "<h1>Dogcat</h1><p class=\"callout info\">Some callout text</p><p>Another line</p>",
 302         ]);
 303         $page->save();
 304
 305         $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
 306         $resp->assertSee("# Dogcat\n\n<p class=\"callout info\">Some callout text</p>\n\nAnother line");
 307     }
 308
 309     public function test_page_markdown_export_handles_bookstacks_wysiwyg_codeblock_format()
 310     {
 311         $page = Page::query()->first()->forceFill([
 312             'markdown' => '',
 313             'html' => '<h1>Dogcat</h1>'."\r\n".'<pre id="bkmrk-var-a-%3D-%27cat%27%3B"><code class="language-JavaScript">var a = \'cat\';</code></pre><p>Another line</p>',
 314         ]);
 315         $page->save();
 316
 317         $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
 318         $resp->assertSee("# Dogcat\n\n```JavaScript\nvar a = 'cat';\n```\n\nAnother line");
 319     }
 320
 321     public function test_chapter_markdown_export()
 322     {
 323         $chapter = Chapter::query()->first();
 324         $page = $chapter->pages()->first();
 325         $resp = $this->asEditor()->get($chapter->getUrl('/export/markdown'));
 326
 327         $resp->assertSee('# ' . $chapter->name);
 328         $resp->assertSee('# ' . $page->name);
 329     }
 330
 331     public function test_book_markdown_export()
 332     {
 333         $book = Book::query()->whereHas('pages')->whereHas('chapters')->first();
 334         $chapter = $book->chapters()->first();
 335         $page = $chapter->pages()->first();
 336         $resp = $this->asEditor()->get($book->getUrl('/export/markdown'));
 337
 338         $resp->assertSee('# ' . $book->name);
 339         $resp->assertSee('# ' . $chapter->name);
 340         $resp->assertSee('# ' . $page->name);
 341     }
 342
 343 }