Issues in SquidPurgeClient.php - All Issues - Inspection of "Daily Inspection: Merge "Add GENDER support to pro..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (939199)

unknown

created 2016-11-04 17:19 UTC

includes/clientpool/SquidPurgeClient.php (1 issue)

Labels

Severity

Major 1

Daniel Friesen 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Squid and Varnish cache purging.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * An HTTP 1.0 client built for the purposes of purging Squid and Varnish.
 * Uses asynchronous I/O, allowing purges to be done in a highly parallel
 * manner.
 *
 * Could be replaced by curl_multi_exec() or some such.
 */
class SquidPurgeClient {
	/** @var string */
	protected $host;

	/** @var int */
	protected $port;

	/** @var string|bool */
	protected $ip;

	/** @var string */
	protected $readState = 'idle';

	/** @var string */
	protected $writeBuffer = '';

	/** @var array */
	protected $requests = [];

	/** @var mixed */
	protected $currentRequestIndex;

	const EINTR = 4;
	const EAGAIN = 11;
	const EINPROGRESS = 115;
	const BUFFER_SIZE = 8192;

	/**
	 * @var resource|null The socket resource, or null for unconnected, or false
	 *   for disabled due to error.
	 */
	protected $socket;

	/** @var string */
	protected $readBuffer;

	/** @var int */
	protected $bodyRemaining;

	/**
	 * @param string $server
	 * @param array $options
	 */
	public function __construct( $server, $options = [] ) {
		$parts = explode( ':', $server, 2 );
		$this->host = $parts[0];
		$this->port = isset( $parts[1] ) ? $parts[1] : 80;
	}

	/**
	 * Open a socket if there isn't one open already, return it.
	 * Returns false on error.
	 *
	 * @return bool|resource
	 */
	protected function getSocket() {
		if ( $this->socket !== null ) {
			return $this->socket;
		}

		$ip = $this->getIP();
		if ( !$ip ) {
			$this->log( "DNS error" );
			$this->markDown();
			return false;
		}
		$this->socket = socket_create( AF_INET, SOCK_STREAM, SOL_TCP );
		socket_set_nonblock( $this->socket );
		MediaWiki\suppressWarnings();
		$ok = socket_connect( $this->socket, $ip, $this->port );
		MediaWiki\restoreWarnings();
		if ( !$ok ) {
			$error = socket_last_error( $this->socket );
			if ( $error !== self::EINPROGRESS ) {
				$this->log( "connection error: " . socket_strerror( $error ) );
				$this->markDown();
				return false;
			}
		}

		return $this->socket;
	}

	/**
	 * Get read socket array for select()
	 * @return array
	 */
	public function getReadSocketsForSelect() {
		if ( $this->readState == 'idle' ) {
			return [];
		}
		$socket = $this->getSocket();
		if ( $socket === false ) {
			return [];
		}
		return [ $socket ];
	}

	/**
	 * Get write socket array for select()
	 * @return array
	 */
	public function getWriteSocketsForSelect() {
		if ( !strlen( $this->writeBuffer ) ) {
			return [];
		}
		$socket = $this->getSocket();
		if ( $socket === false ) {
			return [];
		}
		return [ $socket ];
	}

	/**
	 * Get the host's IP address.
	 * Does not support IPv6 at present due to the lack of a convenient interface in PHP.
	 * @throws MWException
	 * @return string
	 */
	protected function getIP() {
		if ( $this->ip === null ) {
			if ( IP::isIPv4( $this->host ) ) {
				$this->ip = $this->host;
			} elseif ( IP::isIPv6( $this->host ) ) {
				throw new MWException( '$wgSquidServers does not support IPv6' );
			} else {
				MediaWiki\suppressWarnings();
				$this->ip = gethostbyname( $this->host );
				if ( $this->ip === $this->host ) {
					$this->ip = false;
				}
				MediaWiki\restoreWarnings();
			}
		}
		return $this->ip;
	}

	/**
	 * Close the socket and ignore any future purge requests.
	 * This is called if there is a protocol error.
	 */
	protected function markDown() {
		$this->close();
		$this->socket = false;
	}

	/**
	 * Close the socket but allow it to be reopened for future purge requests
	 */
	public function close() {
		if ( $this->socket ) {
			MediaWiki\suppressWarnings();
			socket_set_block( $this->socket );
			socket_shutdown( $this->socket );
			socket_close( $this->socket );
			MediaWiki\restoreWarnings();
		}
		$this->socket = null;
		$this->readBuffer = '';
		// Write buffer is kept since it may contain a request for the next socket
	}

