Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * The API for download and import of translations from remote and local sources.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Load the common translation API.
Chris@0:  */
Chris@0: // @todo Combine functions differently in files to avoid unnecessary includes.
Chris@0: // Follow-up issue: https://www.drupal.org/node/1834298.
Chris@0: require_once __DIR__ . '/locale.translation.inc';
Chris@0: 
Chris@0: /**
Chris@0:  * Builds a batch to check, download and import project translations.
Chris@0:  *
Chris@0:  * @param array $projects
Chris@0:  *   Array of project names for which to update the translations. Defaults to
Chris@0:  *   all translatable projects.
Chris@0:  * @param array $langcodes
Chris@0:  *   Array of language codes. Defaults to all translatable languages.
Chris@0:  * @param array $options
Chris@0:  *   Array of import options. See locale_translate_batch_import_files().
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   Batch definition array.
Chris@0:  */
Chris@0: function locale_translation_batch_update_build($projects = [], $langcodes = [], $options = []) {
Chris@0:   module_load_include('compare.inc', 'locale');
Chris@0:   $projects = $projects ? $projects : array_keys(locale_translation_get_projects());
Chris@0:   $langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
Chris@0:   $status_options = $options;
Chris@0:   $status_options['finish_feedback'] = FALSE;
Chris@0: 
Chris@0:   // Check status of local and remote translation files.
Chris@0:   $operations = _locale_translation_batch_status_operations($projects, $langcodes, $status_options);
Chris@0:   // Download and import translations.
Chris@0:   $operations = array_merge($operations, _locale_translation_fetch_operations($projects, $langcodes, $options));
Chris@0: 
Chris@0:   $batch = [
Chris@0:     'operations' => $operations,
Chris@0:     'title' => t('Updating translations'),
Chris@0:     'progress_message' => '',
Chris@0:     'error_message' => t('Error importing translation files'),
Chris@0:     'finished' => 'locale_translation_batch_fetch_finished',
Chris@0:     'file' => drupal_get_path('module', 'locale') . '/locale.batch.inc',
Chris@0:   ];
Chris@0:   return $batch;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Builds a batch to download and import project translations.
Chris@0:  *
Chris@0:  * @param array $projects
Chris@0:  *   Array of project names for which to check the state of translation files.
Chris@0:  *   Defaults to all translatable projects.
Chris@0:  * @param array $langcodes
Chris@0:  *   Array of language codes. Defaults to all translatable languages.
Chris@0:  * @param array $options
Chris@0:  *   Array of import options. See locale_translate_batch_import_files().
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   Batch definition array.
Chris@0:  */
Chris@0: function locale_translation_batch_fetch_build($projects = [], $langcodes = [], $options = []) {
Chris@0:   $projects = $projects ? $projects : array_keys(locale_translation_get_projects());
Chris@0:   $langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
Chris@0: 
Chris@0:   $batch = [
Chris@0:     'operations' => _locale_translation_fetch_operations($projects, $langcodes, $options),
Chris@0:     'title' => t('Updating translations.'),
Chris@0:     'progress_message' => '',
Chris@0:     'error_message' => t('Error importing translation files'),
Chris@0:     'finished' => 'locale_translation_batch_fetch_finished',
Chris@0:     'file' => drupal_get_path('module', 'locale') . '/locale.batch.inc',
Chris@0:   ];
Chris@0:   return $batch;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Helper function to construct the batch operations to fetch translations.
Chris@0:  *
Chris@0:  * @param array $projects
Chris@0:  *   Array of project names for which to check the state of translation files.
Chris@0:  *   Defaults to all translatable projects.
Chris@0:  * @param array $langcodes
Chris@0:  *   Array of language codes. Defaults to all translatable languages.
Chris@0:  * @param array $options
Chris@0:  *   Array of import options.
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   Array of batch operations.
Chris@0:  */
Chris@0: function _locale_translation_fetch_operations($projects, $langcodes, $options) {
Chris@0:   $operations = [];
Chris@0: 
Chris@0:   foreach ($projects as $project) {
Chris@0:     foreach ($langcodes as $langcode) {
Chris@0:       if (locale_translation_use_remote_source()) {
Chris@0:         $operations[] = ['locale_translation_batch_fetch_download', [$project, $langcode]];
Chris@0:       }
Chris@0:       $operations[] = ['locale_translation_batch_fetch_import', [$project, $langcode, $options]];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   return $operations;
Chris@0: }