Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
AppleFormat.php
1<?php
2declare( strict_types = 1 );
3
4namespace MediaWiki\Extension\Translate\FileFormatSupport;
5
6use InvalidArgumentException;
10
21 public function supportsFuzzy(): string {
22 return 'write';
23 }
24
25 public function getFileExtensions(): array {
26 return [ '.strings' ];
27 }
28
30 public function readFromVariable( string $data ): array {
31 $lines = explode( "\n", $data );
32 $authors = $messages = [];
33 $linecontinuation = false;
34
35 foreach ( $lines as $line ) {
36 $line = trim( $line );
37 if ( $linecontinuation ) {
38 if ( str_contains( $line, '*/' ) ) {
39 $linecontinuation = false;
40 }
41 } else {
42 if ( $line === '' ) {
43 continue;
44 }
45
46 if ( substr( $line, 0, 2 ) === '//' ) {
47 // Single-line comment
48 $match = [];
49 $ok = preg_match( '~//\s*Author:\s*(.*)~', $line, $match );
50 if ( $ok ) {
51 $authors[] = $match[1];
52 }
53 continue;
54 }
55
56 if ( substr( $line, 0, 2 ) === '/*' ) {
57 if ( strpos( $line, '*/', 2 ) === false ) {
58 $linecontinuation = true;
59 }
60 continue;
61 }
62
63 [ $key, $value ] = $this->readRow( $line );
64 $messages[$key] = $value;
65 }
66 }
67
68 $messages = $this->group->getMangler()->mangleArray( $messages );
69
70 return [
71 'AUTHORS' => $authors,
72 'MESSAGES' => $messages,
73 ];
74 }
75
82 public function readRow( string $line ): array {
83 $match = [];
84 if ( preg_match( '/^"((?:\\\"|[^"])*)"\s*=\s*"((?:\\\"|[^"])*)"\s*;\s*$/', $line, $match ) ) {
85 $key = self::unescapeString( $match[1] );
86 $value = self::unescapeString( $match[2] );
87 if ( $key === '' ) {
88 throw new InvalidArgumentException( "Empty key in line $line" );
89 }
90 return [ $key, $value ];
91 } else {
92 throw new InvalidArgumentException( "Unrecognized line format: $line" );
93 }
94 }
95
96 protected function writeReal( MessageCollection $collection ): string {
97 $header = $this->doHeader( $collection );
98 $header .= $this->doAuthors( $collection );
99 $header .= "\n";
100
101 $output = '';
102 $mangler = $this->group->getMangler();
103
105 foreach ( $collection as $key => $m ) {
106 $value = $m->translation();
107 $value = str_replace( TRANSLATE_FUZZY, '', $value );
108
109 if ( $value === '' ) {
110 continue;
111 }
112
113 // Just to give an overview of translation quality.
114 if ( $m->hasTag( 'fuzzy' ) ) {
115 $output .= "// Fuzzy\n";
116 }
117
118 $key = $mangler->unmangle( $key );
119 $output .= $this->writeRow( $key, $value );
120 }
121
122 if ( $output ) {
123 $data = $header . $output;
124 } else {
125 $data = $header;
126 }
127
128 return $data;
129 }
130
135 public function writeRow( string $key, string $value ): string {
136 return self::quoteString( $key ) . ' = ' . self::quoteString( $value ) . ';' . "\n";
137 }
138
140 protected static function quoteString( string $str ): string {
141 return '"' . self::escapeString( $str ) . '"';
142 }
143
145 private static function escapeString( string $str ): string {
146 $str = addcslashes( $str, '\\"' );
147 $str = str_replace( "\n", '\\n', $str );
148 return $str;
149 }
150
156 protected static function unescapeString( string $str ): string {
157 return stripcslashes( $str );
158 }
159
160 private function doHeader( MessageCollection $collection ): string {
161 if ( isset( $this->extra['header'] ) ) {
162 $output = $this->extra['header'];
163 } else {
164 global $wgSitename;
165
166 $code = $collection->code;
167 $name = Utilities::getLanguageName( $code );
168 $native = Utilities::getLanguageName( $code, $code );
169 $output = "// Messages for $name ($native)\n";
170 $output .= "// Exported from $wgSitename\n";
171 }
172
173 return $output;
174 }
175
176 private function doAuthors( MessageCollection $collection ): string {
177 $output = '';
178 $authors = $collection->getAuthors();
179 $authors = $this->filterAuthors( $authors, $collection->code );
180
181 foreach ( $authors as $author ) {
182 $output .= "// Author: $author\n";
183 }
184
185 return $output;
186 }
187
188 public static function getExtraSchema(): array {
189 return [
190 'root' => [
191 '_type' => 'array',
192 '_children' => [
193 'FILES' => [
194 '_type' => 'array',
195 '_children' => [
196 'header' => [
197 '_type' => 'text',
198 ],
199 ]
200 ]
201 ]
202 ]
203 ];
204 }
205}
206
207class_alias( AppleFormat::class, 'AppleFFS' );
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
AppleFFS class implements support for Apple .strings files.
getFileExtensions()
Return the commonly used file extensions for these formats.
supportsFuzzy()
Query the capabilities of this FFS.
static quoteString(string $str)
Quote and escape Obj-C-style strings for .strings format.
readRow(string $line)
Parses non-empty strings file row to key and value.
static unescapeString(string $str)
Unescape Obj-C-style strings; can include backslash-escapes.
writeRow(string $key, string $value)
Writes well-formed properties file row with key and value.
A very basic FileFormatSupport module that implements some basic functionality and a simple binary ba...
This file contains the class for core message collections implementation.
Interface for message objects used by MessageCollection.
Definition Message.php:13
Essentially random collection of helper functions, similar to GlobalFunctions.php.
Definition Utilities.php:31