1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
<?php
/**
* 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
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Trevor Parscal
* @author Roan Kattouw
*/
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* Abstraction for ResourceLoader 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::isUserConfigPage()
* and Title::isSiteConfigPage().
*
* This module supports being used as a placeholder for a module on a remote wiki.
* To do so, getDB() must be overloaded to return a foreign database object that
* allows local wikis to query page metadata.
*
* Safe for calls on local wikis are:
* - Option getters:
* - getGroup()
* - getPages()
* - Basic methods that strictly involve the foreign database
* - getDB()
* - isKnownEmpty()
* - getTitleInfo()
*
* @ingroup ResourceLoader
* @since 1.17
*/
class ResourceLoaderWikiModule extends ResourceLoaderModule {
// Origin defaults to users with sitewide authority
protected $origin = self::ORIGIN_USER_SITEWIDE;
// In-process cache for title info, structured as an array
// [
// <batchKey> // Pipe-separated list of sorted keys from getPages
// => [
// <titleKey> => [ // Normalised title key
// 'page_len' => ..,
// 'page_latest' => ..,
// 'page_touched' => ..,
// ]
// ]
// ]
// @see self::fetchTitleInfo()
// @see self::makeTitleKey()
protected $titleInfo = [];
// List of page names that contain CSS
protected $styles = [];
// List of page names that contain JavaScript
protected $scripts = [];
// Group of module
protected $group;
/**
* @param array|null $options For back-compat, this can be omitted in favour of overwriting
* getPages.
*/
public function __construct( array $options = null ) {
if ( $options === null ) {
return;
}
foreach ( $options as $member => $option ) {
switch ( $member ) {
case 'styles':
case 'scripts':
case 'group':
case 'targets':
$this->{$member} = $option;
break;
}
}
}
/**
* Subclasses should return an associative array of resources in the module.
* Keys should be the title of a page in the MediaWiki or User namespace.
*
* Values should be a nested array of options. The supported keys are 'type' and
* (CSS only) 'media'.
*
* For scripts, 'type' should be 'script'.
*
* For stylesheets, 'type' should be 'style'.
* There is an optional media key, the value of which can be the
* medium ('screen', 'print', etc.) of the stylesheet.
*
* @param ResourceLoaderContext $context
* @return array[]
* @phan-return array<string,array{type:string,media?:string}>
*/
protected function getPages( ResourceLoaderContext $context ) {
$config = $this->getConfig();
$pages = [];
// Filter out pages from origins not allowed by the current wiki configuration.
if ( $config->get( 'UseSiteJs' ) ) {
foreach ( $this->scripts as $script ) {
$pages[$script] = [ 'type' => 'script' ];
}
}
if ( $config->get( 'UseSiteCss' ) ) {
foreach ( $this->styles as $style ) {
$pages[$style] = [ 'type' => 'style' ];
}
}
return $pages;
}
/**
* Get group name
*
* @return string
*/
public function getGroup() {
return $this->group;
}
/**
* Get the Database handle used for computing the module version.
*
* Subclasses may override this to return a foreign database, which would
* allow them to register a module on wiki A that fetches wiki pages from
* wiki B.
*
* The way this works is that the local module is a placeholder that can
* only computer a module version hash. The 'source' of the module must
* be set to the foreign wiki directly. Methods getScript() and getContent()
* will not use this handle and are not valid on the local wiki.
*
* @return IDatabase
*/
protected function getDB() {
return wfGetDB( DB_REPLICA );
}
/**
* @param string $titleText
* @param ResourceLoaderContext $context
* @return null|string
* @since 1.32 added the $context parameter
*/
protected function getContent( $titleText, ResourceLoaderContext $context ) {
$title = Title::newFromText( $titleText );
if ( !$title ) {
return null; // Bad title
}
$content = $this->getContentObj( $title, $context );
if ( !$content ) {
return null; // No content found
}
$handler = $content->getContentHandler();
if ( $handler->isSupportedFormat( CONTENT_FORMAT_CSS ) ) {
$format = CONTENT_FORMAT_CSS;
} elseif ( $handler->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) {
$format = CONTENT_FORMAT_JAVASCRIPT;
} else {
return null; // Bad content model
}
return $content->serialize( $format );
}
/**
* @param Title $title
* @param ResourceLoaderContext $context
* @param int|null $maxRedirects Maximum number of redirects to follow. If
* null, uses $wgMaxRedirects
* @return Content|null
* @since 1.32 added the $context and $maxRedirects parameters
*/
protected function getContentObj(
Title $title, ResourceLoaderContext $context, $maxRedirects = null
) {
$overrideCallback = $context->getContentOverrideCallback();
$content = $overrideCallback ? call_user_func( $overrideCallback, $title ) : null;
if ( $content ) {
if ( !$content instanceof Content ) {
$this->getLogger()->error(
'Bad content override for "{title}" in ' . __METHOD__,
[ 'title' => $title->getPrefixedText() ]
);
return null;
}
} else {
$revision = MediaWikiServices::getInstance()
->getRevisionLookup()
->getKnownCurrentRevision( $title );
if ( !$revision ) {
return null;
}
$content = $revision->getContent( SlotRecord::MAIN, RevisionRecord::RAW );
if ( !$content ) {
$this->getLogger()->error(
'Failed to load content of JS/CSS page "{title}" in ' . __METHOD__,
[ 'title' => $title->getPrefixedText() ]
);
return null;
}
}
if ( $content->isRedirect() ) {
if ( $maxRedirects === null ) {
$maxRedirects = $this->getConfig()->get( 'MaxRedirects' ) ?: 0;
}
if ( $maxRedirects > 0 ) {
$newTitle = $content->getRedirectTarget();
return $newTitle ? $this->getContentObj( $newTitle, $context, $maxRedirects - 1 ) : null;
}
}
return $content;
}
/**
* @param ResourceLoaderContext $context
* @return bool
*/
public function shouldEmbedModule( ResourceLoaderContext $context ) {
$overrideCallback = $context->getContentOverrideCallback();
if ( $overrideCallback && $this->getSource() === 'local' ) {
foreach ( $this->getPages( $context ) as $page => $info ) {
$title = Title::newFromText( $page );
if ( $title && call_user_func( $overrideCallback, $title ) !== null ) {
return true;
}
}
}
return parent::shouldEmbedModule( $context );
}
/**
* @param ResourceLoaderContext $context
* @return string JavaScript code
*/
public function getScript( ResourceLoaderContext $context ) {
$scripts = '';
foreach ( $this->getPages( $context ) as $titleText => $options ) {
if ( $options['type'] !== 'script' ) {
continue;
}
$script = $this->getContent( $titleText, $context );
if ( strval( $script ) !== '' ) {
$script = $this->validateScriptFile( $titleText, $script );
$scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n";
}
}
return $scripts;
}
/**
* @param ResourceLoaderContext $context
* @return array
*/
public function getStyles( ResourceLoaderContext $context ) {
$styles = [];
foreach ( $this->getPages( $context ) as $titleText => $options ) {
if ( $options['type'] !== 'style' ) {
continue;
}
$media = $options['media'] ?? 'all';
$style = $this->getContent( $titleText, $context );
if ( strval( $style ) === '' ) {
continue;
}
if ( $this->getFlip( $context ) ) {
$style = CSSJanus::transform( $style, true, false );
}
$style = MemoizedCallable::call( 'CSSMin::remap',
[ $style, false, $this->getConfig()->get( 'ScriptPath' ), true ] );
if ( !isset( $styles[$media] ) ) {
$styles[$media] = [];
}
$style = ResourceLoader::makeComment( $titleText ) . $style;
$styles[$media][] = $style;
}
return $styles;
}
/**
* Disable module content versioning.
*
* This class does not support generating content outside of a module
* request due to foreign database support.
*
* See getDefinitionSummary() for meta-data versioning.
*
* @return bool
*/
public function enableModuleContentVersion() {
return false;
}
/**
* @param ResourceLoaderContext $context
* @return array
*/
public function getDefinitionSummary( ResourceLoaderContext $context ) {
$summary = parent::getDefinitionSummary( $context );
$summary[] = [
'pages' => $this->getPages( $context ),
// Includes meta data of current revisions
'titleInfo' => $this->getTitleInfo( $context ),
];
return $summary;
}
/**
* @param ResourceLoaderContext $context
* @return bool
*/
public function isKnownEmpty( ResourceLoaderContext $context ) {
$revisions = $this->getTitleInfo( $context );
// If a module has dependencies it cannot be empty. An empty array will be cast to false
if ( $this->getDependencies() ) {
return false;
}
// For user modules, don't needlessly load if there are no non-empty pages
if ( $this->getGroup() === 'user' ) {
foreach ( $revisions as $revision ) {
if ( $revision['page_len'] > 0 ) {
// At least one non-empty page, module should be loaded
return false;
}
}
return true;
}
// T70488: For other modules (i.e. ones that are called in cached html output) only check
// page existance. This ensures that, if some pages in a module are temporarily blanked,
// we don't end omit the module's script or link tag on some pages.
return count( $revisions ) === 0;
}
private function setTitleInfo( $batchKey, array $titleInfo ) {
$this->titleInfo[$batchKey] = $titleInfo;
}
private static function makeTitleKey( LinkTarget $title ) {
// Used for keys in titleInfo.
return "{$title->getNamespace()}:{$title->getDBkey()}";
}
/**
* Get the information about the wiki pages for a given context.
* @param ResourceLoaderContext $context
* @return array[] Keyed by page name
*/
protected function getTitleInfo( ResourceLoaderContext $context ) {
$dbr = $this->getDB();
$pageNames = array_keys( $this->getPages( $context ) );
sort( $pageNames );
$batchKey = implode( '|', $pageNames );
if ( !isset( $this->titleInfo[$batchKey] ) ) {
$this->titleInfo[$batchKey] = static::fetchTitleInfo( $dbr, $pageNames, __METHOD__ );
}
$titleInfo = $this->titleInfo[$batchKey];
// Override the title info from the overrides, if any
$overrideCallback = $context->getContentOverrideCallback();
if ( $overrideCallback ) {
foreach ( $pageNames as $page ) {
$title = Title::newFromText( $page );
$content = $title ? call_user_func( $overrideCallback, $title ) : null;
if ( $content !== null ) {
$titleInfo[$title->getPrefixedText()] = [
'page_len' => $content->getSize(),
'page_latest' => 'TBD', // None available
'page_touched' => ConvertibleTimestamp::now( TS_MW ),
];
}
}
}
return $titleInfo;
}
/**
* @param IDatabase $db
* @param array $pages
* @param string $fname
* @return array
*/
protected static function fetchTitleInfo( IDatabase $db, array $pages, $fname = __METHOD__ ) {
$titleInfo = [];
$batch = new LinkBatch;
foreach ( $pages as $titleText ) {
$title = Title::newFromText( $titleText );
if ( $title ) {
// Page name may be invalid if user-provided (e.g. gadgets)
$batch->addObj( $title );
}
}
if ( !$batch->isEmpty() ) {
$res = $db->select( 'page',
// Include page_touched to allow purging if cache is poisoned (T117587, T113916)
[ 'page_namespace', 'page_title', 'page_touched', 'page_len', 'page_latest' ],
$batch->constructSet( 'page', $db ),
$fname
);
foreach ( $res as $row ) {
// Avoid including ids or timestamps of revision/page tables so
// that versions are not wasted
$title = new TitleValue( (int)$row->page_namespace, $row->page_title );
$titleInfo[self::makeTitleKey( $title )] = [
'page_len' => $row->page_len,
'page_latest' => $row->page_latest,
'page_touched' => $row->page_touched,
];
}
}
return $titleInfo;
}
/**
* @since 1.28
* @param ResourceLoaderContext $context
* @param IDatabase $db
* @param string[] $moduleNames
*/
public static function preloadTitleInfo(
ResourceLoaderContext $context, IDatabase $db, array $moduleNames
) {
$rl = $context->getResourceLoader();
// getDB() can be overridden to point to a foreign database.
// For now, only preload local. In the future, we could preload by wikiID.
$allPages = [];
/** @var ResourceLoaderWikiModule[] $wikiModules */
$wikiModules = [];
foreach ( $moduleNames as $name ) {
$module = $rl->getModule( $name );
if ( $module instanceof self ) {
$mDB = $module->getDB();
// Subclasses may implement getDB differently
if ( $mDB->getDomainID() === $db->getDomainID() ) {
$wikiModules[] = $module;
$allPages += $module->getPages( $context );
}
}
}
if ( !$wikiModules ) {
// Nothing to preload
return;
}
$pageNames = array_keys( $allPages );
sort( $pageNames );
$hash = sha1( implode( '|', $pageNames ) );
// Avoid Zend bug where "static::" does not apply LSB in the closure
$func = [ static::class, 'fetchTitleInfo' ];
$fname = __METHOD__;
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$allInfo = $cache->getWithSetCallback(
$cache->makeGlobalKey( 'resourceloader-titleinfo', $db->getDomainID(), $hash ),
$cache::TTL_HOUR,
function ( $curVal, &$ttl, array &$setOpts ) use ( $func, $pageNames, $db, $fname ) {
$setOpts += Database::getCacheSetOptions( $db );
return call_user_func( $func, $db, $pageNames, $fname );
},
[
'checkKeys' => [
$cache->makeGlobalKey( 'resourceloader-titleinfo', $db->getDomainID() ) ]
]
);
foreach ( $wikiModules as $wikiModule ) {
$pages = $wikiModule->getPages( $context );
// Before we intersect, map the names to canonical form (T145673).
$intersect = [];
foreach ( $pages as $pageName => $unused ) {
$title = Title::newFromText( $pageName );
if ( $title ) {
$intersect[ self::makeTitleKey( $title ) ] = 1;
} else {
// Page name may be invalid if user-provided (e.g. gadgets)
$rl->getLogger()->info(
'Invalid wiki page title "{title}" in ' . __METHOD__,
[ 'title' => $pageName ]
);
}
}
$info = array_intersect_key( $allInfo, $intersect );
$pageNames = array_keys( $pages );
sort( $pageNames );
$batchKey = implode( '|', $pageNames );
$wikiModule->setTitleInfo( $batchKey, $info );
}
}
/**
* Clear the preloadTitleInfo() cache for all wiki modules on this wiki on
* page change if it was a JS or CSS page
*
* @internal
* @param Title $title
* @param RevisionRecord|null $old Prior page revision
* @param RevisionRecord|null $new New page revision
* @param string $domain Database domain ID
*/
public static function invalidateModuleCache(
Title $title,
?RevisionRecord $old,
?RevisionRecord $new,
$domain
) {
static $models = [ CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT ];
Assert::parameterType( 'string', $domain, '$domain' );
$purge = false;
// TODO: MCR: differentiate between page functionality and content model!
// Not all pages containing CSS or JS have to be modules! [PageType]
if ( $old ) {
$oldModel = $old->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel();
if ( in_array( $oldModel, $models ) ) {
$purge = true;
}
}
if ( !$purge && $new ) {
$newModel = $new->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getModel();
if ( in_array( $newModel, $models ) ) {
$purge = true;
}
}
if ( !$purge ) {
$purge = ( $title->isSiteConfigPage() || $title->isUserConfigPage() );
}
if ( $purge ) {
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$key = $cache->makeGlobalKey( 'resourceloader-titleinfo', $domain );
$cache->touchCheckKey( $key );
}
}
/**
* @since 1.28
* @return string
*/
public function getType() {
// Check both because subclasses don't always pass pages via the constructor,
// they may also override getPages() instead, in which case we should keep
// defaulting to LOAD_GENERAL and allow them to override getType() separately.
return ( $this->styles && !$this->scripts ) ? self::LOAD_STYLES : self::LOAD_GENERAL;
}
}
|