Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Translation\Dumper;
Chris@0: 
Chris@17: use Symfony\Component\Translation\Exception\InvalidArgumentException;
Chris@0: use Symfony\Component\Translation\MessageCatalogue;
Chris@0: 
Chris@0: /**
Chris@0:  * XliffFileDumper generates xliff files from a message catalogue.
Chris@0:  *
Chris@0:  * @author Michel Salib <michelsalib@hotmail.com>
Chris@0:  */
Chris@0: class XliffFileDumper extends FileDumper
Chris@0: {
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = [])
Chris@0:     {
Chris@0:         $xliffVersion = '1.2';
Chris@18:         if (\array_key_exists('xliff_version', $options)) {
Chris@0:             $xliffVersion = $options['xliff_version'];
Chris@0:         }
Chris@0: 
Chris@18:         if (\array_key_exists('default_locale', $options)) {
Chris@0:             $defaultLocale = $options['default_locale'];
Chris@0:         } else {
Chris@0:             $defaultLocale = \Locale::getDefault();
Chris@0:         }
Chris@0: 
Chris@0:         if ('1.2' === $xliffVersion) {
Chris@0:             return $this->dumpXliff1($defaultLocale, $messages, $domain, $options);
Chris@0:         }
Chris@0:         if ('2.0' === $xliffVersion) {
Chris@0:             return $this->dumpXliff2($defaultLocale, $messages, $domain, $options);
Chris@0:         }
Chris@0: 
Chris@0:         throw new InvalidArgumentException(sprintf('No support implemented for dumping XLIFF version "%s".', $xliffVersion));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     protected function getExtension()
Chris@0:     {
Chris@0:         return 'xlf';
Chris@0:     }
Chris@0: 
Chris@17:     private function dumpXliff1($defaultLocale, MessageCatalogue $messages, $domain, array $options = [])
Chris@0:     {
Chris@17:         $toolInfo = ['tool-id' => 'symfony', 'tool-name' => 'Symfony'];
Chris@18:         if (\array_key_exists('tool_info', $options)) {
Chris@0:             $toolInfo = array_merge($toolInfo, $options['tool_info']);
Chris@0:         }
Chris@0: 
Chris@0:         $dom = new \DOMDocument('1.0', 'utf-8');
Chris@0:         $dom->formatOutput = true;
Chris@0: 
Chris@0:         $xliff = $dom->appendChild($dom->createElement('xliff'));
Chris@0:         $xliff->setAttribute('version', '1.2');
Chris@0:         $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:1.2');
Chris@0: 
Chris@0:         $xliffFile = $xliff->appendChild($dom->createElement('file'));
Chris@0:         $xliffFile->setAttribute('source-language', str_replace('_', '-', $defaultLocale));
Chris@0:         $xliffFile->setAttribute('target-language', str_replace('_', '-', $messages->getLocale()));
Chris@0:         $xliffFile->setAttribute('datatype', 'plaintext');
Chris@0:         $xliffFile->setAttribute('original', 'file.ext');
Chris@0: 
Chris@0:         $xliffHead = $xliffFile->appendChild($dom->createElement('header'));
Chris@0:         $xliffTool = $xliffHead->appendChild($dom->createElement('tool'));
Chris@0:         foreach ($toolInfo as $id => $value) {
Chris@0:             $xliffTool->setAttribute($id, $value);
Chris@0:         }
Chris@0: 
Chris@0:         $xliffBody = $xliffFile->appendChild($dom->createElement('body'));
Chris@0:         foreach ($messages->all($domain) as $source => $target) {
Chris@0:             $translation = $dom->createElement('trans-unit');
Chris@0: 
Chris@14:             $translation->setAttribute('id', strtr(substr(base64_encode(hash('sha256', $source, true)), 0, 7), '/+', '._'));
Chris@0:             $translation->setAttribute('resname', $source);
Chris@0: 
Chris@0:             $s = $translation->appendChild($dom->createElement('source'));
Chris@0:             $s->appendChild($dom->createTextNode($source));
Chris@0: 
Chris@0:             // Does the target contain characters requiring a CDATA section?
Chris@0:             $text = 1 === preg_match('/[&<>]/', $target) ? $dom->createCDATASection($target) : $dom->createTextNode($target);
Chris@0: 
Chris@0:             $targetElement = $dom->createElement('target');
Chris@0:             $metadata = $messages->getMetadata($source, $domain);
Chris@0:             if ($this->hasMetadataArrayInfo('target-attributes', $metadata)) {
Chris@0:                 foreach ($metadata['target-attributes'] as $name => $value) {
Chris@0:                     $targetElement->setAttribute($name, $value);
Chris@0:                 }
Chris@0:             }
Chris@0:             $t = $translation->appendChild($targetElement);
Chris@0:             $t->appendChild($text);
Chris@0: 
Chris@0:             if ($this->hasMetadataArrayInfo('notes', $metadata)) {
Chris@0:                 foreach ($metadata['notes'] as $note) {
Chris@0:                     if (!isset($note['content'])) {
Chris@0:                         continue;
Chris@0:                     }
Chris@0: 
Chris@0:                     $n = $translation->appendChild($dom->createElement('note'));
Chris@0:                     $n->appendChild($dom->createTextNode($note['content']));
Chris@0: 
Chris@0:                     if (isset($note['priority'])) {
Chris@0:                         $n->setAttribute('priority', $note['priority']);
Chris@0:                     }
Chris@0: 
Chris@0:                     if (isset($note['from'])) {
Chris@0:                         $n->setAttribute('from', $note['from']);
Chris@0:                     }
Chris@0:                 }
Chris@0:             }
Chris@0: 
Chris@0:             $xliffBody->appendChild($translation);
Chris@0:         }
Chris@0: 
Chris@0:         return $dom->saveXML();
Chris@0:     }
Chris@0: 
Chris@17:     private function dumpXliff2($defaultLocale, MessageCatalogue $messages, $domain, array $options = [])
Chris@0:     {
Chris@0:         $dom = new \DOMDocument('1.0', 'utf-8');
Chris@0:         $dom->formatOutput = true;
Chris@0: 
Chris@0:         $xliff = $dom->appendChild($dom->createElement('xliff'));
Chris@0:         $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:2.0');
Chris@0:         $xliff->setAttribute('version', '2.0');
Chris@0:         $xliff->setAttribute('srcLang', str_replace('_', '-', $defaultLocale));
Chris@0:         $xliff->setAttribute('trgLang', str_replace('_', '-', $messages->getLocale()));
Chris@0: 
Chris@0:         $xliffFile = $xliff->appendChild($dom->createElement('file'));
Chris@0:         $xliffFile->setAttribute('id', $domain.'.'.$messages->getLocale());
Chris@0: 
Chris@0:         foreach ($messages->all($domain) as $source => $target) {
Chris@0:             $translation = $dom->createElement('unit');
Chris@14:             $translation->setAttribute('id', strtr(substr(base64_encode(hash('sha256', $source, true)), 0, 7), '/+', '._'));
Chris@14:             $metadata = $messages->getMetadata($source, $domain);
Chris@14: 
Chris@14:             // Add notes section
Chris@14:             if ($this->hasMetadataArrayInfo('notes', $metadata)) {
Chris@14:                 $notesElement = $dom->createElement('notes');
Chris@14:                 foreach ($metadata['notes'] as $note) {
Chris@14:                     $n = $dom->createElement('note');
Chris@14:                     $n->appendChild($dom->createTextNode(isset($note['content']) ? $note['content'] : ''));
Chris@14:                     unset($note['content']);
Chris@14: 
Chris@14:                     foreach ($note as $name => $value) {
Chris@14:                         $n->setAttribute($name, $value);
Chris@14:                     }
Chris@14:                     $notesElement->appendChild($n);
Chris@14:                 }
Chris@14:                 $translation->appendChild($notesElement);
Chris@14:             }
Chris@0: 
Chris@0:             $segment = $translation->appendChild($dom->createElement('segment'));
Chris@0: 
Chris@0:             $s = $segment->appendChild($dom->createElement('source'));
Chris@0:             $s->appendChild($dom->createTextNode($source));
Chris@0: 
Chris@0:             // Does the target contain characters requiring a CDATA section?
Chris@0:             $text = 1 === preg_match('/[&<>]/', $target) ? $dom->createCDATASection($target) : $dom->createTextNode($target);
Chris@0: 
Chris@0:             $targetElement = $dom->createElement('target');
Chris@0:             if ($this->hasMetadataArrayInfo('target-attributes', $metadata)) {
Chris@0:                 foreach ($metadata['target-attributes'] as $name => $value) {
Chris@0:                     $targetElement->setAttribute($name, $value);
Chris@0:                 }
Chris@0:             }
Chris@0:             $t = $segment->appendChild($targetElement);
Chris@0:             $t->appendChild($text);
Chris@0: 
Chris@0:             $xliffFile->appendChild($translation);
Chris@0:         }
Chris@0: 
Chris@0:         return $dom->saveXML();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string     $key
Chris@0:      * @param array|null $metadata
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     private function hasMetadataArrayInfo($key, $metadata = null)
Chris@0:     {
Chris@18:         return null !== $metadata && \array_key_exists($key, $metadata) && ($metadata[$key] instanceof \Traversable || \is_array($metadata[$key]));
Chris@0:     }
Chris@0: }