Page MenuHomeWickedGov Phorge
Files F5980056

TemplateStylesHooksTest.php
No OneTemporary
Actions

Size
14 KB
Referenced Files
None
Subscribers
None

TemplateStylesHooksTest.php
View Options

<?php
use MediaWiki\Content\ContentHandler;
use MediaWiki\Context\RequestContext;
use MediaWiki\Extension\TemplateStyles\Hooks as TemplateStylesHooks;
use MediaWiki\Extension\TemplateStyles\TemplateStylesContent;
use MediaWiki\MainConfigNames;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use Wikimedia\CSS\Parser\Parser as CSSParser;
/**
* @group TemplateStyles
* @group Database
* @covers \MediaWiki\Extension\TemplateStyles\Hooks
*/
class TemplateStylesHooksTest extends MediaWikiLangTestCase {
protected function addPage( $page, $text, $model ) {
$title = Title::newFromText( 'Template:TemplateStyles test/' . $page );
$content = ContentHandler::makeContent( $text, $title, $model );
$page = $this->getServiceContainer()->getWikiPageFactory()->newFromTitle( $title );
$user = static::getTestSysop()->getUser();
$status = $page->doUserEditContent( $content, $user, 'Test for TemplateStyles' );
if ( !$status->isOk() ) {
$this->fail( "Failed to create $title: " . $status->getWikiText( false, false, 'en' ) );
}
}
public function addDBDataOnce() {
$this->addPage( 'wikitext', '.foo { color: red; }', CONTENT_MODEL_WIKITEXT );
$this->addPage( 'nonsanitized.css', '.foo { color: red; }', CONTENT_MODEL_CSS );
$this->addPage( 'styles1.css', '.foo { color: blue; }', 'sanitized-css' );
$this->addPage( 'styles2.css', '.bar { color: green; }', 'sanitized-css' );
$this->addPage(
'styles3.css', 'html.no-js body.skin-minerva .bar { color: yellow; }', 'sanitized-css'
);
}
public function testGetSanitizerInvalidWrapper() {
$this->expectException( InvalidArgumentException::class );
$this->expectExceptionMessage( 'Invalid value for $extraWrapper: .foo>.bar' );
TemplateStylesHooks::getSanitizer( 'foo', '.foo>.bar' );
}
public function testGetSanitizerNonLinearWrapper() {
$sanitizer = TemplateStylesHooks::getSanitizer( 'foo', 'div[data]' );
$sanitizer->sanitize( CSSParser::newFromString( '.not-empty { }' )->parseStylesheet() );
$this->assertSame( [], $sanitizer->getSanitizationErrors() );
}
/**
* @dataProvider provideOnRegistration
* @param array $textModelsToParse
* @param bool $autoParseContent
* @param array $expect
*/
public function testOnRegistration( $textModelsToParse, $autoParseContent, $expect ) {
$this->overrideConfigValues( [
MainConfigNames::TextModelsToParse => $textModelsToParse,
'TemplateStylesAutoParseContent' => $autoParseContent,
] );
global $wgTextModelsToParse;
TemplateStylesHooks::onRegistration();
$this->assertSame( $expect, $wgTextModelsToParse );
}
public static function provideOnRegistration() {
return [
[
[ CONTENT_MODEL_WIKITEXT ],
true,
[ CONTENT_MODEL_WIKITEXT ]
],
[
[ CONTENT_MODEL_WIKITEXT, CONTENT_MODEL_CSS ],
true,
[ CONTENT_MODEL_WIKITEXT, CONTENT_MODEL_CSS, 'sanitized-css' ],
],
[
[ CONTENT_MODEL_WIKITEXT, CONTENT_MODEL_CSS ],
false,
[ CONTENT_MODEL_WIKITEXT, CONTENT_MODEL_CSS ],
],
];
}
/**
* @dataProvider provideOnContentHandlerDefaultModelFor
*/
public function testOnContentHandlerDefaultModelFor( $ns, $title, $expect ) {
$this->overrideConfigValues( [
'TemplateStylesNamespaces' => [
10 => true,
2 => false,
3000 => true,
3002 => true,
3006 => false,
],
MainConfigNames::NamespacesWithSubpages => [
10 => true,
2 => true,
3000 => true,
3002 => false,
3004 => true,
3006 => true
],
] );
$reset = ExtensionRegistry::getInstance()->setAttributeForTest(
'TemplateStylesNamespaces', [ 3004, 3006 ]
);
$model = 'unchanged';
$ret = ( new TemplateStylesHooks )->onContentHandlerDefaultModelFor(
Title::makeTitle( $ns, $title ), $model
);
$this->assertSame( !$expect, $ret );
$this->assertSame( $expect ? 'sanitized-css' : 'unchanged', $model );
}
public static function provideOnContentHandlerDefaultModelFor() {
return [
[ 10, 'Test/test.css', true ],
[ 10, 'Test.css', false ],
[ 10, 'Test/test.xss', false ],
[ 10, 'Test/test.CSS', false ],
[ 3000, 'Test/test.css', true ],
[ 3002, 'Test/test.css', false ],
[ 2, 'Test/test.css', false ],
[ 3004, 'Test/test.css', true ],
[ 3006, 'Test/test.css', false ],
];
}
/**
* Unfortunately we can't just use a parserTests.txt file because our
* tag's output depends on the revision IDs of the input pages.
* @dataProvider provideTag
*/
public function testTag(
ParserOptions $popt, $getTextOptions, $wikitext, $expect, $globals = []
) {
$this->overrideConfigValues( $globals + [
MainConfigNames::ScriptPath => '',
MainConfigNames::Script => '/index.php',
MainConfigNames::ArticlePath => '/wiki/$1',
] );
$oldCurrentRevisionRecordCallback = $popt->setCurrentRevisionRecordCallback(
static function ( Title $title, $parser = null ) use ( &$oldCurrentRevisionRecordCallback ) {
if ( $title->getPrefixedText() === 'Template:Test replacement' ) {
$user = RequestContext::getMain()->getUser();
$revRecord = new MutableRevisionRecord( $title );
$revRecord->setUser( $user );
$revRecord->setContent(
SlotRecord::MAIN,
new TemplateStylesContent( '.baz { color:orange; bogus:bogus; }' )
);
$revRecord->setParentId( $title->getLatestRevID() );
return $revRecord;
}
return call_user_func( $oldCurrentRevisionRecordCallback, $title, $parser );
}
);
$services = $this->getServiceContainer();
$parser = $services->getParserFactory()->create();
$parser->firstCallInit();
if ( !in_array( 'templatestyles', $parser->getTags(), true ) ) {
throw new Exception( 'templatestyles tag hook is not in the parser' );
}
$out = $parser->parse( $wikitext, Title::newFromText( 'Test' ), $popt );
$expect = preg_replace_callback( '/\{\{REV:(.*?)\}\}/', static function ( $m ) {
return Title::newFromText( 'Template:TemplateStyles test/' . $m[1] )->getLatestRevID();
}, $expect );
$this->assertEquals( $expect, $out->getText( $getTextOptions ) );
}
public static function provideTag() {
$popt = ParserOptions::newFromContext( RequestContext::getMain() );
$popt->setWrapOutputClass( 'templatestyles-test' );
$popt2 = ParserOptions::newFromContext( RequestContext::getMain() );
$popt3 = ParserOptions::newFromContext( RequestContext::getMain() );
// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
@$popt3->setWrapOutputClass( false );
return [
'Tag without src' => [
$popt, [],
'<templatestyles />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">TemplateStyles' <code>src</code> attribute must not be empty.</strong>\n</p></div>",
],
'Tag with invalid src' => [
$popt, [],
'<templatestyles src="Test&lt;&gt;" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Invalid title for TemplateStyles' <code>src</code> attribute.</strong>\n</p></div>",
],
'Tag with valid but nonexistent title' => [
$popt, [],
'<templatestyles src="ThisDoes\'\'\'Not\'\'\'Exist" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Page <a href=\"/index.php?title=Template:ThisDoes%27%27%27Not%27%27%27Exist&amp;action=edit&amp;redlink=1\" class=\"new\" title=\"Template:ThisDoes&#39;&#39;&#39;Not&#39;&#39;&#39;Exist (page does not exist)\">Template:ThisDoes&#39;&#39;&#39;Not&#39;&#39;&#39;Exist</a> has no content.</strong>\n</p></div>",
],
'Tag with valid but nonexistent title, main namespace' => [
$popt, [],
'<templatestyles src=":ThisDoes\'\'\'Not\'\'\'Exist" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Page <a href=\"/index.php?title=ThisDoes%27%27%27Not%27%27%27Exist&amp;action=edit&amp;redlink=1\" class=\"new\" title=\"ThisDoes&#39;&#39;&#39;Not&#39;&#39;&#39;Exist (page does not exist)\">ThisDoes&#39;&#39;&#39;Not&#39;&#39;&#39;Exist</a> has no content.</strong>\n</p></div>",
],
'Tag with wikitext page' => [
$popt, [],
'<templatestyles src="TemplateStyles test/wikitext" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Page <a href=\"/wiki/Template:TemplateStyles_test/wikitext\" title=\"Template:TemplateStyles test/wikitext\">Template:TemplateStyles test/wikitext</a> must have content model \"Sanitized CSS\" for TemplateStyles (current model is \"wikitext\").</strong>\n</p></div>",
],
'Tag with CSS (not sanitized-css) page' => [
$popt, [],
'<templatestyles src="TemplateStyles test/nonsanitized.css" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Page <a href=\"/wiki/Template:TemplateStyles_test/nonsanitized.css\" title=\"Template:TemplateStyles test/nonsanitized.css\">Template:TemplateStyles test/nonsanitized.css</a> must have content model \"Sanitized CSS\" for TemplateStyles (current model is \"CSS\").</strong>\n</p></div>",
],
'Working tag' => [
$popt, [],
'<templatestyles src="TemplateStyles test/styles1.css" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><style data-mw-deduplicate=\"TemplateStyles:r{{REV:styles1.css}}/templatestyles-test\">.templatestyles-test .foo{color:blue}</style></div>",
],
'Disabled' => [
$popt, [],
'<templatestyles src="TemplateStyles test/styles1.css" />',
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"></div>",
[ 'TemplateStylesDisable' => true ],
],
'Replaced content (which includes sanitization errors)' => [
$popt, [],
'<templatestyles src="Test replacement" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><style data-mw-deduplicate=\"TemplateStyles:8fd14043c1cce91e8b9d1487a9d17d8d9ae43890/templatestyles-test\">/*\nErrors processing stylesheet [[:Template:Test replacement]] (rev ):\n• Unrecognized or unsupported property at line 1 character 22.\n*/\n.templatestyles-test .baz{color:orange}</style></div>",
],
'Hoistable selectors are hoisted' => [
$popt, [],
'<templatestyles src="TemplateStyles test/styles3.css" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><style data-mw-deduplicate=\"TemplateStyles:r{{REV:styles3.css}}/templatestyles-test\">html.no-js body.skin-minerva .templatestyles-test .bar{color:yellow}</style></div>",
],
'Still prefixed despite no wrapping class' => [
$popt2, [ 'unwrap' => true ],
'<templatestyles src="TemplateStyles test/styles1.css" />',
// phpcs:ignore Generic.Files.LineLength
"<style data-mw-deduplicate=\"TemplateStyles:r{{REV:styles1.css}}\">.mw-parser-output .foo{color:blue}</style>",
],
'Still prefixed despite deprecated no wrapping class' => [
$popt3, [],
'<templatestyles src="TemplateStyles test/styles1.css" />',
// phpcs:ignore Generic.Files.LineLength
"<style data-mw-deduplicate=\"TemplateStyles:r{{REV:styles1.css}}\">.mw-parser-output .foo{color:blue}</style>",
],
'Deduplicated tags' => [
$popt, [],
trim( '
<templatestyles src="TemplateStyles test/styles1.css" />
<templatestyles src="TemplateStyles test/styles1.css" />
<templatestyles src="TemplateStyles test/styles2.css" />
<templatestyles src="TemplateStyles test/styles1.css" />
<templatestyles src="TemplateStyles test/styles2.css" />
' ),
// phpcs:disable Generic.Files.LineLength
trim( '
<div class="mw-content-ltr templatestyles-test" lang="en" dir="ltr"><style data-mw-deduplicate="TemplateStyles:r{{REV:styles1.css}}/templatestyles-test">.templatestyles-test .foo{color:blue}</style>
<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r{{REV:styles1.css}}/templatestyles-test">
<style data-mw-deduplicate="TemplateStyles:r{{REV:styles2.css}}/templatestyles-test">.templatestyles-test .bar{color:green}</style>
<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r{{REV:styles1.css}}/templatestyles-test">
<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r{{REV:styles2.css}}/templatestyles-test"></div>
' ),
// phpcs:enable
],
'Wrapper parameter' => [
$popt2, [],
'<templatestyles src="TemplateStyles test/styles1.css" wrapper=".foobar" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr mw-parser-output\" lang=\"en\" dir=\"ltr\"><style data-mw-deduplicate=\"TemplateStyles:r{{REV:styles1.css}}/mw-parser-output/.foobar\">.mw-parser-output .foobar .foo{color:blue}</style></div>",
],
'Invalid wrapper parameter' => [
$popt, [],
'<templatestyles src="TemplateStyles test/styles1.css" wrapper=".foo .bar" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Invalid value for TemplateStyles' <code>wrapper</code> attribute.</strong>\n</p></div>",
],
'Invalid wrapper parameter (2)' => [
$popt, [],
'<templatestyles src="TemplateStyles test/styles1.css" wrapper=".foo/*" />',
// phpcs:ignore Generic.Files.LineLength
"<div class=\"mw-content-ltr templatestyles-test\" lang=\"en\" dir=\"ltr\"><p><strong class=\"error\">Invalid value for TemplateStyles' <code>wrapper</code> attribute.</strong>\n</p></div>",
],
'Wrapper parameter and proper deduplication' => [
$popt2, [],
trim( '
<templatestyles src="TemplateStyles test/styles1.css" />
<templatestyles src="TemplateStyles test/styles1.css" wrapper=" " />
<templatestyles src="TemplateStyles test/styles1.css" wrapper=".foobar" />
<templatestyles src="TemplateStyles test/styles1.css" wrapper=".foobaz" />
<templatestyles src="TemplateStyles test/styles1.css" wrapper=" .foobar " />
' ),
// phpcs:disable Generic.Files.LineLength
trim( '
<div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><style data-mw-deduplicate="TemplateStyles:r{{REV:styles1.css}}">.mw-parser-output .foo{color:blue}</style>
<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r{{REV:styles1.css}}">
<style data-mw-deduplicate="TemplateStyles:r{{REV:styles1.css}}/mw-parser-output/.foobar">.mw-parser-output .foobar .foo{color:blue}</style>
<style data-mw-deduplicate="TemplateStyles:r{{REV:styles1.css}}/mw-parser-output/.foobaz">.mw-parser-output .foobaz .foo{color:blue}</style>
<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r{{REV:styles1.css}}/mw-parser-output/.foobar"></div>
' ),
// phpcs:enable
],
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 21:13 (5 d, 22 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
44/ae/204186388f67744a440e070c1d68
Default Alt Text
TemplateStylesHooksTest.php (14 KB)

Event Timeline