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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
9
10
11
12
/**
 * Implementation of hook_help().
 */
function block_help($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
13
  switch ($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
14
    case 'admin/help#block':
15
      return t('
16
<p>Blocks are the boxes visible in the sidebar(s) of your web site. These are usually generated automatically by modules (e.g. recent forum topics), but you can also create your own blocks.</p>
17
18
19
20
21
22
23
24
25
26
27
28
29
<p>The sidebar each block appears in depends on both which theme you are using (some are left-only, some right, some both), and on the settings in block management.</p>
<p>The block management screen lets you specify the vertical sort-order of the blocks within a sidebar. You do this by assigning a weight to each block. Lighter blocks (smaller weight) "float up" towards the top of the sidebar. Heavier ones "sink down" towards the bottom of it.</p>
<p>A block\'s visibility depends on:</p>
<ul>
<li>Its enabled checkbox. Disabled blocks are never shown.</li>
<li>Its throttle checkbox. Throttled blocks are hidden during high server loads.</li>
<li>Its path options. Blocks can be configured to only show/hide on certain pages</li>.
<li>User settings. You can choose to let your users decide whether to show/hide certain blocks.</li>
<li>Its function. Dynamic blocks (such as those defined by modules) may be empty on certain pages and will not be shown.</li>
</ul>

<h3>Administrator defined blocks</h3>
<p>An administrator defined block contains content supplied by you (as opposed to being generated automatically by a module). Each admin-defined block consists of a title, a description, and a body which can be as long as you wish. The Drupal engine will render the content of the block.</p>');
Dries Buytaert's avatar
   
Dries Buytaert committed
30
    case 'admin/modules#description':
Dries Buytaert's avatar
   
Dries Buytaert committed
31
      return t('Controls the boxes that are displayed around the main content.');
Dries Buytaert's avatar
   
Dries Buytaert committed
32
    case 'admin/block':
33
34
35
      return t("
<p>Blocks are the boxes in the left and right side bars of the web site. They are made available by modules or created manually.</p>
<p>Only enabled blocks are shown. You can position the blocks by deciding which side of the page they will show up on (region) and in which order they appear (weight).</p>
36
<p>If you want certain blocks to disable themselves temporarily during high server loads, check the 'Throttle' box. You can configure the auto-throttle on the <a href=\"%throttle\">throttle configuration page</a> after having enabled the throttle module.
37
", array('%throttle' => url('admin/settings/throttle')));
Dries Buytaert's avatar
   
Dries Buytaert committed
38
    case 'admin/block/add':
39
      return t("Here you can create a new block. Once you have created this block you must make it active and give it a place on the page using <a href=\"%overview\">blocks</a>. The title is used when displaying the block. The description is used in the \"block\" column on the <a href=\"%overview\">blocks</a> page.", array('%overview' => url('admin/block')));
Dries Buytaert's avatar
   
Dries Buytaert committed
40
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
41
42
}

Dries Buytaert's avatar
   
Dries Buytaert committed
43
44
45
/**
 * Implementation of hook_perm().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
46
function block_perm() {
Dries Buytaert's avatar
   
Dries Buytaert committed
47
  return array('administer blocks');
Dries Buytaert's avatar
   
Dries Buytaert committed
48
49
}

Dries Buytaert's avatar
   
Dries Buytaert committed
50
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
51
 * Implementation of hook_menu().
Dries Buytaert's avatar
   
Dries Buytaert committed
52
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
53
function block_menu($may_cache) {
Dries Buytaert's avatar
   
Dries Buytaert committed
54
  $items = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
55
56
57
58
59
60
61

  if ($may_cache) {
    $items[] = array('path' => 'admin/block', 'title' => t('blocks'),
      'access' => user_access('administer blocks'),
      'callback' => 'block_admin');
    $items[] = array('path' => 'admin/block/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
62
    $items[] = array('path' => 'admin/block/configure', 'title' => t('configure block'),
Dries Buytaert's avatar
   
Dries Buytaert committed
63
      'access' => user_access('administer blocks'),
64
65
66
67
68
      'callback' => 'block_admin_configure',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/block/delete', 'title' => t('delete block'),
      'access' => user_access('administer blocks'),
      'callback' => 'block_box_delete',
Dries Buytaert's avatar
   
Dries Buytaert committed
69
      'type' => MENU_CALLBACK);
Dries Buytaert's avatar
   
Dries Buytaert committed
70
    $items[] = array('path' => 'admin/block/add', 'title' => t('add block'),
Dries Buytaert's avatar
   
Dries Buytaert committed
71
      'access' => user_access('administer blocks'),
72
      'callback' => 'block_box_add',
Dries Buytaert's avatar
   
Dries Buytaert committed
73
74
75
      'type' => MENU_LOCAL_TASK);
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
76
  return $items;
Dries Buytaert's avatar
   
Dries Buytaert committed
77
78
}

Dries Buytaert's avatar
   
Dries Buytaert committed
79
80
81
82
83
/**
 * Implementation of hook_block().
 *
 * Generates the administrator-defined blocks for display.
 */
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
function block_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      $result = db_query('SELECT bid, title, info FROM {boxes} ORDER BY title');
      while ($block = db_fetch_object($result)) {
        $blocks[$block->bid]['info'] = $block->info;
      }
      return $blocks;

    case 'configure':
      $box = block_box_get($delta);
      if (filter_access($box['format'])) {
        return block_box_form($box);
      }
      break;

    case 'save':
      block_box_save($edit, $delta);
      break;

    case 'view':
      $block = db_fetch_object(db_query('SELECT * FROM {boxes} WHERE bid = %d', $delta));
      $data['subject'] = $block->title;
      $data['content'] = check_output($block->body, $block->format);
      return $data;
109
110
111
  }
}

Dries Buytaert's avatar
 
Dries Buytaert committed
112
function block_admin_save($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
113
114
  foreach ($edit as $module => $blocks) {
    foreach ($blocks as $delta => $block) {
115
116
      db_query("UPDATE {blocks} SET region = %d, status = %d, weight = %d, throttle = %d WHERE module = '%s' AND delta = '%s'",
                $block['region'], $block['status'], $block['weight'], $block['throttle'], $module, $delta);
Dries Buytaert's avatar
   
Dries Buytaert committed
117
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
118
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
119

120
  return t('The block settings have been updated.');
Dries Buytaert's avatar
 
Dries Buytaert committed
121
122
}

Dries Buytaert's avatar
   
Dries Buytaert committed
123
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
124
 * Update the 'blocks' DB table with the blocks currently exported by modules.
Dries Buytaert's avatar
   
Dries Buytaert committed
125
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
126
127
128
 * @param $order_by php <a
 *   href="http://www.php.net/manual/en/function.array-multisort.php">array_multisort()</a>
 *   style sort ordering, eg. "weight", SORT_ASC, SORT_STRING.
129
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
130
131
 * @return
 *   Blocks currently exported by modules, sorted by $order_by.
Dries Buytaert's avatar
   
Dries Buytaert committed
132
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
133
134
function _block_rehash($order_by = array('weight')) {
  $result = db_query('SELECT * FROM {blocks} ');
Dries Buytaert's avatar
   
Dries Buytaert committed
135
136
137
138
  while ($old_block = db_fetch_object($result)) {
    $old_blocks[$old_block->module][$old_block->delta] = $old_block;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
139
  db_query('DELETE FROM {blocks} ');
Dries Buytaert's avatar
   
Dries Buytaert committed
140
141

  foreach (module_list() as $module) {
Dries Buytaert's avatar
   
Dries Buytaert committed
142
    $module_blocks = module_invoke($module, 'block', 'list');
Dries Buytaert's avatar
   
Dries Buytaert committed
143
144
    if ($module_blocks) {
      foreach ($module_blocks as $delta => $block) {
Dries Buytaert's avatar
   
Dries Buytaert committed
145
146
        $block['module'] = $module;
        $block['delta']  = $delta;
Dries Buytaert's avatar
   
Dries Buytaert committed
147
        if ($old_blocks[$module][$delta]) {
Dries Buytaert's avatar
   
Dries Buytaert committed
148
149
150
          $block['status'] = $old_blocks[$module][$delta]->status;
          $block['weight'] = $old_blocks[$module][$delta]->weight;
          $block['region'] = $old_blocks[$module][$delta]->region;
151
152
          $block['visibility'] = $old_blocks[$module][$delta]->visibility;
          $block['pages'] = $old_blocks[$module][$delta]->pages;
Dries Buytaert's avatar
   
Dries Buytaert committed
153
154
          $block['custom'] = $old_blocks[$module][$delta]->custom;
          $block['throttle'] = $old_blocks[$module][$delta]->throttle;
155
          $block['types'] = $old_blocks[$module][$delta]->types;
Dries Buytaert's avatar
   
Dries Buytaert committed
156
157
        }
        else {
Dries Buytaert's avatar
   
Dries Buytaert committed
158
          $block['status'] = $block['weight'] = $block['region'] = $block['custom'] = 0;
159
          $block['pages'] = $block['types'] = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
160
161
162
        }

        // reinsert blocks into table
163
164
        db_query("INSERT INTO {blocks} (module, delta, status, weight, region, visibility, pages, custom, throttle, types) VALUES ('%s', '%s', %d, %d, %d, %d, '%s', %d, %d, '%s')",
          $block['module'], $block['delta'], $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle'], $block['types']);
Dries Buytaert's avatar
   
Dries Buytaert committed
165
166

        $blocks[] = $block;
Dries Buytaert's avatar
   
Dries Buytaert committed
167

Dries Buytaert's avatar
   
Dries Buytaert committed
168
169
        // build array to sort on
        $order[$order_by[0]][] = $block[$order_by[0]];
Dries Buytaert's avatar
   
Dries Buytaert committed
170
171
172
173
      }
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
174
175
176
  // sort
  array_multisort($order[$order_by[0]], $order_by[1] ? $order_by[1] : SORT_ASC, $order_by[2] ? $order_by[2] : SORT_REGULAR, $blocks);

Dries Buytaert's avatar
   
Dries Buytaert committed
177
178
  return $blocks;
}
Dries Buytaert's avatar
   
Dries Buytaert committed
179

Dries Buytaert's avatar
   
Dries Buytaert committed
180
181
182
/**
 * Prepare the main block administration form.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
183
function block_admin_display() {
Dries Buytaert's avatar
   
Dries Buytaert committed
184
  $blocks = _block_rehash();
Dries Buytaert's avatar
   
Dries Buytaert committed
185

Dries Buytaert's avatar
   
Dries Buytaert committed
186
187
188
189
190
191
  $header = array(t('Block'), t('Enabled'), t('Weight'), t('Region'));
  if (module_exist('throttle')) {
    $header[] = t('Throttle');
  }
  $header[] = array('data' => t('Operations'), 'colspan' => 2);

Dries Buytaert's avatar
   
Dries Buytaert committed
192

Dries Buytaert's avatar
   
Dries Buytaert committed
193
  foreach ($blocks as $block) {
194
    if ($block['module'] == 'block') {
Steven Wittens's avatar
Steven Wittens committed
195
      $operation = l(t('delete'), 'admin/block/delete/'. $block['delta']);
196
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
197
    else {
198
      $operation = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
199
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
200

Dries Buytaert's avatar
   
Dries Buytaert committed
201
202
203
204
205
206
207
208
    $row = array($block['info'], array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][status', 1, $block['status']), 'align' => 'center'), form_weight(NULL, $block['module'] .']['. $block['delta'] .'][weight', $block['weight']), form_radios(NULL, $block['module'] .']['. $block['delta'] .'][region', $block['region'], array(t('left'), t('right'))));

    $row = array($block['info'], array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][status', 1, $block['status']), 'align' => 'center'), form_weight(NULL, $block['module'] .']['. $block['delta'] .'][weight', $block['weight']), form_radios(NULL, $block['module'] .']['. $block['delta'] .'][region', $block['region'], array(t('left'), t('right'))));
    if (module_exist('throttle')) {
      $row[] = array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][throttle', 1, $block['throttle']), 'align' => 'center');
    }
    $row[] = array('data' => l(t('configure'), 'admin/block/configure/'. $block['module'] .'/'. $block['delta']), $operation);
    $rows[] = $row;
Dries Buytaert's avatar
 
Dries Buytaert committed
209
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
210

Dries Buytaert's avatar
   
Dries Buytaert committed
211
212
  $output = theme('table', $header, $rows);
  $output .= form_submit(t('Save blocks'));
Dries Buytaert's avatar
 
Dries Buytaert committed
213

Dries Buytaert's avatar
   
Dries Buytaert committed
214
  return form($output, 'post', url('admin/block'));
Dries Buytaert's avatar
 
Dries Buytaert committed
215
216
}

217
function block_box_get($bid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
218
219
220
221
  return db_fetch_array(db_query('SELECT * FROM {boxes} WHERE bid = %d', $bid));
}

/**
222
 * Menu callback; displays the block configuration form.
Dries Buytaert's avatar
   
Dries Buytaert committed
223
 */
224
function block_admin_configure($module = NULL, $delta = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
225
226
227
  $edit = $_POST['edit'];
  $op = $_POST['op'];

228
229
  switch ($op) {
    case t('Save block'):
230
231
232
233
234
235
236
      if ($edit['types']) {
        $types = implode(',', $edit['types']);
      }
      else {
        $types = '';
      }
      db_query("UPDATE {blocks} SET visibility = %d, pages = '%s', custom = %d, types = '%s' WHERE module = '%s' AND delta = '%s'", $edit['visibility'], $edit['pages'], $edit['custom'], $types, $module, $delta);
237
238
      module_invoke($module, 'block', 'save', $delta, $edit);
      drupal_set_message('The block configuration has been saved.');
239
240
241
      cache_clear_all();
      drupal_goto('admin/block');

242
243
244
    default:
      // Always evaluates to TRUE, but a validation step may be added later.
      if (!$edit) {
245
        $edit = db_fetch_array(db_query("SELECT pages, visibility, custom, types FROM {blocks} WHERE module = '%s' AND delta = '%s'", $module, $delta));
246
247
248
249
250
251
252
      }

      // Module-specific block configurations.
      if ($settings = module_invoke($module, 'block', 'configure', $delta)) {
        $form = form_group(t('Block-specific settings'), $settings);
      }

253
254
255
      foreach (node_list() as $type) {
        $content_types[$type] = node_invoke($type, 'node_name');
      }
256
257
258
      // Get the block subject for the page title.
      $info = module_invoke($module, 'block', 'list');
      drupal_set_title(t("'%name' block", array('%name' => $info[$delta]['info'])));
259

260
      // Standard block configurations.
261
262
      $group_1 = form_radios(t('Custom visibility settings'), 'custom', $edit['custom'], array(t('Users cannot control whether or not they see this block.'), t('Show this block by default, but let individual users hide it.'), t('Hide this block by default but let individual users show it.')), t('Allow individual users to customize the visibility of this block in their account settings.'));
      $group_2 = form_radios(t('Show block on specific pages'), 'visibility', $edit['visibility'], array(t('Show on every page except the listed pages.'), t('Show on only the listed pages.')));
Steven Wittens's avatar
Typos.    
Steven Wittens committed
263
264
      $group_2 .= form_textarea(t('Pages'), 'pages', $edit['pages'], 40, 5, t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are '<em>blog</em>' for the blog page and '<em>blog/*</em>' for every personal blog. '<em>&lt;front&gt;</em>' is the front page."));
      $group_3 = form_checkboxes(t('Restrict block to specific content types'), 'types', explode(',', $edit['types']), $content_types, t('Selecting one or more content types will cause this block to only be shown on pages of the selected types. This feature works alone or in conjunction with page specific visibility settings. For example, you can specify that a block only appear on book pages in the \'FAQ\' path.'), NULL, FALSE);
265

266
267
268
      $form  = form_group(t('User specific visibility settings'), $group_1);
      $form .= form_group(t('Page specific visibility settings'), $group_2);
      $form .= form_group(t('Content specific visibility settings'), $group_3);
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306


      $form .= form_submit(t('Save block'));

      print theme('page', form($form));
  }
}

/**
 * Menu callback; displays the block creation form.
 */
function block_box_add() {
  $edit = $_POST['edit'];
  $op = $_POST['op'];

  switch ($op) {
    case t('Save block'):
      block_box_save($edit);
      drupal_set_message(t('The new block has been added.'));
      drupal_goto('admin/block');

    default:
      $form = block_box_form();
      $form .= form_submit(t('Save block'));
      $output .= form($form);
  }

  print theme('page', $output);
}

/**
 * Menu callback; confirm and delete custom blocks.
 */
function block_box_delete($bid = 0) {
  $op = $_POST['op'];
  $box = block_box_get($bid);

  switch ($op) {
307
308
    case t('Delete'):
      db_query('DELETE FROM {boxes} WHERE bid = %d', $bid);
Steven Wittens's avatar
Steven Wittens committed
309
      drupal_set_message(t('The block %name has been deleted.', array('%name' => '<em>'. $box['info'] .'</em>')));
310
311
312
313
      cache_clear_all();
      drupal_goto('admin/block');

    default:
Steven Wittens's avatar
Steven Wittens committed
314
      $form = '<p>'. t('Are you sure you want to delete the block %name?', array('%name' => '<em>'. $box['info'] .'</em>')) ."</p>\n";
315
316
      $form .= form_submit(t('Delete'));
      $output = form($form);
Dries Buytaert's avatar
   
Dries Buytaert committed
317
318
319
  }

  print theme('page', $output);
320
321
322
}

function block_box_form($edit = array()) {
323
324
325
326
  $output = form_textfield(t('Block title'), 'title', $edit['title'], 50, 64, t('The title of the block as shown to the user.'));
  $output .= filter_form('format', $edit['format']);
  $output .= form_textarea(t('Block body'), 'body', $edit['body'], 70, 10, t('The content of the block as shown to the user.'));
  $output .= form_textfield(t('Block description'), 'info', $edit['info'], 50, 64, t('A brief description of your block.  Used on the <a href="%overview">block overview page</a>.', array('%overview' => url('admin/block'))));
327

328
  return $output;
329
330
}

331
function block_box_save($edit, $delta = NULL) {
332
333
  if (!filter_access($edit['format'])) {
    $edit['format'] = FILTER_FORMAT_DEFAULT;
Dries Buytaert's avatar
   
Dries Buytaert committed
334
335
  }

336
337
  if (isset($delta)) {
    db_query("UPDATE {boxes} SET title = '%s', body = '%s', info = '%s', format = %d WHERE bid = %d", $edit['title'], $edit['body'], $edit['info'], $edit['format'], $delta);
338
339
  }
  else {
340
    db_query("INSERT INTO {boxes} (title, body, info, format) VALUES  ('%s', '%s', '%s', %d)", $edit['title'], $edit['body'], $edit['info'], $edit['format']);
341
342
343
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
344
/**
345
 * Menu callback; displays the block overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
346
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
347
function block_admin() {
Dries Buytaert's avatar
   
Dries Buytaert committed
348
349
  $edit = $_POST['edit'];
  $op = $_POST['op'];
Dries Buytaert's avatar
   
Dries Buytaert committed
350

Dries Buytaert's avatar
   
Dries Buytaert committed
351
352
353
  if ($op == t('Save blocks')) {
    drupal_set_message(block_admin_save($edit));
    cache_clear_all();
354
    drupal_goto($_GET['q']);
Dries Buytaert's avatar
   
Dries Buytaert committed
355
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
356
  print theme('page', block_admin_display());
Dries Buytaert's avatar
 
Dries Buytaert committed
357
}
Dries Buytaert's avatar
   
Dries Buytaert committed
358

Dries Buytaert's avatar
   
Dries Buytaert committed
359
360
361
362
363
364
/**
 * Implementation of hook_user().
 *
 * Allow users to decide which custom blocks to display when they visit
 * the site.
 */
365
function block_user($type, $edit, &$user, $category = NULL) {
366
  switch ($type) {
367
    case 'form':
368
      if ($category == 'account') {
369
        $result = db_query('SELECT * FROM {blocks} WHERE status = 1 AND custom != 0 ORDER BY weight, module, delta');
370
371
372
373

        while ($block = db_fetch_object($result)) {
          $data = module_invoke($block->module, 'block', 'list');
          if ($data[$block->delta]['info']) {
374
            $form .= form_checkbox($data[$block->delta]['info'], 'block]['. $block->module .']['. $block->delta, 1, isset($user->block[$block->module][$block->delta]) ? $user->block[$block->module][$block->delta] : ($block->custom == 1));
375
          }
Kjartan Mannes's avatar
Kjartan Mannes committed
376
377
        }

378
379
380
        if (isset($form)) {
          return array(array('title' => t('Block configuration'), 'data' => $form, 'weight' => 2));
        }
381
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
382
383

      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
384
385
386
    case 'validate':
      if (!$edit['block']) {
        $edit['block'] = array();
387
388
      }
      return $edit;
389
390
391
  }
}

392
393
394
/**
 * Return blocks available for current $user at $region.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
395
 * @param $region main|left|right
396
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
397
 * @return array of block objects, indexed with <i>module</i>_<i>delta</i>
398
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
399
 * @see <a href="http://drupal.org/node/1042" target="_top">[feature]
400
 *   Generic template design difficult w/o block region "look-ahead"</a>
Dries Buytaert's avatar
   
Dries Buytaert committed
401
 * @todo add a proper primary key (bid) to the blocks table so we don't have
402
403
404
405
 *   to mess around with this <i>module</i>_<i>delta</i> construct. currently,
 *   "blocks" has no primary key defined (bad)!
 */
function block_list($region) {
406
  global $user;
407
408
409
410
  static $blocks = array();

  if (!isset($blocks[$region])) {
    $blocks[$region] = array();
411
    $result = db_query('SELECT * FROM {blocks} WHERE status = 1 '. ($region != 'all' ? 'AND region = %d ' : '') .'ORDER BY weight, module', $region == 'left' ? 0 : 1);
412
413

    while ($result && ($block = db_fetch_array($result))) {
414
415
416
417
418
419
420
421
422
423
424
      // Use the user's block visibility setting, if necessary
      if ($block['custom'] != 0) {
        if ($user->uid && isset($user->block[$block['module']][$block['delta']])) {
          $enabled = $user->block[$block['module']][$block['delta']];
        }
        else {
          $enabled = ($block['custom'] == 1);
        }
      }
      else {
        $enabled = TRUE;
425
      }
426
427

      // Match path if necessary
428
      if ($block['pages']) {
429
        $path = drupal_get_path_alias($_GET['q']);
430
        $regexp = '/^('. preg_replace(array('/(\r\n?|\n)/', '/\\\\\*/', '/(^|\|)\\\\<front\\\\>($|\|)/'), array('|', '.*', '\1'. variable_get('site_frontpage', 'node') .'\2'), preg_quote($block['pages'], '/')) .')$/';
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
        $page_match = !($block['visibility'] xor preg_match($regexp, $path));
      }
      else {
        $page_match = TRUE;
      }
      // Match node type if necessary
      $type_match = FALSE;
      if ($block['types'] != '') {
        if (arg(0) == 'node' && is_numeric(arg(1))) {
          $node = node_load(array('nid' => arg(1)));
          $types = explode(',', $block['types']);
          //Match on any one selected type
          foreach ($types as $type) {
            if ($node->type == $type) {
              $type_match = TRUE;
              break;
            }
          }
        }
450
451
      }
      else {
452
        $type_match = TRUE;
453
454
      }

455
      if ($enabled && $page_match && $type_match) {
456
457
        // Check the current throttle status and see if block should be displayed
        // based on server load.
458
        if (!($block['throttle'] && (module_invoke('throttle', 'status') > 0))) {
459
          $array = module_invoke($block['module'], 'block', 'view', $block['delta']);
Dries Buytaert's avatar
   
Dries Buytaert committed
460
          if (is_array($array)) {
461
462
            $block = array_merge($block, $array);
          }
Dries Buytaert's avatar
   
Dries Buytaert committed
463
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
464
        if (isset($block['content']) && $block['content']) {
465
466
467
468
469
470
471
472
          $blocks[$region]["$block[module]_$block[delta]"] = (object) $block;
        }
      }
    }
  }
  return $blocks[$region];
}

473
?>