Merge "pass codesniffer on tests/"

[lhc/web/wiklou.git] / includes / LinkFilter.php

diff --git a/includes/LinkFilter.php b/includes/LinkFilter.php
index 53841df..c2f6b1e 100644 (file)
--- a/includes/LinkFilter.php
+++ b/includes/LinkFilter.php
@@ -1,8 +1,29 @@
 <?php
+/**
+ * Functions to help implement an external link filter for spam control.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
 
 /**
  * Some functions to help implement an external link filter for spam control.
- * 
+ *
  * @todo implement the filter. Currently these are just some functions to help
  * maintenance/cleanupSpam.php remove links to a single specified domain. The
  * next thing is to implement functions for checking a given page against a big
@@ -13,13 +34,22 @@
 class LinkFilter {
 
        /**
-        * Check whether $text contains a link to $filterEntry
+        * Check whether $content contains a link to $filterEntry
         *
-        * @param $text String: text to check
+        * @param $content Content: content to check
         * @param $filterEntry String: domainparts, see makeRegex() for more details
         * @return Integer: 0 if no match or 1 if there's at least one match
         */
-       static function matchEntry( $text, $filterEntry ) {
+       static function matchEntry( Content $content, $filterEntry ) {
+               if ( !( $content instanceof TextContent ) ) {
+                       //TODO: handle other types of content too.
+                       //      Maybe create ContentHandler::matchFilter( LinkFilter ).
+                       //      Think about a common base class for LinkFilter and MagicWord.
+                       return 0;
+               }
+
+               $text = $content->getNativeData();
+
                $regex = LinkFilter::makeRegex( $filterEntry );
                return preg_match( $regex, $text );
        }
@@ -41,42 +71,6 @@ class LinkFilter {
                return $regex;
        }
 
-       /**
-        * Make a string to go after an SQL LIKE, which will match the specified
-        * string. There are several kinds of filter entry:
-        *     *.domain.com    -  Produces http://com.domain.%, matches domain.com
-        *                        and www.domain.com
-        *     domain.com      -  Produces http://com.domain./%, matches domain.com
-        *                        or domain.com/ but not www.domain.com
-        *     *.domain.com/x  -  Produces http://com.domain.%/x%, matches
-        *                        www.domain.com/xy
-        *     domain.com/x    -  Produces http://com.domain./x%, matches
-        *                        domain.com/xy but not www.domain.com/xy
-        *
-        * Asterisks in any other location are considered invalid.
-        * 
-        * @param $filterEntry String: domainparts
-        * @param $prot        String: protocol
-        * @return String
-        * @deprecated Use makeLikeArray() and pass result to Database::buildLike() instead
-        */
-        public static function makeLike( $filterEntry , $prot = 'http://' ) {
-               wfDeprecated( __METHOD__ );
-
-               $like = self::makeLikeArray( $filterEntry , $prot );
-               if ( !$like ) {
-                       return false;
-               }
-               $dbw = wfGetDB( DB_MASTER );
-               $s = $dbw->buildLike( $like );
-               $m = false;
-               if ( preg_match( "/^ *LIKE '(.*)' *$/", $s, $m ) ) {
-                       return $m[1];
-               } else {
-                       throw new MWException( __METHOD__.': this DBMS is not supported by this function.' );
-               }
-       }
-
        /**
         * Make an array to be used for calls to DatabaseBase::buildLike(), which
         * will match the specified string. There are several kinds of filter entry:
@@ -125,17 +119,17 @@ class LinkFilter {
                // Reverse the labels in the hostname, convert to lower case
                // For emails reverse domainpart only
                if ( $prot == 'mailto:' && strpos($host, '@') ) {
-                       // complete email adress 
+                       // complete email adress
                        $mailparts = explode( '@', $host );
                        $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
                        $host = $domainpart . '@' . $mailparts[0];
                        $like = array( "$prot$host", $db->anyString() );
                } elseif ( $prot == 'mailto:' ) {
                        // domainpart of email adress only. do not add '.'
-                       $host = strtolower( implode( '.', array_reverse( explode( '.', $host ) ) ) );   
-                       $like = array( "$prot$host", $db->anyString() );                        
+                       $host = strtolower( implode( '.', array_reverse( explode( '.', $host ) ) ) );
+                       $like = array( "$prot$host", $db->anyString() );
                } else {
-                       $host = strtolower( implode( '.', array_reverse( explode( '.', $host ) ) ) );   
+                       $host = strtolower( implode( '.', array_reverse( explode( '.', $host ) ) ) );
                        if ( substr( $host, -1, 1 ) !== '.' ) {
                                $host .= '.';
                        }
@@ -156,7 +150,7 @@ class LinkFilter {
         * Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
         *
         * @param $arr array: array to filter
-        * @return filtered array
+        * @return array filtered array
         */
        public static function keepOneWildcard( $arr ) {
                if( !is_array( $arr ) ) {