block.module 23.7 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Controls the boxes that are displayed around the main content.
 */

9 10 11
/**
 * Denotes that a block is not enabled in any region and should not be shown.
 */
12 13
define('BLOCK_REGION_NONE', -1);

14 15 16 17
/**
 * Constants defining cache granularity for blocks.
 *
 * Modules specify the caching patterns for their blocks using binary
18
 * combinations of these constants in their hook_block_list():
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
 *   $block[delta]['cache'] = BLOCK_CACHE_PER_ROLE | BLOCK_CACHE_PER_PAGE;
 * BLOCK_CACHE_PER_ROLE is used as a default when no caching pattern is
 * specified.
 *
 * The block cache is cleared in cache_clear_all(), and uses the same clearing
 * policy than page cache (node, comment, user, taxonomy added or updated...).
 * Blocks requiring more fine-grained clearing might consider disabling the
 * built-in block cache (BLOCK_NO_CACHE) and roll their own.
 *
 * Note that user 1 is excluded from block caching.
 */

/**
 * The block should not get cached. This setting should be used:
 * - for simple blocks (notably those that do not perform any db query),
 * where querying the db cache would be more expensive than directly generating
 * the content.
 * - for blocks that change too frequently.
 */
define('BLOCK_NO_CACHE', -1);

/**
41 42 43
 * The block can change depending on the roles the user viewing the page belongs to.
 * This is the default setting, used when the block does not specify anything.
 */
44 45 46
define('BLOCK_CACHE_PER_ROLE', 0x0001);

/**
47 48 49 50
 * The block can change depending on the user viewing the page.
 * This setting can be resource-consuming for sites with large number of users,
 * and thus should only be used when BLOCK_CACHE_PER_ROLE is not sufficient.
 */
51 52 53
define('BLOCK_CACHE_PER_USER', 0x0002);

/**
54 55
 * The block can change depending on the page being viewed.
 */
56 57 58 59 60 61 62
define('BLOCK_CACHE_PER_PAGE', 0x0004);

/**
 * The block is the same for every user on every page where it is visible.
 */
define('BLOCK_CACHE_GLOBAL', 0x0008);

Dries's avatar
 
Dries committed
63 64 65
/**
 * Implementation of hook_help().
 */
66 67
function block_help($path, $arg) {
  switch ($path) {
Dries's avatar
 
Dries committed
68
    case 'admin/help#block':
69
      $output = '<p>' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Garland, for example, implements the regions "left sidebar", "right sidebar", "content", "header", and "footer", and a block may appear in any one of these areas. 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.', array('@blocks' => url('admin/build/block'))) . '</p>';
70
      $output .= '<p>' . t('Although blocks are usually generated automatically by modules (like the <em>User login</em> block, for example), administrators can also define custom blocks. Custom blocks have a title, description, and body. The body of the block can be as long as necessary, and can contain content supported by any available <a href="@text-format">text format</a>.', array('@text-format' => url('admin/settings/filter'))) . '</p>';
71 72 73 74 75 76 77 78 79
      $output .= '<p>' . t('When working with blocks, remember that:') . '</p>';
      $output .= '<ul><li>' . t('since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis.') . '</li>';
      $output .= '<li>' . t('disabled blocks, or blocks not in a region, are never shown.') . '</li>';
      $output .= '<li>' . t('blocks can be configured to be visible only on certain pages.') . '</li>';
      $output .= '<li>' . t('blocks can be configured to be visible only when specific conditions are true.') . '</li>';
      $output .= '<li>' . t('blocks can be configured to be visible only for certain user roles.') . '</li>';
      $output .= '<li>' . t('when allowed by an administrator, specific blocks may be enabled or disabled on a per-user basis using the <em>My account</em> page.') . '</li>';
      $output .= '<li>' . t('some dynamic blocks, such as those generated by modules, will be displayed only on certain pages.') . '</li></ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@block">Block module</a>.', array('@block' => 'http://drupal.org/handbook/modules/block/')) . '</p>';
80
      return $output;
81
    case 'admin/build/block':
82 83
      $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. To change the region or order of a block, grab a drag-and-drop handle under the <em>Block</em> column and drag the block to a new location in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) 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.') . '</p>';
      $output .= '<p>' . t('Click the <em>configure</em> link next to each block to configure its specific title and visibility settings. Use the <a href="@add-block">add block page</a> to create a custom block.', array('@add-block' => url('admin/build/block/add'))) . '</p>';
