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
  30  * Title::isCssJsSubpage.
  31  */
  32 abstract class ResourceLoaderWikiModule extends ResourceLoaderModule {
  33
  34         /* Protected Members */
  35
  36         # Origin is user-supplied code
  37         protected $origin = self::ORIGIN_USER_SITEWIDE;
  38
  39         // In-object cache for title info
  40         protected $titleInfo = array();
  41
  42         /* Abstract Protected Methods */
  43
  44         /**
  45          * Subclasses should return an associative array of resources in the module.
  46          * Keys should be the title of a page in the MediaWiki or User namespace.
  47          *
  48          * Values should be a nested array of options.  The supported keys are 'type' and
  49          * (CSS only) 'media'.
  50          *
  51          * For scripts, 'type' should be 'script'.
  52          *
  53          * For stylesheets, 'type' should be 'style'.
  54          * There is an optional media key, the value of which can be the
  55          * medium ('screen', 'print', etc.) of the stylesheet.
  56          *
  57          * @param ResourceLoaderContext $context
  58          * @return array
  59          */
  60         abstract protected function getPages( ResourceLoaderContext $context );
  61
  62         /* Protected Methods */
  63
  64         /**
  65          * Get the Database object used in getTitleMTimes(). Defaults to the local slave DB
  66          * but subclasses may want to override this to return a remote DB object, or to return
  67          * null if getTitleMTimes() shouldn't access the DB at all.
  68          *
  69          * NOTE: This ONLY works for getTitleMTimes() and getModifiedTime(), NOT FOR ANYTHING ELSE.
  70          * In particular, it doesn't work for getting the content of JS and CSS pages. That functionality
  71          * will use the local DB irrespective of the return value of this method.
  72          *
  73          * @return DatabaseBase|null
  74          */
  75         protected function getDB() {
  76                 return wfGetDB( DB_SLAVE );
  77         }
  78
  79         /**
  80          * @param Title $title
  81          * @return null|string
  82          */
  83         protected function getContent( $title ) {
  84                 $handler = ContentHandler::getForTitle( $title );
  85                 if ( $handler->isSupportedFormat( CONTENT_FORMAT_CSS ) ) {
  86                         $format = CONTENT_FORMAT_CSS;
  87                 } elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) {
  88                         $format = CONTENT_FORMAT_JAVASCRIPT;
  89                 } else {
  90                         return null;
  91                 }
  92
  93                 $revision = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
  94                 if ( !$revision ) {
  95                         return null;
  96                 }
  97
  98                 $content = $revision->getContent( Revision::RAW );
  99
 100                 if ( !$content ) {
 101                         wfDebugLog( 'resourceloader', __METHOD__ . ': failed to load content of JS/CSS page!' );
 102                         return null;
 103                 }
 104
 105                 return $content->serialize( $format );
 106         }
 107
 108         /* Methods */
 109
 110         /**
 111          * @param ResourceLoaderContext $context
 112          * @return string
 113          */
 114         public function getScript( ResourceLoaderContext $context ) {
 115                 $scripts = '';
 116                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 117                         if ( $options['type'] !== 'script' ) {
 118                                 continue;
 119                         }
 120                         $title = Title::newFromText( $titleText );
 121                         if ( !$title || $title->isRedirect() ) {
 122                                 continue;
 123                         }
 124                         $script = $this->getContent( $title );
 125                         if ( strval( $script ) !== '' ) {
 126                                 $script = $this->validateScriptFile( $titleText, $script );
 127                                 $scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n";
 128                         }
 129                 }
 130                 return $scripts;
 131         }
 132
 133         /**
 134          * @param ResourceLoaderContext $context
 135          * @return array
 136          */
 137         public function getStyles( ResourceLoaderContext $context ) {
 138                 $styles = array();
 139                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 140                         if ( $options['type'] !== 'style' ) {
 141                                 continue;
 142                         }
 143                         $title = Title::newFromText( $titleText );
 144                         if ( !$title || $title->isRedirect() ) {
 145                                 continue;
 146                         }
 147                         $media = isset( $options['media'] ) ? $options['media'] : 'all';
 148                         $style = $this->getContent( $title );
 149                         if ( strval( $style ) === '' ) {
 150                                 continue;
 151                         }
 152                         if ( $this->getFlip( $context ) ) {
 153                                 $style = CSSJanus::transform( $style, true, false );
 154                         } else {
 155                                 $style = CSSJanus::nullTransform( $style );
 156                         }
 157                         $style = CSSMin::remap( $style, false, $this->getConfig()->get( 'ScriptPath' ), true );
 158                         if ( !isset( $styles[$media] ) ) {
 159                                 $styles[$media] = array();
 160                         }
 161                         $style = ResourceLoader::makeComment( $titleText ) . $style;
 162                         $styles[$media][] = $style;
 163                 }
 164                 return $styles;
 165         }
 166
 167         /**
 168          * @param ResourceLoaderContext $context
 169          * @return int|mixed
 170          */
 171         public function getModifiedTime( ResourceLoaderContext $context ) {
 172                 $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
 173                 $titleInfo = $this->getTitleInfo( $context );
 174                 if ( count( $titleInfo ) ) {
 175                         $mtimes = array_map( function( $value ) {
 176                                 return $value['timestamp'];
 177                         }, $titleInfo );
 178                         $modifiedTime = max( $modifiedTime, max( $mtimes ) );
 179                 }
 180                 $modifiedTime = max(
 181                         $modifiedTime,
 182                         $this->getMsgBlobMtime( $context->getLanguage() ),
 183                         $this->getDefinitionMtime( $context )
 184                 );
 185                 return $modifiedTime;
 186         }
 187
 188         /**
 189          * Get the definition summary for this module.
 190          *
 191          * @param ResourceLoaderContext $context
 192          * @return array
 193          */
 194         public function getDefinitionSummary( ResourceLoaderContext $context ) {
 195                 return array(
 196                         'class' => get_class( $this ),
 197                         'pages' => $this->getPages( $context ),
 198                 );
 199         }
 200
 201         /**
 202          * @param ResourceLoaderContext $context
 203          * @return bool
 204          */
 205         public function isKnownEmpty( ResourceLoaderContext $context ) {
 206                 $titleInfo = $this->getTitleInfo( $context );
 207                 // Bug 68488: For modules in the "user" group, we should actually
 208                 // check that the pages are empty (page_len == 0), but for other
 209                 // groups, just check the pages exist so that we don't end up
 210                 // caching temporarily-blank pages without the appropriate
 211                 // <script> or <link> tag.
 212                 if ( $this->getGroup() !== 'user' ) {
 213                         return count( $titleInfo ) === 0;
 214                 }
 215
 216                 foreach ( $titleInfo as $info ) {
 217                         if ( $info['length'] !== 0 ) {
 218                                 // At least one non-0-lenth page, not empty
 219                                 return false;
 220                         }
 221                 }
 222
 223                 // All pages are 0-length, so it's empty
 224                 return true;
 225         }
 226
 227         /**
 228          * Get the modification times of all titles that would be loaded for
 229          * a given context.
 230          * @param ResourceLoaderContext $context Context object
 231          * @return array keyed by page dbkey, with value is an array with 'length' and 'timestamp'
 232          *               keys, where the timestamp is a unix one
 233          */
 234         protected function getTitleInfo( ResourceLoaderContext $context ) {
 235                 $dbr = $this->getDB();
 236                 if ( !$dbr ) {
 237                         // We're dealing with a subclass that doesn't have a DB
 238                         return array();
 239                 }
 240
 241                 $hash = $context->getHash();
 242                 if ( isset( $this->titleInfo[$hash] ) ) {
 243                         return $this->titleInfo[$hash];
 244                 }
 245
 246                 $this->titleInfo[$hash] = array();
 247                 $batch = new LinkBatch;
 248                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 249                         $batch->addObj( Title::newFromText( $titleText ) );
 250                 }
 251
 252                 if ( !$batch->isEmpty() ) {
 253                         $res = $dbr->select( 'page',
 254                                 array( 'page_namespace', 'page_title', 'page_touched', 'page_len' ),
 255                                 $batch->constructSet( 'page', $dbr ),
 256                                 __METHOD__
 257                         );
 258                         foreach ( $res as $row ) {
 259                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 260                                 $this->titleInfo[$hash][$title->getPrefixedDBkey()] = array(
 261                                         'timestamp' => wfTimestamp( TS_UNIX, $row->page_touched ),
 262                                         'length' => $row->page_len,
 263                                 );
 264                         }
 265                 }
 266                 return $this->titleInfo[$hash];
 267         }
 268 }