LinkFilterTest.php

Go to the documentation of this file.

<?php
 
use Wikimedia\Rdbms\LikeMatch;
 
class LinkFilterTest extends MediaWikiLangTestCase {
 
    protected function setUp() {
        parent::setUp();
 
        $this->setMwGlobals( 'wgUrlProtocols', [
            'http://',
            'https://',
            'ftp://',
            'irc://',
            'ircs://',
            'gopher://',
            'telnet://',
            'nntp://',
            'worldwind://',
            'mailto:',
            'news:',
            'svn://',
            'git://',
            'mms://',
            '//',
        ] );
    }
 
    function createRegexFromLIKE( $like ) {
        $regex = '!^';
 
        foreach ( $like as $item ) {
            if ( $item instanceof LikeMatch ) {
                if ( $item->toString() == '%' ) {
                    $regex .= '.*';
                } elseif ( $item->toString() == '_' ) {
                    $regex .= '.';
                }
            } else {
                $regex .= preg_quote( $item, '!' );
            }
 
        }
 
        $regex .= '$!';
 
        return $regex;
    }
 
    public static function provideValidPatterns() {
        return [
            // Protocol, Search pattern, URL which matches the pattern
            [ 'http://', '*.test.com', 'http://www.test.com' ],
            [ 'http://', 'test.com:8080/dir/file', 'http://name:pass@test.com:8080/dir/file' ],
            [ 'https://', '*.com', 'https://s.s.test..com:88/dir/file?a=1&b=2' ],
            [ 'https://', '*.com', 'https://name:pass@secure.com/index.html' ],
            [ 'http://', 'name:pass@test.com', 'http://test.com' ],
            [ 'http://', 'test.com', 'http://name:pass@test.com' ],
            [ 'http://', '*.test.com', 'http://a.b.c.test.com/dir/dir/file?a=6' ],
            [ null, 'http://*.test.com', 'http://www.test.com' ],
            [ 'mailto:', 'name@mail.test123.com', 'mailto:name@mail.test123.com' ],
            [ '',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg'
            ],
            [ '', 'http://name:pass@*.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg' ],
            [ '', 'http://name:wrongpass@*.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg' ],
            [ 'http://', 'name:pass@*.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg' ],
            [ '', 'http://name:pass@www.test.com:12345',
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg' ],
            [ 'ftp://', 'user:pass@ftp.test.com:1233/home/user/file;type=efw',
                'ftp://user:pass@ftp.test.com:1233/home/user/file;type=efw' ],
            [ null, 'ftp://otheruser:otherpass@ftp.test.com:1233/home/user/file;type=',
                'ftp://user:pass@ftp.test.com:1233/home/user/file;type=efw' ],
            [ null, 'ftp://@ftp.test.com:1233/home/user/file;type=',
                'ftp://user:pass@ftp.test.com:1233/home/user/file;type=efw' ],
            [ null, 'ftp://ftp.test.com/',
                'ftp://user:pass@ftp.test.com/home/user/file;type=efw' ],
            [ null, 'ftp://ftp.test.com/',
                'ftp://user:pass@ftp.test.com/home/user/file;type=efw' ],
            [ null, 'ftp://*.test.com:222/',
                'ftp://user:pass@ftp.test.com:222/home' ],
            [ 'irc://', '*.myserver:6667/', 'irc://test.myserver:6667/' ],
            [ 'irc://', 'name:pass@*.myserver/', 'irc://test.myserver:6667/' ],
            [ 'irc://', 'name:pass@*.myserver/', 'irc://other:@test.myserver:6667/' ],
            [ '', 'irc://test/name,string,abc?msg=t', 'irc://test/name,string,abc?msg=test' ],
            [ '', 'https://gerrit.wikimedia.org/r/#/q/status:open,n,z',
                'https://gerrit.wikimedia.org/r/#/q/status:open,n,z' ],
            [ '', 'https://gerrit.wikimedia.org',
                'https://gerrit.wikimedia.org/r/#/q/status:open,n,z' ],
            [ 'mailto:', '*.test.com', 'mailto:name@pop3.test.com' ],
            [ 'mailto:', 'test.com', 'mailto:name@test.com' ],
            [ 'news:', 'test.1234afc@news.test.com', 'news:test.1234afc@news.test.com' ],
            [ 'news:', '*.test.com', 'news:test.1234afc@news.test.com' ],
            [ '', 'news:4df8kh$iagfewewf(at)newsbf02aaa.news.aol.com',
                'news:4df8kh$iagfewewf(at)newsbf02aaa.news.aol.com' ],
            [ '', 'news:*.aol.com',
                'news:4df8kh$iagfewewf(at)newsbf02aaa.news.aol.com' ],
            [ '', 'git://github.com/prwef/abc-def.git', 'git://github.com/prwef/abc-def.git' ],
            [ 'git://', 'github.com/', 'git://github.com/prwef/abc-def.git' ],
            [ 'git://', '*.github.com/', 'git://a.b.c.d.e.f.github.com/prwef/abc-def.git' ],
            [ '', 'gopher://*.test.com/', 'gopher://gopher.test.com/0/v2/vstat' ],
            [ 'telnet://', '*.test.com', 'telnet://shell.test.com/~home/' ],
            [ '', 'http://test.com', 'http://test.com/index?arg=1' ],
            [ 'http://', '*.test.com', 'http://www.test.com/index?arg=1' ],
            [ '' ,
                'http://xx23124:__ffdfdef__@www.test.com:12345/dir' ,
                'http://name:pass@www.test.com:12345/dir/dir/file.xyz.php#__se__?arg1=_&arg2[]=4rtg'
            ],
 
            // Tests for false positives
            [ 'http://', 'test.com', 'http://www.test.com', false ],
            [ 'http://', 'www1.test.com', 'http://www.test.com', false ],
            [ 'http://', '*.test.com', 'http://www.test.t.com', false ],
            [ '', 'http://test.com:8080', 'http://www.test.com:8080', false ],
            [ '', 'https://test.com', 'http://test.com', false ],
            [ '', 'http://test.com', 'https://test.com', false ],
            [ 'http://', 'http://test.com', 'http://test.com', false ],
            [ null, 'http://www.test.com', 'http://www.test.com:80', false ],
            [ null, 'http://www.test.com:80', 'http://www.test.com', false ],
            [ null, 'http://*.test.com:80', 'http://www.test.com', false ],
            [ '', 'https://gerrit.wikimedia.org/r/#/XXX/status:open,n,z',
                'https://gerrit.wikimedia.org/r/#/q/status:open,n,z', false ],
            [ '', 'https://*.wikimedia.org/r/#/q/status:open,n,z',
                'https://gerrit.wikimedia.org/r/#/XXX/status:open,n,z', false ],
            [ 'mailto:', '@test.com', '@abc.test.com', false ],
            [ 'mailto:', 'mail@test.com', 'mail2@test.com', false ],
            [ '', 'mailto:mail@test.com', 'mail2@test.com', false ],
            [ '', 'mailto:@test.com', '@abc.test.com', false ],
            [ 'ftp://', '*.co', 'ftp://www.co.uk', false ],
            [ 'ftp://', '*.co', 'ftp://www.co.m', false ],
            [ 'ftp://', '*.co/dir/', 'ftp://www.co/dir2/', false ],
            [ 'ftp://', 'www.co/dir/', 'ftp://www.co/dir2/', false ],
            [ 'ftp://', 'test.com/dir/', 'ftp://test.com/', false ],
            [ '', 'http://test.com:8080/dir/', 'http://test.com:808/dir/', false ],
            [ '', 'http://test.com/dir/index.html', 'http://test.com/dir/index.php', false ],
 
            // These are false positives too and ideally shouldn't match, but that
            // would require using regexes and RLIKE instead of LIKE
            // [ null, 'http://*.test.com', 'http://www.test.com:80', false ],
            // [ '', 'https://*.wikimedia.org/r/#/q/status:open,n,z',
            //  'https://gerrit.wikimedia.org/XXX/r/#/q/status:open,n,z', false ],
        ];
    }
 
    function testMakeLikeArrayWithValidPatterns( $protocol, $pattern, $url, $shouldBeFound = true ) {
        $indexes = wfMakeUrlIndexes( $url );
        $likeArray = LinkFilter::makeLikeArray( $pattern, $protocol );
 
        $this->assertTrue( $likeArray !== false,
            "LinkFilter::makeLikeArray('$pattern', '$protocol') returned false on a valid pattern"
        );
 
        $regex = $this->createRegexFromLIKE( $likeArray );
        $debugmsg = "Regex: '" . $regex . "'\n";
        $debugmsg .= count( $indexes ) . " index(es) created by wfMakeUrlIndexes():\n";
 
        $matches = 0;
 
        foreach ( $indexes as $index ) {
            $matches += preg_match( $regex, $index );
            $debugmsg .= "\t'$index'\n";
        }
 
        if ( $shouldBeFound ) {
            $this->assertTrue(
                $matches > 0,
                "Search pattern '$protocol$pattern' does not find url '$url' \n$debugmsg"
            );
        } else {
            $this->assertFalse(
                $matches > 0,
                "Search pattern '$protocol$pattern' should not find url '$url' \n$debugmsg"
            );
        }
    }
 
    public static function provideInvalidPatterns() {
        return [
            [ '' ],
            [ '*' ],
            [ 'http://*' ],
            [ 'http://*/' ],
            [ 'http://*/dir/file' ],
            [ 'test.*.com' ],
            [ 'http://test.*.com' ],
            [ 'test.*.com' ],
            [ 'http://*.test.*' ],
            [ 'http://*test.com' ],
            [ 'https://*' ],
            [ '*://test.com' ],
            [ 'mailto:name:pass@t*est.com' ],
            [ 'http://*:888/' ],
            [ '*http://' ],
            [ 'test.com/*/index' ],
            [ 'test.com/dir/index?arg=*' ],
        ];
    }
 
    function testMakeLikeArrayWithInvalidPatterns( $pattern ) {
        $this->assertFalse(
            LinkFilter::makeLikeArray( $pattern ),
            "'$pattern' is not a valid pattern and should be rejected"
        );
    }
 
}