84
      return $output;
85
    case 'admin/build/block/add':
86
      return '<p>' . t('Use this page to create a new custom block. New blocks are disabled by default, and must be moved to a region on the <a href="@blocks">blocks administration page</a> to be visible.', array('@blocks' => url('admin/build/block'))) . '</p>';
Dries's avatar
 
Dries committed
87
  }
Dries's avatar
 
Dries committed
88 89
}

90
/**
91
 * Implementation of hook_theme().
92 93 94
 */
function block_theme() {
  return array(
95 96
    'block_admin_display_form' => array(
      'template' => 'block-admin-display-form',
97
      'file' => 'block.admin.inc',
98 99 100 101 102
      'arguments' => array('form' => NULL),
    ),
  );
}

Dries's avatar
 
Dries committed
103 104 105
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
106
function block_perm() {
107
  return array(
108 109 110 111 112 113 114 115
    'administer blocks' => array(
      'title' => t('Administer blocks'),
      'description' => t('Select which blocks are displayed, and arrange them on the page.'),
    ),
    'use PHP for block visibility' => array(
      'title' => t('Use PHP for block visibility'),
      'description' => t('Enter PHP code in the field for block visibility settings. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
116
  );
Dries's avatar
 
Dries committed
117 118
}

Dries's avatar
 
Dries committed
119
/**
Dries's avatar
 
Dries committed
120
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
121
 */
122 123
function block_menu() {
  $items['admin/build/block'] = array(
124 125
    'title' => 'Blocks',
    'description' => 'Configure what block content appears in your site\'s sidebars and other regions.',
126
    'page callback' => 'block_admin_display',
127 128 129
    'access arguments' => array('administer blocks'),
  );
  $items['admin/build/block/list'] = array(
130
    'title' => 'List',
131 132 133
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
134
  $items['admin/build/block/list/js'] = array(
135
    'title' => 'JavaScript List Form',
136
    'page callback' => 'block_admin_display_js',
137
    'access arguments' => array('administer blocks'),
138 139
    'type' => MENU_CALLBACK,
  );
140
  $items['admin/build/block/configure'] = array(
141
    'title' => 'Configure block',
142
    'page callback' => 'drupal_get_form',
143
    'page arguments' => array('block_admin_configure'),
144
    'access arguments' => array('administer blocks'),
145 146 147
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/block/delete'] = array(
148
    'title' => 'Delete block',
149
    'page callback' => 'drupal_get_form',
150
    'page arguments' => array('block_box_delete'),
151
    'access arguments' => array('administer blocks'),
152 153 154
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/block/add'] = array(
155
    'title' => 'Add block',
156
    'page callback' => 'drupal_get_form',
157
    'page arguments' => array('block_add_block_form'),
158
    'access arguments' => array('administer blocks'),
159 160 161 162
    'type' => MENU_LOCAL_TASK,
  );
  $default = variable_get('theme_default', 'garland');
  foreach (list_themes() as $key => $theme) {
163
    $items['admin/build/block/list/' . $key] = array(
164 165 166 167 168 169 170
      'title' => check_plain($theme->info['name']),
      'page arguments' => array($key),
      'type' => $key == $default ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK,
      'weight' => $key == $default ? -10 : 0,
      'access callback' => '_block_themes_access',
      'access arguments' => array($theme),
    );
Dries's avatar
 
Dries committed
171
  }
Dries's avatar
 
Dries committed
172
  return $items;
Dries's avatar
 
Dries committed
173 174
}

175
/**
176
 * Menu item access callback - only admin or enabled themes can be accessed.
177 178
 */
function _block_themes_access($theme) {
179
  return user_access('administer blocks') && ($theme->status || $theme->name == variable_get('admin_theme', 0));
180 181
}

Dries's avatar
 
Dries committed
182
/**
183
 * Implementation of hook_block_list().
Dries's avatar
 
Dries committed
184
 */
185 186
function block_block_list() {
  $blocks = array();
187

188 189 190 191 192 193 194 195
  $result = db_query('SELECT bid, info FROM {box} ORDER BY info');
  while ($block = db_fetch_object($result)) {
    $blocks[$block->bid]['info'] = $block->info;
    // Not worth caching.
    $blocks[$block->bid]['cache'] = BLOCK_NO_CACHE;
  }
  return $blocks;
}
196

197 198 199 200 201 202 203 204 205 206
/**
 * Implementation of hook_block_configure().
 */
function block_block_configure($delta = 0, $edit = array()) {
  $box = array('format' => FILTER_FORMAT_DEFAULT);
  if ($delta) {
    $box = block_box_get($delta);
  }
  if (filter_access($box['format'])) {
    return block_box_form($box);
207 208 209
  }
}

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
/**
 * Implementation of hook_block_save().
 */
function block_block_save($delta = 0, $edit = array()) {
  block_box_save($edit, $delta);
}

/**
 * Implementation of hook_block_view().
 *
 * Generates the administrator-defined blocks for display.
 */
function block_block_view($delta = 0, $edit = array()) {
  $block = db_fetch_object(db_query('SELECT body, format FROM {box} WHERE bid = %d', $delta));
  $data['content'] = check_markup($block->body, $block->format, '', FALSE);
  return $data;
}

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/**
 * Implementation of hook_page_alter().
 *
 * Render blocks into their regions.
 */
function block_page_alter($page) {
  global $theme;

  // The theme system might not yet be initialized. We need $theme.
  init_theme();

  // Populate all block regions
  $regions = system_region_list($theme);

  // Load all region content assigned via blocks.
  foreach (array_keys($regions) as $region) {
    // Prevent left and right regions from rendering blocks when 'show_blocks' == FALSE.
    if ($page['#show_blocks'] || ($region != 'left' && $region != 'right')) {
      // Assign blocks to region.
      if ($blocks = block_get_blocks_by_region($region)) {
        $page[$region]['blocks'] = $blocks;
      }

      // Append region description if we are rendering the block admin page.
      $item = menu_get_item();
      if ($item['path'] == 'admin/build/block') {
        $description = '<div class="block-region">' . $regions[$region] . '</div>';
        $page[$region]['blocks']['block_description'] = array('#markup' => $description);
      }
    }
  }
}

/**
 * Get a renderable array of a region containing all enabled blocks.
 *
 * @param $region
 *   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] = array(
        '#theme' => 'block',
        '#block' => $block,
        '#weight' => ++$weight,
      );
    }
    $build['#sorted'] = TRUE;
  }
  return $build;
}

Dries's avatar
 
Dries committed
283
/**
284
 * Update the 'block' DB table with the blocks currently exported by modules.
Dries's avatar
 
Dries committed
285
 *
Dries's avatar
 
Dries committed
286
 * @return
287
 *   Blocks currently exported by modules.
Dries's avatar
 
Dries committed
288
 */
289
function _block_rehash() {
290 291
  global $theme_key;

292
  init_theme();
293

294
  $result = db_query("SELECT * FROM {block} WHERE theme = '%s'", $theme_key);
295 296 297
  $old_blocks = array();
  while ($old_block = db_fetch_array($result)) {
    $old_blocks[$old_block['module']][$old_block['delta']] = $old_block;
Dries's avatar
 
Dries committed
298 299
  }

300
  $blocks = array();
301 302
  // Valid region names for the theme.
  $regions = system_region_list($theme_key);
Dries's avatar
 
Dries committed
303

304 305
  foreach (module_implements('block_list') as $module) {
    $module_blocks = module_invoke($module, 'block_list');
Dries's avatar
 
Dries committed
306 307
    if ($module_blocks) {
      foreach ($module_blocks as $delta => $block) {
308 309 310 311 312
        if (empty($old_blocks[$module][$delta])) {
          // If it's a new block, add identifiers.
          $block['module'] = $module;
          $block['delta']  = $delta;
          $block['theme']  = $theme_key;
313 314 315 316 317 318
          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']  = '';
          }
319
          // Add defaults and save it into the database.
320
          drupal_write_record('block', $block);
321 322 323
          // Set region to none if not enabled.
          $block['region'] = $block['status'] ? $block['region'] : BLOCK_REGION_NONE;
          // Add to the list of blocks we return.
324
          $blocks[] = $block;
Dries's avatar
 
Dries committed
325 326
        }
        else {
327 328 329 330 331 332
          // If it's an existing block, database settings should overwrite
          // the code. But aside from 'info' everything that's definable in
          // code is stored in the database and we do not store 'info', so we
          // do not need to update the database here.
          // Add 'info' to this block.
          $old_blocks[$module][$delta]['info'] = $block['info'];
333 334 335 336 337 338 339 340 341
          // If the region name does not exist, disable the block and assign it to none.
          if (!empty($old_blocks[$module][$delta]['region']) && !isset($regions[$old_blocks[$module][$delta]['region']])) {
            drupal_set_message(t('The block %info was assigned to the invalid region %region and has been disabled.', array('%info' => $old_blocks[$module][$delta]['info'], '%region' => $old_blocks[$module][$delta]['region'])), 'warning');
            $old_blocks[$module][$delta]['status'] = 0;
            $old_blocks[$module][$delta]['region'] = BLOCK_REGION_NONE;
          }
          else {
            $old_blocks[$module][$delta]['region'] = $old_blocks[$module][$delta]['status'] ? $old_blocks[$module][$delta]['region'] : BLOCK_REGION_NONE;
          }
342
          // Add this block to the list of blocks we return.
343 344 345
          $blocks[] = $old_blocks[$module][$delta];
          // Remove this block from the list of blocks to be deleted.
          unset($old_blocks[$module][$delta]);
Dries's avatar
 
Dries committed
346 347 348 349 350
        }
      }
    }
  }

351 352 353
  // Remove blocks that are no longer defined by the code from the database.
  foreach ($old_blocks as $module => $old_module_blocks) {
    foreach ($old_module_blocks as $delta => $block) {
354
      db_query("DELETE FROM {block} WHERE module = '%s' AND delta = '%s' AND theme = '%s'", $module, $delta, $theme_key);
355
    }
356
  }
Dries's avatar
 
Dries committed
357 358
  return $blocks;
}
Dries's avatar
 
Dries committed
359

360
function block_box_get($bid) {
361
  return db_fetch_array(db_query("SELECT * FROM {box} WHERE bid = %d", $bid));
Dries's avatar
 
Dries committed
362 363
}

364 365 366
/**
 * Define the custom block form.
 */
367
function block_box_form($edit = array()) {
368 369 370 371
  $edit += array(
    'info' => '',
    'body' => '',
  );
372 373 374
  $form['info'] = array(
    '#type' => 'textfield',
    '#title' => t('Block description'),
375
    '#default_value' => $edit['info'],
376
    '#maxlength' => 64,
377
    '#description' => t('A brief description of your block. Used on the <a href="@overview">block overview page</a>.', array('@overview' => url('admin/build/block'))),
378 379 380
    '#required' => TRUE,
    '#weight' => -19,
  );
381 382
  $form['body_field']['#weight'] = -17;
  $form['body_field']['body'] = array(
383 384
    '#type' => 'textarea',
    '#title' => t('Block body'),
385
    '#default_value' => $edit['body'],
386
    '#text_format' => isset($edit['format']) ? $edit['format'] : FILTER_FORMAT_DEFAULT,
387 388
    '#rows' => 15,
    '#description' => t('The content of the block as shown to the user.'),
389
    '#required' => TRUE,
390 391
    '#weight' => -17,
  );
392

393
  return $form;
394 395
}

396
function block_box_save($edit, $delta) {
397 398
  if (!filter_access($edit['body_format'])) {
    $edit['body_format'] = FILTER_FORMAT_DEFAULT;
Dries's avatar
 
Dries committed
399 400
  }

401
  db_query("UPDATE {box} SET body = '%s', info = '%s', format = %d WHERE bid = %d", $edit['body'], $edit['info'], $edit['body_format'], $delta);
402

403
  return TRUE;
404 405
}

Dries's avatar
 
Dries committed
406
/**
407
 * Implementation of hook_user_form().
Dries's avatar
 
Dries committed
408
 */
409 410 411
function block_user_form(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
    $rids = array_keys($account->roles);
412
    $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));
413 414
    $form['block'] = array('#type' => 'fieldset', '#title' => t('Block configuration'), '#weight' => 3, '#collapsible' => TRUE, '#tree' => TRUE);
    while ($block = db_fetch_object($result)) {
415
      $data = module_invoke($block->module, 'block_list');
416 417 418
      if ($data[$block->delta]['info']) {
        $return = TRUE;
        $form['block'][$block->module][$block->delta] = array('#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));
419
      }
420
    }
Dries's avatar
 
Dries committed
421

422 423 424 425 426 427 428 429 430 431 432 433
    if (!empty($return)) {
      return $form;
    }
  }
}

