shortcut.module 20.5 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Allows users to manage customizable lists of shortcut links.
 */

8
use Drupal\shortcut\Plugin\Core\Entity\Shortcut;
9

10 11 12 13
/**
 * Implements hook_help().
 */
function shortcut_help($path, $arg) {
14 15
  global $user;

16 17 18
  switch ($path) {
    case 'admin/help#shortcut':
      $output = '<h3>' . t('About') . '</h3>';
19
      $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>';
20
      $output .= '<h3>' . t('Uses') . '</h3>';
21 22 23 24
      $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>';
25
      $output .= '<dt>' . t('Adding and removing shortcuts') . '</dt>';
26
      $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>';
27
      $output .= '<dt>' . t('Displaying shortcuts') . '</dt>';
28
      $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>';
29 30
      $output .= '</dl>';
      return $output;
31 32 33 34 35 36 37

    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;
      }
38 39
  }
}
40

41
/**
42
 * Implements hook_permission().
43 44 45 46 47 48 49
 */
function shortcut_permission() {
  return array(
    'administer shortcuts' => array(
      'title' => t('Administer shortcuts'),
    ),
    'customize shortcut links' => array(
50 51
      '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.'),
52 53
    ),
    'switch shortcut sets' => array(
54 55
      '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.'),
56 57 58 59 60
    ),
  );
}

/**
61
 * Implements hook_menu().
62 63
 */
function shortcut_menu() {
64
  $items['admin/config/user-interface/shortcut'] = array(
65
    'title' => 'Shortcuts',
66
    'description' => 'Add and modify shortcut sets.',
67
    'route_name' => 'shortcut_set_admin',
68 69 70
  );
  $items['admin/config/user-interface/shortcut/add-set'] = array(
    'title' => 'Add shortcut set',
71
    'page callback' => 'shortcut_set_add',
72
    'access arguments' => array('administer shortcuts'),
73
    'type' => MENU_LOCAL_ACTION,
74 75
    'file' => 'shortcut.admin.inc',
  );
76
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set'] = array(
77
    'title' => 'Edit shortcuts',
78
    'page callback' => 'drupal_get_form',
79 80 81
    'page arguments' => array('shortcut_set_customize', 5),
    'title callback' => 'entity_page_label',
    'title arguments' => array(5),
82
    'access callback' => 'shortcut_set_edit_access',
83
    'access arguments' => array(5),
84 85
    'file' => 'shortcut.admin.inc',
  );
86
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set/links'] = array(
87 88 89
    'title' => 'List links',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
90
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set/edit'] = array(
91
    'title' => 'Edit set name',
92 93
    'page callback' => 'entity_get_form',
    'page arguments' => array(5),
94
    'access callback' => 'shortcut_set_edit_access',
95
    'access arguments' => array(5),
96 97 98 99
    'type' => MENU_LOCAL_TASK,
    'file' => 'shortcut.admin.inc',
    'weight' => 10,
  );
100
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set/delete'] = array(
101
    'title' => 'Delete shortcut set',
102
    'route_name' => 'shortcut_set_delete',
103
  );
104
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set/add-link'] = array(
105 106
    'title' => 'Add shortcut',
    'page callback' => 'drupal_get_form',
107
    'page arguments' => array('shortcut_link_add', 5),
108
    'access callback' => 'shortcut_set_edit_access',
109
    'access arguments' => array(5),
110 111 112
    'type' => MENU_LOCAL_ACTION,
    'file' => 'shortcut.admin.inc',
  );
113
  $items['admin/config/user-interface/shortcut/manage/%shortcut_set/add-link-inline'] = array(
114 115
    'title' => 'Add shortcut',
    'page callback' => 'shortcut_link_add_inline',
116
    'page arguments' => array(5),
117
    'access callback' => 'shortcut_set_edit_access',
118
    'access arguments' => array(5),
119 120 121
    'type' => MENU_CALLBACK,
    'file' => 'shortcut.admin.inc',
  );
122
  $items['admin/config/user-interface/shortcut/link/%menu_link'] = array(
123 124 125 126 127 128 129
    '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',
  );
