summaryrefslogtreecommitdiff
blob: fb05687348195f5ed1b5518665d760fbcc114f21 (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
<?php
declare( strict_types = 1 );

namespace MediaWiki\Extension\Translate\Validation\Validators;

use InvalidArgumentException;
use MediaWiki\Extension\Translate\TranslatorInterface\Insertable\RegexInsertablesSuggester;
use MediaWiki\Extension\Translate\Validation\MessageValidator;
use MediaWiki\Extension\Translate\Validation\ValidationIssue;
use MediaWiki\Extension\Translate\Validation\ValidationIssues;
use TMessage;

/**
 * A generic regex validator and insertable that can be reused by other classes.
 * @author Abijeet Patro
 * @license GPL-2.0-or-later
 * @since 2019.06
 */
class InsertableRegexValidator extends RegexInsertablesSuggester implements MessageValidator {
	/** @var string */
	private $validationRegex;

	public function __construct( $params ) {
		parent::__construct( $params );

		if ( is_string( $params ) ) {
			$this->validationRegex = $params;
		} elseif ( is_array( $params ) ) {
			$this->validationRegex = $params['regex'] ?? null;
		}

		if ( $this->validationRegex === null ) {
			throw new InvalidArgumentException( 'The configuration for InsertableRegexValidator does not ' .
				'specify a regular expression.' );
		}
	}

	public function getIssues( TMessage $message, string $targetLanguage ): ValidationIssues {
		$issues = new ValidationIssues();

		preg_match_all( $this->validationRegex, $message->definition(), $definitionMatch );
		preg_match_all( $this->validationRegex, $message->translation(), $translationMatch );
		$definitionVariables = $definitionMatch[0];
		$translationVariables = $translationMatch[0];

		$missingVariables = array_diff( $definitionVariables, $translationVariables );
		if ( $missingVariables ) {
			$issue = new ValidationIssue(
				'variable',
				'missing',
				'translate-checks-parameters',
				[
					[ 'PLAIN-PARAMS', $missingVariables ],
					[ 'COUNT', count( $missingVariables ) ]
				]
			);

			$issues->add( $issue );
		}

		$unknownVariables = array_diff( $translationVariables, $definitionVariables );
		if ( $unknownVariables ) {
			$issue = new ValidationIssue(
				'variable',
				'unknown',
				'translate-checks-parameters-unknown',
				[
					[ 'PLAIN-PARAMS', $unknownVariables ],
					[ 'COUNT', count( $unknownVariables ) ]
				]
			);

			$issues->add( $issue );
		}

		return $issues;
	}
}

class_alias( InsertableRegexValidator::class, '\MediaWiki\Extensions\Translate\InsertableRegexValidator' );