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

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

8 9
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

10
/**
11 12 13
 * Page callback: Shows the string search screen.
 *
 * @see locale_menu()
14
 */
15 16 17 18 19
function locale_translate_page() {
  return array(
    'filter' => drupal_get_form('locale_translate_filter_form'),
    'form' => drupal_get_form('locale_translate_edit_form'),
  );
20 21 22
}

/**
23
 * Build a string search query.
24
 */
25 26
function locale_translate_query() {
  $filter_values = locale_translate_filter_values();
27 28

  $sql_query = db_select('locales_source', 's');
29 30 31
  // Language is sanitized to be one of the possible options in
  // locale_translate_filter_values().
  $sql_query->leftJoin('locales_target', 't', "t.lid = s.lid AND t.language = :langcode", array(':langcode' => $filter_values['langcode']));
32
  $sql_query->fields('s', array('source', 'location', 'context', 'lid'));
33
  $sql_query->fields('t', array('translation', 'language', 'customized'));
34

35 36 37 38 39 40 41 42 43
  if (!empty($filter_values['string'])) {
    $sql_query->condition(db_or()
      ->condition('s.source', '%' . db_like($filter_values['string']) . '%', 'LIKE')
      ->condition('t.translation', '%' . db_like($filter_values['string']) . '%', 'LIKE')
    );
  }

  // Add translation status conditions.
  switch ($filter_values['translation']) {
44
    case 'translated':
45 46 47
      $sql_query->isNotNull('t.translation');
      if ($filter_values['customized'] != 'all') {
        $sql_query->condition('t.customized', $filter_values['customized']);
48
      }
49
      break;
50

51
    case 'untranslated':
52
      $sql_query->isNull('t.translation');
53 54 55 56
      break;

  }

57 58
  $sql_query = $sql_query->extend('Drupal\Core\Database\Query\PagerSelectExtender')->limit(30);
  return $sql_query->execute();
59 60 61
}

/**
62
 * Build array out of search criteria specified in request variables.
63
 */
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
function locale_translate_filter_values() {
  $filter_values = &drupal_static(__FUNCTION__);
  if (!isset($filter_values)) {
    $filter_values = array();
    $filters = locale_translate_filters();
    foreach ($filters as $key => $filter) {
      $filter_values[$key] = $filter['default'];
      // Let the filter defaults be overwritten by parameters in the URL.
      if (isset($_GET[$key])) {
        // Only allow this value if it was among the options, or
        // if there were no fixed options to filter for.
        if (!isset($filter['options']) || isset($filter['options'][$_GET[$key]])) {
          $filter_values[$key] = $_GET[$key];
        }
      }
      elseif (isset($_SESSION['locale_translate_filter'][$key])) {
        // Only allow this value if it was among the options, or
        // if there were no fixed options to filter for.
        if (!isset($filter['options']) || isset($filter['options'][$_SESSION['locale_translate_filter'][$key]])) {
          $filter_values[$key] = $_SESSION['locale_translate_filter'][$key];
        }
85 86 87
      }
    }
  }
88
  return $filter_values;
89 90 91 92 93
}

/**
 * List locale translation filters that can be applied.
 */
