block.module 32.3 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
 * Implement hook_help().
Dries's avatar
   
Dries committed
65
 */
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/structure/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/structure/block':
82
      $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.') . '</p>';
83
      $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/structure/block/add'))) . '</p>';
84
      return $output;
85
86
    case 'admin/structure/block/add':
      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/structure/block'))) . '</p>';
Dries's avatar
   
Dries committed
87
  }
Dries's avatar
   
Dries committed
88
89
}

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

Dries's avatar
   
Dries committed
107
/**
108
 * Implement hook_permission().
Dries's avatar
   
Dries committed
109
 */
110
function block_permission() {
111
  return array(
112
113
114
115
    'administer blocks' => array(
      'title' => t('Administer blocks'),
      'description' => t('Select which blocks are displayed, and arrange them on the page.'),
    ),
116
  );
Dries's avatar
   
Dries committed
117
118
}

Dries's avatar
   
Dries committed
119
/**
120
 * Implement hook_menu().
Dries's avatar
   
Dries committed
121
 */
122
function block_menu() {
123
  $items['admin/structure/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
    'access arguments' => array('administer blocks'),
  );
129
  $items['admin/structure/block/list'] = array(
130
    'title' => 'List',
131
132
133
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
134
  $items['admin/structure/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/structure/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
    'type' => MENU_CALLBACK,
  );
147
  $items['admin/structure/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
    'type' => MENU_CALLBACK,
  );
154
  $items['admin/structure/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/structure/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
180
  $admin_theme = variable_get('admin_theme');
  return user_access('administer blocks') && ($theme->status || ($admin_theme && ($theme->name == $admin_theme)));
181
182
}

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

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

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

209
/**
210
 * Implement hook_block_save().
211
212
213
214
215
216
 */
function block_block_save($delta = 0, $edit = array()) {
  block_box_save($edit, $delta);
}

/**
217
 * Implement hook_block_view().
218
219
220
221
 *
 * Generates the administrator-defined blocks for display.
 */
function block_block_view($delta = 0, $edit = array()) {
222
  $block = db_query('SELECT body, format FROM {box} WHERE bid = :bid', array(':bid' => $delta))->fetchObject();
223
224
225
226
  $data['content'] = check_markup($block->body, $block->format, '', FALSE);
  return $data;
}

227
/**
228
 * Implement hook_page_alter().
229
230
231
232
233
234
235
 *
 * Render blocks into their regions.
 */
function block_page_alter($page) {
  global $theme;

  // The theme system might not yet be initialized. We need $theme.
236
  drupal_theme_initialize();
237
238

  // Populate all block regions
239
240
  $all_regions = system_region_list($theme);
  $visible_regions = system_region_list($theme, REGIONS_VISIBLE);
241
242

  // Load all region content assigned via blocks.
243
  foreach (array_keys($all_regions) as $region) {
244
245
    // Prevent sidebar regions from rendering blocks when 'show_blocks' == FALSE.
    if (!empty($page['#show_blocks']) || (strpos($region, 'sidebar_') !== 0)) {
246
247
      // Assign blocks to region.
      if ($blocks = block_get_blocks_by_region($region)) {
248
        $page[$region] = $blocks;
249
250
251
252
      }

      // Append region description if we are rendering the block admin page.
      $item = menu_get_item();
253
      if ($item['path'] == 'admin/structure/block' && isset($visible_regions[$region])) {
254
        $description = '<div class="block-region">' . $all_regions[$region] . '</div>';
255
256
257
258
        $page[$region]['block_description'] = array(
          '#markup' => $description,
          '#weight' => 15,
        );
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
      }
    }
  }
}

/**
 * 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) {
275
276
277
      $build[$key] = $block->content;
      unset($block->content);
      $build[$key] += array(
278
        '#theme_wrappers' => array('block'),
279
280
281
282
283
284
285
286
287
        '#block' => $block,
        '#weight' => ++$weight,
      );
    }
    $build['#sorted'] = TRUE;
  }
  return $build;
}

Dries's avatar
   
Dries committed
288
/**
289
 * Update the 'block' DB table with the blocks currently exported by modules.
Dries's avatar
   
Dries committed
290
 *
Dries's avatar
   
Dries committed
291
 * @return
292
 *   Blocks currently exported by modules.
Dries's avatar
   
Dries committed
293
 */
294
function _block_rehash() {
295
296
  global $theme_key;

297
  drupal_theme_initialize();
298

299
  $old_blocks = array();
300
301
302
  $result = db_query("SELECT * FROM {block} WHERE theme = :theme", array(':theme' => $theme_key));
  foreach ($result as $old_block) {
    $old_block = is_object($old_block) ? get_object_vars($old_block) : $old_block;
303
    $old_blocks[$old_block['module']][$old_block['delta']] = $old_block;
Dries's avatar
   
Dries committed
304
305
  }

306
  $blocks = array();
307
308
  // Valid region names for the theme.
  $regions = system_region_list($theme_key);
Dries's avatar
   
Dries committed
309

310
311
  foreach (module_implements('block_list') as $module) {
    $module_blocks = module_invoke($module, 'block_list');
Dries's avatar
   
Dries committed
312
313
    if ($module_blocks) {
      foreach ($module_blocks as $delta => $block) {
314
315
316
317
318
        if (empty($old_blocks[$module][$delta])) {
          // If it's a new block, add identifiers.
          $block['module'] = $module;
          $block['delta']  = $delta;
          $block['theme']  = $theme_key;
319
320
321
322
323
324
          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']  = '';
          }
325
          // Add defaults and save it into the database.
326
          drupal_write_record('block', $block);
327
328
329
          // Set region to none if not enabled.
          $block['region'] = $block['status'] ? $block['region'] : BLOCK_REGION_NONE;
          // Add to the list of blocks we return.
330
          $blocks[] = $block;
Dries's avatar
   
Dries committed
331
332
        }
        else {
333
334
335
336
337
338
          // 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'];
339
340
341
342
343
344
345
346
347
          // 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;
          }
348
          // Add this block to the list of blocks we return.
349
350
351
          $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
352
353
354
355
356
        }
      }
    }
  }

357
358
359
  // 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) {
360
361
362
363
364
      db_delete('block')
        ->condition('module', $module)
        ->condition('delta', $delta)
        ->condition('theme', $theme_key)
        ->execute();
365
    }
