MediaWikiMessageChecker.php

Go to the documentation of this file.

<?php
class MediaWikiMessageChecker extends MessageChecker {
    protected function wikiParameterCheck( $messages, $code, &$warnings ) {
        parent::parameterCheck( $messages, $code, $warnings, '/\$[1-9]/' );
    }

    protected function wikiLinksCheck( $messages, $code, &$warnings ) {
        $tc = Title::legalChars() . '#%{}';

        foreach ( $messages as $message ) {
            $key = $message->key();
            $definition = $message->definition();
            $translation = $message->translation();

            $subcheck = 'extra';
            $matches = $links = array();
            preg_match_all( "/\[\[([{$tc}]+)(\\|(.+?))?]]/sDu", $translation, $matches );
            $count = count( $matches[0] );
            for ( $i = 0; $i < $count; $i++ ) {
                $backMatch = preg_quote( $matches[1][$i], '/' );

                if ( preg_match( "/\[\[$backMatch/", $definition ) ) {
                    continue;
                }

                $links[] = "[[{$matches[1][$i]}{$matches[2][$i]}]]";
            }

            if ( count( $links ) ) {
                $warnings[$key][] = array(
                    array( 'links', $subcheck, $key, $code ),
                    'translate-checks-links',
                    array( 'PARAMS', $links ),
                    array( 'COUNT', count( $links ) ),
                );
            }

            $subcheck = 'missing';
            $matches = $links = array();
            preg_match_all( "/\[\[([{$tc}]+)(\\|(.+?))?]]/sDu", $definition, $matches );
            $count = count( $matches[0] );
            for ( $i = 0; $i < $count; $i++ ) {
                $backMatch = preg_quote( $matches[1][$i], '/' );

                if ( preg_match( "/\[\[$backMatch/", $translation ) ) {
                    continue;
                }

                $links[] = "[[{$matches[1][$i]}{$matches[2][$i]}]]";
            }

            if ( count( $links ) ) {
                $warnings[$key][] = array(
                    array( 'links', $subcheck, $key, $code ),
                    'translate-checks-links-missing',
                    array( 'PARAMS', $links ),
                    array( 'COUNT', count( $links ) ),
                );
            }
        }
    }

    protected function XhtmlCheck( $messages, $code, &$warnings ) {
        foreach ( $messages as $message ) {
            $key = $message->key();
            $translation = $message->translation();
            if ( strpos( $translation, '<' ) === false ) {
                continue;
            }

            $subcheck = 'invalid';
            $tags = array(
                '~<hr *(\\\\)?>~suDi' => '<hr />', // Wrong syntax
                '~<br *(\\\\)?>~suDi' => '<br />',
                '~<hr/>~suDi' => '<hr />', // Wrong syntax
                '~<br/>~suDi' => '<br />',
                '~<(HR|Hr|hR) />~su' => '<hr />', // Case
                '~<(BR|Br|bR) />~su' => '<br />',
            );

            $wrongTags = array();
            foreach ( $tags as $wrong => $correct ) {
                $matches = array();
                preg_match_all( $wrong, $translation, $matches, PREG_PATTERN_ORDER );
                foreach ( $matches[0] as $wrongMatch ) {
                    $wrongTags[$wrongMatch] = "$wrongMatch → $correct";
                }
            }

            if ( count( $wrongTags ) ) {
                $warnings[$key][] = array(
                    array( 'xhtml', $subcheck, $key, $code ),
                    'translate-checks-xhtml',
                    array( 'PARAMS', $wrongTags ),
                    array( 'COUNT', count( $wrongTags ) ),
                );
            }
        }
    }

    protected function pluralCheck( $messages, $code, &$warnings ) {
        foreach ( $messages as $message ) {
            $key = $message->key();
            $definition = $message->definition();
            $translation = $message->translation();

            $subcheck = 'missing';
            if (
                stripos( $definition, '{{plural:' ) !== false &&
                stripos( $translation, '{{plural:' ) === false
            ) {
                $warnings[$key][] = array(
                    array( 'plural', $subcheck, $key, $code ),
                    'translate-checks-plural',
                );
            }
        }
    }

    protected function pluralFormsCheck( $messages, $code, &$warnings ) {
        foreach ( $messages as $message ) {
            $key = $message->key();
            $translation = $message->translation();

            // Does this version of MediaWiki support v1.20-style CLDR plural rules?
            if ( !method_exists( 'Language', 'getPluralRules' ) ) {
                return;
            }

            // Are there any plural forms for this language in this message?
            if ( stripos( $translation, '{{plural:' ) === false ) {
                return;
            }

            $plurals = self::getPluralForms( $translation );
            $allowed = self::getPluralFormCount( $code );

            foreach ( $plurals as $forms ) {
                $forms = self::removeExplicitPluralForms( $forms );
                $provided = count( $forms );

                if ( $provided > $allowed ) {
                    $warnings[$key][] = array(
                        array( 'plural', 'forms', $key, $code ),
                        'translate-checks-plural-forms', $provided, $allowed
                    );
                }

                // Are the last two forms identical?
                if ( $provided > 1 && $forms[$provided - 1] === $forms[$provided - 2] ) {
                    $warnings[$key][] = array(
                        array( 'plural', 'dupe', $key, $code ),
                        'translate-checks-plural-dupe'
                    );
                }
            }
        }
    }