/**
 * Implementation of hook_user_validate().
 */
function block_user_validate(&$edit, &$account, $category = NULL) {
  if (empty($edit['block'])) {
    $edit['block'] = array();
434
  }
435
  return $edit;
436 437
}

438 439 440 441 442 443 444 445 446 447 448 449 450
/**
 * 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
451 452
 *   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>.
453 454
 */
function block_list($region) {
455 456
  static $blocks = array();

457
  if (!count($blocks)) {
458 459 460
    $blocks = _block_load_blocks();
  }

461
  // Create an empty array if there were no entries.
462 463 464 465 466 467 468 469 470 471
  if (!isset($blocks[$region])) {
    $blocks[$region] = array();
  }

  $blocks[$region] = _block_render_blocks($blocks[$region]);

  return $blocks[$region];
}

/**
472
 * Load blocks information from the database.
473 474 475 476 477 478
 */
function _block_load_blocks() {
  global $user, $theme_key;

  $blocks = array();
  $rids = array_keys($user->roles);
479
  $result = db_query(db_rewrite_sql("SELECT DISTINCT b.* FROM {block} b LEFT JOIN {block_role} r ON b.module = r.module AND b.delta = r.delta WHERE b.theme = '%s' AND b.status = 1 AND (r.rid IN (" . db_placeholders($rids) . ") OR r.rid IS NULL) ORDER BY b.region, b.weight, b.module", 'b', 'bid'), array_merge(array($theme_key), $rids));
480 481 482 483
  while ($block = db_fetch_object($result)) {
    if (!isset($blocks[$block->region])) {
      $blocks[$block->region] = array();
    }
484
    // Use the user's block visibility setting, if necessary.
485 486 487
    if ($block->custom != 0) {
      if ($user->uid && isset($user->block[$block->module][$block->delta])) {
        $enabled = $user->block[$block->module][$block->delta];
488 489
      }
      else {
490
        $enabled = ($block->custom == 1);
491
      }
492 493 494 495
    }
    else {
      $enabled = TRUE;
    }
496

497
    // Match path if necessary.
498 499 500 501 502 503 504
    if ($block->pages) {
      if ($block->visibility < 2) {
        $path = drupal_get_path_alias($_GET['q']);
        // Compare with the internal and path alias (if any).
        $page_match = drupal_match_path($path, $block->pages);
        if ($path != $_GET['q']) {
          $page_match = $page_match || drupal_match_path($_GET['q'], $block->pages);
505
        }
506 507 508 509
        // 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);
510 511
      }
      else {
512
        $page_match = drupal_eval($block->pages);
513
      }
514 515 516 517 518 519 520 521
    }
    else {
      $page_match = TRUE;
    }
    $block->enabled = $enabled;
    $block->page_match = $page_match;
    $blocks[$block->region]["{$block->module}_{$block->delta}"] = $block;
  }
522

523 524
  return $blocks;
}
525

