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 {
24
25 public const CONSTRUCTOR_OPTIONS = [
26 'TranslateUseSandbox',
27 ];
28
29 public function __construct(
30 private readonly TranslationStashReader $stash,
31 private readonly UserOptionsLookup $userOptionsLookup,
32 private readonly TranslateSandbox $translateSandbox,
33 private readonly ServiceOptions $options,
34 ) {
35 parent::__construct( 'ManageTranslatorSandbox' );
36 $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
37 }
38
40 public function getRestriction(): string {
41 return 'translate-sandboxmanage';
42 }
43
44 public function isListed(): bool {
45 return $this->options->get( 'TranslateUseSandbox' );
46 }
47
49 public function doesWrites() {
50 return true;
51 }
52
53 protected function getGroupName(): string {
54 return 'translation';
55 }
56
58 public function execute( $params ) {
59 $this->setHeaders();
60 $this->checkPermissions();
61 $this->outputHeader();
62 $out = $this->getOutput();
63 $out->addModuleStyles(
64 [
65 'ext.translate.special.managetranslatorsandbox.styles',
66 'codex-styles',
67 'jquery.uls.grid',
68 'mediawiki.codex.messagebox.styles',
69 ]
70 );
71 $out->addModules( 'ext.translate.special.managetranslatorsandbox' );
72
73 $this->showPage();
74 }
75
77 private function showPage(): void {
78 $out = $this->getOutput();
79
80 $nojs = Html::errorBox(
81 $this->msg( 'tux-nojs' )->escaped(),
82 '',
83 'tux-nojs'
84 );
85 $out->addHTML( $nojs );
86
87 $out->addHTML(
88 <<<HTML
89 <div class="grid tsb-container">
90 <div class="row">
91 <div class="nine columns pane filter">{$this->makeFilter()}</div>
92 <div class="three columns pane search">{$this->makeSearchBox()}</div>
93 </div>
94 <div class="row tsb-body">
95 <div class="four columns pane requests">
96 {$this->makeList()}
97 <div class="request-footer">
98 <span class="selected-counter">
99 {$this->msg( 'tsb-selected-count' )->numParams( 0 )->escaped()}
100 </span>
101 \u{00A0}
102 <a href="#" class="older-requests-indicator"></a>
103 </div>
104 </div>
105 <div class="eight columns pane details"></div>
106 </div>
107 </div>
108 HTML
109 );
110 }
111
112 private function makeFilter(): string {
113 return $this->msg( 'tsb-filter-pending' )->escaped();
114 }
115
116 private function makeSearchBox(): string {
117 return <<<HTML
118 <input class="request-filter-box right"
119 placeholder="{$this->msg( 'tsb-search-requests' )->escaped()}" type="search" />
120 HTML;
121 }
122
123 private function makeList(): string {
124 $items = [];
125 $requests = [];
126 $users = $this->translateSandbox->getUsers();
127
129 foreach ( $users as $user ) {
130 $reminders = $this->userOptionsLookup->getOption( $user, 'translate-sandbox-reminders' );
131 $reminders = $reminders ? explode( '|', $reminders ) : [];
132 $remindersCount = count( $reminders );
133 if ( $remindersCount ) {
134 $lastReminderTimestamp = new MWTimestamp( end( $reminders ) );
135 $lastReminderRfcTimestamp = $lastReminderTimestamp->getTimestamp( TS_RFC2822 );
136 $lastReminderAgo = htmlspecialchars(
137 $this->getHumanTimestamp( $lastReminderTimestamp )
138 );
139 } else {
140 $lastReminderAgo = '';
141 $lastReminderRfcTimestamp = '';
142 }
143
144 $requests[] = [
145 'username' => $user->getName(),
146 'email' => $user->getEmail(),
147 'gender' => $this->userOptionsLookup->getOption( $user, 'gender' ),
148 'registrationdate' => $user->getRegistration(),
149 'translations' => count( $this->stash->getTranslations( $user ) ),
150 'languagepreferences' => FormatJson::decode(
151 $this->userOptionsLookup->getOption( $user, 'translate-sandbox' )
152 ),
153 'userid' => $user->getId(),
154 'reminderscount' => $remindersCount,
155 'lastreminder' => $lastReminderAgo,
156 'lastreminderts' => $lastReminderRfcTimestamp
157 ];
158 }
159
160 // Sort the requests based on translations and registration date
161 usort( $requests, [ $this, 'translatorRequestSort' ] );
162
163 foreach ( $requests as $request ) {
164 $items[] = $this->makeRequestItem( $request );
165 }
166
167 $requestsList = implode( "\n", $items );
168
169 return <<<HTML
170 <div class="row request-header">
171 <div class="four columns">
172 <button class="language-selector unselected">
173 {$this->msg( 'tsb-all-languages-button-label' )->escaped()}
174 </button>
175 </div>
176 <div class="five columns request-count"></div>
177 <div class="three columns text-center">
178 <input class="request-selector-all" name="request" type="checkbox" />
179 </div>
180 </div>
181 <div class="requests-list">
182 {$requestsList}
183 </div>
184 HTML;
185 }
186
187 private function makeRequestItem( array $request ): string {
188 $requestdataEnc = htmlspecialchars( FormatJson::encode( $request ) );
189 $nameEnc = htmlspecialchars( $request['username'] );
190 $nameEncForId =
191 htmlspecialchars(
192 Sanitizer::escapeIdForAttribute( 'tsb-request-' . $request['username'] )
193 );
194 $emailEnc = htmlspecialchars( $request['email'] );
195 $countEnc = htmlspecialchars( (string)$request['translations'] );
196 $timestamp = new MWTimestamp( $request['registrationdate'] );
197 $agoEnc = htmlspecialchars( $this->getHumanTimestamp( $timestamp ) );
198
199 return <<<HTML
200 <div class="row request" data-data="$requestdataEnc" id="$nameEncForId">
201 <div class="two columns amount">
202 <div class="translation-count">$countEnc</div>
203 </div>
204 <div class="seven columns request-info">
205 <div class="row username">$nameEnc</div>
206 <div class="row email" dir="ltr">$emailEnc</div>
207 </div>
208 <div class="three columns approval text-center">
209 <input class="row request-selector" name="request" type="checkbox" />
210 <div class="row signup-age">$agoEnc</div>
211 </div>
212 </div>
213 HTML;
214 }
215
216 private function getHumanTimestamp( MWTimestamp $ts ): string {
217 return $this->getLanguage()->getHumanTimestamp( $ts, null, $this->getUser() );
218 }
219
224 private function translatorRequestSort( array $a, array $b ): int {
225 return $b['translations'] <=> $a['translations']
226 ?: $b['registrationdate'] <=> $a['registrationdate']
227 ?: strnatcasecmp( $a['username'], $b['username'] );
228 }
229}
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->getConnectionProvider());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