wanCache = $wanCache; $this->revLookup = $revLookup; } /** * Get a list of gadget ids from cache/database * * @return string[] */ public function getGadgetIds(): array { $key = $this->getGadgetIdsKey(); $fname = __METHOD__; return $this->wanCache->getWithSetCallback( $key, self::CACHE_TTL, static function ( $oldValue, &$ttl, array &$setOpts ) use ( $fname ) { $dbr = wfGetDB( DB_REPLICA ); $setOpts += Database::getCacheSetOptions( $dbr ); return $dbr->newSelectQueryBuilder() ->select( 'page_title' ) ->from( 'page' ) ->where( [ 'page_namespace' => NS_GADGET_DEFINITION ] ) ->caller( $fname ) ->fetchFieldValues(); }, [ 'checkKeys' => [ $key ], 'pcTTL' => WANObjectCache::TTL_PROC_SHORT, 'lockTSE' => 30 ] ); } /** * @inheritDoc */ public function handlePageUpdate( LinkTarget $target ): void { if ( $target->inNamespace( NS_GADGET_DEFINITION ) ) { $this->purgeGadgetIdsList(); $this->purgeGadgetEntry( $target->getText() ); } } /** * Purge the list of gadget ids when a page is deleted or if a new page is created */ public function purgeGadgetIdsList(): void { $this->wanCache->touchCheckKey( $this->getGadgetIdsKey() ); } /** * @inheritDoc */ public function getGadgetDefinitionTitle( string $id ): ?Title { return Title::makeTitleSafe( NS_GADGET_DEFINITION, $id ); } /** * @param string $id * @throws InvalidArgumentException * @return Gadget */ public function getGadget( string $id ): Gadget { $key = $this->getGadgetCacheKey( $id ); $gadget = $this->wanCache->getWithSetCallback( $key, self::CACHE_TTL, function ( $old, &$ttl, array &$setOpts ) use ( $id ) { $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) ); $title = Title::makeTitleSafe( NS_GADGET_DEFINITION, $id ); if ( !$title ) { $ttl = WANObjectCache::TTL_UNCACHEABLE; return null; } $revRecord = $this->revLookup->getRevisionByTitle( $title ); if ( !$revRecord ) { $ttl = WANObjectCache::TTL_UNCACHEABLE; return null; } $content = $revRecord->getContent( SlotRecord::MAIN ); if ( !$content instanceof GadgetDefinitionContent ) { // Uhm... $ttl = WANObjectCache::TTL_UNCACHEABLE; return null; } return Gadget::serializeDefinition( $id, $content->getAssocArray() ); }, [ 'checkKeys' => [ $key ], 'pcTTL' => WANObjectCache::TTL_PROC_SHORT, 'lockTSE' => 30, 'version' => 2, ] ); if ( $gadget === null ) { throw new InvalidArgumentException( "No gadget registered for '$id'" ); } return new Gadget( $gadget ); } /** * Update the cache for a specific Gadget whenever it is updated * * @param string $id */ public function purgeGadgetEntry( $id ) { $this->wanCache->touchCheckKey( $this->getGadgetCacheKey( $id ) ); } /** * @return string */ private function getGadgetIdsKey() { return $this->wanCache->makeKey( 'gadgets', 'namespace', 'ids' ); } /** * @param string $id * @return string */ private function getGadgetCacheKey( $id ) { return $this->wanCache->makeKey( 'gadgets', 'object', md5( $id ), Gadget::GADGET_CLASS_VERSION ); } }