BookStack Code Mirror - bookstack/blob - app/References/ReferenceUpdater.php

1 <?php

3 namespace BookStack\References;

5 use BookStack\Entities\Models\Book;

6 use BookStack\Entities\Models\Entity;

7 use BookStack\Entities\Models\Page;

8 use BookStack\Entities\Repos\RevisionRepo;

9 use DOMDocument;

10 use DOMXPath;

12 class ReferenceUpdater

13 {

14 protected ReferenceFetcher $referenceFetcher;

15 protected RevisionRepo $revisionRepo;

17 public function __construct(ReferenceFetcher $referenceFetcher, RevisionRepo $revisionRepo)

18 {

19 $this->referenceFetcher = $referenceFetcher;

20 $this->revisionRepo = $revisionRepo;

21 }

23 public function updateEntityPageReferences(Entity $entity, string $oldLink)

24 {

25 $references = $this->getReferencesToUpdate($entity);

26 $newLink = $entity->getUrl();

28 /** @var Reference $reference */

29 foreach ($references as $reference) {

30 /** @var Page $page */

31 $page = $reference->from;

32 $this->updateReferencesWithinPage($page, $oldLink, $newLink);

33 }

34 }

36 /**

37 * @return Reference[]

38 */

39 protected function getReferencesToUpdate(Entity $entity): array

40 {

41 /** @var Reference[] $references */

42 $references = $this->referenceFetcher->getPageReferencesToEntity($entity)->values()->all();

44 if ($entity instanceof Book) {

45 $pages = $entity->pages()->get(['id']);

46 $chapters = $entity->chapters()->get(['id']);

47 $children = $pages->concat($chapters);

48 foreach ($children as $bookChild) {

49 $childRefs = $this->referenceFetcher->getPageReferencesToEntity($bookChild)->values()->all();

50 array_push($references, ...$childRefs);

51 }

52 }

54 $deduped = [];

55 foreach ($references as $reference) {

56 $key = $reference->from_id . ':' . $reference->from_type;

57 $deduped[$key] = $reference;

58 }

60 return array_values($deduped);

61 }

63 protected function updateReferencesWithinPage(Page $page, string $oldLink, string $newLink)

64 {

65 $page = (clone $page)->refresh();

66 $html = $this->updateLinksInHtml($page->html, $oldLink, $newLink);

67 $markdown = $this->updateLinksInMarkdown($page->markdown, $oldLink, $newLink);

69 $page->html = $html;

70 $page->markdown = $markdown;

71 $page->revision_count++;

72 $page->save();

74 $summary = trans('entities.pages_references_update_revision');

75 $this->revisionRepo->storeNewForPage($page, $summary);

76 }

78 protected function updateLinksInMarkdown(string $markdown, string $oldLink, string $newLink): string

79 {

80 if (empty($markdown)) {

81 return $markdown;

82 }

84 $commonLinkRegex = '/(\[.*?\]$)' . preg_quote($oldLink, '/') . '(.*?$)/i';

85 $markdown = preg_replace($commonLinkRegex, '$1' . $newLink . '$2', $markdown);

87 $referenceLinkRegex = '/(\[.*?\]:\s?)' . preg_quote($oldLink, '/') . '(.*?)($|\s)/i';

88 $markdown = preg_replace($referenceLinkRegex, '$1' . $newLink . '$2$3', $markdown);

90 return $markdown;

91 }

93 protected function updateLinksInHtml(string $html, string $oldLink, string $newLink): string

94 {

95 if (empty($html)) {

96 return $html;

97 }

99 $html = '<body>' . $html . '</body>';

100 libxml_use_internal_errors(true);

101 $doc = new DOMDocument();

102 $doc->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));

103

104 $xPath = new DOMXPath($doc);

105 $anchors = $xPath->query('//a[@href]');

106

107 /** @var \DOMElement $anchor */

108 foreach ($anchors as $anchor) {

109 $link = $anchor->getAttribute('href');

110 $updated = str_ireplace($oldLink, $newLink, $link);

111 $anchor->setAttribute('href', $updated);

112 }

113

114 $html = '';

115 $topElems = $doc->documentElement->childNodes->item(0)->childNodes;

116 foreach ($topElems as $child) {

117 $html .= $doc->saveHTML($child);

118 }

119

120 return $html;

121 }

122 }