Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\locale;
Chris@0: 
Chris@0: use Drupal\Component\Gettext\PoStreamReader;
Chris@0: 
Chris@0: /**
Chris@0:  * Static class providing Drupal specific Gettext functionality.
Chris@0:  *
Chris@0:  * The operations are related to pumping data from a source to a destination,
Chris@0:  * for example:
Chris@0:  * - Remote files http://*.po to memory
Chris@0:  * - File public://*.po to database
Chris@0:  */
Chris@0: class Gettext {
Chris@0: 
Chris@0:   /**
Chris@0:    * Reads the given PO files into the database.
Chris@0:    *
Chris@0:    * @param object $file
Chris@0:    *   File object with an URI property pointing at the file's path.
Chris@0:    *   - "langcode": The language the strings will be added to.
Chris@0:    *   - "uri": File URI.
Chris@0:    * @param array $options
Chris@0:    *   An array with options that can have the following elements:
Chris@0:    *   - 'overwrite_options': Overwrite options array as defined in
Chris@0:    *     Drupal\locale\PoDatabaseWriter. Optional, defaults to an empty array.
Chris@0:    *   - 'customized': Flag indicating whether the strings imported from $file
Chris@0:    *     are customized translations or come from a community source. Use
Chris@0:    *     LOCALE_CUSTOMIZED or LOCALE_NOT_CUSTOMIZED. Optional, defaults to
Chris@0:    *     LOCALE_NOT_CUSTOMIZED.
Chris@0:    *   - 'seek': Specifies from which position in the file should the reader
Chris@0:    *     start reading the next items. Optional, defaults to 0.
Chris@0:    *   - 'items': Specifies the number of items to read. Optional, defaults to
Chris@0:    *     -1, which means that all the items from the stream will be read.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Report array as defined in Drupal\locale\PoDatabaseWriter.
Chris@0:    *
Chris@0:    * @see \Drupal\locale\PoDatabaseWriter
Chris@0:    */
Chris@0:   public static function fileToDatabase($file, $options) {
Chris@0:     // Add the default values to the options array.
Chris@0:     $options += [
Chris@0:       'overwrite_options' => [],
Chris@0:       'customized' => LOCALE_NOT_CUSTOMIZED,
Chris@0:       'items' => -1,
Chris@0:       'seek' => 0,
Chris@0:     ];
Chris@0:     // Instantiate and initialize the stream reader for this file.
Chris@0:     $reader = new PoStreamReader();
Chris@0:     $reader->setLangcode($file->langcode);
Chris@0:     $reader->setURI($file->uri);
Chris@0: 
Chris@0:     try {
Chris@0:       $reader->open();
Chris@0:     }
Chris@0:     catch (\Exception $exception) {
Chris@0:       throw $exception;
Chris@0:     }
Chris@0: 
Chris@0:     $header = $reader->getHeader();
Chris@0:     if (!$header) {
Chris@0:       throw new \Exception('Missing or malformed header.');
Chris@0:     }
Chris@0: 
Chris@0:     // Initialize the database writer.
Chris@0:     $writer = new PoDatabaseWriter();
Chris@0:     $writer->setLangcode($file->langcode);
Chris@0:     $writer_options = [
Chris@0:       'overwrite_options' => $options['overwrite_options'],
Chris@0:       'customized' => $options['customized'],
Chris@0:     ];
Chris@0:     $writer->setOptions($writer_options);
Chris@0:     $writer->setHeader($header);
Chris@0: 
Chris@0:     // Attempt to pipe all items from the file to the database.
Chris@0:     try {
Chris@0:       if ($options['seek']) {
Chris@0:         $reader->setSeek($options['seek']);
Chris@0:       }
Chris@0:       $writer->writeItems($reader, $options['items']);
Chris@0:     }
Chris@0:     catch (\Exception $exception) {
Chris@0:       throw $exception;
Chris@0:     }
Chris@0: 
Chris@0:     // Report back with an array of status information.
Chris@0:     $report = $writer->getReport();
Chris@0: 
Chris@0:     // Add the seek position to the report. This is useful for the batch
Chris@0:     // operation.
Chris@0:     $report['seek'] = $reader->getSeek();
Chris@0:     return $report;
Chris@0:   }
Chris@0: 
Chris@0: }