<?php

/**

 * @file

 * Displays the Drupal administration interface in an overlay.

 */

/**

 * Implements hook_help().

 */

function overlay_help($path, $arg) {

  switch ($path) {

    case 'admin/help#overlay':

      $output = '';

      $output .= '<h3>' . t('About') . '</h3>';

      $output .= '<p>' . t('The Overlay module makes the administration pages on your site display in a JavaScript overlay of the page you were viewing when you clicked the administrative link, instead of replacing the page in your browser window. Use the close link on the overlay to return to the page you were viewing when you clicked the link. For more information, see the online handbook entry for <a href="@overlay">Overlay module</a>.', array('@overlay' => 'http://drupal.org/documentation/modules/overlay')) . '</p>';

      return $output;

  }

}

/**

 * Implements hook_menu().

 */

function overlay_menu() {

  $items['overlay-ajax/%'] = array(

    'title' => '',

    'page callback' => 'overlay_ajax_render_region',

    'page arguments' => array(1),

    'access arguments' => array('access overlay'),

    'type' => MENU_CALLBACK,

  );

  $items['overlay/dismiss-message'] = array(

    'title' => '',

    'page callback' => 'overlay_user_dismiss_message',

    'access arguments' => array('access overlay'),

    'type' => MENU_CALLBACK,

  );

  return $items;

}

/**

 * Implements hook_admin_paths().

 */

function overlay_admin_paths() {

  $paths = array(

    // This is marked as an administrative path so that if it is visited from

    // within the overlay, the user will stay within the overlay while the

    // callback is being processed.

    'overlay/dismiss-message' => TRUE,

  );

  return $paths;

}

/**

 * Implements hook_permission().

 */

function overlay_permission() {

  return array(

    'access overlay' => array(

      'title' => t('Access the administrative overlay'),

      'description' => t('View administrative pages in the overlay.'),

    ),

  );

}

/**

 * Implements hook_theme().

 */

function overlay_theme() {

  return array(

    'overlay' => array(

      'render element' => 'page',

      'template' => 'overlay',

    ),

    'overlay_disable_message' => array(

      'render element' => 'element',

    ),

  );

}

/**

 * Implements hook_form_alter().

 */

function overlay_form_alter(&$form, &$form_state) {

  // Add a hidden element to prevent dropping out of the overlay when a form is

  // submitted inside the overlay using a GET method.

  if (isset($form['#method']) && $form['#method'] == 'get' && isset($_REQUEST['render']) && $_REQUEST['render'] == 'overlay' && !isset($form['render'])) {

    $form['render'] = array(

      '#type' => 'hidden',

      '#value' => 'overlay',

    );

  }

}

/**

 * Implements hook_form_FORM_ID_alter().

 */

function overlay_form_user_profile_form_alter(&$form, &$form_state) {

  if ($form['#user_category'] == 'account') {

    $account = $form['#user'];

    if (user_access('access overlay', $account)) {

      $form['overlay_control'] = array(

        '#type' => 'fieldset',

        '#title' => t('Administrative overlay'),

        '#weight' => 4,

        '#collapsible' => TRUE,

      );

      $form['overlay_control']['overlay'] = array(

        '#type' => 'checkbox',

        '#title' => t('Use the overlay for administrative pages.'),

        '#description' => t('Show administrative pages on top of the page you started from.'),

        '#default_value' => isset($account->data['overlay']) ? $account->data['overlay'] : 1,

      );

    }

  }

}

/**

 * Implements hook_user_presave().

 */

function overlay_user_presave(&$edit, $account, $category) {

  if (isset($edit['overlay'])) {

    $edit['data']['overlay'] = $edit['overlay'];

  }

}

/**

 * Implements hook_init().

 *

 * Determine whether the current page request is destined to appear in the

 * parent window or in the overlay window, and format the page accordingly.

 *

 * @see overlay_set_mode()

 */