	/**
	 * Queue a purge operation
	 *
	 * @param string $url
	 */
	public function queuePurge( $url ) {
		global $wgSquidPurgeUseHostHeader;
		$url = CdnCacheUpdate::expand( str_replace( "\n", '', $url ) );
		$request = [];
		if ( $wgSquidPurgeUseHostHeader ) {
			$url = wfParseUrl( $url );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
			$host = $url['host'];
			if ( isset( $url['port'] ) && strlen( $url['port'] ) > 0 ) {
				$host .= ":" . $url['port'];
			}
			$path = $url['path'];
			if ( isset( $url['query'] ) && is_string( $url['query'] ) ) {
				$path = wfAppendQuery( $path, $url['query'] );
			}
			$request[] = "PURGE $path HTTP/1.1";
			$request[] = "Host: $host";
		} else {
			$request[] = "PURGE $url HTTP/1.0";
		}
		$request[] = "Connection: Keep-Alive";
		$request[] = "Proxy-Connection: Keep-Alive";
		$request[] = "User-Agent: " . Http::userAgent() . ' ' . __CLASS__;
		// Two ''s to create \r\n\r\n
		$request[] = '';
		$request[] = '';

		$this->requests[] = implode( "\r\n", $request );
		if ( $this->currentRequestIndex === null ) {
			$this->nextRequest();
		}
	}

	/**
	 * @return bool
	 */
	public function isIdle() {
		return strlen( $this->writeBuffer ) == 0 && $this->readState == 'idle';
	}

	/**
	 * Perform pending writes. Call this when socket_select() indicates that writing will not block.
	 */
	public function doWrites() {
		if ( !strlen( $this->writeBuffer ) ) {
			return;
		}
		$socket = $this->getSocket();
		if ( !$socket ) {
			return;
		}

		if ( strlen( $this->writeBuffer ) <= self::BUFFER_SIZE ) {
			$buf = $this->writeBuffer;
			$flags = MSG_EOR;
		} else {
			$buf = substr( $this->writeBuffer, 0, self::BUFFER_SIZE );
			$flags = 0;
		}
		MediaWiki\suppressWarnings();
		$bytesSent = socket_send( $socket, $buf, strlen( $buf ), $flags );
		MediaWiki\restoreWarnings();

		if ( $bytesSent === false ) {
			$error = socket_last_error( $socket );
			if ( $error != self::EAGAIN && $error != self::EINTR ) {
				$this->log( 'write error: ' . socket_strerror( $error ) );
				$this->markDown();
			}
			return;
		}

		$this->writeBuffer = substr( $this->writeBuffer, $bytesSent );
	}

	/**
	 * Read some data. Call this when socket_select() indicates that the read buffer is non-empty.
	 */
	public function doReads() {
		$socket = $this->getSocket();
		if ( !$socket ) {
			return;
		}

		$buf = '';
		MediaWiki\suppressWarnings();
		$bytesRead = socket_recv( $socket, $buf, self::BUFFER_SIZE, 0 );
		MediaWiki\restoreWarnings();
		if ( $bytesRead === false ) {
			$error = socket_last_error( $socket );
			if ( $error != self::EAGAIN && $error != self::EINTR ) {
				$this->log( 'read error: ' . socket_strerror( $error ) );
				$this->markDown();
				return;
			}
		} elseif ( $bytesRead === 0 ) {
			// Assume EOF
			$this->close();
			return;
		}

		$this->readBuffer .= $buf;
		while ( $this->socket && $this->processReadBuffer() === 'continue' );
	}

	/**
	 * @throws MWException
	 * @return string
	 */
	protected function processReadBuffer() {
		switch ( $this->readState ) {
		case 'idle':
			return 'done';
		case 'status':
		case 'header':
			$lines = explode( "\r\n", $this->readBuffer, 2 );
			if ( count( $lines ) < 2 ) {
				return 'done';
			}
			if ( $this->readState == 'status' ) {
				$this->processStatusLine( $lines[0] );
			} else { // header
				$this->processHeaderLine( $lines[0] );
			}
			$this->readBuffer = $lines[1];
			return 'continue';
		case 'body':
			if ( $this->bodyRemaining !== null ) {
				if ( $this->bodyRemaining > strlen( $this->readBuffer ) ) {
					$this->bodyRemaining -= strlen( $this->readBuffer );
					$this->readBuffer = '';
					return 'done';
				} else {
					$this->readBuffer = substr( $this->readBuffer, $this->bodyRemaining );
					$this->bodyRemaining = 0;
					$this->nextRequest();
					return 'continue';
				}
			} else {
				// No content length, read all data to EOF
				$this->readBuffer = '';
				return 'done';
			}
		default:
			throw new MWException( __METHOD__ . ': unexpected state' );
		}
	}

	/**
	 * @param string $line
	 */
	protected function processStatusLine( $line ) {
		if ( !preg_match( '!^HTTP/(\d+)\.(\d+) (\d{3}) (.*)$!', $line, $m ) ) {
			$this->log( 'invalid status line' );
			$this->markDown();
			return;
		}
		list( , , , $status, $reason ) = $m;
		$status = intval( $status );
		if ( $status !== 200 && $status !== 404 ) {
			$this->log( "unexpected status code: $status $reason" );
			$this->markDown();
			return;
		}
		$this->readState = 'header';
	}

