path.module 7.83 KB
Newer Older
Steven Wittens's avatar
Steven Wittens committed
1
2
3
4
5
6
7
8
9
10
11
<?php
// $Id$

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

/**
 * Implementation of hook_help().
 */
12
13
function path_help($path, $arg) {
  switch ($path) {
Steven Wittens's avatar
Steven Wittens committed
14
15
16
17
18
19
20
21
22
23
    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 .= t('<p>Some examples of URL aliases are:</p>
<ul>
<li>user/login =&gt; login</li>
<li>image/tid/16 =&gt; store</li>
<li>taxonomy/term/7+19+20+21 =&gt; store/products/whirlygigs</li>
<li>node/3 =&gt; contact</li>
</ul>
');
24
      $output .= '<p>'. t('The path module enables an extra field for aliases in all node input and editing forms (when users have the appropriate permissions). It also provides an interface to view and edit all URL aliases. The two permissions related to URL aliasing are "administer url aliases" and "create url aliases". ') .'</p>';
Steven Wittens's avatar
Steven Wittens committed
25
26
27
28
      $output .= '<p>'. t('This module also comes with 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 these kinds of aliases. ') .'</p>';
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@path">Path page</a>.', array('@path' => 'http://drupal.org/handbook/modules/path/')) .'</p>';
      return $output;
    case 'admin/build/path':
29
      return '<p>'. t("Drupal provides users complete control over URLs through aliasing. This feature is typically used to make URLs human-readable or easy to remember. For example, one could map the relative URL 'node/1' onto 'about'. Each system path can have multiple aliases.") .'</p>';
Steven Wittens's avatar
Steven Wittens committed
30
    case 'admin/build/path/add':
31
      return '<p>'. t('Enter the path you wish to create the alias for, followed by the name of the new alias.') .'</p>';
Steven Wittens's avatar
Steven Wittens committed
32
33
34
35
36
37
  }
}

/**
 * Implementation of hook_menu().
 */
38
39
function path_menu() {
  $items['admin/build/path'] = array(
40
41
    'title' => 'URL aliases',
    'description' => "Change your site's URL paths by aliasing them.",
42
    'page callback' => 'path_admin_overview',
43
    'access arguments' => array('administer url aliases'),
44
    'file' => 'path.admin.inc',
45
46
  );
  $items['admin/build/path/edit'] = array(
47
    'title' => 'Edit alias',
48
    'page callback' => 'path_admin_edit',
49
    'type' => MENU_CALLBACK,
50
    'file' => 'path.admin.inc',
51
52
  );
  $items['admin/build/path/delete'] = array(
53
    'title' => 'Delete alias',
54
55
56
    'page callback' => 'drupal_get_form',
    'page arguments' => array('path_admin_delete_confirm'),
    'type' => MENU_CALLBACK,
57
    'file' => 'path.admin.inc',
58
59
  );
  $items['admin/build/path/list'] = array(
60
    'title' => 'List',
61
62
63
64
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/build/path/add'] = array(
65
    'title' => 'Add alias',
66
    'page callback' => 'path_admin_edit',
67
68
    'access arguments' => array('administer url aliases'),
    'type' => MENU_LOCAL_TASK,
69
    'file' => 'path.admin.inc',
70
  );
Steven Wittens's avatar
Steven Wittens committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

  return $items;
}

/**
 * Post-confirmation; delete an URL alias.
 */
function path_admin_delete($pid = 0) {
  db_query('DELETE FROM {url_alias} WHERE pid = %d', $pid);
  drupal_set_message(t('The alias has been deleted.'));
}

/**
 * Set an aliased path for a given Drupal path, preventing duplicates.
 */
86
function path_set_alias($path = NULL, $alias = NULL, $pid = NULL, $language = '') {
87
88
89
90
91
92
93
94
95
96
97
98
99
  $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_query('DELETE FROM {url_alias} WHERE pid = %d', $pid);
    }
    else {
      // Update the existing alias.
      db_query("UPDATE {url_alias} SET src = '%s', dst = '%s', language = '%s' WHERE pid = %d", $path, $alias, $language, $pid);
    }
Steven Wittens's avatar
Steven Wittens committed
100
101
  }
  else if ($path && $alias) {
102
103
104
105
106
    // 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_query("UPDATE {url_alias} SET src = '%s', dst = '%s', language = '%s' WHERE dst = '%s'", $path, $alias, $language, $alias);
Steven Wittens's avatar
Steven Wittens committed
107
    }