526 527 528 529
/**
 * Render the content and subject for a set of blocks.
 *
 * @param $region_blocks
530
 *   An array of block objects such as returned for one region by _block_load_blocks().
531 532
 *
 * @return
533
 *   An array of visible blocks with subject and content rendered.
534 535 536 537 538 539 540 541
 */
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.
      unset($region_blocks[$key]);
      if ($block->enabled && $block->page_match) {
542 543
        // Try fetching the block from cache. Block caching is not compatible with
        // node_access modules. We also preserve the submission of forms in blocks,
544 545
        // 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'))) {
546 547 548
          $array = $cache->data;
        }
        else {
549
          $array = module_invoke($block->module, 'block_view', $block->delta);
550 551
          if (isset($cid)) {
            cache_set($cid, $array, 'cache_block', CACHE_TEMPORARY);
552
          }
553
        }
554

555 556 557
        if (isset($array) && is_array($array)) {
          foreach ($array as $k => $v) {
            $block->$k = $v;
558
          }
Dries's avatar
 
Dries committed
559
        }
560
        if (isset($block->content) && $block->content) {
561 562 563 564 565
          // 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);
          }
566 567 568
          if (!isset($block->subject)) {
            $block->subject = '';
          }
569
          $region_blocks["{$block->module}_{$block->delta}"] = $block;
