]> BookStack Code Mirror - bookstack/blob - app/References/ReferenceUpdater.php
Rolled out reference link updating logic usage
[bookstack] / app / References / ReferenceUpdater.php
1 <?php
2
3 namespace BookStack\References;
4
5 use BookStack\Entities\Models\Entity;
6 use BookStack\Entities\Models\Page;
7 use BookStack\Entities\Repos\RevisionRepo;
8 use DOMDocument;
9 use DOMXPath;
10
11 class ReferenceUpdater
12 {
13     protected ReferenceFetcher $referenceFetcher;
14     protected RevisionRepo $revisionRepo;
15
16     public function __construct(ReferenceFetcher $referenceFetcher, RevisionRepo $revisionRepo)
17     {
18         $this->referenceFetcher = $referenceFetcher;
19         $this->revisionRepo = $revisionRepo;
20     }
21
22     public function updateEntityPageReferences(Entity $entity, string $oldLink)
23     {
24         $references = $this->referenceFetcher->getPageReferencesToEntity($entity);
25         $newLink = $entity->getUrl();
26
27         /** @var Reference $reference */
28         foreach ($references as $reference) {
29             /** @var Page $page */
30             $page = $reference->from;
31             $this->updateReferencesWithinPage($page, $oldLink, $newLink);
32         }
33     }
34
35     protected function updateReferencesWithinPage(Page $page, string $oldLink, string $newLink)
36     {
37         $page = (clone $page)->refresh();
38         $html = $this->updateLinksInHtml($page->html, $oldLink, $newLink);
39         $markdown = $this->updateLinksInMarkdown($page->markdown, $oldLink, $newLink);
40
41         $page->html = $html;
42         $page->markdown = $markdown;
43         $page->revision_count++;
44         $page->save();
45
46         $summary = trans('entities.pages_references_update_revision');
47         $this->revisionRepo->storeNewForPage($page, $summary);
48     }
49
50     protected function updateLinksInMarkdown(string $markdown, string $oldLink, string $newLink): string
51     {
52         if (empty($markdown)) {
53             return $markdown;
54         }
55
56         $commonLinkRegex = '/(\[.*?\]\()' . preg_quote($oldLink, '/') . '(.*?\))/i';
57         $markdown = preg_replace($commonLinkRegex, '$1' . $newLink . '$2', $markdown);
58
59         $referenceLinkRegex = '/(\[.*?\]:\s?)' . preg_quote($oldLink, '/') . '(.*?)($|\s)/i';
60         $markdown = preg_replace($referenceLinkRegex, '$1' . $newLink . '$2$3', $markdown);
61
62         return $markdown;
63     }
64
65     protected function updateLinksInHtml(string $html, string $oldLink, string $newLink): string
66     {
67         if (empty($html)) {
68             return $html;
69         }
70
71         $html = '<body>' . $html . '</body>';
72         libxml_use_internal_errors(true);
73         $doc = new DOMDocument();
74         $doc->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));
75
76         $xPath = new DOMXPath($doc);
77         $anchors = $xPath->query('//a[@href]');
78
79         /** @var \DOMElement $anchor */
80         foreach ($anchors as $anchor) {
81             $link = $anchor->getAttribute('href');
82             $updated = str_ireplace($oldLink, $newLink, $link);
83             $anchor->setAttribute('href', $updated);
84         }
85
86         $html = '';
87         $topElems = $doc->documentElement->childNodes->item(0)->childNodes;
88         foreach ($topElems as $child) {
89             $html .= $doc->saveHTML($child);
90         }
91
92         return $html;
93     }
94 }