includes/resourceloader/ResourceLoaderWikiModule.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @author Trevor Parscal
  20  * @author Roan Kattouw
  21  */
  22
  23 defined( 'MEDIAWIKI' ) || die( 1 );
  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::isValidCssJsSubpage.
  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 mtimes
  40         protected $titleMtimes = array();
  41
  42         /* Abstract Protected Methods */
  43
  44         abstract protected function getPages( ResourceLoaderContext $context );
  45
  46         /* Protected Methods */
  47
  48         /**
  49          * @param $title Title
  50          * @return null|string
  51          */
  52         protected function getContent( $title ) {
  53                 if ( $title->getNamespace() === NS_MEDIAWIKI ) {
  54                         $dbkey = $title->getDBkey();
  55                         return wfEmptyMsg( $dbkey ) ? '' : wfMsgExt( $dbkey, 'content' );
  56                 }
  57                 if ( !$title->isCssJsSubpage() ) {
  58                         return null;
  59                 }
  60                 $revision = Revision::newFromTitle( $title );
  61                 if ( !$revision ) {
  62                         return null;
  63                 }
  64                 return $revision->getRawText();
  65         }
  66
  67         /* Methods */
  68
  69         public function getScript( ResourceLoaderContext $context ) {
  70                 $scripts = '';
  71                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
  72                         if ( $options['type'] !== 'script' ) {
  73                                 continue;
  74                         }
  75                         $title = Title::newFromText( $titleText );
  76                         if ( !$title ) {
  77                                 continue;
  78                         }
  79                         $script = $this->getContent( $title );
  80                         if ( strval( $script ) !== '' ) {
  81                                 if ( strpos( $titleText, '*/' ) === false ) {
  82                                         $scripts .=  "/* $titleText */\n";
  83                                 }
  84                                 $scripts .= $script . "\n";
  85                         }
  86                 }
  87                 return $scripts;
  88         }
  89
  90         public function getStyles( ResourceLoaderContext $context ) {
  91                 global $wgScriptPath;
  92
  93                 $styles = array();
  94                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
  95                         if ( $options['type'] !== 'style' ) {
  96                                 continue;
  97                         }
  98                         $title = Title::newFromText( $titleText );
  99                         if ( !$title ) {
 100                                 continue;
 101                         }
 102                         $media = isset( $options['media'] ) ? $options['media'] : 'all';
 103                         $style = $this->getContent( $title );
 104                         if ( strval( $style ) === '' ) {
 105                                 continue;
 106                         }
 107                         if ( $this->getFlip( $context ) ) {
 108                                 $style = CSSJanus::transform( $style, true, false );
 109                         }
 110                         $style = CSSMin::remap( $style, false, $wgScriptPath, true );
 111                         if ( !isset( $styles[$media] ) ) {
 112                                 $styles[$media] = '';
 113                         }
 114                         if ( strpos( $titleText, '*/' ) === false ) {
 115                                 $styles[$media] .=  "/* $titleText */\n";
 116                         }
 117                         $styles[$media] .= $style . "\n";
 118                 }
 119                 return $styles;
 120         }
 121
 122         public function getModifiedTime( ResourceLoaderContext $context ) {
 123                 $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
 124                 $mtimes = $this->getTitleMtimes( $context );
 125                 if ( count( $mtimes ) ) {
 126                         $modifiedTime = max( $modifiedTime, max( $mtimes ) );
 127                 }
 128                 return $modifiedTime;
 129         }
 130
 131         public function isKnownEmpty( ResourceLoaderContext $context ) {
 132                 return count( $this->getTitleMtimes( $context ) ) == 0;
 133         }
 134
 135         /**
 136          * @param $context ResourceLoaderContext
 137          * @return bool
 138          */
 139         public function getFlip( $context ) {
 140                 global $wgContLang;
 141
 142                 return $wgContLang->getDir() !== $context->getDirection();
 143         }
 144
 145         /**
 146          * Get the modification times of all titles that would be loaded for
 147          * a given context.
 148          * @param $context ResourceLoaderContext: Context object
 149          * @return array( prefixed DB key => UNIX timestamp ), nonexistent titles are dropped
 150          */
 151         protected function getTitleMtimes( ResourceLoaderContext $context ) {
 152                 $hash = $context->getHash();
 153                 if ( isset( $this->titleMtimes[$hash] ) ) {
 154                         return $this->titleMtimes[$hash];
 155                 }
 156
 157                 $this->titleMtimes[$hash] = array();
 158                 $batch = new LinkBatch;
 159                 foreach ( $this->getPages( $context ) as $titleText => $options ) {
 160                         $batch->addObj( Title::newFromText( $titleText ) );
 161                 }
 162
 163                 if ( !$batch->isEmpty() ) {
 164                         $dbr = wfGetDB( DB_SLAVE );
 165                         $res = $dbr->select( 'page',
 166                                 array( 'page_namespace', 'page_title', 'page_touched' ),
 167                                 $batch->constructSet( 'page', $dbr ),
 168                                 __METHOD__
 169                         );
 170                         foreach ( $res as $row ) {
 171                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 172                                 $this->titleMtimes[$hash][$title->getPrefixedDBkey()] =
 173                                         wfTimestamp( TS_UNIX, $row->page_touched );
 174                         }
 175                 }
 176                 return $this->titleMtimes[$hash];
 177         }
 178 }