magic-export.php

Go to the documentation of this file.

<?php
require dirname( dirname( dirname( __DIR__ ) ) ) . '/maintenance/Maintenance.php';

class MagicExport extends Maintenance {
    protected $type;
    protected $target;

    protected $handles = array();
    protected $messagesOld = array();

    public function __construct() {
        parent::__construct();
        $this->mDescription = 'Export of aliases and magic words for MediaWiki extensions.';
        $this->addOption(
            'target',
            'Target directory for exported files',
            true, /*required*/
            true /*has arg*/
        );
        $this->addOption(
            'type',
            'magic or special',
            true, /*required*/
            true /*has arg*/
        );
    }

    public function execute() {
        $this->target = $this->getOption( 'target' );
        $this->type = $this->getOption( 'type' );

        switch ( $this->type ) {
            case 'special':
            case 'magic':
                break;
            default:
                $this->error( 'Invalid type.', 1 );
        }

        $this->openHandles();
        $this->writeHeaders();
        $this->writeFiles();
        $this->writeFooters();
        $this->closeHandles();
    }

    protected function openHandles() {
        $this->output( "Opening file handles and loading current data...\n" );

        $groups = MessageGroups::singleton()->getGroups();
        $filename = null;
        foreach ( $groups as $group ) {
            $filename = null;
            if ( $group instanceof MediaWikiExtensionMessageGroup ) {
                $conf = $group->getConfiguration();
                switch ( $this->type ) {
                    case 'special':
                        if ( isset( $conf['FILES']['aliasFile'] ) ) {
                            $filename = $conf['FILES']['aliasFile'];
                        }
                        break;
                    case 'magic':
                        if ( isset( $conf['FILES']['magicFile'] ) ) {
                            $filename = $conf['FILES']['magicFile'];
                        }
                        break;
                }
            }

            if ( $filename === null ) {
                continue;
            }

            global $wgTranslateExtensionDirectory;
            $inFile = "$wgTranslateExtensionDirectory/$filename";

            if ( !file_exists( $inFile ) ) {
                continue;
            }

            include $inFile;
            switch ( $this->type ) {
                case 'special':
                    if ( isset( $aliases ) ) {
                        $this->messagesOld[$group->getId()] = $aliases;
                        unset( $aliases );
                    } elseif ( isset( $specialPageAliases ) ) {
                        $this->messagesOld[$group->getId()] = $specialPageAliases;
                        unset( $specialPageAliases );
                    } else {
                        $this->error( "File '$inFile' does not contain an aliases array.", 1 );
                    }
                    break;
                case 'magic':
                    if ( !isset( $magicWords ) ) {
                        $this->error( "File '$inFile' does not contain a magic words array.", 1 );
                    }
                    $this->messagesOld[$group->getId()] = $magicWords;
                    unset( $magicWords );
                    break;
            }

            $outFile = $this->target . '/' . $filename;
            wfMkdirParents( dirname( $outFile ), null, __METHOD__ );
            $this->handles[$group->getId()] = fopen( $outFile, 'w' );
            fwrite( $this->handles[$group->getId()], $this->readHeader( $inFile ) );

            $this->output( "\t{$group->getId()}\n" );
        }
    }

    protected function readHeader( $file ) {
        $data = file_get_contents( $file );

        // Seek first '*/'.
        $end = strpos( $data, '*/' ) + 2;

        if ( $end === false ) {
            return "<?php\n";
        }

        // Grab header.
        return substr( $data, 0, $end );
    }

    protected function writeHeaders() {
        foreach ( $this->handles as $handle ) {
            switch ( $this->type ) {
                case 'special':
                    fwrite( $handle, <<<PHP

// @codingStandardsIgnoreFile

\$specialPageAliases = array();
PHP
                    );
                    break;
                case 'magic':
                    fwrite( $handle, <<<PHP


\$magicWords = array();
PHP
                    );
                    break;
            }
        }
    }