366
  }
Dries's avatar
   
Dries committed
367
368
  return $blocks;
}
Dries's avatar
   
Dries committed
369

370
function block_box_get($bid) {
371
  return db_query("SELECT * FROM {box} WHERE bid = :bid", array(':bid' => $bid))->fetchAssoc();
Dries's avatar
   
Dries committed
372
373
}

374
375
376
/**
 * Define the custom block form.
 */
377
function block_box_form($edit = array()) {
378
379
380
381
  $edit += array(
    'info' => '',
    'body' => '',
  );
382
383
384
  $form['info'] = array(
    '#type' => 'textfield',
    '#title' => t('Block description'),
385
    '#default_value' => $edit['info'],
386
    '#maxlength' => 64,
387
    '#description' => t('A brief description of your block. Used on the <a href="@overview">blocks administration page</a>.', array('@overview' => url('admin/structure/block'))),
388
389
390
    '#required' => TRUE,
    '#weight' => -19,
  );
391
392
  $form['body_field']['#weight'] = -17;
  $form['body_field']['body'] = array(
393
394
    '#type' => 'textarea',
    '#title' => t('Block body'),
395
    '#default_value' => $edit['body'],
396
    '#text_format' => isset($edit['format']) ? $edit['format'] : FILTER_FORMAT_DEFAULT,
397
398
    '#rows' => 15,
    '#description' => t('The content of the block as shown to the user.'),
399
    '#required' => TRUE,
400
    '#weight' => -17,
401
    '#access' => filter_access($edit['format']),
402
  );
403

404
  return $form;
405
406
}