130
  $items['admin/config/user-interface/shortcut/link/%menu_link/delete'] = array(
131
    'title' => 'Delete shortcut',
132
    'route_name' => 'shortcut_link_delete',
133 134 135 136 137 138 139 140 141 142
  );
  $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',
  );
143

144 145 146
  return $items;
}

147 148 149 150 151 152 153 154 155 156
/**
 * Implements hook_admin_paths().
 */
function shortcut_admin_paths() {
  $paths = array(
    'user/*/shortcuts' => TRUE,
  );
  return $paths;
}

157
/**
158
 * Implements hook_theme().
159 160 161 162
 */
function shortcut_theme() {
  return array(
    'shortcut_set_customize' => array(
163
      'render element' => 'form',
164 165 166 167 168 169 170 171
      'file' => 'shortcut.admin.inc',
    ),
  );
}

/**
 * Access callback for editing a shortcut set.
 *
172
 * @param $shortcut_set Drupal\shortcut\Plugin\Core\Entity\Shortcut
173 174 175
 *   (optional) The shortcut set to be edited. If not set, the current user's
 *   shortcut set will be used.
 *
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
 * @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 switching the shortcut set assigned to a user account.
 *
195
 * @param object $account
196
 *   (optional) The user account whose shortcuts will be switched. If not set,
197 198 199
 *   permissions will be checked for switching the logged-in user's own
 *   shortcut set.
 *
200 201 202 203 204 205
 * @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;
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

  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;
224 225 226 227 228 229 230 231
}

/**
 * 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.
232 233
  $set_name = str_replace('shortcut-', '', $menu_link['menu_name']);
  if ($shortcut_set = shortcut_set_load($set_name)) {
234 235 236 237 238
    return shortcut_set_edit_access($shortcut_set);
  }
  return FALSE;
}

239 240 241 242 243 244 245 246 247 248 249 250
/**
 * Implements hook_menu_link_delete().
 */
function shortcut_menu_link_delete($menu_link) {
  // If the deleted menu link was in a shortcut set, remove it.
  if (strpos($menu_link->menu_name, 'shortcut-') === 0) {
    $shortcut = entity_load('shortcut', str_replace('shortcut-', '', $menu_link->menu_name));
    unset($shortcut->links[$menu_link->uuid]);
    $shortcut->save();
  }
}

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/**
 * Loads the data for a shortcut set.
 *
 * @param $id
 *   The machine-name of the shortcut set to load.
 *
 * @return object
 *   If the shortcut set exists, an object containing the following properties:
 *   - 'id': The internal name of the shortcut set.
 *   - 'label': 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($id) {
  return entity_load('shortcut', $id);
}
267

268
/**
269
 * Resets the link weights in a shortcut set to match their current order.
270 271 272 273 274
 *
 * 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.
 *
275
 * @param object $shortcut_set
276 277 278 279 280
 *   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;
281 282
  foreach ($shortcut_set->links as $menu_link) {
    $menu_link->weight = ++$weight;
283 284 285 286
  }
}

/**
287
 * Assigns a user to a particular shortcut set.
288
 *
289
 * @param $shortcut_set Drupal\shortcut\Plugin\Core\Entity\Shortcut
290 291 292 293 294 295 296
 *   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))
297
    ->fields(array('set_name' => $shortcut_set->id()))
298
    ->execute();
299
  drupal_static_reset('shortcut_current_displayed_set');
300 301 302
}

/**
303
 * Unassigns a user from any shortcut set they may have been assigned to.
304 305 306 307 308
 *
 * 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.
309
 *
310 311 312 313 314 315
 * @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) {
316
  $deleted = db_delete('shortcut_set_users')
317 318 319 320 321 322 323 324 325 326
    ->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
327 328
 *   the currently logged-in user.
 *
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
 * @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.
346 347 348
  $query = db_select('shortcut_set_users', 'ssu');
  $query->fields('ssu', array('set_name'));
  $query->condition('ssu.uid', $account->uid);
349 350 351 352
  $shortcut_set_name = $query->execute()->fetchField();
  if ($shortcut_set_name) {
    $shortcut_set = shortcut_set_load($shortcut_set_name);
  }
353
  // Otherwise, use the default set.
354
  else {
355 356
    $shortcut_set = shortcut_default_set($account);
  }
357

358 359 360 361 362 363 364
  $shortcut_sets[$account->uid] = $shortcut_set;
  return $shortcut_set;
}

/**
 * Returns the default shortcut set for a given user account.
 *
365 366 367 368 369
 * @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.
 *
370 371 372 373 374 375 376 377
 * @return
 *   An object representing the default shortcut set.
 */
