Merge "Whitelist the <wbr> element."
[mediawiki.git] / includes / resourceloader / ResourceLoaderWikiModule.php
blob3f10ae533254ef1b40a0f83541ac396f319bdc4a
1 <?php
2 /**
3 * Abstraction for resource loader modules which pull from wiki pages.
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.
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.
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
20 * @file
21 * @author Trevor Parscal
22 * @author Roan Kattouw
25 /**
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::isCssJsSubpage.
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 title mtimes
40 protected $titleMtimes = array();
42 /* Abstract Protected Methods */
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.
48 * Values should be a nested array of options. The supported keys are 'type' and
49 * (CSS only) 'media'.
51 * For scripts, 'type' should be 'script'.
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.
57 * @param $context ResourceLoaderContext
58 * @return array
60 abstract protected function getPages( ResourceLoaderContext $context );
62 /* Protected Methods */
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.
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.
73 * @return DatabaseBase|null
75 protected function getDB() {
76 return wfGetDB( DB_SLAVE );
79 /**
80 * @param $title Title
81 * @return null|string
83 protected function getContent( $title ) {
84 if ( !$title->isCssJsSubpage() && !$title->isCssOrJsPage() ) {
85 return null;
87 $revision = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
88 if ( !$revision ) {
89 return null;
92 $content = $revision->getContent( Revision::RAW );
94 if ( !$content ) {
95 wfDebugLog( 'resourceloader', __METHOD__ . ': failed to load content of JS/CSS page!' );
96 return null;
99 $model = $content->getModel();
101 if ( $model !== CONTENT_MODEL_CSS && $model !== CONTENT_MODEL_JAVASCRIPT ) {
102 wfDebugLog( 'resourceloader', __METHOD__ . ': bad content model $model for JS/CSS page!' );
103 return null;
106 return $content->getNativeData(); //NOTE: this is safe, we know it's JS or CSS
109 /* Methods */
112 * @param $context ResourceLoaderContext
113 * @return string
115 public function getScript( ResourceLoaderContext $context ) {
116 $scripts = '';
117 foreach ( $this->getPages( $context ) as $titleText => $options ) {
118 if ( $options['type'] !== 'script' ) {
119 continue;
121 $title = Title::newFromText( $titleText );
122 if ( !$title || $title->isRedirect() ) {
123 continue;
125 $script = $this->getContent( $title );
126 if ( strval( $script ) !== '' ) {
127 $script = $this->validateScriptFile( $titleText, $script );
128 if ( strpos( $titleText, '*/' ) === false ) {
129 $scripts .= "/* $titleText */\n";
131 $scripts .= $script . "\n";
134 return $scripts;
138 * @param $context ResourceLoaderContext
139 * @return array
141 public function getStyles( ResourceLoaderContext $context ) {
142 global $wgScriptPath;
144 $styles = array();
145 foreach ( $this->getPages( $context ) as $titleText => $options ) {
146 if ( $options['type'] !== 'style' ) {
147 continue;
149 $title = Title::newFromText( $titleText );
150 if ( !$title || $title->isRedirect() ) {
151 continue;
153 $media = isset( $options['media'] ) ? $options['media'] : 'all';
154 $style = $this->getContent( $title );
155 if ( strval( $style ) === '' ) {
156 continue;
158 if ( $this->getFlip( $context ) ) {
159 $style = CSSJanus::transform( $style, true, false );
161 $style = CSSMin::remap( $style, false, $wgScriptPath, true );
162 if ( !isset( $styles[$media] ) ) {
163 $styles[$media] = array();
165 if ( strpos( $titleText, '*/' ) === false ) {
166 $style = "/* $titleText */\n" . $style;
168 $styles[$media][] = $style;
170 return $styles;
174 * @param $context ResourceLoaderContext
175 * @return int|mixed
177 public function getModifiedTime( ResourceLoaderContext $context ) {
178 $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
179 $mtimes = $this->getTitleMtimes( $context );
180 if ( count( $mtimes ) ) {
181 $modifiedTime = max( $modifiedTime, max( $mtimes ) );
183 $modifiedTime = max( $modifiedTime, $this->getMsgBlobMtime( $context->getLanguage() ) );
184 return $modifiedTime;
188 * @param $context ResourceLoaderContext
189 * @return bool
191 public function isKnownEmpty( ResourceLoaderContext $context ) {
192 return count( $this->getTitleMtimes( $context ) ) == 0;
196 * Get the modification times of all titles that would be loaded for
197 * a given context.
198 * @param $context ResourceLoaderContext: Context object
199 * @return array( prefixed DB key => UNIX timestamp ), nonexistent titles are dropped
201 protected function getTitleMtimes( ResourceLoaderContext $context ) {
202 $dbr = $this->getDB();
203 if ( !$dbr ) {
204 // We're dealing with a subclass that doesn't have a DB
205 return array();
208 $hash = $context->getHash();
209 if ( isset( $this->titleMtimes[$hash] ) ) {
210 return $this->titleMtimes[$hash];
213 $this->titleMtimes[$hash] = array();
214 $batch = new LinkBatch;
215 foreach ( $this->getPages( $context ) as $titleText => $options ) {
216 $batch->addObj( Title::newFromText( $titleText ) );
219 if ( !$batch->isEmpty() ) {
220 $res = $dbr->select( 'page',
221 array( 'page_namespace', 'page_title', 'page_touched' ),
222 $batch->constructSet( 'page', $dbr ),
223 __METHOD__
225 foreach ( $res as $row ) {
226 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
227 $this->titleMtimes[$hash][$title->getPrefixedDBkey()] =
228 wfTimestamp( TS_UNIX, $row->page_touched );
231 return $this->titleMtimes[$hash];