Merge "Localisation updates from http://translatewiki.net."

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

diff --git a/includes/LinkFilter.php b/includes/LinkFilter.php
index 2764185..214f495 100644 (file)
--- a/includes/LinkFilter.php
+++ b/includes/LinkFilter.php
@@ -1,9 +1,30 @@
 <?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
+ * @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
  * list of domains.
@@ -11,8 +32,13 @@
  * Another cool thing to do would be a web interface for fast spam removal.
  */
 class LinkFilter {
+
        /**
-        * @static
+        * Check whether $text contains a link to $filterEntry
+        *
+        * @param $text String: text 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 ) {
                $regex = LinkFilter::makeRegex( $filterEntry );
@@ -20,7 +46,11 @@ class LinkFilter {
        }
 
        /**
-        * @static
+        * Builds a regex pattern for $filterEntry.
+        *
+        * @param $filterEntry String: URL, if it begins with "*.", it'll be
+        *        replaced to match any subdomain
+        * @return String: regex pattern, for preg_match()
         */
        private static function makeRegex( $filterEntry ) {
                $regex = '!http://';
@@ -33,8 +63,8 @@ class LinkFilter {
        }
 
        /**
-        * Make a string to go after an SQL LIKE, which will match the specified
-        * string. There are several kinds of filter entry:
+        * Make an array to be used for calls to DatabaseBase::buildLike(), 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
@@ -45,41 +75,10 @@ class LinkFilter {
         *                        domain.com/xy but not www.domain.com/xy
         *
         * Asterisks in any other location are considered invalid.
-        * 
-        * @static
-        * @param $filterEntry String: domainparts
-        * @param $prot        String: protocol
-        * @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 );
-
-               return $dbw->buildLike( $like );
-       }
-
-       /**
-        * Make an array to be used for calls to Database::buildLike(), 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.
-        * 
-        * @static
         * @param $filterEntry String: domainparts
         * @param $prot        String: protocol
+        * @return Array to be passed to DatabaseBase::buildLike() or false on error
         */
         public static function makeLikeArray( $filterEntry , $prot = 'http://' ) {
                $db = wfGetDB( DB_MASTER );
@@ -140,9 +139,9 @@ class LinkFilter {
 
        /**
         * Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
-        * @static
+        *
         * @param $arr array: array to filter
-        * @return filtered array
+        * @return array filtered array
         */
        public static function keepOneWildcard( $arr ) {
                if( !is_array( $arr ) ) {