includes/SquidUpdate.php

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