locale.pages.inc 14.2 KB
Newer Older
1 2 3
<?php

/**
4 5
 * @file
 * Interface translation summary, editing and deletion user interfaces.
6 7
 */

8
use Drupal\Component\Utility\String;
9
use Drupal\Core\Language\Language;
10 11
use Drupal\locale\SourceString;
use Drupal\locale\TranslationString;
12
use Symfony\Component\HttpFoundation\RedirectResponse;
13 14
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

15
/**
16
 * Page callback: Checks for translation updates and displays the status.
17
 *
18
 * Manually checks the translation status without the use of cron.
19 20
 *
 * @see locale_menu()
21
 */
22 23
function locale_translation_manual_status() {
  module_load_include('compare.inc', 'locale');
24

25 26 27 28 29
  // Check the translation status of all translatable projects in all languages.
  // First we clear the cached list of projects. Although not strictly
  // necessary, this is helpful in case the project list is out of sync.
  locale_translation_flush_projects();
  locale_translation_check_projects();
30

31 32 33 34
  // Execute a batch if required. A batch is only used when remote files
  // are checked.
  if (batch_get()) {
    return batch_process('admin/reports/translations');
35
  }
36
  return new RedirectResponse(url('admin/reports/translations', array('absolute' => TRUE)));
37 38
}

39 40 41 42
/**
 * Page callback: Display the current translation status.
 *
 * @see locale_menu()
43
 *
44 45
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\locale\Form\LocaleForm::status().
46
 */
47
function locale_translation_status_form($form, &$form_state) {
48
  module_load_include('translation.inc', 'locale');
49
  module_load_include('compare.inc', 'locale');
50 51
  $updates = $options = array();
  $languages_update = $languages_not_found = array();
52
  $projects_update = array();
53

54 55 56 57
  // @todo Calling locale_translation_build_projects() is an expensive way to
  //   get a module name. In follow-up issue http://drupal.org/node/1842362
  //   the project name will be stored to display use, like here.
  $project_data = locale_translation_build_projects();
58
  $languages = locale_translatable_language_list();
59
  $status = locale_translation_get_status();
60

61 62 63
  // Prepare information about projects which have available translation
  // updates.
  if ($languages && $status) {
64
    foreach ($status as $project) {
65 66
      foreach ($project as $langcode => $project_info) {
        // No translation file found for this project-language combination.
67
        if (empty($project_info->type)) {
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
          $updates[$langcode]['not_found'][] = array(
            'name' => $project_info->name == 'drupal' ? t('Drupal core') : $project_data[$project_info->name]->info['name'],
            'version' => $project_info->version,
            'info' => _locale_translation_status_debug_info($project_info),
          );
          $languages_not_found[$langcode] = $langcode;
        }
        // Translation update found for this project-language combination.
        elseif ($project_info->type == LOCALE_TRANSLATION_LOCAL || $project_info->type == LOCALE_TRANSLATION_REMOTE ) {
          $local = isset($project_info->files[LOCALE_TRANSLATION_LOCAL]) ? $project_info->files[LOCALE_TRANSLATION_LOCAL] : NULL;
          $remote = isset($project_info->files[LOCALE_TRANSLATION_REMOTE]) ? $project_info->files[LOCALE_TRANSLATION_REMOTE] : NULL;
          $recent = _locale_translation_source_compare($local, $remote) == LOCALE_TRANSLATION_SOURCE_COMPARE_LT ? $remote : $local;
          $updates[$langcode]['updates'][] = array(
            'name' => $project_data[$project_info->name]->info['name'],
            'version' => $project_info->version,
            'timestamp' => $recent->timestamp,
          );
          $languages_update[$langcode] = $langcode;
86
          $projects_update[$project_info->name] = $project_info->name;
87 88 89 90 91 92 93
        }
      }
    }
    $languages_not_found = array_diff($languages_not_found, $languages_update);

    // Build data options for the select table.
    foreach($updates as $langcode => $update) {
94
      $title = String::checkPlain($languages[$langcode]->name);
95 96 97 98 99 100
      $locale_translation_update_info = array('#theme' => 'locale_translation_update_info');
      foreach (array('updates', 'not_found') as $update_status) {
        if (isset($update[$update_status])) {
          $locale_translation_update_info['#' . $update_status] = $update[$update_status];
        }
      }
101
      $options[$langcode] = array(
102 103 104 105 106 107 108
        'title' => array(
          'class' => array('label'),
          'data' => array(
            '#title' => $title,
            '#markup' => $title
          ),
        ),
109
        'status' => array('class' => array('description', 'expand', 'priority-low'), 'data' => drupal_render($locale_translation_update_info)),
110 111 112
      );
    }
    // Sort the table data on language name.
113 114 115
    uasort($options, function ($a, $b) {
      return strcasecmp($a['title']['data']['#title'], $b['title']['data']['#title']);
    });
116 117
  }

118
  $last_checked = \Drupal::state()->get('locale.translation_last_checked');
119
  $form['last_checked'] = array(
120 121
    '#theme' => 'locale_translation_last_check',
    '#last' => $last_checked,
122 123
  );

124 125 126 127 128 129 130 131 132
  $header = array(
    'title' => array(
      'data' => t('Language'),
      'class' => array('title'),
    ),
    'status' => array(
      'data' => t('Status'),
      'class' => array('status', 'priority-low'),
    ),
133 134
  );

135 136 137 138 139 140 141 142 143 144
  if (!$languages) {
    $empty = t('No translatable languages available. <a href="@add_language">Add a language</a> first.', array('@add_language' => url('admin/config/regional/language')));
  }
  elseif ($status) {
    $empty = t('All translations up to date.');
  }
  else  {
    $empty = t('No translation status available. <a href="@check">Check manually</a>.', array('@check' => url('admin/reports/translations/check')));
  }

145 146 147 148 149 150
  // The projects which require an update. Used by the _submit callback.
  $form['projects_update'] = array(
    '#type' => 'value',
    '#value' => $projects_update,
  );

151 152 153 154 155 156 157 158 159 160 161
  $form['langcodes'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $options,
    '#default_value' => $languages_update,
    '#empty' => $empty,
    '#js_select' => TRUE,
    '#multiple' => TRUE,
    '#required' => TRUE,
    '#not_found' => $languages_not_found,
    '#after_build' => array('locale_translation_language_table'),
162
  );
163 164

  $form['#attached']['library'][] = array('locale', 'drupal.locale.admin');
165
  $form['#attached']['css'] = array(drupal_get_path('module', 'locale') . '/css/locale.admin.css');
166 167 168 169 170 171 172 173 174

  $form['actions'] = array('#type' => 'actions');
  if ($languages_update) {
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Update translations'),
    );
  }