94
function locale_translate_filters() {
95 96
  $filters = array();

97
  // Get all languages, except English.
98
  drupal_static_reset('language_list');
99
  $languages = language_list();
100 101 102 103 104
  $language_options = array();
  foreach ($languages as $langcode => $language) {
    if ($langcode != 'en' || locale_translate_english()) {
      $language_options[$langcode] = $language->name;
    }
105
  }
106

107
  // Pick the current interface language code for the filter.
108
  $default_langcode = language(LANGUAGE_TYPE_INTERFACE)->langcode;
109 110 111 112 113
  if (!isset($language_options[$default_langcode])) {
    $available_langcodes = array_keys($language_options);
    $default_langcode = array_shift($available_langcodes);
  }

114 115 116
  $filters['string'] = array(
    'title' => t('String contains'),
    'description' => t('Leave blank to show all strings. The search is case sensitive.'),
117
    'default' => '',
118 119
  );

120 121 122 123
  $filters['langcode'] = array(
    'title' => t('Translation language'),
    'options' => $language_options,
    'default' => $default_langcode,
124 125 126 127
  );

  $filters['translation'] = array(
    'title' => t('Search in'),
128 129 130
    'options' => array(
      'all' => t('Both translated and untranslated strings'),
      'translated' => t('Only translated strings'),
131
      'untranslated' => t('Only untranslated strings'),
132
    ),
133
    'default' => 'all',
134 135 136 137 138 139 140 141 142 143 144 145
  );

  $filters['customized'] = array(
    'title' => t('Translation type'),
    'options' => array(
      'all' => t('All'),
      LOCALE_NOT_CUSTOMIZED => t('Non-customized translation'),
      LOCALE_CUSTOMIZED => t('Customized translation'),
    ),
    'states' => array(
      'visible' => array(
        ':input[name=translation]' => array('value' => 'translated'),
146
      ),
147
    ),
148
    'default' => 'all',
149 150 151 152 153 154 155 156 157 158
  );

  return $filters;
}

/**
 * Return form for locale translation filters.
 *
 * @ingroup forms
 */
