diff --git install.php install.php index 8a3daa9..8287634 100644 --- install.php +++ install.php @@ -1423,6 +1423,14 @@ function install_finished(&$install_state) { $output .= '

' . st('For more information on configuring Drupal, please refer to the help section.', array('@help' => url('admin/help'))) . '

'; } + // Rebuild the module and theme data, in case any newly-installed modules + // need to modify it via hook_system_info_alter(). We need to clear the + // theme static cache first, to make sure that the theme data is actually + // rebuilt. + drupal_static_reset('_system_get_theme_data'); + system_get_module_data(); + system_get_theme_data(); + // Rebuild menu and registry to get content type links registered by the // profile, and possibly any other menu items created through the tasks. menu_rebuild(); diff --git modules/block/block.module modules/block/block.module index d2287f4..6e4a0b0 100644 --- modules/block/block.module +++ modules/block/block.module @@ -224,20 +224,34 @@ function block_page_build(&$page) { * The requested region. */ function block_get_blocks_by_region($region) { - $weight = 0; $build = array(); if ($list = block_list($region)) { - foreach ($list as $key => $block) { - $build[$key] = $block->content; - unset($block->content); - $build[$key] += array( - '#block' => $block, - '#weight' => ++$weight, - ); - $build[$key]['#theme_wrappers'][] ='block'; - } - $build['#sorted'] = TRUE; + $build = _block_get_renderable_array($list); + } + return $build; +} + +/** + * Get an array of blocks suitable for drupal_render(). + * + * @param $list + * A list of blocks such as that returned by block_list(). + * @return + * A renderable array. + */ +function _block_get_renderable_array($list = array()) { + $weight = 0; + $build = array(); + foreach ($list as $key => $block) { + $build[$key] = $block->content; + unset($block->content); + $build[$key] += array( + '#block' => $block, + '#weight' => ++$weight, + ); + $build[$key]['#theme_wrappers'][] ='block'; } + $build['#sorted'] = TRUE; return $build; } diff --git modules/dashboard/dashboard.css modules/dashboard/dashboard.css new file mode 100644 index 0000000..f6981a5 --- /dev/null +++ modules/dashboard/dashboard.css @@ -0,0 +1,76 @@ +/* $Id$ */ + +div#page { + padding-top: 20px; +} + +#dashboard div.dashboard-region { + float: left; + min-height: 1px; + margin: 5px; +} + +#dashboard div#dashboard_main { + width: 65%; +} + +#dashboard div#dashboard_sidebar { + width: 30%; +} + +#dashboard div.block { + border: 1px solid #e2e1dc; + margin-bottom: 20px; +} + +#dashboard div.block h2 { + background-color:#e2e1dc; + padding: 3px 5px; +} + +#dashboard div.block div.content { + padding: 10px 5px 5px 5px; +} + +#dashboard div.block div.content ul.menu { + margin-left:20px; +} + +body.page-admin-dashboard.one-sidebar div#content div.block { + margin-right:20px; +} + +#dashboard #disabled-blocks { + margin: 5px; +} + +#dashboard #disabled-blocks .block { + background: #e2e1dc; + padding: 4px; + margin: 3px; + display: inline; + -moz-border-radius: 4px; +} + +#dashboard .ui-sortable { + border: 3px dashed #ccc; + padding: 10px; +} + +#dashboard div.dragging { + width: 30% !important; +} + +#dashboard #disabled-blocks h2 { + display: inline; + font-weight: normal; + white-space: nowrap; +} + +#dashboard #disabled-blocks .block .content { + display: none; +} + +#dashboard .ui-sortable .block { + cursor: move; +} diff --git modules/dashboard/dashboard.info modules/dashboard/dashboard.info new file mode 100644 index 0000000..8aecfec --- /dev/null +++ modules/dashboard/dashboard.info @@ -0,0 +1,9 @@ +; $Id$ +name = Dashboard +description = A module that provides a dashboard interface for organizing and tracking various information within your site. +core = 7.x +package = Core +version = VERSION +files[] = dashboard.info +files[] = dashboard.module +dependencies[] = block diff --git modules/dashboard/dashboard.js modules/dashboard/dashboard.js new file mode 100644 index 0000000..02c93d1 --- /dev/null +++ modules/dashboard/dashboard.js @@ -0,0 +1,105 @@ +// $Id: toolbar.js,v 1.1 2009/07/04 05:37:30 dries Exp $ +(function ($) { + +/** + * Implementation of Drupal.behaviors for dashboard. + */ +Drupal.behaviors.dashboard = { + attach: function () { + $('#dashboard').prepend('
'); + $('#dashboard .customize input').click(Drupal.behaviors.dashboard.enterCustomizeMode); + }, + + /** + * Enter "customize" mode by displaying disabled blocks. + */ + enterCustomizeMode: function () { + $('#dashboard .customize input').unbind("click").click(Drupal.behaviors.dashboard.exitCustomizeMode).attr('value', Drupal.t('Return to regular dashboard view')); + $('div.customize .canvas').load(Drupal.settings.dashboard.customize, Drupal.behaviors.dashboard.makeDraggable); + }, + + /** + * Exit "customize" mode by simply forcing a page refresh. + */ + exitCustomizeMode: function () { + location.reload(); + }, + + /** + * Helper function for enterCustomizeMode; sets up drag-and-drop. + */ + makeDraggable: function () { + // Initialize drag-and-drop. + var regions = $('div.region'); + regions.sortable({ + connectWith: regions, + cursor: 'move', + dropOnEmpty: true, + items: '>div.block, div.disabled-block', + opacity: 0.8, + update: Drupal.behaviors.dashboard.update + }); + }, + + /** + * Send block order to the server, and expand previously disabled blocks. + * + * This function is called on the jQuery UI Sortable "update" event. + * + * @param event + * The event that triggered this callback. + * @param ui + * An object containing information about the item that was just dropped. + */ + update: function (event, ui) { + var item = $(ui.item); + + // If the user dragged a disabled block, load the block contents. + if (item.hasClass('disabled-block')) { + var module, delta, itemClass; + itemClass = item.attr('class'); + // Determine the block module and delta. + module = itemClass.match(/\bmodule-(\S+)\b/)[1]; + delta = itemClass.match(/\bdelta-(\S+)\b/)[1]; + + // Load the newly enabled block's content. + $.get(Drupal.settings.dashboard.blockContent + '/' + module + '/' + delta, {}, + function (block) { + var blockContent = $("div.content", $(block)); + $("div.content", item).after(blockContent).remove(); + }, + 'html' + ); + // Remove the "disabled-block" class, so we don't reload its content the + // next time it's dragged. + item.removeClass("disabled-block"); + } + + // Let the server know what the new block order is. + $.post(Drupal.settings.dashboard.updatePath, { + 'form_token': Drupal.settings.dashboard.formToken, + 'regions': Drupal.behaviors.dashboard.getOrder + } + ); + }, + + /** + * Return the current order of the blocks in each of the sortable regions, + * in query string format. + */ + getOrder: function () { + var order = []; + $('div.region').each(function () { + var region = $(this).parent().attr('id').replace(/-/g, '_'); + var blocks = $(this).sortable('toArray'); + var i; + for (i = 0; i < blocks.length; i++) { + order.push(region + '[]=' + blocks[i]); + } + }); + order = order.join('&'); + return order; + } +}; + +})(jQuery); diff --git modules/dashboard/dashboard.module modules/dashboard/dashboard.module new file mode 100644 index 0000000..3de7909 --- /dev/null +++ modules/dashboard/dashboard.module @@ -0,0 +1,309 @@ + 'Dashboard', + 'page callback' => 'dashboard_admin', + 'access arguments' => array('access dashboard'), + 'type' => MENU_CALLBACK, + ); + $items['admin/dashboard/customize'] = array( + 'page callback' => 'dashboard_show_disabled', + 'access arguments' => array('administer blocks'), + 'type' => MENU_CALLBACK, + ); + $items['admin/dashboard/block-content'] = array( + 'page callback' => 'dashboard_show_block_content', + 'page arguments' => array(3, 4), + 'access arguments' => array('administer blocks'), + 'type' => MENU_CALLBACK, + ); + $items['admin/dashboard/update'] = array( + 'page callback' => 'dashboard_update', + 'access arguments' => array('administer blocks'), + 'type' => MENU_CALLBACK, + ); + return $items; +} + +/** + * Implement hook_block_info_alter(). + * + * Skip rendering dashboard blocks when not on the dashboard page itself. This + * prevents expensive dashboard blocks from causing performance issues on pages + * where they will never be displayed. + */ +function dashboard_block_info_alter(&$blocks) { + $menu_item = menu_get_item(); + if ($menu_item['page_callback'] !== 'dashboard_admin') { + foreach ($blocks as $key => $block) { + if (in_array($block->region, dashboard_regions())) { + unset($blocks[$key]); + } + } + } +} + +/** + * Implement hook_page_alter(). + * + * Display dashboard blocks in the main content region. + */ +function dashboard_page_alter(&$page) { + // Only do this when we are on the main dashboard page. + $menu_item = menu_get_item(); + if ($menu_item['page_callback'] == 'dashboard_admin') { + // Create a wrapper for the dashboard itself, then insert each dashboard + // region into it. + $page['content']['dashboard'] = array('#theme_wrappers' => array('dashboard')); + foreach (dashboard_regions() as $region) { + // Insert regions even when they are empty, so that they will be + // displayed when the dashboard is being configured. + $page['content']['dashboard'][$region] = !empty($page[$region]) ? $page[$region] : array(); + $page['content']['dashboard'][$region]['#dashboard_region'] = $region; + // Allow each dashboard region to be themed differently, or fall back on + // the generic theme wrapper function for dashboard regions. + $page['content']['dashboard'][$region]['#theme_wrappers'][] = array($region, 'dashboard_region'); + unset($page[$region]); + } + } +} + +/** + * Implement hook_permissions(). + */ +function dashboard_permissions() { + return array( + array( + 'access dashboard' => 'View the administrative dashboard.' + ) + ); +} + +/** + * Implement hook_system_info_alter(). + * + * Add regions to each theme to store the dashboard blocks. + */ +function dashboard_system_info_alter(&$info, $file, $type) { + if ($type == 'theme') { + $info['regions'] += dashboard_region_descriptions(); + } +} + +/** + * Implement hook_theme(). + */ +function dashboard_theme() { + return array( + 'dashboard' => array( + 'arguments' => array('element' => NULL), + ), + 'dashboard_region' => array( + 'arguments' => array('element' => NULL), + ), + 'dashboard_disabled_block' => array( + 'arguments' => array('block' => NULL), + ) + ); +} + +/** + * Dashboard page callback. + */ +function dashboard_admin() { + drupal_add_js(drupal_get_path('module', 'dashboard') . '/dashboard.js'); + drupal_add_js(array( + 'dashboard' => array( + 'customize' => url('admin/dashboard/customize'), + 'blockContent' => url('admin/dashboard/block-content'), + 'updatePath' => url('admin/dashboard/update'), + 'formToken' => drupal_get_token('dashboard-update'), + ), + ), array('type' => 'setting')); + drupal_add_library('system', 'ui.sortable'); + return ''; +} + +/** + * Return an array of dashboard region descriptions, keyed by region name. + */ +function dashboard_region_descriptions() { + $default_regions = array( + 'dashboard_main' => 'Dashboard main', + 'dashboard_sidebar' => 'Dashboard sidebar', + ); + return variable_get('dashboard_region_descriptions', $default_regions); +} + +/** + * Return an array of dashboard region names. + */ +function dashboard_regions() { + return array_keys(dashboard_region_descriptions()); +} + +/** + * AJAX callback to show disabled blocks in dashboard customization mode. + */ +function dashboard_show_disabled() { + global $theme_key; + + // Theme system not initialized at this point. + drupal_theme_initialize(); + + // Blocks are not necessarily initialized either. + $blocks = _block_rehash(); + + $output = "

" . t("Drag and drop dashboard widgets to their place.") . "

"; + $output .= '
'; + $output .= '

' . t("Available blocks") . '

'; + + foreach ($blocks as $block) { + if ($block['theme'] == $theme_key && ($block['status'] == 0 || empty($block['region']))) { + $output .= theme('dashboard_disabled_block', $block); + } + } + $output .= '
'; + + print $output; + exit(); + +} + +/** + * AJAX callback to display the rendered contents of a specific block. + * + * @param $module + * The block's module name. + * @param $delta + * The block's delta. + */ +function dashboard_show_block_content($module, $delta) { + drupal_theme_initialize(); + global $theme_key; + + $blocks = array(); + $block_object = db_query("SELECT * FROM {block} WHERE theme = :theme AND module = :module AND delta = :delta", array( + ":theme" => $theme_key, + ":module" => $module, + ":delta" => $delta, + )) + ->fetchObject(); + $block_object->enabled = $block_object->page_match = TRUE; + $blocks[$module . "_" . $delta] = $block_object; + $block_content = _block_render_blocks($blocks); + $build = _block_get_renderable_array($block_content); + $rendered_block = drupal_render($build); + print $rendered_block; + exit; +} + +/** + * Set the new weight of each region according to the drag-and-drop order. + */ +function dashboard_update() { + drupal_theme_initialize(); + global $theme_key; + // Check the form token to make sure we have a valid request. + if (!empty($_REQUEST['form_token']) && drupal_valid_token($_REQUEST['form_token'], 'dashboard-update')) { + parse_str($_REQUEST['regions'], $regions); + foreach ($regions as $region_name => $blocks) { + if ($region_name == 'disabled_blocks') { + $region_name = ''; + } + foreach ($blocks as $weight => $block_string) { + // Parse the query string to determine the block's module and delta. + preg_match('/block-([^-]+)-(.+)/', $block_string, $matches); + $block = new stdClass; + $block->module = $matches[1]; + $block->delta = $matches[2]; + + $block->region = $region_name; + $block->weight = $weight; + if (empty($region_name)) { + $block->status = 0; + } + else { + $block->status = 1; + } + + db_merge('block') + ->key(array( + 'module' => $block->module, + 'delta' => $block->delta, + 'theme' => $theme_key, + )) + ->fields(array( + 'status' => $block->status, + 'weight' => $block->weight, + 'region' => $block->region, + 'pages' => '', + )) + ->execute(); + } + } + } + exit; +} + +/** + * Theme the entire dashboard. + * + * @param $element + * An associative array containing the properties of the dashboard element. + * Properties used: #children + * @return + * A string representing the themed dashboard. + * + * @ingroup themeable + */ +function theme_dashboard($element) { + drupal_add_css(drupal_get_path('module', 'dashboard') . '/dashboard.css'); + return '
' . $element['#children'] . '
'; +} + +/** + * Theme a generic dashboard region. + * + * @param $element + * An associative array containing the properties of the dashboard region + * element. Properties used: #dashboard_region, #children + * @return + * A string representing the themed dashboard region. + * + * @ingroup themeable + */ +function theme_dashboard_region($element) { + $output = '
'; + $output .= $element['#children']; + $output .= '
'; + return $output; +} + +/** + * Theme a disabled block, for display in dashboard customization mode. + * + * @param $block + * A block object from _block_rehash(). + * @return + * A string representing the disabled block. + * + * @ingroup themeable + */ +function theme_dashboard_disabled_block($block) { + $output = ""; + if (isset($block)) { + $output .= '
' + . '

'.(!empty($block['title']) ? $block['title'] : $block['info']).'

' + . '
' + . '
'; + } + return $output; +} diff --git modules/simpletest/tests/system_test.module modules/simpletest/tests/system_test.module index 49b34e0..2171b27 100644 --- modules/simpletest/tests/system_test.module +++ modules/simpletest/tests/system_test.module @@ -182,7 +182,7 @@ function system_test_exit() { /** * Implement hook_system_info_alter(). */ -function system_test_system_info_alter(&$info, $file) { +function system_test_system_info_alter(&$info, $file, $type) { // We need a static otherwise the last test will fail to alter common_test. static $test; if (($dependencies = variable_get('dependencies', array())) || $test) { diff --git modules/system/system.api.php modules/system/system.api.php index 7230866..0ac04d7 100644 --- modules/system/system.api.php +++ modules/system/system.api.php @@ -713,8 +713,11 @@ function hook_mail_alter(&$message) { * @param $file * Full information about the module or theme, including $file->name, and * $file->filename + * @param $type + * Either 'module' or 'theme', depending on the type of .info file that was + * passed. */ -function hook_system_info_alter(&$info, $file) { +function hook_system_info_alter(&$info, $file, $type) { // Only fill this in if the .info file does not define a 'datestamp'. if (empty($info['datestamp'])) { $info['datestamp'] = filemtime($file->filename); diff --git modules/system/system.module modules/system/system.module index ab5dce9..6309d43 100644 --- modules/system/system.module +++ modules/system/system.module @@ -1906,7 +1906,7 @@ function _system_get_module_data() { // Invoke hook_system_info_alter() to give installed modules a chance to // modify the data in the .info files if necessary. - drupal_alter('system_info', $modules[$key]->info, $modules[$key]); + drupal_alter('system_info', $modules[$key]->info, $modules[$key], 'module'); } // The install profile is required. @@ -1999,7 +1999,7 @@ function _system_get_theme_data() { // Invoke hook_system_info_alter() to give installed modules a chance to // modify the data in the .info files if necessary. - drupal_alter('system_info', $themes[$key]->info, $themes[$key]); + drupal_alter('system_info', $themes[$key]->info, $themes[$key], 'theme'); if (!empty($themes[$key]->info['base theme'])) { $sub_themes[] = $key; @@ -2161,11 +2161,13 @@ function system_region_list($theme_key, $show = REGIONS_ALL) { /** * Implement hook_system_info_alter(). */ -function system_system_info_alter(&$info, $file) { +function system_system_info_alter(&$info, $file, $type) { // Remove page-top from the blocks UI since it is reserved for modules to // populate from outside the blocks system. - $info['regions_hidden'][] = 'page_top'; - $info['regions_hidden'][] = 'page_bottom'; + if ($type == 'theme') { + $info['regions_hidden'][] = 'page_top'; + $info['regions_hidden'][] = 'page_bottom'; + } } /** diff --git modules/toolbar/toolbar.install modules/toolbar/toolbar.install index 628893a..a4a48ab 100644 --- modules/toolbar/toolbar.install +++ modules/toolbar/toolbar.install @@ -27,7 +27,7 @@ function toolbar_install() { $items = array( 'node/add' => 'Add content', 'admin/content' => 'Find content', - 'admin' => 'Dashboard', + 'admin/dashboard' => 'Dashboard', ); $weight = -20; foreach ($items as $path => $title) { diff --git profiles/default/default.info profiles/default/default.info index 9b0ed6c..34eb20c 100644 --- profiles/default/default.info +++ profiles/default/default.info @@ -6,6 +6,7 @@ core = 7.x dependencies[] = block dependencies[] = color dependencies[] = comment +dependencies[] = dashboard dependencies[] = help dependencies[] = image dependencies[] = menu diff --git profiles/default/default.install profiles/default/default.install index b692c14..9ccd167 100644 --- profiles/default/default.install +++ profiles/default/default.install @@ -100,6 +100,26 @@ function default_install() { 'pages' => '', 'cache' => -1, ), + array( + 'module' => 'system', + 'delta' => 'management', + 'theme' => 'seven', + 'status' => 1, + 'weight' => 0, + 'region' => 'dashboard_main', + 'pages' => '', + 'cache' => -1, + ), + array( + 'module' => 'user', + 'delta' => 'new', + 'theme' => 'seven', + 'status' => 1, + 'weight' => 0, + 'region' => 'dashboard_sidebar', + 'pages' => '', + 'cache' => -1, + ), ); $query = db_insert('block')->fields(array('module', 'delta', 'theme', 'status', 'weight', 'region', 'pages', 'cache')); foreach ($values as $record) {