translation.module 18.1 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 25
<?php
// $Id$

/**
 * @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.
 */
26
define('TRANSLATION_ENABLED', 2);
27 28

/**
29
 * Implements hook_help().
30
 */
31 32
function translation_help($path, $arg) {
  switch ($path) {
33
    case 'admin/help#translation':
34 35
      $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.', array('@locale' => url('admin/help/locale'))) . '</p>';
      $output .= '<p>' . t('Configuring content translation and translation-enabled content types:') . '</p>';
36
      $output .= '<ul><li>' . t('Assign the <em>translate content</em> permission to the appropriate user roles at the <a href="@permissions">Permissions configuration page</a>.', array('@permissions' => url('admin/config/people/permissions'))) . '</li>';
37
      $output .= '<li>' . t('Add and enable desired languages at the <a href="@languages">Languages configuration page</a>.', array('@languages' => url('admin/config/regional/language'))) . '</li>';
38
      $output .= '<li>' . t('Determine which <a href="@content-types">content types</a> should support translation features. To enable translation support for a content type, edit the type and at the <em>Multilingual support</em> drop down, select <em>Enabled, with translation</em>. (<em>Multilingual support</em> is located within <em>Publishing options</em>.) Be sure to save each content type after enabling multilingual support.', array('@content-types' => url('admin/structure/types'))) . '</li></ul>';
39 40 41 42
      $output .= '<p>' . t('Working with translation-enabled content types:') . '</p>';
      $output .= '<ul><li>' . t('Use the <em>Language</em> drop down to select the appropriate language when creating or editing posts.') . '</li>';
      $output .= '<li>' . t('Provide new or edit current translations for existing posts via the <em>Translation</em> tab. Only visible while viewing a post as a user with the <em>translate content</em> permission, this tab allows translations to be added or edited using a specialized editing form that also displays the content being translated.') . '</li>';
      $output .= '<li>' . t('Update translations as needed, so that they accurately reflect changes in the content of the original post. The translation status flag provides a simple method for tracking outdated translations. After editing a post, for example, select the <em>Flag translations as outdated</em> check box to mark all of its translations as outdated and in need of revision. Individual translations may be marked for revision by selecting the <em>This translation needs to be updated</em> check box on the translation editing form.') . '</li>';
43
      $output .= '<li>' . t('The <a href="@content-node">Content management administration page</a> displays the language of each post, and also allows filtering by language or translation status.', array('@content-node' => url('admin/content'))) . '</li></ul>';
44
      $output .= '<p>' . t('Use the <a href="@blocks">language switcher block</a> provided by locale module to allow users to select a language. If available, both the site interface and site content are presented in the language selected.', array('@blocks' => url('admin/structure/block'))) . '</p>';
45
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@translation">Translation module</a>.', array('@translation' => 'http://drupal.org/handbook/modules/translation/')) . '</p>';
46 47
      return $output;
    case 'node/%/translate':
48
      $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/settings/language'))) . '</p>';
49 50 51 52 53
      return $output;
  }
}

/**
54
 * Implements hook_menu().
55 56 57 58 59 60 61 62 63 64 65
 */
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,
66
    'file' => 'translation.pages.inc',
67 68 69 70 71 72 73 74 75 76 77
  );
  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).
 */
78
function _translation_tab_access($node) {
79
  if ($node->language != LANGUAGE_NONE && translation_supported_type($node->type)) {
80 81 82 83 84 85
    return user_access('translate content');
  }
  return FALSE;
}

/**
86
 * Implements hook_permission().
87
 */
88
function translation_permission() {
89
  return array(
90
    'translate content' => array(
91
      'title' => t('Translate content'),
92
    ),
93
  );
94 95
}

96
/**
97
 * Implements hook_form_FORM_ID_alter().
98 99 100 101 102 103 104 105
 */
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.
  $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 enabled 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/settings/language')));
}

