LessVarFileModule.php

Go to the documentation of this file.

<?php
namespace MediaWiki\ResourceLoader;
 
use Wikimedia\Minify\CSSMin;
 
// Per https://phabricator.wikimedia.org/T241091
// phpcs:disable MediaWiki.Commenting.FunctionAnnotations.UnrecognizedAnnotation
 
class LessVarFileModule extends FileModule {
    protected $lessVariables = [];
 
    public function __construct(
        array $options = [],
        $localBasePath = null,
        $remoteBasePath = null
    ) {
        if ( isset( $options['lessMessages'] ) ) {
            $this->lessVariables = $options['lessMessages'];
        }
        parent::__construct( $options, $localBasePath, $remoteBasePath );
    }
 
    public function getMessages() {
        // Overload so MessageBlobStore can detect updates to messages and purge as needed.
        return array_merge( $this->messages, $this->lessVariables );
    }
 
    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 ) );
    }
 
    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
    private static function wrapAndEscapeMessage( $msg ) {
        return str_replace( "'", "\'", CSSMin::serializeStringValue( $msg ) );
    }
 
    // phpcs:enable MediaWiki.Commenting.DocComment.SpacingDocTag, Squiz.WhiteSpace.FunctionSpacing.Before
 
    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;
    }
}