Translate extension for MediaWiki
Loading...
Searching...
No Matches
MessageGroupStatsTable.php
1<?php
2declare( strict_types = 1 );
3
4namespace MediaWiki\Extension\Translate\Statistics;
5
6use MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore;
7use MediaWiki\Extension\Translate\MessageGroups\MessageGroup;
8use MediaWiki\Extension\Translate\MessageProcessing\MessageGroupMetadata;
9use MediaWiki\Extension\Translate\Utilities\Utilities;
10use MediaWiki\Html\Html;
11use MediaWiki\Language\Language;
12use MediaWiki\Language\MessageLocalizer;
13use MediaWiki\Linker\LinkRenderer;
14use MediaWiki\SpecialPage\SpecialPage;
15use MediaWiki\Title\Title;
16
24
26 private bool $incompleteStats;
27 private array $languageNames;
28 private Title $translateTitle;
30 private array $states;
31
32 public function __construct(
33 private readonly StatsTable $table,
34 private readonly LinkRenderer $linkRenderer,
35 private readonly MessageLocalizer $localizer,
36 private readonly Language $interfaceLanguage,
37 private readonly MessageGroupReviewStore $groupReviewStore,
38 private readonly MessageGroupMetadata $messageGroupMetadata,
39 private readonly bool $haveTranslateWorkflowStates,
40 ) {
41 $this->incompleteStats = false;
42 $this->languageNames = Utilities::getLanguageNames( $this->interfaceLanguage->getCode() );
43 $this->translateTitle = SpecialPage::getTitleFor( 'Translate' );
44 }
45
46 public function get(
47 array $stats,
48 MessageGroup $group,
49 bool $noComplete,
50 bool $noEmpty
51 ): ?string {
52 $out = '';
53 $rowCount = 0;
55 $groupId = $group->getId();
56
57 $languages = array_keys(
58 Utilities::getLanguageNames( $this->interfaceLanguage->getCode() )
59 );
60 sort( $languages );
61 $this->filterPriorityLangs( $languages, $groupId, $stats );
62
63 // If workflow states are configured, adds a workflow states column
64 if ( $this->haveTranslateWorkflowStates ) {
65 $this->table->addExtraColumn( $this->localizer->msg( 'translate-stats-workflow' ) );
66 }
67
68 foreach ( $languages as $code ) {
69 if ( $this->table->isExcluded( $group, $code ) ) {
70 continue;
71 }
72
73 $languageStats = $stats[$code];
74 $row = $this->makeRow(
75 $this->table,
76 $code,
77 $languageStats,
78 $group,
79 $rowCount,
80 $noComplete,
81 $noEmpty
82 );
83 if ( $row ) {
84 $rowCount += 1;
85 $out .= $row;
86 $totals = MessageGroupStats::multiAdd( $totals, $languageStats );
87 }
88 }
89
90 if ( $out ) {
91 $this->table->setMainColumnHeader( $this->localizer->msg( 'translate-mgs-column-language' ) );
92 $out = $this->table->createHeader() . "\n" . $out;
93 $out .= Html::closeElement( 'tbody' );
94
95 $out .= Html::openElement( 'tfoot' );
96 $out .= $this->table->makeTotalRow(
97 $this->localizer->msg( 'translate-mgs-totals' )->numParams( $rowCount ),
98 $totals
99 );
100 $out .= Html::closeElement( 'tfoot' );
101
102 $out .= Html::closeElement( 'table' );
103
104 return $out;
105 } else {
106 return null;
107 }
108 }
109
110 public function areStatsIncomplete(): bool {
111 return $this->incompleteStats;
112 }
113
114 private function makeRow(
115 StatsTable $table,
116 string $languageCode,
117 array $stats,
118 MessageGroup $group,
119 int $rowCount,
120 bool $noComplete,
121 bool $noEmpty
122 ): ?string {
123 $total = $stats[MessageGroupStats::TOTAL];
124 $translated = $stats[MessageGroupStats::TRANSLATED];
125 $fuzzy = $stats[MessageGroupStats::FUZZY];
126 $extra = [];
127
128 if ( $total === null ) {
129 $this->incompleteStats = true;
130 } else {
131 if ( $noComplete && $fuzzy === 0 && $translated === $total ) {
132 return null;
133 }
134
135 if ( $noEmpty && $translated === 0 && $fuzzy === 0 ) {
136 return null;
137 }
138
139 // Skip below 2% if "don't show without translations" is checked.
140 if ( $noEmpty && ( $translated / $total ) < 0.02 ) {
141 return null;
142 }
143
144 if ( $translated === $total ) {
145 $extra = [ 'action' => 'proofread' ];
146 }
147 }
148
149 $rowParams = [];
150 if ( $rowCount % 2 === 0 ) {
151 $rowParams[ 'class' ] = 'tux-statstable-even';
152 }
153
154 $out = "\t" . Html::openElement( 'tr', $rowParams );
155 $out .= "\n\t\t" . $this->getMainColumnCell( $languageCode, $extra, $group->getId() );
156 $out .= $table->makeNumberColumns( $stats );
157 $out .= $this->getWorkflowStateCell( $table, $languageCode, $group );
158
159 $out .= "\n\t" . Html::closeElement( 'tr' ) . "\n";
160
161 return $out;
162 }
163
164 private function getMainColumnCell( string $code, array $params, string $groupId ): string {
165 if ( isset( $this->languageNames[$code] ) ) {
166 $text = "$code: {$this->languageNames[$code]}";
167 } else {
168 $text = $code;
169 }
170
171 // Do not render links when generating table for MessagePrefixMessageGroup
172 // as this is a dynamic group whose contents are based on user input
173 if ( $groupId === '!prefix' ) {
174 return Html::rawElement( 'td', [], $text );
175 }
176
177 $queryParameters = $params + [
178 'group' => $groupId,
179 'language' => $code
180 ];
181
182 $link = $this->linkRenderer->makeKnownLink(
183 $this->translateTitle,
184 $text,
185 [],
186 $queryParameters
187 );
188
189 return Html::rawElement( 'td', [], $link );
190 }
191
193 private function getWorkflowStateCell( StatsTable $table, string $language, MessageGroup $group ): string {
194 if ( !$this->haveTranslateWorkflowStates ) {
195 return '';
196 }
197
198 $this->states ??= $this->groupReviewStore->getWorkflowStatesForGroup( $group->getId() );
199 return $table->makeWorkflowStateCell( $this->states[$language] ?? null, $group, $language );
200 }
201
207 private function filterPriorityLangs( array &$languages, string $group, array $cache ): void {
208 $filterLangs = $this->messageGroupMetadata->get( $group, 'prioritylangs' );
209 if ( $filterLangs === false || strlen( $filterLangs ) === 0 ) {
210 // No restrictions, keep everything
211 return;
212 }
213 $filter = array_flip( explode( ',', $filterLangs ) );
214 foreach ( $languages as $id => $code ) {
215 if ( isset( $filter[$code] ) ) {
216 continue;
217 }
218 $translated = $cache[$code][1];
219 if ( $translated === 0 ) {
220 unset( $languages[$id] );
221 }
222 }
223 }
224}
Provides methods to get and change the state of a message group.
Offers functionality for reading and updating Translate group related metadata.
Used to build the table displayed on Special:MessageGroupStats.
Implements generation of HTML stats table.