* Document a bit

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

diff --git a/includes/SquidUpdate.php b/includes/SquidUpdate.php
index 2e2a4a5..1323ffa 100644 (file)
--- a/includes/SquidUpdate.php
+++ b/includes/SquidUpdate.php
@@ -1,17 +1,18 @@
 <?php
 /**
  * See deferred.txt
- * @package MediaWiki
+ * @file
+ * @ingroup Cache
  */
 
 /**
- *
- * @package MediaWiki
+ * Handles purging appropriate Squid URLs given a title (or titles)
+ * @ingroup Cache
  */
 class SquidUpdate {
        var $urlArr, $mMaxTitles;
 
-       function SquidUpdate( $urlArr = Array(), $maxTitles = false ) {
+       function __construct( $urlArr = Array(), $maxTitles = false ) {
                global $wgMaxSquidPurgeTitles;
                if ( $maxTitles === false ) {
                        $this->mMaxTitles = $wgMaxSquidPurgeTitles;
@@ -24,19 +25,18 @@ class SquidUpdate {
                $this->urlArr = $urlArr;
        }
 
-       /* static */ function newFromLinksTo( &$title ) {
-               $fname = 'SquidUpdate::newFromLinksTo';
-               wfProfileIn( $fname );
+       static function newFromLinksTo( &$title ) {
+               wfProfileIn( __METHOD__ );
 
                # Get a list of URLs linking to this page
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $res = $dbr->select( array( 'links', 'page' ),
                        array( 'page_namespace', 'page_title' ),
                        array(
                                'pl_namespace' => $title->getNamespace(),
-                               'pl_title'     => $title->getDbKey(),
+                               'pl_title'     => $title->getDBkey(),
                                'pl_from=page_id' ),
-                       $fname );
+                       __METHOD__ );
                $blurlArr = $title->getSquidURLs();
                if ( $dbr->numRows( $res ) <= $this->mMaxTitles ) {
                        while ( $BL = $dbr->fetchObject ( $res ) )
@@ -47,22 +47,26 @@ class SquidUpdate {
                }
                $dbr->freeResult ( $res ) ;
 
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return new SquidUpdate( $blurlArr );
        }
 
-       /* static */ function newFromTitles( &$titles, $urlArr = array() ) {
+       /**
+        * Create a SquidUpdate from an array of Title objects, or a TitleArray object
+        */
+       static function newFromTitles( $titles, $urlArr = array() ) {
                global $wgMaxSquidPurgeTitles;
-               if ( count( $titles ) > $wgMaxSquidPurgeTitles ) {
-                       $titles = array_slice( $titles, 0, $wgMaxSquidPurgeTitles );
-               }
+               $i = 0;
                foreach ( $titles as $title ) {
                        $urlArr[] = $title->getInternalURL();
+                       if ( $i++ > $wgMaxSquidPurgeTitles ) {
+                               break;
+                       }
                }
                return new SquidUpdate( $urlArr );
        }
 
-       /* static */ function newSimplePurge( &$title ) {
+       static function newSimplePurge( &$title ) {
                $urlArr = $title->getSquidURLs();
                return new SquidUpdate( $urlArr );
        }
@@ -76,19 +80,23 @@ class SquidUpdate {
        (example: $urlArr[] = 'http://my.host/something')
        XXX report broken Squids per mail or log */
 
-       /* static */ function purge( $urlArr ) {
-               global $wgSquidServers, $wgHTCPMulticastAddress, $wgHTCPPort;
+       static function purge( $urlArr ) {
+               global $wgSquidServers, $wgHTCPMulticastAddress, $wgHTCPPort, $wgSquidResponseLimit;
 
                /*if ( (@$wgSquidServers[0]) == 'echo' ) {
                        echo implode("<br />\n", $urlArr) . "<br />\n";
                        return;
                }*/
 
-               if ( $wgHTCPMulticastAddress && $wgHTCPPort )
-                       SquidUpdate::HTCPPurge( $urlArr );
+               if( empty( $urlArr ) ) {
+                       return;
+               }
+
+               if ( $wgHTCPMulticastAddress && $wgHTCPPort ) {
+                       return SquidUpdate::HTCPPurge( $urlArr );
+               }
 
-               $fname = 'SquidUpdate::purge';
-               wfProfileIn( $fname );
+               wfProfileIn( __METHOD__ );
 
                $maxsocketspersquid = 8; //  socket cap per Squid
                $urlspersocket = 400; // 400 seems to be a good tradeoff, opening a socket takes a while
@@ -132,7 +140,7 @@ class SquidUpdate {
                                                #$this->debug("\n");
                                                /* Squid only returns http headers with 200 or 404 status,
                                                if there's more returned something's wrong */
-                                               if (strlen($res) > 250) {
+                                               if (strlen($res) > $wgSquidResponseLimit) {
                                                        fclose($socket);
                                                        $failed = true;
                                                        $totalsockets -= $sockspersq;
@@ -145,8 +153,9 @@ class SquidUpdate {
                                        /* open the remaining sockets for this server */
                                        list($server, $port) = explode(':', $wgSquidServers[$ss]);
                                        if(!isset($port)) $port = 80;
-                                       $sockets[$so+1] = @fsockopen($server, $port, $error, $errstr, 2);
-                                       @stream_set_blocking($sockets[$so+1],false);
+                                       $socket = @fsockopen($server, $port, $error, $errstr, 2);
+                                       @stream_set_blocking($socket,false);
+                                       $sockets[] = $socket;
                                }
                                $so++;
                        }
@@ -188,13 +197,12 @@ class SquidUpdate {
                        @fclose($socket);
                }
                #$this->debug("\n");
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
        }
 
-       /* static */ function HTCPPurge( $urlArr ) {
+       static function HTCPPurge( $urlArr ) {
                global $wgHTCPMulticastAddress, $wgHTCPMulticastTTL, $wgHTCPPort;
-               $fname = 'SquidUpdate::HTCPPurge';
-               wfProfileIn( $fname );
+               wfProfileIn( __METHOD__ );
 
                $htcpOpCLR = 4;                 // HTCP CLR
 
@@ -206,7 +214,7 @@ class SquidUpdate {
                }
 
                // pfsockopen doesn't work because we need set_sock_opt
-               $conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
+               $conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
                if ( $conn ) {
                        // Set socket options
                        socket_set_option( $conn, IPPROTO_IP, IP_MULTICAST_LOOP, 0 );
@@ -216,10 +224,10 @@ class SquidUpdate {
 
                        foreach ( $urlArr as $url ) {
                                if( !is_string( $url ) ) {
-                                       wfDebugDieBacktrace( 'Bad purge URL' );
+                                       throw new MWException( 'Bad purge URL' );
                                }
                                $url = SquidUpdate::expand( $url );
-                               
+
                                // Construct a minimal HTCP request diagram
                                // as per RFC 2756
                                // Opcode 'CLR', no response desired, no auth
@@ -246,9 +254,9 @@ class SquidUpdate {
                        }
                } else {
                        $errstr = socket_strerror( socket_last_error() );
-                       wfDebug( "SquidUpdate::HTCPPurge(): Error opening UDP socket: $errstr\n" );
+                       wfDebug( __METHOD__ . "(): Error opening UDP socket: $errstr\n" );
                }
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
        }
 
        function debug( $text ) {
@@ -257,7 +265,7 @@ class SquidUpdate {
                        wfDebug( $text );
                }
        }
-       
+
        /**
         * Expand local URLs to fully-qualified URLs using the internal protocol
         * and host defined in $wgInternalServer. Input that's already fully-
@@ -279,4 +287,3 @@ class SquidUpdate {
                return $url;
        }
 }
-?>