translation.module 21.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
<?php

/**
 * @file
 *   Manages content translations.
 *
 *   Translations are managed in sets of posts, which represent the same
 *   information in different languages. Only content types for which the
 *   administrator explicitly enabled translations could have translations
 *   associated. Translations are managed in sets with exactly one source
 *   post per set. The source post is used to translate to different
 *   languages, so if the source post is significantly updated, the
 *   editor can decide to mark all translations outdated.
 *
 *   The node table stores the values used by this module:
 *    - 'tnid' is the translation set id, which equals the node id
 *      of the source post.
 *    - 'translate' is a flag, either indicating that the translation
 *      is up to date (0) or needs to be updated (1).
 */

/**
 * Identifies a content type which has translation support enabled.
 */
25
define('TRANSLATION_ENABLED', 2);
26 27

/**
28
 * Implements hook_help().
29
 */
30 31
function translation_help($path, $arg) {
  switch ($path) {
32
    case 'admin/help#translation':
33 34 35 36 37 38 39 40 41 42 43 44 45 46
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Content translation module allows content to be translated into different languages. Working with the <a href="@locale">Locale module</a> (which manages enabled languages and provides translation for the site interface), the Content translation module is key to creating and maintaining translated site content. For more information, see the online handbook entry for <a href="@translation">Content translation module</a>.', array('@locale' => url('admin/help/locale'), '@translation' => 'http://drupal.org/handbook/modules/translation/')) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Configuring content types for translation') . '</dt>';
      $output .= '<dd>' . t('To configure a particular content type for translation, visit the <a href="@content-types">Content types</a> page, and click the <em>edit</em> link for the content type. In the <em>Publishing options</em> section, select <em>Enabled, with translation</em> under <em>Multilingual support</em>.', array('@content-types' => url('admin/structure/types'))) . '</li></ul><dd>';
      $output .= '<dt>' . t('Assigning a language to content') . '</dt>';
      $output .= '<dd>' . t('Use the <em>Language</em> drop down to select the appropriate language when creating or editing content.') . '</dd>';
      $output .= '<dt>' . t('Translating content') . '</dt>';
      $output .= '<dd>' . t('Users with the <em>translate content</em> permission can translate content, if the content type has been configured to allow translations. To translate content, select the <em>Translation</em> tab when viewing the content, select the language for which you wish to provide content, and then enter the content.') . '</dd>';
      $output .= '<dt>' . t('Maintaining translations') . '</dt>';
      $output .= '<dd>' . t('If editing content in one language requires that translated versions also be updated to reflect the change, use the <em>Flag translations as outdated</em> check box to mark the translations as outdated and in need of revision. Individual translations may also be marked for revision by selecting the <em>This translation needs to be updated</em> check box on the translation editing form.') . '</dd>';
      $output .= '</dl>';
47 48
      return $output;
    case 'node/%/translate':
49
      $output = '<p>' . t('Translations of a piece of content are managed with translation sets. Each translation set has one source post and any number of translations in any of the <a href="!languages">enabled languages</a>. All translations are tracked to be up to date or outdated based on whether the source post was modified significantly.', array('!languages' => url('admin/config/regional/language'))) . '</p>';
50 51 52 53 54
      return $output;
  }
}

/**
55
 * Implements hook_menu().
56 57 58 59 60 61 62 63 64 65 66
 */
function translation_menu() {
  $items = array();
  $items['node/%node/translate'] = array(
    'title' => 'Translate',
    'page callback' => 'translation_node_overview',
    'page arguments' => array(1),
    'access callback' => '_translation_tab_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
67
    'file' => 'translation.pages.inc',
68 69 70 71 72 73 74 75 76 77 78
  );
  return $items;
}

/**
 * Menu access callback.
 *
 * Only display translation tab for node types, which have translation enabled
 * and where the current node is not language neutral (which should span
 * all languages).
 */
79
function _translation_tab_access($node) {
80
  if ($node->language != LANGUAGE_NONE && translation_supported_type($node->type) && node_access('view', $node)) {
81 82 83 84 85
    return user_access('translate content');
  }
  return FALSE;
}

86 87 88 89
/**
 * Implements hook_admin_paths().
 */