407
function block_box_save($edit, $delta) {
408
409
410
411
412
413
414
415
  db_update('box')
    ->fields(array(
      'body' => $edit['body'],
      'info' => $edit['info'],
      'format' => $edit['body_format'],
    ))
    ->condition('bid', $delta)
    ->execute();
416
  return TRUE;
417
418
}

Dries's avatar
   
Dries committed
419
/**
420
 * Implement hook_user_form().
Dries's avatar
   
Dries committed
421
 */
422
423
424
function block_user_form(&$edit, &$account, $category = NULL) {
  if ($category == 'account') {
    $rids = array_keys($account->roles);
425
    $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));
426
427
428
429
430
431
432
433
    $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
    );
434
    foreach ($result as $block) {
435
      $data = module_invoke($block->module, 'block_list');
436
437
      if ($data[$block->delta]['info']) {
        $return = TRUE;
438
439
440
441
442
        $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),
        );
443
      }
444
    }
Dries's avatar
   
Dries committed
445

446
447
448
449
450
451
452
    if (!empty($return)) {
      return $form;
    }
  }
}

/**
453
 * Implement hook_user_validate().
454
455
456
457
 */
function block_user_validate(&$edit, &$account, $category = NULL) {
  if (empty($edit['block'])) {
    $edit['block'] = array();
458
  }
459
  return $edit;
460
461
}

462
/**
463
 * Implement hook_form_FORM_ID_alter().
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 */
function block_form_system_performance_settings_alter(&$form, &$form_state) {

  // Add the block cache fieldset on the performance settings page.
  $form['block_cache'] = array(
    '#type' => 'fieldset',
    '#title' => t('Block cache'),
    '#description' => t('Enabling the block cache can offer a performance increase for all users by preventing blocks from being reconstructed on each page load. If the page cache is also enabled, performance increases from enabling the block cache will mainly benefit authenticated users.'),
    '#weight' => 0,
  );

  $form['block_cache']['block_cache'] = array(
    '#type' => 'radios',
    '#title' => t('Block cache'),
    '#default_value' => variable_get('block_cache', CACHE_DISABLED),
    '#options' => array(CACHE_DISABLED => t('Disabled'), CACHE_NORMAL => t('Enabled (recommended)')),
    '#disabled' => count(module_implements('node_grants')),
    '#description' => t('Note that block caching is inactive when modules defining content access restrictions are enabled.'),
  );
483

484
  // Check if the "Who's online" block is enabled.
485
  $online_block_enabled = db_query_range("SELECT 1 FROM {block} b WHERE module = 'user' AND delta = 'online' AND status = 1", array(), 0, 1)->fetchField();
486

487
488
489
490
491
  // If the "Who's online" block is enabled, append some descriptive text to
  // the end of the form description.
  if ($online_block_enabled) {
    $form['page_cache']['cache']['#description'] .=  '<p>' . t('When caching is enabled, anonymous user sessions are only saved to the database when needed, so the "Who\'s online" block does not display the number of anonymous users.') . '</p>';
  }
492

493
494
}

495
/**
496
 * Implement hook_form_FORM_ID_alter().
497
498
 */
function block_form_system_themes_form_alter(&$form, &$form_state) {
499
500
501
502
  // This function needs to fire before the theme changes are recorded in the
  // database, otherwise it will populate the default list of blocks from the
  // new theme, which is empty.
  array_unshift($form['#submit'], 'block_system_themes_form_submit');
503
504
505
506
507
508
509
510
511
512
}

/**
 * Initialize blocks for enabled themes.
 */
function block_system_themes_form_submit(&$form, &$form_state) {
  if ($form_state['values']['op'] == t('Save configuration')) {
    if (is_array($form_state['values']['status'])) {
      foreach ($form_state['values']['status'] as $key => $choice) {
        if ($choice || $form_state['values']['theme_default'] == $key) {
513
          block_theme_initialize($key);
514
515
516
        }
      }
    }
517
    if ($form_state['values']['admin_theme'] && $form_state['values']['admin_theme'] !== variable_get('admin_theme', 0)) {
518
      // If we're changing themes, make sure the theme has its blocks initialized.
519
520
      $has_blocks = (bool) db_query_range('SELECT 1 FROM {block} WHERE theme = :theme', array(':theme' => $form_state['values']['admin_theme']), 0, 1)->fetchField();
      if (!$has_blocks) {
521
        block_theme_initialize($form_state['values']['admin_theme']);
522
523
524
525
526
527
528
      }
    }
  }
}

