path.admin.inc

  1. 7.x drupal-7.x/modules/path/path.admin.inc
  2. 6.x drupal-6.x/modules/path/path.admin.inc

Administrative page callbacks for the path module.

File

drupal-6.x/modules/path/path.admin.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * Administrative page callbacks for the path module.
  5. */
  6. /**
  7. * Return a listing of all defined URL aliases.
  8. * When filter key passed, perform a standard search on the given key,
  9. * and return the list of matching URL aliases.
  10. */
  11. function path_admin_overview($keys = NULL) {
  12. // Add the filter form above the overview table.
  13. $output = drupal_get_form('path_admin_filter_form', $keys);
  14. // Enable language column if locale is enabled or if we have any alias with language
  15. $count = db_result(db_query("SELECT COUNT(*) FROM {url_alias} WHERE language != ''"));
  16. $multilanguage = (module_exists('locale') || $count);
  17. if ($keys) {
  18. // Replace wildcards with MySQL/PostgreSQL wildcards.
  19. $keys = preg_replace('!\*+!', '%', $keys);
  20. $sql = "SELECT * FROM {url_alias} WHERE dst LIKE '%%%s%%'";
  21. }
  22. else {
  23. $sql = 'SELECT * FROM {url_alias}';
  24. }
  25. $header = array(
  26. array('data' => t('Alias'), 'field' => 'dst', 'sort' => 'asc'),
  27. array('data' => t('System'), 'field' => 'src'),
  28. array('data' => t('Operations'), 'colspan' => '2')
  29. );
  30. if ($multilanguage) {
  31. $header[3] = $header[2];
  32. $header[2] = array('data' => t('Language'), 'field' => 'language');
  33. }
  34. $sql .= tablesort_sql($header);
  35. $result = pager_query($sql, 50, 0 , NULL, $keys);
  36. $rows = array();
  37. $destination = drupal_get_destination();
  38. while ($data = db_fetch_object($result)) {
  39. $row = array(check_plain($data->dst), check_plain($data->src), l(t('edit'), "admin/build/path/edit/$data->pid", array('query' => $destination)), l(t('delete'), "admin/build/path/delete/$data->pid", array('query' => $destination)));
  40. if ($multilanguage) {
  41. $row[4] = $row[3];
  42. $row[3] = $row[2];
  43. $row[2] = module_invoke('locale', 'language_name', $data->language);
  44. }
  45. $rows[] = $row;
  46. }
  47. if (empty($rows)) {
  48. $empty_message = $keys ? t('No URL aliases found.') : t('No URL aliases available.') ;
  49. $rows[] = array(array('data' => $empty_message, 'colspan' => ($multilanguage ? 5 : 4)));
  50. }
  51. $output .= theme('table', $header, $rows);
  52. $output .= theme('pager', NULL, 50, 0);
  53. return $output;
  54. }
  55. /**
  56. * Menu callback; handles pages for creating and editing URL aliases.
  57. */
  58. function path_admin_edit($pid = 0) {
  59. if ($pid) {
  60. $alias = path_load($pid);
  61. drupal_set_title(check_plain($alias['dst']));
  62. $output = drupal_get_form('path_admin_form', $alias);
  63. }
  64. else {
  65. $output = drupal_get_form('path_admin_form');
  66. }
  67. return $output;
  68. }
  69. /**
  70. * Return a form for editing or creating an individual URL alias.
  71. *
  72. * @ingroup forms
  73. * @see path_admin_form_validate()
  74. * @see path_admin_form_submit()
  75. */
  76. function path_admin_form(&$form_state, $edit = array('src' => '', 'dst' => '', 'language' => '', 'pid' => NULL)) {
  77. $form['#alias'] = $edit;
  78. $form['src'] = array(
  79. '#type' => 'textfield',
  80. '#title' => t('Existing system path'),
  81. '#default_value' => $edit['src'],
  82. '#maxlength' => 128,
  83. '#size' => 45,
  84. '#description' => t('Specify the existing path you wish to alias. For example: node/28, forum/1, taxonomy/term/1+2.'),
  85. '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
  86. '#required' => TRUE,
  87. );
  88. $form['dst'] = array(
  89. '#type' => 'textfield',
  90. '#title' => t('Path alias'),
  91. '#default_value' => $edit['dst'],
  92. '#maxlength' => 128,
  93. '#size' => 45,
  94. '#description' => 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.'),
  95. '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
  96. '#required' => TRUE,
  97. );
  98. // This will be a hidden value unless locale module is enabled
  99. $form['language'] = array(
  100. '#type' => 'value',
  101. '#value' => $edit['language']
  102. );
  103. if ($edit['pid']) {
  104. $form['pid'] = array('#type' => 'hidden', '#value' => $edit['pid']);
  105. $form['submit'] = array('#type' => 'submit', '#value' => t('Update alias'));
  106. }
  107. else {
  108. $form['submit'] = array('#type' => 'submit', '#value' => t('Create new alias'));
  109. }
  110. return $form;
  111. }
  112. /**
  113. * Verify that a new URL alias is valid
  114. */
  115. function path_admin_form_validate($form, &$form_state) {
  116. $src = $form_state['values']['src'];
  117. $dst = $form_state['values']['dst'];
  118. $pid = isset($form_state['values']['pid']) ? $form_state['values']['pid'] : 0;
  119. // Language is only set if locale module is enabled, otherwise save for all languages.
  120. $language = isset($form_state['values']['language']) ? $form_state['values']['language'] : '';
  121. if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE pid != %d AND dst = '%s' AND language = '%s'", $pid, $dst, $language))) {
  122. form_set_error('dst', t('The alias %alias is already in use in this language.', array('%alias' => $dst)));
  123. }
  124. $item = menu_get_item($src);
  125. if (!$item || !$item['access']) {
  126. form_set_error('src', t("The path '@link_path' is either invalid or you do not have access to it.", array('@link_path' => $src)));
  127. }
  128. }
  129. /**
  130. * Save a new URL alias to the database.
  131. */
  132. function path_admin_form_submit($form, &$form_state) {
  133. // Language is only set if locale module is enabled
  134. path_set_alias($form_state['values']['src'], $form_state['values']['dst'], isset($form_state['values']['pid']) ? $form_state['values']['pid'] : 0, isset($form_state['values']['language']) ? $form_state['values']['language'] : '');
  135. drupal_set_message(t('The alias has been saved.'));
  136. $form_state['redirect'] = 'admin/build/path';
  137. return;
  138. }
  139. /**
  140. * Menu callback; confirms deleting an URL alias
  141. */
  142. function path_admin_delete_confirm($form_state, $pid) {
  143. $path = path_load($pid);
  144. if (user_access('administer url aliases')) {
  145. $form['pid'] = array('#type' => 'value', '#value' => $pid);
  146. $output = confirm_form($form,
  147. t('Are you sure you want to delete path alias %title?', array('%title' => $path['dst'])),
  148. isset($_GET['destination']) ? $_GET['destination'] : 'admin/build/path');
  149. }
  150. return $output;
  151. }
  152. /**
  153. * Execute URL alias deletion
  154. */
  155. function path_admin_delete_confirm_submit($form, &$form_state) {
  156. if ($form_state['values']['confirm']) {
  157. path_admin_delete($form_state['values']['pid']);
  158. $form_state['redirect'] = 'admin/build/path';
  159. return;
  160. }
  161. }
  162. /**
  163. * Return a form to filter URL aliases.
  164. *
  165. * @ingroup forms
  166. * @see path_admin_filter_form_submit()
  167. */
  168. function path_admin_filter_form(&$form_state, $keys = '') {
  169. $form['#attributes'] = array('class' => 'search-form');
  170. $form['basic'] = array('#type' => 'fieldset',
  171. '#title' => t('Filter aliases')
  172. );
  173. $form['basic']['inline'] = array('#prefix' => '<div class="container-inline">', '#suffix' => '</div>');
  174. $form['basic']['inline']['filter'] = array(
  175. '#type' => 'textfield',
  176. '#title' => '',
  177. '#default_value' => $keys,
  178. '#maxlength' => 128,
  179. '#size' => 25,
  180. );
  181. $form['basic']['inline']['submit'] = array(
  182. '#type' => 'submit',
  183. '#value' => t('Filter'),
  184. '#submit' => array('path_admin_filter_form_submit_filter'),
  185. );
  186. if ($keys) {
  187. $form['basic']['inline']['reset'] = array(
  188. '#type' => 'submit',
  189. '#value' => t('Reset'),
  190. '#submit' => array('path_admin_filter_form_submit_reset'),
  191. );
  192. }
  193. return $form;
  194. }
  195. /**
  196. * Process filter form submission when the Filter button is pressed.
  197. */
  198. function path_admin_filter_form_submit_filter($form, &$form_state) {
  199. $form_state['redirect'] = 'admin/build/path/list/'. trim($form_state['values']['filter']);
  200. }
  201. /**
  202. * Process filter form submission when the Reset button is pressed.
  203. */
  204. function path_admin_filter_form_submit_reset($form, &$form_state) {
  205. $form_state['redirect'] = 'admin/build/path/list';
  206. }
  207. /**
  208. * Helper function for grabbing filter keys.
  209. */
  210. function path_admin_filter_get_keys() {
  211. // Extract keys as remainder of path
  212. $path = explode('/', $_GET['q'], 5);
  213. return count($path) == 5 ? $path[4] : '';
  214. }