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.
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.
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
19 * @author Trevor Parscal
20 * @author Roan Kattouw
23 defined( 'MEDIAWIKI' ) ||
die( 1 );
26 * Abstraction for resource loader modules which pull from wiki pages
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.
32 abstract class ResourceLoaderWikiModule
extends ResourceLoaderModule
{
34 /* Protected Members */
36 # Origin is user-supplied code
37 protected $origin = self
::ORIGIN_USER_SITEWIDE
;
39 // In-object cache for modified time
40 protected $modifiedTime = array();
42 /* Abstract Protected Methods */
44 abstract protected function getPages( ResourceLoaderContext
$context );
46 /* Protected Methods */
48 protected function getContent( $title ) {
49 if ( $title->getNamespace() === NS_MEDIAWIKI
) {
50 $dbkey = $title->getDBkey();
51 return wfEmptyMsg( $dbkey ) ?
'' : wfMsgExt( $dbkey, 'content' );
53 if ( !$title->isCssJsSubpage() ) {
56 $revision = Revision
::newFromTitle( $title );
60 return $revision->getRawText();
65 public function getScript( ResourceLoaderContext
$context ) {
67 foreach ( $this->getPages( $context ) as $titleText => $options ) {
68 if ( $options['type'] !== 'script' ) {
71 $title = Title
::newFromText( $titleText );
75 $script = $this->getContent( $title );
76 if ( strval( $script ) !== '' ) {
77 if ( strpos( $titleText, '*/' ) === false ) {
78 $scripts .= "/* $titleText */\n";
80 $scripts .= $script . "\n";
86 public function getStyles( ResourceLoaderContext
$context ) {
89 foreach ( $this->getPages( $context ) as $titleText => $options ) {
90 if ( $options['type'] !== 'style' ) {
93 $title = Title
::newFromText( $titleText );
97 $media = isset( $options['media'] ) ?
$options['media'] : 'all';
98 $style = $this->getContent( $title );
99 if ( strval( $style ) === '' ) {
102 if ( $this->getFlip( $context ) ) {
103 $style = CSSJanus
::transform( $style, true, false );
105 if ( !isset( $styles[$media] ) ) {
106 $styles[$media] = '';
108 if ( strpos( $titleText, '*/' ) === false ) {
109 $styles[$media] .= "/* $titleText */\n";
111 $styles[$media] .= $style . "\n";
116 public function getModifiedTime( ResourceLoaderContext
$context ) {
117 $hash = $context->getHash();
118 if ( isset( $this->modifiedTime
[$hash] ) ) {
119 return $this->modifiedTime
[$hash];
122 $batch = new LinkBatch
;
123 foreach ( $this->getPages( $context ) as $titleText => $options ) {
124 $batch->addObj( Title
::newFromText( $titleText ) );
127 $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
128 if ( !$batch->isEmpty() ) {
129 $dbr = wfGetDB( DB_SLAVE
);
130 $latest = $dbr->selectField( 'page', 'MAX(page_touched)',
131 $batch->constructSet( 'page', $dbr ),
135 $modifiedTime = wfTimestamp( TS_UNIX
, $latest );
139 $this->modifiedTime
[$hash] = $modifiedTime;
140 return $modifiedTime;