path.module 11.8 KB
Newer Older
Dries's avatar
Dries committed
1 2 3 4
<?php
/* $Id$ */

function path_admin() {
Dries's avatar
 
Dries committed
5
  $op = $_POST["op"];
Dries's avatar
Dries committed
6 7
  $edit = $_POST["edit"];

Dries's avatar
 
Dries committed
8
  if (user_access("administer url aliases")) {
Dries's avatar
Dries committed
9 10 11 12 13 14

    if (empty($op)) {
      $op = arg(2);
    }

    switch ($op) {
Dries's avatar
 
Dries committed
15
      case "add":
Dries's avatar
Dries committed
16 17 18
        $output = path_form();
        break;

Dries's avatar
 
Dries committed
19
      case "edit":
Dries's avatar
 
Dries committed
20 21 22 23 24
        $output = path_form(path_load(arg(3)));
        break;

      case "help":
        $output = path_help();
Dries's avatar
Dries committed
25 26
        break;

Dries's avatar
 
Dries committed
27
      case "delete":
Dries's avatar
 
Dries committed
28
        path_delete(arg(3));
Dries's avatar
 
Dries committed
29
        $output .= path_overview();
Dries's avatar
Dries committed
30 31
        break;

Dries's avatar
 
Dries committed
32 33
      case t("Create new alias"):
      case t("Update alias"):
Dries's avatar
 
Dries committed
34
        $output = path_save($edit);
Dries's avatar
 
Dries committed
35
        break;
Dries's avatar
Dries committed
36 37

      default:
Dries's avatar
 
Dries committed
38
        $output .= path_overview();
Dries's avatar
Dries committed
39 40
    }

Dries's avatar
 
Dries committed
41
    print theme("page", $output);
Dries's avatar
Dries committed
42 43
  }
  else {
Dries's avatar
 
Dries committed
44
    print theme("page", message_access());
Dries's avatar
Dries committed
45 46 47
  }
}

Dries's avatar
 
Dries committed
48 49
function path_set_alias($path = NULL, $alias = NULL) {
  if ($path && !$alias) {
Dries's avatar
 
Dries committed
50
    db_query("DELETE FROM {url_alias} WHERE src = '%s'", $path);
Dries's avatar
 
Dries committed
51 52 53
    drupal_rebuild_path_map();
  }
  else if (!$path && $alias) {
Dries's avatar
 
Dries committed
54
    db_query("DELETE FROM {url_alias} WHERE dst = '%s'", $alias);
Dries's avatar
 
Dries committed
55 56 57
    drupal_rebuild_path_map();
  }
  else if ($path && $alias) {
Dries's avatar
 
Dries committed
58 59
    $path_count = db_result(db_query("SELECT COUNT(src) FROM {url_alias} WHERE src = '%s'", $path));
    $alias_count = db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE dst = '%s'", $alias));
Dries's avatar
 
Dries committed
60 61 62

    // We have an insert:
    if ($path_count == 0 && $alias_count == 0) {
63
      db_query("INSERT INTO {url_alias} (src, dst) VALUES ('%s', '%s')", $path, $alias);
Dries's avatar
 
Dries committed
64 65 66
      drupal_rebuild_path_map();
    }
    else if ($path_count == 1 && $alias_count == 0) {
Dries's avatar
 
Dries committed
67
      db_query("UPDATE {url_alias} SET dst = '%s' WHERE src = '%s'", $alias, $path);
Dries's avatar
 
Dries committed
68 69 70
      drupal_rebuild_path_map();
    }
    else if ($path_count == 0 && $alias_count == 1) {
Dries's avatar
 
Dries committed
71
      db_query("UPDATE {url_alias} SET src = '%s' WHERE dst = '%s'", $path, $alias);
Dries's avatar
 
Dries committed
72 73 74 75 76 77 78 79 80
      drupal_rebuild_path_map();
    }
    else if ($path_count == 1 && $alias_count == 1) {
      // This will delete the path that alias was originally pointing to:
      path_set_alias(NULL, $alias);
      path_set_alias($path);
      path_set_alias($path, $alias);
    }
  }
Dries's avatar
Dries committed
81 82
}

Dries's avatar
 
