Page MenuHomeWickedGov Phorge
Files F1429489

LessVarFileModule.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

LessVarFileModule.php
View Options

<?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
*/
namespace MediaWiki\ResourceLoader;
use Wikimedia\Minify\CSSMin;
// Per https://phabricator.wikimedia.org/T241091
// phpcs:disable MediaWiki.Commenting.FunctionAnnotations.UnrecognizedAnnotation
/**
* Module augmented with context-specific LESS variables.
*
* @ingroup ResourceLoader
* @since 1.32
*/
class LessVarFileModule extends FileModule {
/** @var array */
protected $lessVariables = [];
/**
* @inheritDoc
*/
public function __construct(
array $options = [],
$localBasePath = null,
$remoteBasePath = null
) {
if ( isset( $options['lessMessages'] ) ) {
$this->lessVariables = $options['lessMessages'];
}
parent::__construct( $options, $localBasePath, $remoteBasePath );
}
/**
* @inheritDoc
*/
public function getMessages() {
// Overload so MessageBlobStore can detect updates to messages and purge as needed.
return array_merge( $this->messages, $this->lessVariables );
}
/**
* Return a subset of messages from a JSON string representation.
*
* @param string|null $blob JSON, or null if module has no declared messages
* @param string[] $allowed
* @return array
*/
private function pluckFromMessageBlob( $blob, array $allowed ): array {
$data = $blob ? json_decode( $blob, true ) : [];
// Keep only the messages intended for LESS export
// (opposite of getMessages essentially).
return array_intersect_key( $data, array_fill_keys( $allowed, true ) );
}
/**
* @inheritDoc
*/
protected function getMessageBlob( Context $context ) {
$blob = parent::getMessageBlob( $context );
if ( !$blob ) {
// If module has no blob, preserve null to avoid needless WAN cache allocation
// client output for modules without messages.
return $blob;
}
return json_encode( (object)$this->pluckFromMessageBlob( $blob, $this->messages ) );
}
// phpcs:disable MediaWiki.Commenting.DocComment.SpacingDocTag, Squiz.WhiteSpace.FunctionSpacing.Before
/**
* Escape and wrap a message value as literal string for LESS.
*
* This mostly lets CSSMin escape it and wrap it, but also escape single quotes
* for compatibility with LESS's feature of variable interpolation into other strings.
* This is relatively rare for most use of LESS, but for messages it is quite common.
*
* Example:
*
* @code
* @x: "foo's";
* .eg { content: 'Value is @{x}'; }
* @endcode
*
* Produces output: `.eg { content: 'Value is foo's'; }`.
* (Tested in less.php 1.8.1, and Less.js 2.7)
*
* @param string $msg
* @return string wrapped LESS variable value
*/
private static function wrapAndEscapeMessage( $msg ) {
return str_replace( "'", "\'", CSSMin::serializeStringValue( $msg ) );
}
// phpcs:enable MediaWiki.Commenting.DocComment.SpacingDocTag, Squiz.WhiteSpace.FunctionSpacing.Before
/**
* Get language-specific LESS variables for this module.
*
* @param Context $context
* @return array LESS variables
*/
protected function getLessVars( Context $context ) {
$vars = parent::getLessVars( $context );
$blob = parent::getMessageBlob( $context );
$messages = $this->pluckFromMessageBlob( $blob, $this->lessVariables );
// It is important that we iterate the declared list from $this->lessVariables,
// and not $messages since in the case of undefined messages, the key is
// omitted entirely from the blob. This emits a log warning for developers,
// but we must still carry on and produce a valid LESS variable declaration,
// to avoid a LESS syntax error (T267785).
foreach ( $this->lessVariables as $msgKey ) {
$vars['msg-' . $msgKey] = self::wrapAndEscapeMessage( $messages[$msgKey] ?? "⧼{$msgKey}⧽" );
}
return $vars;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 17:38 (9 h, 1 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
30/a3/e6ba1b8ef92b2873ad966db5a6c2
Default Alt Text
LessVarFileModule.php (4 KB)

Event Timeline