<?php

/**

 * @file

 * Allows users to manage customizable lists of shortcut links.

 */

/**

 * The name of the default shortcut set.

 *

 * This set will be displayed to any user that does not have another set

 * assigned, unless overridden by a hook_shortcut_default_set() implementation.

 */

define('SHORTCUT_DEFAULT_SET_NAME', 'shortcut-set-1');

/**

 * Implements hook_help().

 */

function shortcut_help($path, $arg) {

  global $user;

  switch ($path) {

    case 'admin/help#shortcut':

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

      $output .= '<p>' . t('The Shortcut module allows users to create sets of <em>shortcut</em> links to commonly-visited pages of the site. Shortcuts are contained within <em>sets</em>. Each user with <em>Select any shortcut set</em> permission can select a shortcut set created by anyone at the site. For more information, see the online handbook entry for <a href="@shortcut">Shortcut module</a>.', array('@shortcut' => 'http://drupal.org/documentation/modules/shortcut/')) . '</p>';

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

      $output .= '<dl><dt>' . t('Administering shortcuts') . '</dt>';

      $output .= '<dd>' . t('Users with the <em>Administer shortcuts</em> permission can manage shortcut sets and edit the shortcuts within sets from the <a href="@shortcuts">Shortcuts administration page</a>.', array('@shortcuts' => url('admin/config/user-interface/shortcut'))) . '</dd>';

      $output .= '<dt>' . t('Choosing shortcut sets') . '</dt>';

      $output .= '<dd>' . t('Users with permission to switch shortcut sets can choose a shortcut set to use from the Shortcuts tab of their user account page.') . '</dd>';

      $output .= '<dt>' . t('Adding and removing shortcuts') . '</dt>';

      $output .= '<dd>' . t('The Shortcut module creates an add/remove link for each page on your site; the link lets you add or remove the current page from the currently-enabled set of shortcuts (if your theme displays it and you have permission to edit your shortcut set). The core Seven administration theme displays this link next to the page title, as a small + or - sign. If you click on the + sign, you will add that page to your preferred set of shortcuts. If the page is already part of your shortcut set, the link will be a - sign, and will allow you to remove the current page from your shortcut set.') . '</dd>';

      $output .= '<dt>' . t('Displaying shortcuts') . '</dt>';

      $output .= '<dd>' . t('You can display your shortcuts by enabling the Shortcuts block on the <a href="@blocks">Blocks administration page</a>. Certain administrative modules also display your shortcuts; for example, the core <a href="@toolbar-help">Toolbar module</a> displays them near the top of the page, along with an <em>Edit shortcuts</em> link.', array('@blocks' => url('admin/structure/block'), '@toolbar-help' => url('admin/help/toolbar'))) . '</dd>';

      $output .= '</dl>';

      return $output;

    case 'admin/config/user-interface/shortcut':

    case 'admin/config/user-interface/shortcut/%':

      if (user_access('switch shortcut sets')) {

        $output = '<p>' . t('Define which shortcut set you are using on the <a href="@shortcut-link">Shortcuts tab</a> of your account page.', array('@shortcut-link' => url("user/{$user->uid}/shortcuts"))) . '</p>';

        return $output;

      }

  }

}

/**

 * Implements hook_permission().

 */

function shortcut_permission() {

  return array(

    'administer shortcuts' => array(

      'title' => t('Administer shortcuts'),

    ),

    'customize shortcut links' => array(

      'title' => t('Edit current shortcut set'),

      'description' => t('Editing the current shortcut set will affect other users if that set has been assigned to or selected by other users. Granting "Select any shortcut set" permission along with this permission will grant permission to edit any shortcut set.'),

    ),

    'switch shortcut sets' => array(

      'title' => t('Select any shortcut set'),

      'description' => t('From all shortcut sets, select one to be own active set. Without this permission, an administrator selects shortcut sets for users.'),

    ),

  );

}

/**

 * Implements hook_menu().

 */

