includes/resourceloader/ResourceLoaderWikiModule.php

   1 <?php
   2 /**
   3  * Abstraction for resource loader modules which 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 /**
  26  * Abstraction for resource loader modules which pull from wiki pages
  27  *
  28  * This can only be used for wiki pages in the MediaWiki and User namespaces,
  29  * because of its dependence on the functionality of Title::isCssJsSubpage.
  30  *
  31  * This module supports being used as a placeholder for a module on a remote wiki.
  32  * To do so, getDB() must be overloaded to return a foreign database object that
  33  * allows local wikis to query page metadata.
  34  *
  35  * Safe for calls on local wikis are:
  36  * - Option getters:
  37  *   - getGroup()
  38  *   - getPosition()
  39  *   - getPages()
  40  * - Basic methods that strictly involve the foreign database
  41  *   - getDB()
  42  *   - isKnownEmpty()
  43  *   - getTitleInfo()
  44  */
  45 class ResourceLoaderWikiModule extends ResourceLoaderModule {
  46         /** @var string Position on the page to load this module at */
  47         protected $position = 'bottom';
  48
  49         // Origin defaults to users with sitewide authority
  50         protected $origin = self::ORIGIN_USER_SITEWIDE;
  51
  52         // In-process cache for title info
  53         protected $titleInfo = array();
  54
  55         // List of page names that contain CSS
  56         protected $styles = array();
  57
  58         // List of page names that contain JavaScript
  59         protected $scripts = array();
  60
  61         // Group of module
  62         protected $group;
  63
  64         /**
  65          * @param array $options For back-compat, this can be omitted in favour of overwriting getPages.
  66          */
  67         public function __construct( array $options = null ) {
  68                 if ( is_null( $options ) ) {
  69                         return;
  70                 }
  71
  72                 foreach ( $options as $member => $option ) {
  73                         switch ( $member ) {
  74                                 case 'position':
  75                                         $this->isPositionDefined = true;
  76                                         // Don't break since we need the member set as well
  77                                 case 'styles':
  78                                 case 'scripts':
  79                                 case 'group':
  80                                         $this->{$member} = $option;
  81                                         break;
  82                         }
  83                 }
  84         }
  85
  86         /**
  87          * Subclasses should return an associative array of resources in the module.
  88          * Keys should be the title of a page in the MediaWiki or User namespace.
  89          *
  90          * Values should be a nested array of options.  The supported keys are 'type' and
  91          * (CSS only) 'media'.
  92          *
  93          * For scripts, 'type' should be 'script'.
  94          *
  95          * For stylesheets, 'type' should be 'style'.
  96          * There is an optional media key, the value of which can be the
  97          * medium ('screen', 'print', etc.) of the stylesheet.
  98          *
  99          * @param ResourceLoaderContext $context
 100          * @return array
 101          */
 102         protected function getPages( ResourceLoaderContext $context ) {
 103                 $config = $this->getConfig();
 104                 $pages = array();
 105
 106                 // Filter out pages from origins not allowed by the current wiki configuration.
 107                 if ( $config->get( 'UseSiteJs' ) ) {
 108                         foreach ( $this->scripts as $script ) {
 109                                 $pages[$script] = array( 'type' => 'script' );
 110                         }
 111                 }
 112
 113                 if ( $config->get( 'UseSiteCss' ) ) {
 114                         foreach ( $this->styles as $style ) {
 115                                 $pages[$style] = array( 'type' => 'style' );
 116                         }
 117                 }
 118
 119                 return $pages;
 120         }
 121
 122         /**
 123          * Get group name
 124          *
 125          * @return string
 126          */
 127         public function getGroup() {
 128                 return $this->group;
 129         }
 130
 131         /**
 132          * Get the Database object used in getTitleInfo().
 133          *
 134          * Defaults to the local slave DB. Subclasses may want to override this to return a foreign
 135          * database object, or null if getTitleInfo() shouldn't access the database.
 136          *
 137          * NOTE: This ONLY works for getTitleInfo() and isKnownEmpty(), NOT FOR ANYTHING ELSE.
 138          * In particular, it doesn't work for getContent() or getScript() etc.
 139          *
 140          * @return IDatabase|null
 141          */
 142         protected function getDB() {
 143                 return wfGetDB( DB_SLAVE );
 144         }
 145
 146         /**
 147          * @param string $title
 148          * @return null|string
 149          */
 150         protected function getContent( $titleText ) {
 151                 $title = Title::newFromText( $titleText );
 152                 if ( !$title ) {
 153                         return null;
 154                 }
 155
 156                 $handler = ContentHandler::getForTitle( $title );
 157                 if ( $handler->isSupportedFormat( CONTENT_FORMAT_CSS ) ) {
 158                         $format = CONTENT_FORMAT_CSS;
 159                 } elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) {
 160                         $format = CONTENT_FORMAT_JAVASCRIPT;
 161                 } else {
 162                         return null;
 163                 }
 164
 165                 $revision = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
 166                 if ( !$revision ) {
 167                         return null;
 168                 }
 169
 170                 $content = $revision->getContent( Revision::RAW );
 171
 172                 if ( !$content ) {
 173                         wfDebugLog( 'resourceloader', __METHOD__ . ': failed to load content of JS/CSS page!' );
 174                         return null;
 175                 }
 176
 177                 return $content->serialize( $format );
 178         }
 179
 180         /**
 181          * @param ResourceLoaderContext $context
 182          * @return string
 183          */
 184         public function getScript( ResourceLoaderContext $context ) {
 185                 $scripts = '';
 186                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 187                         if ( $options['type'] !== 'script' ) {
 188                                 continue;
 189                         }
 190                         $script = $this->getContent( $titleText );
 191                         if ( strval( $script ) !== '' ) {
 192                                 $script = $this->validateScriptFile( $titleText, $script );
 193                                 $scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n";
 194                         }
 195                 }
 196                 return $scripts;
 197         }
 198
 199         /**
 200          * @param ResourceLoaderContext $context
 201          * @return array
 202          */
 203         public function getStyles( ResourceLoaderContext $context ) {
 204                 $styles = array();
 205                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 206                         if ( $options['type'] !== 'style' ) {
 207                                 continue;
 208                         }
 209                         $media = isset( $options['media'] ) ? $options['media'] : 'all';
 210                         $style = $this->getContent( $titleText );
 211                         if ( strval( $style ) === '' ) {
 212                                 continue;
 213                         }
 214                         if ( $this->getFlip( $context ) ) {
 215                                 $style = CSSJanus::transform( $style, true, false );
 216                         }
 217                         $style = MemoizedCallable::call( 'CSSMin::remap',
 218                                 array( $style, false, $this->getConfig()->get( 'ScriptPath' ), true ) );
 219                         if ( !isset( $styles[$media] ) ) {
 220                                 $styles[$media] = array();
 221                         }
 222                         $style = ResourceLoader::makeComment( $titleText ) . $style;
 223                         $styles[$media][] = $style;
 224                 }
 225                 return $styles;
 226         }
 227
 228         /**
 229          * Disable module content versioning.
 230          *
 231          * This class does not support generating content outside of a module
 232          * request due to foreign database support.
 233          *
 234          * See getDefinitionSummary() for meta-data versioning.
 235          *
 236          * @return bool
 237          */
 238         public function enableModuleContentVersion() {
 239                 return false;
 240         }
 241
 242         /**
 243          * @param ResourceLoaderContext $context
 244          * @return array
 245          */
 246         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 247                 $summary = parent::getDefinitionSummary( $context );
 248                 $summary[] = array(
 249                         'pages' => $this->getPages( $context ),
 250                         // Includes SHA1 of content
 251                         'titleInfo' => $this->getTitleInfo( $context ),
 252                 );
 253                 return $summary;
 254         }
 255
 256         /**
 257          * @param ResourceLoaderContext $context
 258          * @return bool
 259          */
 260         public function isKnownEmpty( ResourceLoaderContext $context ) {
 261                 $revisions = $this->getTitleInfo( $context );
 262
 263                 // For user modules, don't needlessly load if there are no non-empty pages
 264                 if ( $this->getGroup() === 'user' ) {
 265                         foreach ( $revisions as $revision ) {
 266                                 if ( $revision['rev_len'] > 0 ) {
 267                                         // At least one non-empty page, module should be loaded
 268                                         return false;
 269                                 }
 270                         }
 271                         return true;
 272                 }
 273
 274                 // Bug 68488: For other modules (i.e. ones that are called in cached html output) only check
 275                 // page existance. This ensures that, if some pages in a module are temporarily blanked,
 276                 // we don't end omit the module's script or link tag on some pages.
 277                 return count( $revisions ) === 0;
 278         }
 279
 280         /**
 281          * Get the information about the wiki pages for a given context.
 282          * @param ResourceLoaderContext $context
 283          * @return array Keyed by page name. Contains arrays with 'rev_len' and 'rev_sha1' keys
 284          */
 285         protected function getTitleInfo( ResourceLoaderContext $context ) {
 286                 $dbr = $this->getDB();
 287                 if ( !$dbr ) {
 288                         // We're dealing with a subclass that doesn't have a DB
 289                         return array();
 290                 }
 291
 292                 $pages = $this->getPages( $context );
 293                 $key = implode( '|', array_keys( $pages ) );
 294                 if ( !isset( $this->titleInfo[$key] ) ) {
 295                         $this->titleInfo[$key] = array();
 296                         $batch = new LinkBatch;
 297                         foreach ( $pages as $titleText => $options ) {
 298                                 $batch->addObj( Title::newFromText( $titleText ) );
 299                         }
 300
 301                         if ( !$batch->isEmpty() ) {
 302                                 $res = $dbr->select( array( 'page', 'revision' ),
 303                                         array( 'page_namespace', 'page_title', 'rev_len', 'rev_sha1' ),
 304                                         $batch->constructSet( 'page', $dbr ),
 305                                         __METHOD__,
 306                                         array(),
 307                                         array( 'revision' => array( 'INNER JOIN', array( 'page_latest=rev_id' ) ) )
 308                                 );
 309                                 foreach ( $res as $row ) {
 310                                         // Avoid including ids or timestamps of revision/page tables so
 311                                         // that versions are not wasted
 312                                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 313                                         $this->titleInfo[$key][$title->getPrefixedText()] = array(
 314                                                 'rev_len' => $row->rev_len,
 315                                                 'rev_sha1' => $row->rev_sha1,
 316                                         );
 317                                 }
 318                         }
 319                 }
 320                 return $this->titleInfo[$key];
 321         }
 322
 323         public function getPosition() {
 324                 return $this->position;
 325         }
 326 }