Merge pull request #510 from wikimedia/transcluded-refs

Fix issue with cleaning transcluded reference links
wikimedia · Mar 20, 2024 · 86dc32b · 86dc32b
2 parents 50fa545 + 3ef1fba
commit 86dc32b
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/src/PageParser.php b/src/PageParser.php
@@ -442,8 +442,11 @@ private function cleanRedLinks() {
 
 	private function cleanReferenceLinks() {
 		$links = $this->xPath->query(
-			'//*[@typeof="mw:Extension/ref"]/a | //a[@rel="mw:referencedBy"]'
+			'//*[contains(@typeof,"mw:Extension/ref")]/a | //a[@rel="mw:referencedBy"]'
 		);
+		if ( !$links ) {
+			return;
+		}
 		foreach ( $links as $link ) {
 			$href = $link->getAttribute( 'href' );
 			$pos = strpos( $href, '#' );

diff --git a/tests/Book/PageParserTest.php b/tests/Book/PageParserTest.php
@@ -233,4 +233,25 @@ public function provideGetPicturesList(): array {
 			],
 		];
 	}
+
+	/**
+	 * @dataProvider provideCleanReferenceLinks
+	 */
+	public function testCleanReferenceLinks( string $html, string $expected ) {
+		$pageParser1 = new PageParser( Util::buildDOMDocumentFromHtml( $html ) );
+		$this->assertStringContainsString( $expected, $pageParser1->getContent( false )->saveXML() );
+	}
+
+	public function provideCleanReferenceLinks() {
+		return [
+			'no links to clean' => [
+				'<sup><a href="./Page#fn"><span>[1]</span></a></sup>',
+				'<a href="./Page#fn">',
+			],
+			'ref that is also transcluded' => [
+				'<sup class="mw-ref reference" id="cite_ref-1" rel="dc:references" typeof="mw:Transclusion mw:Extension/ref"><a href="./Page#cite_note-1"><span class="mw-reflink-text">[1]</span></a></sup>',
+				'<a href="#cite_note-1">',
+			],
+		];
+	}
 }