ee4d5c6eed
tl;dr: Having unnessary complexity in security critical code is bad.
* Extra options add extra complexity and maintenance burden
** Thus we should only have one html output mode. well formed = false
was already vetoed in T52040, so lets go with WellFormed=true.
* Options which are used by very few people tend to get tested less
* Escaping is an area of code where we should be very conservative
* Having escaping rules depend on making assumptions about which
characters various browsers consider "whitespace" is scary
* $wgWellFormedXml=false has had a negative security impact in the
past (Usually not directly its fault, but has made other bugs
more exploitable)
* Saving a couple bytes (even less bytes after gzip taken into
account) is really not worth it in this context (imho).
Change-Id: I5c922e0980d3f9eb39adb5bb5833e158afda42ed
383 lines
12 KiB
PHP
383 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
*
|
|
* @author Matthew Flaschen
|
|
*
|
|
* @group Output
|
|
*
|
|
* @todo factor tests in this class into providers and test methods
|
|
*
|
|
*/
|
|
class OutputPageTest extends MediaWikiTestCase {
|
|
const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
|
|
const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
|
|
|
|
/**
|
|
* Tests a particular case of transformCssMedia, using the given input, globals,
|
|
* expected return, and message
|
|
*
|
|
* Asserts that $expectedReturn is returned.
|
|
*
|
|
* options['printableQuery'] - value of query string for printable, or omitted for none
|
|
* options['handheldQuery'] - value of query string for handheld, or omitted for none
|
|
* options['media'] - passed into the method under the same name
|
|
* options['expectedReturn'] - expected return value
|
|
* options['message'] - PHPUnit message for assertion
|
|
*
|
|
* @param array $args Key-value array of arguments as shown above
|
|
*/
|
|
protected function assertTransformCssMediaCase( $args ) {
|
|
$queryData = [];
|
|
if ( isset( $args['printableQuery'] ) ) {
|
|
$queryData['printable'] = $args['printableQuery'];
|
|
}
|
|
|
|
if ( isset( $args['handheldQuery'] ) ) {
|
|
$queryData['handheld'] = $args['handheldQuery'];
|
|
}
|
|
|
|
$fauxRequest = new FauxRequest( $queryData, false );
|
|
$this->setMwGlobals( [
|
|
'wgRequest' => $fauxRequest,
|
|
] );
|
|
|
|
$actualReturn = OutputPage::transformCssMedia( $args['media'] );
|
|
$this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
|
|
}
|
|
|
|
/**
|
|
* Tests print requests
|
|
* @covers OutputPage::transformCssMedia
|
|
*/
|
|
public function testPrintRequests() {
|
|
$this->assertTransformCssMediaCase( [
|
|
'printableQuery' => '1',
|
|
'media' => 'screen',
|
|
'expectedReturn' => null,
|
|
'message' => 'On printable request, screen returns null'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'printableQuery' => '1',
|
|
'media' => self::SCREEN_MEDIA_QUERY,
|
|
'expectedReturn' => null,
|
|
'message' => 'On printable request, screen media query returns null'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'printableQuery' => '1',
|
|
'media' => self::SCREEN_ONLY_MEDIA_QUERY,
|
|
'expectedReturn' => null,
|
|
'message' => 'On printable request, screen media query with only returns null'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'printableQuery' => '1',
|
|
'media' => 'print',
|
|
'expectedReturn' => '',
|
|
'message' => 'On printable request, media print returns empty string'
|
|
] );
|
|
}
|
|
|
|
/**
|
|
* Tests screen requests, without either query parameter set
|
|
* @covers OutputPage::transformCssMedia
|
|
*/
|
|
public function testScreenRequests() {
|
|
$this->assertTransformCssMediaCase( [
|
|
'media' => 'screen',
|
|
'expectedReturn' => 'screen',
|
|
'message' => 'On screen request, screen media type is preserved'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'media' => 'handheld',
|
|
'expectedReturn' => 'handheld',
|
|
'message' => 'On screen request, handheld media type is preserved'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'media' => self::SCREEN_MEDIA_QUERY,
|
|
'expectedReturn' => self::SCREEN_MEDIA_QUERY,
|
|
'message' => 'On screen request, screen media query is preserved.'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'media' => self::SCREEN_ONLY_MEDIA_QUERY,
|
|
'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
|
|
'message' => 'On screen request, screen media query with only is preserved.'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'media' => 'print',
|
|
'expectedReturn' => 'print',
|
|
'message' => 'On screen request, print media type is preserved'
|
|
] );
|
|
}
|
|
|
|
/**
|
|
* Tests handheld behavior
|
|
* @covers OutputPage::transformCssMedia
|
|
*/
|
|
public function testHandheld() {
|
|
$this->assertTransformCssMediaCase( [
|
|
'handheldQuery' => '1',
|
|
'media' => 'handheld',
|
|
'expectedReturn' => '',
|
|
'message' => 'On request with handheld querystring and media is handheld, returns empty string'
|
|
] );
|
|
|
|
$this->assertTransformCssMediaCase( [
|
|
'handheldQuery' => '1',
|
|
'media' => 'screen',
|
|
'expectedReturn' => null,
|
|
'message' => 'On request with handheld querystring and media is screen, returns null'
|
|
] );
|
|
}
|
|
|
|
public static function provideMakeResourceLoaderLink() {
|
|
// @codingStandardsIgnoreStart Generic.Files.LineLength
|
|
return [
|
|
// Load module script only
|
|
[
|
|
[ 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ],
|
|
"<script>(window.RLQ=window.RLQ||[]).push(function(){"
|
|
. 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.foo\u0026only=scripts\u0026skin=fallback");'
|
|
. "});</script>"
|
|
],
|
|
[
|
|
// Don't condition wrap raw modules (like the startup module)
|
|
[ 'test.raw', ResourceLoaderModule::TYPE_SCRIPTS ],
|
|
'<script async="" src="http://127.0.0.1:8080/w/load.php?debug=false&lang=en&modules=test.raw&only=scripts&skin=fallback"></script>'
|
|
],
|
|
// Load module styles only
|
|
// This also tests the order the modules are put into the url
|
|
[
|
|
[ [ 'test.baz', 'test.foo', 'test.bar' ], ResourceLoaderModule::TYPE_STYLES ],
|
|
|
|
'<link rel="stylesheet" href="http://127.0.0.1:8080/w/load.php?debug=false&lang=en&modules=test.bar%2Cbaz%2Cfoo&only=styles&skin=fallback"/>'
|
|
],
|
|
// Load private module (only=scripts)
|
|
[
|
|
[ 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ],
|
|
"<script>(window.RLQ=window.RLQ||[]).push(function(){"
|
|
. "mw.test.baz({token:123});mw.loader.state({\"test.quux\":\"ready\"});"
|
|
. "});</script>"
|
|
],
|
|
// Load private module (combined)
|
|
[
|
|
[ 'test.quux', ResourceLoaderModule::TYPE_COMBINED ],
|
|
"<script>(window.RLQ=window.RLQ||[]).push(function(){"
|
|
. "mw.loader.implement(\"test.quux\",function($,jQuery,require,module){"
|
|
. "mw.test.baz({token:123});},{\"css\":[\".mw-icon{transition:none}"
|
|
. "\"]});});</script>"
|
|
],
|
|
// Load no modules
|
|
[
|
|
[ [], ResourceLoaderModule::TYPE_COMBINED ],
|
|
'',
|
|
],
|
|
// noscript group
|
|
[
|
|
[ 'test.noscript', ResourceLoaderModule::TYPE_STYLES ],
|
|
'<noscript><link rel="stylesheet" href="http://127.0.0.1:8080/w/load.php?debug=false&lang=en&modules=test.noscript&only=styles&skin=fallback"/></noscript>'
|
|
],
|
|
// Load two modules in separate groups
|
|
[
|
|
[ [ 'test.group.foo', 'test.group.bar' ], ResourceLoaderModule::TYPE_COMBINED ],
|
|
"<script>(window.RLQ=window.RLQ||[]).push(function(){"
|
|
. 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.bar\u0026skin=fallback");'
|
|
. "});</script>\n"
|
|
. "<script>(window.RLQ=window.RLQ||[]).push(function(){"
|
|
. 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.foo\u0026skin=fallback");'
|
|
. "});</script>"
|
|
],
|
|
];
|
|
// @codingStandardsIgnoreEnd
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideMakeResourceLoaderLink
|
|
* @covers OutputPage::makeResourceLoaderLink
|
|
* @covers ResourceLoader::makeLoaderImplementScript
|
|
* @covers ResourceLoader::makeModuleResponse
|
|
* @covers ResourceLoader::makeInlineScript
|
|
* @covers ResourceLoader::makeLoaderStateScript
|
|
* @covers ResourceLoader::createLoaderURL
|
|
*/
|
|
public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
|
|
$this->setMwGlobals( [
|
|
'wgResourceLoaderDebug' => false,
|
|
'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
|
|
] );
|
|
$class = new ReflectionClass( 'OutputPage' );
|
|
$method = $class->getMethod( 'makeResourceLoaderLink' );
|
|
$method->setAccessible( true );
|
|
$ctx = new RequestContext();
|
|
$ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
|
|
$ctx->setLanguage( 'en' );
|
|
$out = new OutputPage( $ctx );
|
|
$rl = $out->getResourceLoader();
|
|
$rl->setMessageBlobStore( new NullMessageBlobStore() );
|
|
$rl->register( [
|
|
'test.foo' => new ResourceLoaderTestModule( [
|
|
'script' => 'mw.test.foo( { a: true } );',
|
|
'styles' => '.mw-test-foo { content: "style"; }',
|
|
] ),
|
|
'test.bar' => new ResourceLoaderTestModule( [
|
|
'script' => 'mw.test.bar( { a: true } );',
|
|
'styles' => '.mw-test-bar { content: "style"; }',
|
|
] ),
|
|
'test.baz' => new ResourceLoaderTestModule( [
|
|
'script' => 'mw.test.baz( { a: true } );',
|
|
'styles' => '.mw-test-baz { content: "style"; }',
|
|
] ),
|
|
'test.quux' => new ResourceLoaderTestModule( [
|
|
'script' => 'mw.test.baz( { token: 123 } );',
|
|
'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
|
|
'group' => 'private',
|
|
] ),
|
|
'test.raw' => new ResourceLoaderTestModule( [
|
|
'script' => 'mw.test.baz( { token: 123 } );',
|
|
'isRaw' => true,
|
|
] ),
|
|
'test.noscript' => new ResourceLoaderTestModule( [
|
|
'styles' => '.mw-test-noscript { content: "style"; }',
|
|
'group' => 'noscript',
|
|
] ),
|
|
'test.group.bar' => new ResourceLoaderTestModule( [
|
|
'styles' => '.mw-group-bar { content: "style"; }',
|
|
'group' => 'bar',
|
|
] ),
|
|
'test.group.foo' => new ResourceLoaderTestModule( [
|
|
'styles' => '.mw-group-foo { content: "style"; }',
|
|
'group' => 'foo',
|
|
] ),
|
|
] );
|
|
$links = $method->invokeArgs( $out, $args );
|
|
$actualHtml = implode( "\n", $links['html'] );
|
|
$this->assertEquals( $expectedHtml, $actualHtml );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideVaryHeaders
|
|
* @covers OutputPage::addVaryHeader
|
|
* @covers OutputPage::getVaryHeader
|
|
* @covers OutputPage::getKeyHeader
|
|
*/
|
|
public function testVaryHeaders( $calls, $vary, $key ) {
|
|
// get rid of default Vary fields
|
|
$outputPage = $this->getMockBuilder( 'OutputPage' )
|
|
->setConstructorArgs( [ new RequestContext() ] )
|
|
->setMethods( [ 'getCacheVaryCookies' ] )
|
|
->getMock();
|
|
$outputPage->expects( $this->any() )
|
|
->method( 'getCacheVaryCookies' )
|
|
->will( $this->returnValue( [] ) );
|
|
TestingAccessWrapper::newFromObject( $outputPage )->mVaryHeader = [];
|
|
|
|
foreach ( $calls as $call ) {
|
|
call_user_func_array( [ $outputPage, 'addVaryHeader' ], $call );
|
|
}
|
|
$this->assertEquals( $vary, $outputPage->getVaryHeader(), 'Vary:' );
|
|
$this->assertEquals( $key, $outputPage->getKeyHeader(), 'Key:' );
|
|
}
|
|
|
|
public function provideVaryHeaders() {
|
|
// note: getKeyHeader() automatically adds Vary: Cookie
|
|
return [
|
|
[ // single header
|
|
[
|
|
[ 'Cookie' ],
|
|
],
|
|
'Vary: Cookie',
|
|
'Key: Cookie',
|
|
],
|
|
[ // non-unique headers
|
|
[
|
|
[ 'Cookie' ],
|
|
[ 'Accept-Language' ],
|
|
[ 'Cookie' ],
|
|
],
|
|
'Vary: Cookie, Accept-Language',
|
|
'Key: Cookie,Accept-Language',
|
|
],
|
|
[ // two headers with single options
|
|
[
|
|
[ 'Cookie', [ 'param=phpsessid' ] ],
|
|
[ 'Accept-Language', [ 'substr=en' ] ],
|
|
],
|
|
'Vary: Cookie, Accept-Language',
|
|
'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
|
|
],
|
|
[ // one header with multiple options
|
|
[
|
|
[ 'Cookie', [ 'param=phpsessid', 'param=userId' ] ],
|
|
],
|
|
'Vary: Cookie',
|
|
'Key: Cookie;param=phpsessid;param=userId',
|
|
],
|
|
[ // Duplicate option
|
|
[
|
|
[ 'Cookie', [ 'param=phpsessid' ] ],
|
|
[ 'Cookie', [ 'param=phpsessid' ] ],
|
|
[ 'Accept-Language', [ 'substr=en', 'substr=en' ] ],
|
|
],
|
|
'Vary: Cookie, Accept-Language',
|
|
'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
|
|
],
|
|
[ // Same header, different options
|
|
[
|
|
[ 'Cookie', [ 'param=phpsessid' ] ],
|
|
[ 'Cookie', [ 'param=userId' ] ],
|
|
],
|
|
'Vary: Cookie',
|
|
'Key: Cookie;param=phpsessid;param=userId',
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @covers OutputPage::haveCacheVaryCookies
|
|
*/
|
|
function testHaveCacheVaryCookies() {
|
|
$request = new FauxRequest();
|
|
$context = new RequestContext();
|
|
$context->setRequest( $request );
|
|
$outputPage = new OutputPage( $context );
|
|
|
|
// No cookies are set.
|
|
$this->assertFalse( $outputPage->haveCacheVaryCookies() );
|
|
|
|
// 'Token' is present but empty, so it shouldn't count.
|
|
$request->setCookie( 'Token', '' );
|
|
$this->assertFalse( $outputPage->haveCacheVaryCookies() );
|
|
|
|
// 'Token' present and nonempty.
|
|
$request->setCookie( 'Token', '123' );
|
|
$this->assertTrue( $outputPage->haveCacheVaryCookies() );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* MessageBlobStore that doesn't do anything
|
|
*/
|
|
class NullMessageBlobStore extends MessageBlobStore {
|
|
public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
|
|
return [];
|
|
}
|
|
|
|
public function insertMessageBlob( $name, ResourceLoaderModule $module, $lang ) {
|
|
return false;
|
|
}
|
|
|
|
public function updateModule( $name, ResourceLoaderModule $module, $lang ) {
|
|
}
|
|
|
|
public function updateMessage( $key ) {
|
|
}
|
|
|
|
public function clear() {
|
|
}
|
|
}
|