Dries committed
83
function path_form($edit = "", $error = "") {
Dries's avatar
Dries committed
84

Dries's avatar
 
Dries committed
85 86
  $form .= form_textfield(t("Existing path"), "src", $edit["src"], 50, 64, t("Specify the existing path you wish to alias. For example: node/view/28, forum/1, taxonomy/page/or/1,2."));
  $form .= form_textfield(t("New path alias"), "dst", $edit["dst"], 50, 64, t("Specify an alternative path by which this data 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."));
Dries's avatar
Dries committed
87

Dries's avatar
 
Dries committed
88 89 90 91 92 93 94 95 96
  if ($edit["pid"]) {
    $form .= form_hidden("pid", $edit["pid"]);
    $form .= form_submit(t("Update alias"));
  }
  else {
    $form .= form_submit(t("Create new alias"));
  }

  return form($form);
Dries's avatar
Dries committed
97 98
}

Dries's avatar
 
Dries committed
99
function path_help($section = "admin/help#path") {
Dries's avatar
 
Dries committed
100

Dries's avatar
Dries committed
101
  switch ($section) {
Dries's avatar
 
Dries committed
102 103
    case "admin/system/modules#description":
      $output = t("Enables users to create custom URLs.");
Dries's avatar
Dries committed
104
      break;
Dries's avatar
 
Dries committed
105
    case "admin/path":
Dries's avatar
 
Dries committed
106
      $output = t("Drupal provides users complete control over URLs through aliasing. While the original Drupal URLs are always created and accessible, advanced users have the option to override these normal paths.");
Dries's avatar
 
Dries committed
107 108
      break;
    case "admin/path/add":
Dries's avatar
 
Dries committed
109
      $output = t("Enter the path you wish to create the alias for, followed by the name of the new alias. Each path can be associated with only one alias.");
Dries's avatar
Dries committed
110
      break;
Dries's avatar
 
Dries committed
111
    case "admin/help#path":
Dries's avatar
 
Dries committed
112 113
      $output = t("
<h3>Background</h3>
Dries's avatar
 
Dries committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
<p>A very powerful feature of Drupal is the ability to have control over all paths. The path module is the tool that provides this functionality and is part of the basic Drupal installation, although it is not enabled by default. Some examples of re-mapping paths are:</p>
<pre>
user/login => login

image/tid/16 => store

taxonomy/page/or/7,19,20,21 => store/products/whirlygigs

node/view/3 => contact
</pre>
<p>This functionality integrates seamlessly into node forms and also provides the administrator an interface to view all aliases that have been created.</p>
<p>Aliases have a 1 to 1 relationship with their original Drupal URLs. In other words you cannot have an alias map to more than one path. Likewise, a Drupal URL can't be mapped to more than one alias.</p>

<h3>Permissions</h3>
<p>Two permissions are related to URL aliasing: <i>create url aliases</i> and <i>administer url aliases</i>.</p>
<ol><li><strong>create url aliases</strong> - Allows users to create aliases for nodes. Enabling this permission will display a path field to the user in any node form, allowing them to enter an alias for that node. They will be able to edit/delete the alias after it is created using the same form.</li><li><strong>administer url aliases</strong> - Allows users to access the alias administration interface. They must also have the <i>access administration pages</i> permission set as well. This interface displays all aliases and provides a way to create and modify them. This is also the location to build aliases for things other than nodes. For example, you can create an alias for a taxonomy URL or even re-map the admin path (although the original admin path will still be accessible since aliases do not cancel out original paths).</li></ol>

<h3>Mass URL aliasing</h3>
<p>Drupal also comes with user defined mass URL aliasing capabilities. You might like to see completely different URLs used by Drupal, or even URLs translated to the visitors' native language, in which case this feature is handy. Only an administrator with access to the website source code can set up this kind of aliases. You can define a <code>conf_url_rewrite</code> function in conf.php, following this example:</p>
<pre>
function conf_url_rewrite(\$path, \$mode = 'incoming') {
  if (\$mode == 'incoming') { // URL coming from a client
Dries's avatar
 
Dries committed
136
    return preg_replace('!^display/(\\d+)\$!', 'node/view/\\1', \$path);
Dries's avatar
 
Dries committed
137 138
  }
  else { // URL going out to a client
Dries's avatar
 
Dries committed
139 140
    \$aliased = preg_replace('!^node/view/(\\d+)\$!', 'display/\\1', \$path);
    if (\$aliased != \$path) { return \$aliased; }
Dries's avatar
 
Dries committed
141 142 143 144
  }
}
</pre>
<p>This function will shorten every <code>node/view/\$node_id</code> type of URL to <code>display/\$node_id</code>. Individual URL aliases defined on the browser interface of Drupal take precedence, so if you have the 'contact' page alias from the example above, then the <code>display/3</code> alias will not be effective when outgoing links are created. Incoming URLs however always work with the mass URL aliased variant. Only the 'incoming' and 'outgoing' modes are supposed to be supported by your <code>conf_url_rewrite</code> function.</p>
Dries's avatar
 
Dries committed
145
<p>You cannot only use this feature to shorten the URLs, or to translate them to you own language, but also to add completely new subURLs to an already existing module's URL space, or to compose a bunch of existing stuff together to a common URL space. You can create a <code>news</code> section for example aliasing nodes and taxonomy overview pages falling under a 'news' vocabulary, thus having <code>news/15</code> and <code>news/sections/3</code> instead of <code>node/view/15</code> and <code>taxonomy/view/or/3</code>. You need extensive knowledge of Drupal's inner workings and regular expressions though to make such advanced aliases.</p>");
Dries's avatar
Dries committed
146 147 148
      break;
  }

Dries's avatar
 
Dries committed
149
  return $output;
Dries's avatar
Dries committed
150 151
}

Dries's avatar
 
Dries committed
152 153
function path_link($type, $node = NULL) {
  if ($type == "system" && user_access("administer url aliases")) {
Dries's avatar
 
Dries committed
154 155 156
    menu("admin/path", t("url aliasing"), "path_admin", 4);
    menu("admin/path/add", t("new alias"), "path_admin");
    menu("admin/path/help", t("help"), "path_admin", 9);
Dries's avatar
 
Dries committed
157 158
   }
}
Dries's avatar
Dries committed
159

Dries's avatar
 
Dries committed
160
function path_nodeapi(&$node, $op, $arg) {
Dries's avatar
 
Dries committed
161
  if (user_access("create url aliases") || user_access("administer url aliases")) {
Dries's avatar
Dries committed
162

Dries's avatar
 
Dries committed
163 164 165 166 167
    switch ($op) {
      case "validate":
        // is_null provides a mechanism for us to determine if this is the first
        // viewing of the form.  If it is the first time, load the alias, if it isn't
        // (i.e., user has clicked preview) let them work with their current form alias.
168 169
        if (is_null($node->path)) {
          $node->path = drupal_get_path_alias("node/view/$node->nid");
Dries's avatar
 
Dries committed
170 171
        }
        else {
172 173 174
          $node->path = trim($node->path);
          if ($node->path && !valid_url($node->path)) {
            $error["path"] = t("The path is invalid.");
Dries's avatar
 
Dries committed
175 176
            return $error;
          }
Dries's avatar
 
Dries committed
177
          else if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE dst = '%s' AND src != '%s'", $node->path, "node/view/$node->nid"))) {
178
            $error["path"] = t("The path is already in use.");
Dries's avatar
 
Dries committed
179 180 181 182
            return $error;
          }
        }
        break;
Dries's avatar
Dries committed
183

Dries's avatar
 
Dries committed
184
      case "form pre":
185
        return form_textfield(t("Path alias"), "path", $node->path, 60, 250, 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.") . theme_error($arg["path"]));
Dries's avatar
 
Dries committed
186 187

      case "insert":
Dries's avatar
 
Dries committed
188 189 190 191 192 193 194 195
        /*
        ** Don't try to insert if path is NULL.  We may have already set
        ** the alias ahead of time.
        */
        if ($node->path) {
          path_set_alias("node/view/$node->nid", $node->path);
        }
        break;
Dries's avatar
 
Dries committed
196
      case "update":
197
        path_set_alias("node/view/$node->nid", $node->path);
Dries's avatar
 
Dries committed
198 199 200 201 202 203 204 205
        break;

      case "delete":
        if ($alias = drupal_get_path_alias("node/view/$node->nid")) {
          path_set_alias("node/view/$node->nid");
        }
        break;
    }
Dries's avatar
Dries committed
206 207 208 209
  }
}

function path_perm() {
Dries's avatar
 
Dries committed
210
  return array("create url aliases", "administer url aliases");
Dries's avatar
Dries committed
211 212 213
}

function path_overview() {
Dries's avatar
 
Dries committed
214
  $sql = "SELECT * FROM {url_alias}";
Dries's avatar
Dries committed
215
  $header = array(
216 217 218
    array("data" => t("alias"), "field" => "dst", "sort" => "asc"),
    array("data" => t("normal"), "field" => "src"),
    array("data" => t("operations"), "colspan" => 2)
Dries's avatar
Dries committed
219 220 221 222 223
  );
  $sql .= tablesort_sql($header);
  $result = pager_query($sql, 50);

  while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
224
    $rows[] = array($data->dst, $data->src, l(t("edit"), "admin/path/edit/$data->pid"), l(t("delete"), "admin/path/delete/$data->pid"));
Dries's avatar
Dries committed
225 226
  }

Dries's avatar
Dries committed
227
  if ($pager = theme("pager", NULL, 50, 0, tablesort_pager())) {
Dries's avatar
 
Dries committed
228
    $rows[] = array(array("data" => $pager, "colspan" => "4"));
Dries's avatar
Dries committed
229 230
  }

Dries's avatar
 
Dries committed
231
  if (!$rows) {
Dries's avatar
 
Dries committed
232
    $rows[] = array(array("data" => t("No URL aliases available."), "colspan" => "4"));
Dries's avatar
 
Dries committed
233 234
  }

Dries's avatar
 
Dries committed
235
  return theme("table", $header, $rows);
Dries's avatar
Dries committed
236 237
}