/**
 * Assign an initial, default set of blocks for a theme.
529
 *
530
531
532
533
 * 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.
534
 *
535
536
537
 * @param $theme
 *   The name of a theme.
 */
538
function block_theme_initialize($theme) {
539
  // Initialize theme's blocks if none already registered.
540
541
  $has_blocks = (bool) db_query_range('SELECT 1 FROM {block} WHERE theme = :theme', array(':theme' => $theme), 0, 1)->fetchField();
  if (!$has_blocks) {
542
543
    $default_theme = variable_get('theme_default', 'garland');
    $regions = system_region_list($theme);
544
545
546
    $result = db_query("SELECT * FROM {block} WHERE theme = :theme", array(':theme' => $default_theme), array('fetch' => PDO::FETCH_ASSOC));
    $query = db_insert('block')->fields(array('module', 'delta', 'theme', 'status', 'weight', 'region', 'visibility', 'pages', 'custom', 'cache'));
    foreach ($result as $block) {
547
548
549
550
      // 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);
      }
551
552
      $block['theme'] = $theme;
      $query->values($block);
553
    }
554
    $query->execute();
555
556
557
  }
}

558
559
560
561
562
563
564
565
566
567
568
569
570
/**
 * 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
571
572
 *   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>.
573
574
 */
function block_list($region) {
575
  $blocks = &drupal_static(__FUNCTION__, array());
576

577
  if (empty($blocks)) {
578
579
580
    $blocks = _block_load_blocks();
  }

581
  // Create an empty array if there were no entries.
582
583
584
585
586
587
588
589
590
591
  if (!isset($blocks[$region])) {
    $blocks[$region] = array();
  }

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

  return $blocks[$region];
}

/**
592
 * Load blocks information from the database.
593
594
 */
function _block_load_blocks() {
595
  global $theme_key;
596

597
598
599
600
601
602
603
604
605
606
  $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')
    ->execute();
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621

  $block_list = $result->fetchAllAssoc('bid');
  // Allow modules to modify the block list.
  drupal_alter('block_list', $block_list);

  $blocks = array();
  foreach ($block_list as $block) {
    $blocks[$block->region]["{$block->module}_{$block->delta}"] = $block;
  }
  return $blocks;
}

/**
 * Implement hook_block_list_alter().
 *
622
623
 * Check the page, user role, content type and user specific visibilty settings.
 * Remove the block if the visibility conditions are not met.
624
625
626
627
628
629
630
631
632
633
634
 */
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;
  }

635
636
637
638
639
640
641
  // Build an array of node types for each block.
  $block_node_types = array();
  $result = db_query('SELECT module, delta, type FROM {block_node_type}');
  foreach ($result as $record) {
    $block_node_types[$record->module][$record->delta][] = $record->type;
  }

