path: root/modules/path/path.module

<?php
// $Id$

/**
 * @file
 * Enables users to rename URLs.
 */

/**
 * Implementation of hook_help().
 */
function path_help($path, $arg) {
  switch ($path) {
    case 'admin/help#path':
      $output = '<p>' . t('The path module allows you to specify aliases for Drupal URLs. Such aliases improve readability of URLs for your users and may help internet search engines to index your content more effectively. More than one alias may be created for a given page.') . '</p>';
      $output .= '<p>' . t('Some examples of URL aliases are:') . '</p>';
      $output .= '<ul><li>' . t('%alias for the path %path', array('%alias' => 'login', '%path' => 'user/login')) . '</li>';
      $output .= '<li>' . t('%alias for the path %path', array('%alias' => 'store', '%path' => 'image/tid/16')) . '</li>';
      $output .= '<li>' . t('%alias for the path %path', array('%alias' => 'store/products/whirlygigs', '%path' => 'taxonomy/term/7+19+20+21')) . '</li>';
      $output .= '<li>' . t('%alias for the path %path', array('%alias' => 'contact', '%path' => 'node/3')) . '</li></ul>';
      $output .= '<p>' . t('The path module enables appropriately permissioned users to specify an optional alias in all node input and editing forms, and provides an interface to view and edit all URL aliases. The two permissions related to URL aliasing are <em>administer url aliases</em> and <em>create url aliases</em>.') . ' </p>';
      $output .= '<p>' . t('This module also provides user-defined mass URL aliasing capabilities, which is useful if you wish to uniformly use URLs different from the default. For example, you may want to have your URLs presented in a different language. Access to the Drupal source code on the web server is required to set up mass URL aliasing.') . ' </p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@path">Path module</a>.', array('@path' => 'http://drupal.org/handbook/modules/path/')) . '</p>';
      return $output;
    case 'admin/build/path':
      return '<p>' . t("Drupal provides complete control over URLs through aliasing, which is often used to make URLs more readable or easy to remember. For example, the alias 'about' may be mapped onto the post at the system path 'node/1', creating a more meaningful URL. Each system path can have multiple aliases.") . '</p>';
    case 'admin/build/path/add':
      return '<p>' . t('Enter the path you wish to create the alias for, followed by the name of the new alias.') . '</p>';
  }
}

/**
 * Implementation of hook_menu().
 */
