Updater.php

Go to the documentation of this file.

<?php
namespace LocalisationUpdate;
 
class Updater {
    public function isDirectory( $path ) {
        $filename = basename( $path );
        return strpos( $filename, '*' ) !== false;
    }
 
    public function expandRemotePath( $info, $repos ) {
        $pattern = $repos[$info['repo']];
        unset( $info['repo'], $info['orig'] );
 
        // This assumes all other keys are used as variables
        // in the pattern. For example name -> %NAME%.
        $keys = [];
        foreach ( array_keys( $info ) as $key ) {
            $keys[] = '%' . strtoupper( $key ) . '%';
        }
 
        $values = array_values( $info );
        return str_replace( $keys, $values, $pattern );
    }
 
    public function readMessages( ReaderFactory $readerFactory, array $files ) {
        $messages = [];
 
        foreach ( $files as $filename => $contents ) {
            $reader = $readerFactory->getReader( $filename );
            try {
                $parsed = $reader->parse( $contents );
            } catch ( \Exception $e ) {
                trigger_error( __METHOD__ . ": Unable to parse messages from $filename", E_USER_WARNING );
                continue;
            }
 
            foreach ( $parsed as $code => $langMessages ) {
                if ( !isset( $messages[$code] ) ) {
                    $messages[$code] = [];
                }
                $messages[$code] = array_merge( $messages[$code], $langMessages );
            }
 
            $c = array_sum( array_map( 'count', $parsed ) );
            // Useful for debugging, maybe create interface to pass this to the script?
            # echo "$filename with " . get_class( $reader ) . " and $c\n";
        }
 
        return $messages;
    }
 
    public function findChangedTranslations( $origin, $remote, $blacklist = [] ) {
        $changed = [];
        foreach ( $remote as $key => $value ) {
            if ( isset( $blacklist[$key] ) ) {
                continue;
            }
 
            if ( !isset( $origin[$key] ) || $value !== $origin[$key] ) {
                $changed[$key] = $value;
            }
        }
        return $changed;
    }
 
    public function fetchFiles( FetcherFactory $factory, $path ) {
        $fetcher = $factory->getFetcher( $path );
 
        if ( $this->isDirectory( $path ) ) {
            $files = $fetcher->fetchDirectory( $path );
        } else {
            $files = [ $path => $fetcher->fetchFile( $path ) ];
        }
 
        // Remove files which were not found
        return array_filter( $files );
    }
 
    public function execute(
        Finder $finder,
        ReaderFactory $readerFactory,
        FetcherFactory $fetcherFactory,
        array $repos
    ) {
        $components = $finder->getComponents();
 
        $updatedMessages = [];
 
        foreach ( $components as $key => $info ) {
            $originFiles = $this->fetchFiles( $fetcherFactory, $info['orig'] );
            $remoteFiles = $this->fetchFiles( $fetcherFactory, $this->expandRemotePath( $info, $repos ) );
 
            if ( $remoteFiles === [] ) {
                // Small optimization: if nothing to compare with, skip
                continue;
            }
 
            $originMessages = $this->readMessages( $readerFactory, $originFiles );
            $remoteMessages = $this->readMessages( $readerFactory, $remoteFiles );
 
            if ( !isset( $remoteMessages['en'] ) ) {
                // Could not find remote messages
                continue;
            }
 
            // If remote translation in English is not present or differs, we do not want
            // translations for other languages for those messages, as they are either not
            // used in this version of code or can be incompatible.
            $forbiddenKeys = $this->findChangedTranslations(
                $originMessages['en'],
                $remoteMessages['en']
            );
 
            // We never accept updates for English strings
            unset( $originMessages['en'], $remoteMessages['en'] );
 
            // message: string in all languages; translation: string in one language.
            foreach ( $remoteMessages as $language => $remoteTranslations ) {
                // Check for completely new languages
                $originTranslations = [];
                if ( isset( $originMessages[$language] ) ) {
                    $originTranslations = $originMessages[$language];
                }
 
                $updatedTranslations = $this->findChangedTranslations(
                    $originTranslations,
                    $remoteTranslations,
                    $forbiddenKeys
                );
 
                // Avoid empty arrays
                if ( $updatedTranslations === [] ) {
                    continue;
                }
 
                if ( !isset( $updatedMessages[$language] ) ) {
                    $updatedMessages[$language] = [];
                }
 
                // In case of conflicts, which should not exist, this prefers the
                // first translation seen.
                $updatedMessages[$language] += $updatedTranslations;
            }
        }
 
        return $updatedMessages;
    }
}