<?php
/**
+ * Abstraction for resource loader modules which pull from wiki pages.
+ *
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* @author Roan Kattouw
*/
-defined( 'MEDIAWIKI' ) || die( 1 );
-
/**
* Abstraction for resource loader modules which pull from wiki pages
- *
- * This can only be used for wiki pages in the MediaWiki and User namespaces,
- * because of its dependence on the functionality of
- * Title::isValidCssJsSubpage.
+ *
+ * This can only be used for wiki pages in the MediaWiki and User namespaces,
+ * because of its dependence on the functionality of
+ * Title::isCssJsSubpage.
*/
abstract class ResourceLoaderWikiModule extends ResourceLoaderModule {
-
+
/* Protected Members */
# Origin is user-supplied code
protected $origin = self::ORIGIN_USER_SITEWIDE;
-
- // In-object cache for modified time
- protected $modifiedTime = array();
-
+
+ // In-object cache for title mtimes
+ protected $titleMtimes = array();
+
/* Abstract Protected Methods */
-
+
+ /**
+ * @abstract
+ * @param $context ResourceLoaderContext
+ */
abstract protected function getPages( ResourceLoaderContext $context );
-
+
/* Protected Methods */
-
- protected function getContent( $page, $ns ) {
- if ( $ns === NS_MEDIAWIKI ) {
- return wfEmptyMsg( $page ) ? '' : wfMsgExt( $page, 'content' );
+
+ /**
+ * Get the Database object used in getTitleMTimes(). Defaults to the local slave DB
+ * but subclasses may want to override this to return a remote DB object, or to return
+ * null if getTitleMTimes() shouldn't access the DB at all.
+ *
+ * NOTE: This ONLY works for getTitleMTimes() and getModifiedTime(), NOT FOR ANYTHING ELSE.
+ * In particular, it doesn't work for getting the content of JS and CSS pages. That functionality
+ * will use the local DB irrespective of the return value of this method.
+ *
+ * @return DatabaseBase|null
+ */
+ protected function getDB() {
+ return wfGetDB( DB_SLAVE );
+ }
+
+ /**
+ * @param $title Title
+ * @return null|string
+ */
+ protected function getContent( $title ) {
+ if ( $title->getNamespace() === NS_MEDIAWIKI ) {
+ // The first "true" is to use the database, the second is to use the content langue
+ // and the last one is to specify the message key already contains the language in it ("/de", etc.)
+ $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
+ return $text === false ? '' : $text;
}
- $title = Title::newFromText( $page, $ns );
- if ( !$title || !$title->isCssJsSubpage() ) {
+ if ( !$title->isCssJsSubpage() && !$title->isCssOrJsPage() ) {
return null;
}
$revision = Revision::newFromTitle( $title );
}
return $revision->getRawText();
}
-
+
/* Methods */
+ /**
+ * @param $context ResourceLoaderContext
+ * @return string
+ */
public function getScript( ResourceLoaderContext $context ) {
$scripts = '';
- foreach ( $this->getPages( $context ) as $page => $options ) {
+ foreach ( $this->getPages( $context ) as $titleText => $options ) {
if ( $options['type'] !== 'script' ) {
continue;
}
- $script = $this->getContent( $page, $options['ns'] );
- if ( $script ) {
- $ns = MWNamespace::getCanonicalName( $options['ns'] );
- $scripts .= "/* $ns:$page */\n$script\n";
+ $title = Title::newFromText( $titleText );
+ if ( !$title || $title->isRedirect() ) {
+ continue;
+ }
+ $script = $this->getContent( $title );
+ if ( strval( $script ) !== '' ) {
+ $script = $this->validateScriptFile( $titleText, $script );
+ if ( strpos( $titleText, '*/' ) === false ) {
+ $scripts .= "/* $titleText */\n";
+ }
+ $scripts .= $script . "\n";
}
}
return $scripts;
}
+ /**
+ * @param $context ResourceLoaderContext
+ * @return array
+ */
public function getStyles( ResourceLoaderContext $context ) {
-
+ global $wgScriptPath;
+
$styles = array();
- foreach ( $this->getPages( $context ) as $page => $options ) {
+ foreach ( $this->getPages( $context ) as $titleText => $options ) {
if ( $options['type'] !== 'style' ) {
continue;
}
+ $title = Title::newFromText( $titleText );
+ if ( !$title || $title->isRedirect() ) {
+ continue;
+ }
$media = isset( $options['media'] ) ? $options['media'] : 'all';
- $style = $this->getContent( $page, $options['ns'] );
- if ( !$style ) {
+ $style = $this->getContent( $title );
+ if ( strval( $style ) === '' ) {
continue;
}
if ( $this->getFlip( $context ) ) {
$style = CSSJanus::transform( $style, true, false );
}
+ $style = CSSMin::remap( $style, false, $wgScriptPath, true );
if ( !isset( $styles[$media] ) ) {
$styles[$media] = '';
}
- $ns = MWNamespace::getCanonicalName( $options['ns'] );
- $styles[$media] .= "/* $ns:$page */\n$style\n";
+ if ( strpos( $titleText, '*/' ) === false ) {
+ $styles[$media] .= "/* $titleText */\n";
+ }
+ $styles[$media] .= $style . "\n";
}
return $styles;
}
+ /**
+ * @param $context ResourceLoaderContext
+ * @return int|mixed
+ */
public function getModifiedTime( ResourceLoaderContext $context ) {
- $hash = $context->getHash();
- if ( isset( $this->modifiedTime[$hash] ) ) {
- return $this->modifiedTime[$hash];
+ $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
+ $mtimes = $this->getTitleMtimes( $context );
+ if ( count( $mtimes ) ) {
+ $modifiedTime = max( $modifiedTime, max( $mtimes ) );
}
+ $modifiedTime = max( $modifiedTime, $this->getMsgBlobMtime( $context->getLanguage() ) );
+ return $modifiedTime;
+ }
- $titles = array();
- foreach ( $this->getPages( $context ) as $page => $options ) {
- $titles[$options['ns']][$page] = true;
- }
+ /**
+ * @param $context ResourceLoaderContext
+ * @return bool
+ */
+ public function isKnownEmpty( ResourceLoaderContext $context ) {
+ return count( $this->getTitleMtimes( $context ) ) == 0;
+ }
- $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
+ /**
+ * Get the modification times of all titles that would be loaded for
+ * a given context.
+ * @param $context ResourceLoaderContext: Context object
+ * @return array( prefixed DB key => UNIX timestamp ), nonexistent titles are dropped
+ */
+ protected function getTitleMtimes( ResourceLoaderContext $context ) {
+ $dbr = $this->getDB();
+ if ( !$dbr ) {
+ // We're dealing with a subclass that doesn't have a DB
+ return array();
+ }
+
+ $hash = $context->getHash();
+ if ( isset( $this->titleMtimes[$hash] ) ) {
+ return $this->titleMtimes[$hash];
+ }
- if ( $titles ) {
- $dbr = wfGetDB( DB_SLAVE );
- $latest = $dbr->selectField( 'page', 'MAX(page_touched)',
- $dbr->makeWhereFrom2d( $titles, 'page_namespace', 'page_title' ),
- __METHOD__ );
+ $this->titleMtimes[$hash] = array();
+ $batch = new LinkBatch;
+ foreach ( $this->getPages( $context ) as $titleText => $options ) {
+ $batch->addObj( Title::newFromText( $titleText ) );
+ }
- if ( $latest ) {
- $modifiedTime = wfTimestamp( TS_UNIX, $latest );
+ if ( !$batch->isEmpty() ) {
+ $res = $dbr->select( 'page',
+ array( 'page_namespace', 'page_title', 'page_touched' ),
+ $batch->constructSet( 'page', $dbr ),
+ __METHOD__
+ );
+ foreach ( $res as $row ) {
+ $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+ $this->titleMtimes[$hash][$title->getPrefixedDBkey()] =
+ wfTimestamp( TS_UNIX, $row->page_touched );
}
}
-
- return $this->modifiedTime[$hash] = $modifiedTime;
+ return $this->titleMtimes[$hash];
}
}