wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-24 07:43:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Hygiene: extract VectorTemplate inline HTML to SearchComponent Mustache file

Browse source 
Extract SearchComponent.mustache from VectorTemplate. The "search"
message is now escaped by the template parser. As is, htmlspecialchars()
for "wgScript".

A later patch will change each component renderer function as well as
renderNavigation() to return a string.

Change-Id: I3084b7e0ef73d320c85ee780c9eff13ecea92906
This commit is contained in:
Stephen Niedzielski 2019-11-20 14:43:07 -05:00
parent c9f15a4206
commit d6f4aaa88e
2 changed files with 51 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
includes/VectorTemplate.php
View file

@ -32,6 +32,8 @@ class VectorTemplate extends BaseTemplate {
* Outputs the entire contents of the HTML page
*/
public function execute() {
$templateParser = new TemplateParser( __DIR__ . '/templates' );
$this->data['namespace_urls'] = $this->data['content_navigation']['namespaces'];
$this->data['view_urls'] = $this->data['content_navigation']['views'];
$this->data['action_urls'] = $this->data['content_navigation']['actions'];
@ -101,12 +103,12 @@ class VectorTemplate extends BaseTemplate {
<div id="mw-navigation">
<h2><?php $this->msg( 'navigation-heading' ) ?></h2>
<div id="mw-head">
<?php $this->renderNavigation( [ 'PERSONAL' ] ); ?>
<?php $this->renderNavigation( $templateParser, [ 'PERSONAL' ] ); ?>
<div id="left-navigation">
<?php $this->renderNavigation( [ 'NAMESPACES', 'VARIANTS' ] ); ?>
<?php $this->renderNavigation( $templateParser, [ 'NAMESPACES', 'VARIANTS' ] ); ?>
</div>
<div id="right-navigation">
<?php $this->renderNavigation( [ 'VIEWS', 'ACTIONS', 'SEARCH' ] ); ?>
<?php $this->renderNavigation( $templateParser, [ 'VIEWS', 'ACTIONS', 'SEARCH' ] ); ?>
</div>
</div>
<div id="mw-panel">
@ -163,8 +165,7 @@ class VectorTemplate extends BaseTemplate {
ob_end_clean();
// Prepare and output the HTML response
$templates = new TemplateParser( __DIR__ . '/templates' );
echo $templates->processTemplate( 'index', $params );
echo $templateParser->processTemplate( 'index', $params );
}
/**
@ -263,9 +264,10 @@ class VectorTemplate extends BaseTemplate {
* Render one or more navigations elements by name, automatically reversed by css
* when UI is in RTL mode
*
* @param TemplateParser $templateParser
* @param array $elements
*/
protected function renderNavigation( array $elements ) {
protected function renderNavigation( TemplateParser $templateParser, array $elements ) {
// Render elements
foreach ( $elements as $name => $element ) {
switch ( $element ) {
@ -285,7 +287,7 @@ class VectorTemplate extends BaseTemplate {
$this->renderPersonalComponent();
break;
case 'SEARCH':
$this->renderSearchComponent();
$this->renderSearchComponent( $templateParser );
break;
}
}
@ -448,48 +450,26 @@ class VectorTemplate extends BaseTemplate {
<?php
}
private function renderSearchComponent() {
$searchHeaderAttrs = $this->data[ 'userlangattributes' ] ?? '';
$searchAction = htmlspecialchars( $this->data[ 'wgScript' ] ?? '' );
$searchDivID = $this->config->get( 'VectorUseSimpleSearch' ) ? 'simpleSearch' : '';
$searchInputHTML = $this->makeSearchInput( [ 'id' => 'searchInput' ] );
$titleHTML = Html::hidden( 'title', $this->get( 'searchtitle' ) );
$fallbackSearchButtonHTML = $this->makeSearchButton(
'fulltext',
[ 'id' => 'mw-searchButton', 'class' => 'searchButton mw-fallbackSearchButton' ]
);
$searchButtonHTML = $this->makeSearchButton(
'go',
[ 'id' => 'searchButton', 'class' => 'searchButton' ]
);
?>
<div id="p-search" role="search">
<h3<?php echo $searchHeaderAttrs ?>>
<label for="searchInput"><?php $this->msg( 'search' ) ?></label>
</h3>
<form action="<?php echo $searchAction ?>" id="searchform">
<div id="<?php echo $searchDivID ?>">
<?php
echo $searchInputHTML;
echo $titleHTML;
/* We construct two buttons (for 'go' and 'fulltext' search modes),
* but only one will be visible and actionable at a time (they are
* overlaid on top of each other in CSS).
* * Browsers will use the 'fulltext' one by default (as it's the
* first in tree-order), which is desirable when they are unable
* to show search suggestions (either due to being broken or
* having JavaScript turned off).
* * The mediawiki.searchSuggest module, after doing tests for the
* broken browsers, removes the 'fulltext' button and handles
* 'fulltext' search itself; this will reveal the 'go' button and
* cause it to be used.
*/
echo $fallbackSearchButtonHTML;
echo $searchButtonHTML;
?>
</div>
</form>
</div>
<?php
/**
* @param TemplateParser $templateParser
*/
private function renderSearchComponent( TemplateParser $templateParser ) {
$props = [
'searchHeaderAttrs' => $this->data[ 'userlangattributes' ] ?? '',
'searchAction' => $this->data[ 'wgScript' ] ?? '',
'searchDivID' => $this->config->get( 'VectorUseSimpleSearch' ) ? 'simpleSearch' : '',
'searchInputHTML' => $this->makeSearchInput( [ 'id' => 'searchInput' ] ),
'titleHTML' => Html::hidden( 'title', $this->data[ 'searchtitle' ] ?? null ),
'fallbackSearchButtonHTML' => $this->makeSearchButton(
'fulltext',
[ 'id' => 'mw-searchButton', 'class' => 'searchButton mw-fallbackSearchButton' ]
),
'searchButtonHTML' => $this->makeSearchButton(
'go',
[ 'id' => 'searchButton', 'class' => 'searchButton' ]
),
'searchInputLabel' => $this->getMsg( 'search' )
];
echo $templateParser->processTemplate( 'SearchComponent', $props );
}
}

21
includes/templates/SearchComponent.mustache Normal file
View file

@ -0,0 +1,21 @@
<div id="p-search" role="search">
<h3 {{searchHeaderAttrs}}>
<label for="searchInput">{{searchInputLabel}}</label>
</h3>
<form action="{{searchAction}}" id="searchform">
<div id="{{searchDivID}}">
{{{searchInputHTML}}}
{{{titleHTML}}}
{{! We construct two buttons (for 'go' and 'fulltext' search modes), but only one will be
visible and actionable at a time (they are overlaid on top of each other in CSS).
* Browsers will use the 'fulltext' one by default (as it's the first in tree-order),
which is desirable when they are unable to show search suggestions (either due to being
broken or having JavaScript turned off).
* The mediawiki.searchSuggest module, after doing tests for the broken browsers, removes
the 'fulltext' button and handles 'fulltext' search itself; this will reveal the 'go'
button and cause it to be used. !}}
{{{fallbackSearchButtonHTML}}}
{{{searchButtonHTML}}}
</div>
</form>
</div>