summaryrefslogtreecommitdiff
blob: 969032aa47c6c457ffb7a63b2355f053d5b6058b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?php
declare( strict_types = 1 );

namespace MediaWiki\Extension\Translate\Validation\Validators;

use MediaWiki\Extension\Translate\TranslatorInterface\Insertable\Insertable;
use MediaWiki\Extension\Translate\TranslatorInterface\Insertable\InsertablesSuggester;
use MediaWiki\Extension\Translate\Utilities\SmartFormatPlural;
use MediaWiki\Extension\Translate\Utilities\UnicodePlural;
use MediaWiki\Extension\Translate\Validation\MessageValidator;
use MediaWiki\Extension\Translate\Validation\ValidationIssue;
use MediaWiki\Extension\Translate\Validation\ValidationIssues;
use TMessage;

/**
 * @license GPL-2.0-or-later
 * @since 2019.11
 */
class SmartFormatPluralValidator implements MessageValidator, InsertablesSuggester {
	public function getIssues( TMessage $message, string $targetLanguage ): ValidationIssues {
		$issues = new ValidationIssues();

		$expectedKeywords = UnicodePlural::getPluralKeywords( $targetLanguage );
		// Skip validation for languages for which we do not know the plural rule
		if ( $expectedKeywords === null ) {
			return $issues;
		}

		$definition = $message->definition();
		$translation = $message->translation();
		$expectedPluralCount = count( $expectedKeywords );
		$definitionPlurals = SmartFormatPlural::getPluralInstances( $definition );
		$translationPlurals = SmartFormatPlural::getPluralInstances( $translation );

		$unsupportedVariables = array_diff(
			array_keys( $translationPlurals ), array_keys( $definitionPlurals )
		);

		foreach ( $unsupportedVariables as $unsupportedVariable ) {
			$issue = new ValidationIssue(
				'plural',
				'unsupported',
				'translate-checks-smartformat-plural-unsupported',
				[
					[ 'PLAIN', '{' . $unsupportedVariable . '}' ],
				]
			);

			$issues->add( $issue );
		}

		if ( $expectedPluralCount > 1 ) {
			$missingVariables = array_diff(
				array_keys( $definitionPlurals ), array_keys( $translationPlurals )
			);

			foreach ( $missingVariables as $missingVariable ) {
				$issue = new ValidationIssue(
					'plural',
					'missing',
					'translate-checks-smartformat-plural-missing',
					[
						[ 'PLAIN', '{' . $missingVariable . '}' ],
					]
				);

				$issues->add( $issue );
			}
		}

		// This returns only translation plurals for variables that exists in source
		$commonVariables = array_intersect_key( $translationPlurals, $definitionPlurals );
		foreach ( $commonVariables as $pluralInstances ) {
			foreach ( $pluralInstances as $pluralInstance ) {
				$actualPluralCount = count( $pluralInstance[ 'forms' ] );
				if ( $actualPluralCount !== $expectedPluralCount ) {
					$issue = new ValidationIssue(
						'plural',
						'forms',
						'translate-checks-smartformat-plural-count',
						[
							[ 'COUNT', $expectedPluralCount ],
							[ 'COUNT', $actualPluralCount ],
							[ 'PLAIN', $pluralInstance[ 'original' ] ],
						]
					);

					$issues->add( $issue );
				}
			}
		}

		return $issues;
	}

	public function getInsertables( string $text ): array {
		$definitionPlurals = SmartFormatPlural::getPluralInstances( $text );
		$insertables = [];

		// This could be more language specific if we were given more information, but
		// we only have text.
		foreach ( array_keys( $definitionPlurals ) as $variable ) {
			$pre = '{' . "$variable:";
			$post = '|}';
			$insertables[] = new Insertable( "$pre$post", $pre, $post );
		}

		return $insertables;
	}
}