MessageGroupConfigurationParser.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\MessageProcessing\StringMatcher;
 
class MessageGroupConfigurationParser {
    private $baseSchema;
 
    public function __construct() {
        // Don't perform validations if library not available
        if ( class_exists( RomaricDrigon\MetaYaml\MetaYaml::class ) ) {
            $this->baseSchema = $this->getBaseSchema();
        }
    }
 
    public function getHopefullyValidConfigurations( $data, $callback = null ) {
        if ( !is_callable( $callback ) ) {
            $callback = static function ( $unused1, $unused2, $unused3 ) {
                /*noop*/
            };
        }
 
        $documents = self::getDocumentsFromYaml( $data );
        $configurations = self::parseDocuments( $documents );
        $groups = [];
 
        if ( is_array( $this->baseSchema ) ) {
            foreach ( $configurations as $index => $config ) {
                try {
                    $this->validate( $config );
                    $groups[$config['BASIC']['id']] = $config;
                } catch ( Exception $e ) {
                    $callback( $index, $config, $e->getMessage() );
                }
            }
        } else {
            foreach ( $configurations as $index => $config ) {
                if ( isset( $config['BASIC']['id'] ) ) {
                    $groups[$config['BASIC']['id']] = $config;
                } else {
                    $callback( $index, $config, 'id is missing' );
                }
            }
        }
 
        return $groups;
    }
 
    public function getDocumentsFromYaml( $data ) {
        return preg_split( "/^---$/m", $data, -1, PREG_SPLIT_NO_EMPTY );
    }
 
    public function parseDocuments( array $documents ) {
        $groups = [];
        $template = [];
 
        foreach ( $documents as $document ) {
            $document = TranslateYaml::loadString( $document );
 
            if ( isset( $document['TEMPLATE'] ) ) {
                $template = $document['TEMPLATE'];
            } else {
                $groups[] = $document;
            }
        }
 
        if ( $template ) {
            foreach ( $groups as $i => $group ) {
                $groups[$i] = self::mergeTemplate( $template, $group );
                // Little hack to allow aggregate groups to be defined in same file with other groups.
                if ( $groups[$i]['BASIC']['class'] === AggregateMessageGroup::class ) {
                    unset( $groups[$i]['FILES'] );
                }
            }
        }
 
        return $groups;
    }
 
    public function getBaseSchema() {
        return TranslateYaml::load( __DIR__ . '/data/group-yaml-schema.yaml' );
    }
 
    public function validate( array $config ) {
        $schema = $this->baseSchema;
 
        foreach ( $config as $section ) {
            if ( !isset( $section['class'] ) ) {
                continue;
            }
 
            $class = $section['class'];
 
            // FIXME: UGLY HACK: StringMatcher is now under a namespace so use the fully prefixed
            // class to check if it has the getExtraSchema method
            if ( $class === 'StringMatcher' ) {
                $class = StringMatcher::class;
            }
 
            // There is no sane way to check whether *class* implements interface in PHP
            if ( !is_callable( [ $class, 'getExtraSchema' ] ) ) {
                continue;
            }
 
            $extra = call_user_func( [ $class, 'getExtraSchema' ] );
            $schema = array_replace_recursive( $schema, $extra );
        }
 
        $schema = new RomaricDrigon\MetaYaml\MetaYaml( $schema );
        $schema->validate( $config );
    }
 
    public static function mergeTemplate( array $base, array $specific ) {
        foreach ( $specific as $key => $value ) {
            if ( is_array( $value ) && isset( $base[$key] ) && is_array( $base[$key] ) ) {
                $base[$key] = self::mergeTemplate( $base[$key], $value );
            } else {
                $base[$key] = $value;
            }
        }
 
        return $base;
    }
}