175 176 177 178
  return $form;
}

/**
179 180 181 182 183
 * Form validation handler for locale_translation_status_form().
 */
function locale_translation_status_form_validate($form, &$form_state) {
  // Check if a language has been selected. 'tableselect' doesn't.
  if (!array_filter($form_state['values']['langcodes'])) {
184
    form_set_error('', $form_state, t('Select a language to update.'));
185 186 187 188 189
  }
}

/**
 * Form submission handler for locale_translation_status_form().
190 191 192 193
 */
function locale_translation_status_form_submit($form, &$form_state) {
  module_load_include('fetch.inc', 'locale');
  $langcodes = array_filter($form_state['values']['langcodes']);
194
  $projects = array_filter($form_state['values']['projects_update']);
195 196 197 198 199 200 201 202

  // Set the translation import options. This determines if existing
  // translations will be overwritten by imported strings.
  $options = _locale_translation_default_update_options();

  // If the status was updated recently we can immediately start fetching the
  // translation updates. If the status is expired we clear it an run a batch to
  // update the status and then fetch the translation updates.
203
  $last_checked = \Drupal::state()->get('locale.translation_last_checked');
204 205 206 207 208 209
  if ($last_checked < REQUEST_TIME - LOCALE_TRANSLATION_STATUS_TTL) {
    locale_translation_clear_status();
    $batch = locale_translation_batch_update_build(array(), $langcodes, $options);
    batch_set($batch);
  }
  else {
210
    $batch = locale_translation_batch_fetch_build($projects, $langcodes, $options);
211 212
    batch_set($batch);
  }
213 214 215
}

/**
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
 * Form element callback: After build changes to the language update table.
 *
 * Adds labels to the languages and removes checkboxes from languages from which
 * translation files could not be found.
 */
function locale_translation_language_table($form_element) {
  // Remove checkboxes of languages without updates.
  if ($form_element['#not_found']) {
    foreach ($form_element['#not_found'] as $langcode) {
      $form_element[$langcode] = array();
    }
  }
  return $form_element;
}

/**
 * Provides debug info for projects in case translation files are not found.
 *
 * Translations files are being fetched either from Drupal translation server
 * and local files or only from the local filesystem depending on the
 * "Translation source" setting at admin/config/regional/translate/settings.
 * This method will produce debug information including the respective path(s)
 * based on this setting.
 *
 * Translations for development versions are never fetched, so the debug info
 * for that is a fixed message.
 *
 * @param array $source
 *   An array which is the project information of the source.
 *
 * @return string
 *   The string which contains debug information.
 */
function _locale_translation_status_debug_info($source) {
  $remote_path = isset($source->files['remote']->uri) ? $source->files['remote']->uri : '';
  $local_path = isset($source->files['local']->uri) ? $source->files['local']->uri : '';

  if (strpos($source->version, 'dev') !== FALSE) {
    return t('No translation files are provided for development releases.');
  }
  if (locale_translation_use_remote_source() && $remote_path && $local_path) {
    return t('File not found at %remote_path nor at %local_path', array(
      '%remote_path' => $remote_path,
      '%local_path' => $local_path,
    ));
  }
  elseif ($local_path) {
    return t('File not found at %local_path', array('%local_path' => $local_path));
  }
  return t('Translation file location could not be determined.');
}

