wiki.techinc.nl/includes/deferred/HtmlFileCacheUpdate.php
Aaron Schulz 3c7f29a6b9 Add small HtmlCacheUpdater service class to normalize purging code (2)
This is a re-submit of 35da1bbd7c, which was accidentally merged before
CR (and reverted with aa4da3c2e8).

The purge() method handles purging of both file cache and CDN, using
a PRESEND deferred update. This avoids code duplication and missing
file cache purge calls.

Also:
* Migrate HTMLCacheUpdate callers to just directly using HTMLCacheUpdateJob
* Add HtmlFileCacheUpdate class and defer such updates just like with CDN
* Simplify HTMLCacheUpdate constructor parameters
* Remove BacklinkCache::clear() calls which do nothing since the backlink
  query does not actually happen until the job runs

Bug: T230025
Change-Id: Ic1005e70e2c22d5bd1ca36dcdb618108ebe290f3
2020-04-14 03:19:07 +00:00

66 lines
1.9 KiB
PHP

<?php
/**
* 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
*/
use Wikimedia\Assert\Assert;
/**
* HTMLFileCache purge update for a set of titles
*
* @ingroup Cache
* @since 1.35
*/
class HtmlFileCacheUpdate implements DeferrableUpdate, MergeableUpdate {
/** @var string[] List of page prefixed DB keys */
private $prefixedDbKeys = [];
/**
* @param string[] $prefixedDbKeys List of page prefixed DB keys
*/
public function __construct( array $prefixedDbKeys ) {
$this->prefixedDbKeys = $prefixedDbKeys;
}
public function merge( MergeableUpdate $update ) {
/** @var self $update */
Assert::parameterType( __CLASS__, $update, '$update' );
'@phan-var self $update';
$this->prefixedDbKeys = array_merge( $this->prefixedDbKeys, $update->prefixedDbKeys );
}
/**
* @param Traversable|Title[] $titles Array or iterator of Title instances
* @return HtmlFileCacheUpdate
*/
public static function newFromTitles( $titles ) {
$prefixedDbKeys = [];
foreach ( $titles as $title ) {
$prefixedDbKeys[] = $title->getPrefixedDBkey();
}
return new self( $prefixedDbKeys );
}
public function doUpdate() {
foreach ( array_unique( $this->prefixedDbKeys ) as $prefixedDbKey ) {
HTMLFileCache::clearFileCache( $prefixedDbKey );
}
}
}