Dries's avatar
 
Dries committed
238
function path_load($pid) {
Dries's avatar
 
Dries committed
239
  return db_fetch_array(db_query("SELECT * FROM {url_alias} WHERE pid = '%d'", $pid));
Dries's avatar
 
Dries committed
240
}
Dries's avatar
Dries committed
241

Dries's avatar
 
Dries committed
242
function path_delete($pid) {
Dries's avatar
 
Dries committed
243
  db_query("DELETE FROM {url_alias} WHERE pid = '%d'", $pid);
Dries's avatar
 
Dries committed
244
  drupal_set_message(t("the alias has been deleted."));
Dries's avatar
 
Dries committed
245
}
Dries's avatar
Dries committed
246

Dries's avatar
 
Dries committed
247 248 249 250
function path_save($edit) {
  $src = $edit["src"];
  $dst = $edit["dst"];
  $pid = $edit["pid"];
Dries's avatar
Dries committed
251

Dries's avatar
 
Dries committed
252
  if (!valid_url($src)) {
Dries's avatar
 
Dries committed
253
    $error = t("the normal path '%src' is invalid.", array("%src" => $src));
Dries's avatar
Dries committed
254 255
  }

Dries's avatar
 
Dries committed
256
  if (db_result(db_query("SELECT COUNT(src) FROM {url_alias} WHERE pid != '%d' AND src = '%s'", $pid, $src))) {
Dries's avatar
 
Dries committed
257
    $error = t("the normal path '%src' is already aliased.", array("%src" => $src));
Dries's avatar
Dries committed
258 259
  }

Dries's avatar
 
Dries committed
260
  if (!valid_url($dst)) {
Dries's avatar
 
Dries committed
261
    $error = t("the alias '%dst' is invalid.", array("%dst" => $dst));
Dries's avatar
Dries committed
262 263
  }

Dries's avatar
 
Dries committed
264
  if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE pid != '%d' AND dst = '%s'", $pid, $dst))) {
Dries's avatar
 
Dries committed
265
    $error = t("the alias '%dst' is already in use.", array("%dst" => $dst));
Dries's avatar
 
Dries committed
266
  }
Dries's avatar
Dries committed
267

Dries's avatar
 
Dries committed
268
  if ($error) {
Dries's avatar
 
Dries committed
269
    drupal_set_message($error, 'error');
Dries's avatar
 
Dries committed
270
    return path_form($edit, $error);
Dries's avatar
Dries committed
271
  }
Dries's avatar
 
Dries committed
272 273 274 275 276 277 278 279
  else {
    /*
    ** Normally, you would use path_set_alias to update the paths table,
    ** but this is a special case.  We want to modify a specific row and the only
    ** way to do that is with pid.
    */

    if ($pid) {
Dries's avatar
 
Dries committed
280
      db_query("UPDATE {url_alias} SET src = '%s', dst = '%s' WHERE pid = '%d'", $src, $dst, $pid);
Dries's avatar
 
Dries committed
281 282 283 284
    }
    else {
      path_set_alias($src, $dst);
    }
Dries's avatar
Dries committed
285 286
  }

Dries's avatar
 
Dries committed
287 288
  drupal_set_message(t('the alias has been saved.'));
  return  path_overview();
Dries's avatar
Dries committed
289 290 291
}

?>