    protected function writeFiles() {
        $langs = TranslateUtils::parseLanguageCodes( '*' );
        unset( $langs[array_search( 'en', $langs )] );
        $langs = array_merge( array( 'en' ), $langs );
        foreach ( $langs as $l ) {
            // Load message page.
            switch ( $this->type ) {
                case 'special':
                    $title = Title::makeTitleSafe( NS_MEDIAWIKI, 'Sp-translate-data-SpecialPageAliases/' . $l );
                    break;
                case 'magic':
                    $title = Title::makeTitleSafe( NS_MEDIAWIKI, 'Sp-translate-data-MagicWords/' . $l );
                    break;
                default:
                    exit( 1 );
            }

            // Parse message page.
            if ( !$title || !$title->exists() ) {
                $this->output( "Skiping $l...\n" );

                $messagesNew = array();
            } else {
                $this->output( "Processing $l...\n" );

                $article = new Article( $title );
                $data = $article->getContent();

                // Parse message file.
                $segments = explode( "\n", $data );
                array_shift( $segments );
                array_shift( $segments );
                unset( $segments[count( $segments ) - 1] );
                unset( $segments[count( $segments ) - 1] );
                $messagesNew = array();
                foreach ( $segments as $segment ) {
                    $parts = explode( ' = ', $segment );
                    $key = array_shift( $parts );
                    $translations = explode( ', ', implode( $parts ) );
                    $messagesNew[$key] = $translations;
                }
            }

            // Write data to handles.
            $namesEn = LanguageNames::getNames( 'en' );
            $namesNative = Language::getLanguageNames();

            foreach ( $this->handles as $group => $handle ) {
                // Find messages to write to this handle.
                $messagesOut = array();
                foreach ( $this->messagesOld[$group]['en'] as $key => $message ) {
                    if ( array_key_exists( $key, $messagesNew ) ) {
                        $messagesOut[$key] = $messagesNew[$key];
                    } elseif ( isset( $this->messagesOld[$group][$l][$key] ) ) {
                        $messagesOut[$key] = $this->messagesOld[$group][$l][$key];
                    }
                }

                // If there are messages to write, write them.
                if ( count( $messagesOut ) > 0 ) {
                    $out = '';
                    switch ( $this->type ) {
                        case 'special':
                            $out .= "\n\n/** {$namesEn[$l]} ({$namesNative[$l]}) " .
                                "*/\n\$specialPageAliases['{$l}'] = array(\n";
                            break;
                        case 'magic':
                            $out .= "\n\n/** {$namesEn[$l]} ({$namesNative[$l]}) *" .
                                "/\n\$magicWords['{$l}'] = array(\n";
                            break;
                    }
                    foreach ( $messagesOut as $key => $translations ) {
                        foreach ( $translations as $id => $translation ) {
                            $translations[$id] = addslashes( $translation );
                            if ( $this->type === 'magic' && $translation == '0' ) {
                                unset( $translations[$id] );
                            }
                        }
                        $translations = implode( "', '", $translations );
                        switch ( $this->type ) {
                            case 'special':
                                $out .= "\t'$key' => array( '$translations' ),\n";
                                break;
                            case 'magic':
                                if ( $this->messagesOld[$group]['en'][$key][0] === 0 ) {
                                    $out .= "\t'$key' => array( 0, '$translations' ),\n";
                                } else {
                                    $out .= "\t'$key' => array( '$translations' ),\n";
                                }
                                break;
                        }
                    }
                    $out .= ");";
                    fwrite( $handle, $out );
                }
            }
        }
    }

    protected function writeFooters() {
        $this->output( "Writing file footers...\n" );
    }

    protected function closeHandles() {
        $this->output( "Closing file handles...\n" );
        foreach ( $this->handles as $handle ) {
            fclose( $handle );
        }
    }
}

$maintClass = "MagicExport";
require_once DO_MAINTENANCE;