colin
/
bookstack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added book child reference handling on book url change 

Closes #3683
This commit is contained in:
Dan Brown 2022-08-30 22:00:32 +01:00
parent 1cc7c649dc
commit 9153be963d
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
2 changed files with 80 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
app/References/ReferenceUpdater.php
View File

@ -2,6 +2,7 @@
namespace BookStack\References; namespace BookStack\References;
use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Entity; use BookStack\Entities\Models\Entity;
use BookStack\Entities\Models\Page; use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\RevisionRepo; use BookStack\Entities\Repos\RevisionRepo;
@ -21,7 +22,7 @@ class ReferenceUpdater
public function updateEntityPageReferences(Entity $entity, string $oldLink) public function updateEntityPageReferences(Entity $entity, string $oldLink)
{ {
$references = $this->referenceFetcher->getPageReferencesToEntity($entity); $references = $this->getReferencesToUpdate($entity);
$newLink = $entity->getUrl(); $newLink = $entity->getUrl();
/** @var Reference $reference */ /** @var Reference $reference */
@ -32,6 +33,33 @@ class ReferenceUpdater
} }
} }
/**
* @return Reference[]
*/
protected function getReferencesToUpdate(Entity $entity): array
{
/** @var Reference[] $references */
$references = $this->referenceFetcher->getPageReferencesToEntity($entity)->values()->all();
if ($entity instanceof Book) {
$pages = $entity->pages()->get(['id']);
$chapters = $entity->chapters()->get(['id']);
$children = $pages->concat($chapters);
foreach ($children as $bookChild) {
$childRefs = $this->referenceFetcher->getPageReferencesToEntity($bookChild)->values()->all();
array_push($references, ...$childRefs);
}
}
$deduped = [];
foreach ($references as $reference) {
$key = $reference->from_id . ':' . $reference->from_type;
$deduped[$key] = $reference;
}
return array_values($deduped);
}
protected function updateReferencesWithinPage(Page $page, string $oldLink, string $newLink) protected function updateReferencesWithinPage(Page $page, string $oldLink, string $newLink)
{ {
$page = (clone $page)->refresh(); $page = (clone $page)->refresh();

51
tests/References/ReferencesTest.php
View File

@ -3,6 +3,7 @@
namespace Tests\References; namespace Tests\References;
use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page; use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo; use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\TrashCan; use BookStack\Entities\Tools\TrashCan;
@ -145,6 +146,56 @@ class ReferencesTest extends TestCase
} }
} }
public function test_pages_linking_to_other_page_updated_on_parent_book_url_change()
{
/** @var Page $bookPage */
/** @var Page $otherPage */
/** @var Book $book */
$bookPage = Page::query()->first();
$otherPage = Page::query()->where('id', '!=', $bookPage->id)->first();
$book = $bookPage->book;
$otherPage->html = '<a href="' . $bookPage->getUrl() . '">Link</a>';
$otherPage->save();
$this->createReference($otherPage, $bookPage);
$this->asEditor()->put($book->getUrl(), [
'name' => 'my updated book slugaroo',
]);
$otherPage->refresh();
$this->assertStringContainsString('href="http://localhost/books/my-updated-book-slugaroo/page/' . $bookPage->slug . '"', $otherPage->html);
$this->assertDatabaseHas('page_revisions', [
'page_id' => $otherPage->id,
'summary' => 'System auto-update of internal links',
]);
}
public function test_pages_linking_to_chapter_updated_on_parent_book_url_change()
{
/** @var Chapter $bookChapter */
/** @var Page $otherPage */
/** @var Book $book */
$bookChapter = Chapter::query()->first();
$otherPage = Page::query()->first();
$book = $bookChapter->book;
$otherPage->html = '<a href="' . $bookChapter->getUrl() . '">Link</a>';
$otherPage->save();
$this->createReference($otherPage, $bookChapter);
$this->asEditor()->put($book->getUrl(), [
'name' => 'my updated book slugaroo',
]);
$otherPage->refresh();
$this->assertStringContainsString('href="http://localhost/books/my-updated-book-slugaroo/chapter/' . $bookChapter->slug . '"', $otherPage->html);
$this->assertDatabaseHas('page_revisions', [
'page_id' => $otherPage->id,
'summary' => 'System auto-update of internal links',
]);
}
public function test_markdown_links_leading_to_entity_updated_on_url_change() public function test_markdown_links_leading_to_entity_updated_on_url_change()
{ {
/** @var Page $page */ /** @var Page $page */