function shortcut_menu() {

  $items['admin/config/user-interface/shortcut'] = array(

    'title' => 'Shortcuts',

    'description' => 'Add and modify shortcut sets.',

    'page callback' => 'shortcut_set_admin',

    'access arguments' => array('administer shortcuts'),

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/add-set'] = array(

    'title' => 'Add shortcut set',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_set_add_form'),

    'access arguments' => array('administer shortcuts'),

    'type' => MENU_LOCAL_ACTION,

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set'] = array(

    'title' => 'Edit shortcuts',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_set_customize', 4),

    'title callback' => 'shortcut_set_title_callback',

    'title arguments' => array(4),

    'access callback' => 'shortcut_set_edit_access',

    'access arguments' => array(4),

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set/links'] = array(

    'title' => 'List links',

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set/edit'] = array(

    'title' => 'Edit set name',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_set_edit_form', 4),

    'access callback' => 'shortcut_set_edit_access',

    'access arguments' => array(4),

    'type' => MENU_LOCAL_TASK,

    'file' => 'shortcut.admin.inc',

    'weight' => 10,

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set/delete'] = array(

    'title' => 'Delete shortcut set',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_set_delete_form', 4),

    'access callback' => 'shortcut_set_delete_access',

    'access arguments' => array(4),

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set/add-link'] = array(

    'title' => 'Add shortcut',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_link_add', 4),

    'access callback' => 'shortcut_set_edit_access',

    'access arguments' => array(4),

    'type' => MENU_LOCAL_ACTION,

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/%shortcut_set/add-link-inline'] = array(

    'title' => 'Add shortcut',

    'page callback' => 'shortcut_link_add_inline',

    'page arguments' => array(4),

    'access callback' => 'shortcut_set_edit_access',

    'access arguments' => array(4),

    'type' => MENU_CALLBACK,

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/link/%menu_link'] = array(

    'title' => 'Edit shortcut',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_link_edit', 5),

    'access callback' => 'shortcut_link_access',

    'access arguments' => array(5),

    'file' => 'shortcut.admin.inc',

  );

  $items['admin/config/user-interface/shortcut/link/%menu_link/delete'] = array(

    'title' => 'Delete shortcut',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_link_delete', 5),

    'access callback' => 'shortcut_link_access',

    'access arguments' => array(5),

    'file' => 'shortcut.admin.inc',

  );

  $items['user/%user/shortcuts'] = array(

    'title' => 'Shortcuts',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('shortcut_set_switch', 1),

    'access callback' => 'shortcut_set_switch_access',

    'access arguments' => array(1),

    'type' => MENU_LOCAL_TASK,

    'file' => 'shortcut.admin.inc',

  );

  return $items;

}

/**

 * Implements hook_admin_paths().

 */

function shortcut_admin_paths() {

  $paths = array(

    'user/*/shortcuts' => TRUE,

  );

  return $paths;

}

/**

 * Implements hook_theme().

 */

function shortcut_theme() {

  return array(

    'shortcut_set_customize' => array(

      'render element' => 'form',

      'file' => 'shortcut.admin.inc',

    ),

  );

}

/**

 * Implements hook_block_info().

 */

function shortcut_block_info() {

  $blocks['shortcuts']['info'] = t('Shortcuts');

  // Shortcut blocks can't be cached because each menu item can have a custom

  // access callback. menu.inc manages its own caching.

  $blocks['shortcuts']['cache'] = DRUPAL_NO_CACHE;

  return $blocks;

}

/**

 * Implements hook_block_view().

 */

function shortcut_block_view($delta = '') {

  if ($delta == 'shortcuts') {

    $shortcut_set = shortcut_current_displayed_set();

    $data['subject'] = t('@shortcut_set shortcuts', array('@shortcut_set' => $shortcut_set->title));

    $data['content'] = shortcut_renderable_links($shortcut_set);

    return $data;

  }

}

/**

 * Access callback for editing a shortcut set.

 *

 * @param object $shortcut_set

 *   (optional) The shortcut set to be edited. If not set, the current user's

 *   shortcut set will be used.

 *

 * @return

 *   TRUE if the current user has access to edit the shortcut set, FALSE

 *   otherwise.

 */

function shortcut_set_edit_access($shortcut_set = NULL) {

  // Sufficiently-privileged users can edit their currently displayed shortcut

  // set, but not other sets. Shortcut administrators can edit any set.

  if (user_access('administer shortcuts')) {

    return TRUE;

  }

  if (user_access('customize shortcut links')) {

    return !isset($shortcut_set) || $shortcut_set == shortcut_current_displayed_set();

  }

  return FALSE;

}

/**

 * Access callback for deleting a shortcut set.

 *

 * @param $shortcut_set

 *   The shortcut set to be deleted.

 *

 * @return

 *   TRUE if the current user has access to delete shortcut sets and this is

 *   not the site-wide default set; FALSE otherwise.

 */