    public static function getPluralFormCount( $code ) {
        $forms = Language::factory( $code )->getPluralRules();

        // +1 for the 'other' form
        return count( $forms ) + 1;
    }

    public static function getPluralForms( $translation ) {
        $plurals = array();
        while ( true ) {
            $pos = stripos( $translation, '{{plural:' );
            if ( $pos === false ) {
                break;
            }

            $len = strlen( $translation );
            $stack = 0;
            for ( $i = $pos; $i < $len; $i++ ) {
                if ( $translation[$i] === '{' ) {
                    $stack++;
                } elseif ( $translation[$i] === '}' ) {
                    $stack--;
                } elseif ( $stack > 2 && $translation[$i] === '|' ) {
                    # These pipes belong to another thing, ignore them
                    $translation[$i] = '_';
                }

                if ( $stack === 0 ) {
                    // The string '{{PLURAL...' (without closing }})
                    $pluralString = substr( $translation, $pos, $i - $pos - 1 );
                    $forms = explode( '|', $pluralString );
                    array_shift( $forms );

                    // Remove this from the current string to continue later
                    $translation = substr( $translation, $i );

                    $plurals[] = $forms;
                    break;
                }
            }

            // Unclosed plural, stop here
            if ( $i === $len ) {
                break;
            }
        }

        return $plurals;
    }

    public static function removeExplicitPluralForms( array $forms ) {
        // Handle explicit 0= and 1= forms
        foreach ( $forms as $index => $form ) {
            if ( isset( $form[1] ) && $form[1] === '=' ) {
                unset( $forms[$index] );
            }
        }

        return array_values( $forms );
    }

    protected function pagenameMessagesCheck( $messages, $code, &$warnings ) {
        foreach ( $messages as $message ) {
            $key = $message->key();
            $definition = $message->definition();
            $translation = $message->translation();

            $subcheck = 'namespace';
            $namespaces = 'help|project|\{\{ns:project}}|mediawiki';
            $matches = array();
            if ( preg_match( "/^($namespaces):[\w\s]+$/ui", $definition, $matches ) ) {
                if ( !preg_match( "/^{$matches[1]}:.+$/u", $translation ) ) {
                    $warnings[$key][] = array(
                        array( 'pagename', $subcheck, $key, $code ),
                        'translate-checks-pagename',
                    );
                }
            }
        }
    }

    protected function miscMWChecks( $messages, $code, &$warnings ) {
        $timeList = array( 'protect-expiry-options', 'ipboptions' );

        foreach ( $messages as $message ) {
            $key = $message->key();
            $definition = $message->definition();
            $translation = $message->translation();

            if ( in_array( strtolower( $key ), $timeList, true ) ) {
                $defArray = explode( ',', $definition );
                $traArray = explode( ',', $translation );

                $subcheck = 'timelist-count';
                $defCount = count( $defArray );
                $traCount = count( $traArray );
                if ( $defCount !== $traCount ) {
                    $warnings[$key][] = array(
                        array( 'miscmw', $subcheck, $key, $code ),
                        'translate-checks-format',
                        wfMessage( 'translate-checks-parametersnotequal' )
                            ->numParams( $traCount, $defCount )->text()
                    );

                    continue;
                }

                for ( $i = 0; $i < $defCount; $i++ ) {
                    $defItems = array_map( 'trim', explode( ':', $defArray[$i] ) );
                    $traItems = array_map( 'trim', explode( ':', $traArray[$i] ) );

                    $subcheck = 'timelist-format';
                    if ( count( $traItems ) !== 2 ) {
                        $warnings[$key][] = array(
                            array( 'miscmw', $subcheck, $key, $code ),
                            'translate-checks-format',
                            wfMessage(
                                'translate-checks-malformed',
                                $traArray[$i]
                            )->text()
                        );
                        continue;
                    }

                    $subcheck = 'timelist-format-value';
                    if ( $traItems[1] !== $defItems[1] ) {
                        $warnings[$key][] = array(
                            array( 'miscmw', $subcheck, $key, $code ),
                            'translate-checks-format',
                            "<samp><nowiki>$traItems[1] !== $defItems[1]</nowiki></samp>", // @todo FIXME: i18n missing.
                        );
                        continue;
                    }
                }
            }
        }
    }
}