You are here

r4032login.module in Redirect 403 to User Login 7

Redirect denied pages to the user login form.

File

r4032login.module
View source
<?php

/**
 * @file
 * Redirect denied pages to the user login form.
 */

/**
 * Implements hook_menu().
 */
function r4032login_menu() {
  $items = array();
  $items['r4032login'] = array(
    'page callback' => 'r4032login_redirect',
    'access callback' => 'r4032login_access_callback',
    'type' => MENU_CALLBACK,
    'title' => 'Access denied',
    'description' => 'You are not authorized to access this page.',
  );
  return $items;
}

/**
 * Without an access callback on the menu item for r4032login_redirect,
 * the redirect will be 403 and just have the default access denied page anyway.
 */
function r4032login_access_callback() {
  return TRUE;
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function r4032login_form_system_site_information_settings_alter(&$form, &$form_state, $form_id) {
  $form['error_page']['r4032login_display_denied_message'] = array(
    '#type' => 'checkbox',
    '#weight' => 5,
    '#title' => t('Display access denied message on login page'),
    '#default_value' => variable_get('r4032login_display_denied_message', TRUE),
  );
  $form['error_page']['r4032login_redirect_to_destination'] = array(
    '#type' => 'checkbox',
    '#weight' => 6,
    '#title' => t('Redirect user to the page they tried to access after login'),
    '#default_value' => variable_get('r4032login_redirect_to_destination', TRUE),
  );
  $form['error_page']['r4032login_access_denied_message'] = array(
    '#type' => 'textarea',
    '#rows' => 1,
    '#weight' => 7,
    '#title' => t("User login 'access denied' message"),
    '#default_value' => variable_get('r4032login_access_denied_message', t('Access denied. You must log in to view this page.')),
    '#states' => array(
      'invisible' => array(
        'input[name="r4032login_display_denied_message"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['error_page']['r4032login_access_denied_message_type'] = array(
    '#type' => 'select',
    '#options' => array(
      'error' => t('Error'),
      'warning' => t('Warning'),
      'status' => t('Status'),
    ),
    '#weight' => 8,
    '#title' => t("User login 'access denied' message type"),
    '#default_value' => variable_get('r4032login_access_denied_message_type', 'error'),
    '#states' => array(
      'invisible' => array(
        'input[name="r4032login_display_denied_message"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['error_page']['r4032login_redirect_authenticated_users_to'] = array(
    '#type' => 'textfield',
    '#weight' => 9,
    '#title' => t("Redirect authenticated users to"),
    '#description' => t('If an authenticated user tries to access a page they can not, redirect them to the given page. Use &lt;front&gt; for the front page, leave blank for a default access denied page.'),
    '#default_value' => variable_get('r4032login_redirect_authenticated_users_to', ''),
  );
  $form['error_page']['r4032login_user_login_path'] = array(
    '#type' => 'textfield',
    '#weight' => 10,
    '#title' => t("Path to user login form"),
    '#description' => t('The path to the user login form. Omit the beginning slash, ie: user/login'),
    '#default_value' => variable_get('r4032login_user_login_path', 'user/login'),
  );
  $options = array(
    '200' => '200 OK',
    '301' => '301 Moved Permanently',
    '302' => '302 Found',
    '307' => '307 Temporary Redirect',
    '403' => '403 Forbidden',
    '451' => '451 Unavailable For Legal Reasons',
  );
  $form['error_page']['r4032login_default_redirect_code'] = array(
    '#type' => 'select',
    '#weight' => 11,
    '#title' => t("HTTP redirect code"),
    '#description' => t('The redirect code to send. 301 responses may be cached by browsers and proxies, so 302 is normally the correct choice.'),
    '#options' => $options,
    '#default_value' => variable_get('r4032login_default_redirect_code', 302),
  );
  $form['error_page']['matching_paths'] = array(
    '#type' => 'fieldset',
    '#title' => t('Skip redirect for matching pages'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 12,
  );
  $form['error_page']['matching_paths']['r4032login_match_noredirect_pages'] = array(
    '#type' => 'textarea',
    '#title' => '<span class="element-invisible">' . t('Only the listed pages') . '</span>',
    '#default_value' => variable_get('r4032login_match_noredirect_pages', ''),
    '#description' => t('Instead of redirecting, the user will get an access deined response and see the standard login form. This may be useful when the response code is important - such as for removing outdated content from search engines.  Use the path node/* for all content.') . ' ' . t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array(
      '%blog' => 'blog',
      '%blog-wildcard' => 'blog/*',
      '%front' => '<front>',
    )),
  );
  return system_settings_form($form);
}

/**
 * Implements hook_theme().
 */
function r4032login_theme() {
  return array(
    'r4032login_denied' => array(
      'variables' => array(),
    ),
  );
}

/**
 * MENU_CALLBACK for /r4032login
 *
 * Redirect anonymous users from 403 Access Denied pages to the /user/login page
 * with a message explaining that they must log in to view the requested page
 * and a query string parameter appended to the url to return after login.
 */
function r4032login_redirect() {
  global $user, $language;
  if (user_is_anonymous()) {

    // Show the access denied message.
    if (variable_get('r4032login_display_denied_message', TRUE) && empty($_POST)) {
      $message = variable_get('r4032login_access_denied_message', t('Access denied. You must log in to view this page.'));
      $message_type = variable_get('r4032login_access_denied_message_type', 'error');
      drupal_set_message(filter_xss_admin($message), $message_type);
    }
    $page_match = FALSE;
    $pages = variable_get('r4032login_match_noredirect_pages', '');
    if ($pages) {

      // When on an access denied page, Drupal stores the original path in
      // $_GET['destination'] in drupal_deliver_html_page().
      // Convert the Drupal path to lowercase.
      $path = drupal_strtolower(drupal_get_path_alias($_GET['destination']));

      // Compare the lowercase internal and lowercase path alias (if any).
      $page_match = drupal_match_path($path, $pages);
      if ($path != $_GET['destination']) {
        $page_match = $page_match || drupal_match_path($_GET['destination'], $pages);
      }
    }
    if ($page_match) {

      // Display the default login page.
      return drupal_get_form('user_login');
    }

    // Handle redirection to the login form.
    // using drupal_goto() with destination set causes a recursive redirect loop
    $login_path = variable_get('r4032login_user_login_path', 'user/login');
    $code = variable_get('r4032login_default_redirect_code', 302);
    drupal_alter('r4032login_code', $code);

    // Check whether we should redirect to desired page after login
    $options = array(
      'absolute' => TRUE,
    );
    if (variable_get('r4032login_redirect_to_destination', TRUE)) {

      // The code in drupal_get_destination() doesn't preserve any query string
      // on 403 pages, so reproduce the part we want here.
      $path = $_GET['destination'];
      $query = drupal_http_build_query(drupal_get_query_parameters(NULL, array(
        'q',
        'destination',
      )));
      if ($query != '') {
        $path .= '?' . $query;
      }
      if (url_is_external($login_path)) {

        // If we are redirecting to another Drupal site for auth, add this site's
        // base path to the destination URL.
        $path = $GLOBALS['base_url'] . $GLOBALS['base_path'] . $path;
      }
      $destination = array(
        'destination' => $path,
      );
      $options['query'] = $destination;
    }
    $url = url($login_path, $options);
    drupal_alter('r4032login_url', $url);
    header('Location: ' . $url, TRUE, $code);
    drupal_exit();
  }
  else {

    // Check to see if we are to redirect the user.
    $redirect = variable_get('r4032login_redirect_authenticated_users_to', '');
    if (empty($redirect)) {

      // Display the default access denied page.
      return theme('r4032login_denied');
    }
    else {

      // Custom access denied page for logged in users.
      header('Location: ' . url($redirect, array(
        'absolute' => TRUE,
      )));
      drupal_exit();
    }
  }
}

/**
 * Display themed Access denied page.
 */
function theme_r4032login_denied() {
  drupal_set_title(t('Access denied'));
  return '<p>' . t('You are not authorized to access this page.') . '</p>';
}

Functions

Namesort descending Description
r4032login_access_callback Without an access callback on the menu item for r4032login_redirect, the redirect will be 403 and just have the default access denied page anyway.
r4032login_form_system_site_information_settings_alter Implements hook_form_FORM_ID_alter().
r4032login_menu Implements hook_menu().
r4032login_redirect MENU_CALLBACK for /r4032login
r4032login_theme Implements hook_theme().
theme_r4032login_denied Display themed Access denied page.