]> BookStack Code Mirror - bookstack/blob - app/References/ReferenceUpdater.php
Images: Added nulling of image page relation on page delete
[bookstack] / app / References / ReferenceUpdater.php
1 <?php
2
3 namespace BookStack\References;
4
5 use BookStack\Entities\Models\Book;
6 use BookStack\Entities\Models\HasDescriptionInterface;
7 use BookStack\Entities\Models\Entity;
8 use BookStack\Entities\Models\EntityContainerData;
9 use BookStack\Entities\Models\Page;
10 use BookStack\Entities\Repos\RevisionRepo;
11 use BookStack\Util\HtmlDocument;
12
13 class ReferenceUpdater
14 {
15     public function __construct(
16         protected ReferenceFetcher $referenceFetcher,
17         protected RevisionRepo $revisionRepo,
18     ) {
19     }
20
21     public function updateEntityReferences(Entity $entity, string $oldLink): void
22     {
23         $references = $this->getReferencesToUpdate($entity);
24         $newLink = $entity->getUrl();
25
26         foreach ($references as $reference) {
27             /** @var Entity $entity */
28             $entity = $reference->from;
29             $this->updateReferencesWithinEntity($entity, $oldLink, $newLink);
30         }
31     }
32
33     /**
34      * @return Reference[]
35      */
36     protected function getReferencesToUpdate(Entity $entity): array
37     {
38         /** @var Reference[] $references */
39         $references = $this->referenceFetcher->getReferencesToEntity($entity, true)->values()->all();
40
41         if ($entity instanceof Book) {
42             $pages = $entity->pages()->get(['id']);
43             $chapters = $entity->chapters()->get(['id']);
44             $children = $pages->concat($chapters);
45             foreach ($children as $bookChild) {
46                 /** @var Reference[] $childRefs */
47                 $childRefs = $this->referenceFetcher->getReferencesToEntity($bookChild, true)->values()->all();
48                 array_push($references, ...$childRefs);
49             }
50         }
51
52         $deduped = [];
53         foreach ($references as $reference) {
54             $key = $reference->from_id . ':' . $reference->from_type;
55             $deduped[$key] = $reference;
56         }
57
58         return array_values($deduped);
59     }
60
61     protected function updateReferencesWithinEntity(Entity $entity, string $oldLink, string $newLink): void
62     {
63         if ($entity instanceof Page) {
64             $this->updateReferencesWithinPage($entity, $oldLink, $newLink);
65         }
66
67         if ($entity instanceof HasDescriptionInterface) {
68             $this->updateReferencesWithinDescription($entity, $oldLink, $newLink);
69         }
70     }
71
72     protected function updateReferencesWithinDescription(Entity&HasDescriptionInterface $entity, string $oldLink, string $newLink): void
73     {
74         $description = $entity->descriptionInfo();
75         $html = $this->updateLinksInHtml($description->getHtml(true) ?: '', $oldLink, $newLink);
76         $description->set($html);
77         $entity->save();
78     }
79
80     protected function updateReferencesWithinPage(Page $page, string $oldLink, string $newLink): void
81     {
82         $page = (clone $page)->refresh();
83         $html = $this->updateLinksInHtml($page->html, $oldLink, $newLink);
84         $markdown = $this->updateLinksInMarkdown($page->markdown, $oldLink, $newLink);
85
86         $page->html = $html;
87         $page->markdown = $markdown;
88         $page->revision_count++;
89         $page->save();
90
91         $summary = trans('entities.pages_references_update_revision');
92         $this->revisionRepo->storeNewForPage($page, $summary);
93     }
94
95     protected function updateLinksInMarkdown(string $markdown, string $oldLink, string $newLink): string
96     {
97         if (empty($markdown)) {
98             return $markdown;
99         }
100
101         $commonLinkRegex = '/(\[.*?\]\()' . preg_quote($oldLink, '/') . '(.*?\))/i';
102         $markdown = preg_replace($commonLinkRegex, '$1' . $newLink . '$2', $markdown);
103
104         $referenceLinkRegex = '/(\[.*?\]:\s?)' . preg_quote($oldLink, '/') . '(.*?)($|\s)/i';
105         $markdown = preg_replace($referenceLinkRegex, '$1' . $newLink . '$2$3', $markdown);
106
107         return $markdown;
108     }
109
110     protected function updateLinksInHtml(string $html, string $oldLink, string $newLink): string
111     {
112         if (empty($html)) {
113             return $html;
114         }
115
116         $doc = new HtmlDocument($html);
117         $anchors = $doc->queryXPath('//a[@href]');
118
119         /** @var \DOMElement $anchor */
120         foreach ($anchors as $anchor) {
121             $link = $anchor->getAttribute('href');
122             $updated = str_ireplace($oldLink, $newLink, $link);
123             $anchor->setAttribute('href', $updated);
124         }
125
126         return $doc->getBodyInnerHtml();
127     }
128 }