silverstripe-cms/tests/php/Model/SiteTreeLinkTrackingTest.php

<?php

namespace SilverStripe\CMS\Tests\Model;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Model\SiteTreeLinkTracking_Parser;
use SilverStripe\Control\Director;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\View\Parsers\HTMLValue;

class SiteTreeLinkTrackingTest extends SapphireTest
{

    protected function setUp(): void
    {
        parent::setUp();
        Director::config()->set('alternate_base_url', 'http://www.mysite.com/');
    }

    protected function isBroken($content)
    {
        $parser = new SiteTreeLinkTracking_Parser();
        $htmlValue = HTMLValue::create($content);
        $links = $parser->process($htmlValue);

        if (empty($links[0])) {
            return false;
        }
        return $links[0]['Broken'];
    }

    public function testParser()
    {
        SiteTree::add_extension(SiteTree::class, SiteTreeLinkTracking_Extension::class);

        // Shortcodes
        $this->assertTrue($this->isBroken('<a href="[sitetree_link,id=123]">link</a>'));
        $this->assertTrue($this->isBroken('<a href="[sitetree_link,id=123]#no-such-anchor">link</a>'));

        // Relative urls
        $this->assertTrue($this->isBroken('<a href="">link</a>'));
        $this->assertTrue($this->isBroken('<a href="/">link</a>'));

        // Non-shortcodes, assume non-broken without due reason
        $this->assertFalse($this->isBroken('<a href="/some-page">link</a>'));
        $this->assertFalse($this->isBroken('<a href="some-page">link</a>'));

        // Absolute urls
        $this->assertFalse($this->isBroken('<a href="http://www.mysite.com/some-page">link</a>'));
        $this->assertFalse($this->isBroken('<a href="http://www.google.com/some-page">link</a>'));

        // Anchors
        $this->assertFalse($this->isBroken('<a name="anchor">anchor</a>'));
        $this->assertFalse($this->isBroken('<a id="anchor">anchor</a>'));
        $this->assertTrue($this->isBroken('<a href="##anchor">anchor</a>'));

        $page = new SiteTree();
        $page->Content = '<a name="yes-name-anchor">name</a><a id="yes-id-anchor">id</a>';
        $page->write();

        $this->assertFalse($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]\">link</a>"));
        $this->assertFalse($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]#yes-name-anchor\">link</a>"));
        $this->assertFalse($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]#yes-id-anchor\">link</a>"));
        $this->assertTrue($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]#http://invalid-anchor.com\"></a>"));

        // Anchors Via updateAnchorsOnPage Extension
        $this->assertFalse($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]#extension-anchor\">link</a>"));
        $this->assertTrue($this->isBroken("<a href=\"[sitetree_link,id=$page->ID]#no-such-anchor\"></a>"));
    }

    protected function highlight($content)
    {
        $page = new SiteTree();
        $page->Content = $content;
        $page->write();
        return $page->Content;
    }

    public function testHighlighter()
    {
        $content = $this->highlight('<a href="[sitetree_link,id=123]" class="existing-class">link</a>');
        $this->assertEquals(substr_count($content ?? '', 'ss-broken'), 1, 'A ss-broken class is added to the broken link.');
        $this->assertEquals(substr_count($content ?? '', 'existing-class'), 1, 'Existing class is not removed.');

        $content = $this->highlight('<a href="[sitetree_link,id=123]">link</a>');
        $this->assertEquals(substr_count($content ?? '', 'ss-broken'), 1, 'ss-broken class is added to the broken link.');

        $otherPage = new SiteTree();
        $otherPage->Content = '';
        $otherPage->write();

        $content = $this->highlight(
            "<a href=\"[sitetree_link,id=$otherPage->ID]\" class=\"existing-class ss-broken ss-broken\">link</a>"
        );
        $this->assertEquals(substr_count($content ?? '', 'ss-broken'), 0, 'All ss-broken classes are removed from good link');
        $this->assertEquals(substr_count($content ?? '', 'existing-class'), 1, 'Existing class is not removed.');
    }
}