Page MenuHomeWickedGov Phorge
Files F1425994

AndroidXmlFormat.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

AndroidXmlFormat.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\FileFormatSupport;
use DOMDocument;
use FileBasedMessageGroup;
use IntlChar;
use MediaWiki\Extension\Translate\MessageLoading\Message;
use MediaWiki\Extension\Translate\MessageLoading\MessageCollection;
use MediaWiki\Extension\Translate\MessageProcessing\ArrayFlattener;
use RuntimeException;
use SimpleXMLElement;
/**
* Support for XML translation format used by Android.
* @author Niklas Laxström
* @license GPL-2.0-or-later
* @ingroup FileFormatSupport
*/
class AndroidXmlFormat extends SimpleFormat {
private ArrayFlattener $flattener;
public function __construct( FileBasedMessageGroup $group ) {
parent::__construct( $group );
$this->flattener = new ArrayFlattener( '', true );
}
public function supportsFuzzy(): string {
return 'yes';
}
public function getFileExtensions(): array {
return [ '.xml' ];
}
public function readFromVariable( string $data ): array {
$reader = new SimpleXMLElement( $data );
$messages = [];
$mangler = $this->group->getMangler();
$regexBacktrackLimit = ini_get( 'pcre.backtrack_limit' );
ini_set( 'pcre.backtrack_limit', '10' );
/** @var SimpleXMLElement $element */
foreach ( $reader as $element ) {
$key = (string)$element['name'];
if ( $element->getName() === 'string' ) {
$value = $this->readElementContents( $element );
} elseif ( $element->getName() === 'plurals' ) {
$forms = [];
foreach ( $element as $item ) {
$forms[(string)$item['quantity']] = $this->readElementContents( $item );
}
$value = $this->flattener->flattenCLDRPlurals( $forms );
} else {
wfDebug( __METHOD__ . ': Unknown XML element name.' );
continue;
}
if ( isset( $element['fuzzy'] ) && (string)$element['fuzzy'] === 'true' ) {
$value = TRANSLATE_FUZZY . $value;
}
$messages[$key] = $value;
}
ini_set( 'pcre.backtrack_limit', $regexBacktrackLimit );
return [
'AUTHORS' => $this->scrapeAuthors( $data ),
'MESSAGES' => $mangler->mangleArray( $messages ),
];
}
private function scrapeAuthors( string $string ): array {
if ( !preg_match( '~<!-- Authors:\n((?:\* .*\n)*)-->~', $string, $match ) ) {
return [];
}
$authors = $matches = [];
preg_match_all( '~\* (.*)~', $match[ 1 ], $matches );
foreach ( $matches[1] as $author ) {
$authors[] = str_replace( "\u{2011}\u{2011}", '--', $author );
}
return $authors;
}
private function readElementContents( SimpleXMLElement $element ): string {
// Convert string of format \uNNNN (eg: \u1234) to symbols
$converted = preg_replace_callback(
'/(?<!\\\\)(?:\\\\{2})*+\\K\\\\u([0-9A-Fa-f]{4,6})+/',
static fn ( array $matches ) => IntlChar::chr( hexdec( $matches[1] ) ),
(string)$element
);
return stripcslashes( $converted );
}
private function formatElementContents( string $contents ): string {
// Kudos to the brilliant person who invented this braindead file format
$escaped = addcslashes( $contents, '"\'\\' );
if ( substr( $escaped, 0, 1 ) === '@' ) {
// '@' at beginning of string refers to another string by name.
// Add backslash to escape it too.
$escaped = '\\' . $escaped;
}
// All html entities seen would be inserted by translators themselves.
// Treat them as plain text.
$escaped = str_replace( '&', '&amp;', $escaped );
// Newlines must be escaped
return str_replace( "\n", '\n', $escaped );
}
private function doAuthors( MessageCollection $collection ): string {
$authors = $collection->getAuthors();
$authors = $this->filterAuthors( $authors, $collection->code );
if ( !$authors ) {
return '';
}
$output = "\n<!-- Authors:\n";
foreach ( $authors as $author ) {
// Since -- is not allowed in XML comments, we rewrite them to
// U+2011 (non-breaking hyphen).
$author = str_replace( '--', "\u{2011}\u{2011}", $author );
$output .= "* $author\n";
}
$output .= "-->\n";
return $output;
}
protected function writeReal( MessageCollection $collection ): string {
global $wgTranslateDocumentationLanguageCode;
$collection->filter( 'hastranslation', false );
if ( count( $collection ) === 0 ) {
return '';
}
$template = '<?xml version="1.0" encoding="utf-8"?>';
$template .= $this->doAuthors( $collection );
$template .= '<resources></resources>';
$writer = new SimpleXMLElement( $template );
if ( $collection->getLanguage() === $wgTranslateDocumentationLanguageCode ) {
$writer->addAttribute(
'tools:ignore',
'all',
'http://schemas.android.com/tools'
);
}
$mangler = $this->group->getMangler();
/** @var Message $m */
foreach ( $collection as $key => $m ) {
$key = $mangler->unmangle( $key );
$value = $m->translation();
if ( $value === null ) {
throw new RuntimeException( "Expected translation to be present for $key, but found null." );
}
$value = str_replace( TRANSLATE_FUZZY, '', $value );
$plurals = $this->flattener->unflattenCLDRPlurals( '', $value );
if ( $plurals === false ) {
$element = $writer->addChild( 'string', $this->formatElementContents( $value ) );
} else {
$element = $writer->addChild( 'plurals' );
foreach ( $plurals as $quantity => $content ) {
$item = $element->addChild( 'item', $this->formatElementContents( $content ) );
$item->addAttribute( 'quantity', $quantity );
}
}
$element->addAttribute( 'name', $key );
// This is non-standard
if ( $m->hasTag( 'fuzzy' ) ) {
$element->addAttribute( 'fuzzy', 'true' );
}
}
// Make the output pretty with DOMDocument
$dom = new DOMDocument( '1.0' );
$dom->formatOutput = true;
$dom->loadXML( $writer->asXML() );
return $dom->saveXML() ?: '';
}
public function isContentEqual( ?string $a, ?string $b ): bool {
return $this->flattener->compareContent( $a, $b );
}
}
class_alias( AndroidXmlFormat::class, 'AndroidXmlFFS' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 12:23 (22 h, 12 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2f/82/a4f1917318e575b52ac9c31c175f
Default Alt Text
AndroidXmlFormat.php (5 KB)

Event Timeline