	/**
	 * @param string $line
	 */
	protected function processHeaderLine( $line ) {
		if ( preg_match( '/^Content-Length: (\d+)$/i', $line, $m ) ) {
			$this->bodyRemaining = intval( $m[1] );
		} elseif ( $line === '' ) {
			$this->readState = 'body';
		}
	}

	protected function nextRequest() {
		if ( $this->currentRequestIndex !== null ) {
			unset( $this->requests[$this->currentRequestIndex] );
		}
		if ( count( $this->requests ) ) {
			$this->readState = 'status';
			$this->currentRequestIndex = key( $this->requests );
			$this->writeBuffer = $this->requests[$this->currentRequestIndex];
		} else {
			$this->readState = 'idle';
			$this->currentRequestIndex = null;
			$this->writeBuffer = '';
		}
		$this->bodyRemaining = null;
	}

	/**
	 * @param string $msg
	 */
	protected function log( $msg ) {
		wfDebugLog( 'squid', __CLASS__ . " ($this->host): $msg" );
	}
}


1		<?php
2		/**
3		* Squid and Varnish cache purging.
4		*
5		* This program is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU General Public License as published by
7		* the Free Software Foundation; either version 2 of the License, or
8		* (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License along
16		* with this program; if not, write to the Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		* http://www.gnu.org/copyleft/gpl.html
19		*
20		* @file
21		*/
22
23		/**
24		* An HTTP 1.0 client built for the purposes of purging Squid and Varnish.
25		* Uses asynchronous I/O, allowing purges to be done in a highly parallel
26		* manner.
27		*
28		* Could be replaced by curl_multi_exec() or some such.
29		*/
30		class SquidPurgeClient {
31		/** @var string */
32		protected $host;
33
34		/** @var int */
35		protected $port;
36
37		/** @var string\|bool */
38		protected $ip;
39
40		/** @var string */
41		protected $readState = 'idle';
42
43		/** @var string */
44		protected $writeBuffer = '';
45
46		/** @var array */
47		protected $requests = [];
48
49		/** @var mixed */
50		protected $currentRequestIndex;
51
52		const EINTR = 4;
53		const EAGAIN = 11;
54		const EINPROGRESS = 115;
55		const BUFFER_SIZE = 8192;
56
57		/**
58		* @var resource\|null The socket resource, or null for unconnected, or false
59		* for disabled due to error.
60		*/
61		protected $socket;
62
63		/** @var string */
64		protected $readBuffer;
65
66		/** @var int */
67		protected $bodyRemaining;
68
69		/**
70		* @param string $server
71		* @param array $options
72		*/
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
79		/**
80		* Open a socket if there isn't one open already, return it.
81		* Returns false on error.
82		*
83		* @return bool\|resource
84		*/
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
113		/**
114		* Get read socket array for select()
115		* @return array
116		*/
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
128		/**
129		* Get write socket array for select()
130		* @return array
131		*/
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
143		/**
144		* Get the host's IP address.
145		* Does not support IPv6 at present due to the lack of a convenient interface in PHP.
146		* @throws MWException
147		* @return string
148		*/
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
167		/**
168		* Close the socket and ignore any future purge requests.
169		* This is called if there is a protocol error.
170		*/
171		protected function markDown() {
172		$this->close();
173		$this->socket = false;
174		}
175
176		/**
177		* Close the socket but allow it to be reopened for future purge requests
178		*/
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
192		/**
193		* Queue a purge operation
194		*
195		* @param string $url
196		*/
197		public function queuePurge( $url ) {
198		global $wgSquidPurgeUseHostHeader;
199		$url = CdnCacheUpdate::expand( str_replace( "\n", '', $url ) );
200		$request = [];
201		if ( $wgSquidPurgeUseHostHeader ) {
202		$url = wfParseUrl( $url );
		0 ignored issues – show Security Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$url` defined by `wfParseUrl($url)` on line `202` can also be of type `false`; however, `wfParseUrl()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
203		$host = $url['host'];
204	View Code Duplication	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
229		/**
230		* @return bool
231		*/
232		public function isIdle() {
233		return strlen( $this->writeBuffer ) == 0 && $this->readState == 'idle';
234		}
235
236		/**
237		* Perform pending writes. Call this when socket_select() indicates that writing will not block.
238		*/
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	View Code Duplication	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
271		/**
272		* Read some data. Call this when socket_select() indicates that the read buffer is non-empty.
273		*/
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	View Code Duplication	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
301		/**
302		* @throws MWException
303		* @return string
304		*/
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
344		/**
345		* @param string $line
346		*/
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
363		/**
364		* @param string $line
365		*/
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
390		/**
391		* @param string $msg
392		*/
393		protected function log( $msg ) {
394		wfDebugLog( 'squid', __CLASS__ . " ($this->host): $msg" );
395		}
396		}
397

wikimedia / mediawiki

Branch — master (939199)

includes/clientpool/SquidPurgeClient.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like