function translation_admin_paths() {
90 91 92 93 94 95
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/translate' => TRUE,
    );
    return $paths;
  }
96 97
}

98
/**
99
 * Implements hook_permission().
100
 */
101
function translation_permission() {
102
  return array(
103
    'translate content' => array(
104
      'title' => t('Translate content'),
105
    ),
106
  );
107 108
}

109
/**
110
 * Implements hook_form_FORM_ID_alter().
111 112 113 114 115
 */
function translation_form_node_type_form_alter(&$form, &$form_state) {
  // Add translation option to content type form.
  $form['workflow']['language_content_type']['#options'][TRANSLATION_ENABLED] = t('Enabled, with translation');
  // Description based on text from locale.module.
116
  $form['workflow']['language_content_type']['#description'] = t('Enable multilingual support for this content type. If enabled, a language selection field will be added to the editing form, allowing you to select from one of the <a href="!languages">enabled languages</a>. You can also turn on translation for this content type, which lets you have content translated to any of the installed languages. If disabled, new posts are saved with the default language. Existing content will not be affected by changing this option.', array('!languages' => url('admin/config/regional/language')));
117 118
}

119
/**
120
 * Implements hook_form_BASE_FORM_ID_alter().
121
 *
122 123
 * This function alters language fields on node edit forms when a translation is
 * about to be created.
124
 */
125 126
function translation_form_node_form_alter(&$form, &$form_state) {
  if (translation_supported_type($form['#node']->type)) {
127
    $node = $form['#node'];
128 129 130 131 132 133 134 135
    $languages = language_list('enabled');
    $disabled_languages = isset($languages[0]) ? $languages[0] : FALSE;
    $translator_widget = $disabled_languages && user_access('translate content');
    $groups = array(t('Disabled'), t('Enabled'));
    // Allow translators to enter content in disabled languages. Translators
    // might need to distinguish between enabled and disabled languages, hence
    // we divide them in two option groups.
    if ($translator_widget) {
136
      $options = array($groups[1] => array(LANGUAGE_NONE => t('Language neutral')));
137 138 139 140 141 142 143 144 145
      $language_list = locale_language_list('name', TRUE);
      foreach (array(1, 0) as $status) {
        $group = $groups[$status];
        foreach ($languages[$status] as $langcode => $language) {
          $options[$group][$langcode] = $language_list[$langcode];
        }
      }
      $form['language']['#options'] = $options;
    }
146 147 148 149 150 151 152 153 154
    if (!empty($node->translation_source)) {
      // We are creating a translation. Add values and lock language field.
      $form['translation_source'] = array('#type' => 'value', '#value' => $node->translation_source);
      $form['language']['#disabled'] = TRUE;
    }
    elseif (!empty($node->nid) && !empty($node->tnid)) {
      // Disable languages for existing translations, so it is not possible to switch this
      // node to some language which is already in the translation set. Also remove the
      // language neutral option.
155
      unset($form['language']['#options'][LANGUAGE_NONE]);
156
      foreach (translation_node_get_translations($node->tnid) as $langcode => $translation) {
157
        if ($translation->nid != $node->nid) {
158 159 160 161 162 163 164
          if ($translator_widget) {
            $group = $groups[(int)!isset($disabled_languages[$langcode])];
            unset($form['language']['#options'][$group][$langcode]);
          }
          else {
            unset($form['language']['#options'][$langcode]);
          }
165 166 167
        }
      }
      // Add translation values and workflow options.
168
      $form['tnid'] = array('#type' => 'value', '#value' => $node->tnid);
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
      $form['translation'] = array(
        '#type' => 'fieldset',
        '#title' => t('Translation settings'),
        '#access' => user_access('translate content'),
        '#collapsible' => TRUE,
        '#collapsed' => !$node->translate,
        '#tree' => TRUE,
        '#weight' => 30,
      );
      if ($node->tnid == $node->nid) {
        // This is the source node of the translation
        $form['translation']['retranslate'] = array(
          '#type' => 'checkbox',
          '#title' => t('Flag translations as outdated'),
          '#default_value' => 0,
          '#description' => t('If you made a significant change, which means translations should be updated, you can flag all translations of this post as outdated. This will not change any other property of those posts, like whether they are published or not.'),
        );
        $form['translation']['status'] = array('#type' => 'value', '#value' => 0);
      }
      else {
        $form['translation']['status'] = array(
          '#type' => 'checkbox',
          '#title' => t('This translation needs to be updated'),
          '#default_value' => $node->translate,
          '#description' => t('When this option is checked, this translation needs to be updated because the source post has changed. Uncheck when the translation is up to date again.'),
        );
      }
    }
  }
}

