includes/SquidUpdate.php

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