106
/**
107
 * Implements hook_form_alter().
108 109 110 111 112
 *
 * - Add translation option to content type form.
 * - Alters language fields on node forms when a translation
 *   is about to be created.
 */
113 114
function translation_form_alter(&$form, &$form_state, $form_id) {
  if (isset($form['#id']) && $form['#id'] == 'node-form' && translation_supported_type($form['#node']->type)) {
115 116 117 118 119 120 121 122 123 124
    $node = $form['#node'];
    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.
125
      unset($form['language']['#options'][LANGUAGE_NONE]);
126 127 128 129 130 131
      foreach (translation_node_get_translations($node->tnid) as $translation) {
        if ($translation->nid != $node->nid) {
          unset($form['language']['#options'][$translation->language]);
        }
      }
      // Add translation values and workflow options.
132
      $form['tnid'] = array('#type' => 'value', '#value' => $node->tnid);
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
      $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.'),
        );
      }
    }
  }
}

/**
165
 * Implements hook_node_view().
166 167 168 169
 *
 * Display translation links with native language names, if this node
 * is part of a translation set.
 */
170
function translation_node_view($node, $build_mode) {
171
  if (isset($node->tnid) && $translations = translation_node_get_translations($node->tnid)) {
172 173 174 175 176 177 178 179 180 181 182
    $path = 'node/' . $node->nid;
    $links = language_negotiation_get_switch_links(LANGUAGE_TYPE_CONTENT, $path);
    if (is_object($links)) {
      $links = $links->links;
      // Do not show link to the same node.
      unset($links[$node->language]);
      $node->content['links']['translation'] = array(
        '#theme' => 'links',
        '#links' => $links,
        '#attributes' => array('class' => array('links', 'inline')),
      );
183 184 185 186 187
    }
  }
}

/**
188
 * Implements hook_node_prepare().
189
 */
190
function translation_node_prepare($node) {
191
  // Only act if we are dealing with a content type supporting translations.
192 193 194 195 196 197
  if (translation_supported_type($node->type)) {
    if (empty($node->nid) && isset($_GET['translation']) && isset($_GET['language']) &&
        ($source_nid = $_GET['translation']) && ($language = $_GET['language']) &&
        (user_access('translate content'))) {
      // We are translating a node from a source node, so
      // load the node to be translated and populate fields.
198 199 200 201 202 203
      $source_node = node_load($source_nid);
      // Ensure we don't have an existing translation in this language.
      if (!empty($source_node->tnid)) {
        $translations = translation_node_get_translations($source_node->tnid);
        if (isset($translations[$language])) {
          $languages = language_list();
204
          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_NONE][0]['value'], '%language' => $languages[$language]->name, '%type' => $node->type)), 'error');
205 206 207
          return;
        }
      }
208
      $node->language = $language;
209
      $node->translation_source = $source_node;
210 211
      $node->title = $node->translation_source->title;
      // Let every module add custom translated fields.
212
      module_invoke_all('node_prepare_translation', $node);
213
    }
214
  }
215
}
216

217
/**
218
 * Implements hook_node_insert().
219
 */
220
function translation_node_insert($node) {
221 222 223 224 225 226
  // 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;
227
      }
228 229 230
      else {
        // Create new translation set, using nid from the source node.
        $tnid = $node->translation_source->nid;
231 232 233 234 235 236 237
        db_update('node')
          ->fields(array(
            'tnid' => $tnid,
            'translate' => 0,
          ))
          ->condition('nid', $node->translation_source->nid)
          ->execute();
238
      }
239 240 241 242 243 244 245
      db_update('node')
        ->fields(array(
          'tnid' => $tnid,
          'translate' => 0,
        ))
        ->condition('nid', $node->nid)
        ->execute();
246 247 248
    }
  }
}
249

250
/**
251
 * Implements hook_node_update().
252
 */