570 571 572 573
        }
      }
    }
  }
574
  return $region_blocks;
575
}
576 577 578 579 580 581 582 583 584 585

/**
 * 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.
 *
586
 * Theme and language contexts are automatically differentiated.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
 *
 * @param $block
 * @return
 *   The string used as cache_id for the block.
 */
function _block_get_cache_id($block) {
  global $theme, $base_root, $user;

  // 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.
  if (variable_get('block_cache', 0) && $block->cache != BLOCK_NO_CACHE && $user->uid != 1) {
    $cid_parts = array();

    // Start with common sub-patterns: block identification, theme, language.
    $cid_parts[] = $block->module;
    $cid_parts[] = $block->delta;
    $cid_parts[] = $theme;
    if (module_exists('locale')) {
      global $language;
      $cid_parts[] = $language->language;
    }

    // 'PER_ROLE' and 'PER_USER' are mutually exclusive. 'PER_USER' can be a
    // resource drag for sites with many users, so when a module is being
    // equivocal, we favor the less expensive 'PER_ROLE' pattern.
    if ($block->cache & BLOCK_CACHE_PER_ROLE) {
615
      $cid_parts[] = 'r.' . implode(',', array_keys($user->roles));
616 617 618 619 620 621 622 623 624 625 626
    }
    elseif ($block->cache & BLOCK_CACHE_PER_USER) {
      $cid_parts[] = "u.$user->uid";
    }

    if ($block->cache & BLOCK_CACHE_PER_PAGE) {
      $cid_parts[] = $base_root . request_uri();
    }

    return implode(':', $cid_parts);
  }
627
}
628 629 630 631 632 633 634

/**
 * Implementation of hook_flush_caches().
 */
function block_flush_caches() {
  return array('cache_block');
}