159 160 161 162 163 164 165
function locale_translate_filter_form($form, &$form_state) {
  $filters = locale_translate_filters();
  $filter_values = locale_translate_filter_values();

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

  $form['filters'] = array(
    '#type' => 'fieldset',
    '#title' => t('Filter translatable strings'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  foreach ($filters as $key => $filter) {
    // Special case for 'string' filter.
    if ($key == 'string') {
      $form['filters']['status']['string'] = array(
177
        '#type' => 'search',
178 179
        '#title' => $filter['title'],
        '#description' => $filter['description'],
180
        '#default_value' => $filter_values[$key],
181 182 183
      );
    }
    else {
184
      $empty_option = isset($filter['options'][$filter['default']]) ? $filter['options'][$filter['default']] : '<none>';
185 186 187
      $form['filters']['status'][$key] = array(
        '#title' => $filter['title'],
        '#type' => 'select',
188 189
        '#empty_value' => $filter['default'],
        '#empty_option' => $empty_option,
190 191
        '#size' => 0,
        '#options' => $filter['options'],
192
        '#default_value' => $filter_values[$key],
193
      );
194 195 196
      if (isset($filter['states'])) {
        $form['filters']['status'][$key]['#states'] = $filter['states'];
      }
197 198 199 200 201 202 203 204 205 206 207
    }
  }

  $form['filters']['actions'] = array(
    '#type' => 'actions',
    '#attributes' => array('class' => array('container-inline')),
  );
  $form['filters']['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Filter'),
  );
208
  if (!empty($_SESSION['locale_translate_filter'])) {
209 210
    $form['filters']['actions']['reset'] = array(
      '#type' => 'submit',
211
      '#value' => t('Reset'),
212 213 214 215 216 217 218 219 220
    );
  }

  return $form;
}

/**
 * Process result from locale translation filter form.
 */
221
function locale_translate_filter_form_submit($form, &$form_state) {
222
  $op = $form_state['values']['op'];
223
  $filters = locale_translate_filters();
224 225 226 227
  switch ($op) {
    case t('Filter'):
      foreach ($filters as $name => $filter) {
        if (isset($form_state['values'][$name])) {
228
          $_SESSION['locale_translate_filter'][$name] = $form_state['values'][$name];
229 230 231
        }
      }
      break;
232

233
    case t('Reset'):
234
      $_SESSION['locale_translate_filter'] = array();
235
      break;
236

237 238 239 240 241 242
  }

  $form_state['redirect'] = 'admin/config/regional/translate/translate';
}

/**
243 244 245 246 247
 * Form constructor for the string editing form.
 *
 * @see locale_menu()
 * @see locale_translate_edit_form_validate()
 * @see locale_translate_edit_form_submit()
248 249
 *
 * @ingroup forms
250
 */
251 252 253 254 255 256 257 258 259 260 261 262
function locale_translate_edit_form($form, &$form_state) {
  $filter_values = locale_translate_filter_values();
  $langcode = $filter_values['langcode'];

  drupal_static_reset('language_list');
  $languages = language_list();

  $langname = isset($langcode) ? $languages[$langcode]->name : "<none>";

  $path = drupal_get_path('module', 'locale');
  $form['#attached']['css'] = array(
    $path . '/locale.admin.css',
263
  );
264
  $form['#attached']['library'][] = array('locale', 'drupal.locale.admin');
265

266 267 268 269
  $form['langcode'] = array(
    '#type' => 'value',
    '#value' => $filter_values['langcode'],
  );
270

271 272 273 274 275
  $form['strings'] = array(
    '#type' => 'item',
    '#tree' => TRUE,
    '#language' => $langname,
    '#theme' => 'locale_translate_edit_form_strings',
276 277
  );

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  if (isset($langcode)) {
    $strings = locale_translate_query();

    $plural_formulas = variable_get('locale_translation_plurals', array());

    foreach ($strings as $string) {
      // Split source to work with plural values.
      $source_array = explode(LOCALE_PLURAL_DELIMITER, $string->source);
      $translation_array = explode(LOCALE_PLURAL_DELIMITER, $string->translation);
      if (count($source_array) == 1) {
        // Add original string value and mark as non-plural.
        $form['strings'][$string->lid]['plural'] = array(
          '#type' => 'value',
          '#value' => 0,
        );
        $form['strings'][$string->lid]['original'] = array(
          '#type' => 'item',
          '#title' => t('Source string'),
          '#title_display' => 'invisible',
          '#markup' => check_plain($source_array[0]),
        );
299 300
      }
      else {
301 302 303 304 305 306 307
        // Add original string value and mark as plural.
        $form['strings'][$string->lid]['plural'] = array(
          '#type' => 'value',
          '#value' => 1,
        );
        $form['strings'][$string->lid]['original_singular'] = array(
          '#type' => 'item',
308
          '#title' => t('Singular form'),
309
          '#markup' => check_plain($source_array[0]),
310
        );
311 312
        $form['strings'][$string->lid]['original_plural'] = array(
          '#type' => 'item',
313
          '#title' => t('Plural form'),
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
          '#markup' => check_plain($source_array[1]),
        );
      }
      if (!empty($string->context)) {
        $form['strings'][$string->lid]['context'] = array(
          '#type' => 'value',
          '#value' => check_plain($string->context),
        );
      }
      $form['strings'][$string->lid]['location'] = array(
        '#type' => 'value',
        '#value' => $string->location,
      );

      // Approximate the number of rows to use in the default textarea.
      $rows = min(ceil(str_word_count($source_array[0]) / 12), 10);
      if (empty($form['strings'][$string->lid]['plural']['#value'])) {
        $form['strings'][$string->lid]['translations'][0] = array(
          '#type' => 'textarea',
          '#title' => t('Translated string'),
          '#title_display' => 'invisible',
335
          '#rows' => $rows,
336
          '#default_value' => $translation_array[0],
337 338
        );
      }
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
      else {
        // Dealing with plural strings.
        if (isset($plural_formulas[$langcode]['plurals']) && $plural_formulas[$langcode]['plurals'] > 2) {
          // Add a textarea for each plural variant.
          for ($i = 0; $i < $plural_formulas[$langcode]['plurals']; $i++) {
            $form['strings'][$string->lid]['translations'][$i] = array(
              '#type' => 'textarea',
              '#title' => ($i == 0 ? t('Singular form') : format_plural($i, 'First plural form', '@count. plural form')),
              '#rows' => $rows,
              '#default_value' => isset($translation_array[$i]) ? $translation_array[$i] : '',
            );
          }
        }
        else {
          // Fallback for unknown number of plurals.
          $form['strings'][$string->lid]['translations'][0] = array(
            '#type' => 'textarea',
            '#title' => t('Singular form'),
            '#rows' => $rows,
            '#default_value' => $translation_array[0],
          );
          $form['strings'][$string->lid]['translations'][1] = array(
            '#type' => 'textarea',
            '#title' => t('Plural form'),
            '#rows' => $rows,
            '#default_value' => isset($translation_array[1]) ? $translation_array[1] : '',
          );
        }
      }
368
    }
369 370 371
    if (count(element_children($form['strings']))) {
      $form['actions'] = array('#type' => 'actions');
      $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save translations'));
372
    }
373 374 375 376 377
  }
  return $form;
}

/**
378 379 380
 * Form validation handler for locale_translate_edit_form().
 *
 * @see locale_translate_edit_form_submit()
381 382
 */
function locale_translate_edit_form_validate($form, &$form_state) {
383 384 385
  $langcode = $form_state['values']['langcode'];
  foreach ($form_state['values']['strings'] as $lid => $translations) {
    foreach ($translations['translations'] as $key => $value) {
386
      if (!locale_string_is_safe($value)) {
387
        form_set_error("strings][$lid][translations][$key", t('The submitted string contains disallowed HTML: %string', array('%string' => $value)));
388 389 390
        form_set_error("translations][$langcode][$key", t('The submitted string contains disallowed HTML: %string', array('%string' => $value)));
        watchdog('locale', 'Attempted submission of a translation string with disallowed HTML: %string', array('%string' => $value), WATCHDOG_WARNING);
      }
391 392 393 394 395
    }
  }
}

/**
396 397 398
 * Form submission handler for locale_translate_edit_form().
 *
 * @see locale_translate_edit_form_validate()
399 400
 */
function locale_translate_edit_form_submit($form, &$form_state) {
401 402
  $langcode = $form_state['values']['langcode'];
  foreach ($form_state['values']['strings'] as $lid => $translations) {
403
    // Serialize plural variants in one string by LOCALE_PLURAL_DELIMITER.
404 405
    $translation_new = implode(LOCALE_PLURAL_DELIMITER, $translations['translations']);
    $translation_old = db_query("SELECT translation FROM {locales_target} WHERE lid = :lid AND language = :language", array(':lid' => $lid, ':language' => $langcode))->fetchField();
406 407
    // No translation when all strings are empty.
    $has_translation = FALSE;
408
    foreach ($translations['translations'] as $string) {
409 410 411 412 413 414
      if (!empty($string)) {
        $has_translation = TRUE;
        break;
      }
    }
    if ($has_translation) {
415
      // Only update or insert if we have a value to use.
416
      if (!empty($translation_old) && $translation_old != $translation_new) {
417 418
        db_update('locales_target')
          ->fields(array(
419
            'translation' => $translation_new,
420
            'customized' => LOCALE_CUSTOMIZED,
421 422
          ))
          ->condition('lid', $lid)
423
          ->condition('language', $langcode)
424 425
          ->execute();
      }
426
      if (empty($translation_old)) {
427 428 429
        db_insert('locales_target')
          ->fields(array(
            'lid' => $lid,
430
            'translation' => $translation_new,
431
            'language' => $langcode,
432
            'customized' => LOCALE_CUSTOMIZED,
433 434 435 436
          ))
          ->execute();
      }
    }
437
    elseif (!empty($translation_old)) {
438 439 440
      // Empty translation entered: remove existing entry from database.
      db_delete('locales_target')
        ->condition('lid', $lid)
441
        ->condition('language', $langcode)
442 443 444 445 446
        ->execute();
    }

  }

447 448 449 450 451 452
  drupal_set_message(t('The strings have been saved.'));

  // Keep the user on the current pager page.
  if (isset($_GET['page'])) {
    $form_state['redirect'] = array('admin/config/regional/translate', array('query' => array('page' => $_GET['page'])));
  }
453

454 455
  // Force JavaScript translation file recreation for this language.
  _locale_invalidate_js($langcode);
456
  // Clear locale cache.
457
  cache()->invalidateTags(array('locale' => TRUE));
458 459 460
}

/**
461
 * Default theme function for translatione edit form.
462
 */
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
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']),
    );
484
  }
485 486 487 488 489 490 491 492
  $output .= theme('table', array(
    'header' => $header,
    'rows' => $rows,
    'empty' => t('No strings available.'),
    'attributes' => array('class' => array('locale-translate-edit-table')),
  ));
  $output .= theme('pager');
  return $output;
493
}