Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
ManageTranslatorSandboxSpecialPage.php
1<?php
2declare( strict_types = 1 );
3
4namespace MediaWiki\Extension\Translate\TranslatorSandbox;
5
6use MediaWiki\Config\ServiceOptions;
7use MediaWiki\Html\Html;
8use MediaWiki\Json\FormatJson;
9use MediaWiki\Parser\Sanitizer;
10use MediaWiki\SpecialPage\SpecialPage;
11use MediaWiki\User\Options\UserOptionsLookup;
12use MediaWiki\User\User;
13use MediaWiki\Utils\MWTimestamp;
14
23class ManageTranslatorSandboxSpecialPage extends SpecialPage {
25 private $stash;
27 private $userOptionsLookup;
28 private TranslateSandbox $translateSandbox;
29
30 public const CONSTRUCTOR_OPTIONS = [
31 'TranslateUseSandbox',
32 ];
33
34 public function __construct(
35 TranslationStashReader $stash,
36 UserOptionsLookup $userOptionsLookup,
37 TranslateSandbox $translateSandbox,
38 ServiceOptions $options
39 ) {
40 $this->stash = $stash;
41 $this->userOptionsLookup = $userOptionsLookup;
42 $this->translateSandbox = $translateSandbox;
43
44 parent::__construct(
45 'ManageTranslatorSandbox',
46 'translate-sandboxmanage',
47 $options->get( 'TranslateUseSandbox' )
48 );
49 }
50
52 public function doesWrites() {
53 return true;
54 }
55
56 protected function getGroupName(): string {
57 return 'translation';
58 }
59
61 public function execute( $params ) {
62 $this->setHeaders();
63 $this->checkPermissions();
64 $this->outputHeader();
65 $out = $this->getOutput();
66 $out->addModuleStyles(
67 [
68 'ext.translate.special.managetranslatorsandbox.styles',
69 'mediawiki.ui.button',
70 'jquery.uls.grid',
71 'mediawiki.codex.messagebox.styles',
72 ]
73 );
74 $out->addModules( 'ext.translate.special.managetranslatorsandbox' );
75
76 $this->showPage();
77 }
78
80 private function showPage(): void {
81 $out = $this->getOutput();
82
83 $nojs = Html::errorBox(
84 $this->msg( 'tux-nojs' )->escaped(),
85 '',
86 'tux-nojs'
87 );
88 $out->addHTML( $nojs );
89
90 $out->addHTML(
91 <<<HTML
92 <div class="grid tsb-container">
93 <div class="row">
94 <div class="nine columns pane filter">{$this->makeFilter()}</div>
95 <div class="three columns pane search">{$this->makeSearchBox()}</div>
96 </div>
97 <div class="row tsb-body">
98 <div class="four columns pane requests">
99 {$this->makeList()}
100 <div class="request-footer">
101 <span class="selected-counter">
102 {$this->msg( 'tsb-selected-count' )->numParams( 0 )->escaped()}
103 </span>
104 \u{00A0}
105 <a href="#" class="older-requests-indicator"></a>
106 </div>
107 </div>
108 <div class="eight columns pane details"></div>
109 </div>
110 </div>
111 HTML
112 );
113 }
114
115 private function makeFilter(): string {
116 return $this->msg( 'tsb-filter-pending' )->escaped();
117 }
118
119 private function makeSearchBox(): string {
120 return <<<HTML
121 <input class="request-filter-box right"
122 placeholder="{$this->msg( 'tsb-search-requests' )->escaped()}" type="search" />
123 HTML;
124 }
125
126 private function makeList(): string {
127 $items = [];
128 $requests = [];
129 $users = $this->translateSandbox->getUsers();
130
132 foreach ( $users as $user ) {
133 $reminders = $this->userOptionsLookup->getOption( $user, 'translate-sandbox-reminders' );
134 $reminders = $reminders ? explode( '|', $reminders ) : [];
135 $remindersCount = count( $reminders );
136 if ( $remindersCount ) {
137 $lastReminderTimestamp = new MWTimestamp( end( $reminders ) );
138 $lastReminderRfcTimestamp = $lastReminderTimestamp->getTimestamp( TS_RFC2822 );
139 $lastReminderAgo = htmlspecialchars(
140 $this->getHumanTimestamp( $lastReminderTimestamp )
141 );
142 } else {
143 $lastReminderAgo = '';
144 $lastReminderRfcTimestamp = '';
145 }
146
147 $requests[] = [
148 'username' => $user->getName(),
149 'email' => $user->getEmail(),
150 'gender' => $this->userOptionsLookup->getOption( $user, 'gender' ),
151 'registrationdate' => $user->getRegistration(),
152 'translations' => count( $this->stash->getTranslations( $user ) ),
153 'languagepreferences' => FormatJson::decode(
154 $this->userOptionsLookup->getOption( $user, 'translate-sandbox' )
155 ),
156 'userid' => $user->getId(),
157 'reminderscount' => $remindersCount,
158 'lastreminder' => $lastReminderAgo,
159 'lastreminderts' => $lastReminderRfcTimestamp
160 ];
161 }
162
163 // Sort the requests based on translations and registration date
164 usort( $requests, [ $this, 'translatorRequestSort' ] );
165
166 foreach ( $requests as $request ) {
167 $items[] = $this->makeRequestItem( $request );
168 }
169
170 $requestsList = implode( "\n", $items );
171
172 return <<<HTML
173 <div class="row request-header">
174 <div class="four columns">
175 <button class="language-selector unselected">
176 {$this->msg( 'tsb-all-languages-button-label' )->escaped()}
177 </button>
178 </div>
179 <div class="five columns request-count"></div>
180 <div class="three columns text-center">
181 <input class="request-selector-all" name="request" type="checkbox" />
182 </div>
183 </div>
184 <div class="requests-list">
185 {$requestsList}
186 </div>
187 HTML;
188 }
189
190 private function makeRequestItem( array $request ): string {
191 $requestdataEnc = htmlspecialchars( FormatJson::encode( $request ) );
192 $nameEnc = htmlspecialchars( $request['username'] );
193 $nameEncForId =
194 htmlspecialchars(
195 Sanitizer::escapeIdForAttribute( 'tsb-request-' . $request['username'] )
196 );
197 $emailEnc = htmlspecialchars( $request['email'] );
198 $countEnc = htmlspecialchars( (string)$request['translations'] );
199 $timestamp = new MWTimestamp( $request['registrationdate'] );
200 $agoEnc = htmlspecialchars( $this->getHumanTimestamp( $timestamp ) );
201
202 return <<<HTML
203 <div class="row request" data-data="$requestdataEnc" id="$nameEncForId">
204 <div class="two columns amount">
205 <div class="translation-count">$countEnc</div>
206 </div>
207 <div class="seven columns request-info">
208 <div class="row username">$nameEnc</div>
209 <div class="row email" dir="ltr">$emailEnc</div>
210 </div>
211 <div class="three columns approval text-center">
212 <input class="row request-selector" name="request" type="checkbox" />
213 <div class="row signup-age">$agoEnc</div>
214 </div>
215 </div>
216 HTML;
217 }
218
219 private function getHumanTimestamp( MWTimestamp $ts ): string {
220 return $this->getLanguage()->getHumanTimestamp( $ts, null, $this->getUser() );
221 }
222
227 private function translatorRequestSort( array $a, array $b ): int {
228 return $b['translations'] <=> $a['translations']
229 ?: $b['registrationdate'] <=> $a['registrationdate']
230 ?: strnatcasecmp( $a['username'], $b['username'] );
231 }
232}
return
return[ 'Translate:AggregateGroupManager'=> static function(MediaWikiServices $services):AggregateGroupManager { return new AggregateGroupManager($services->getTitleFactory(), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:AggregateGroupMessageGroupFactory'=> static function(MediaWikiServices $services):AggregateGroupMessageGroupFactory { return new AggregateGroupMessageGroupFactory($services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:ConfigHelper'=> static function():ConfigHelper { return new ConfigHelper();}, 'Translate:CsvTranslationImporter'=> static function(MediaWikiServices $services):CsvTranslationImporter { return new CsvTranslationImporter( $services->getWikiPageFactory());}, 'Translate:EntitySearch'=> static function(MediaWikiServices $services):EntitySearch { return new EntitySearch($services->getMainWANObjectCache(), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), MessageGroups::singleton(), $services->getNamespaceInfo(), $services->get( 'Translate:MessageIndex'), $services->getTitleParser(), $services->getTitleFormatter());}, 'Translate:ExternalMessageSourceStateComparator'=> static function(MediaWikiServices $services):ExternalMessageSourceStateComparator { return new ExternalMessageSourceStateComparator(new SimpleStringComparator(), $services->getRevisionLookup(), $services->getPageStore());}, 'Translate:ExternalMessageSourceStateImporter'=> static function(MediaWikiServices $services):ExternalMessageSourceStateImporter { return new ExternalMessageSourceStateImporter($services->get( 'Translate:GroupSynchronizationCache'), $services->getJobQueueGroup(), LoggerFactory::getInstance(LogNames::GROUP_SYNCHRONIZATION), $services->get( 'Translate:MessageIndex'), $services->getTitleFactory(), $services->get( 'Translate:MessageGroupSubscription'), new ServiceOptions(ExternalMessageSourceStateImporter::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:FileBasedMessageGroupFactory'=> static function(MediaWikiServices $services):FileBasedMessageGroupFactory { return new FileBasedMessageGroupFactory(new MessageGroupConfigurationParser(), $services->getContentLanguageCode() ->toString(), new ServiceOptions(FileBasedMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:FileFormatFactory'=> static function(MediaWikiServices $services):FileFormatFactory { return new FileFormatFactory( $services->getObjectFactory());}, 'Translate:GroupSynchronizationCache'=> static function(MediaWikiServices $services):GroupSynchronizationCache { return new GroupSynchronizationCache( $services->get( 'Translate:PersistentCache'));}, 'Translate:HookDefinedMessageGroupFactory'=> static function(MediaWikiServices $services):HookDefinedMessageGroupFactory { return new HookDefinedMessageGroupFactory( $services->get( 'Translate:HookRunner'));}, 'Translate:HookRunner'=> static function(MediaWikiServices $services):HookRunner { return new HookRunner( $services->getHookContainer());}, 'Translate:MessageBundleDependencyPurger'=> static function(MediaWikiServices $services):MessageBundleDependencyPurger { return new MessageBundleDependencyPurger( $services->get( 'Translate:TranslatableBundleFactory'));}, 'Translate:MessageBundleMessageGroupFactory'=> static function(MediaWikiServices $services):MessageBundleMessageGroupFactory { return new MessageBundleMessageGroupFactory($services->get( 'Translate:MessageGroupMetadata'), new ServiceOptions(MessageBundleMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:MessageBundleStore'=> static function(MediaWikiServices $services):MessageBundleStore { return new MessageBundleStore($services->get( 'Translate:RevTagStore'), $services->getJobQueueGroup(), $services->getLanguageNameUtils(), $services->get( 'Translate:MessageIndex'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:MessageBundleTranslationLoader'=> static function(MediaWikiServices $services):MessageBundleTranslationLoader { return new MessageBundleTranslationLoader( $services->getLanguageFallback());}, 'Translate:MessageGroupMetadata'=> static function(MediaWikiServices $services):MessageGroupMetadata { return new MessageGroupMetadata( $services->getConnectionProvider());}, 'Translate:MessageGroupReviewStore'=> static function(MediaWikiServices $services):MessageGroupReviewStore { return new MessageGroupReviewStore($services->getConnectionProvider(), $services->get( 'Translate:HookRunner'));}, 'Translate:MessageGroupStatsTableFactory'=> static function(MediaWikiServices $services):MessageGroupStatsTableFactory { return new MessageGroupStatsTableFactory($services->get( 'Translate:ProgressStatsTableFactory'), $services->getLinkRenderer(), $services->get( 'Translate:MessageGroupReviewStore'), $services->get( 'Translate:MessageGroupMetadata'), $services->getMainConfig() ->get( 'TranslateWorkflowStates') !==false);}, 'Translate:MessageGroupSubscription'=> static function(MediaWikiServices $services):MessageGroupSubscription { return new MessageGroupSubscription($services->get( 'Translate:MessageGroupSubscriptionStore'), $services->getJobQueueGroup(), $services->getUserIdentityLookup(), LoggerFactory::getInstance(LogNames::GROUP_SUBSCRIPTION), new ServiceOptions(MessageGroupSubscription::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:MessageGroupSubscriptionHookHandler'=> static function(MediaWikiServices $services):?MessageGroupSubscriptionHookHandler { if(! $services->getExtensionRegistry() ->isLoaded( 'Echo')) { return null;} return new MessageGroupSubscriptionHookHandler($services->get( 'Translate:MessageGroupSubscription'), $services->getUserFactory());}, 'Translate:MessageGroupSubscriptionStore'=> static function(MediaWikiServices $services):MessageGroupSubscriptionStore { return new MessageGroupSubscriptionStore( $services->getConnectionProvider());}, 'Translate:MessageIndex'=> static function(MediaWikiServices $services):MessageIndex { $params=(array) $services->getMainConfig() ->get( 'TranslateMessageIndex');$class=array_shift( $params);$implementationMap=['HashMessageIndex'=> HashMessageIndex::class, 'CDBMessageIndex'=> CDBMessageIndex::class, 'DatabaseMessageIndex'=> DatabaseMessageIndex::class, 'hash'=> HashMessageIndex::class, 'cdb'=> CDBMessageIndex::class, 'database'=> DatabaseMessageIndex::class,];$messageIndexStoreClass=$implementationMap[$class] ?? $implementationMap['database'];return new MessageIndex(new $messageIndexStoreClass, $services->getMainWANObjectCache(), $services->getJobQueueGroup(), $services->get( 'Translate:HookRunner'), LoggerFactory::getInstance(LogNames::MAIN), $services->getMainObjectStash(), $services->getConnectionProvider(), new ServiceOptions(MessageIndex::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:MessagePrefixStats'=> static function(MediaWikiServices $services):MessagePrefixStats { return new MessagePrefixStats( $services->getTitleParser());}, 'Translate:ParsingPlaceholderFactory'=> static function():ParsingPlaceholderFactory { return new ParsingPlaceholderFactory();}, 'Translate:PersistentCache'=> static function(MediaWikiServices $services):PersistentCache { return new PersistentDatabaseCache($services->getConnectionProvider(), $services->getJsonCodec());}, 'Translate:ProgressStatsTableFactory'=> static function(MediaWikiServices $services):ProgressStatsTableFactory { return new ProgressStatsTableFactory($services->getLinkRenderer(), $services->get( 'Translate:ConfigHelper'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:RevTagStore'=> static function(MediaWikiServices $services):RevTagStore { return new RevTagStore( $services->getConnectionProvider());}, 'Translate:SubpageListBuilder'=> static function(MediaWikiServices $services):SubpageListBuilder { return new SubpageListBuilder($services->get( 'Translate:TranslatableBundleFactory'), $services->getLinkBatchFactory());}, 'Translate:TranslatableBundleDeleter'=> static function(MediaWikiServices $services):TranslatableBundleDeleter { return new TranslatableBundleDeleter($services->getMainObjectStash(), $services->getJobQueueGroup(), $services->get( 'Translate:SubpageListBuilder'), $services->get( 'Translate:TranslatableBundleFactory'));}, 'Translate:TranslatableBundleExporter'=> static function(MediaWikiServices $services):TranslatableBundleExporter { return new TranslatableBundleExporter($services->get( 'Translate:SubpageListBuilder'), $services->getWikiExporterFactory(), $services->getConnectionProvider());}, 'Translate:TranslatableBundleFactory'=> static function(MediaWikiServices $services):TranslatableBundleFactory { return new TranslatableBundleFactory($services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:MessageBundleStore'));}, 'Translate:TranslatableBundleImporter'=> static function(MediaWikiServices $services):TranslatableBundleImporter { return new TranslatableBundleImporter($services->getWikiImporterFactory(), $services->get( 'Translate:TranslatablePageParser'), $services->getRevisionLookup(), $services->getNamespaceInfo(), $services->getTitleFactory(), $services->getFormatterFactory());}, 'Translate:TranslatableBundleMover'=> static function(MediaWikiServices $services):TranslatableBundleMover { return new TranslatableBundleMover($services->getMovePageFactory(), $services->getJobQueueGroup(), $services->getLinkBatchFactory(), $services->get( 'Translate:TranslatableBundleFactory'), $services->get( 'Translate:SubpageListBuilder'), $services->getConnectionProvider(), $services->getObjectCacheFactory(), $services->getMainConfig() ->get( 'TranslatePageMoveLimit'));}, 'Translate:TranslatableBundleStatusStore'=> static function(MediaWikiServices $services):TranslatableBundleStatusStore { return new TranslatableBundleStatusStore($services->getConnectionProvider() ->getPrimaryDatabase(), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), $services->getDBLoadBalancer() ->getMaintenanceConnectionRef(DB_PRIMARY));}, 'Translate:TranslatablePageMarker'=> static function(MediaWikiServices $services):TranslatablePageMarker { return new TranslatablePageMarker($services->getConnectionProvider(), $services->getJobQueueGroup(), $services->getLinkRenderer(), MessageGroups::singleton(), $services->get( 'Translate:MessageIndex'), $services->getTitleFormatter(), $services->getTitleParser(), $services->get( 'Translate:TranslatablePageParser'), $services->get( 'Translate:TranslatablePageStore'), $services->get( 'Translate:TranslatablePageStateStore'), $services->get( 'Translate:TranslationUnitStoreFactory'), $services->get( 'Translate:MessageGroupMetadata'), $services->getWikiPageFactory(), $services->get( 'Translate:TranslatablePageView'), $services->get( 'Translate:MessageGroupSubscription'), $services->getFormatterFactory(), $services->get( 'Translate:HookRunner'),);}, 'Translate:TranslatablePageMessageGroupFactory'=> static function(MediaWikiServices $services):TranslatablePageMessageGroupFactory { return new TranslatablePageMessageGroupFactory(new ServiceOptions(TranslatablePageMessageGroupFactory::SERVICE_OPTIONS, $services->getMainConfig()),);}, 'Translate:TranslatablePageParser'=> static function(MediaWikiServices $services):TranslatablePageParser { return new TranslatablePageParser($services->get( 'Translate:ParsingPlaceholderFactory'));}, 'Translate:TranslatablePageStateStore'=> static function(MediaWikiServices $services):TranslatablePageStateStore { return new TranslatablePageStateStore($services->get( 'Translate:PersistentCache'), $services->getPageStore());}, 'Translate:TranslatablePageStore'=> static function(MediaWikiServices $services):TranslatablePageStore { return new TranslatablePageStore($services->get( 'Translate:MessageIndex'), $services->getJobQueueGroup(), $services->get( 'Translate:RevTagStore'), $services->getConnectionProvider(), $services->get( 'Translate:TranslatableBundleStatusStore'), $services->get( 'Translate:TranslatablePageParser'), $services->get( 'Translate:MessageGroupMetadata'));}, 'Translate:TranslatablePageView'=> static function(MediaWikiServices $services):TranslatablePageView { return new TranslatablePageView($services->getConnectionProvider(), $services->get( 'Translate:TranslatablePageStateStore'), new ServiceOptions(TranslatablePageView::SERVICE_OPTIONS, $services->getMainConfig()));}, 'Translate:TranslateSandbox'=> static function(MediaWikiServices $services):TranslateSandbox { return new TranslateSandbox($services->getUserFactory(), $services->getConnectionProvider(), $services->getPermissionManager(), $services->getAuthManager(), $services->getUserGroupManager(), $services->getActorStore(), $services->getUserOptionsManager(), $services->getJobQueueGroup(), $services->get( 'Translate:HookRunner'), new ServiceOptions(TranslateSandbox::CONSTRUCTOR_OPTIONS, $services->getMainConfig()));}, 'Translate:TranslationStashReader'=> static function(MediaWikiServices $services):TranslationStashReader { return new TranslationStashStorage( $services->getConnectionProvider() ->getPrimaryDatabase());}, 'Translate:TranslationStatsDataProvider'=> static function(MediaWikiServices $services):TranslationStatsDataProvider { return new TranslationStatsDataProvider(new ServiceOptions(TranslationStatsDataProvider::CONSTRUCTOR_OPTIONS, $services->getMainConfig()), $services->getObjectFactory(), $services->getConnectionProvider());}, 'Translate:TranslationUnitStoreFactory'=> static function(MediaWikiServices $services):TranslationUnitStoreFactory { return new TranslationUnitStoreFactory( $services->getDBLoadBalancer());}, 'Translate:TranslatorActivity'=> static function(MediaWikiServices $services):TranslatorActivity { $query=new TranslatorActivityQuery($services->getMainConfig(), $services->getDBLoadBalancer());return new TranslatorActivity($services->getMainObjectStash(), $query, $services->getJobQueueGroup());}, 'Translate:TtmServerFactory'=> static function(MediaWikiServices $services):TtmServerFactory { $config=$services->getMainConfig();$default=$config->get( 'TranslateTranslationDefaultService');if( $default===false) { $default=null;} return new TtmServerFactory( $config->get( 'TranslateTranslationServices'), $default);}, 'Translate:WorkflowStatesMessageGroupLoader'=> static function(MediaWikiServices $services):WorkflowStatesMessageGroupLoader { return new WorkflowStatesMessageGroupLoader(new ServiceOptions(WorkflowStatesMessageGroupLoader::CONSTRUCTOR_OPTIONS, $services->getMainConfig()),);},]
@phpcs-require-sorted-array
Definition ServiceWiring.php:543
MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox
Utility class for the sandbox feature of Translate.
Definition TranslateSandbox.php:38