function overlay_init() {

  global $user;

  $mode = overlay_get_mode();

  // Only act if the user has access to the overlay and a mode was not already

  // set. Other modules can also enable the overlay directly for other uses.

  $use_overlay = !isset($user->data['overlay']) || $user->data['overlay'];

  if (empty($mode) && user_access('access overlay') && $use_overlay) {

    $current_path = current_path();

    // After overlay is enabled on the modules page, redirect to

    // <front>#overlay=admin/modules to actually enable the overlay.

    if (isset($_SESSION['overlay_enable_redirect']) && $_SESSION['overlay_enable_redirect']) {

      unset($_SESSION['overlay_enable_redirect']);

      drupal_goto('<front>', array('fragment' => 'overlay=' . $current_path));

    }

    if (isset($_GET['render']) && $_GET['render'] == 'overlay') {

      // If a previous page requested that we close the overlay, close it and

      // redirect to the final destination.

      if (isset($_SESSION['overlay_close_dialog'])) {

        call_user_func_array('overlay_close_dialog', $_SESSION['overlay_close_dialog']);

        unset($_SESSION['overlay_close_dialog']);

      }

      // If this page shouldn't be rendered inside the overlay, redirect to the

      // parent.

      elseif (!path_is_admin($current_path)) {

        // Prevent open redirects by ensuring the current path is not an absolute URL.

        if (url_is_external($current_path)) {

          $current_path = '<front>';

        }

        overlay_close_dialog($current_path, array('query' => drupal_get_query_parameters(NULL, array('q', 'render'))));

      }

      // Indicate that we are viewing an overlay child page.

      overlay_set_mode('child');

      // Unset the render parameter to avoid it being included in URLs on the page.

      unset($_GET['render']);

    }

    // Do not enable the overlay if we already are on an admin page.

    elseif (!path_is_admin($current_path)) {

      // Otherwise add overlay parent code and our behavior.

      overlay_set_mode('parent');

    }

  }

}

/**

 * Implements hook_exit().

 *

 * When viewing an overlay child page, check if we need to trigger a refresh of

 * the supplemental regions of the overlay on the next page request.

 */

function overlay_exit() {

  // Check that we are in an overlay child page. Note that this should never

  // return TRUE on a cached page view, since the child mode is not set until

  // overlay_init() is called.

  if (overlay_get_mode() == 'child') {

    // Load any markup that was stored earlier in the page request, via calls

    // to overlay_store_rendered_content(). If none was stored, this is not a

    // page request where we expect any changes to the overlay supplemental

    // regions to have occurred, so we do not need to proceed any further.

    $original_markup = overlay_get_rendered_content();

    if (!empty($original_markup)) {

      // Compare the original markup to the current markup that we get from

      // rendering each overlay supplemental region now. If they don't match,

      // something must have changed, so we request a refresh of that region

      // within the parent window on the next page request.

      foreach (overlay_supplemental_regions() as $region) {

        if (!isset($original_markup[$region]) || $original_markup[$region] != overlay_render_region($region)) {

          overlay_request_refresh($region);

        }

      }

    }

  }

}

/**

 * Implements hook_library().

 */

function overlay_library() {

  $module_path = drupal_get_path('module', 'overlay');

  // Overlay parent.

  $libraries['parent'] = array(

    'title' => 'Overlay: Parent',

    'website' => 'http://drupal.org/documentation/modules/overlay',

    'version' => '1.0',

    'js' => array(

      $module_path . '/overlay-parent.js' => array(),

    ),

    'css' => array(

      $module_path . '/overlay-parent.css' => array(),

    ),

    'dependencies' => array(

      array('system', 'ui'),

      array('system', 'jquery.bbq'),

    ),

  );

  // Overlay child.

  $libraries['child'] = array(

    'title' => 'Overlay: Child',

    'website' => 'http://drupal.org/documentation/modules/overlay',

    'version' => '1.0',

    'js' => array(

      $module_path . '/overlay-child.js' => array(),

    ),

    'css' => array(

      $module_path . '/overlay-child.css' => array(),

    ),

  );

  return $libraries;

}

/**

 * Implements hook_drupal_goto_alter().

 */

function overlay_drupal_goto_alter(&$path, &$options, &$http_response_code) {

  if (overlay_get_mode() == 'child') {

    // The authorize.php script bootstraps Drupal to a very low level, where

    // the PHP code that is necessary to close the overlay properly will not be

    // loaded. Therefore, if we are redirecting to authorize.php inside the

    // overlay, instead redirect back to the current page with instructions to

    // close the overlay there before redirecting to the final destination; see

    // overlay_init().

    if ($path == system_authorized_get_url() || $path == system_authorized_batch_processing_url()) {

      $_SESSION['overlay_close_dialog'] = array($path, $options);

      $path = current_path();

      $options = drupal_get_query_parameters();

    }

    // If the current page request is inside the overlay, add ?render=overlay

    // to the new path, so that it appears correctly inside the overlay.

    if (isset($options['query'])) {

      $options['query'] += array('render' => 'overlay');

    }

    else {

      $options['query'] = array('render' => 'overlay');

    }

  }

}