642
643
644
645
  foreach ($blocks as $key => $block) {
    if ($block->theme != $theme_key || $block->status != 1) {
      // This block was added by a contrib module, leave it in the list.
      continue;
646
    }
647
648
649
650

    // 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.
651
    if (isset($block_roles[$block->module][$block->delta]) && !array_intersect($block_roles[$block->module][$block->delta], array_keys($user->roles))) {
652
653
654
      // No match.
      unset($blocks[$key]);
      continue;
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
    }

    // If a block has no node types associated, it is displayed for every type.
    // For blocks with node types associated, if the node type does not match
    // the settings from this block, remove it from the block list.
    if (isset($block_node_types[$block->module][$block->delta])) {
      $node = menu_get_object();
      if (!empty($node)) {
        // This is a node or node edit page.
        if (!in_array($node->type, $block_node_types[$block->module][$block->delta])) {
          // This block should not be displayed for this node type.
          unset($blocks[$key]);
          continue;
        }
      }
      elseif (arg(0) == 'node' && arg(1) == 'add' && in_array(arg(2), array_keys(node_type_get_types()))) {
        // This is a node creation page
        if (!in_array(arg(2), $block_node_types[$block->module][$block->delta])) {
          // This block should not be displayed for this node type.
          unset($blocks[$key]);
          continue;
        }
      }
      else {
        // This is not a node page, remove the block.
        unset($blocks[$key]);
        continue;
      }
    }
684

685
    // Use the user's block visibility setting, if necessary.
686
687
688
    if ($block->custom != 0) {
      if ($user->uid && isset($user->block[$block->module][$block->delta])) {
        $enabled = $user->block[$block->module][$block->delta];
689
690
      }
      else {
691
        $enabled = ($block->custom == 1);
692
      }
693
694
695
696
    }
    else {
      $enabled = TRUE;
    }
697
698
699
700
    if (!$enabled) {
      unset($blocks[$key]);
      continue;
    }
701

702
    // Match path if necessary.
703
704
705
706
707
708
709
    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);
710
        }
711
712
713
714
        // 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);
715
      }
716
717
718
      elseif (module_exists('php')) {
        $page_match = php_eval($block->pages);
      }
719
      else {
720
        $page_match = FALSE;
721
      }
722
723
724
725
    }
    else {
      $page_match = TRUE;
    }
726
727
728
    if (!$page_match) {
      unset($blocks[$key]);
    }
729
730
  }
}
731

732
733
734
735
/**
 * Render the content and subject for a set of blocks.
 *
 * @param $region_blocks
736
 *   An array of block objects such as returned for one region by _block_load_blocks().
737
738
 *
 * @return
739
 *   An array of visible blocks with subject and content rendered.
740
741
742
743
744
 */
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)) {
745
746
      // Erase the block from the static array - we'll put it back if it has
      // content.
747
      unset($region_blocks[$key]);
748
749
750
751
752
753
754
755
756
757
758
      // 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);
        if (isset($cid)) {
          cache_set($cid, $array, 'cache_block', CACHE_TEMPORARY);
759
        }
760
      }
761

762
763
764
      if (isset($array) && is_array($array)) {
        foreach ($array as $k => $v) {
          $block->$k = $v;
Dries's avatar
   
Dries committed
765
        }
766
767
      }
      if (isset($block->content) && $block->content) {
768
769
        // Normalize to the drupal_render() structure.
        $block->content = array('content' => is_string($block->content) ? array('#markup' => $block->content) : $block->content);
770
771
772
773
774
775
776
777
        // 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 = '';
778
        }
779
        $region_blocks["{$block->module}_{$block->delta}"] = $block;
780
781
782
      }
    }
  }
783
  return $region_blocks;
784
}
785
786
787
788
789
790
791
792
793
794

/**
 * 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.
 *
795
 * Theme and language contexts are automatically differentiated.
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 *
 * @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) {
824
      $cid_parts[] = 'r.' . implode(',', array_keys($user->roles));
825
826
827
828
829
830
831
832
833
834
835
    }
    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);
  }
836
}
837
838

/**
839
 * Implement hook_flush_caches().
840
841
842
843
 */
function block_flush_caches() {
  return array('cache_block');
}
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862

/**
 * 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) {
863
  $block_counter = &drupal_static(__FUNCTION__, array());
864
  $variables['block'] = $variables['elements']['#block'];
865
866
867
868
869
870
871
872
  // 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]++;

873
874
  // Create the $content variable that templates expect.
  $variables['content'] = $variables['elements']['#children'];
875

876
877
  $variables['classes_array'][] = 'block-' . $variables['block']->module;

878
879
880
  $variables['template_files'][] = 'block-' . $variables['block']->region;
  $variables['template_files'][] = 'block-' . $variables['block']->module;
  $variables['template_files'][] = 'block-' . $variables['block']->module . '-' . $variables['block']->delta;
881
}