Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MicrosoftWebService.php
1<?php
2declare( strict_types = 1 );
3
4namespace MediaWiki\Extension\Translate\WebService;
5
6use MediaWiki\Http\HttpRequestFactory;
7
18 private HttpRequestFactory $httpRequestFactory;
19
20 public function __construct(
21 HttpRequestFactory $httpRequestFactory,
22 string $serviceName,
23 array $config
24 ) {
25 parent::__construct( $serviceName, $config );
26 $this->httpRequestFactory = $httpRequestFactory;
27 }
28
30 public function getType(): string {
31 return 'mt';
32 }
33
35 protected function mapCode( string $code ): string {
36 $map = [
37 'tl' => 'fil',
38 'zh-hant' => 'zh-Hant',
39 'zh-hans' => 'zh-Hans',
40 'sr-ec' => 'sr-Cyrl',
41 'sr-el' => 'sr-Latn',
42 'pt-br' => 'pt',
43 ];
44
45 return $map[$code] ?? $code;
46 }
47
49 protected function doPairs(): array {
50 if ( !isset( $this->config['key'] ) ) {
51 throw new TranslationWebServiceConfigurationException( 'key is not set' );
52 }
53
54 $key = $this->config['key'];
55
56 $options = [];
57 $options['method'] = 'GET';
58 $options['timeout'] = $this->config['timeout'];
59
60 $url = $this->config['url'] . '/languages?api-version=3.0';
61
62 $req = $this->httpRequestFactory->create( $url, $options, __METHOD__ );
63 $req->setHeader( 'Ocp-Apim-Subscription-Key', $key );
64
65 $status = $req->execute();
66 if ( !$status->isOK() ) {
67 $error = $req->getContent();
68 // Most likely a timeout or other general error
70 'HttpRequestFactory::get failed:' . serialize( $error ) . serialize( $status )
71 );
72 }
73
74 $json = $req->getContent();
75 $response = json_decode( $json, true );
76 if ( !isset( $response[ 'translation' ] ) ) {
77 throw new TranslationWebServiceException(
78 'Unable to fetch list of available languages: ' . $json
79 );
80 }
81
82 $languages = array_keys( $response[ 'translation' ] );
83
84 // Let's make a cartesian product, assuming we can translate from any language to any language
85 $pairs = [];
86 foreach ( $languages as $from ) {
87 foreach ( $languages as $to ) {
88 $pairs[$from][$to] = true;
89 }
90 }
91
92 return $pairs;
93 }
94
96 protected function getQuery( string $text, string $sourceLanguage, string $targetLanguage ): TranslationQuery {
97 if ( !isset( $this->config['key'] ) ) {
98 throw new TranslationWebServiceConfigurationException( 'key is not set' );
99 }
100
101 $key = $this->config['key'];
102 $text = trim( $text );
103 $text = $this->wrapUntranslatable( $text );
104
105 $url = $this->config['url'] . '/translate';
106 $params = [
107 'api-version' => '3.0',
108 'from' => $sourceLanguage,
109 'to' => $targetLanguage,
110 'textType' => 'html',
111 ];
112 $headers = [
113 'Ocp-Apim-Subscription-Key' => $key,
114 'Content-Type' => 'application/json',
115 ];
116 $body = json_encode( [ [ 'Text' => $text ] ] );
117
118 if ( $body === false ) {
119 throw new TranslationWebServiceInvalidInputException( 'Could not JSON encode source text' );
120 }
121
122 if ( strlen( $body ) > 5000 ) {
123 throw new TranslationWebServiceInvalidInputException( 'Source text too long' );
124 }
125
126 return TranslationQuery::factory( $url )
127 ->timeout( intval( $this->config['timeout'] ) )
128 ->queryParameters( $params )
129 ->queryHeaders( $headers )
130 ->postWithData( $body );
131 }
132
134 protected function parseResponse( TranslationQueryResponse $reply ): string {
135 $body = $reply->getBody();
136
137 $response = json_decode( $body, true );
138 if ( !isset( $response[ 0 ][ 'translations' ][ 0 ][ 'text' ] ) ) {
140 'Unable to parse translation response: ' . $body
141 );
142 }
143
144 $text = $response[ 0 ][ 'translations' ][ 0 ][ 'text' ];
145 $text = $this->unwrapUntranslatable( $text );
146
147 return $text;
148 }
149
151 protected function wrapUntranslatable( string $text ): string {
152 $pattern = '~%[^% ]+%|\$\d|{VAR:[^}]+}|{?{(PLURAL|GRAMMAR|GENDER):[^|]+\||%(\d\$)?[sd]~';
153 $wrap = '<span class="notranslate">\0</span>';
154 return preg_replace( $pattern, $wrap, $text );
155 }
156
158 protected function unwrapUntranslatable( string $text ): string {
159 $pattern = '~<span class="notranslate">\s*(.*?)\s*</span>~';
160 return preg_replace( $pattern, '\1', $text );
161 }
162}
return[ '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:ExternalMessageSourceStateImporter'=> static function(MediaWikiServices $services):ExternalMessageSourceStateImporter { return new ExternalMessageSourceStateImporter($services->getMainConfig(), $services->get( 'Translate:GroupSynchronizationCache'), $services->getJobQueueGroup(), LoggerFactory::getInstance( 'Translate.GroupSynchronization'), $services->get( 'Translate:MessageIndex'));}, '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:HookRunner'=> static function(MediaWikiServices $services):HookRunner { return new HookRunner( $services->getHookContainer());}, 'Translate:MessageBundleStore'=> static function(MediaWikiServices $services):MessageBundleStore { return new MessageBundleStore($services->get( 'Translate:RevTagStore'), $services->getJobQueueGroup(), $services->getLanguageNameUtils(), $services->get( 'Translate:MessageIndex'));}, 'Translate:MessageGroupReviewStore'=> static function(MediaWikiServices $services):MessageGroupReviewStore { return new MessageGroupReviewStore($services->getDBLoadBalancer(), $services->get( 'Translate:HookRunner'));}, 'Translate:MessageGroupStatsTableFactory'=> static function(MediaWikiServices $services):MessageGroupStatsTableFactory { return new MessageGroupStatsTableFactory($services->get( 'Translate:ProgressStatsTableFactory'), $services->getDBLoadBalancer(), $services->getLinkRenderer(), $services->get( 'Translate:MessageGroupReviewStore'), $services->getMainConfig() ->get( 'TranslateWorkflowStates') !==false);}, 'Translate:MessageIndex'=> static function(MediaWikiServices $services):MessageIndex { $params=$services->getMainConfig() ->get( 'TranslateMessageIndex');if(is_string( $params)) { $params=(array) $params;} $class=array_shift( $params);return new $class( $params);}, '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->getDBLoadBalancer(), $services->getJsonCodec());}, 'Translate:ProgressStatsTableFactory'=> static function(MediaWikiServices $services):ProgressStatsTableFactory { return new ProgressStatsTableFactory($services->getLinkRenderer(), $services->get( 'Translate:ConfigHelper'));}, 'Translate:RevTagStore'=> static function(MediaWikiServices $services):RevTagStore { return new RevTagStore($services->getDBLoadBalancerFactory());}, 'Translate:SubpageListBuilder'=> static function(MediaWikiServices $services):SubpageListBuilder { return new SubpageListBuilder($services->get( 'Translate:TranslatableBundleFactory'), $services->getLinkBatchFactory());}, 'Translate:TranslatableBundleExporter'=> static function(MediaWikiServices $services):TranslatableBundleExporter { return new TranslatableBundleExporter($services->get( 'Translate:SubpageListBuilder'), $services->getWikiExporterFactory(), $services->getDBLoadBalancer());}, '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());}, '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->getMainConfig() ->get( 'TranslatePageMoveLimit'));}, 'Translate:TranslatableBundleStatusStore'=> static function(MediaWikiServices $services):TranslatableBundleStatusStore { return new TranslatableBundleStatusStore($services->getDBLoadBalancer() ->getConnection(DB_PRIMARY), $services->getCollationFactory() ->makeCollation( 'uca-default-u-kn'), $services->getDBLoadBalancer() ->getMaintenanceConnectionRef(DB_PRIMARY));}, 'Translate:TranslatablePageParser'=> static function(MediaWikiServices $services):TranslatablePageParser { return new TranslatablePageParser($services->get( 'Translate:ParsingPlaceholderFactory'));}, 'Translate:TranslatablePageStore'=> static function(MediaWikiServices $services):TranslatablePageStore { return new TranslatablePageStore($services->get( 'Translate:MessageIndex'), $services->getJobQueueGroup(), $services->get( 'Translate:RevTagStore'), $services->getDBLoadBalancer(), $services->get( 'Translate:TranslatableBundleStatusStore'), $services->get( 'Translate:TranslatablePageParser'),);}, 'Translate:TranslationStashReader'=> static function(MediaWikiServices $services):TranslationStashReader { $db=$services->getDBLoadBalancer() ->getConnection(DB_REPLICA);return new TranslationStashStorage( $db);}, 'Translate:TranslationStatsDataProvider'=> static function(MediaWikiServices $services):TranslationStatsDataProvider { return new TranslationStatsDataProvider(new ServiceOptions(TranslationStatsDataProvider::CONSTRUCTOR_OPTIONS, $services->getMainConfig()), $services->getObjectFactory(), $services->getDBLoadBalancer());}, '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);}]
@phpcs-require-sorted-array
Implements support for Microsoft translation api v3.
getQuery(string $text, string $sourceLanguage, string $targetLanguage)
@inheritDoc
parseResponse(TranslationQueryResponse $reply)
@inheritDoc
Value object that represents a HTTP(S) query response.
Mutable objects that represents an HTTP(S) query.
Used to signal that the requested input is rejected and cannot be used with an external web service.