MediaWiki  1.29.1
SquidPurgeClient.php
Go to the documentation of this file.
1 <?php
32  protected $host;
33 
35  protected $port;
36 
38  protected $ip;
39 
41  protected $readState = 'idle';
42 
44  protected $writeBuffer = '';
45 
47  protected $requests = [];
48 
51 
52  const EINTR = 4;
53  const EAGAIN = 11;
54  const EINPROGRESS = 115;
55  const BUFFER_SIZE = 8192;
56 
61  protected $socket;
62 
64  protected $readBuffer;
65 
67  protected $bodyRemaining;
68 
73  public function __construct( $server, $options = [] ) {
74  $parts = explode( ':', $server, 2 );
75  $this->host = $parts[0];
76  $this->port = isset( $parts[1] ) ? $parts[1] : 80;
77  }
78 
85  protected function getSocket() {
86  if ( $this->socket !== null ) {
87  return $this->socket;
88  }
89 
90  $ip = $this->getIP();
91  if ( !$ip ) {
92  $this->log( "DNS error" );
93  $this->markDown();
94  return false;
95  }
96  $this->socket = socket_create( AF_INET, SOCK_STREAM, SOL_TCP );
97  socket_set_nonblock( $this->socket );
98  MediaWiki\suppressWarnings();
99  $ok = socket_connect( $this->socket, $ip, $this->port );
100  MediaWiki\restoreWarnings();
101  if ( !$ok ) {
102  $error = socket_last_error( $this->socket );
103  if ( $error !== self::EINPROGRESS ) {
104  $this->log( "connection error: " . socket_strerror( $error ) );
105  $this->markDown();
106  return false;
107  }
108  }
109 
110  return $this->socket;
111  }
112 
117  public function getReadSocketsForSelect() {
118  if ( $this->readState == 'idle' ) {
119  return [];
120  }
121  $socket = $this->getSocket();
122  if ( $socket === false ) {
123  return [];
124  }
125  return [ $socket ];
126  }
127 
132  public function getWriteSocketsForSelect() {
133  if ( !strlen( $this->writeBuffer ) ) {
134  return [];
135  }
136  $socket = $this->getSocket();
137  if ( $socket === false ) {
138  return [];
139  }
140  return [ $socket ];
141  }
142 
149  protected function getIP() {
150  if ( $this->ip === null ) {
151  if ( IP::isIPv4( $this->host ) ) {
152  $this->ip = $this->host;
153  } elseif ( IP::isIPv6( $this->host ) ) {
154  throw new MWException( '$wgSquidServers does not support IPv6' );
155  } else {
156  MediaWiki\suppressWarnings();
157  $this->ip = gethostbyname( $this->host );
158  if ( $this->ip === $this->host ) {
159  $this->ip = false;
160  }
161  MediaWiki\restoreWarnings();
162  }
163  }
164  return $this->ip;
165  }
166 
171  protected function markDown() {
172  $this->close();
173  $this->socket = false;
174  }
175 
179  public function close() {
180  if ( $this->socket ) {
181  MediaWiki\suppressWarnings();
182  socket_set_block( $this->socket );
183  socket_shutdown( $this->socket );
184  socket_close( $this->socket );
185  MediaWiki\restoreWarnings();
186  }
187  $this->socket = null;
188  $this->readBuffer = '';
189  // Write buffer is kept since it may contain a request for the next socket
190  }
191 
197  public function queuePurge( $url ) {
199  $url = CdnCacheUpdate::expand( str_replace( "\n", '', $url ) );
200  $request = [];
202  $url = wfParseUrl( $url );
203  $host = $url['host'];
204  if ( isset( $url['port'] ) && strlen( $url['port'] ) > 0 ) {
205  $host .= ":" . $url['port'];
206  }
207  $path = $url['path'];
208  if ( isset( $url['query'] ) && is_string( $url['query'] ) ) {
209  $path = wfAppendQuery( $path, $url['query'] );
210  }
211  $request[] = "PURGE $path HTTP/1.1";
212  $request[] = "Host: $host";
213  } else {
214  $request[] = "PURGE $url HTTP/1.0";
215  }
216  $request[] = "Connection: Keep-Alive";
217  $request[] = "Proxy-Connection: Keep-Alive";
218  $request[] = "User-Agent: " . Http::userAgent() . ' ' . __CLASS__;
219  // Two ''s to create \r\n\r\n
220  $request[] = '';
221  $request[] = '';
222 
223  $this->requests[] = implode( "\r\n", $request );
224  if ( $this->currentRequestIndex === null ) {
225  $this->nextRequest();
226  }
227  }
228 
232  public function isIdle() {
233  return strlen( $this->writeBuffer ) == 0 && $this->readState == 'idle';
234  }
235 
239  public function doWrites() {
240  if ( !strlen( $this->writeBuffer ) ) {
241  return;
242  }
243  $socket = $this->getSocket();
244  if ( !$socket ) {
245  return;
246  }
247 
248  if ( strlen( $this->writeBuffer ) <= self::BUFFER_SIZE ) {
249  $buf = $this->writeBuffer;
250  $flags = MSG_EOR;
251  } else {
252  $buf = substr( $this->writeBuffer, 0, self::BUFFER_SIZE );
253  $flags = 0;
254  }
255  MediaWiki\suppressWarnings();
256  $bytesSent = socket_send( $socket, $buf, strlen( $buf ), $flags );
257  MediaWiki\restoreWarnings();
258 
259  if ( $bytesSent === false ) {
260  $error = socket_last_error( $socket );
261  if ( $error != self::EAGAIN && $error != self::EINTR ) {
262  $this->log( 'write error: ' . socket_strerror( $error ) );
263  $this->markDown();
264  }
265  return;
266  }
267 
268  $this->writeBuffer = substr( $this->writeBuffer, $bytesSent );
269  }
270 
274  public function doReads() {
275  $socket = $this->getSocket();
276  if ( !$socket ) {
277  return;
278  }
279 
280  $buf = '';
281  MediaWiki\suppressWarnings();
282  $bytesRead = socket_recv( $socket, $buf, self::BUFFER_SIZE, 0 );
283  MediaWiki\restoreWarnings();
284  if ( $bytesRead === false ) {
285  $error = socket_last_error( $socket );
286  if ( $error != self::EAGAIN && $error != self::EINTR ) {
287  $this->log( 'read error: ' . socket_strerror( $error ) );
288  $this->markDown();
289  return;
290  }
291  } elseif ( $bytesRead === 0 ) {
292  // Assume EOF
293  $this->close();
294  return;
295  }
296 
297  $this->readBuffer .= $buf;
298  while ( $this->socket && $this->processReadBuffer() === 'continue' );
299  }
300 
305  protected function processReadBuffer() {
306  switch ( $this->readState ) {
307  case 'idle':
308  return 'done';
309  case 'status':
310  case 'header':
311  $lines = explode( "\r\n", $this->readBuffer, 2 );
312  if ( count( $lines ) < 2 ) {
313  return 'done';
314  }
315  if ( $this->readState == 'status' ) {
316  $this->processStatusLine( $lines[0] );
317  } else { // header
318  $this->processHeaderLine( $lines[0] );
319  }
320  $this->readBuffer = $lines[1];
321  return 'continue';
322  case 'body':
323  if ( $this->bodyRemaining !== null ) {
324  if ( $this->bodyRemaining > strlen( $this->readBuffer ) ) {
325  $this->bodyRemaining -= strlen( $this->readBuffer );
326  $this->readBuffer = '';
327  return 'done';
328  } else {
329  $this->readBuffer = substr( $this->readBuffer, $this->bodyRemaining );
330  $this->bodyRemaining = 0;
331  $this->nextRequest();
332  return 'continue';
333  }
334  } else {
335  // No content length, read all data to EOF
336  $this->readBuffer = '';
337  return 'done';
338  }
339  default:
340  throw new MWException( __METHOD__ . ': unexpected state' );
341  }
342  }
343 
347  protected function processStatusLine( $line ) {
348  if ( !preg_match( '!^HTTP/(\d+)\.(\d+) (\d{3}) (.*)$!', $line, $m ) ) {
349  $this->log( 'invalid status line' );
350  $this->markDown();
351  return;
352  }
353  list( , , , $status, $reason ) = $m;
354  $status = intval( $status );
355  if ( $status !== 200 && $status !== 404 ) {
356  $this->log( "unexpected status code: $status $reason" );
357  $this->markDown();
358  return;
359  }
360  $this->readState = 'header';
361  }
362 
366  protected function processHeaderLine( $line ) {
367  if ( preg_match( '/^Content-Length: (\d+)$/i', $line, $m ) ) {
368  $this->bodyRemaining = intval( $m[1] );
369  } elseif ( $line === '' ) {
370  $this->readState = 'body';
371  }
372  }
373 
374  protected function nextRequest() {
375  if ( $this->currentRequestIndex !== null ) {
376  unset( $this->requests[$this->currentRequestIndex] );
377  }
378  if ( count( $this->requests ) ) {
379  $this->readState = 'status';
380  $this->currentRequestIndex = key( $this->requests );
381  $this->writeBuffer = $this->requests[$this->currentRequestIndex];
382  } else {
383  $this->readState = 'idle';
384  $this->currentRequestIndex = null;
385  $this->writeBuffer = '';
386  }
387  $this->bodyRemaining = null;
388  }
389 
393  protected function log( $msg ) {
394  wfDebugLog( 'squid', __CLASS__ . " ($this->host): $msg" );
395  }
396 }
SquidPurgeClient\EINTR
const EINTR
Definition: SquidPurgeClient.php:52
SquidPurgeClient\$writeBuffer
string $writeBuffer
Definition: SquidPurgeClient.php:44
SquidPurgeClient\markDown
markDown()
Close the socket and ignore any future purge requests.
Definition: SquidPurgeClient.php:171
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
captcha-old.count
count
Definition: captcha-old.py:225
SquidPurgeClient\EAGAIN
const EAGAIN
Definition: SquidPurgeClient.php:53
SquidPurgeClient\close
close()
Close the socket but allow it to be reopened for future purge requests.
Definition: SquidPurgeClient.php:179
Http\userAgent
static userAgent()
A standard user-agent we can use for external requests.
Definition: Http.php:129
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
SquidPurgeClient\$port
int $port
Definition: SquidPurgeClient.php:35
SquidPurgeClient\$host
string $host
Definition: SquidPurgeClient.php:32
SquidPurgeClient\$ip
string bool $ip
Definition: SquidPurgeClient.php:38
IP\isIPv6
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
Definition: IP.php:90
SquidPurgeClient
An HTTP 1.0 client built for the purposes of purging Squid and Varnish.
Definition: SquidPurgeClient.php:30
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1092
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
SquidPurgeClient\$readState
string $readState
Definition: SquidPurgeClient.php:41
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:500
key
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition: design.txt:25
SquidPurgeClient\processHeaderLine
processHeaderLine( $line)
Definition: SquidPurgeClient.php:366
SquidPurgeClient\getIP
getIP()
Get the host's IP address.
Definition: SquidPurgeClient.php:149
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:818
MWException
MediaWiki exception.
Definition: MWException.php:26
SquidPurgeClient\BUFFER_SIZE
const BUFFER_SIZE
Definition: SquidPurgeClient.php:55
SquidPurgeClient\$socket
resource null $socket
The socket resource, or null for unconnected, or false for disabled due to error.
Definition: SquidPurgeClient.php:61
SquidPurgeClient\$currentRequestIndex
mixed $currentRequestIndex
Definition: SquidPurgeClient.php:50
CdnCacheUpdate\expand
static expand( $url)
Expand local URLs to fully-qualified URLs using the internal protocol and host defined in $wgInternal...
Definition: CdnCacheUpdate.php:269
SquidPurgeClient\getSocket
getSocket()
Open a socket if there isn't one open already, return it.
Definition: SquidPurgeClient.php:85
SquidPurgeClient\isIdle
isIdle()
Definition: SquidPurgeClient.php:232
$lines
$lines
Definition: router.php:67
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SquidPurgeClient\nextRequest
nextRequest()
Definition: SquidPurgeClient.php:374
port
storage can be distributed across multiple and multiple web servers can use the same cache cluster *********************W A R N I N G ***********************Memcached has no security or authentication Please ensure that your server is appropriately and that the port(s) used for memcached servers are not publicly accessible. Otherwise
SquidPurgeClient\$requests
array $requests
Definition: SquidPurgeClient.php:47
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$line
$line
Definition: cdb.php:58
SquidPurgeClient\doReads
doReads()
Read some data.
Definition: SquidPurgeClient.php:274
SquidPurgeClient\$readBuffer
string $readBuffer
Definition: SquidPurgeClient.php:64
IP\isIPv4
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:101
SquidPurgeClient\EINPROGRESS
const EINPROGRESS
Definition: SquidPurgeClient.php:54
SquidPurgeClient\doWrites
doWrites()
Perform pending writes.
Definition: SquidPurgeClient.php:239
$wgSquidPurgeUseHostHeader
$wgSquidPurgeUseHostHeader
Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServer...
Definition: DefaultSettings.php:2750
SquidPurgeClient\getWriteSocketsForSelect
getWriteSocketsForSelect()
Get write socket array for select()
Definition: SquidPurgeClient.php:132
SquidPurgeClient\processStatusLine
processStatusLine( $line)
Definition: SquidPurgeClient.php:347
SquidPurgeClient\queuePurge
queuePurge( $url)
Queue a purge operation.
Definition: SquidPurgeClient.php:197
SquidPurgeClient\getReadSocketsForSelect
getReadSocketsForSelect()
Get read socket array for select()
Definition: SquidPurgeClient.php:117
$path
$path
Definition: NoLocalSettings.php:26
SquidPurgeClient\processReadBuffer
processReadBuffer()
Definition: SquidPurgeClient.php:305
SquidPurgeClient\log
log( $msg)
Definition: SquidPurgeClient.php:393
SquidPurgeClient\__construct
__construct( $server, $options=[])
Definition: SquidPurgeClient.php:73
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2749
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SquidPurgeClient\$bodyRemaining
int $bodyRemaining
Definition: SquidPurgeClient.php:67