webmaster@1: <?php
webmaster@1: // $Id: path.admin.inc,v 1.7 2008/01/08 10:35:42 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Administrative page callbacks for the path module.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Return a listing of all defined URL aliases.
webmaster@1:  * When filter key passed, perform a standard search on the given key,
webmaster@1:  * and return the list of matching URL aliases.
webmaster@1:  */
webmaster@1: function path_admin_overview($keys = NULL) {
webmaster@1:   // Add the filter form above the overview table.
webmaster@1:   $output = drupal_get_form('path_admin_filter_form', $keys);
webmaster@1:   // Enable language column if locale is enabled or if we have any alias with language
webmaster@1:   $count = db_result(db_query("SELECT COUNT(*) FROM {url_alias} WHERE language != ''"));
webmaster@1:   $multilanguage = (module_exists('locale') || $count);
webmaster@1: 
webmaster@1:   if ($keys) {
webmaster@1:     // Replace wildcards with MySQL/PostgreSQL wildcards.
webmaster@1:     $keys = preg_replace('!\*+!', '%', $keys);
webmaster@1:     $sql = "SELECT * FROM {url_alias} WHERE dst LIKE '%%%s%%'";
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $sql = 'SELECT * FROM {url_alias}';
webmaster@1:   }
webmaster@1:   $header = array(
webmaster@1:     array('data' => t('Alias'), 'field' => 'dst', 'sort' => 'asc'),
webmaster@1:     array('data' => t('System'), 'field' => 'src'),
webmaster@1:     array('data' => t('Operations'), 'colspan' => '2')
webmaster@1:   );
webmaster@1:   if ($multilanguage) {
webmaster@1:     $header[3] = $header[2];
webmaster@1:     $header[2] = array('data' => t('Language'), 'field' => 'language');
webmaster@1:   }
webmaster@1:   $sql .= tablesort_sql($header);
webmaster@1:   $result = pager_query($sql, 50, 0 , NULL, $keys);
webmaster@1: 
webmaster@1:   $rows = array();
webmaster@1:   $destination = drupal_get_destination();
webmaster@1:   while ($data = db_fetch_object($result)) {
webmaster@1:     $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)));
webmaster@1:     if ($multilanguage) {
webmaster@1:       $row[4] = $row[3];
webmaster@1:       $row[3] = $row[2];
webmaster@1:       $row[2] = module_invoke('locale', 'language_name', $data->language);
webmaster@1:     }
webmaster@1:     $rows[] = $row;
webmaster@1:   }
webmaster@1: 
webmaster@1:   if (empty($rows)) {
webmaster@1:     $empty_message = $keys ? t('No URL aliases found.') : t('No URL aliases available.') ;
webmaster@1:     $rows[] = array(array('data' => $empty_message, 'colspan' => ($multilanguage ? 5 : 4)));
webmaster@1:   }
webmaster@1: 
webmaster@1:   $output .= theme('table', $header, $rows);
webmaster@1:   $output .= theme('pager', NULL, 50, 0);
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; handles pages for creating and editing URL aliases.
webmaster@1:  */
webmaster@1: function path_admin_edit($pid = 0) {
webmaster@1:   if ($pid) {
webmaster@1:     $alias = path_load($pid);
webmaster@1:     drupal_set_title(check_plain($alias['dst']));
webmaster@1:     $output = drupal_get_form('path_admin_form', $alias);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $output = drupal_get_form('path_admin_form');
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Return a form for editing or creating an individual URL alias.
webmaster@1:  *
webmaster@1:  * @ingroup forms
webmaster@1:  * @see path_admin_form_validate()
webmaster@1:  * @see path_admin_form_submit()
webmaster@1:  */
webmaster@1: function path_admin_form(&$form_state, $edit = array('src' => '', 'dst' => '', 'language' => '', 'pid' => NULL)) {
webmaster@1: 
webmaster@1:   $form['#alias'] = $edit;
webmaster@1: 
webmaster@1:   $form['src'] = array(
webmaster@1:     '#type' => 'textfield',
webmaster@1:     '#title' => t('Existing system path'),
webmaster@1:     '#default_value' => $edit['src'],
webmaster@1:     '#maxlength' => 64,
webmaster@1:     '#size' => 45,
webmaster@1:     '#description' => t('Specify the existing path you wish to alias. For example: node/28, forum/1, taxonomy/term/1+2.'),
webmaster@1:     '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
webmaster@1:     '#required' => TRUE,
webmaster@1:   );
webmaster@1:   $form['dst'] = array(
webmaster@1:     '#type' => 'textfield',
webmaster@1:     '#title' => t('Path alias'),
webmaster@1:     '#default_value' => $edit['dst'],
webmaster@1:     '#maxlength' => 64,
webmaster@1:     '#size' => 45,
webmaster@1:     '#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.'),
webmaster@1:     '#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
webmaster@1:     '#required' => TRUE,
webmaster@1:   );
webmaster@1:   // This will be a hidden value unless locale module is enabled
webmaster@1:   $form['language'] = array(
webmaster@1:     '#type' => 'value',
webmaster@1:     '#value' => $edit['language']
webmaster@1:   );
webmaster@1:   if ($edit['pid']) {
webmaster@1:     $form['pid'] = array('#type' => 'hidden', '#value' => $edit['pid']);
webmaster@1:     $form['submit'] = array('#type' => 'submit', '#value' => t('Update alias'));
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $form['submit'] = array('#type' => 'submit', '#value' => t('Create new alias'));
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Verify that a new URL alias is valid
webmaster@1:  */
webmaster@1: function path_admin_form_validate($form, &$form_state) {
webmaster@1:   $src = $form_state['values']['src'];
webmaster@1:   $dst = $form_state['values']['dst'];
webmaster@1:   $pid = isset($form_state['values']['pid']) ? $form_state['values']['pid'] : 0;
webmaster@1:   // Language is only set if locale module is enabled, otherwise save for all languages.
webmaster@1:   $language = isset($form_state['values']['language']) ? $form_state['values']['language'] : '';
webmaster@1: 
webmaster@1:   if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE pid != %d AND dst = '%s' AND language = '%s'", $pid, $dst, $language))) {
webmaster@1:     form_set_error('dst', t('The alias %alias is already in use in this language.', array('%alias' => $dst)));
webmaster@1:   }
webmaster@1:   $item = menu_get_item($src);
webmaster@1:   if (!$item || !$item['access']) {
webmaster@1:     form_set_error('src', t("The path '@link_path' is either invalid or you do not have access to it.", array('@link_path' => $src)));
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Save a new URL alias to the database.
webmaster@1:  */
webmaster@1: function path_admin_form_submit($form, &$form_state) {
webmaster@1:   // Language is only set if locale module is enabled
webmaster@1:   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'] : '');
webmaster@1: 
webmaster@1:   drupal_set_message(t('The alias has been saved.'));
webmaster@1:   $form_state['redirect'] = 'admin/build/path';
webmaster@1:   return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; confirms deleting an URL alias
webmaster@1:  */
webmaster@1: function path_admin_delete_confirm($form_state, $pid) {
webmaster@1:   $path = path_load($pid);
webmaster@1:   if (user_access('administer url aliases')) {
webmaster@1:     $form['pid'] = array('#type' => 'value', '#value' => $pid);
webmaster@1:     $output = confirm_form($form,
webmaster@1:       t('Are you sure you want to delete path alias %title?', array('%title' => $path['dst'])),
webmaster@1:       isset($_GET['destination']) ? $_GET['destination'] : 'admin/build/path');
webmaster@1:   }
webmaster@1:   return $output;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Execute URL alias deletion
webmaster@1:  */
webmaster@1: function path_admin_delete_confirm_submit($form, &$form_state) {
webmaster@1:   if ($form_state['values']['confirm']) {
webmaster@1:     path_admin_delete($form_state['values']['pid']);
webmaster@1:     $form_state['redirect'] = 'admin/build/path';
webmaster@1:     return;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Return a form to filter URL aliases.
webmaster@1:  *
webmaster@1:  * @ingroup forms
webmaster@1:  * @see path_admin_filter_form_submit()
webmaster@1:  */
webmaster@1: function path_admin_filter_form(&$form_state, $keys = '') {
webmaster@1:   $form['#attributes'] = array('class' => 'search-form');
webmaster@1:   $form['basic'] = array('#type' => 'fieldset',
webmaster@1:     '#title' => t('Filter aliases')
webmaster@1:   );
webmaster@1:   $form['basic']['inline'] = array('#prefix' => '<div class="container-inline">', '#suffix' => '</div>');
webmaster@1:   $form['basic']['inline']['filter'] = array(
webmaster@1:     '#type' => 'textfield',
webmaster@1:     '#title' => '',
webmaster@1:     '#default_value' => $keys,
webmaster@1:     '#maxlength' => 64,
webmaster@1:     '#size' => 25,
webmaster@1:   );
webmaster@1:   $form['basic']['inline']['submit'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => t('Filter'),
webmaster@1:     '#submit' => array('path_admin_filter_form_submit_filter'),
webmaster@1:     );
webmaster@1:   if ($keys) {
webmaster@1:     $form['basic']['inline']['reset'] = array(
webmaster@1:       '#type' => 'submit',
webmaster@1:       '#value' => t('Reset'),
webmaster@1:       '#submit' => array('path_admin_filter_form_submit_reset'),
webmaster@1:     );
webmaster@1:   }
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Process filter form submission when the Filter button is pressed.
webmaster@1:  */
webmaster@1: function path_admin_filter_form_submit_filter($form, &$form_state) {
webmaster@1:   $form_state['redirect'] = 'admin/build/path/list/'. trim($form_state['values']['filter']);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Process filter form submission when the Reset button is pressed.
webmaster@1:  */
webmaster@1: function path_admin_filter_form_submit_reset($form, &$form_state) {
webmaster@1:   $form_state['redirect'] = 'admin/build/path/list';
webmaster@1: }
webmaster@1: 
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Helper function for grabbing filter keys.
webmaster@1:  */
webmaster@1: function path_admin_filter_get_keys() {
webmaster@1:   // Extract keys as remainder of path
webmaster@1:   $path = explode('/', $_GET['q'], 5);
webmaster@1:   return count($path) == 5 ? $path[4] : '';
webmaster@1: }