function shortcut_default_set($account = NULL) {
  global $user;
  if (!isset($account)) {
    $account = $user;
  }
378

379 380 381
  // 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
382 383
  // default, which is the lowest-numbered shortcut set.
  $suggestions = array_reverse(module_invoke_all('shortcut_default_set', $account));
384
  $suggestions[] = 'default';
385
  foreach ($suggestions as $name) {
386 387 388 389
    if ($shortcut_set = shortcut_set_load($name)) {
      break;
    }
  }
390

391 392 393
  return $shortcut_set;
}

394 395 396 397 398 399 400 401 402 403
/**
 * Check to see if a shortcut set with the given title already exists.
 *
 * @param $title
 *   Human-readable name of the shortcut set to check.
 *
 * @return
 *   TRUE if a shortcut set with that title exists; FALSE otherwise.
 */
function shortcut_set_title_exists($title) {
404 405 406 407 408 409 410
  $sets = entity_load_multiple('shortcut');
  foreach ($sets as $id => $set) {
    if ($set->label == $title) {
      return TRUE;
    }
  }
  return FALSE;
411 412
}

413 414 415 416 417
/**
 * Determines if a path corresponds to a valid shortcut link.
 *
 * @param $path
 *   The path to the link.
418
 *
419 420 421 422 423 424 425 426
 * @return
 *   TRUE if the shortcut link is valid, FALSE otherwise. Valid links are ones
 *   that correspond to actual paths on the site.
 *
 * @see menu_edit_item_validate()
 */
function shortcut_valid_link($path) {
  // Do not use URL aliases.
427
  $normal_path = drupal_container()->get('path.alias_manager')->getSystemPath($path);
428 429 430
  if ($path != $normal_path) {
    $path = $normal_path;
  }
431 432
  // An empty path is valid too and will be converted to <front>.
  return (!url_is_external($path) && menu_get_item($path)) || empty($path) || $path == '<front>';
433 434 435 436 437
}

/**
 * Returns an array of shortcut links, suitable for rendering.
 *
438
 * @param $shortcut_set Drupal\shortcut\Plugin\Core\Entity\Shortcut
439 440 441 442 443 444 445 446 447 448 449
 *   (optional) An object representing the set whose links will be displayed.
 *   If not provided, the user's current set will be displayed.
 * @return
 *   An array of shortcut links, in the format returned by the menu system.
 *
 * @see menu_tree()
 */
function shortcut_renderable_links($shortcut_set = NULL) {
  if (!isset($shortcut_set)) {
    $shortcut_set = shortcut_current_displayed_set();
  }
450
  return menu_tree('shortcut-' . $shortcut_set->id());
451 452
}

453
/**
454
 * Implements hook_preprocess_HOOK() for block.tpl.php.
455 456 457
 */
function shortcut_preprocess_block(&$variables) {
  if ($variables['block']->module == 'shortcut') {
458
    $variables['attributes']['role'] = 'navigation';
459 460 461
  }
}

462
/**
463
 * Implements hook_preprocess_HOOK() for page.tpl.php.
464
 */