253
function translation_node_update($node) {
254 255 256 257
  // 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.
258 259 260 261 262 263 264
      db_update('node')
        ->fields(array(
          'tnid' => $node->tnid,
          'translate' => $node->translation['status'],
        ))
        ->condition('nid', $node->nid)
        ->execute();
265 266
      if (!empty($node->translation['retranslate'])) {
        // This is the source node, asking to mark all translations outdated.
267 268 269 270 271
        db_update('node')
          ->fields(array('translate' => 1))
          ->condition('nid', $node->nid, '<>')
          ->condition('tnid', $node->tnid)
          ->execute();
272
      }
273
    }
274 275 276
  }
}

277
/**
278
 * Implements hook_node_validate().
279 280 281
 *
 * Ensure that duplicate translations can not be created for the same source.
 */
282
function translation_node_validate($node, $form) {
283 284 285 286 287 288 289 290 291 292
  // 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.'));
    }
  }
}

293
/**
294
 * Implements hook_node_delete().
295
 */
296
function translation_node_delete($node) {
297 298 299 300 301
  // Only act if we are dealing with a content type supporting translations.
  if (translation_supported_type($node->type)) {
    translation_remove_from_set($node);
  }
}
302

303 304 305 306
/**
 * Remove a node from its translation set (if any)
 * and update the set accordingly.
 */
307
function translation_remove_from_set($node) {
308
  if (isset($node->tnid)) {
309 310 311 312 313 314
    $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) {
315
      // There is only one node left in the set: remove the set altogether.
316 317 318
      $query
        ->condition('tnid', $node->tnid)
        ->execute();
319 320
    }
    else {
321 322 323
      $query
        ->condition('nid', $node->nid)
        ->execute();
324 325 326 327

      // 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) {
328 329 330 331 332
        $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();
333 334
      }
    }
335 336 337
  }
}

338 339 340 341 342 343 344
/**
 * 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
345 346 347
 *   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
348
 *   partial nodes, you need to node_load() the full node, if you
349
 *   need more properties. The array is indexed by language code.
350 351 352
 */
function translation_node_get_translations($tnid) {
  if (is_numeric($tnid) && $tnid) {
353 354
    $translations = &drupal_static(__FUNCTION__, array());

355 356
    if (!isset($translations[$tnid])) {
      $translations[$tnid] = array();
357 358 359 360 361 362 363
      $result = db_select('node', 'n')
        ->fields('n', array('nid', 'title', 'language'))
        ->condition('n.tnid', $tnid)
        ->addTag('node_access')
        ->execute();

      foreach ($result as $node) {
364 365 366 367 368 369 370 371 372 373 374 375 376 377
        $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) {
378
  return variable_get('language_content_type_' . $type, 0) == TRANSLATION_ENABLED;
379
}
380 381 382

/**
 * Return paths of all translations of a node, based on
383
 * its Drupal path.
384 385 386 387
 *
 * @param $path
 *   A Drupal path, for example node/432.
 * @return
388
 *   An array of paths of translations of the node accessible
389 390 391 392 393 394 395
 *   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.
  if ((preg_match("!^node/([0-9]+)(/.+|)$!", $path, $matches)) && ($node = node_load((int)$matches[1])) && !empty($node->tnid)) {
    foreach (translation_node_get_translations($node->tnid) as $language => $translation_node) {
396
      $paths[$language] = 'node/' . $translation_node->nid . $matches[2];
397 398 399 400 401 402
    }
  }
  return $paths;
}

/**
403
 * Implements hook_language_switch_link_alter().
404 405 406
 *
 * Replaces links with pointers to translated versions of the content.
 */
407 408
function translation_language_switch_links_alter(array &$links, $type, $path) {
  if ($type == LANGUAGE_TYPE_CONTENT && $paths = translation_path_get_translations($path)) {
409 410 411 412 413 414 415 416 417 418 419 420
    foreach ($links as $langcode => $link) {
      if (isset($paths[$langcode])) {
        // Translation in a different node.
        $links[$langcode]['href'] = $paths[$langcode];
      }
      else {
        // No translation in this language, or no permission to view.
        unset($links[$langcode]);
      }
    }
  }
}