function shortcut_set_delete_access($shortcut_set) {

  // Only admins can delete sets.

  if (!user_access('administer shortcuts')) {

    return FALSE;

  }

  // Never let the default shortcut set be deleted.

  if ($shortcut_set->set_name == SHORTCUT_DEFAULT_SET_NAME) {

    return FALSE;

  }

  return TRUE;

}

/**

 * Access callback for switching the shortcut set assigned to a user account.

 *

 * @param object $account

 *   (optional) The user account whose shortcuts will be switched. If not set,

 *   permissions will be checked for switching the logged-in user's own

 *   shortcut set.

 *

 * @return

 *   TRUE if the current user has access to switch the shortcut set of the

 *   provided account, FALSE otherwise.

 */

function shortcut_set_switch_access($account = NULL) {

  global $user;

  if (user_access('administer shortcuts')) {

    // Administrators can switch anyone's shortcut set.

    return TRUE;

  }

  if (!user_access('switch shortcut sets')) {

    // The user has no permission to switch anyone's shortcut set.

    return FALSE;

  }

  if (!isset($account) || $user->uid == $account->uid) {

    // Users with the 'switch shortcut sets' permission can switch their own

    // shortcuts sets.

    return TRUE;

  }

  return FALSE;

}

/**

 * Access callback for editing a link in a shortcut set.

 */

function shortcut_link_access($menu_link) {

  // The link must belong to a shortcut set that the current user has access

  // to edit.

  if ($shortcut_set = shortcut_set_load($menu_link['menu_name'])) {

    return shortcut_set_edit_access($shortcut_set);

  }

  return FALSE;

}

/**

 * Loads the data for a shortcut set.

 *

 * @param $set_name

 *   The name of the shortcut set to load.

 *

 * @return object

 *   If the shortcut set exists, an object containing the following properties:

 *   - 'set_name': The internal name of the shortcut set.

 *   - 'title': The title of the shortcut set.

 *   - 'links': An array of links associated with this shortcut set.

 *   If the shortcut set does not exist, the function returns FALSE.

 */

function shortcut_set_load($set_name) {

  $set = db_select('shortcut_set', 'ss')

  ->fields('ss')

  ->condition('set_name', $set_name)

  ->execute()

  ->fetchObject();

  if (!$set) {

    return FALSE;

  }

  $set->links = menu_load_links($set_name);

  return $set;

}

/**

 * Saves a shortcut set.

 *

 * @param $shortcut_set

 *   An object containing the following properties:

 *   - 'title': The title of the shortcut set.

 *   - 'set_name': (optional) The internal name of the shortcut set. If

 *     omitted, a new shortcut set will be created, and the 'set_name' property

 *     will be added to the passed-in object.

 *   - 'links': (optional) An array of menu links to save for the shortcut set.

 *     Each link is an array containing at least the following keys (which will

 *     be expanded to fill in other default values after the shortcut set is

 *     saved):

 *     - 'link_path': The Drupal path or external path that the link points to.

 *     - 'link_title': The title of the link.

 *     Any other keys accepted by menu_link_save() may also be provided.

 *

 * @return

 *   A constant which is either SAVED_NEW or SAVED_UPDATED depending on whether

 *   a new set was created or an existing one was updated.

 *

 * @see menu_link_save()

 */

function shortcut_set_save(&$shortcut_set) {

  // First save the shortcut set itself.

  if (isset($shortcut_set->set_name)) {

    $return = drupal_write_record('shortcut_set', $shortcut_set, 'set_name');

  }

  else {

    $shortcut_set->set_name = shortcut_set_get_unique_name();

    $return = drupal_write_record('shortcut_set', $shortcut_set);

  }

  // If links were provided for the set, save them.

  if (isset($shortcut_set->links)) {

    foreach ($shortcut_set->links as &$link) {

      // Do not specifically associate these links with the shortcut module,

      // since other modules may make them editable via the menu system.

      // However, we do need to specify the correct menu name.

      $link['menu_name'] = $shortcut_set->set_name;

      $link['plid'] = 0;

      menu_link_save($link);

    }

    // Make sure that we have a return value, since if the links were updated

    // but the shortcut set was not, the call to drupal_write_record() above

    // would not return an indication that anything had changed.

    if (empty($return)) {

      $return = SAVED_UPDATED;

    }

  }

  return $return;

}

/**

 * Deletes a shortcut set.

 *

 * Note that the default set cannot be deleted.

 *

 * @param $shortcut_set

 *   An object representing the shortcut set to delete.

 *

 * @return

 *   TRUE if the set was deleted, FALSE otherwise.

 */

