annotate modules/dashboard/dashboard.module @ 13:134d4b2e75f6

updated quicktabs and google analytics modules
author danieleb <danielebarchiesi@me.com>
date Tue, 29 Oct 2013 13:48:59 +0000
parents ff03f76ab3fe
children
rev   line source
danielebarchiesi@0 1 <?php
danielebarchiesi@0 2 /**
danielebarchiesi@0 3 * @file
danielebarchiesi@0 4 * Provides a dashboard page in the administrative interface.
danielebarchiesi@0 5 */
danielebarchiesi@0 6
danielebarchiesi@0 7 /**
danielebarchiesi@0 8 * Implements hook_help().
danielebarchiesi@0 9 */
danielebarchiesi@0 10 function dashboard_help($path, $arg) {
danielebarchiesi@0 11 switch ($path) {
danielebarchiesi@0 12 case 'admin/help#dashboard':
danielebarchiesi@0 13 $output = '';
danielebarchiesi@0 14 $output .= '<h3>' . t('About') . '</h3>';
danielebarchiesi@0 15 $output .= '<p>' . t('The Dashboard module provides a <a href="@dashboard">Dashboard page</a> in the administrative interface for organizing administrative tasks and navigation, and tracking information within your site. The Dashboard page contains blocks, which you can add to and arrange using the drag-and-drop interface that appears when you click on the <em>Customize dashboard</em> link. Within this interface, blocks that are not primarily used for site administration do not appear by default, but can be added via the <em>Add other blocks</em> link. For more information, see the online handbook entry for <a href="@handbook">Dashboard module</a>.', array('@handbook' => 'http://drupal.org/documentation/modules/dashboard', '@dashboard' => url('admin/dashboard'))) . '</p>';
danielebarchiesi@0 16 $output .= '<h3>' . t('Uses') . '</h3>';
danielebarchiesi@0 17 $output .= '<dl>';
danielebarchiesi@0 18 $output .= '<dt>' . t('Tracking user activity') . '</dt>';
danielebarchiesi@0 19 $output .= '<dd>' . t("By enabling blocks such as <em>Who's online</em> and <em>Who's new</em>, site users can track who is logged in and new user signups at a centralized location.") . '</dd>';
danielebarchiesi@0 20 $output .= '<dt>' . t('Tracking content activity') . '</dt>';
danielebarchiesi@0 21 $output .= '<dd>' . t('By enabling blocks such as <em>Recent blog posts</em>, <em>New forum topics</em> and <em>Recent comments</em>, site users can view newly added site content at a glance.') . '</dd>';
danielebarchiesi@0 22 $output .= '</dl>';
danielebarchiesi@0 23 return $output;
danielebarchiesi@0 24
danielebarchiesi@0 25 case 'admin/dashboard/configure':
danielebarchiesi@0 26 // @todo This assumes the current page is being displayed using the same
danielebarchiesi@0 27 // theme that the dashboard is displayed in.
danielebarchiesi@0 28 $output = '<p>' . t('Rearrange blocks for display on the <a href="@dashboard-url">Dashboard page</a>. Blocks placed in the <em>Dashboard (inactive)</em> region are not displayed when viewing the Dashboard page, but are available within its <em>Customize dashboard</em> interface. Removing a block from active dashboard display makes it available on the main <a href="@blocks-url">blocks administration page</a>.', array('@dashboard-url' => url('admin/dashboard'), '@blocks-url' => url("admin/structure/block/list/{$GLOBALS['theme_key']}"))) . '</p>';
danielebarchiesi@0 29 return $output;
danielebarchiesi@0 30 }
danielebarchiesi@0 31 }
danielebarchiesi@0 32
danielebarchiesi@0 33 /**
danielebarchiesi@0 34 * Implements hook_menu().
danielebarchiesi@0 35 */
danielebarchiesi@0 36 function dashboard_menu() {
danielebarchiesi@0 37 $items['admin/dashboard'] = array(
danielebarchiesi@0 38 'title' => 'Dashboard',
danielebarchiesi@0 39 'description' => 'View and customize your dashboard.',
danielebarchiesi@0 40 'page callback' => 'dashboard_admin',
danielebarchiesi@0 41 'access arguments' => array('access dashboard'),
danielebarchiesi@0 42 // Make this appear first, so for example, in admin menus, it shows up on
danielebarchiesi@0 43 // the top corner of the window as a convenient "home link".
danielebarchiesi@0 44 'weight' => -15,
danielebarchiesi@0 45 );
danielebarchiesi@0 46 $items['admin/dashboard/configure'] = array(
danielebarchiesi@0 47 'title' => 'Configure available dashboard blocks',
danielebarchiesi@0 48 'description' => 'Configure which blocks can be shown on the dashboard.',
danielebarchiesi@0 49 'page callback' => 'dashboard_admin_blocks',
danielebarchiesi@0 50 'access arguments' => array('administer blocks'),
danielebarchiesi@0 51 'type' => MENU_VISIBLE_IN_BREADCRUMB,
danielebarchiesi@0 52 );
danielebarchiesi@0 53 $items['admin/dashboard/customize'] = array(
danielebarchiesi@0 54 'title' => 'Customize dashboard',
danielebarchiesi@0 55 'description' => 'Customize your dashboard.',
danielebarchiesi@0 56 'page callback' => 'dashboard_admin',
danielebarchiesi@0 57 'page arguments' => array(TRUE),
danielebarchiesi@0 58 'access arguments' => array('access dashboard'),
danielebarchiesi@0 59 'type' => MENU_VISIBLE_IN_BREADCRUMB,
danielebarchiesi@0 60 );
danielebarchiesi@0 61 $items['admin/dashboard/drawer'] = array(
danielebarchiesi@0 62 'page callback' => 'dashboard_show_disabled',
danielebarchiesi@0 63 'access arguments' => array('administer blocks'),
danielebarchiesi@0 64 'type' => MENU_CALLBACK,
danielebarchiesi@0 65 );
danielebarchiesi@0 66 $items['admin/dashboard/block-content/%/%'] = array(
danielebarchiesi@0 67 'page callback' => 'dashboard_show_block_content',
danielebarchiesi@0 68 'page arguments' => array(3, 4),
danielebarchiesi@0 69 'access arguments' => array('administer blocks'),
danielebarchiesi@0 70 'type' => MENU_CALLBACK,
danielebarchiesi@0 71 );
danielebarchiesi@0 72 $items['admin/dashboard/update'] = array(
danielebarchiesi@0 73 'page callback' => 'dashboard_update',
danielebarchiesi@0 74 'access arguments' => array('administer blocks'),
danielebarchiesi@0 75 'type' => MENU_CALLBACK,
danielebarchiesi@0 76 );
danielebarchiesi@0 77
danielebarchiesi@0 78 return $items;
danielebarchiesi@0 79 }
danielebarchiesi@0 80
danielebarchiesi@0 81 /**
danielebarchiesi@0 82 * Implements hook_permission().
danielebarchiesi@0 83 */
danielebarchiesi@0 84 function dashboard_permission() {
danielebarchiesi@0 85 return array(
danielebarchiesi@0 86 'access dashboard' => array(
danielebarchiesi@0 87 'title' => t('View the administrative dashboard'),
danielebarchiesi@0 88 // Note: We translate the 'Administer blocks' permission string here with
danielebarchiesi@0 89 // a separate t() call, to make sure it gets the same translation as when
danielebarchiesi@0 90 // it's in block_permission().
danielebarchiesi@0 91 'description' => t('Customizing the dashboard requires the !permission-name permission.', array(
danielebarchiesi@0 92 '!permission-name' => l(t('Administer blocks'), 'admin/people/permissions', array('fragment' => 'module-block')),
danielebarchiesi@0 93 )),
danielebarchiesi@0 94 ),
danielebarchiesi@0 95 );
danielebarchiesi@0 96 }
danielebarchiesi@0 97
danielebarchiesi@0 98 /**
danielebarchiesi@0 99 * Implements hook_block_info_alter().
danielebarchiesi@0 100 */
danielebarchiesi@0 101 function dashboard_block_info_alter(&$blocks, $theme, $code_blocks) {
danielebarchiesi@0 102 $admin_theme = variable_get('admin_theme');
danielebarchiesi@0 103 if (($admin_theme && $theme == $admin_theme) || (!$admin_theme && $theme == variable_get('theme_default', 'bartik'))) {
danielebarchiesi@0 104 foreach ($blocks as $module => &$module_blocks) {
danielebarchiesi@0 105 foreach ($module_blocks as $delta => &$block) {
danielebarchiesi@0 106 // Make administrative blocks that are not already in use elsewhere
danielebarchiesi@0 107 // available for the dashboard.
danielebarchiesi@0 108 if (empty($block['status']) && (empty($block['region']) || $block['region'] == BLOCK_REGION_NONE) && !empty($code_blocks[$module][$delta]['properties']['administrative'])) {
danielebarchiesi@0 109 $block['status'] = 1;
danielebarchiesi@0 110 $block['region'] = 'dashboard_inactive';
danielebarchiesi@0 111 }
danielebarchiesi@0 112 }
danielebarchiesi@0 113 }
danielebarchiesi@0 114 }
danielebarchiesi@0 115 }
danielebarchiesi@0 116
danielebarchiesi@0 117 /**
danielebarchiesi@0 118 * Implements hook_block_list_alter().
danielebarchiesi@0 119 *
danielebarchiesi@0 120 * Skip rendering dashboard blocks when not on the dashboard page itself. This
danielebarchiesi@0 121 * prevents expensive dashboard blocks from causing performance issues on pages
danielebarchiesi@0 122 * where they will never be displayed.
danielebarchiesi@0 123 */
danielebarchiesi@0 124 function dashboard_block_list_alter(&$blocks) {
danielebarchiesi@0 125 if (!dashboard_is_visible()) {
danielebarchiesi@0 126 foreach ($blocks as $key => $block) {
danielebarchiesi@0 127 if (in_array($block->region, dashboard_regions())) {
danielebarchiesi@0 128 unset($blocks[$key]);
danielebarchiesi@0 129 }
danielebarchiesi@0 130 }
danielebarchiesi@0 131 }
danielebarchiesi@0 132 }
danielebarchiesi@0 133
danielebarchiesi@0 134 /**
danielebarchiesi@0 135 * Implements hook_page_build().
danielebarchiesi@0 136 *
danielebarchiesi@0 137 * Display dashboard blocks in the main content region.
danielebarchiesi@0 138 */
danielebarchiesi@0 139 function dashboard_page_build(&$page) {
danielebarchiesi@0 140 global $theme_key;
danielebarchiesi@0 141
danielebarchiesi@0 142 if (dashboard_is_visible()) {
danielebarchiesi@0 143 $block_info = array();
danielebarchiesi@0 144
danielebarchiesi@0 145 // Create a wrapper for the dashboard itself, then insert each dashboard
danielebarchiesi@0 146 // region into it.
danielebarchiesi@0 147 $page['content']['dashboard'] = array('#theme_wrappers' => array('dashboard'));
danielebarchiesi@0 148 foreach (dashboard_regions() as $region) {
danielebarchiesi@0 149 // Do not show dashboard blocks that are disabled.
danielebarchiesi@0 150 if ($region == 'dashboard_inactive') {
danielebarchiesi@0 151 continue;
danielebarchiesi@0 152 }
danielebarchiesi@0 153 // Insert regions even when they are empty, so that they will be
danielebarchiesi@0 154 // displayed when the dashboard is being configured.
danielebarchiesi@0 155 $page['content']['dashboard'][$region] = !empty($page[$region]) ? $page[$region] : array();
danielebarchiesi@0 156 $page['content']['dashboard'][$region]['#dashboard_region'] = $region;
danielebarchiesi@0 157 // Allow each dashboard region to be themed differently, or fall back on
danielebarchiesi@0 158 // the generic theme wrapper function for dashboard regions.
danielebarchiesi@0 159 $page['content']['dashboard'][$region]['#theme_wrappers'][] = array($region, 'dashboard_region');
danielebarchiesi@0 160 unset($page[$region]);
danielebarchiesi@0 161 $blocks_found = array();
danielebarchiesi@0 162 foreach ($page['content']['dashboard'][$region] as $item) {
danielebarchiesi@0 163 if (isset($item['#theme_wrappers']) && is_array($item['#theme_wrappers']) && in_array('block', $item['#theme_wrappers'])) {
danielebarchiesi@0 164 // If this item is a block, ensure it has a subject.
danielebarchiesi@0 165 if (empty($item['#block']->subject)) {
danielebarchiesi@0 166 // Locally cache info data for the object for all blocks, in case
danielebarchiesi@0 167 // we find a block similarly missing title from the same module.
danielebarchiesi@0 168 if (!isset($block_info[$item['#block']->module])) {
danielebarchiesi@0 169 $block_info[$item['#block']->module] = module_invoke($item['#block']->module, 'block_info');
danielebarchiesi@0 170 }
danielebarchiesi@0 171 $item['#block']->subject = $block_info[$item['#block']->module][$item['#block']->delta]['info'];
danielebarchiesi@0 172 }
danielebarchiesi@0 173 $blocks_found[$item['#block']->module . '_' . $item['#block']->delta] = TRUE;
danielebarchiesi@0 174 }
danielebarchiesi@0 175 }
danielebarchiesi@0 176
danielebarchiesi@0 177 // Find blocks which were not yet displayed on the page (were empty), and
danielebarchiesi@0 178 // add placeholder items in their place for rendering.
danielebarchiesi@0 179 $block_list = db_select('block')
danielebarchiesi@0 180 ->condition('theme', $theme_key)
danielebarchiesi@0 181 ->condition('status', 1)
danielebarchiesi@0 182 ->condition('region', $region)
danielebarchiesi@0 183 ->fields('block')
danielebarchiesi@0 184 ->execute();
danielebarchiesi@0 185 foreach ($block_list as $block) {
danielebarchiesi@0 186 if (!isset($blocks_found[$block->module . '_' . $block->delta])) {
danielebarchiesi@0 187 $block->enabled = $block->page_match = TRUE;
danielebarchiesi@0 188 $block->content = array('#markup' => '<div class="dashboard-block-empty">(empty)</div>');
danielebarchiesi@0 189 if (!isset($block_info[$block->module])) {
danielebarchiesi@0 190 $block_info[$block->module] = module_invoke($block->module, 'block_info');
danielebarchiesi@0 191 }
danielebarchiesi@0 192 $block->subject = t('@title', array('@title' => $block_info[$block->module][$block->delta]['info']));
danielebarchiesi@0 193 $block_render = array($block->module . '_' . $block->delta => $block);
danielebarchiesi@0 194 $build = _block_get_renderable_array($block_render);
danielebarchiesi@0 195 $page['content']['dashboard'][$block->region][] = $build;
danielebarchiesi@0 196 }
danielebarchiesi@0 197 }
danielebarchiesi@0 198 }
danielebarchiesi@0 199 }
danielebarchiesi@0 200 }
danielebarchiesi@0 201
danielebarchiesi@0 202 /**
danielebarchiesi@0 203 * Implements hook_system_info_alter().
danielebarchiesi@0 204 *
danielebarchiesi@0 205 * Add regions to each theme to store the dashboard blocks.
danielebarchiesi@0 206 */
danielebarchiesi@0 207 function dashboard_system_info_alter(&$info, $file, $type) {
danielebarchiesi@0 208 if ($type == 'theme') {
danielebarchiesi@0 209 // Add the dashboard regions (the "inactive" region should always appear
danielebarchiesi@0 210 // last in the list, for usability reasons).
danielebarchiesi@0 211 $dashboard_regions = dashboard_region_descriptions();
danielebarchiesi@0 212 if (isset($dashboard_regions['dashboard_inactive'])) {
danielebarchiesi@0 213 $inactive_region = $dashboard_regions['dashboard_inactive'];
danielebarchiesi@0 214 unset($dashboard_regions['dashboard_inactive']);
danielebarchiesi@0 215 $dashboard_regions['dashboard_inactive'] = $inactive_region;
danielebarchiesi@0 216 }
danielebarchiesi@0 217 $info['regions'] += $dashboard_regions;
danielebarchiesi@0 218 // Indicate that these regions are intended to be displayed whenever the
danielebarchiesi@0 219 // dashboard is displayed in an overlay. This information is provided for
danielebarchiesi@0 220 // any module that might need to use it, not just the core Overlay module.
danielebarchiesi@0 221 $info['overlay_regions'] = !empty($info['overlay_regions']) ? array_merge($info['overlay_regions'], dashboard_regions()) : dashboard_regions();
danielebarchiesi@0 222 }
danielebarchiesi@0 223 }
danielebarchiesi@0 224
danielebarchiesi@0 225 /**
danielebarchiesi@0 226 * Implements hook_theme().
danielebarchiesi@0 227 */
danielebarchiesi@0 228 function dashboard_theme() {
danielebarchiesi@0 229 return array(
danielebarchiesi@0 230 'dashboard' => array(
danielebarchiesi@0 231 'render element' => 'element',
danielebarchiesi@0 232 ),
danielebarchiesi@0 233 'dashboard_admin' => array(
danielebarchiesi@0 234 'render element' => 'element',
danielebarchiesi@0 235 ),
danielebarchiesi@0 236 'dashboard_region' => array(
danielebarchiesi@0 237 'render element' => 'element',
danielebarchiesi@0 238 ),
danielebarchiesi@0 239 'dashboard_disabled_blocks' => array(
danielebarchiesi@0 240 'variables' => array('blocks' => NULL),
danielebarchiesi@0 241 ),
danielebarchiesi@0 242 'dashboard_disabled_block' => array(
danielebarchiesi@0 243 'variables' => array('block' => NULL),
danielebarchiesi@0 244 ),
danielebarchiesi@0 245 'dashboard_admin_display_form' => array(
danielebarchiesi@0 246 // When building the form for configuring dashboard blocks, reuse the
danielebarchiesi@0 247 // Block module's template for the main block configuration form.
danielebarchiesi@0 248 'template' => 'block-admin-display-form',
danielebarchiesi@0 249 'path' => drupal_get_path('module', 'block'),
danielebarchiesi@0 250 'file' => 'block.admin.inc',
danielebarchiesi@0 251 'render element' => 'form',
danielebarchiesi@0 252 ),
danielebarchiesi@0 253 );
danielebarchiesi@0 254 }
danielebarchiesi@0 255
danielebarchiesi@0 256 /**
danielebarchiesi@0 257 * Implements hook_forms().
danielebarchiesi@0 258 */
danielebarchiesi@0 259 function dashboard_forms() {
danielebarchiesi@0 260 // Reroute the dashboard configuration form to the main blocks administration
danielebarchiesi@0 261 // form. This allows us to distinguish them by form ID in hook_form_alter().
danielebarchiesi@0 262 $forms['dashboard_admin_display_form'] = array(
danielebarchiesi@0 263 'callback' => 'block_admin_display_form',
danielebarchiesi@0 264 );
danielebarchiesi@0 265
danielebarchiesi@0 266 return $forms;
danielebarchiesi@0 267 }
danielebarchiesi@0 268
danielebarchiesi@0 269 /**
danielebarchiesi@0 270 * Page callback: Displays the dashboard.
danielebarchiesi@0 271 *
danielebarchiesi@0 272 * @param $launch_customize
danielebarchiesi@0 273 * Whether to launch in customization mode right away. TRUE or FALSE.
danielebarchiesi@0 274 */
danielebarchiesi@0 275 function dashboard_admin($launch_customize = FALSE) {
danielebarchiesi@0 276 $js_settings = array(
danielebarchiesi@0 277 'dashboard' => array(
danielebarchiesi@0 278 'drawer' => url('admin/dashboard/drawer'),
danielebarchiesi@0 279 'blockContent' => url('admin/dashboard/block-content'),
danielebarchiesi@0 280 'updatePath' => url('admin/dashboard/update'),
danielebarchiesi@0 281 'formToken' => drupal_get_token('dashboard-update'),
danielebarchiesi@0 282 'launchCustomize' => $launch_customize,
danielebarchiesi@0 283 'dashboard' => url('admin/dashboard'),
danielebarchiesi@0 284 'emptyBlockText' => t('(empty)'),
danielebarchiesi@0 285 'emptyRegionTextInactive' => t('This dashboard region is empty. Click <em>Customize dashboard</em> to add blocks to it.'),
danielebarchiesi@0 286 'emptyRegionTextActive' => t('DRAG HERE'),
danielebarchiesi@0 287 ),
danielebarchiesi@0 288 );
danielebarchiesi@0 289 $build = array(
danielebarchiesi@0 290 '#theme' => 'dashboard_admin',
danielebarchiesi@0 291 '#message' => t('To customize the dashboard page, move blocks to the dashboard regions on the <a href="@dashboard">Dashboard administration page</a>, or enable JavaScript on this page to use the drag-and-drop interface.', array('@dashboard' => url('admin/dashboard/configure'))),
danielebarchiesi@0 292 '#access' => user_access('administer blocks'),
danielebarchiesi@0 293 '#attached' => array(
danielebarchiesi@0 294 'js' => array(
danielebarchiesi@0 295 drupal_get_path('module', 'dashboard') . '/dashboard.js',
danielebarchiesi@0 296 array('data' => $js_settings, 'type' => 'setting'),
danielebarchiesi@0 297 ),
danielebarchiesi@0 298 'library' => array(array('system', 'ui.sortable')),
danielebarchiesi@0 299 ),
danielebarchiesi@0 300 );
danielebarchiesi@0 301 return $build;
danielebarchiesi@0 302 }
danielebarchiesi@0 303
danielebarchiesi@0 304 /**
danielebarchiesi@0 305 * Page callback: Builds the page for administering dashboard blocks.
danielebarchiesi@0 306 *
danielebarchiesi@0 307 * This page reuses the Block module's administration form but limits editing
danielebarchiesi@0 308 * to blocks that are available to appear on the dashboard.
danielebarchiesi@0 309 *
danielebarchiesi@0 310 * @see block_admin_display()
danielebarchiesi@0 311 * @see block_admin_display_form()
danielebarchiesi@0 312 * @see dashboard_form_dashboard_admin_display_form_alter()
danielebarchiesi@0 313 * @see template_preprocess_dashboard_admin_display_form()
danielebarchiesi@0 314 */
danielebarchiesi@0 315 function dashboard_admin_blocks() {
danielebarchiesi@0 316 global $theme_key;
danielebarchiesi@0 317 drupal_theme_initialize();
danielebarchiesi@0 318 module_load_include('inc', 'block', 'block.admin');
danielebarchiesi@0 319
danielebarchiesi@0 320 // Prepare the blocks for the current theme, and remove those that are
danielebarchiesi@0 321 // currently displayed in non-dashboard regions.
danielebarchiesi@0 322 // @todo This assumes the current page is being displayed using the same
danielebarchiesi@0 323 // theme that the dashboard is displayed in.
danielebarchiesi@0 324 $blocks = block_admin_display_prepare_blocks($theme_key);
danielebarchiesi@0 325 $dashboard_regions = dashboard_region_descriptions();
danielebarchiesi@0 326 $regions_to_remove = array_diff_key(system_region_list($theme_key, REGIONS_VISIBLE), $dashboard_regions);
danielebarchiesi@0 327 foreach ($blocks as $id => $block) {
danielebarchiesi@0 328 if (isset($regions_to_remove[$block['region']])) {
danielebarchiesi@0 329 unset($blocks[$id]);
danielebarchiesi@0 330 }
danielebarchiesi@0 331 }
danielebarchiesi@0 332
danielebarchiesi@0 333 // Pass in the above blocks and dashboard regions to the form, so that only
danielebarchiesi@0 334 // dashboard-related regions will be displayed.
danielebarchiesi@0 335 return drupal_get_form('dashboard_admin_display_form', $blocks, $theme_key, $dashboard_regions);
danielebarchiesi@0 336 }
danielebarchiesi@0 337
danielebarchiesi@0 338 /**
danielebarchiesi@0 339 * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0 340 */
danielebarchiesi@0 341 function dashboard_form_block_admin_display_form_alter(&$form, &$form_state, $form_id) {
danielebarchiesi@0 342 // Hide dashboard regions (and any blocks placed within them) from the block
danielebarchiesi@0 343 // administration form and from the options list on that form. This
danielebarchiesi@0 344 // function is called for both the dashboard block configuration form and the
danielebarchiesi@0 345 // standard block configuration form so that both forms can share the same
danielebarchiesi@0 346 // constructor. As a result the form_id must be checked.
danielebarchiesi@0 347 if ($form_id != 'dashboard_admin_display_form') {
danielebarchiesi@0 348 $dashboard_regions = dashboard_region_descriptions();
danielebarchiesi@0 349 $form['block_regions']['#value'] = array_diff_key($form['block_regions']['#value'], $dashboard_regions);
danielebarchiesi@0 350 foreach (element_children($form['blocks']) as $i) {
danielebarchiesi@0 351 $block = &$form['blocks'][$i];
danielebarchiesi@0 352 if (isset($block['region']['#default_value']) && isset($dashboard_regions[$block['region']['#default_value']]) && $block['region']['#default_value'] != 'dashboard_inactive') {
danielebarchiesi@0 353 $block['#access'] = FALSE;
danielebarchiesi@0 354 }
danielebarchiesi@0 355 elseif (isset($block['region']['#options'])) {
danielebarchiesi@0 356 $block['region']['#options'] = array_diff_key($block['region']['#options'], $dashboard_regions);
danielebarchiesi@0 357 }
danielebarchiesi@0 358 // Show inactive dashboard blocks as disabled on the main block
danielebarchiesi@0 359 // administration form, so that they are available to place in other
danielebarchiesi@0 360 // regions of the theme. Note that when the form is submitted, any such
danielebarchiesi@0 361 // blocks which still remain disabled will immediately be put back in the
danielebarchiesi@0 362 // 'dashboard_inactive' region, because dashboard_block_info_alter() is
danielebarchiesi@0 363 // called when the blocks are rehashed. Fortunately, this is the exact
danielebarchiesi@0 364 // behavior we want.
danielebarchiesi@0 365 if ($block['region']['#default_value'] == 'dashboard_inactive') {
danielebarchiesi@0 366 // @todo These do not wind up in correct alphabetical order.
danielebarchiesi@0 367 $block['region']['#default_value'] = NULL;
danielebarchiesi@0 368 }
danielebarchiesi@0 369 }
danielebarchiesi@0 370 }
danielebarchiesi@0 371 }
danielebarchiesi@0 372
danielebarchiesi@0 373 /**
danielebarchiesi@0 374 * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0 375 */
danielebarchiesi@0 376 function dashboard_form_dashboard_admin_display_form_alter(&$form, &$form_state) {
danielebarchiesi@0 377 // Redirect the 'configure' and 'delete' links on each block back to the
danielebarchiesi@0 378 // dashboard blocks administration page.
danielebarchiesi@0 379 foreach ($form['blocks'] as &$block) {
danielebarchiesi@0 380 if (isset($block['configure']['#href'])) {
danielebarchiesi@0 381 $block['configure']['#options']['query']['destination'] = 'admin/dashboard/configure';
danielebarchiesi@0 382 }
danielebarchiesi@0 383 if (isset($block['delete']['#href'])) {
danielebarchiesi@0 384 $block['delete']['#options']['query']['destination'] = 'admin/dashboard/configure';
danielebarchiesi@0 385 }
danielebarchiesi@0 386 }
danielebarchiesi@0 387 }
danielebarchiesi@0 388
danielebarchiesi@0 389 /**
danielebarchiesi@0 390 * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0 391 */
danielebarchiesi@0 392 function dashboard_form_block_admin_configure_alter(&$form, &$form_state) {
danielebarchiesi@0 393 global $theme_key;
danielebarchiesi@0 394 drupal_theme_initialize();
danielebarchiesi@0 395 // Hide the dashboard regions from the region select list on the block
danielebarchiesi@0 396 // configuration form, for all themes except the current theme (since the
danielebarchiesi@0 397 // other themes do not display the dashboard).
danielebarchiesi@0 398 // @todo This assumes the current page is being displayed using the same
danielebarchiesi@0 399 // theme that the dashboard is displayed in.
danielebarchiesi@0 400 $dashboard_regions = dashboard_region_descriptions();
danielebarchiesi@0 401 foreach (element_children($form['regions']) as $region_name) {
danielebarchiesi@0 402 $region = &$form['regions'][$region_name];
danielebarchiesi@0 403 if ($region_name != $theme_key && isset($region['#options'])) {
danielebarchiesi@0 404 $region['#options'] = array_diff_key($region['#options'], $dashboard_regions);
danielebarchiesi@0 405 }
danielebarchiesi@0 406 }
danielebarchiesi@0 407 }
danielebarchiesi@0 408
danielebarchiesi@0 409 /**
danielebarchiesi@0 410 * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0 411 */
danielebarchiesi@0 412 function dashboard_form_block_add_block_form_alter(&$form, &$form_state) {
danielebarchiesi@0 413 dashboard_form_block_admin_configure_alter($form, $form_state);
danielebarchiesi@0 414 }
danielebarchiesi@0 415
danielebarchiesi@0 416 /**
danielebarchiesi@0 417 * Preprocesses variables for block-admin-display-form.tpl.php.
danielebarchiesi@0 418 */
danielebarchiesi@0 419 function template_preprocess_dashboard_admin_display_form(&$variables) {
danielebarchiesi@0 420 template_preprocess_block_admin_display_form($variables);
danielebarchiesi@0 421 if (isset($variables['block_regions'][BLOCK_REGION_NONE])) {
danielebarchiesi@0 422 $variables['block_regions'][BLOCK_REGION_NONE] = t('Other blocks');
danielebarchiesi@0 423 }
danielebarchiesi@0 424 }
danielebarchiesi@0 425
danielebarchiesi@0 426 /**
danielebarchiesi@0 427 * Determines if the dashboard should be displayed on the current page.
danielebarchiesi@0 428 *
danielebarchiesi@0 429 * This function checks if the user is currently viewing the dashboard and has
danielebarchiesi@0 430 * access to see it. It is used by other functions in the dashboard module to
danielebarchiesi@0 431 * decide whether or not the dashboard content should be displayed to the
danielebarchiesi@0 432 * current user.
danielebarchiesi@0 433 *
danielebarchiesi@0 434 * Although the menu system normally handles the above tasks, it only does so
danielebarchiesi@0 435 * for the main page content. However, the dashboard is not part of the main
danielebarchiesi@0 436 * page content, but rather is displayed in special regions of the page (so it
danielebarchiesi@0 437 * can interface with the Block module's method of managing page regions). We
danielebarchiesi@0 438 * therefore need to maintain this separate function to check the menu item for
danielebarchiesi@0 439 * us.
danielebarchiesi@0 440 *
danielebarchiesi@0 441 * @return
danielebarchiesi@0 442 * TRUE if the dashboard should be visible on the current page, FALSE
danielebarchiesi@0 443 * otherwise.
danielebarchiesi@0 444 *
danielebarchiesi@0 445 * @see dashboard_block_list_alter()
danielebarchiesi@0 446 * @see dashboard_page_build()
danielebarchiesi@0 447 */
danielebarchiesi@0 448 function dashboard_is_visible() {
danielebarchiesi@0 449 static $is_visible;
danielebarchiesi@0 450 if (!isset($is_visible)) {
danielebarchiesi@0 451 // If the current menu item represents the page on which we want to display
danielebarchiesi@0 452 // the dashboard, and if the current user has access to see it, return
danielebarchiesi@0 453 // TRUE.
danielebarchiesi@0 454 $menu_item = menu_get_item();
danielebarchiesi@0 455 $is_visible = isset($menu_item['page_callback']) && $menu_item['page_callback'] == 'dashboard_admin' && !empty($menu_item['access']);
danielebarchiesi@0 456 }
danielebarchiesi@0 457 return $is_visible;
danielebarchiesi@0 458 }
danielebarchiesi@0 459
danielebarchiesi@0 460 /**
danielebarchiesi@0 461 * Returns an array of dashboard region descriptions, keyed by region name.
danielebarchiesi@0 462 */
danielebarchiesi@0 463 function dashboard_region_descriptions() {
danielebarchiesi@0 464 $regions = module_invoke_all('dashboard_regions');
danielebarchiesi@0 465 drupal_alter('dashboard_regions', $regions);
danielebarchiesi@0 466 return $regions;
danielebarchiesi@0 467 }
danielebarchiesi@0 468
danielebarchiesi@0 469 /**
danielebarchiesi@0 470 * Returns an array of dashboard region names.
danielebarchiesi@0 471 */
danielebarchiesi@0 472 function dashboard_regions() {
danielebarchiesi@0 473 $regions = &drupal_static(__FUNCTION__);
danielebarchiesi@0 474 if (!isset($regions)) {
danielebarchiesi@0 475 $regions = array_keys(dashboard_region_descriptions());
danielebarchiesi@0 476 }
danielebarchiesi@0 477 return $regions;
danielebarchiesi@0 478 }
danielebarchiesi@0 479
danielebarchiesi@0 480 /**
danielebarchiesi@0 481 * Implements hook_dashboard_regions().
danielebarchiesi@0 482 */
danielebarchiesi@0 483 function dashboard_dashboard_regions() {
danielebarchiesi@0 484 return array(
danielebarchiesi@0 485 'dashboard_main' => 'Dashboard (main)',
danielebarchiesi@0 486 'dashboard_sidebar' => 'Dashboard (sidebar)',
danielebarchiesi@0 487 'dashboard_inactive' => 'Dashboard (inactive)',
danielebarchiesi@0 488 );
danielebarchiesi@0 489 }
danielebarchiesi@0 490
danielebarchiesi@0 491 /**
danielebarchiesi@0 492 * Ajax callback: Shows disabled blocks in the dashboard customization mode.
danielebarchiesi@0 493 */
danielebarchiesi@0 494 function dashboard_show_disabled() {
danielebarchiesi@0 495 global $theme_key;
danielebarchiesi@0 496
danielebarchiesi@0 497 // Blocks are not necessarily initialized at this point.
danielebarchiesi@0 498 $blocks = _block_rehash();
danielebarchiesi@0 499
danielebarchiesi@0 500 // Limit the list to blocks that are marked as disabled for the dashboard.
danielebarchiesi@0 501 foreach ($blocks as $key => $block) {
danielebarchiesi@0 502 if ($block['theme'] != $theme_key || $block['region'] != 'dashboard_inactive') {
danielebarchiesi@0 503 unset($blocks[$key]);
danielebarchiesi@0 504 }
danielebarchiesi@0 505 }
danielebarchiesi@0 506
danielebarchiesi@0 507 // Theme the output and end the page request.
danielebarchiesi@0 508 print theme('dashboard_disabled_blocks', array('blocks' => $blocks));
danielebarchiesi@0 509 drupal_exit();
danielebarchiesi@0 510 }
danielebarchiesi@0 511
danielebarchiesi@0 512 /**
danielebarchiesi@0 513 * Ajax callback: Displays the rendered contents of a specific block.
danielebarchiesi@0 514 *
danielebarchiesi@0 515 * @param $module
danielebarchiesi@0 516 * The block's module name.
danielebarchiesi@0 517 * @param $delta
danielebarchiesi@0 518 * The block's delta.
danielebarchiesi@0 519 */
danielebarchiesi@0 520 function dashboard_show_block_content($module, $delta) {
danielebarchiesi@0 521 drupal_theme_initialize();
danielebarchiesi@0 522 global $theme_key;
danielebarchiesi@0 523
danielebarchiesi@0 524 $blocks = array();
danielebarchiesi@0 525 $block_object = db_query("SELECT * FROM {block} WHERE theme = :theme AND module = :module AND delta = :delta", array(
danielebarchiesi@0 526 ":theme" => $theme_key,
danielebarchiesi@0 527 ":module" => $module,
danielebarchiesi@0 528 ":delta" => $delta,
danielebarchiesi@0 529 ))
danielebarchiesi@0 530 ->fetchObject();
danielebarchiesi@0 531 $block_object->enabled = $block_object->page_match = TRUE;
danielebarchiesi@0 532 $blocks[$module . "_" . $delta] = $block_object;
danielebarchiesi@0 533 $block_content = _block_render_blocks($blocks);
danielebarchiesi@0 534 $build = _block_get_renderable_array($block_content);
danielebarchiesi@0 535 $rendered_block = drupal_render($build);
danielebarchiesi@0 536 print $rendered_block;
danielebarchiesi@0 537 drupal_exit();
danielebarchiesi@0 538 }
danielebarchiesi@0 539
danielebarchiesi@0 540 /**
danielebarchiesi@0 541 * Sets the new weight of each region according to the drag-and-drop order.
danielebarchiesi@0 542 */
danielebarchiesi@0 543 function dashboard_update() {
danielebarchiesi@0 544 drupal_theme_initialize();
danielebarchiesi@0 545 global $theme_key;
danielebarchiesi@0 546 // Check the form token to make sure we have a valid request.
danielebarchiesi@0 547 if (!empty($_REQUEST['form_token']) && drupal_valid_token($_REQUEST['form_token'], 'dashboard-update')) {
danielebarchiesi@0 548 parse_str($_REQUEST['regions'], $regions);
danielebarchiesi@0 549 foreach ($regions as $region_name => $blocks) {
danielebarchiesi@0 550 if ($region_name == 'disabled_blocks') {
danielebarchiesi@0 551 $region_name = 'dashboard_inactive';
danielebarchiesi@0 552 }
danielebarchiesi@0 553 foreach ($blocks as $weight => $block_string) {
danielebarchiesi@0 554 // Parse the query string to determine the block's module and delta.
danielebarchiesi@0 555 preg_match('/block-([^-]+)-(.+)/', $block_string, $matches);
danielebarchiesi@0 556 $block = new stdClass();
danielebarchiesi@0 557 $block->module = $matches[1];
danielebarchiesi@0 558 $block->delta = $matches[2];
danielebarchiesi@0 559
danielebarchiesi@0 560 $block->region = $region_name;
danielebarchiesi@0 561 $block->weight = $weight;
danielebarchiesi@0 562 $block->status = 1;
danielebarchiesi@0 563
danielebarchiesi@0 564 db_merge('block')
danielebarchiesi@0 565 ->key(array(
danielebarchiesi@0 566 'module' => $block->module,
danielebarchiesi@0 567 'delta' => $block->delta,
danielebarchiesi@0 568 'theme' => $theme_key,
danielebarchiesi@0 569 ))
danielebarchiesi@0 570 ->fields(array(
danielebarchiesi@0 571 'status' => $block->status,
danielebarchiesi@0 572 'weight' => $block->weight,
danielebarchiesi@0 573 'region' => $block->region,
danielebarchiesi@0 574 'pages' => '',
danielebarchiesi@0 575 ))
danielebarchiesi@0 576 ->execute();
danielebarchiesi@0 577 }
danielebarchiesi@0 578 }
danielebarchiesi@0 579 drupal_set_message(t('The configuration options have been saved.'), 'status', FALSE);
danielebarchiesi@0 580 }
danielebarchiesi@0 581 drupal_exit();
danielebarchiesi@0 582 }
danielebarchiesi@0 583
danielebarchiesi@0 584 /**
danielebarchiesi@0 585 * Returns HTML for the entire dashboard.
danielebarchiesi@0 586 *
danielebarchiesi@0 587 * @param $variables
danielebarchiesi@0 588 * An associative array containing:
danielebarchiesi@0 589 * - element: A render element containing the properties of the dashboard
danielebarchiesi@0 590 * region element, #dashboard_region and #children.
danielebarchiesi@0 591 *
danielebarchiesi@0 592 * @ingroup themeable
danielebarchiesi@0 593 */
danielebarchiesi@0 594 function theme_dashboard($variables) {
danielebarchiesi@0 595 extract($variables);
danielebarchiesi@0 596 drupal_add_css(drupal_get_path('module', 'dashboard') . '/dashboard.css');
danielebarchiesi@0 597 return '<div id="dashboard" class="clearfix">' . $element['#children'] . '</div>';
danielebarchiesi@0 598 }
danielebarchiesi@0 599
danielebarchiesi@0 600 /**
danielebarchiesi@0 601 * Returns HTML for the non-customizable part of the dashboard page.
danielebarchiesi@0 602 *
danielebarchiesi@0 603 * @param $variables
danielebarchiesi@0 604 * An associative array containing:
danielebarchiesi@0 605 * - element: A render element containing a #message.
danielebarchiesi@0 606 *
danielebarchiesi@0 607 * @ingroup themeable
danielebarchiesi@0 608 */
danielebarchiesi@0 609 function theme_dashboard_admin($variables) {
danielebarchiesi@0 610 // We only return a simple help message, since the actual content of the page
danielebarchiesi@0 611 // will be populated via the dashboard regions in dashboard_page_build().
danielebarchiesi@0 612 return '<div class="customize-dashboard js-hide">' . $variables['element']['#message'] . '</div>';
danielebarchiesi@0 613 }
danielebarchiesi@0 614
danielebarchiesi@0 615 /**
danielebarchiesi@0 616 * Returns HTML for a generic dashboard region.
danielebarchiesi@0 617 *
danielebarchiesi@0 618 * @param $variables
danielebarchiesi@0 619 * An associative array containing:
danielebarchiesi@0 620 * - element: A render element containing the properties of the dashboard
danielebarchiesi@0 621 * region element, #dashboard_region and #children.
danielebarchiesi@0 622 *
danielebarchiesi@0 623 * @ingroup themeable
danielebarchiesi@0 624 */
danielebarchiesi@0 625 function theme_dashboard_region($variables) {
danielebarchiesi@0 626 extract($variables);
danielebarchiesi@0 627 $output = '<div id="' . $element['#dashboard_region'] . '" class="dashboard-region">';
danielebarchiesi@0 628 $output .= '<div class="region clearfix">';
danielebarchiesi@0 629 $output .= $element['#children'];
danielebarchiesi@0 630 // Closing div.region
danielebarchiesi@0 631 $output .= '</div>';
danielebarchiesi@0 632 // Closing div.dashboard-region
danielebarchiesi@0 633 $output .= '</div>';
danielebarchiesi@0 634 return $output;
danielebarchiesi@0 635 }
danielebarchiesi@0 636
danielebarchiesi@0 637 /**
danielebarchiesi@0 638 * Returns HTML for disabled blocks, for use in dashboard customization mode.
danielebarchiesi@0 639 *
danielebarchiesi@0 640 * @param $variables
danielebarchiesi@0 641 * An associative array containing:
danielebarchiesi@0 642 * - blocks: An array of block objects from _block_rehash().
danielebarchiesi@0 643 *
danielebarchiesi@0 644 * @ingroup themeable
danielebarchiesi@0 645 */
danielebarchiesi@0 646 function theme_dashboard_disabled_blocks($variables) {
danielebarchiesi@0 647 extract($variables);
danielebarchiesi@0 648 $output = '<div class="canvas-content"><p>' . t('Drag and drop these blocks to the columns below. Changes are automatically saved. More options are available on the <a href="@dashboard-url">configuration page</a>.', array('@dashboard-url' => url('admin/dashboard/configure'))) . '</p>';
danielebarchiesi@0 649 $output .= '<div id="disabled-blocks"><div class="region disabled-blocks clearfix">';
danielebarchiesi@0 650 foreach ($blocks as $block) {
danielebarchiesi@0 651 $output .= theme('dashboard_disabled_block', array('block' => $block));
danielebarchiesi@0 652 }
danielebarchiesi@0 653 $output .= '<div class="clearfix"></div>';
danielebarchiesi@0 654 $output .= '<p class="dashboard-add-other-blocks">' . l(t('Add other blocks'), 'admin/dashboard/configure') . '</p>';
danielebarchiesi@0 655 $output .= '</div></div></div>';
danielebarchiesi@0 656 return $output;
danielebarchiesi@0 657 }
danielebarchiesi@0 658
danielebarchiesi@0 659 /**
danielebarchiesi@0 660 * Returns HTML for disabled blocks, for use in dashboard customization mode.
danielebarchiesi@0 661 *
danielebarchiesi@0 662 * @param $variables
danielebarchiesi@0 663 * An associative array containing:
danielebarchiesi@0 664 * - block: A block object from _block_rehash().
danielebarchiesi@0 665 *
danielebarchiesi@0 666 * @ingroup themeable
danielebarchiesi@0 667 */
danielebarchiesi@0 668 function theme_dashboard_disabled_block($variables) {
danielebarchiesi@0 669 extract($variables);
danielebarchiesi@0 670 $output = "";
danielebarchiesi@0 671 if (isset($block)) {
danielebarchiesi@0 672 $output .= '<div id="block-' . $block['module'] . '-' . $block['delta']
danielebarchiesi@0 673 . '" class="disabled-block block block-' . $block['module'] . '-' . $block['delta']
danielebarchiesi@0 674 . ' module-' . $block['module'] . ' delta-' . $block['delta'] . '">'
danielebarchiesi@0 675 . '<h2>' . (!empty($block['title']) && $block['title'] != '<none>' ? check_plain($block['title']) : check_plain($block['info'])) . '</h2>'
danielebarchiesi@0 676 . '<div class="content"></div>'
danielebarchiesi@0 677 . '</div>';
danielebarchiesi@0 678 }
danielebarchiesi@0 679 return $output;
danielebarchiesi@0 680 }
danielebarchiesi@0 681