includes/SquidUpdate.php

   1 <?php
   2 /**
   3  * See deferred.doc
   4  * @package MediaWiki
   5  */
   6
   7 /**
   8  *
   9  * @package MediaWiki
  10  */
  11 class SquidUpdate {
  12         var $urlArr, $mMaxTitles;
  13
  14         function SquidUpdate( $urlArr = Array(), $maxTitles = false ) {
  15                 global $wgMaxSquidPurgeTitles;
  16                 if ( $maxTitles === false ) {
  17                         $this->mMaxTitles = $wgMaxSquidPurgeTitles;
  18                 } else {
  19                         $this->mMaxTitles = $maxTitles;
  20                 }
  21                 if ( count( $urlArr ) > $this->mMaxTitles ) {
  22                         $urlArr = array_slice( $urlArr, 0, $this->mMaxTitles );
  23                 }
  24                 $this->urlArr = $urlArr;
  25         }
  26
  27         /* static */ function newFromLinksTo( &$title ) {
  28                 $fname = 'SquidUpdate::newFromLinksTo';
  29                 wfProfileIn( $fname );
  30
  31                 # Get a list of URLs linking to this page
  32                 $id = $title->getArticleID();
  33
  34                 $dbr =& wfGetDB( DB_SLAVE );
  35                 $links = $dbr->tableName( 'links' );
  36                 $page = $dbr->tableName( 'page' );
  37
  38                 $sql = "SELECT page_namespace,page_title FROM $links,$page WHERE l_to={$id} and l_from=page_id" ;
  39                 $res = $dbr->query( $sql, $fname ) ;
  40                 $blurlArr = $title->getSquidURLs();
  41                 if ( $dbr->numRows( $res ) <= $this->mMaxTitles ) {
  42                         while ( $BL = $dbr->fetchObject ( $res ) )
  43                         {
  44                                 $tobj = Title::makeTitle( $BL->page_namespace, $BL->page_title ) ;
  45                                 $blurlArr[] = $tobj->getInternalURL();
  46                         }
  47                 }
  48                 $dbr->freeResult ( $res ) ;
  49
  50                 wfProfileOut( $fname );
  51                 return new SquidUpdate( $blurlArr );
  52         }
  53
  54         /* static */ function newFromBrokenLinksTo( &$title ) {
  55                 $fname = 'SquidUpdate::newFromBrokenLinksTo';
  56                 wfProfileIn( $fname );
  57
  58                 # Get a list of URLs linking to this (currently non-existent) page
  59                 $dbr =& wfGetDB( DB_SLAVE );
  60                 $brokenlinks = $dbr->tableName( 'brokenlinks' );
  61                 $page = $dbr->tableName( 'page' );
  62                 $encTitle = $dbr->addQuotes( $title->getPrefixedDBkey() );
  63
  64                 $sql = "SELECT page_namespace,page_title FROM $brokenlinks,$cur WHERE bl_to={$encTitle} AND bl_from=page_id";
  65                 $res = $dbr->query( $sql, $fname );
  66                 $blurlArr = array();
  67                 if ( $dbr->numRows( $res ) <= $this->mMaxTitles ) {
  68                         while ( $BL = $dbr->fetchObject( $res ) )
  69                         {
  70                                 $tobj = Title::makeTitle( $BL->page_namespace, $BL->page_title );
  71                                 $blurlArr[] = $tobj->getInternalURL();
  72                         }
  73                 }
  74                 $dbr->freeResult( $res );
  75                 wfProfileOut( $fname );
  76                 return new SquidUpdate( $blurlArr );
  77         }
  78
  79         /* static */ function newSimplePurge( &$title ) {
  80                 $urlArr = $title->getSquidURLs();
  81                 return new SquidUpdate( $blurlArr );
  82         }
  83
  84         function doUpdate() {
  85                 SquidUpdate::purge( $this->urlArr );
  86         }
  87
  88         /* Purges a list of Squids defined in $wgSquidServers.
  89         $urlArr should contain the full URLs to purge as values
  90         (example: $urlArr[] = 'http://my.host/something')
  91         XXX report broken Squids per mail or log */
  92
  93         /* static */ function purge( $urlArr ) {
  94                 global  $wgSquidServers;
  95
  96                 if ( $wgSquidServers == 'echo' ) {
  97                         echo implode("<br />\n", $urlArr);
  98                         return;
  99                 }
 100
 101                 $fname = 'SquidUpdate::purge';
 102                 wfProfileIn( $fname );
 103
 104                 $maxsocketspersquid = 8; //  socket cap per Squid
 105                 $urlspersocket = 400; // 400 seems to be a good tradeoff, opening a socket takes a while
 106                 $firsturl = $urlArr[0];
 107                 unset($urlArr[0]);
 108                 $urlArr = array_values($urlArr);
 109                 $sockspersq =  max(ceil(count($urlArr) / $urlspersocket ),1);
 110                 if ($sockspersq == 1) {
 111                         /* the most common case */
 112                         $urlspersocket = count($urlArr);
 113                 } else if ($sockspersq > $maxsocketspersquid ) {
 114                         $urlspersocket = ceil(count($urlArr) / $maxsocketspersquid);
 115                         $sockspersq = $maxsocketspersquid;
 116                 }
 117                 $totalsockets = count($wgSquidServers) * $sockspersq;
 118                 $sockets = Array();
 119
 120                 /* this sets up the sockets and tests the first socket for each server. */
 121                 for ($ss=0;$ss < count($wgSquidServers);$ss++) {
 122                         $failed = false;
 123                         $so = 0;
 124                         while ($so < $sockspersq && !$failed) {
 125                                 if ($so == 0) {
 126                                         /* first socket for this server, do the tests */
 127                                         @list($server, $port) = explode(':', $wgSquidServers[$ss]);
 128                                         if(!isset($port)) $port = 80;
 129                                         #$this->debug("Opening socket to $server:$port");
 130                                         $socket = @fsockopen($server, $port, $error, $errstr, 3);
 131                                         #$this->debug("\n");
 132                                         if (!$socket) {
 133                                                 $failed = true;
 134                                                 $totalsockets -= $sockspersq;
 135                                         } else {
 136                                                 $msg = 'PURGE ' . $firsturl . " HTTP/1.0\r\n".
 137                                                 "Connection: Keep-Alive\r\n\r\n";
 138                                                 #$this->debug($msg);
 139                                                 @fputs($socket,$msg);
 140                                                 #$this->debug("...");
 141                                                 $res = @fread($socket,512);
 142                                                 #$this->debug("\n");
 143                                                 /* Squid only returns http headers with 200 or 404 status,
 144                                                 if there's more returned something's wrong */
 145                                                 if (strlen($res) > 250) {
 146                                                         fclose($socket);
 147                                                         $failed = true;
 148                                                         $totalsockets -= $sockspersq;
 149                                                 } else {
 150                                                         @stream_set_blocking($socket,false);
 151                                                         $sockets[] = $socket;
 152                                                 }
 153                                         }
 154                                 } else {
 155                                         /* open the remaining sockets for this server */
 156                                         list($server, $port) = explode(':', $wgSquidServers[$ss]);
 157                                         if(!isset($port)) $port = 80;
 158                                         $sockets[] = @fsockopen($server, $port, $error, $errstr, 2);
 159                                         @stream_set_blocking($sockets[$s],false);
 160                                 }
 161                                 $so++;
 162                         }
 163                 }
 164
 165                 if ($urlspersocket > 0) {
 166                         /* now do the heavy lifting. The fread() relies on Squid returning only the headers */
 167                         for ($r=0;$r < $urlspersocket;$r++) {
 168                                 for ($s=0;$s < $totalsockets;$s++) {
 169                                         if($r != 0) {
 170                                                 $res = '';
 171                                                 $esc = 0;
 172                                                 while (strlen($res) < 100 && $esc < 200  ) {
 173                                                         $res .= @fread($sockets[$s],512);
 174                                                         $esc++;
 175                                                         usleep(20);
 176                                                 }
 177                                         }
 178                                         $urindex = $r + $urlspersocket * ($s - $sockspersq * floor($s / $sockspersq));
 179                                         $msg = 'PURGE ' . $urlArr[$urindex] . " HTTP/1.0\r\n".
 180                                         "Connection: Keep-Alive\r\n\r\n";
 181                                         #$this->debug($msg);
 182                                         @fputs($sockets[$s],$msg);
 183                                         #$this->debug("\n");
 184                                 }
 185                         }
 186                 }
 187                 #$this->debug("Reading response...");
 188                 foreach ($sockets as $socket) {
 189                         $res = '';
 190                         $esc = 0;
 191                         while (strlen($res) < 100 && $esc < 200  ) {
 192                                 $res .= @fread($socket,1024);
 193                                 $esc++;
 194                                 usleep(20);
 195                         }
 196
 197                         @fclose($socket);
 198                 }
 199                 #$this->debug("\n");
 200                 wfProfileOut( $fname );
 201         }
 202
 203         function debug( $text ) {
 204                 global $wgDebugSquid;
 205                 if ( $wgDebugSquid ) {
 206                         wfDebug( $text );
 207                 }
 208         }
 209 }
 210 ?>