/**
201
 * Implements hook_node_view().
202
 *
203 204 205
 * Display translation links with native language names, if this node is part of
 * a translation set. If no language provider is enabled "fall back" to the
 * simple links built through the result of translation_node_get_translations().
206
 */
207
function translation_node_view($node, $view_mode) {
208 209
  // If the site has no translations or is not multilingual we have no content
  // translation links to display.
210
  if (isset($node->tnid) && drupal_multilingual() && $translations = translation_node_get_translations($node->tnid)) {
211 212 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
    $languages = language_list('enabled');
    $languages = $languages[1];

    // There might be a language provider enabled defining custom language
    // switch links which need to be taken into account while generating the
    // content translation links. As custom language switch links are available
    // only for configurable language types and interface language is the only
    // configurable language type in core, we use it as default. Contributed
    // modules can change this behavior by setting the system variable below.
    $type = variable_get('translation_language_type', LANGUAGE_TYPE_INTERFACE);
    $custom_links = language_negotiation_get_switch_links($type, "node/$node->nid");
    $links = array();

    foreach ($translations as $langcode => $translation) {
      // Do not show links to the same node, to unpublished translations or to
      // translations in disabled languages.
      if ($translation->status && isset($languages[$langcode]) && $langcode != $node->language) {
        $language = $languages[$langcode];
        $key = "translation_$langcode";

        if (isset($custom_links->links[$langcode])) {
          $links[$key] = $custom_links->links[$langcode];
        }
        else {
          $links[$key] = array(
            'href' => "node/{$translation->nid}",
            'title' => $language->native,
            'language' => $language,
          );
        }

        // Custom switch links are more generic than content translation links,
        // hence we override existing attributes with the ones below.
        $links[$key] += array('attributes' => array());
        $attributes = array(
          'title' => $translation->title,
          'class' => array('translation-link'),
        );
        $links[$key]['attributes'] = $attributes + $links[$key]['attributes'];
      }
251
    }
252

253 254 255 256 257
    $node->content['links']['translation'] = array(
      '#theme' => 'links__node__translation',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
258 259 260 261
  }
}

/**
262
 * Implements hook_node_prepare().
263
 */
264
function translation_node_prepare($node) {
265
  // Only act if we are dealing with a content type supporting translations.
266 267 268 269 270 271 272
  if (translation_supported_type($node->type) &&
    // And it's a new node.
    empty($node->nid) &&
    // And the user has permission to translate content.
    user_access('translate content') &&
    // And the $_GET variables are set properly.
    isset($_GET['translation']) &&
273
    isset($_GET['target']) &&
274
    is_numeric($_GET['translation'])) {
275

276 277 278 279 280 281 282
    $source_node = node_load($_GET['translation']);
    if (empty($source_node) || !node_access('view', $source_node)) {
      // Source node not found or no access to view. We should not check
      // for edit access, since the translator might not have permissions
      // to edit the source node but should still be able to translate.
      return;
    }
283

284
    $language_list = language_list();
285 286
    $langcode = $_GET['target'];
    if (!isset($language_list[$langcode]) || ($source_node->language == $langcode)) {
287 288 289
      // If not supported language, or same language as source node, break.
      return;
    }
290

291 292 293
    // Ensure we don't have an existing translation in this language.
    if (!empty($source_node->tnid)) {
      $translations = translation_node_get_translations($source_node->tnid);
294 295
      if (isset($translations[$langcode])) {
        drupal_set_message(t('A translation of %title in %language already exists, a new %type will be created instead of a translation.', array('%title' => $source_node->title, '%language' => $language_list[$langcode]->name, '%type' => $node->type)), 'error');
296
        return;
297
      }
298
    }
299

300
    // Populate fields based on source node.
301
    $node->language = $langcode;
302 303 304
    $node->translation_source = $source_node;
    $node->title = $source_node->title;

305 306 307
    // Add field translations and let other modules module add custom translated
    // fields.
    field_attach_prepare_translation('node', $node, $node->language, $source_node, $source_node->language);
308
  }
309
}
310

311
/**
312
 * Implements hook_node_insert().
313
 */
314
function translation_node_insert($node) {
315 316 317 318 319 320
  // Only act if we are dealing with a content type supporting translations.
  if (translation_supported_type($node->type)) {
    if (!empty($node->translation_source)) {
      if ($node->translation_source->tnid) {
        // Add node to existing translation set.
        $tnid = $node->translation_source->tnid;
321
      }
322 323 324
      else {
        // Create new translation set, using nid from the source node.
        $tnid = $node->translation_source->nid;
325 326 327 328 329 330 331
        db_update('node')
          ->fields(array(
            'tnid' => $tnid,
            'translate' => 0,
          ))
          ->condition('nid', $node->translation_source->nid)
          ->execute();
332
      }
333 334 335 336 337 338 339
      db_update('node')
        ->fields(array(
          'tnid' => $tnid,
          'translate' => 0,
        ))
        ->condition('nid', $node->nid)
        ->execute();
340 341
      // Save tnid to avoid loss in case of resave.
      $node->tnid = $tnid;
342 343 344
    }
  }
}
345

346
/**
347
 * Implements hook_node_update().
348
 */
349
function translation_node_update($node) {
350 351 352 353
  // Only act if we are dealing with a content type supporting translations.
  if (translation_supported_type($node->type)) {
    if (isset($node->translation) && $node->translation && !empty($node->language) && $node->tnid) {
      // Update translation information.
354 355 356 357 358 359 360
      db_update('node')
        ->fields(array(
          'tnid' => $node->tnid,
          'translate' => $node->translation['status'],
        ))
        ->condition('nid', $node->nid)
        ->execute();
361 362
      if (!empty($node->translation['retranslate'])) {
        // This is the source node, asking to mark all translations outdated.
363 364 365 366 367
        db_update('node')
          ->fields(array('translate' => 1))
          ->condition('nid', $node->nid, '<>')
          ->condition('tnid', $node->tnid)
          ->execute();
368
      }
369
    }
370 371 372
  }
}

373
/**
374
 * Implements hook_node_validate().
375 376 377
 *
 * Ensure that duplicate translations can not be created for the same source.
 */
378
function translation_node_validate($node, $form) {
379 380 381 382 383 384 385 386 387 388
  // Only act on translatable nodes with a tnid or translation_source.
  if (translation_supported_type($node->type) && (!empty($node->tnid) || !empty($form['#node']->translation_source->nid))) {
    $tnid = !empty($node->tnid) ? $node->tnid : $form['#node']->translation_source->nid;
    $translations = translation_node_get_translations($tnid);
    if (isset($translations[$node->language]) && $translations[$node->language]->nid != $node->nid ) {
      form_set_error('language', t('There is already a translation in this language.'));
    }
  }
}

389
/**
390
 * Implements hook_node_delete().
391
 */
392
function translation_node_delete($node) {
393 394 395 396 397
  // Only act if we are dealing with a content type supporting translations.
  if (translation_supported_type($node->type)) {
    translation_remove_from_set($node);
  }
}
398

399 400 401 402
/**
 * Remove a node from its translation set (if any)
 * and update the set accordingly.
 */
403
function translation_remove_from_set($node) {
404
  if (isset($node->tnid)) {
405 406 407 408 409 410
    $query = db_update('node')
      ->fields(array(
        'tnid' => 0,
        'translate' => 0,
      ));
    if (db_query('SELECT COUNT(*) FROM {node} WHERE tnid = :tnid', array(':tnid' => $node->tnid))->fetchField() == 1) {
411
      // There is only one node left in the set: remove the set altogether.
412 413 414
      $query
        ->condition('tnid', $node->tnid)
        ->execute();
415 416
    }
    else {
417 418 419
      $query
        ->condition('nid', $node->nid)
        ->execute();
420 421 422 423

      // If the node being removed was the source of the translation set,
      // we pick a new source - preferably one that is up to date.
      if ($node->tnid == $node->nid) {
424 425 426 427 428
        $new_tnid = db_query('SELECT nid FROM {node} WHERE tnid = :tnid ORDER BY translate ASC, nid ASC', array(':tnid' => $node->tnid))->fetchField();
        db_update('node')
          ->fields(array('tnid' => $new_tnid))
          ->condition('tnid', $node->tnid)
          ->execute();
429 430
      }
    }
431 432 433
  }
}

434 435 436 437 438 439 440
/**
 * Get all nodes in a translation set, represented by $tnid.
 *
 * @param $tnid
 *   The translation source nid of the translation set, the identifier
 *   of the node used to derive all translations in the set.
 * @return
441 442 443
 *   Array of partial node objects (nid, title, language) representing
 *   all nodes in the translation set, in effect all translations
 *   of node $tnid, including node $tnid itself. Because these are
444
 *   partial nodes, you need to node_load() the full node, if you
445
 *   need more properties. The array is indexed by language code.
446 447 448
 */
function translation_node_get_translations($tnid) {
  if (is_numeric($tnid) && $tnid) {
449 450
    $translations = &drupal_static(__FUNCTION__, array());

451 452
    if (!isset($translations[$tnid])) {
      $translations[$tnid] = array();
453
      $result = db_select('node', 'n')
454
        ->fields('n', array('nid', 'type', 'uid', 'status', 'title', 'language'))
455 456 457 458 459
        ->condition('n.tnid', $tnid)
        ->addTag('node_access')
        ->execute();

      foreach ($result as $node) {
460 461 462 463 464 465 466 467 468 469 470 471 472 473
        $translations[$tnid][$node->language] = $node;
      }
    }
    return $translations[$tnid];
  }
}

/**
 * Returns whether the given content type has support for translations.
 *
 * @return
 *   Boolean value.
 */
function translation_supported_type($type) {
474
  return variable_get('language_content_type_' . $type, 0) == TRANSLATION_ENABLED;
475
}
476 477 478

/**
 * Return paths of all translations of a node, based on
479
 * its Drupal path.
480 481 482 483
 *
 * @param $path
 *   A Drupal path, for example node/432.
 * @return
484
 *   An array of paths of translations of the node accessible
485 486 487 488 489
 *   to the current user keyed with language codes.
 */
function translation_path_get_translations($path) {
  $paths = array();
  // Check for a node related path, and for its translations.
490
  if ((preg_match("!^node/(\d+)(/.+|)$!", $path, $matches)) && ($node = node_load((int) $matches[1])) && !empty($node->tnid)) {
491
    foreach (translation_node_get_translations($node->tnid) as $language => $translation_node) {
492
      $paths[$language] = 'node/' . $translation_node->nid . $matches[2];
493 494 495 496 497 498
    }
  }
  return $paths;
}

/**
499
 * Implements hook_language_switch_links_alter().
500 501 502
 *
 * Replaces links with pointers to translated versions of the content.
 */
503
function translation_language_switch_links_alter(array &$links, $type, $path) {
504
  $language_type = variable_get('translation_language_type', LANGUAGE_TYPE_INTERFACE);
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

  if ($type == $language_type && preg_match("!^node/(\d+)(/.+|)!", $path, $matches)) {
    $node = node_load((int) $matches[1]);

    if (empty($node->tnid)) {
      // If the node cannot be found nothing needs to be done. If it does not
      // have translations it might be a language neutral node, in which case we
      // must leave the language switch links unaltered. This is true also for
      // nodes not having translation support enabled.
      if (empty($node) || $node->language == LANGUAGE_NONE || !translation_supported_type($node->type)) {
        return;
      }
      $translations = array($node->language => $node);
    }
    else {
      $translations = translation_node_get_translations($node->tnid);
    }
522

523
    foreach ($links as $langcode => $link) {
524
      if (isset($translations[$langcode]) && $translations[$langcode]->status) {
525
        // Translation in a different node.
526
        $links[$langcode]['href'] = 'node/' . $translations[$langcode]->nid . $matches[2];
527 528 529
      }
      else {
        // No translation in this language, or no permission to view.
530 531
        unset($links[$langcode]['href']);
        $links[$langcode]['attributes']['class'] = 'locale-untranslated';
532 533 534 535
      }
    }
  }
}