108
    else {
109
110
      // A new alias. Add it to the database.
      db_query("INSERT INTO {url_alias} (src, dst, language) VALUES ('%s', '%s', '%s')", $path, $alias, $language);
Steven Wittens's avatar
Steven Wittens committed
111
    }
112
113
114
115
116
  }
  else {
    // Delete the alias.
    if ($alias) {
      db_query("DELETE FROM {url_alias} WHERE dst = '%s'", $alias);
Steven Wittens's avatar
Steven Wittens committed
117
    }
118
119
120
    else {
      db_query("DELETE FROM {url_alias} WHERE src = '%s'", $path);
    }  
Steven Wittens's avatar
Steven Wittens committed
121
  }
122
  drupal_clear_path_cache();
Steven Wittens's avatar
Steven Wittens committed
123
124
}

125

Steven Wittens's avatar
Steven Wittens committed
126
127
128
129
130
131
132
133
/**
 * Implementation of hook_nodeapi().
 *
 * Allows URL aliases for nodes to be specified at node edit time rather
 * than through the administrative interface.
 */
function path_nodeapi(&$node, $op, $arg) {
  if (user_access('create url aliases') || user_access('administer url aliases')) {
134
    $language = isset($node->language) ? $node->language : '';
Steven Wittens's avatar
Steven Wittens committed
135
136
137
    switch ($op) {
      case 'validate':
        $node->path = trim($node->path);
138
        if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE dst = '%s' AND src != '%s' AND language = '%s'", $node->path, "node/$node->nid", $language))) {
Steven Wittens's avatar
Steven Wittens committed
139
140
141
142
143
          form_set_error('path', t('The path is already in use.'));
        }
        break;

      case 'load':
144
        $path = 'node/'. $node->nid;
145
146
147
        $alias = drupal_get_path_alias($path, $language);
        if ($path != $alias) {
          $node->path = $alias;
Steven Wittens's avatar
Steven Wittens committed
148
149
150
151
152
153
        }
        break;

      case 'insert':
        // Don't try to insert if path is NULL. We may have already set
        // the alias ahead of time.
154
        if (isset($node->path)) {
155
          path_set_alias('node/'. $node->nid, $node->path, NULL, $language);
Steven Wittens's avatar
Steven Wittens committed
156
157
158
159
        }
        break;

      case 'update':
160
        path_set_alias('node/'. $node->nid, isset($node->path) ? $node->path : NULL, isset($node->pid) ? $node->pid : NULL, $language);
Steven Wittens's avatar
Steven Wittens committed
161
162
163
        break;

      case 'delete':
164
        $path = 'node/'. $node->nid;
Steven Wittens's avatar
Steven Wittens committed
165
166
167
168
169
170
171
172
173
174
175
        if (drupal_get_path_alias($path) != $path) {
          path_set_alias($path);
        }
        break;
    }
  }
}

/**
 * Implementation of hook_form_alter().
 */
176
function path_form_alter(&$form, $form_state, $form_id) {
177
  if (isset($form['type']) && isset($form['#node']) && $form['type']['#value'] .'_node_form' == $form_id) {
178
    $path = isset($form['#node']->path) ? $form['#node']->path : NULL;
Steven Wittens's avatar
Steven Wittens committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
    $form['path'] = array(
      '#type' => 'fieldset',
      '#title' => t('URL path settings'),
      '#collapsible' => TRUE,
      '#collapsed' => empty($path),
      '#access' => user_access('create url aliases'),
      '#weight' => 30,
    );
    $form['path']['path'] = array(
      '#type' => 'textfield',
      '#default_value' => $path,
      '#maxlength' => 250,
      '#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_result(db_query("SELECT pid FROM {url_alias} WHERE dst = '%s'", $path))
      );
    }
  }
}

/**
 * Implementation of hook_perm().
 */
function path_perm() {
  return array('create url aliases', 'administer url aliases');
}

/**
 * Fetch a specific URL alias from the database.
 */
function path_load($pid) {
  return db_fetch_array(db_query('SELECT * FROM {url_alias} WHERE pid = %d', $pid));
}