/**

 * Implements hook_batch_alter().

 *

 * If the current page request is inside the overlay, add ?render=overlay to

 * the success callback URL, so that it appears correctly within the overlay.

 *

 * @see overlay_get_mode()

 */

function overlay_batch_alter(&$batch) {

  if (overlay_get_mode() == 'child') {

    if (isset($batch['url_options']['query'])) {

      $batch['url_options']['query']['render'] = 'overlay';

    }

    else {

      $batch['url_options']['query'] = array('render' => 'overlay');

    }

  }

}

/**

 * Implements hook_page_alter().

 */

function overlay_page_alter(&$page) {

  // If we are limiting rendering to a subset of page regions, deny access to

  // all other regions so that they will not be processed.

  if ($regions_to_render = overlay_get_regions_to_render()) {

    $skipped_regions = array_diff(element_children($page), $regions_to_render);

    foreach ($skipped_regions as $skipped_region) {

      $page[$skipped_region]['#access'] = FALSE;

    }

  }

  $mode = overlay_get_mode();

  if ($mode == 'child') {

    // Add the overlay wrapper before the html wrapper.

    array_unshift($page['#theme_wrappers'], 'overlay');

  }

  elseif ($mode == 'parent' && ($message = overlay_disable_message())) {

    $page['page_top']['disable_overlay'] = $message;

  }

}

/**

 * Page callback: Dismisses the overlay accessibility message for this user.

 *

 * @return

 *   A render array for a page containing a list of content.

 */

function overlay_user_dismiss_message() {

  global $user;

  // It's unlikely, but possible that "access overlay" permission is granted to

  // the anonymous role. In this case, we do not display the message to disable

  // the overlay, so there is nothing to dismiss. Also, protect against

  // cross-site request forgeries by validating a token.

  if (empty($user->uid) || !isset($_GET['token']) || !drupal_valid_token($_GET['token'], 'overlay')) {

    return MENU_ACCESS_DENIED;

  }

  else {

    user_save(user_load($user->uid), array('data' => array('overlay_message_dismissed' => 1)));

    drupal_set_message(t('The message has been dismissed. You can change your overlay settings at any time by visiting your profile page.'));

    // Destination is normally given. Go to the user profile as a fallback.

    drupal_goto('user/' . $user->uid . '/edit');

  }

}

/**

 * Returns a renderable array representing a message for disabling the overlay.

 *

 * If the current user can access the overlay and has not previously indicated

 * that this message should be dismissed, this function returns a message

 * containing a link to disable the overlay. Nothing is returned for anonymous

 * users, because the links control per-user settings. Because some screen

 * readers are unable to properly read overlay contents, site builders are

 * discouraged from granting the "access overlay" permission to the anonymous

 * role.

 *

 * @see http://drupal.org/node/890284

 */

function overlay_disable_message() {

  global $user;

  if (!empty($user->uid) && empty($user->data['overlay_message_dismissed']) && (!isset($user->data['overlay']) || $user->data['overlay']) && user_access('access overlay')) {

    $build = array(

      '#theme' => 'overlay_disable_message',

      '#weight' => -99,

      // Link to the user's profile page, where the overlay can be disabled.

      'profile_link' => array(

        '#type' => 'link',

        '#title' => t('If you have problems accessing administrative pages on this site, disable the overlay on your profile page.'),

        '#href' => 'user/' . $user->uid . '/edit',

        '#options' => array(

          'query' => drupal_get_destination(),

          'fragment' => 'edit-overlay-control',

          'attributes' => array(

            'id' => 'overlay-profile-link',

            // Prevent the target page from being opened in the overlay.

            'class' => array('overlay-exclude'),

          ),

        ),

      ),

      // Link to a menu callback that allows this message to be permanently

      // dismissed for the current user.

      'dismiss_message_link' => array(

        '#type' => 'link',

        '#title' => t('Dismiss this message.'),

        '#href' => 'overlay/dismiss-message',

        '#options' => array(

          'query' => drupal_get_destination() + array(

            // Add a token to protect against cross-site request forgeries.

            'token' => drupal_get_token('overlay'),

          ),

          'attributes' => array(

            'id' => 'overlay-dismiss-message',

            // If this message is being displayed outside the overlay, prevent

            // this link from opening the overlay.

            'class' => (overlay_get_mode() == 'parent') ? array('overlay-exclude') : array(),

          ),

        ),

      )

    );

  }

  else {

    $build = array();

  }

  return $build;

}

