Newer
Older
// $Id$
* Controls the visual building blocks a page is constructed with.
/**
* Denotes that a block is not enabled in any region and should not be shown.
*/
Dries Buytaert
committed
define('BLOCK_REGION_NONE', -1);
Dries Buytaert
committed
* Implements hook_help().
Gábor Hojtsy
committed
function block_help($path, $arg) {
switch ($path) {
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Block module allows you to create boxes of content, which are rendered into an area, or region, of one or more pages of a website. The core Seven administration theme, for example, implements the regions "Content", "Help", "Dashboard main", and "Dashboard sidebar", and a block may appear in any one of these regions. The <a href="@blocks">Blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. For more information, see the online handbook entry for <a href="@block">Block module</a>.', array('@block' => 'http://drupal.org/handbook/modules/block/', '@blocks' => url('admin/structure/block'))) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Positioning content') . '</dt>';
$output .= '<dd>' . t('When working with blocks, remember that all themes do <em>not</em> implement the same regions, or display regions in the same way. Blocks are positioned on a per-theme basis. Users with the <em>Administer blocks</em> permission can disable blocks. Disabled blocks are listed on the <a href="@blocks">Blocks administration page</a>, but are not displayed in any region.', array('@block' => 'http://drupal.org/handbook/modules/block/', '@blocks' => url('admin/structure/block'))) . '</dd>';
$output .= '<dt>' . t('Controlling visibility') . '</dt>';
$output .= '<dd>' . t('Blocks can be configured to be visible only on certain pages, only to users of certain roles, or only on pages displaying certain <a href="@content-type">content types</a>. Administrators can also allow specific blocks to be enabled or disabled by users when they edit their <a href="@user">My account</a> page. Some dynamic blocks, such as those generated by modules, will be displayed only on certain pages.', array('@content-type' => url('admin/structure/types'), '@user' => url('user'))) . '</dd>';
$output .= '<dt>' . t('Creating custom blocks') . '</dt>';
$output .= '<dd>' . t('Users with the <em>Administer blocks</em> permission can <a href="@block-add">add custom blocks</a>, which are then listed on the <a href="@blocks">Blocks administration page</a>. Once created, custom blocks behave just like default and module-generated blocks.', array('@blocks' => url('admin/structure/block'), '@block-add' => url('admin/structure/block/add'))) . '</dd>';
$output .= '</dl>';
Dries Buytaert
committed
return $output;
Dries Buytaert
committed
case 'admin/structure/block/add':
Dries Buytaert
committed
return '<p>' . t('Use this page to create a new custom block.') . '</p>';
Angie Byron
committed
if ($arg[0] == 'admin' && $arg[1] == 'structure' && $arg['2'] == 'block' && (empty($arg[3]) || $arg[3] == 'list')) {
Dries Buytaert
committed
$demo_theme = !empty($arg[4]) ? $arg[4] : variable_get('theme_default', 'garland');
$themes = list_themes();
$output = '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page. Click the <em>configure</em> link next to each block to configure its specific title and visibility settings.') . '</p>';
$output .= '<p>' . l(t('Demonstrate block regions (@theme)', array('@theme' => $themes[$demo_theme]->info['name'])), 'admin/structure/block/demo/' . $demo_theme) . '</p>';
return $output;
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function block_theme() {
return array(
Angie Byron
committed
'block' => array(
'render element' => 'elements',
Angie Byron
committed
'template' => 'block',
'block_admin_display_form' => array(
'template' => 'block-admin-display-form',
'file' => 'block.admin.inc',
'render element' => 'form',
Dries Buytaert
committed
),
);
}
Dries Buytaert
committed
* Implements hook_permission().
function block_permission() {
return array(
Angie Byron
committed
'administer blocks' => array(
'title' => t('Administer blocks'),
),
);
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
function block_menu() {
Dries Buytaert
committed
$default_theme = variable_get('theme_default', 'garland');
Dries Buytaert
committed
$items['admin/structure/block'] = array(
'title' => 'Blocks',
'description' => 'Configure what block content appears in your site\'s sidebars and other regions.',
'page callback' => 'block_admin_display',
Dries Buytaert
committed
'page arguments' => array($default_theme),
Dries Buytaert
committed
'access arguments' => array('administer blocks'),
'file' => 'block.admin.inc',
Dries Buytaert
committed
);
Dries Buytaert
committed
$items['admin/structure/block/list'] = array(
'title' => 'List',
Dries Buytaert
committed
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
Dries Buytaert
committed
$items['admin/structure/block/manage/%/%'] = array(
'title' => 'Configure block',
'page callback' => 'drupal_get_form',
Dries Buytaert
committed
'page arguments' => array('block_admin_configure', 4, 5),
Dries Buytaert
committed
'access arguments' => array('administer blocks'),
'file' => 'block.admin.inc',
Dries Buytaert
committed
);
Dries Buytaert
committed
$items['admin/structure/block/manage/%/%/configure'] = array(
Angie Byron
committed
'title' => 'Configure block',
'type' => MENU_DEFAULT_LOCAL_TASK,
'context' => MENU_CONTEXT_INLINE,
);
Dries Buytaert
committed
$items['admin/structure/block/manage/%/%/delete'] = array(
'title' => 'Delete block',
'page callback' => 'drupal_get_form',
Dries Buytaert
committed
'page arguments' => array('block_custom_block_delete', 4, 5),
Dries Buytaert
committed
'access arguments' => array('administer blocks'),
Dries Buytaert
committed
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_NONE,
'file' => 'block.admin.inc',
Dries Buytaert
committed
);
Dries Buytaert
committed
$items['admin/structure/block/add'] = array(
'title' => 'Add block',
'page callback' => 'drupal_get_form',
Dries Buytaert
committed
'page arguments' => array('block_add_block_form'),
Dries Buytaert
committed
'access arguments' => array('administer blocks'),
Angie Byron
committed
'type' => MENU_LOCAL_ACTION,
'file' => 'block.admin.inc',
Dries Buytaert
committed
);
foreach (list_themes() as $key => $theme) {
Dries Buytaert
committed
$items['admin/structure/block/list/' . $key] = array(
Gábor Hojtsy
committed
'title' => check_plain($theme->info['name']),
'page arguments' => array($key),
Dries Buytaert
committed
'type' => $key == $default_theme ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
'weight' => $key == $default_theme ? -10 : 0,
'access callback' => '_block_themes_access',
'access arguments' => array($theme),
'file' => 'block.admin.inc',
);
Angie Byron
committed
if ($key != $default_theme) {
$items['admin/structure/block/list/' . $key . '/add'] = array(
'title' => 'Add block',
'page callback' => 'drupal_get_form',
'page arguments' => array('block_add_block_form'),
'access arguments' => array('administer blocks'),
'type' => MENU_LOCAL_ACTION,
'file' => 'block.admin.inc',
);
}
Dries Buytaert
committed
$items['admin/structure/block/demo/' . $key] = array(
'title' => check_plain($theme->info['name']),
'page callback' => 'block_admin_demo',
'page arguments' => array($key),
'type' => MENU_CALLBACK,
Gábor Hojtsy
committed
'access callback' => '_block_themes_access',
'access arguments' => array($theme),
Dries Buytaert
committed
'theme callback' => '_block_custom_theme',
'theme arguments' => array($key),
'file' => 'block.admin.inc',
Gábor Hojtsy
committed
);
Gábor Hojtsy
committed
/**
* Menu item access callback - only admin or enabled themes can be accessed.
Gábor Hojtsy
committed
*/
function _block_themes_access($theme) {
Dries Buytaert
committed
return user_access('administer blocks') && drupal_theme_access($theme);
}
/**
* Theme callback for the block configuration pages.
*
* @param $theme
* The theme whose blocks are being configured. If not set, the default theme
* is assumed.
* @return
* The theme that should be used for the block configuration page, or NULL
* to indicate that the default theme should be used.
*/
function _block_custom_theme($theme = NULL) {
// We return exactly what was passed in, to guarantee that the page will
// always be displayed using the theme whose blocks are being configured.
return $theme;
Gábor Hojtsy
committed
}
Dries Buytaert
committed
* Implements hook_block_info().
Dries Buytaert
committed
function block_block_info() {
Dries Buytaert
committed
$blocks = array();
$result = db_query('SELECT bid, info FROM {block_custom} ORDER BY info');
Dries Buytaert
committed
foreach ($result as $block) {
Dries Buytaert
committed
$blocks[$block->bid]['info'] = $block->info;
// Not worth caching.
$blocks[$block->bid]['cache'] = DRUPAL_NO_CACHE;
Dries Buytaert
committed
}
return $blocks;
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_block_configure().
Dries Buytaert
committed
*/
function block_block_configure($delta = 0) {
$custom_block = array('format' => filter_default_format());
Dries Buytaert
committed
if ($delta) {
$custom_block = block_custom_block_get($delta);
Dries Buytaert
committed
}
return block_custom_block_form($custom_block);
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_block_save().
Dries Buytaert
committed
*/
function block_block_save($delta = 0, $edit = array()) {
block_custom_block_save($edit, $delta);
Dries Buytaert
committed
}
/**
Dries Buytaert
committed
* Implements hook_block_view().
Dries Buytaert
committed
*
* Generates the administrator-defined blocks for display.
*/
function block_block_view($delta = 0, $edit = array()) {
$block = db_query('SELECT body, format FROM {block_custom} WHERE bid = :bid', array(':bid' => $delta))->fetchObject();
Angie Byron
committed
$data['content'] = check_markup($block->body, $block->format, '', TRUE);
Dries Buytaert
committed
return $data;
}
/**
Dries Buytaert
committed
* Implements hook_page_build().
*
* Render blocks into their regions.
*/
Angie Byron
committed
function block_page_build(&$page) {
global $theme;
// The theme system might not yet be initialized. We need $theme.
Dries Buytaert
committed
drupal_theme_initialize();
// Populate all block regions
Dries Buytaert
committed
$all_regions = system_region_list($theme);
Dries Buytaert
committed
$item = menu_get_item();
if ($item['path'] != 'admin/structure/block/demo/' . $theme) {
// Load all region content assigned via blocks.
foreach (array_keys($all_regions) as $region) {
// Assign blocks to region.
if ($blocks = block_get_blocks_by_region($region)) {
$page[$region] = $blocks;
}
Dries Buytaert
committed
}
Dries Buytaert
committed
}
else {
// Append region description if we are rendering the regions demo page.
Dries Buytaert
committed
$item = menu_get_item();
Dries Buytaert
committed
if ($item['path'] == 'admin/structure/block/demo/' . $theme) {
$visible_regions = array_keys(system_region_list($theme, REGIONS_VISIBLE));
foreach ($visible_regions as $region) {
Dries Buytaert
committed
$description = '<div class="block-region">' . $all_regions[$region] . '</div>';
$page[$region]['block_description'] = array(
'#markup' => $description,
'#weight' => 15,
);
}
}
}
}
/**
* Get a renderable array of a region containing all enabled blocks.
*
* @param $region
* The requested region.
*/
function block_get_blocks_by_region($region) {
$build = array();
if ($list = block_list($region)) {
Dries Buytaert
committed
$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);
Angie Byron
committed
// Add contextual links for this block; skipping the system main block.
if ($key != 'system_main') {
Dries Buytaert
committed
$build[$key]['#contextual_links']['block'] = array('admin/structure/block/manage', array($block->module, $block->delta));
Angie Byron
committed
}
Dries Buytaert
committed
$build[$key] += array(
'#block' => $block,
'#weight' => ++$weight,
);
$build[$key]['#theme_wrappers'][] ='block';
}
Dries Buytaert
committed
$build['#sorted'] = TRUE;
return $build;
}
Dries Buytaert
committed
* Update the 'block' DB table with the blocks currently exported by modules.
Dries Buytaert
committed
* @param $theme
* The theme to rehash blocks for. If not provided, defaults to the currently
* used theme.
Angie Byron
committed
*
Steven Wittens
committed
* Blocks currently exported by modules.
Dries Buytaert
committed
function _block_rehash($theme = NULL) {
Angie Byron
committed
Dries Buytaert
committed
drupal_theme_initialize();
Dries Buytaert
committed
if (!isset($theme)) {
// If theme is not specifically set, rehash for the current theme.
$theme = $theme_key;
}
$regions = system_region_list($theme);
// These are the blocks the function will return.
$blocks = array();
// These are the blocks defined by code and modified by the database.
$current_blocks = array();
// These are {block}.bid values to be kept.
$bids = array();
$or = db_or();
// Gather the blocks defined by modules.
Dries Buytaert
committed
foreach (module_implements('block_info') as $module) {
$module_blocks = module_invoke($module, 'block_info');
foreach ($module_blocks as $delta => $block) {
// Compile a condition to retrieve this block from the database.
$condition = db_and()
->condition('module', $module)
->condition('delta', $delta);
$or->condition($condition);
// Add identifiers.
$block['module'] = $module;
$block['delta'] = $delta;
$block['theme'] = $theme;
$current_blocks[$module][$delta] = $block;
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
// Save the blocks defined in code for alter context.
$code_blocks = $current_blocks;
$database_blocks = db_select('block', 'b')
->fields('b')
->condition($or)
->condition('theme', $theme)
->execute();
foreach ($database_blocks as $block) {
// Preserve info which is not in the database.
$block->info = $current_blocks[$block->module][$block->delta]['info'];
// Blocks stored in the database override the blocks defined in code.
$current_blocks[$block->module][$block->delta] = get_object_vars($block);
// Preserve this block.
$bids[$block->bid] = $block->bid;
}
drupal_alter('block_info', $current_blocks, $theme, $code_blocks);
foreach ($current_blocks as $module => $module_blocks) {
foreach ($module_blocks as $delta => $block) {
if (!isset($block['pages'])) {
// {block}.pages is type 'text', so it cannot have a
// default value, and not null, so we need to provide
// value if the module did not.
$block['pages'] = '';
}
// Make sure weight is set.
if (!isset($block['weight'])) {
$block['weight'] = 0;
}
if (!empty($block['region']) && $block['region'] != BLOCK_REGION_NONE && !isset($regions[$block['region']])) {
drupal_set_message(t('The block %info was assigned to the invalid region %region and has been disabled.', array('%info' => $block['info'], '%region' => $block['region'])), 'warning');
// Disabled modules are moved into the BLOCK_REGION_NONE later so no
// need to move the bock to another region.
$block['status'] = 0;
}
// Set region to none if not enabled and make sure status is set.
if (empty($block['status'])) {
$block['status'] = 0;
$block['region'] = BLOCK_REGION_NONE;
}
// There is no point saving disabled blocks. Still, we need to save them
// beecause the 'title' attribute is saved to the {blocks} table.
if (isset($block['bid'])) {
// If the block has a bid property, it comes from the database and
// the record needs to be updated, so set the primary key to 'bid'
// before passing to drupal_write_record().
$primary_keys = array('bid');
// Remove a block from the list of blocks to keep if it became disabled.
unset($bids[$block['bid']]);
}
else {
$primary_keys = array();
}
drupal_write_record('block', $block, $primary_keys);
// Add to the list of blocks we return.
$blocks[] = $block;
Gábor Hojtsy
committed
}
Dries Buytaert
committed
}
if ($bids) {
// Remove disabled that are no longer defined by the code from the
// database.
db_delete('block')
->condition('bid', $bids, 'NOT IN')
->condition('theme', $theme)
->execute();
}
Dries Buytaert
committed
/**
* Returns information from database about a user-created (custom) block.
*
* @param $bid
* ID of the block to get information for.
* @return
* Associative array of information stored in the database for this block.
* Array keys:
* - bid: Block ID.
* - info: Block description.
* - body: Block contents.
* - format: Filter ID of the filter format for the body.
*/
function block_custom_block_get($bid) {
return db_query("SELECT * FROM {block_custom} WHERE bid = :bid", array(':bid' => $bid))->fetchAssoc();
/**
* Define the custom block form.
*/
function block_custom_block_form($edit = array()) {
Steven Wittens
committed
$edit += array(
'info' => '',
'body' => '',
);
Dries Buytaert
committed
$form['info'] = array(
'#type' => 'textfield',
'#title' => t('Block description'),
'#default_value' => $edit['info'],
Dries Buytaert
committed
'#maxlength' => 64,
Dries Buytaert
committed
'#description' => t('A brief description of your block. Used on the <a href="@overview">Blocks administration page</a>.', array('@overview' => url('admin/structure/block'))),
Dries Buytaert
committed
'#required' => TRUE,
'#weight' => -19,
);
$form['body_field']['#weight'] = -17;
$form['body_field']['body'] = array(
'#type' => 'text_format',
Dries Buytaert
committed
'#title' => t('Block body'),
'#default_value' => $edit['body'],
'#format' => isset($edit['format']) ? $edit['format'] : NULL,
Dries Buytaert
committed
'#rows' => 15,
'#description' => t('The content of the block as shown to the user.'),
'#required' => TRUE,
Dries Buytaert
committed
'#weight' => -17,
);
}
Dries Buytaert
committed
/**
* Saves a user-created block in the database.
*
* @param $edit
* Associative array of fields to save. Array keys:
* - info: Block description.
* - body: Block contents.
* - format: Filter ID of the filter format for the body.
* @param $delta
* Block ID of the block to save.
* @return
* Always returns TRUE.
*/
function block_custom_block_save($edit, $delta) {
db_update('block_custom')
Dries Buytaert
committed
->fields(array(
'body' => $edit['body'],
'info' => $edit['info'],
'format' => $edit['format'],
Dries Buytaert
committed
))
->condition('bid', $delta)
->execute();
Dries Buytaert
committed
return TRUE;
}
Dries Buytaert
committed
* Implements hook_form_FORM_ID_alter().
Dries Buytaert
committed
function block_form_user_profile_form_alter(&$form, &$form_state) {
if ($form['#user_category'] == 'account') {
$account = $form['#user'];
Dries Buytaert
committed
$rids = array_keys($account->roles);
$result = db_query("SELECT DISTINCT b.* FROM {block} b LEFT JOIN {block_role} r ON b.module = r.module AND b.delta = r.delta WHERE b.status = 1 AND b.custom <> 0 AND (r.rid IN (:rids) OR r.rid IS NULL) ORDER BY b.weight, b.module", array(':rids' => $rids));
$blocks = array();
Dries Buytaert
committed
foreach ($result as $block) {
Dries Buytaert
committed
$data = module_invoke($block->module, 'block_info');
Dries Buytaert
committed
if ($data[$block->delta]['info']) {
$blocks[$block->module][$block->delta] = array(
Dries Buytaert
committed
'#type' => 'checkbox',
'#title' => check_plain($data[$block->delta]['info']),
'#default_value' => isset($account->block[$block->module][$block->delta]) ? $account->block[$block->module][$block->delta] : ($block->custom == 1),
);
Dries Buytaert
committed
}
// Only display the fieldset if there are any personalizable blocks.
if ($blocks) {
$form['block'] = array(
'#type' => 'fieldset',
'#title' => t('Personalize blocks'),
'#description' => t('Blocks consist of content or information that complements the main content of the page. Enable or disable optional blocks using the checkboxes below.'),
'#weight' => 3,
'#collapsible' => TRUE,
'#tree' => TRUE,
);
$form['block'] += $blocks;
Dries Buytaert
committed
}
}
}
Dries Buytaert
committed
/**
* Initialize blocks for enabled themes.
*/
Dries Buytaert
committed
function block_themes_enabled($theme_list) {
foreach ($theme_list as $theme) {
block_theme_initialize($theme);
Dries Buytaert
committed
}
}
/**
* Assign an initial, default set of blocks for a theme.
Dries Buytaert
committed
* This function is called the first time a new theme is enabled. The new theme
* gets a copy of the default theme's blocks, with the difference that if a
* particular region isn't available in the new theme, the block is assigned
* to the new theme's default region.
Dries Buytaert
committed
* @param $theme
* The name of a theme.
*/
Dries Buytaert
committed
function block_theme_initialize($theme) {
Dries Buytaert
committed
// Initialize theme's blocks if none already registered.
Angie Byron
committed
$has_blocks = (bool) db_query_range('SELECT 1 FROM {block} WHERE theme = :theme', 0, 1, array(':theme' => $theme))->fetchField();
Angie Byron
committed
if (!$has_blocks) {
Dries Buytaert
committed
$default_theme = variable_get('theme_default', 'garland');
$regions = system_region_list($theme);
Dries Buytaert
committed
$result = db_query("SELECT * FROM {block} WHERE theme = :theme", array(':theme' => $default_theme), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $block) {
Dries Buytaert
committed
// If the region isn't supported by the theme, assign the block to the theme's default region.
if (!array_key_exists($block['region'], $regions)) {
$block['region'] = system_default_region($theme);
}
Dries Buytaert
committed
$block['theme'] = $theme;
Dries Buytaert
committed
unset($block['bid']);
drupal_write_record('block', $block);
Dries Buytaert
committed
}
}
}
/**
* Return all blocks in the specified region for the current user.
*
* @param $region
* The name of a region.
*
* @return
* An array of block objects, indexed with <i>module</i>_<i>delta</i>.
* If you are displaying your blocks in one or two sidebars, you may check
* whether this array is empty to see how many columns are going to be
* displayed.
*
* @todo
* Now that the blocks table has a primary key, we should use that as the
* array key instead of <i>module</i>_<i>delta</i>.
*/
function block_list($region) {
Dries Buytaert
committed
$blocks = &drupal_static(__FUNCTION__);
Dries Buytaert
committed
if (!isset($blocks)) {
Dries Buytaert
committed
$blocks = _block_load_blocks();
}
Dries Buytaert
committed
// Create an empty array if there are no entries.
Dries Buytaert
committed
if (!isset($blocks[$region])) {
$blocks[$region] = array();
}
Dries Buytaert
committed
else {
$blocks[$region] = _block_render_blocks($blocks[$region]);
}
Dries Buytaert
committed
return $blocks[$region];
}
Angie Byron
committed
/**
* Load a block object from the database.
*
* @param $module
* Name of the module that implements the block to load.
* @param $delta
Dries Buytaert
committed
* Unique ID of the block within the context of $module. Pass NULL to return
* an empty $block object for $module.
Angie Byron
committed
*
* @return
* A block object.
*/
function block_load($module, $delta) {
Dries Buytaert
committed
if (isset($delta)) {
$block = db_query('SELECT * FROM {block} WHERE module = :module AND delta = :delta', array(':module' => $module, ':delta' => $delta))->fetchObject();
}
Angie Byron
committed
// If the block does not exist in the database yet return a stub block
// object.
Dries Buytaert
committed
if (empty($block)) {
Angie Byron
committed
$block = new stdClass;
$block->module = $module;
$block->delta = $delta;
}
return $block;
}
Dries Buytaert
committed
/**
* Load blocks information from the database.
Dries Buytaert
committed
*/
function _block_load_blocks() {
global $theme_key;
Dries Buytaert
committed
Dries Buytaert
committed
$query = db_select('block', 'b');
$result = $query
->fields('b')
->condition('b.theme', $theme_key)
->condition('b.status', 1)
->orderBy('b.region')
->orderBy('b.weight')
->orderBy('b.module')
->addTag('block_load')
Dries Buytaert
committed
->addTag('translatable')
Dries Buytaert
committed
->execute();
Dries Buytaert
committed
$block_info = $result->fetchAllAssoc('bid');
// Allow modules to modify the block list.
drupal_alter('block_list', $block_info);
$blocks = array();
Dries Buytaert
committed
foreach ($block_info as $block) {
$blocks[$block->region]["{$block->module}_{$block->delta}"] = $block;
}
return $blocks;
}
/**
* Implements hook_block_list_alter().
*
Dries Buytaert
committed
* Check the page, user role and user specific visibilty settings.
Dries Buytaert
committed
* Remove the block if the visibility conditions are not met.
*/
function block_block_list_alter(&$blocks) {
global $user, $theme_key;
// Build an array of roles for each block.
$block_roles = array();
$result = db_query('SELECT module, delta, rid FROM {block_role}');
foreach ($result as $record) {
$block_roles[$record->module][$record->delta][] = $record->rid;
}
foreach ($blocks as $key => $block) {
Dries Buytaert
committed
if (!isset($block->theme) || !isset($block->status) || $block->theme != $theme_key || $block->status != 1) {
// This block was added by a contrib module, leave it in the list.
continue;
Dries Buytaert
committed
}
// If a block has no roles associated, it is displayed for every role.
// For blocks with roles associated, if none of the user's roles matches
// the settings from this block, remove it from the block list.
Dries Buytaert
committed
if (isset($block_roles[$block->module][$block->delta]) && !array_intersect($block_roles[$block->module][$block->delta], array_keys($user->roles))) {
// No match.
unset($blocks[$key]);
continue;
Dries Buytaert
committed
}
// Use the user's block visibility setting, if necessary.
Dries Buytaert
committed
if ($block->custom != 0) {
if ($user->uid && isset($user->block[$block->module][$block->delta])) {
$enabled = $user->block[$block->module][$block->delta];
}
else {
Dries Buytaert
committed
$enabled = ($block->custom == 1);
Steven Wittens
committed
}
Dries Buytaert
committed
}
else {
$enabled = TRUE;
}
if (!$enabled) {
unset($blocks[$key]);
continue;
}
Steven Wittens
committed
// Match path if necessary.
Dries Buytaert
committed
if ($block->pages) {
Angie Byron
committed
// Convert path to lowercase. This allows comparison of the same path
// with different case. Ex: /Page, /page, /PAGE.
$pages = drupal_strtolower($block->pages);
Dries Buytaert
committed
if ($block->visibility < 2) {
Angie Byron
committed
// Convert the Drupal path to lowercase
$path = drupal_strtolower(drupal_get_path_alias($_GET['q']));
// Compare the lowercase internal and lowercase path alias (if any).
$page_match = drupal_match_path($path, $pages);
Dries Buytaert
committed
if ($path != $_GET['q']) {
Angie Byron
committed
$page_match = $page_match || drupal_match_path($_GET['q'], $pages);
Dries Buytaert
committed
}
Dries Buytaert
committed
// When $block->visibility has a value of 0, the block is displayed on
// all pages except those listed in $block->pages. When set to 1, it
// is displayed only on those pages listed in $block->pages.
$page_match = !($block->visibility xor $page_match);
Steven Wittens
committed
}
elseif (module_exists('php')) {
$page_match = php_eval($block->pages);
}
Steven Wittens
committed
else {
$page_match = FALSE;
Steven Wittens
committed
}
Dries Buytaert
committed
}
else {
$page_match = TRUE;
}
if (!$page_match) {
unset($blocks[$key]);
}
Dries Buytaert
committed
}
}
Dries Buytaert
committed
Dries Buytaert
committed
/**
* Render the content and subject for a set of blocks.
*
* @param $region_blocks
* An array of block objects such as returned for one region by _block_load_blocks().
Dries Buytaert
committed
*
* @return
* An array of visible blocks as expected by drupal_render().
Dries Buytaert
committed
*/
function _block_render_blocks($region_blocks) {
foreach ($region_blocks as $key => $block) {
// Render the block content if it has not been created already.
if (!isset($block->content)) {
// Erase the block from the static array - we'll put it back if it has
// content.
Dries Buytaert
committed
unset($region_blocks[$key]);
// Try fetching the block from cache. Block caching is not compatible
// with node_access modules. We also preserve the submission of forms in
// blocks, by fetching from cache only if the request method is 'GET'
// (or 'HEAD').
if (!count(module_implements('node_grants')) && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD') && ($cid = _block_get_cache_id($block)) && ($cache = cache_get($cid, 'cache_block'))) {
$array = $cache->data;
}
else {
$array = module_invoke($block->module, 'block_view', $block->delta);
Angie Byron
committed
// Allow modules to modify the block before it is viewed, via either
// hook_block_view_alter() or hook_block_view_MODULE_DELTA_alter().
drupal_alter(array('block_view', "block_view_{$block->module}_{$block->delta}"), $array, $block);
Angie Byron
committed
if (isset($cid)) {
cache_set($cid, $array, 'cache_block', CACHE_TEMPORARY);
Dries Buytaert
committed
}
}
if (isset($array) && is_array($array)) {
foreach ($array as $k => $v) {
$block->$k = $v;
}
if (isset($block->content) && $block->content) {
// Normalize to the drupal_render() structure.
if (is_string($block->content)) {
$block->content = array('#markup' => $block->content);
}
// Override default block title if a custom display title is present.
if ($block->title) {
// Check plain here to allow module generated titles to keep any
// markup.
$block->subject = $block->title == '<none>' ? '' : check_plain($block->title);
}
if (!isset($block->subject)) {
$block->subject = '';
$region_blocks["{$block->module}_{$block->delta}"] = $block;
Dries Buytaert
committed
return $region_blocks;
/**
* Assemble the cache_id to use for a given block.
*
* The cache_id string reflects the viewing context for the current block
* instance, obtained by concatenating the relevant context information
* (user, page, ...) according to the block's cache settings (BLOCK_CACHE_*
* constants). Two block instances can use the same cached content when
* they share the same cache_id.
*
* Theme and language contexts are automatically differentiated.
*
* @param $block
* @return
* The string used as cache_id for the block.
*/
function _block_get_cache_id($block) {
global $user;
Angie Byron
committed
// User 1 being out of the regular 'roles define permissions' schema,
// it brings too many chances of having unwanted output get in the cache
// and later be served to other users. We therefore exclude user 1 from
// block caching.
Dries Buytaert
committed
if (variable_get('block_cache', FALSE) && !in_array($block->cache, array(DRUPAL_NO_CACHE, DRUPAL_CACHE_CUSTOM)) && $user->uid != 1) {
// Start with common sub-patterns: block identification, theme, language.
$cid_parts[] = $block->module;
$cid_parts[] = $block->delta;
Dries Buytaert
committed
$cid_parts = array_merge($cid_parts, drupal_render_cid_parts($block->cache));
return implode(':', $cid_parts);
}
Dries Buytaert
committed
}
Dries Buytaert
committed
* Implements hook_flush_caches().
*/
function block_flush_caches() {
return array('cache_block');
}
Angie Byron
committed
/**
* Process variables for block.tpl.php
*
* Prepare the values passed to the theme_block function to be passed
* into a pluggable template engine. Uses block properties to generate a
* series of template file suggestions. If none are found, the default
* block.tpl.php is used.
*
* Most themes utilize their own copy of block.tpl.php. The default is located
* inside "modules/block/block.tpl.php". Look in there for the full list of
* variables.
*
* The $variables array contains the following arguments:
* - $block
*
* @see block.tpl.php
*/
function template_preprocess_block(&$variables) {
$block_counter = &drupal_static(__FUNCTION__, array());
$variables['block'] = $variables['elements']['#block'];
Angie Byron
committed
// All blocks get an independent counter for each region.
if (!isset($block_counter[$variables['block']->region])) {
$block_counter[$variables['block']->region] = 1;
}
// Same with zebra striping.
$variables['block_zebra'] = ($block_counter[$variables['block']->region] % 2) ? 'odd' : 'even';
$variables['block_id'] = $block_counter[$variables['block']->region]++;
// Create the $content variable that templates expect.
$variables['content'] = $variables['elements']['#children'];
Dries Buytaert
committed
$variables['classes_array'][] = drupal_html_class('block-' . $variables['block']->module);
Angie Byron
committed
Angie Byron
committed
$variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->region;
$variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module;
$variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module . '__' . $variables['block']->delta;
Dries Buytaert
committed
// Create a valid HTML ID and make sure it is unique.
$variables['block_html_id'] = drupal_html_id('block-' . $variables['block']->module . '-' . $variables['block']->delta);
Angie Byron
committed
}
Dries Buytaert
committed
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_user_role_delete().
Dries Buytaert
committed
*
Angie Byron
committed
* Remove deleted role from blocks that use it.
Dries Buytaert
committed
*/
function block_user_role_delete($role) {
db_delete('block_role')
->condition('rid', $role->rid)
->execute();
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_filter_format_delete().
Dries Buytaert
committed
*/
function block_filter_format_delete($format, $fallback) {
db_update('block_custom')
->fields(array('format' => $fallback->format))
Dries Buytaert
committed
->condition('format', $format->format)
->execute();
}
/**
Dries Buytaert
committed
* Implements hook_menu_delete().
*/
function block_menu_delete($menu) {
db_delete('block')
->condition('module', 'menu')
->condition('delta', $menu['menu_name'])
->execute();
db_delete('block_role')
->condition('module', 'menu')
->condition('delta', $menu['menu_name'])
->execute();
}
Angie Byron
committed
/**
Dries Buytaert
committed
* Implements hook_form_FORM_ID_alter().
Angie Byron
committed
*/
function block_form_system_performance_settings_alter(&$form, &$form_state) {
$disabled = count(module_implements('node_grants'));
$form['caching']['block_cache'] = array(
'#type' => 'checkbox',
'#title' => t('Cache blocks'),
'#default_value' => variable_get('block_cache', FALSE),
'#disabled' => $disabled,
'#description' => $disabled ? t('Block caching is inactive because you have enabled modules defining content access restrictions.') : NULL,
'#weight' => -1,
);
}
Dries Buytaert
committed
/**
* Implements hook_modules_uninstalled().
*
* Cleanup {block} and {block_role} tables from modules' blocks.
*/
function block_modules_uninstalled($modules) {
db_delete('block')
->condition('module', $modules, 'IN')
->execute();
db_delete('block_role')
->condition('module', $modules, 'IN')
->execute();
}