/**
 * Returns HTML for translation edit form.
 *
 * @param array $variables
 *   An associative array containing:
 *   - form: The form that contains the language information.
 *
 * @see locale_translate_edit_form()
 * @ingroup themeable
277
 */
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
function theme_locale_translate_edit_form_strings($variables) {
  $output = '';
  $form = $variables['form'];
  $header = array(
    t('Source string'),
    t('Translation for @language', array('@language' => $form['#language'])),
  );
  $rows = array();
  foreach (element_children($form) as $lid) {
    $string = $form[$lid];
    if ($string['plural']['#value']) {
      $source = drupal_render($string['original_singular']) . '<br />' . drupal_render($string['original_plural']);
    }
    else {
      $source = drupal_render($string['original']);
    }
    $source .= empty($string['context']) ? '' : '<br /><small>' . t('In Context') . ':&nbsp;' . $string['context']['#value'] . '</small>';
    $rows[] = array(
      array('data' => $source),
      array('data' => $string['translations']),
    );
299
  }
300 301 302 303 304 305 306 307 308 309
  $table = array(
    '#theme' => 'table',
    '#header' => $header,
    '#rows' => $rows,
    '#empty' => t('No strings available.'),
    '#attributes' => array('class' => array('locale-translate-edit-table')),
  );
  $output .= drupal_render($table);
  $pager = array('#theme' => 'pager');
  $output .= drupal_render($pager);
310
  return $output;
311
}
312 313

/**
314 315 316 317 318
 * Prepares variables for translation status information templates.
 *
 * Translation status information is displayed per language.
 *
 * Default template: locale-translate-edit-form-strings.html.twig.
319 320 321 322 323 324 325 326
 *
 * @param array $variables
 *   An associative array containing:
 *   - updates: The projects which have updates.
 *   - not_found: The projects which updates are not found.
 *
 * @see locale_translation_status_form()
 */
327 328
function template_preprocess_locale_translation_update_info(&$variables) {
  $details = array();
329 330 331

  // Build output for available updates.
  if (isset($variables['updates'])) {
332
    $releases = array();
333 334 335 336 337
    if ($variables['updates']) {
      foreach ($variables['updates'] as $update) {
        $modules[] = $update['name'];
        $releases[] = t('@module (@date)', array('@module' => $update['name'], '@date' => format_date($update['timestamp'], 'html_date')));
      }
338
      $variables['modules'] = $modules;
339
    }
340 341 342 343
    $details['available_updates_list'] = array(
      '#theme' => 'item_list',
      '#items' => $releases,
    );
344 345 346 347
  }

  // Build output for updates not found.
  if (isset($variables['not_found'])) {
348
    $releases = array();
349
    $variables['missing_updates_status'] = format_plural(count($variables['not_found']), 'Missing translations for one project', 'Missing translations for @count projects');
350 351 352 353 354 355
    if ($variables['not_found']) {
      foreach ($variables['not_found'] as $update) {
        $version = $update['version'] ? $update['version'] : t('no version');
        $releases[] = t('@module (@version).', array('@module' => $update['name'], '@version' => $version)) . ' ' . $update['info'];
      }
    }
356 357 358 359 360 361 362 363
    $details['missing_updates_list'] = array(
      '#theme' => 'item_list',
      '#items' => $releases,
    );
    // Prefix the missing updates list if there is an available updates lists
    // before it.
    if (!empty($details['available_updates_list']['#items'])) {
      $details['missing_updates_list']['#prefix'] = t('Missing translations for:');
364 365
    }
  }
366
  $variables['details'] = $details;
367 368 369
}

/**
370 371 372 373 374 375
 * Prepares variables for most recent translation update templates.
 *
 * Displays the last time we checked for locale update data. In addition to
 * properly formatting the given timestamp, this function also provides a "Check
 * manually" link that refreshes the available update and redirects back to the
 * same page.
376
 *
377
 * Default template: locale-translation-last-check.html.twig.
378 379 380 381 382 383 384
 *
 * @param $variables
 *   An associative array containing:
 *   - last: The timestamp when the site last checked for available updates.
 *
 * @see locale_translation_status_form()
 */
385
function template_preprocess_locale_translation_last_check(&$variables) {
386
  $last = $variables['last'];
387 388 389
  $variables['last_checked'] = ($last != NULL);
  $variables['time'] = format_interval(REQUEST_TIME - $last);
  $variables['link'] = l(t('Check manually'), 'admin/reports/translations/check', array('query' => drupal_get_destination()));
390
}