/**

 * Returns the HTML for the message about how to disable the overlay.

 *

 * @param $variables

 *   An associative array with an 'element' element, which itself is an

 *   associative array containing:

 *   - profile_link: The link to this user's account.

 *   - dismiss_message_link: The link to dismiss the overlay.

 *

 * @ingroup themeable

 */

function theme_overlay_disable_message($variables) {

  $element = $variables['element'];

  // Add CSS classes to hide the links from most sighted users, while keeping

  // them accessible to screen-reader users and keyboard-only users. To assist

  // screen-reader users, this message appears in both the parent and child

  // documents, but only the one in the child document is part of the tab order.

  foreach (array('profile_link', 'dismiss_message_link') as $key) {

    $element[$key]['#options']['attributes']['class'][] = 'element-invisible';

    if (overlay_get_mode() == 'child') {

      $element[$key]['#options']['attributes']['class'][] = 'element-focusable';

    }

  }

  // Render the links.

  $output = drupal_render($element['profile_link']) . ' ' . drupal_render($element['dismiss_message_link']);

  // Add a heading for screen-reader users. The heading doesn't need to be seen

  // by sighted users.

  $output = '<h3 class="element-invisible">' . t('Options for the administrative overlay') . '</h3>' . $output;

  // Wrap in a container for styling.

  $output = '<div id="overlay-disable-message" class="clearfix">' . $output . '</div>';

  return $output;

}

/**

 * Implements hook_block_list_alter().

 */

function overlay_block_list_alter(&$blocks) {

  // If we are limiting rendering to a subset of page regions, hide all blocks

  // which appear in regions not on that list. Note that overlay_page_alter()

  // does a more comprehensive job of preventing unwanted regions from being

  // displayed (regardless of whether they contain blocks or not), but the

  // reason for duplicating effort here is performance; we do not even want

  // these blocks to be built if they are not going to be displayed.

  if ($regions_to_render = overlay_get_regions_to_render()) {

    foreach ($blocks as $bid => $block) {

      if (!in_array($block->region, $regions_to_render)) {

        unset($blocks[$bid]);

      }

    }

  }

}

/**

 * Implements hook_system_info_alter().

 *

 * Add default regions for the overlay.

 */

function overlay_system_info_alter(&$info, $file, $type) {

  if ($type == 'theme') {

    $info['overlay_regions'][] = 'content';

    $info['overlay_regions'][] = 'help';

  }

}

/**

 * Implements hook_preprocess_html().

 *

 * If the current page request is inside the overlay, add appropriate classes

 * to the <body> element, and simplify the page title.

 *

 * @see overlay_get_mode()

 */

function overlay_preprocess_html(&$variables) {

  if (overlay_get_mode() == 'child') {

    // Add overlay class, so themes can react to being displayed in the overlay.

    $variables['classes_array'][] = 'overlay';

  }

}

/**

 * Implements hook_preprocess_maintenance_page().

 *

 * If the current page request is inside the overlay, add appropriate classes

 * to the <body> element, and simplify the page title.

 *

 * @see overlay_preprocess_maintenance_page()

 */

function overlay_preprocess_maintenance_page(&$variables) {

  overlay_preprocess_html($variables);

}

/**

 * Implements template_preprocess_HOOK() for overlay.tpl.php

 *

 * If the current page request is inside the overlay, add appropriate classes

 * to the <body> element, and simplify the page title.

 *

 * @see template_process_overlay()

 * @see overlay.tpl.php

 */

function template_preprocess_overlay(&$variables) {

  $variables['tabs'] = menu_primary_local_tasks();

  $variables['title'] = drupal_get_title();

  $variables['disable_overlay'] = overlay_disable_message();

  $variables['content_attributes_array']['class'][] = 'clearfix';

}

/**

 * Implements template_process_HOOK() for overlay.tpl.php

 *

 * Places the rendered HTML for the page body into a top level variable.

 *

 * @see template_preprocess_overlay()

 * @see overlay.tpl.php

 */

function template_process_overlay(&$variables) {

  $variables['page'] = $variables['page']['#children'];