| Server IP : 167.235.224.122 / Your IP : 216.73.216.110 Web Server : Apache/2.4.58 (Ubuntu) System : Linux newplayground 6.8.0-136-generic #136-Ubuntu SMP PREEMPT_DYNAMIC Wed Jul 1 21:33:11 UTC 2026 aarch64 User : deploy ( 1000) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/html/openusability/wiki/includes/deferred/ |
Upload File : |
<?php
/**
* CDN 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
* @ingroup Cache
*/
use Wikimedia\Assert\Assert;
use MediaWiki\MediaWikiServices;
/**
* Handles purging appropriate CDN URLs given a title (or titles)
* @ingroup Cache
*/
class CdnCacheUpdate implements DeferrableUpdate, MergeableUpdate {
/** @var string[] Collection of URLs to purge */
protected $urls = [];
/**
* @param string[] $urlArr Collection of URLs to purge
*/
public function __construct( array $urlArr ) {
$this->urls = $urlArr;
}
public function merge( MergeableUpdate $update ) {
/** @var CdnCacheUpdate $update */
Assert::parameterType( __CLASS__, $update, '$update' );
$this->urls = array_merge( $this->urls, $update->urls );
}
/**
* Create an update object from an array of Title objects, or a TitleArray object
*
* @param Traversable|array $titles
* @param string[] $urlArr
* @return CdnCacheUpdate
*/
public static function newFromTitles( $titles, $urlArr = [] ) {
/** @var Title $title */
foreach ( $titles as $title ) {
$urlArr = array_merge( $urlArr, $title->getCdnUrls() );
}
return new CdnCacheUpdate( $urlArr );
}
/**
* @param Title $title
* @return CdnCacheUpdate
* @deprecated 1.27
*/
public static function newSimplePurge( Title $title ) {
return new CdnCacheUpdate( $title->getCdnUrls() );
}
/**
* Purges the list of URLs passed to the constructor.
*/
public function doUpdate() {
global $wgCdnReboundPurgeDelay;
self::purge( $this->urls );
if ( $wgCdnReboundPurgeDelay > 0 ) {
JobQueueGroup::singleton()->lazyPush( new CdnPurgeJob(
Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __CLASS__ ),
[
'urls' => $this->urls,
'jobReleaseTimestamp' => time() + $wgCdnReboundPurgeDelay
]
) );
}
}
/**
* Purges a list of CDN nodes defined in $wgSquidServers.
* $urlArr should contain the full URLs to purge as values
* (example: $urlArr[] = 'http://my.host/something')
*
* @param string[] $urlArr List of full URLs to purge
*/
public static function purge( array $urlArr ) {
global $wgSquidServers, $wgHTCPRouting;
if ( !$urlArr ) {
return;
}
// Remove duplicate URLs from list
$urlArr = array_unique( $urlArr );
wfDebugLog( 'squid', __METHOD__ . ': ' . implode( ' ', $urlArr ) );
// Reliably broadcast the purge to all edge nodes
$relayer = MediaWikiServices::getInstance()->getEventRelayerGroup()
->getRelayer( 'cdn-url-purges' );
$relayer->notify(
'cdn-url-purges',
[
'urls' => array_values( $urlArr ), // JSON array
'timestamp' => microtime( true )
]
);
// Send lossy UDP broadcasting if enabled
if ( $wgHTCPRouting ) {
self::HTCPPurge( $urlArr );
}
// Do direct server purges if enabled (this does not scale very well)
if ( $wgSquidServers ) {
// Maximum number of parallel connections per squid
$maxSocketsPerSquid = 8;
// Number of requests to send per socket
// 400 seems to be a good tradeoff, opening a socket takes a while
$urlsPerSocket = 400;
$socketsPerSquid = ceil( count( $urlArr ) / $urlsPerSocket );
if ( $socketsPerSquid > $maxSocketsPerSquid ) {
$socketsPerSquid = $maxSocketsPerSquid;
}
$pool = new SquidPurgeClientPool;
$chunks = array_chunk( $urlArr, ceil( count( $urlArr ) / $socketsPerSquid ) );
foreach ( $wgSquidServers as $server ) {
foreach ( $chunks as $chunk ) {
$client = new SquidPurgeClient( $server );
foreach ( $chunk as $url ) {
$client->queuePurge( $url );
}
$pool->addClient( $client );
}
}
$pool->run();
}
}
/**
* Send Hyper Text Caching Protocol (HTCP) CLR requests.
*
* @throws MWException
* @param string[] $urlArr Collection of URLs to purge
*/
private static function HTCPPurge( array $urlArr ) {
global $wgHTCPRouting, $wgHTCPMulticastTTL;
// HTCP CLR operation
$htcpOpCLR = 4;
// @todo FIXME: PHP doesn't support these socket constants (include/linux/in.h)
if ( !defined( "IPPROTO_IP" ) ) {
define( "IPPROTO_IP", 0 );
define( "IP_MULTICAST_LOOP", 34 );
define( "IP_MULTICAST_TTL", 33 );
}
// pfsockopen doesn't work because we need set_sock_opt
$conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
if ( !$conn ) {
$errstr = socket_strerror( socket_last_error() );
wfDebugLog( 'squid', __METHOD__ .
": Error opening UDP socket: $errstr" );
return;
}
// Set socket options
socket_set_option( $conn, IPPROTO_IP, IP_MULTICAST_LOOP, 0 );
if ( $wgHTCPMulticastTTL != 1 ) {
// Set multicast time to live (hop count) option on socket
socket_set_option( $conn, IPPROTO_IP, IP_MULTICAST_TTL,
$wgHTCPMulticastTTL );
}
// Get sequential trx IDs for packet loss counting
$ids = UIDGenerator::newSequentialPerNodeIDs(
'squidhtcppurge', 32, count( $urlArr ), UIDGenerator::QUICK_VOLATILE
);
foreach ( $urlArr as $url ) {
if ( !is_string( $url ) ) {
throw new MWException( 'Bad purge URL' );
}
$url = self::expand( $url );
$conf = self::getRuleForURL( $url, $wgHTCPRouting );
if ( !$conf ) {
wfDebugLog( 'squid', __METHOD__ .
"No HTCP rule configured for URL {$url} , skipping" );
continue;
}
if ( isset( $conf['host'] ) && isset( $conf['port'] ) ) {
// Normalize single entries
$conf = [ $conf ];
}
foreach ( $conf as $subconf ) {
if ( !isset( $subconf['host'] ) || !isset( $subconf['port'] ) ) {
throw new MWException( "Invalid HTCP rule for URL $url\n" );
}
}
// Construct a minimal HTCP request diagram
// as per RFC 2756
// Opcode 'CLR', no response desired, no auth
$htcpTransID = current( $ids );
next( $ids );
$htcpSpecifier = pack( 'na4na*na8n',
4, 'HEAD', strlen( $url ), $url,
8, 'HTTP/1.0', 0 );
$htcpDataLen = 8 + 2 + strlen( $htcpSpecifier );
$htcpLen = 4 + $htcpDataLen + 2;
// Note! Squid gets the bit order of the first
// word wrong, wrt the RFC. Apparently no other
// implementation exists, so adapt to Squid
$htcpPacket = pack( 'nxxnCxNxxa*n',
$htcpLen, $htcpDataLen, $htcpOpCLR,
$htcpTransID, $htcpSpecifier, 2 );
wfDebugLog( 'squid', __METHOD__ .
"Purging URL $url via HTCP" );
foreach ( $conf as $subconf ) {
socket_sendto( $conn, $htcpPacket, $htcpLen, 0,
$subconf['host'], $subconf['port'] );
}
}
}
/**
* Expand local URLs to fully-qualified URLs using the internal protocol
* and host defined in $wgInternalServer. Input that's already fully-
* qualified will be passed through unchanged.
*
* This is used to generate purge URLs that may be either local to the
* main wiki or include a non-native host, such as images hosted on a
* second internal server.
*
* Client functions should not need to call this.
*
* @param string $url
* @return string
*/
public static function expand( $url ) {
return wfExpandUrl( $url, PROTO_INTERNAL );
}
/**
* Find the HTCP routing rule to use for a given URL.
* @param string $url URL to match
* @param array $rules Array of rules, see $wgHTCPRouting for format and behavior
* @return mixed Element of $rules that matched, or false if nothing matched
*/
private static function getRuleForURL( $url, $rules ) {
foreach ( $rules as $regex => $routing ) {
if ( $regex === '' || preg_match( $regex, $url ) ) {
return $routing;
}
}
return false;
}
}
/**
* @deprecated since 1.27
*/
class SquidUpdate extends CdnCacheUpdate {
// Keep class name for b/c
}