From 282c5fa9f31f9106645dd92007db187e00bfa3ec Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Wed, 9 Dec 2015 10:05:59 -0800 Subject: [PATCH] Rename SquidUpdate => CdnCacheUpdate Squid is not the only possible CDN Change-Id: Ie2a2955847c5706e630322bbbab71c9d063b378f --- autoload.php | 4 +++- includes/Title.php | 2 +- includes/clientpool/SquidPurgeClient.php | 2 +- .../{SquidUpdate.php => CdnCacheUpdate.php} | 21 ++++++++++++------- includes/filerepo/file/LocalFile.php | 12 +++++------ includes/jobqueue/jobs/HTMLCacheUpdateJob.php | 2 +- includes/page/WikiPage.php | 2 +- includes/revisiondelete/RevDelFileList.php | 2 +- maintenance/benchmarks/benchmarkPurge.php | 2 +- maintenance/purgeChangedPages.php | 2 +- maintenance/purgeList.php | 4 ++-- ...dUpdateTest.php => CdnCacheUpdateTest.php} | 6 +++--- 12 files changed, 35 insertions(+), 26 deletions(-) rename includes/deferred/{SquidUpdate.php => CdnCacheUpdate.php} (94%) rename tests/phpunit/includes/deferred/{SquidUpdateTest.php => CdnCacheUpdateTest.php} (83%) diff --git a/autoload.php b/autoload.php index ed765b0b35..fce9cd4135 100644 --- a/autoload.php +++ b/autoload.php @@ -199,6 +199,7 @@ $wgAutoloadLocalClasses = array( 'CdbException' => __DIR__ . '/includes/compat/CdbCompat.php', 'CdbReader' => __DIR__ . '/includes/compat/CdbCompat.php', 'CdbWriter' => __DIR__ . '/includes/compat/CdbCompat.php', + 'CdnCacheUpdate' => __DIR__ . '/includes/deferred/CdnCacheUpdate.php', 'CentralIdLookup' => __DIR__ . '/includes/user/CentralIdLookup.php', 'CgzCopyTransaction' => __DIR__ . '/maintenance/storage/recompressTracked.php', 'ChangePassword' => __DIR__ . '/maintenance/changePassword.php', @@ -471,6 +472,7 @@ $wgAutoloadLocalClasses = array( 'GanConverter' => __DIR__ . '/languages/classes/LanguageGan.php', 'GenderCache' => __DIR__ . '/includes/cache/GenderCache.php', 'GenerateCollationData' => __DIR__ . '/maintenance/language/generateCollationData.php', + 'GenerateCommonPassword' => __DIR__ . '/maintenance/createCommonPasswordCdb.php', 'GenerateJsonI18n' => __DIR__ . '/maintenance/generateJsonI18n.php', 'GenerateNormalizerDataAr' => __DIR__ . '/maintenance/language/generateNormalizerDataAr.php', 'GenerateNormalizerDataMl' => __DIR__ . '/maintenance/language/generateNormalizerDataMl.php', @@ -1212,7 +1214,7 @@ $wgAutoloadLocalClasses = array( 'SqliteUpdater' => __DIR__ . '/includes/installer/SqliteUpdater.php', 'SquidPurgeClient' => __DIR__ . '/includes/clientpool/SquidPurgeClient.php', 'SquidPurgeClientPool' => __DIR__ . '/includes/clientpool/SquidPurgeClientPool.php', - 'SquidUpdate' => __DIR__ . '/includes/deferred/SquidUpdate.php', + 'SquidUpdate' => __DIR__ . '/includes/deferred/CdnCacheUpdate.php', 'SrConverter' => __DIR__ . '/languages/classes/LanguageSr.php', 'StatsOutput' => __DIR__ . '/maintenance/language/StatOutputs.php', 'Status' => __DIR__ . '/includes/Status.php', diff --git a/includes/Title.php b/includes/Title.php index 46131c1da0..440204b5ab 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -3592,7 +3592,7 @@ class Title { */ public function purgeSquid() { DeferredUpdates::addUpdate( - new SquidUpdate( $this->getSquidURLs() ), + new CdnCacheUpdate( $this->getSquidURLs() ), DeferredUpdates::PRESEND ); } diff --git a/includes/clientpool/SquidPurgeClient.php b/includes/clientpool/SquidPurgeClient.php index 91100e9270..24b8b8eb75 100644 --- a/includes/clientpool/SquidPurgeClient.php +++ b/includes/clientpool/SquidPurgeClient.php @@ -196,7 +196,7 @@ class SquidPurgeClient { */ public function queuePurge( $url ) { global $wgSquidPurgeUseHostHeader; - $url = SquidUpdate::expand( str_replace( "\n", '', $url ) ); + $url = CdnCacheUpdate::expand( str_replace( "\n", '', $url ) ); $request = array(); if ( $wgSquidPurgeUseHostHeader ) { $url = wfParseUrl( $url ); diff --git a/includes/deferred/SquidUpdate.php b/includes/deferred/CdnCacheUpdate.php similarity index 94% rename from includes/deferred/SquidUpdate.php rename to includes/deferred/CdnCacheUpdate.php index c223de8ff1..eb54bc2a40 100644 --- a/includes/deferred/SquidUpdate.php +++ b/includes/deferred/CdnCacheUpdate.php @@ -27,7 +27,7 @@ use Wikimedia\Assert\Assert; * Handles purging appropriate Squid URLs given a title (or titles) * @ingroup Cache */ -class SquidUpdate implements DeferrableUpdate, MergeableUpdate { +class CdnCacheUpdate implements DeferrableUpdate, MergeableUpdate { /** @var string[] Collection of URLs to purge */ protected $urls = array(); @@ -39,11 +39,11 @@ class SquidUpdate implements DeferrableUpdate, MergeableUpdate { } /** - * Create a SquidUpdate from an array of Title objects, or a TitleArray object + * Create an update object from an array of Title objects, or a TitleArray object * * @param Traversable|array $titles * @param string[] $urlArr - * @return SquidUpdate + * @return CdnCacheUpdate */ public static function newFromTitles( $titles, $urlArr = array() ) { /** @var Title $title */ @@ -51,16 +51,16 @@ class SquidUpdate implements DeferrableUpdate, MergeableUpdate { $urlArr = array_merge( $urlArr, $title->getSquidURLs() ); } - return new SquidUpdate( $urlArr ); + return new CdnCacheUpdate( $urlArr ); } /** * @param Title $title - * @return SquidUpdate + * @return CdnCacheUpdate * @deprecated 1.27 */ public static function newSimplePurge( Title $title ) { - return new SquidUpdate( $title->getSquidURLs() ); + return new CdnCacheUpdate( $title->getSquidURLs() ); } /** @@ -71,7 +71,7 @@ class SquidUpdate implements DeferrableUpdate, MergeableUpdate { } public function merge( MergeableUpdate $update ) { - /** @var SquidUpdate $update */ + /** @var CdnCacheUpdate $update */ Assert::parameterType( __CLASS__, $update, '$update' ); $this->urls = array_merge( $this->urls, $update->urls ); @@ -255,3 +255,10 @@ class SquidUpdate implements DeferrableUpdate, MergeableUpdate { return false; } } + +/** + * @deprecated since 1.27 + */ +class SquidUpdate extends CdnCacheUpdate { + // Keep class name for b/c +} diff --git a/includes/filerepo/file/LocalFile.php b/includes/filerepo/file/LocalFile.php index dcc87412ec..b986b85456 100644 --- a/includes/filerepo/file/LocalFile.php +++ b/includes/filerepo/file/LocalFile.php @@ -880,7 +880,7 @@ class LocalFile extends File { // Purge squid cache for this file DeferredUpdates::addUpdate( - new SquidUpdate( array( $this->getUrl() ) ), + new CdnCacheUpdate( array( $this->getUrl() ) ), DeferredUpdates::PRESEND ); } @@ -904,7 +904,7 @@ class LocalFile extends File { foreach ( $files as $file ) { $urls[] = $this->getArchiveThumbUrl( $archiveName, $file ); } - DeferredUpdates::addUpdate( new SquidUpdate( $urls ), DeferredUpdates::PRESEND ); + DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND ); } /** @@ -936,7 +936,7 @@ class LocalFile extends File { $this->purgeThumbList( $dir, $files ); // Purge the squid - DeferredUpdates::addUpdate( new SquidUpdate( $urls ), DeferredUpdates::PRESEND ); + DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND ); } /** @@ -1436,7 +1436,7 @@ class LocalFile extends File { $that->purgeThumbnails(); # Remove the old file from the squid cache DeferredUpdates::addUpdate( - new SquidUpdate( array( $that->getUrl() ) ), + new CdnCacheUpdate( array( $that->getUrl() ) ), DeferredUpdates::PRESEND ); } else { @@ -1637,7 +1637,7 @@ class LocalFile extends File { foreach ( $archiveNames as $archiveName ) { $purgeUrls[] = $this->getArchiveUrl( $archiveName ); } - DeferredUpdates::addUpdate( new SquidUpdate( $purgeUrls ), DeferredUpdates::PRESEND ); + DeferredUpdates::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates::PRESEND ); return $status; } @@ -1675,7 +1675,7 @@ class LocalFile extends File { } DeferredUpdates::addUpdate( - new SquidUpdate( array( $this->getArchiveUrl( $archiveName ) ) ), + new CdnCacheUpdate( array( $this->getArchiveUrl( $archiveName ) ) ), DeferredUpdates::PRESEND ); diff --git a/includes/jobqueue/jobs/HTMLCacheUpdateJob.php b/includes/jobqueue/jobs/HTMLCacheUpdateJob.php index ae35e30ad0..cffd564019 100644 --- a/includes/jobqueue/jobs/HTMLCacheUpdateJob.php +++ b/includes/jobqueue/jobs/HTMLCacheUpdateJob.php @@ -140,7 +140,7 @@ class HTMLCacheUpdateJob extends Job { ) ); // Update squid - $u = SquidUpdate::newFromTitles( $titleArray ); + $u = CdnCacheUpdate::newFromTitles( $titleArray ); $u->doUpdate(); // Update file cache diff --git a/includes/page/WikiPage.php b/includes/page/WikiPage.php index 294a22c802..be5ecbaa49 100644 --- a/includes/page/WikiPage.php +++ b/includes/page/WikiPage.php @@ -1133,7 +1133,7 @@ class WikiPage implements Page, IDBAccessObject { // Send purge after above page_touched update was committed DeferredUpdates::addUpdate( - new SquidUpdate( $title->getSquidURLs() ), + new CdnCacheUpdate( $title->getSquidURLs() ), DeferredUpdates::PRESEND ); diff --git a/includes/revisiondelete/RevDelFileList.php b/includes/revisiondelete/RevDelFileList.php index e5f32d22db..c8276fca74 100644 --- a/includes/revisiondelete/RevDelFileList.php +++ b/includes/revisiondelete/RevDelFileList.php @@ -117,7 +117,7 @@ class RevDelFileList extends RevDelList { $purgeUrls[] = $file->getArchiveUrl( $archiveName ); } DeferredUpdates::addUpdate( - new SquidUpdate( $purgeUrls ), + new CdnCacheUpdate( $purgeUrls ), DeferredUpdates::PRESEND ); diff --git a/maintenance/benchmarks/benchmarkPurge.php b/maintenance/benchmarks/benchmarkPurge.php index 42c1eb78a3..9eca73c682 100644 --- a/maintenance/benchmarks/benchmarkPurge.php +++ b/maintenance/benchmarks/benchmarkPurge.php @@ -63,7 +63,7 @@ class BenchmarkPurge extends Benchmarker { private function benchSquid( $urls, $trials = 1 ) { $start = microtime( true ); for ( $i = 0; $i < $trials; $i++ ) { - SquidUpdate::purge( $urls ); + CdnCacheUpdate::purge( $urls ); } $delta = microtime( true ) - $start; $pertrial = $delta / $trials; diff --git a/maintenance/purgeChangedPages.php b/maintenance/purgeChangedPages.php index 56e22c4040..31500c9ce0 100644 --- a/maintenance/purgeChangedPages.php +++ b/maintenance/purgeChangedPages.php @@ -135,7 +135,7 @@ class PurgeChangedPages extends Maintenance { } // Send batch of purge requests out to squids - $squid = new SquidUpdate( $urls, count( $urls ) ); + $squid = new CdnCacheUpdate( $urls, count( $urls ) ); $squid->doUpdate(); if ( $this->hasOption( 'sleep-per-batch' ) ) { diff --git a/maintenance/purgeList.php b/maintenance/purgeList.php index 2e1963097d..31ea5d0899 100644 --- a/maintenance/purgeList.php +++ b/maintenance/purgeList.php @@ -129,7 +129,7 @@ class PurgeList extends Maintenance { if ( $this->hasOption( 'verbose' ) ) { $this->output( $url . "\n" ); } - $u = new SquidUpdate( array( $url ) ); + $u = new CdnCacheUpdate( array( $url ) ); $u->doUpdate(); usleep( $delay * 1e6 ); } @@ -137,7 +137,7 @@ class PurgeList extends Maintenance { if ( $this->hasOption( 'verbose' ) ) { $this->output( implode( "\n", $urls ) . "\n" ); } - $u = new SquidUpdate( $urls ); + $u = new CdnCacheUpdate( $urls ); $u->doUpdate(); } } diff --git a/tests/phpunit/includes/deferred/SquidUpdateTest.php b/tests/phpunit/includes/deferred/CdnCacheUpdateTest.php similarity index 83% rename from tests/phpunit/includes/deferred/SquidUpdateTest.php rename to tests/phpunit/includes/deferred/CdnCacheUpdateTest.php index 6ceb42c116..de77ad5071 100644 --- a/tests/phpunit/includes/deferred/SquidUpdateTest.php +++ b/tests/phpunit/includes/deferred/CdnCacheUpdateTest.php @@ -1,6 +1,6 @@ setMwGlobals( 'wgCommandLineMode', false ); @@ -9,14 +9,14 @@ class SquidUpdatesTest extends MediaWikiTestCase { $urls1[] = $title->getCanonicalURL( '?x=1' ); $urls1[] = $title->getCanonicalURL( '?x=2' ); $urls1[] = $title->getCanonicalURL( '?x=3' ); - $update1 = new SquidUpdate( $urls1 ); + $update1 = new CdnCacheUpdate( $urls1 ); DeferredUpdates::addUpdate( $update1 ); $urls2 = array(); $urls2[] = $title->getCanonicalURL( '?x=2' ); $urls2[] = $title->getCanonicalURL( '?x=3' ); $urls2[] = $title->getCanonicalURL( '?x=4' ); - $update2 = new SquidUpdate( $urls2 ); + $update2 = new CdnCacheUpdate( $urls2 ); DeferredUpdates::addUpdate( $update2 ); $wrapper = TestingAccessWrapper::newFromObject( $update1 ); -- 2.20.1