new feature: $wgBlockAllowsUTEdit
[lhc/web/wiklou.git] / includes / SquidUpdate.php
index bb90029..91769b2 100644 (file)
@@ -1,41 +1,66 @@
 <?php
-# See deferred.doc
+/**
+ * See deferred.txt
+ * @package MediaWiki
+ */
 
+/**
+ *
+ * @package MediaWiki
+ */
 class SquidUpdate {
-       var $urlArr;
+       var $urlArr, $mMaxTitles;
 
-       function SquidUpdate( $urlArr = Array() ) {
+       function SquidUpdate( $urlArr = Array(), $maxTitles = false ) {
+               global $wgMaxSquidPurgeTitles;
+               if ( $maxTitles === false ) {
+                       $this->mMaxTitles = $wgMaxSquidPurgeTitles;
+               } else {
+                       $this->mMaxTitles = $maxTitles;
+               }
+               if ( count( $urlArr ) > $this->mMaxTitles ) {
+                       $urlArr = array_slice( $urlArr, 0, $this->mMaxTitles );
+               }
                $this->urlArr = $urlArr;
        }
 
        /* static */ function newFromLinksTo( &$title ) {
+               $fname = 'SquidUpdate::newFromLinksTo';
+               wfProfileIn( $fname );
+
                # Get a list of URLs linking to this page
                $id = $title->getArticleID();
-               $sql = "SELECT cur_namespace,cur_title FROM links,cur WHERE l_to={$id} and l_from=cur_id" ;
-               $res = wfQuery ( $sql, DB_READ ) ;
+
+               $dbr =& wfGetDB( DB_SLAVE );
+               $links = $dbr->tableName( 'links' );
+               $page = $dbr->tableName( 'page' );
+
+               $res = $dbr->select( array( 'links', 'page' ),
+                       array( 'page_namespace', 'page_title' ),
+                       array(
+                               'pl_namespace' => $title->getNamespace(),
+                               'pl_title'     => $title->getDbKey(),
+                               'pl_from=page_id' ),
+                       $fname );
                $blurlArr = $title->getSquidURLs();
-               while ( $BL = wfFetchObject ( $res ) )
-               {
-                       $tobj = Title::makeTitle( $BL->cur_namespace, $BL->cur_title ) ; 
-                       $blurlArr[] = $tobj->getInternalURL();
+               if ( $dbr->numRows( $res ) <= $this->mMaxTitles ) {
+                       while ( $BL = $dbr->fetchObject ( $res ) )
+                       {
+                               $tobj = Title::makeTitle( $BL->page_namespace, $BL->page_title ) ; 
+                               $blurlArr[] = $tobj->getInternalURL();
+                       }
                }
-               wfFreeResult ( $res ) ;
+               $dbr->freeResult ( $res ) ;
+
+               wfProfileOut( $fname );
                return new SquidUpdate( $blurlArr );
        }
 
-       /* static */ function newFromBrokenLinksTo( &$title ) {
-               # Get a list of URLs linking to this (currently non-existent) page
-               $encTitle = $title->getPrefixedDBkey();
-               $sql = "SELECT cur_namespace,cur_title FROM brokenlinks,cur WHERE bl_to={$encTitle} AND bl_from=cur_id";
-               $res = wfQuery( $sql, DB_READ );
-               $blurlArr = array();
-               while ( $BL = wfFetchObject( $res ) )
-               {
-                       $tobj = Title::makeTitle( $BL->cur_namespace, $BL->cur_title );
-                       $blurlArr[] = $tobj->getInternalURL();
+       /* static */ function newFromTitles( &$titles, $urlArr = array() ) {
+               foreach ( $titles as $title ) {
+                       $urlArr[] = $title->getInternalURL();
                }
-               wfFreeResult( $res );
-               return new SquidUpdate( $blurlArr );
+               return new SquidUpdate( $urlArr );
        }
 
        /* static */ function newSimplePurge( &$title ) {
@@ -53,13 +78,19 @@ class SquidUpdate {
        XXX report broken Squids per mail or log */
 
        /* static */ function purge( $urlArr ) {
-               global  $wgSquidServers;
+               global $wgSquidServers, $wgHTCPMulticastAddress, $wgHTCPPort;
 
-               if ( $wgSquidServers == "echo" ) {
-                       echo implode("<br>\n", $urlArr);
+               if ( $wgSquidServers == 'echo' ) {
+                       echo implode("<br />\n", $urlArr);
                        return;
                }
 
+               if ( $wgHTCPMulticastAddress && $wgHTCPPort )
+                       SquidUpdate::HTCPPurge( $urlArr );
+
+               $fname = 'SquidUpdate::purge';
+               wfProfileIn( $fname );
+               
                $maxsocketspersquid = 8; //  socket cap per Squid
                $urlspersocket = 400; // 400 seems to be a good tradeoff, opening a socket takes a while
                $firsturl = $urlArr[0];
@@ -85,20 +116,20 @@ class SquidUpdate {
                                        /* first socket for this server, do the tests */
                                        @list($server, $port) = explode(':', $wgSquidServers[$ss]);
                                        if(!isset($port)) $port = 80;
-                                       $this->debug("Opening socket to $server:$port");
+                                       #$this->debug("Opening socket to $server:$port");
                                        $socket = @fsockopen($server, $port, $error, $errstr, 3);
-                                       $this->debug("\n");
+                                       #$this->debug("\n");
                                        if (!$socket) {
                                                $failed = true;
                                                $totalsockets -= $sockspersq;
                                        } else {
-                                               $msg ="PURGE " . $firsturl . " HTTP/1.0\r\n".
+                                               $msg = 'PURGE ' . $firsturl . " HTTP/1.0\r\n".
                                                "Connection: Keep-Alive\r\n\r\n";
-                                               $this->debug($msg);
+                                               #$this->debug($msg);
                                                @fputs($socket,$msg);
-                                               $this->debug("...");
+                                               #$this->debug("...");
                                                $res = @fread($socket,512);
-                                               $this->debug("\n");
+                                               #$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) {
@@ -135,15 +166,15 @@ class SquidUpdate {
                                                }
                                        }
                                        $urindex = $r + $urlspersocket * ($s - $sockspersq * floor($s / $sockspersq));
-                                       $msg = "PURGE " . $urlArr[$urindex] . " HTTP/1.0\r\n".
+                                       $msg = 'PURGE ' . $urlArr[$urindex] . " HTTP/1.0\r\n".
                                        "Connection: Keep-Alive\r\n\r\n";
-                                       $this->debug($msg);
+                                       #$this->debug($msg);
                                        @fputs($sockets[$s],$msg);
-                                       $this->debug("\n");
+                                       #$this->debug("\n");
                                }
                        }
                }
-               $this->debug("Reading response...");
+               #$this->debug("Reading response...");
                foreach ($sockets as $socket) {
                        $res = '';
                        $esc = 0;
@@ -155,7 +186,61 @@ class SquidUpdate {
 
                        @fclose($socket);
                }
-               $this->debug("\n");
+               #$this->debug("\n");
+               wfProfileOut( $fname );
+       }
+
+       /* static */ function HTCPPurge( $urlArr ) {
+               global $wgHTCPMulticastAddress, $wgHTCPMulticastTTL, $wgHTCPPort;
+               $fname = 'SquidUpdate::HTCPPurge';
+               wfProfileIn( $fname );
+
+               $htcpOpCLR = 4;                 // HTCP CLR
+
+               // FIXME PHP doesn't support these socket constants (include/linux/in.h)
+               define( "IPPROTO_IP", 0 );
+               define( "IP_MULTICAST_LOOP", 34 );
+               define( "IP_MULTICAST_TTL", 33 );
+
+               // pfsockopen doesn't work because we need set_sock_opt
+               $conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
+               if ( $conn ) {
+                       // Set socket options
+                       socket_set_option( $conn, IPPROTO_IP, IP_MULTICAST_LOOP, 0 );
+                       if ( $wgHTCPMulticastTTL != 1 )
+                               socket_set_option( $conn, IPPROTO_IP, IP_MULTICAST_TTL,
+                                       $wgHTCPMulticastTTL );
+
+                       foreach ( $urlArr as $url ) {
+                               // Construct a minimal HTCP request diagram
+                               // as per RFC 2756
+                               // Opcode 'CLR', no response desired, no auth
+                               $htcpTransID = rand();
+
+                               $htcpSpecifier = pack( 'na4na*na8n',
+                                       4, 'NONE', strlen( $url ), $url,
+                                       8, 'HTTP/1.0', 0 );
+
+                               $htcpDataLen = 8 + 2 + strlen( $htcpSpecifier );
+                               $htcpLen = 4 + $htcpDataLen + 2;
+
+                               // Note! Squid gets the bit order of the first
+                               // word wrong, wrt the RFC. Apparently no other
+                               // implementation exists, so adapt to Squid
+                               $htcpPacket = pack( 'nxxnCxNxxa*n',
+                                       $htcpLen, $htcpDataLen, $htcpOpCLR,
+                                       $htcpTransID, $htcpSpecifier, 2);
+
+                               // Send out
+                               wfDebug( "Purging URL $url via HTCP\n" );
+                               socket_sendto( $conn, $htcpPacket, $htcpLen, 0,
+                                       $wgHTCPMulticastAddress, $wgHTCPPort );
+                       }
+               } else {
+                       $errstr = socket_strerror( socket_last_error() );
+                       wfDebug( "SquidUpdate::HTCPPurge(): Error opening UDP socket: $errstr\n" );
+               }
+               wfProfileOut( $fname );
        }
 
        function debug( $text ) {