465
function shortcut_preprocess_page(&$variables) {
466 467 468 469 470
  // Only display the shortcut link if the user has the ability to edit
  // shortcuts and if the page's actual content is being shown (for example,
  // we do not want to display it on "access denied" or "page not found"
  // pages).
  if (shortcut_set_edit_access() && ($item = menu_get_item()) && $item['access']) {
471
    $link = current_path();
472 473 474 475 476 477 478 479 480 481 482
    $query_parameters = drupal_get_query_parameters();
    if (!empty($query_parameters)) {
     $link .= '?' . drupal_http_build_query($query_parameters);
    }
    $query = array(
     'link' => $link,
     'name' => drupal_get_title(),
    );
    $query += drupal_get_destination();

    $shortcut_set = shortcut_current_displayed_set();
483 484

    // Check if $link is already a shortcut and set $link_mode accordingly.
485
    foreach ($shortcut_set->links as $uuid => $shortcut) {
486 487 488 489 490 491 492 493 494
      if ($link == $shortcut['link_path']) {
        $mlid = $shortcut['mlid'];
        break;
      }
    }
    $link_mode = isset($mlid) ? "remove" : "add";

    if ($link_mode == "add") {
      $query['token'] = drupal_get_token('shortcut-add-link');
495 496
      $link_text = shortcut_set_switch_access() ? t('Add to %shortcut_set shortcuts', array('%shortcut_set' => $shortcut_set->label())) : t('Add to shortcuts');
      $link_path = 'admin/config/user-interface/shortcut/manage/' . $shortcut_set->id() . '/add-link-inline';
497 498 499
    }
    else {
      $query['mlid'] = $mlid;
500
      $link_text = shortcut_set_switch_access() ? t('Remove from %shortcut_set shortcuts', array('%shortcut_set' => $shortcut_set->label())) : t('Remove from shortcuts');
501
      $link_path = 'admin/config/user-interface/shortcut/link/' . $mlid . '/delete';
502 503
    }

504 505
    if (theme_get_setting('shortcut_module_link')) {
      $variables['title_suffix']['add_or_remove_shortcut'] = array(
506 507 508 509 510 511
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'shortcut') . '/shortcut.base.css',
            drupal_get_path('module', 'shortcut') . '/shortcut.theme.css',
          ),
        ),
512 513
        '#prefix' => '<div class="add-or-remove-shortcuts ' . $link_mode . '-shortcut">',
        '#type' => 'link',
514
        '#title' => '<span class="icon">'. t('Add or remove shortcut') .'</span><span class="text">' . $link_text . '</span>',
515 516 517 518 519
        '#href' => $link_path,
        '#options' => array('query' => $query, 'html' => TRUE),
        '#suffix' => '</div>',
      );
    }
520
  }
521 522 523
}

/**
524
 * Implements hook_toolbar().
525
 */
526
function shortcut_toolbar() {
527
  $items = array();
528 529 530 531
  $links = shortcut_renderable_links();
  $shortcut_set = shortcut_current_displayed_set();
  $configure_link = NULL;
  if (shortcut_set_edit_access($shortcut_set)) {
532 533
    $configure_link = array(
      '#type' => 'link',
534
      '#title' => t('Edit shortcuts'),
535
      '#href' => 'admin/config/user-interface/shortcut/' . $shortcut_set->id(),
536
      '#options' => array('attributes' => array('class' => array('edit-shortcuts'))),
537
    );
538
  }
539 540 541 542 543 544 545 546 547 548 549 550 551
  if (!empty($links) || !empty($configure_link)) {
    $items['shortcuts'] = array(
      '#type' => 'toolbar_item',
      'tab' => array(
        '#type' => 'link',
        '#title' => t('Shortcuts'),
        '#href' => 'admin/config/user-interface/shortcut',
        '#options' => array(
          'attributes' => array(
            'title' => t('Shortcuts'),
            'class' => array('icon', 'icon-shortcut'),
          ),
        ),
552
      ),
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
      'tray' => array(
        '#heading' => t('User-defined shortcuts'),
        'shortcuts' => $links,
        'configure' => $configure_link,
      ),
      '#weight' => -10,
      '#attached' => array(
        'css' => array(
          drupal_get_path('module', 'shortcut') . '/shortcut.base.css',
          drupal_get_path('module', 'shortcut') . '/shortcut.theme.css',
        ),
      ),
    );
  }

568
  return $items;
569 570
}

571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
/**
 * Implements hook_library_info().
 */
function shortcut_library_info() {
  $libraries['drupal.shortcut.admin'] = array(
    'title' => 'Shortcut',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'shortcut') . '/shortcut.admin.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );

  return $libraries;
}