includes/resourceloader/ResourceLoaderWikiModule.php

   1 <?php
   2 /**
   3  * Abstraction for ResourceLoader modules that pull from wiki pages.
   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  * @author Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 use Wikimedia\Rdbms\Database;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * Abstraction for ResourceLoader modules which pull from wiki pages
  30  *
  31  * This can only be used for wiki pages in the MediaWiki and User namespaces,
  32  * because of its dependence on the functionality of Title::isCssJsSubpage
  33  * and Title::isCssOrJsPage().
  34  *
  35  * This module supports being used as a placeholder for a module on a remote wiki.
  36  * To do so, getDB() must be overloaded to return a foreign database object that
  37  * allows local wikis to query page metadata.
  38  *
  39  * Safe for calls on local wikis are:
  40  * - Option getters:
  41  *   - getGroup()
  42  *   - getPages()
  43  * - Basic methods that strictly involve the foreign database
  44  *   - getDB()
  45  *   - isKnownEmpty()
  46  *   - getTitleInfo()
  47  */
  48 class ResourceLoaderWikiModule extends ResourceLoaderModule {
  49
  50         // Origin defaults to users with sitewide authority
  51         protected $origin = self::ORIGIN_USER_SITEWIDE;
  52
  53         // In-process cache for title info
  54         protected $titleInfo = [];
  55
  56         // List of page names that contain CSS
  57         protected $styles = [];
  58
  59         // List of page names that contain JavaScript
  60         protected $scripts = [];
  61
  62         // Group of module
  63         protected $group;
  64
  65         /**
  66          * @param array $options For back-compat, this can be omitted in favour of overwriting getPages.
  67          */
  68         public function __construct( array $options = null ) {
  69                 if ( is_null( $options ) ) {
  70                         return;
  71                 }
  72
  73                 foreach ( $options as $member => $option ) {
  74                         switch ( $member ) {
  75                                 case 'styles':
  76                                 case 'scripts':
  77                                 case 'group':
  78                                 case 'targets':
  79                                         $this->{$member} = $option;
  80                                         break;
  81                         }
  82                 }
  83         }
  84
  85         /**
  86          * Subclasses should return an associative array of resources in the module.
  87          * Keys should be the title of a page in the MediaWiki or User namespace.
  88          *
  89          * Values should be a nested array of options.  The supported keys are 'type' and
  90          * (CSS only) 'media'.
  91          *
  92          * For scripts, 'type' should be 'script'.
  93          *
  94          * For stylesheets, 'type' should be 'style'.
  95          * There is an optional media key, the value of which can be the
  96          * medium ('screen', 'print', etc.) of the stylesheet.
  97          *
  98          * @param ResourceLoaderContext $context
  99          * @return array
 100          */
 101         protected function getPages( ResourceLoaderContext $context ) {
 102                 $config = $this->getConfig();
 103                 $pages = [];
 104
 105                 // Filter out pages from origins not allowed by the current wiki configuration.
 106                 if ( $config->get( 'UseSiteJs' ) ) {
 107                         foreach ( $this->scripts as $script ) {
 108                                 $pages[$script] = [ 'type' => 'script' ];
 109                         }
 110                 }
 111
 112                 if ( $config->get( 'UseSiteCss' ) ) {
 113                         foreach ( $this->styles as $style ) {
 114                                 $pages[$style] = [ 'type' => 'style' ];
 115                         }
 116                 }
 117
 118                 return $pages;
 119         }
 120
 121         /**
 122          * Get group name
 123          *
 124          * @return string
 125          */
 126         public function getGroup() {
 127                 return $this->group;
 128         }
 129
 130         /**
 131          * Get the Database object used in getTitleInfo().
 132          *
 133          * Defaults to the local replica DB. Subclasses may want to override this to return a foreign
 134          * database object, or null if getTitleInfo() shouldn't access the database.
 135          *
 136          * NOTE: This ONLY works for getTitleInfo() and isKnownEmpty(), NOT FOR ANYTHING ELSE.
 137          * In particular, it doesn't work for getContent() or getScript() etc.
 138          *
 139          * @return IDatabase|null
 140          */
 141         protected function getDB() {
 142                 return wfGetDB( DB_REPLICA );
 143         }
 144
 145         /**
 146          * @param string $titleText
 147          * @return null|string
 148          */
 149         protected function getContent( $titleText ) {
 150                 $title = Title::newFromText( $titleText );
 151                 if ( !$title ) {
 152                         return null; // Bad title
 153                 }
 154
 155                 // If the page is a redirect, follow the redirect.
 156                 if ( $title->isRedirect() ) {
 157                         $content = $this->getContentObj( $title );
 158                         $title = $content ? $content->getUltimateRedirectTarget() : null;
 159                         if ( !$title ) {
 160                                 return null; // Dead redirect
 161                         }
 162                 }
 163
 164                 $handler = ContentHandler::getForTitle( $title );
 165                 if ( $handler->isSupportedFormat( CONTENT_FORMAT_CSS ) ) {
 166                         $format = CONTENT_FORMAT_CSS;
 167                 } elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) {
 168                         $format = CONTENT_FORMAT_JAVASCRIPT;
 169                 } else {
 170                         return null; // Bad content model
 171                 }
 172
 173                 $content = $this->getContentObj( $title );
 174                 if ( !$content ) {
 175                         return null; // No content found
 176                 }
 177
 178                 return $content->serialize( $format );
 179         }
 180
 181         /**
 182          * @param Title $title
 183          * @return Content|null
 184          */
 185         protected function getContentObj( Title $title ) {
 186                 $revision = Revision::newKnownCurrent( wfGetDB( DB_REPLICA ), $title );
 187                 if ( !$revision ) {
 188                         return null;
 189                 }
 190                 $content = $revision->getContent( Revision::RAW );
 191                 if ( !$content ) {
 192                         wfDebugLog( 'resourceloader', __METHOD__ . ': failed to load content of JS/CSS page!' );
 193                         return null;
 194                 }
 195                 return $content;
 196         }
 197
 198         /**
 199          * @param ResourceLoaderContext $context
 200          * @return string JavaScript code
 201          */
 202         public function getScript( ResourceLoaderContext $context ) {
 203                 $scripts = '';
 204                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 205                         if ( $options['type'] !== 'script' ) {
 206                                 continue;
 207                         }
 208                         $script = $this->getContent( $titleText );
 209                         if ( strval( $script ) !== '' ) {
 210                                 $script = $this->validateScriptFile( $titleText, $script );
 211                                 $scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n";
 212                         }
 213                 }
 214                 return $scripts;
 215         }
 216
 217         /**
 218          * @param ResourceLoaderContext $context
 219          * @return array
 220          */
 221         public function getStyles( ResourceLoaderContext $context ) {
 222                 $styles = [];
 223                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 224                         if ( $options['type'] !== 'style' ) {
 225                                 continue;
 226                         }
 227                         $media = isset( $options['media'] ) ? $options['media'] : 'all';
 228                         $style = $this->getContent( $titleText );
 229                         if ( strval( $style ) === '' ) {
 230                                 continue;
 231                         }
 232                         if ( $this->getFlip( $context ) ) {
 233                                 $style = CSSJanus::transform( $style, true, false );
 234                         }
 235                         $style = MemoizedCallable::call( 'CSSMin::remap',
 236                                 [ $style, false, $this->getConfig()->get( 'ScriptPath' ), true ] );
 237                         if ( !isset( $styles[$media] ) ) {
 238                                 $styles[$media] = [];
 239                         }
 240                         $style = ResourceLoader::makeComment( $titleText ) . $style;
 241                         $styles[$media][] = $style;
 242                 }
 243                 return $styles;
 244         }
 245
 246         /**
 247          * Disable module content versioning.
 248          *
 249          * This class does not support generating content outside of a module
 250          * request due to foreign database support.
 251          *
 252          * See getDefinitionSummary() for meta-data versioning.
 253          *
 254          * @return bool
 255          */
 256         public function enableModuleContentVersion() {
 257                 return false;
 258         }
 259
 260         /**
 261          * @param ResourceLoaderContext $context
 262          * @return array
 263          */
 264         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 265                 $summary = parent::getDefinitionSummary( $context );
 266                 $summary[] = [
 267                         'pages' => $this->getPages( $context ),
 268                         // Includes meta data of current revisions
 269                         'titleInfo' => $this->getTitleInfo( $context ),
 270                 ];
 271                 return $summary;
 272         }
 273
 274         /**
 275          * @param ResourceLoaderContext $context
 276          * @return bool
 277          */
 278         public function isKnownEmpty( ResourceLoaderContext $context ) {
 279                 $revisions = $this->getTitleInfo( $context );
 280
 281                 // For user modules, don't needlessly load if there are no non-empty pages
 282                 if ( $this->getGroup() === 'user' ) {
 283                         foreach ( $revisions as $revision ) {
 284                                 if ( $revision['page_len'] > 0 ) {
 285                                         // At least one non-empty page, module should be loaded
 286                                         return false;
 287                                 }
 288                         }
 289                         return true;
 290                 }
 291
 292                 // T70488: For other modules (i.e. ones that are called in cached html output) only check
 293                 // page existance. This ensures that, if some pages in a module are temporarily blanked,
 294                 // we don't end omit the module's script or link tag on some pages.
 295                 return count( $revisions ) === 0;
 296         }
 297
 298         private function setTitleInfo( $key, array $titleInfo ) {
 299                 $this->titleInfo[$key] = $titleInfo;
 300         }
 301
 302         /**
 303          * Get the information about the wiki pages for a given context.
 304          * @param ResourceLoaderContext $context
 305          * @return array Keyed by page name
 306          */
 307         protected function getTitleInfo( ResourceLoaderContext $context ) {
 308                 $dbr = $this->getDB();
 309                 if ( !$dbr ) {
 310                         // We're dealing with a subclass that doesn't have a DB
 311                         return [];
 312                 }
 313
 314                 $pageNames = array_keys( $this->getPages( $context ) );
 315                 sort( $pageNames );
 316                 $key = implode( '|', $pageNames );
 317                 if ( !isset( $this->titleInfo[$key] ) ) {
 318                         $this->titleInfo[$key] = static::fetchTitleInfo( $dbr, $pageNames, __METHOD__ );
 319                 }
 320                 return $this->titleInfo[$key];
 321         }
 322
 323         protected static function fetchTitleInfo( IDatabase $db, array $pages, $fname = __METHOD__ ) {
 324                 $titleInfo = [];
 325                 $batch = new LinkBatch;
 326                 foreach ( $pages as $titleText ) {
 327                         $title = Title::newFromText( $titleText );
 328                         if ( $title ) {
 329                                 // Page name may be invalid if user-provided (e.g. gadgets)
 330                                 $batch->addObj( $title );
 331                         }
 332                 }
 333                 if ( !$batch->isEmpty() ) {
 334                         $res = $db->select( 'page',
 335                                 // Include page_touched to allow purging if cache is poisoned (T117587, T113916)
 336                                 [ 'page_namespace', 'page_title', 'page_touched', 'page_len', 'page_latest' ],
 337                                 $batch->constructSet( 'page', $db ),
 338                                 $fname
 339                         );
 340                         foreach ( $res as $row ) {
 341                                 // Avoid including ids or timestamps of revision/page tables so
 342                                 // that versions are not wasted
 343                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 344                                 $titleInfo[$title->getPrefixedText()] = [
 345                                         'page_len' => $row->page_len,
 346                                         'page_latest' => $row->page_latest,
 347                                         'page_touched' => $row->page_touched,
 348                                 ];
 349                         }
 350                 }
 351                 return $titleInfo;
 352         }
 353
 354         /**
 355          * @since 1.28
 356          * @param ResourceLoaderContext $context
 357          * @param IDatabase $db
 358          * @param string[] $moduleNames
 359          */
 360         public static function preloadTitleInfo(
 361                 ResourceLoaderContext $context, IDatabase $db, array $moduleNames
 362         ) {
 363                 $rl = $context->getResourceLoader();
 364                 // getDB() can be overridden to point to a foreign database.
 365                 // For now, only preload local. In the future, we could preload by wikiID.
 366                 $allPages = [];
 367                 /** @var ResourceLoaderWikiModule[] $wikiModules */
 368                 $wikiModules = [];
 369                 foreach ( $moduleNames as $name ) {
 370                         $module = $rl->getModule( $name );
 371                         if ( $module instanceof self ) {
 372                                 $mDB = $module->getDB();
 373                                 // Subclasses may disable getDB and implement getTitleInfo differently
 374                                 if ( $mDB && $mDB->getDomainID() === $db->getDomainID() ) {
 375                                         $wikiModules[] = $module;
 376                                         $allPages += $module->getPages( $context );
 377                                 }
 378                         }
 379                 }
 380
 381                 if ( !$wikiModules ) {
 382                         // Nothing to preload
 383                         return;
 384                 }
 385
 386                 $pageNames = array_keys( $allPages );
 387                 sort( $pageNames );
 388                 $hash = sha1( implode( '|', $pageNames ) );
 389
 390                 // Avoid Zend bug where "static::" does not apply LSB in the closure
 391                 $func = [ static::class, 'fetchTitleInfo' ];
 392                 $fname = __METHOD__;
 393
 394                 $cache = ObjectCache::getMainWANInstance();
 395                 $allInfo = $cache->getWithSetCallback(
 396                         $cache->makeGlobalKey( 'resourceloader', 'titleinfo', $db->getDomainID(), $hash ),
 397                         $cache::TTL_HOUR,
 398                         function ( $curVal, &$ttl, array &$setOpts ) use ( $func, $pageNames, $db, $fname ) {
 399                                 $setOpts += Database::getCacheSetOptions( $db );
 400
 401                                 return call_user_func( $func, $db, $pageNames, $fname );
 402                         },
 403                         [
 404                                 'checkKeys' => [
 405                                         $cache->makeGlobalKey( 'resourceloader', 'titleinfo', $db->getDomainID() ) ]
 406                         ]
 407                 );
 408
 409                 foreach ( $wikiModules as $wikiModule ) {
 410                         $pages = $wikiModule->getPages( $context );
 411                         // Before we intersect, map the names to canonical form (T145673).
 412                         $intersect = [];
 413                         foreach ( $pages as $page => $unused ) {
 414                                 $title = Title::newFromText( $page );
 415                                 if ( $title ) {
 416                                         $intersect[ $title->getPrefixedText() ] = 1;
 417                                 } else {
 418                                         // Page name may be invalid if user-provided (e.g. gadgets)
 419                                         $rl->getLogger()->info(
 420                                                 'Invalid wiki page title "{title}" in ' . __METHOD__,
 421                                                 [ 'title' => $page ]
 422                                         );
 423                                 }
 424                         }
 425                         $info = array_intersect_key( $allInfo, $intersect );
 426                         $pageNames = array_keys( $pages );
 427                         sort( $pageNames );
 428                         $key = implode( '|', $pageNames );
 429                         $wikiModule->setTitleInfo( $key, $info );
 430                 }
 431         }
 432
 433         /**
 434          * Clear the preloadTitleInfo() cache for all wiki modules on this wiki on
 435          * page change if it was a JS or CSS page
 436          *
 437          * @param Title $title
 438          * @param Revision|null $old Prior page revision
 439          * @param Revision|null $new New page revision
 440          * @param string $wikiId
 441          * @since 1.28
 442          */
 443         public static function invalidateModuleCache(
 444                 Title $title, Revision $old = null, Revision $new = null, $wikiId
 445         ) {
 446                 static $formats = [ CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT ];
 447
 448                 if ( $old && in_array( $old->getContentFormat(), $formats ) ) {
 449                         $purge = true;
 450                 } elseif ( $new && in_array( $new->getContentFormat(), $formats ) ) {
 451                         $purge = true;
 452                 } else {
 453                         $purge = ( $title->isCssOrJsPage() || $title->isCssJsSubpage() );
 454                 }
 455
 456                 if ( $purge ) {
 457                         $cache = ObjectCache::getMainWANInstance();
 458                         $key = $cache->makeGlobalKey( 'resourceloader', 'titleinfo', $wikiId );
 459                         $cache->touchCheckKey( $key );
 460                 }
 461         }
 462
 463         /**
 464          * @since 1.28
 465          * @return string
 466          */
 467         public function getType() {
 468                 // Check both because subclasses don't always pass pages via the constructor,
 469                 // they may also override getPages() instead, in which case we should keep
 470                 // defaulting to LOAD_GENERAL and allow them to override getType() separately.
 471                 return ( $this->styles && !$this->scripts ) ? self::LOAD_STYLES : self::LOAD_GENERAL;
 472         }
 473 }