MediaWiki  REL1_31
OutputPageTest.php
Go to the documentation of this file.
1 <?php
2 
3 use Wikimedia\TestingAccessWrapper;
4 
15  const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
16  const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
17 
23  public function testMetaTags() {
24  $outputPage = $this->newInstance();
25  $outputPage->addMeta( 'http:expires', '0' );
26  $outputPage->addMeta( 'keywords', 'first' );
27  $outputPage->addMeta( 'keywords', 'second' );
28  $outputPage->addMeta( 'og:title', 'Ta-duh' );
29 
30  $expected = [
31  [ 'http:expires', '0' ],
32  [ 'keywords', 'first' ],
33  [ 'keywords', 'second' ],
34  [ 'og:title', 'Ta-duh' ],
35  ];
36  $this->assertSame( $expected, $outputPage->getMetaTags() );
37 
38  $links = $outputPage->getHeadLinksArray();
39  $this->assertContains( '<meta http-equiv="expires" content="0"/>', $links );
40  $this->assertContains( '<meta name="keywords" content="first"/>', $links );
41  $this->assertContains( '<meta name="keywords" content="second"/>', $links );
42  $this->assertContains( '<meta property="og:title" content="Ta-duh"/>', $links );
43  $this->assertArrayNotHasKey( 'meta-robots', $links );
44  }
45 
51  public function testRobotsPolicies() {
52  $outputPage = $this->newInstance();
53  $outputPage->setIndexPolicy( 'noindex' );
54  $outputPage->setFollowPolicy( 'nofollow' );
55 
56  $links = $outputPage->getHeadLinksArray();
57  $this->assertContains( '<meta name="robots" content="noindex,nofollow"/>', $links );
58  }
59 
74  protected function assertTransformCssMediaCase( $args ) {
75  $queryData = [];
76  if ( isset( $args['printableQuery'] ) ) {
77  $queryData['printable'] = $args['printableQuery'];
78  }
79 
80  if ( isset( $args['handheldQuery'] ) ) {
81  $queryData['handheld'] = $args['handheldQuery'];
82  }
83 
84  $fauxRequest = new FauxRequest( $queryData, false );
85  $this->setMwGlobals( [
86  'wgRequest' => $fauxRequest,
87  ] );
88 
89  $actualReturn = OutputPage::transformCssMedia( $args['media'] );
90  $this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
91  }
92 
97  public function testPrintRequests() {
99  'printableQuery' => '1',
100  'media' => 'screen',
101  'expectedReturn' => null,
102  'message' => 'On printable request, screen returns null'
103  ] );
104 
106  'printableQuery' => '1',
107  'media' => self::SCREEN_MEDIA_QUERY,
108  'expectedReturn' => null,
109  'message' => 'On printable request, screen media query returns null'
110  ] );
111 
113  'printableQuery' => '1',
114  'media' => self::SCREEN_ONLY_MEDIA_QUERY,
115  'expectedReturn' => null,
116  'message' => 'On printable request, screen media query with only returns null'
117  ] );
118 
120  'printableQuery' => '1',
121  'media' => 'print',
122  'expectedReturn' => '',
123  'message' => 'On printable request, media print returns empty string'
124  ] );
125  }
126 
131  public function testScreenRequests() {
133  'media' => 'screen',
134  'expectedReturn' => 'screen',
135  'message' => 'On screen request, screen media type is preserved'
136  ] );
137 
139  'media' => 'handheld',
140  'expectedReturn' => 'handheld',
141  'message' => 'On screen request, handheld media type is preserved'
142  ] );
143 
145  'media' => self::SCREEN_MEDIA_QUERY,
146  'expectedReturn' => self::SCREEN_MEDIA_QUERY,
147  'message' => 'On screen request, screen media query is preserved.'
148  ] );
149 
151  'media' => self::SCREEN_ONLY_MEDIA_QUERY,
152  'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
153  'message' => 'On screen request, screen media query with only is preserved.'
154  ] );
155 
157  'media' => 'print',
158  'expectedReturn' => 'print',
159  'message' => 'On screen request, print media type is preserved'
160  ] );
161  }
162 
167  public function testHandheld() {
169  'handheldQuery' => '1',
170  'media' => 'handheld',
171  'expectedReturn' => '',
172  'message' => 'On request with handheld querystring and media is handheld, returns empty string'
173  ] );
174 
176  'handheldQuery' => '1',
177  'media' => 'screen',
178  'expectedReturn' => null,
179  'message' => 'On request with handheld querystring and media is screen, returns null'
180  ] );
181  }
182 
183  public static function provideTransformFilePath() {
184  $baseDir = dirname( __DIR__ ) . '/data/media';
185  return [
186  // File that matches basePath, and exists. Hash found and appended.
187  [
188  'baseDir' => $baseDir, 'basePath' => '/w',
189  '/w/test.jpg',
190  '/w/test.jpg?edcf2'
191  ],
192  // File that matches basePath, but not found on disk. Empty query.
193  [
194  'baseDir' => $baseDir, 'basePath' => '/w',
195  '/w/unknown.png',
196  '/w/unknown.png?'
197  ],
198  // File not matching basePath. Ignored.
199  [
200  'baseDir' => $baseDir, 'basePath' => '/w',
201  '/files/test.jpg'
202  ],
203  // Empty string. Ignored.
204  [
205  'baseDir' => $baseDir, 'basePath' => '/w',
206  '',
207  ''
208  ],
209  // Similar path, but with domain component. Ignored.
210  [
211  'baseDir' => $baseDir, 'basePath' => '/w',
212  '//example.org/w/test.jpg'
213  ],
214  [
215  'baseDir' => $baseDir, 'basePath' => '/w',
216  'https://example.org/w/test.jpg'
217  ],
218  // Unrelated path with domain component. Ignored.
219  [
220  'baseDir' => $baseDir, 'basePath' => '/w',
221  'https://example.org/files/test.jpg'
222  ],
223  [
224  'baseDir' => $baseDir, 'basePath' => '/w',
225  '//example.org/files/test.jpg'
226  ],
227  // Unrelated path with domain, and empty base path (root mw install). Ignored.
228  [
229  'baseDir' => $baseDir, 'basePath' => '',
230  'https://example.org/files/test.jpg'
231  ],
232  [
233  'baseDir' => $baseDir, 'basePath' => '',
234  // T155310
235  '//example.org/files/test.jpg'
236  ],
237  // Check UploadPath before ResourceBasePath (T155146)
238  [
239  'baseDir' => dirname( $baseDir ), 'basePath' => '',
240  'uploadDir' => $baseDir, 'uploadPath' => '/images',
241  '/images/test.jpg',
242  '/images/test.jpg?edcf2'
243  ],
244  ];
245  }
246 
252  public function testTransformResourcePath( $baseDir, $basePath, $uploadDir = null,
253  $uploadPath = null, $path = null, $expected = null
254  ) {
255  if ( $path === null ) {
256  // Skip optional $uploadDir and $uploadPath
257  $path = $uploadDir;
258  $expected = $uploadPath;
259  $uploadDir = "$baseDir/images";
260  $uploadPath = "$basePath/images";
261  }
262  $this->setMwGlobals( 'IP', $baseDir );
263  $conf = new HashConfig( [
264  'ResourceBasePath' => $basePath,
265  'UploadDirectory' => $uploadDir,
266  'UploadPath' => $uploadPath,
267  ] );
268 
269  Wikimedia\suppressWarnings();
270  $actual = OutputPage::transformResourcePath( $conf, $path );
271  Wikimedia\restoreWarnings();
272 
273  $this->assertEquals( $expected ?: $path, $actual );
274  }
275 
276  public static function provideMakeResourceLoaderLink() {
277  // phpcs:disable Generic.Files.LineLength
278  return [
279  // Single only=scripts load
280  [
281  [ 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ],
282  "<script>(window.RLQ=window.RLQ||[]).push(function(){"
283  . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.foo\u0026only=scripts\u0026skin=fallback");'
284  . "});</script>"
285  ],
286  // Multiple only=styles load
287  [
288  [ [ 'test.baz', 'test.foo', 'test.bar' ], ResourceLoaderModule::TYPE_STYLES ],
289 
290  '<link rel="stylesheet" href="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.bar%2Cbaz%2Cfoo&amp;only=styles&amp;skin=fallback"/>'
291  ],
292  // Private embed (only=scripts)
293  [
294  [ 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ],
295  "<script>(window.RLQ=window.RLQ||[]).push(function(){"
296  . "mw.test.baz({token:123});\nmw.loader.state({\"test.quux\":\"ready\"});"
297  . "});</script>"
298  ],
299  ];
300  // phpcs:enable
301  }
302 
309  public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
310  $this->setMwGlobals( [
311  'wgResourceLoaderDebug' => false,
312  'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
313  ] );
314  $class = new ReflectionClass( OutputPage::class );
315  $method = $class->getMethod( 'makeResourceLoaderLink' );
316  $method->setAccessible( true );
317  $ctx = new RequestContext();
318  $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
319  $ctx->setLanguage( 'en' );
320  $out = new OutputPage( $ctx );
321  $rl = $out->getResourceLoader();
322  $rl->setMessageBlobStore( new NullMessageBlobStore() );
323  $rl->register( [
324  'test.foo' => new ResourceLoaderTestModule( [
325  'script' => 'mw.test.foo( { a: true } );',
326  'styles' => '.mw-test-foo { content: "style"; }',
327  ] ),
328  'test.bar' => new ResourceLoaderTestModule( [
329  'script' => 'mw.test.bar( { a: true } );',
330  'styles' => '.mw-test-bar { content: "style"; }',
331  ] ),
332  'test.baz' => new ResourceLoaderTestModule( [
333  'script' => 'mw.test.baz( { a: true } );',
334  'styles' => '.mw-test-baz { content: "style"; }',
335  ] ),
336  'test.quux' => new ResourceLoaderTestModule( [
337  'script' => 'mw.test.baz( { token: 123 } );',
338  'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
339  'group' => 'private',
340  ] ),
341  ] );
342  $links = $method->invokeArgs( $out, $args );
343  $actualHtml = strval( $links );
344  $this->assertEquals( $expectedHtml, $actualHtml );
345  }
346 
347  public static function provideBuildExemptModules() {
348  // phpcs:disable Generic.Files.LineLength
349  return [
350  'empty' => [
351  'exemptStyleModules' => [],
352  '<meta name="ResourceLoaderDynamicStyles" content=""/>',
353  ],
354  'empty sets' => [
355  'exemptStyleModules' => [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ],
356  '<meta name="ResourceLoaderDynamicStyles" content=""/>',
357  ],
358  'default logged-out' => [
359  'exemptStyleModules' => [ 'site' => [ 'site.styles' ] ],
360  '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
361  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>',
362  ],
363  'default logged-in' => [
364  'exemptStyleModules' => [ 'site' => [ 'site.styles' ], 'user' => [ 'user.styles' ] ],
365  '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
366  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>' . "\n" .
367  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=user.styles&amp;only=styles&amp;skin=fallback&amp;version=1e9z0ox"/>',
368  ],
369  'custom modules' => [
370  'exemptStyleModules' => [
371  'site' => [ 'site.styles', 'example.site.a', 'example.site.b' ],
372  'user' => [ 'user.styles', 'example.user' ],
373  ],
374  '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
375  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=example.site.a%2Cb&amp;only=styles&amp;skin=fallback"/>' . "\n" .
376  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>' . "\n" .
377  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=example.user&amp;only=styles&amp;skin=fallback&amp;version=0a56zyi"/>' . "\n" .
378  '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=user.styles&amp;only=styles&amp;skin=fallback&amp;version=1e9z0ox"/>',
379  ],
380  ];
381  // phpcs:enable
382  }
383 
388  public function testBuildExemptModules( array $exemptStyleModules, $expect ) {
389  $this->setMwGlobals( [
390  'wgResourceLoaderDebug' => false,
391  'wgLoadScript' => '/w/load.php',
392  // Stub wgCacheEpoch as it influences getVersionHash used for the
393  // urls in the expected HTML
394  'wgCacheEpoch' => '20140101000000',
395  ] );
396 
397  // Set up stubs
398  $ctx = new RequestContext();
399  $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
400  $ctx->setLanguage( 'en' );
401  $outputPage = $this->getMockBuilder( OutputPage::class )
402  ->setConstructorArgs( [ $ctx ] )
403  ->setMethods( [ 'isUserCssPreview', 'buildCssLinksArray' ] )
404  ->getMock();
405  $outputPage->expects( $this->any() )
406  ->method( 'isUserCssPreview' )
407  ->willReturn( false );
408  $outputPage->expects( $this->any() )
409  ->method( 'buildCssLinksArray' )
410  ->willReturn( [] );
411  $rl = $outputPage->getResourceLoader();
412  $rl->setMessageBlobStore( new NullMessageBlobStore() );
413 
414  // Register custom modules
415  $rl->register( [
416  'example.site.a' => new ResourceLoaderTestModule( [ 'group' => 'site' ] ),
417  'example.site.b' => new ResourceLoaderTestModule( [ 'group' => 'site' ] ),
418  'example.user' => new ResourceLoaderTestModule( [ 'group' => 'user' ] ),
419  ] );
420 
421  $outputPage = TestingAccessWrapper::newFromObject( $outputPage );
422  $outputPage->rlExemptStyleModules = $exemptStyleModules;
423  $this->assertEquals(
424  $expect,
425  strval( $outputPage->buildExemptModules() )
426  );
427  }
428 
435  public function testVaryHeaders( $calls, $vary, $key ) {
436  // get rid of default Vary fields
437  $outputPage = $this->getMockBuilder( OutputPage::class )
438  ->setConstructorArgs( [ new RequestContext() ] )
439  ->setMethods( [ 'getCacheVaryCookies' ] )
440  ->getMock();
441  $outputPage->expects( $this->any() )
442  ->method( 'getCacheVaryCookies' )
443  ->will( $this->returnValue( [] ) );
444  TestingAccessWrapper::newFromObject( $outputPage )->mVaryHeader = [];
445 
446  foreach ( $calls as $call ) {
447  call_user_func_array( [ $outputPage, 'addVaryHeader' ], $call );
448  }
449  $this->assertEquals( $vary, $outputPage->getVaryHeader(), 'Vary:' );
450  $this->assertEquals( $key, $outputPage->getKeyHeader(), 'Key:' );
451  }
452 
453  public function provideVaryHeaders() {
454  // note: getKeyHeader() automatically adds Vary: Cookie
455  return [
456  [ // single header
457  [
458  [ 'Cookie' ],
459  ],
460  'Vary: Cookie',
461  'Key: Cookie',
462  ],
463  [ // non-unique headers
464  [
465  [ 'Cookie' ],
466  [ 'Accept-Language' ],
467  [ 'Cookie' ],
468  ],
469  'Vary: Cookie, Accept-Language',
470  'Key: Cookie,Accept-Language',
471  ],
472  [ // two headers with single options
473  [
474  [ 'Cookie', [ 'param=phpsessid' ] ],
475  [ 'Accept-Language', [ 'substr=en' ] ],
476  ],
477  'Vary: Cookie, Accept-Language',
478  'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
479  ],
480  [ // one header with multiple options
481  [
482  [ 'Cookie', [ 'param=phpsessid', 'param=userId' ] ],
483  ],
484  'Vary: Cookie',
485  'Key: Cookie;param=phpsessid;param=userId',
486  ],
487  [ // Duplicate option
488  [
489  [ 'Cookie', [ 'param=phpsessid' ] ],
490  [ 'Cookie', [ 'param=phpsessid' ] ],
491  [ 'Accept-Language', [ 'substr=en', 'substr=en' ] ],
492  ],
493  'Vary: Cookie, Accept-Language',
494  'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
495  ],
496  [ // Same header, different options
497  [
498  [ 'Cookie', [ 'param=phpsessid' ] ],
499  [ 'Cookie', [ 'param=userId' ] ],
500  ],
501  'Vary: Cookie',
502  'Key: Cookie;param=phpsessid;param=userId',
503  ],
504  ];
505  }
506 
510  public function testHaveCacheVaryCookies() {
511  $request = new FauxRequest();
512  $context = new RequestContext();
513  $context->setRequest( $request );
514  $outputPage = new OutputPage( $context );
515 
516  // No cookies are set.
517  $this->assertFalse( $outputPage->haveCacheVaryCookies() );
518 
519  // 'Token' is present but empty, so it shouldn't count.
520  $request->setCookie( 'Token', '' );
521  $this->assertFalse( $outputPage->haveCacheVaryCookies() );
522 
523  // 'Token' present and nonempty.
524  $request->setCookie( 'Token', '123' );
525  $this->assertTrue( $outputPage->haveCacheVaryCookies() );
526  }
527 
532  public function testGetCategories() {
533  $fakeResultWrapper = new FakeResultWrapper( [
534  (object)[
535  'pp_value' => 1,
536  'page_title' => 'Test'
537  ],
538  (object)[
539  'page_title' => 'Test2'
540  ]
541  ] );
542  $outputPage = $this->getMockBuilder( OutputPage::class )
543  ->setConstructorArgs( [ new RequestContext() ] )
544  ->setMethods( [ 'addCategoryLinksToLBAndGetResult' ] )
545  ->getMock();
546  $outputPage->expects( $this->any() )
547  ->method( 'addCategoryLinksToLBAndGetResult' )
548  ->will( $this->returnValue( $fakeResultWrapper ) );
549 
550  $outputPage->addCategoryLinks( [
551  'Test' => 'Test',
552  'Test2' => 'Test2',
553  ] );
554  $this->assertEquals( [ 0 => 'Test', '1' => 'Test2' ], $outputPage->getCategories() );
555  $this->assertEquals( [ 0 => 'Test2' ], $outputPage->getCategories( 'normal' ) );
556  $this->assertEquals( [ 0 => 'Test' ], $outputPage->getCategories( 'hidden' ) );
557  }
558 
564  public function testLinkHeaders( $headers, $result ) {
565  $outputPage = $this->newInstance();
566 
567  foreach ( $headers as $header ) {
568  $outputPage->addLinkHeader( $header );
569  }
570 
571  $this->assertEquals( $result, $outputPage->getLinkHeader() );
572  }
573 
574  public function provideLinkHeaders() {
575  return [
576  [
577  [],
578  false
579  ],
580  [
581  [ '<https://foo/bar.jpg>;rel=preload;as=image' ],
582  'Link: <https://foo/bar.jpg>;rel=preload;as=image',
583  ],
584  [
585  [ '<https://foo/bar.jpg>;rel=preload;as=image','<https://foo/baz.jpg>;rel=preload;as=image' ],
586  'Link: <https://foo/bar.jpg>;rel=preload;as=image,<https://foo/baz.jpg>;rel=preload;as=image',
587  ],
588  ];
589  }
590 
596  public function testPreloadLinkHeaders( $config, $result, $baseDir = null ) {
597  if ( $baseDir ) {
598  $this->setMwGlobals( 'IP', $baseDir );
599  }
600  $out = TestingAccessWrapper::newFromObject( $this->newInstance( $config ) );
601  $out->addLogoPreloadLinkHeaders();
602 
603  $this->assertEquals( $result, $out->getLinkHeader() );
604  }
605 
606  public function providePreloadLinkHeaders() {
607  return [
608  [
609  [
610  'ResourceBasePath' => '/w',
611  'Logo' => '/img/default.png',
612  'LogoHD' => [
613  '1.5x' => '/img/one-point-five.png',
614  '2x' => '/img/two-x.png',
615  ],
616  ],
617  'Link: </img/default.png>;rel=preload;as=image;media=' .
618  'not all and (min-resolution: 1.5dppx),' .
619  '</img/one-point-five.png>;rel=preload;as=image;media=' .
620  '(min-resolution: 1.5dppx) and (max-resolution: 1.999999dppx),' .
621  '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
622  ],
623  [
624  [
625  'ResourceBasePath' => '/w',
626  'Logo' => '/img/default.png',
627  'LogoHD' => false,
628  ],
629  'Link: </img/default.png>;rel=preload;as=image'
630  ],
631  [
632  [
633  'ResourceBasePath' => '/w',
634  'Logo' => '/img/default.png',
635  'LogoHD' => [
636  '2x' => '/img/two-x.png',
637  ],
638  ],
639  'Link: </img/default.png>;rel=preload;as=image;media=' .
640  'not all and (min-resolution: 2dppx),' .
641  '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
642  ],
643  [
644  [
645  'ResourceBasePath' => '/w',
646  'Logo' => '/img/default.png',
647  'LogoHD' => [
648  'svg' => '/img/vector.svg',
649  ],
650  ],
651  'Link: </img/vector.svg>;rel=preload;as=image'
652 
653  ],
654  [
655  [
656  'ResourceBasePath' => '/w',
657  'Logo' => '/w/test.jpg',
658  'LogoHD' => false,
659  'UploadPath' => '/w/images',
660  ],
661  'Link: </w/test.jpg?edcf2>;rel=preload;as=image',
662  'baseDir' => dirname( __DIR__ ) . '/data/media',
663  ],
664  ];
665  }
666 
670  private function newInstance( $config = [] ) {
671  $context = new RequestContext();
672 
673  $context->setConfig( new HashConfig( $config + [
674  'AppleTouchIcon' => false,
675  'DisableLangConversion' => true,
676  'EnableAPI' => false,
677  'EnableCanonicalServerLink' => false,
678  'Favicon' => false,
679  'Feed' => false,
680  'LanguageCode' => false,
681  'ReferrerPolicy' => false,
682  'RightsPage' => false,
683  'RightsUrl' => false,
684  'UniversalEditButton' => false,
685  ] ) );
686 
687  return new OutputPage( $context );
688  }
689 }
690 
695  public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
696  return [];
697  }
698 
699  public function updateModule( $name, ResourceLoaderModule $module, $lang ) {
700  }
701 
702  public function updateMessage( $key ) {
703  }
704 
705  public function clear() {
706  }
707 }
OutputPageTest
Definition: OutputPageTest.php:14
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
NullMessageBlobStore\updateModule
updateModule( $name, ResourceLoaderModule $module, $lang)
Definition: OutputPageTest.php:699
OutputPageTest\provideBuildExemptModules
static provideBuildExemptModules()
Definition: OutputPageTest.php:347
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
HashConfig
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
OutputPageTest\providePreloadLinkHeaders
providePreloadLinkHeaders()
Definition: OutputPageTest.php:606
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
NullMessageBlobStore
MessageBlobStore that doesn't do anything.
Definition: OutputPageTest.php:694
NullMessageBlobStore\updateMessage
updateMessage( $key)
Invalidate cache keys for modules using this message key.
Definition: OutputPageTest.php:702
OutputPageTest\testVaryHeaders
testVaryHeaders( $calls, $vary, $key)
provideVaryHeaders OutputPage::addVaryHeader OutputPage::getVaryHeader OutputPage::getKeyHeader
Definition: OutputPageTest.php:435
$resourceLoader
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2818
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
OutputPage\transformCssMedia
static transformCssMedia( $media)
Transform "media" attribute based on request parameters.
Definition: OutputPage.php:3757
OutputPageTest\testBuildExemptModules
testBuildExemptModules(array $exemptStyleModules, $expect)
provideBuildExemptModules OutputPage::buildExemptModules
Definition: OutputPageTest.php:388
OutputPageTest\testPreloadLinkHeaders
testPreloadLinkHeaders( $config, $result, $baseDir=null)
providePreloadLinkHeaders OutputPage::addLogoPreloadLinkHeaders ResourceLoaderSkinModule::getLogo
Definition: OutputPageTest.php:596
OutputPageTest\testScreenRequests
testScreenRequests()
Tests screen requests, without either query parameter set OutputPage::transformCssMedia.
Definition: OutputPageTest.php:131
OutputPageTest\provideLinkHeaders
provideLinkHeaders()
Definition: OutputPageTest.php:574
OutputPageTest\newInstance
newInstance( $config=[])
Definition: OutputPageTest.php:670
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
MediaWikiTestCase
Definition: MediaWikiTestCase.php:17
OutputPageTest\testLinkHeaders
testLinkHeaders( $headers, $result)
provideLinkHeaders OutputPage::addLinkHeader OutputPage::getLinkHeader
Definition: OutputPageTest.php:564
$modules
$modules
Definition: HTMLFormElement.php:12
ResourceLoaderModule\TYPE_SCRIPTS
const TYPE_SCRIPTS
Definition: ResourceLoaderModule.php:37
OutputPageTest\SCREEN_MEDIA_QUERY
const SCREEN_MEDIA_QUERY
Definition: OutputPageTest.php:15
OutputPageTest\testRobotsPolicies
testRobotsPolicies()
OutputPage::setIndexPolicy OutputPage::setFollowPolicy OutputPage::getHeadLinksArray.
Definition: OutputPageTest.php:51
OutputPageTest\provideMakeResourceLoaderLink
static provideMakeResourceLoaderLink()
Definition: OutputPageTest.php:276
OutputPageTest\assertTransformCssMediaCase
assertTransformCssMediaCase( $args)
Tests a particular case of transformCssMedia, using the given input, globals, expected return,...
Definition: OutputPageTest.php:74
RequestContext
Group all the pieces relevant to the context of a request into one instance.
Definition: RequestContext.php:32
ResourceLoaderTestModule
Definition: ResourceLoaderTestCase.php:84
OutputPage
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:45
OutputPageTest\testGetCategories
testGetCategories()
OutputPage::addCategoryLinks OutputPage::getCategories.
Definition: OutputPageTest.php:532
OutputPageTest\testPrintRequests
testPrintRequests()
Tests print requests OutputPage::transformCssMedia.
Definition: OutputPageTest.php:97
OutputPageTest\SCREEN_ONLY_MEDIA_QUERY
const SCREEN_ONLY_MEDIA_QUERY
Definition: OutputPageTest.php:16
$header
$header
Definition: updateCredits.php:35
OutputPageTest\testMetaTags
testMetaTags()
OutputPage::addMeta OutputPage::getMetaTags OutputPage::getHeadLinksArray.
Definition: OutputPageTest.php:23
OutputPageTest\testMakeResourceLoaderLink
testMakeResourceLoaderLink( $args, $expectedHtml)
See ResourceLoaderClientHtmlTest for full coverage.
Definition: OutputPageTest.php:309
$args
if( $line===false) $args
Definition: cdb.php:64
OutputPageTest\testHaveCacheVaryCookies
testHaveCacheVaryCookies()
OutputPage::haveCacheVaryCookies.
Definition: OutputPageTest.php:510
OutputPageTest\testTransformResourcePath
testTransformResourcePath( $baseDir, $basePath, $uploadDir=null, $uploadPath=null, $path=null, $expected=null)
provideTransformFilePath OutputPage::transformFilePath OutputPage::transformResourcePath
Definition: OutputPageTest.php:252
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ResourceLoaderModule
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
Definition: ResourceLoaderModule.php:35
ResourceLoader
Dynamic JavaScript and CSS resource loading system.
Definition: ResourceLoader.php:38
$path
$path
Definition: NoLocalSettings.php:25
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
MessageBlobStore
This class generates message blobs for use by ResourceLoader modules.
Definition: MessageBlobStore.php:37
NullMessageBlobStore\clear
clear()
Invalidate cache keys for all known modules.
Definition: OutputPageTest.php:705
$basePath
$basePath
Definition: addSite.php:5
ResourceLoaderModule\TYPE_STYLES
const TYPE_STYLES
Definition: ResourceLoaderModule.php:38
OutputPageTest\provideVaryHeaders
provideVaryHeaders()
Definition: OutputPageTest.php:453
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
OutputPageTest\testHandheld
testHandheld()
Tests handheld behavior OutputPage::transformCssMedia.
Definition: OutputPageTest.php:167
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
SkinFactory\getDefaultInstance
static getDefaultInstance()
Definition: SkinFactory.php:50
OutputPageTest\provideTransformFilePath
static provideTransformFilePath()
Definition: OutputPageTest.php:183
OutputPage\transformResourcePath
static transformResourcePath(Config $config, $path)
Transform path to web-accessible static resource.
Definition: OutputPage.php:3699