function shortcut_set_delete($shortcut_set) {

  // Don't allow deletion of the system default shortcut set.

  if ($shortcut_set->set_name == SHORTCUT_DEFAULT_SET_NAME) {

    return FALSE;

  }

  // First, delete any user assignments for this set, so that each of these

  // users will go back to using whatever default set applies.

  db_delete('shortcut_set_users')

    ->condition('set_name', $shortcut_set->set_name)

    ->execute();

  // Next, delete the menu links for this set.

  menu_delete_links($shortcut_set->set_name);

  // Finally, delete the set itself.

  $deleted = db_delete('shortcut_set')

    ->condition('set_name', $shortcut_set->set_name)

    ->execute();

  return (bool) $deleted;

}

/**

 * Resets the link weights in a shortcut set to match their current order.

 *

 * This function can be used, for example, when a new shortcut link is added to

 * the set. If the link is added to the end of the array and this function is

 * called, it will force that link to display at the end of the list.

 *

 * @param object $shortcut_set

 *   An object representing a shortcut set. The link weights of the passed-in

 *   object will be reset as described above.

 */

function shortcut_set_reset_link_weights(&$shortcut_set) {

  $weight = -50;

  foreach ($shortcut_set->links as &$link) {

    $link['weight'] = $weight;

    $weight++;

  }

}

/**

 * Assigns a user to a particular shortcut set.

 *

 * @param $shortcut_set

 *   An object representing the shortcut set.

 * @param $account

 *   A user account that will be assigned to use the set.

 */

function shortcut_set_assign_user($shortcut_set, $account) {

  db_merge('shortcut_set_users')

    ->key(array('uid' => $account->uid))

    ->fields(array('set_name' => $shortcut_set->set_name))

    ->execute();

  drupal_static_reset('shortcut_current_displayed_set');

}

/**

 * Unassigns a user from any shortcut set they may have been assigned to.

 *

 * The user will go back to using whatever default set applies.

 *

 * @param $account

 *   A user account that will be removed from the shortcut set assignment.

 *

 * @return

 *   TRUE if the user was previously assigned to a shortcut set and has been

 *   successfully removed from it. FALSE if the user was already not assigned

 *   to any set.

 */

function shortcut_set_unassign_user($account) {

  $deleted = db_delete('shortcut_set_users')

    ->condition('uid', $account->uid)

    ->execute();

  return (bool) $deleted;

}

/**

 * Returns the current displayed shortcut set for the provided user account.

 *

 * @param $account

 *   (optional) The user account whose shortcuts will be returned. Defaults to

 *   the currently logged-in user.

 *

 * @return

 *   An object representing the shortcut set that should be displayed to the

 *   current user. If the user does not have an explicit shortcut set defined,

 *   the default set is returned.

 */

function shortcut_current_displayed_set($account = NULL) {

  $shortcut_sets = &drupal_static(__FUNCTION__, array());

  global $user;

  if (!isset($account)) {

    $account = $user;

  }

  // Try to return a shortcut set from the static cache.

  if (isset($shortcut_sets[$account->uid])) {

    return $shortcut_sets[$account->uid];

  }

  // If none was found, try to find a shortcut set that is explicitly assigned

  // to this user.

  $query = db_select('shortcut_set', 's');

  $query->addField('s', 'set_name');

  $query->join('shortcut_set_users', 'u', 's.set_name = u.set_name');

  $query->condition('u.uid', $account->uid);

  $shortcut_set_name = $query->execute()->fetchField();

  if ($shortcut_set_name) {

    $shortcut_set = shortcut_set_load($shortcut_set_name);

  }

  // Otherwise, use the default set.

  else {

    $shortcut_set = shortcut_default_set($account);

  }

  $shortcut_sets[$account->uid] = $shortcut_set;

  return $shortcut_set;

}

/**

 * Returns the default shortcut set for a given user account.

 *

 * @param object $account

 *   (optional) The user account whose default shortcut set will be returned.

 *   If not provided, the function will return the currently logged-in user's

 *   default shortcut set.

 *

 * @return

 *   An object representing the default shortcut set.

 */

function shortcut_default_set($account = NULL) {

  global $user;

  if (!isset($account)) {

    $account = $user;

  }

  // Allow modules to return a default shortcut set name. Since we can only

  // have one, we allow the last module which returns a valid result to take

  // precedence. If no module returns a valid set, fall back on the site-wide