function path_menu() {
  $items['admin/build/path'] = array(
    'title' => 'URL aliases',
    'description' => "Change your site's URL paths by aliasing them.",
    'page callback' => 'path_admin_overview',
    'access arguments' => array('administer url aliases'),
  );
  $items['admin/build/path/edit'] = array(
    'title' => 'Edit alias',
    'page callback' => 'path_admin_edit',
    'access arguments' => array('administer url aliases'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/path/delete'] = array(
    'title' => 'Delete alias',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('path_admin_delete_confirm'),
    'access arguments' => array('administer url aliases'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/path/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/build/path/add'] = array(
    'title' => 'Add alias',
    'page callback' => 'path_admin_edit',
    'access arguments' => array('administer url aliases'),
    'type' => MENU_LOCAL_TASK,
  );

  return $items;
}

/**
 * Post-confirmation; delete an URL alias.
 */
function path_admin_delete($pid = 0) {
  db_delete('url_alias')
    ->condition('pid', $pid)
    ->execute();
  drupal_set_message(t('The alias has been deleted.'));
}

/**
 * Set an aliased path for a given Drupal path, preventing duplicates.
 */
function path_set_alias($path = NULL, $alias = NULL, $pid = NULL, $language = '') {
  $path = urldecode($path);
  $alias = urldecode($alias);
  // First we check if we deal with an existing alias and delete or modify it based on pid.
  if ($pid) {
    // An existing alias.
    if (!$path || !$alias) {
      // Delete the alias based on pid.
      db_delete('url_alias')
        ->condition('pid', $pid)
        ->execute();
    }
    else {
      // Update the existing alias.
      db_update('url_alias')
        ->fields(array(
          'src'      => $path,
          'dst'      => $alias,
          'language' => $language))
        ->condition('pid', $pid)
        ->execute();
    }
  }
  elseif ($path && $alias) {
    // Check for existing aliases.
    if ($alias == drupal_get_path_alias($path, $language)) {
      // There is already such an alias, neutral or in this language.
      // Update the alias based on alias; setting the language if not yet done.
      db_update('url_alias')
        ->fields(array(
          'src' => $path,
          'dst' => $alias,
          'language' => $language
        ))
        ->condition('dst', $alias)
        ->execute();
    }
    else {
      // A new alias. Add it to the database.
      db_insert('url_alias')
        ->fields(array(
          'src'     => $path,
          'dst'      => $alias,
          'language' => $language,
        ))
        ->execute();
    }
  }
  else {
    // Delete the alias.
    if ($alias) {
      db_delete('url_alias')
        ->condition('dst', $alias)
        ->execute();
    }
    else {
      db_delete('url_alias')
        ->condition('src', $path)
        ->execute();
    }
  }
  drupal_clear_path_cache();
}

/**
 * Implementation of hook_node_validate().
 */
function path_node_validate($node, $form) {
  if (user_access('create url aliases') || user_access('administer url aliases')) {
    if (isset($node->path)) {
      $language = isset($node->language) ? $node->language : '';
      $node->path = trim($node->path);
      $has_alias = db_query("SELECT COUNT(dst) FROM {url_alias} WHERE src <> :src AND dst = :dst AND language = :language", array(
        ':src' => "node/$node->nid",
        ':dst' => $node->path,
        ':language' => $language,
      ))
      ->fetchField();

      if ($has_alias) {
        form_set_error('path', t('The path is already in use.'));
      }
    }
  }
}

/**
 * Implementation of hook_node_load().
 */
function path_node_load($nodes, $types) {
  foreach ($nodes as $node) {
    $language = isset($node->language) ? $node->language : '';
    $path = 'node/' . $node->nid;
    $alias = drupal_get_path_alias($path, $language);
    if ($path != $alias) {
      $node->path = $alias;
    }
  }
}

/**
 * Implementation of hook_node_insert().
 */
function path_node_insert($node) {
  if (user_access('create url aliases') || user_access('administer url aliases')) {
    $language = isset($node->language) ? $node->language : '';
    // Don't try to insert if path is NULL. We may have already set
    // the alias ahead of time.
    if (isset($node->path)) {
      path_set_alias('node/' . $node->nid, $node->path, NULL, $language);
    }
  }
}

/**
 * Implementation of hook_node_update().
 */
function path_node_update($node) {
  if (user_access('create url aliases') || user_access('administer url aliases')) {
    $language = isset($node->language) ? $node->language : '';
    path_set_alias('node/' . $node->nid, isset($node->path) ? $node->path : NULL, isset($node->pid) ? $node->pid : NULL, $language);
  }
}

/**
 * Implementation of hook_node_delete().
 */
function path_node_delete($node) {
  if (user_access('create url aliases') || user_access('administer url aliases')) {
    $language = isset($node->language) ? $node->language : '';
    $path = 'node/' . $node->nid;
    if (drupal_get_path_alias($path) != $path) {
      path_set_alias($path);
    }
  }
}

/**
 * Implementation of hook_form_alter().
 */
function path_form_alter(&$form, $form_state, $form_id) {
  if (!empty($form['#node_edit_form'])) {
    $path = isset($form['#node']->path) ? $form['#node']->path : NULL;
    $form['path'] = array(
      '#type' => 'fieldset',
      '#title' => t('URL path settings'),
      '#collapsible' => TRUE,
      '#collapsed' => empty($path),
      '#group' => 'additional_settings',
      '#attached_js' => array(drupal_get_path('module', 'path') . '/path.js'),
      '#access' => user_access('create url aliases'),
      '#weight' => 30,
    );
    $form['path']['path'] = array(
      '#type' => 'textfield',
      '#title' => t('URL alias'),
      '#default_value' => $path,
      '#maxlength' => 128,
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#description' => t('Optionally specify an alternative URL by which this node can be accessed. For example, type "about" when writing an about page. Use a relative path and don\'t add a trailing slash or the URL alias won\'t work.'),
    );
    if ($path) {
      $form['path']['pid'] = array(
        '#type' => 'value',
        '#value' => db_query("SELECT pid FROM {url_alias} WHERE dst = :dst AND language = :language", array(
          ':dst' => $path,
          ':language' => $form['#node']->language
        ))
        ->fetchField(),
      );
    }
  }
}

/**
 * Implementation of hook_perm().
 */
function path_perm() {
  return array(
    'administer url aliases' => array(
      'title' => t('Administer URL aliases'),
      'description' => t('Manage URL aliases across the entire website.'),
    ),
    'create url aliases' => array(
      'title' => t('Create URL aliases'),
      'description' => t('Manage URL aliases on content.'),
    ),
  );
}

/**
 * Fetch a specific URL alias from the database.
 */
function path_load($pid) {
  return db_query('SELECT * FROM {url_alias} WHERE pid = :pid', array(':pid' => $pid))->fetchAssoc();
}