|
1 <?php |
|
2 |
|
3 /** |
|
4 * @file |
|
5 * Controls the visual building blocks a page is constructed with. |
|
6 */ |
|
7 |
|
8 /** |
|
9 * Denotes that a block is not enabled in any region and should not be shown. |
|
10 */ |
|
11 define('BLOCK_REGION_NONE', -1); |
|
12 |
|
13 /** |
|
14 * Users cannot control whether or not they see this block. |
|
15 */ |
|
16 define('BLOCK_CUSTOM_FIXED', 0); |
|
17 |
|
18 /** |
|
19 * Shows this block by default, but lets individual users hide it. |
|
20 */ |
|
21 define('BLOCK_CUSTOM_ENABLED', 1); |
|
22 |
|
23 /** |
|
24 * Hides this block by default but lets individual users show it. |
|
25 */ |
|
26 define('BLOCK_CUSTOM_DISABLED', 2); |
|
27 |
|
28 /** |
|
29 * Shows this block on every page except the listed pages. |
|
30 */ |
|
31 define('BLOCK_VISIBILITY_NOTLISTED', 0); |
|
32 |
|
33 /** |
|
34 * Shows this block on only the listed pages. |
|
35 */ |
|
36 define('BLOCK_VISIBILITY_LISTED', 1); |
|
37 |
|
38 /** |
|
39 * Shows this block if the associated PHP code returns TRUE. |
|
40 */ |
|
41 define('BLOCK_VISIBILITY_PHP', 2); |
|
42 |
|
43 /** |
|
44 * Implements hook_help(). |
|
45 */ |
|
46 function block_help($path, $arg) { |
|
47 switch ($path) { |
|
48 case 'admin/help#block': |
|
49 $output = ''; |
|
50 $output .= '<h3>' . t('About') . '</h3>'; |
|
51 $output .= '<p>' . t('The Block module allows you to create boxes of content, which are rendered into an area, or region, of one or more pages of a website. The core Seven administration theme, for example, implements the regions "Content", "Help", "Dashboard main", and "Dashboard sidebar", and a block may appear in any one of these regions. The <a href="@blocks">Blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. For more information, see the online handbook entry for <a href="@block">Block module</a>.', array('@block' => 'http://drupal.org/documentation/modules/block/', '@blocks' => url('admin/structure/block'))) . '</p>'; |
|
52 $output .= '<h3>' . t('Uses') . '</h3>'; |
|
53 $output .= '<dl>'; |
|
54 $output .= '<dt>' . t('Positioning content') . '</dt>'; |
|
55 $output .= '<dd>' . t('When working with blocks, remember that all themes do <em>not</em> implement the same regions, or display regions in the same way. Blocks are positioned on a per-theme basis. Users with the <em>Administer blocks</em> permission can disable blocks. Disabled blocks are listed on the <a href="@blocks">Blocks administration page</a>, but are not displayed in any region.', array('@block' => 'http://drupal.org/documentation/modules/block/', '@blocks' => url('admin/structure/block'))) . '</dd>'; |
|
56 $output .= '<dt>' . t('Controlling visibility') . '</dt>'; |
|
57 $output .= '<dd>' . t('Blocks can be configured to be visible only on certain pages, only to users of certain roles, or only on pages displaying certain <a href="@content-type">content types</a>. Administrators can also allow specific blocks to be enabled or disabled by users when they edit their <a href="@user">My account</a> page. Some dynamic blocks, such as those generated by modules, will be displayed only on certain pages.', array('@content-type' => url('admin/structure/types'), '@user' => url('user'))) . '</dd>'; |
|
58 $output .= '<dt>' . t('Creating custom blocks') . '</dt>'; |
|
59 $output .= '<dd>' . t('Users with the <em>Administer blocks</em> permission can <a href="@block-add">add custom blocks</a>, which are then listed on the <a href="@blocks">Blocks administration page</a>. Once created, custom blocks behave just like default and module-generated blocks.', array('@blocks' => url('admin/structure/block'), '@block-add' => url('admin/structure/block/add'))) . '</dd>'; |
|
60 $output .= '</dl>'; |
|
61 return $output; |
|
62 |
|
63 case 'admin/structure/block/add': |
|
64 return '<p>' . t('Use this page to create a new custom block.') . '</p>'; |
|
65 } |
|
66 if ($arg[0] == 'admin' && $arg[1] == 'structure' && $arg['2'] == 'block' && (empty($arg[3]) || $arg[3] == 'list')) { |
|
67 $demo_theme = !empty($arg[4]) ? $arg[4] : variable_get('theme_default', 'bartik'); |
|
68 $themes = list_themes(); |
|
69 $output = '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page. Click the <em>configure</em> link next to each block to configure its specific title and visibility settings.') . '</p>'; |
|
70 $output .= '<p>' . l(t('Demonstrate block regions (!theme)', array('!theme' => $themes[$demo_theme]->info['name'])), 'admin/structure/block/demo/' . $demo_theme) . '</p>'; |
|
71 return $output; |
|
72 } |
|
73 } |
|
74 |
|
75 /** |
|
76 * Implements hook_theme(). |
|
77 */ |
|
78 function block_theme() { |
|
79 return array( |
|
80 'block' => array( |
|
81 'render element' => 'elements', |
|
82 'template' => 'block', |
|
83 ), |
|
84 'block_admin_display_form' => array( |
|
85 'template' => 'block-admin-display-form', |
|
86 'file' => 'block.admin.inc', |
|
87 'render element' => 'form', |
|
88 ), |
|
89 ); |
|
90 } |
|
91 |
|
92 /** |
|
93 * Implements hook_permission(). |
|
94 */ |
|
95 function block_permission() { |
|
96 return array( |
|
97 'administer blocks' => array( |
|
98 'title' => t('Administer blocks'), |
|
99 ), |
|
100 ); |
|
101 } |
|
102 |
|
103 /** |
|
104 * Implements hook_menu(). |
|
105 */ |
|
106 function block_menu() { |
|
107 $default_theme = variable_get('theme_default', 'bartik'); |
|
108 $items['admin/structure/block'] = array( |
|
109 'title' => 'Blocks', |
|
110 'description' => 'Configure what block content appears in your site\'s sidebars and other regions.', |
|
111 'page callback' => 'block_admin_display', |
|
112 'page arguments' => array($default_theme), |
|
113 'access arguments' => array('administer blocks'), |
|
114 'file' => 'block.admin.inc', |
|
115 ); |
|
116 $items['admin/structure/block/manage/%/%'] = array( |
|
117 'title' => 'Configure block', |
|
118 'page callback' => 'drupal_get_form', |
|
119 'page arguments' => array('block_admin_configure', 4, 5), |
|
120 'access arguments' => array('administer blocks'), |
|
121 'file' => 'block.admin.inc', |
|
122 ); |
|
123 $items['admin/structure/block/manage/%/%/configure'] = array( |
|
124 'title' => 'Configure block', |
|
125 'type' => MENU_DEFAULT_LOCAL_TASK, |
|
126 'context' => MENU_CONTEXT_INLINE, |
|
127 ); |
|
128 $items['admin/structure/block/manage/%/%/delete'] = array( |
|
129 'title' => 'Delete block', |
|
130 'page callback' => 'drupal_get_form', |
|
131 'page arguments' => array('block_custom_block_delete', 4, 5), |
|
132 'access arguments' => array('administer blocks'), |
|
133 'type' => MENU_LOCAL_TASK, |
|
134 'context' => MENU_CONTEXT_NONE, |
|
135 'file' => 'block.admin.inc', |
|
136 ); |
|
137 $items['admin/structure/block/add'] = array( |
|
138 'title' => 'Add block', |
|
139 'page callback' => 'drupal_get_form', |
|
140 'page arguments' => array('block_add_block_form'), |
|
141 'access arguments' => array('administer blocks'), |
|
142 'type' => MENU_LOCAL_ACTION, |
|
143 'file' => 'block.admin.inc', |
|
144 ); |
|
145 foreach (list_themes() as $key => $theme) { |
|
146 $items['admin/structure/block/list/' . $key] = array( |
|
147 'title' => $theme->info['name'], |
|
148 'page arguments' => array($key), |
|
149 'type' => $key == $default_theme ? MENU_DEFAULT_LOCAL_TASK : MENU_LOCAL_TASK, |
|
150 'weight' => $key == $default_theme ? -10 : 0, |
|
151 'access callback' => '_block_themes_access', |
|
152 'access arguments' => array($theme), |
|
153 'file' => 'block.admin.inc', |
|
154 ); |
|
155 if ($key != $default_theme) { |
|
156 $items['admin/structure/block/list/' . $key . '/add'] = array( |
|
157 'title' => 'Add block', |
|
158 'page callback' => 'drupal_get_form', |
|
159 'page arguments' => array('block_add_block_form'), |
|
160 'access arguments' => array('administer blocks'), |
|
161 'type' => MENU_LOCAL_ACTION, |
|
162 'file' => 'block.admin.inc', |
|
163 ); |
|
164 } |
|
165 $items['admin/structure/block/demo/' . $key] = array( |
|
166 'title' => $theme->info['name'], |
|
167 'page callback' => 'block_admin_demo', |
|
168 'page arguments' => array($key), |
|
169 'type' => MENU_CALLBACK, |
|
170 'access callback' => '_block_themes_access', |
|
171 'access arguments' => array($theme), |
|
172 'theme callback' => '_block_custom_theme', |
|
173 'theme arguments' => array($key), |
|
174 'file' => 'block.admin.inc', |
|
175 ); |
|
176 } |
|
177 return $items; |
|
178 } |
|
179 |
|
180 /** |
|
181 * Menu item access callback - only admin or enabled themes can be accessed. |
|
182 */ |
|
183 function _block_themes_access($theme) { |
|
184 return user_access('administer blocks') && drupal_theme_access($theme); |
|
185 } |
|
186 |
|
187 /** |
|
188 * Theme callback for the block configuration pages. |
|
189 * |
|
190 * @param $theme |
|
191 * The theme whose blocks are being configured. If not set, the default theme |
|
192 * is assumed. |
|
193 * |
|
194 * @return |
|
195 * The theme that should be used for the block configuration page, or NULL |
|
196 * to indicate that the default theme should be used. |
|
197 */ |
|
198 function _block_custom_theme($theme = NULL) { |
|
199 // We return exactly what was passed in, to guarantee that the page will |
|
200 // always be displayed using the theme whose blocks are being configured. |
|
201 return $theme; |
|
202 } |
|
203 |
|
204 /** |
|
205 * Implements hook_block_info(). |
|
206 */ |
|
207 function block_block_info() { |
|
208 $blocks = array(); |
|
209 |
|
210 $result = db_query('SELECT bid, info FROM {block_custom} ORDER BY info'); |
|
211 foreach ($result as $block) { |
|
212 $blocks[$block->bid]['info'] = $block->info; |
|
213 // Not worth caching. |
|
214 $blocks[$block->bid]['cache'] = DRUPAL_NO_CACHE; |
|
215 } |
|
216 return $blocks; |
|
217 } |
|
218 |
|
219 /** |
|
220 * Implements hook_block_configure(). |
|
221 */ |
|
222 function block_block_configure($delta = 0) { |
|
223 if ($delta) { |
|
224 $custom_block = block_custom_block_get($delta); |
|
225 } |
|
226 else { |
|
227 $custom_block = array(); |
|
228 } |
|
229 return block_custom_block_form($custom_block); |
|
230 } |
|
231 |
|
232 /** |
|
233 * Implements hook_block_save(). |
|
234 */ |
|
235 function block_block_save($delta = 0, $edit = array()) { |
|
236 block_custom_block_save($edit, $delta); |
|
237 } |
|
238 |
|
239 /** |
|
240 * Implements hook_block_view(). |
|
241 * |
|
242 * Generates the administrator-defined blocks for display. |
|
243 */ |
|
244 function block_block_view($delta = '') { |
|
245 $block = db_query('SELECT body, format FROM {block_custom} WHERE bid = :bid', array(':bid' => $delta))->fetchObject(); |
|
246 $data['subject'] = NULL; |
|
247 $data['content'] = check_markup($block->body, $block->format, '', TRUE); |
|
248 return $data; |
|
249 } |
|
250 |
|
251 /** |
|
252 * Implements hook_page_build(). |
|
253 * |
|
254 * Renders blocks into their regions. |
|
255 */ |
|
256 function block_page_build(&$page) { |
|
257 global $theme; |
|
258 |
|
259 // The theme system might not yet be initialized. We need $theme. |
|
260 drupal_theme_initialize(); |
|
261 |
|
262 // Fetch a list of regions for the current theme. |
|
263 $all_regions = system_region_list($theme); |
|
264 |
|
265 $item = menu_get_item(); |
|
266 if ($item['path'] != 'admin/structure/block/demo/' . $theme) { |
|
267 // Load all region content assigned via blocks. |
|
268 foreach (array_keys($all_regions) as $region) { |
|
269 // Assign blocks to region. |
|
270 if ($blocks = block_get_blocks_by_region($region)) { |
|
271 $page[$region] = $blocks; |
|
272 } |
|
273 } |
|
274 // Once we've finished attaching all blocks to the page, clear the static |
|
275 // cache to allow modules to alter the block list differently in different |
|
276 // contexts. For example, any code that triggers hook_page_build() more |
|
277 // than once in the same page request may need to alter the block list |
|
278 // differently each time, so that only certain parts of the page are |
|
279 // actually built. We do not clear the cache any earlier than this, though, |
|
280 // because it is used each time block_get_blocks_by_region() gets called |
|
281 // above. |
|
282 drupal_static_reset('block_list'); |
|
283 } |
|
284 else { |
|
285 // Append region description if we are rendering the regions demo page. |
|
286 $item = menu_get_item(); |
|
287 if ($item['path'] == 'admin/structure/block/demo/' . $theme) { |
|
288 foreach (system_region_list($theme, REGIONS_VISIBLE, FALSE) as $region) { |
|
289 $description = '<div class="block-region">' . $all_regions[$region] . '</div>'; |
|
290 $page[$region]['block_description'] = array( |
|
291 '#markup' => $description, |
|
292 '#weight' => 15, |
|
293 ); |
|
294 } |
|
295 $page['page_top']['backlink'] = array( |
|
296 '#type' => 'link', |
|
297 '#title' => t('Exit block region demonstration'), |
|
298 '#href' => 'admin/structure/block' . (variable_get('theme_default', 'bartik') == $theme ? '' : '/list/' . $theme), |
|
299 // Add the "overlay-restore" class to indicate this link should restore |
|
300 // the context in which the region demonstration page was opened. |
|
301 '#options' => array('attributes' => array('class' => array('block-demo-backlink', 'overlay-restore'))), |
|
302 '#weight' => -10, |
|
303 ); |
|
304 } |
|
305 } |
|
306 } |
|
307 |
|
308 /** |
|
309 * Gets a renderable array of a region containing all enabled blocks. |
|
310 * |
|
311 * @param $region |
|
312 * The requested region. |
|
313 * |
|
314 * @return |
|
315 * A renderable array of a region containing all enabled blocks. |
|
316 */ |
|
317 function block_get_blocks_by_region($region) { |
|
318 $build = array(); |
|
319 if ($list = block_list($region)) { |
|
320 $build = _block_get_renderable_array($list); |
|
321 } |
|
322 return $build; |
|
323 } |
|
324 |
|
325 /** |
|
326 * Gets an array of blocks suitable for drupal_render(). |
|
327 * |
|
328 * @param $list |
|
329 * A list of blocks such as that returned by block_list(). |
|
330 * |
|
331 * @return |
|
332 * A renderable array. |
|
333 */ |
|
334 function _block_get_renderable_array($list = array()) { |
|
335 $weight = 0; |
|
336 $build = array(); |
|
337 foreach ($list as $key => $block) { |
|
338 $build[$key] = $block->content; |
|
339 unset($block->content); |
|
340 |
|
341 // Add contextual links for this block; skip the main content block, since |
|
342 // contextual links are basically output as tabs/local tasks already. Also |
|
343 // skip the help block, since we assume that most users do not need or want |
|
344 // to perform contextual actions on the help block, and the links needlessly |
|
345 // draw attention on it. |
|
346 if ($key != 'system_main' && $key != 'system_help') { |
|
347 $build[$key]['#contextual_links']['block'] = array( |
|
348 'admin/structure/block/manage', |
|
349 array($block->module, $block->delta), |
|
350 ); |
|
351 } |
|
352 |
|
353 $build[$key] += array( |
|
354 '#block' => $block, |
|
355 '#weight' => ++$weight, |
|
356 ); |
|
357 $build[$key]['#theme_wrappers'][] = 'block'; |
|
358 } |
|
359 $build['#sorted'] = TRUE; |
|
360 return $build; |
|
361 } |
|
362 |
|
363 /** |
|
364 * Updates the 'block' DB table with the blocks currently exported by modules. |
|
365 * |
|
366 * @param $theme |
|
367 * The theme to rehash blocks for. If not provided, defaults to the currently |
|
368 * used theme. |
|
369 * |
|
370 * @return |
|
371 * Blocks currently exported by modules. |
|
372 */ |
|
373 function _block_rehash($theme = NULL) { |
|
374 global $theme_key; |
|
375 |
|
376 drupal_theme_initialize(); |
|
377 if (!isset($theme)) { |
|
378 // If theme is not specifically set, rehash for the current theme. |
|
379 $theme = $theme_key; |
|
380 } |
|
381 $regions = system_region_list($theme); |
|
382 |
|
383 // These are the blocks the function will return. |
|
384 $blocks = array(); |
|
385 // These are the blocks defined by code and modified by the database. |
|
386 $current_blocks = array(); |
|
387 // These are {block}.bid values to be kept. |
|
388 $bids = array(); |
|
389 $or = db_or(); |
|
390 // Gather the blocks defined by modules. |
|
391 foreach (module_implements('block_info') as $module) { |
|
392 $module_blocks = module_invoke($module, 'block_info'); |
|
393 $delta_list = array(); |
|
394 foreach ($module_blocks as $delta => $block) { |
|
395 // Compile a condition to retrieve this block from the database. |
|
396 // Add identifiers. |
|
397 $delta_list[] = $delta; |
|
398 $block['module'] = $module; |
|
399 $block['delta'] = $delta; |
|
400 $block['theme'] = $theme; |
|
401 $current_blocks[$module][$delta] = $block; |
|
402 } |
|
403 if (!empty($delta_list)) { |
|
404 $condition = db_and()->condition('module', $module)->condition('delta', $delta_list); |
|
405 $or->condition($condition); |
|
406 } |
|
407 } |
|
408 // Save the blocks defined in code for alter context. |
|
409 $code_blocks = $current_blocks; |
|
410 $database_blocks = db_select('block', 'b', array('fetch' => PDO::FETCH_ASSOC)) |
|
411 ->fields('b') |
|
412 ->condition($or) |
|
413 ->condition('theme', $theme) |
|
414 ->execute(); |
|
415 $original_database_blocks = array(); |
|
416 foreach ($database_blocks as $block) { |
|
417 $module = $block['module']; |
|
418 $delta = $block['delta']; |
|
419 $original_database_blocks[$module][$delta] = $block; |
|
420 // The cache mode can only by set from hook_block_info(), so that has |
|
421 // precedence over the database's value. |
|
422 if (isset($current_blocks[$module][$delta]['cache'])) { |
|
423 $block['cache'] = $current_blocks[$module][$delta]['cache']; |
|
424 } |
|
425 // Preserve info which is not in the database. |
|
426 $block['info'] = $current_blocks[$module][$delta]['info']; |
|
427 // Blocks stored in the database override the blocks defined in code. |
|
428 $current_blocks[$module][$delta] = $block; |
|
429 // Preserve this block. |
|
430 $bids[$block['bid']] = $block['bid']; |
|
431 } |
|
432 drupal_alter('block_info', $current_blocks, $theme, $code_blocks); |
|
433 foreach ($current_blocks as $module => $module_blocks) { |
|
434 foreach ($module_blocks as $delta => $block) { |
|
435 // Make sure certain attributes are set. |
|
436 $block += array( |
|
437 'pages' => '', |
|
438 'weight' => 0, |
|
439 'status' => 0, |
|
440 ); |
|
441 // Check for active blocks in regions that are not available. |
|
442 if (!empty($block['region']) && $block['region'] != BLOCK_REGION_NONE && !isset($regions[$block['region']]) && $block['status'] == 1) { |
|
443 drupal_set_message(t('The block %info was assigned to the invalid region %region and has been disabled.', array('%info' => $block['info'], '%region' => $block['region'])), 'warning'); |
|
444 // Disabled modules are moved into the BLOCK_REGION_NONE later so no |
|
445 // need to move the block to another region. |
|
446 $block['status'] = 0; |
|
447 } |
|
448 // Set region to none if not enabled. |
|
449 if (empty($block['status'])) { |
|
450 $block['status'] = 0; |
|
451 $block['region'] = BLOCK_REGION_NONE; |
|
452 } |
|
453 // There is no point saving disabled blocks. Still, we need to save them |
|
454 // because the 'title' attribute is saved to the {blocks} table. |
|
455 if (isset($block['bid'])) { |
|
456 // If the block has a bid property, it comes from the database and |
|
457 // the record needs to be updated, so set the primary key to 'bid' |
|
458 // before passing to drupal_write_record(). |
|
459 $primary_keys = array('bid'); |
|
460 // Remove a block from the list of blocks to keep if it became disabled. |
|
461 unset($bids[$block['bid']]); |
|
462 } |
|
463 else { |
|
464 $primary_keys = array(); |
|
465 } |
|
466 // If the block is new or differs from the original database block, save |
|
467 // it. To determine whether there was a change it is enough to examine |
|
468 // the values for the keys in the original database record as that |
|
469 // contained every database field. |
|
470 if (!$primary_keys || array_diff_assoc($original_database_blocks[$module][$delta], $block)) { |
|
471 drupal_write_record('block', $block, $primary_keys); |
|
472 // Make it possible to test this. |
|
473 $block['saved'] = TRUE; |
|
474 } |
|
475 // Add to the list of blocks we return. |
|
476 $blocks[] = $block; |
|
477 } |
|
478 } |
|
479 if ($bids) { |
|
480 // Remove disabled that are no longer defined by the code from the |
|
481 // database. |
|
482 db_delete('block') |
|
483 ->condition('bid', $bids, 'NOT IN') |
|
484 ->condition('theme', $theme) |
|
485 ->execute(); |
|
486 } |
|
487 return $blocks; |
|
488 } |
|
489 |
|
490 /** |
|
491 * Returns information from database about a user-created (custom) block. |
|
492 * |
|
493 * @param $bid |
|
494 * ID of the block to get information for. |
|
495 * |
|
496 * @return |
|
497 * Associative array of information stored in the database for this block. |
|
498 * Array keys: |
|
499 * - bid: Block ID. |
|
500 * - info: Block description. |
|
501 * - body: Block contents. |
|
502 * - format: Filter ID of the filter format for the body. |
|
503 */ |
|
504 function block_custom_block_get($bid) { |
|
505 return db_query("SELECT * FROM {block_custom} WHERE bid = :bid", array(':bid' => $bid))->fetchAssoc(); |
|
506 } |
|
507 |
|
508 /** |
|
509 * Form constructor for the custom block form. |
|
510 * |
|
511 * @param $edit |
|
512 * (optional) An associative array of information retrieved by |
|
513 * block_custom_get_block() if an existing block is being edited, or an empty |
|
514 * array otherwise. Defaults to array(). |
|
515 * |
|
516 * @ingroup forms |
|
517 */ |
|
518 function block_custom_block_form($edit = array()) { |
|
519 $edit += array( |
|
520 'info' => '', |
|
521 'body' => '', |
|
522 ); |
|
523 $form['info'] = array( |
|
524 '#type' => 'textfield', |
|
525 '#title' => t('Block description'), |
|
526 '#default_value' => $edit['info'], |
|
527 '#maxlength' => 64, |
|
528 '#description' => t('A brief description of your block. Used on the <a href="@overview">Blocks administration page</a>.', array('@overview' => url('admin/structure/block'))), |
|
529 '#required' => TRUE, |
|
530 '#weight' => -18, |
|
531 ); |
|
532 $form['body_field']['#weight'] = -17; |
|
533 $form['body_field']['body'] = array( |
|
534 '#type' => 'text_format', |
|
535 '#title' => t('Block body'), |
|
536 '#default_value' => $edit['body'], |
|
537 '#format' => isset($edit['format']) ? $edit['format'] : NULL, |
|
538 '#rows' => 15, |
|
539 '#description' => t('The content of the block as shown to the user.'), |
|
540 '#required' => TRUE, |
|
541 '#weight' => -17, |
|
542 ); |
|
543 |
|
544 return $form; |
|
545 } |
|
546 |
|
547 /** |
|
548 * Saves a user-created block in the database. |
|
549 * |
|
550 * @param $edit |
|
551 * Associative array of fields to save. Array keys: |
|
552 * - info: Block description. |
|
553 * - body: Associative array of body value and format. Array keys: |
|
554 * - value: Block contents. |
|
555 * - format: Filter ID of the filter format for the body. |
|
556 * @param $delta |
|
557 * Block ID of the block to save. |
|
558 * |
|
559 * @return |
|
560 * Always returns TRUE. |
|
561 */ |
|
562 function block_custom_block_save($edit, $delta) { |
|
563 db_update('block_custom') |
|
564 ->fields(array( |
|
565 'body' => $edit['body']['value'], |
|
566 'info' => $edit['info'], |
|
567 'format' => $edit['body']['format'], |
|
568 )) |
|
569 ->condition('bid', $delta) |
|
570 ->execute(); |
|
571 return TRUE; |
|
572 } |
|
573 |
|
574 /** |
|
575 * Implements hook_form_FORM_ID_alter() for user_profile_form(). |
|
576 */ |
|
577 function block_form_user_profile_form_alter(&$form, &$form_state) { |
|
578 if ($form['#user_category'] == 'account') { |
|
579 $account = $form['#user']; |
|
580 $rids = array_keys($account->roles); |
|
581 $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)); |
|
582 |
|
583 $blocks = array(); |
|
584 foreach ($result as $block) { |
|
585 $data = module_invoke($block->module, 'block_info'); |
|
586 if ($data[$block->delta]['info']) { |
|
587 $blocks[$block->module][$block->delta] = array( |
|
588 '#type' => 'checkbox', |
|
589 '#title' => check_plain($data[$block->delta]['info']), |
|
590 '#default_value' => isset($account->data['block'][$block->module][$block->delta]) ? $account->data['block'][$block->module][$block->delta] : ($block->custom == 1), |
|
591 ); |
|
592 } |
|
593 } |
|
594 // Only display the fieldset if there are any personalizable blocks. |
|
595 if ($blocks) { |
|
596 $form['block'] = array( |
|
597 '#type' => 'fieldset', |
|
598 '#title' => t('Personalize blocks'), |
|
599 '#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.'), |
|
600 '#weight' => 3, |
|
601 '#collapsible' => TRUE, |
|
602 '#tree' => TRUE, |
|
603 ); |
|
604 $form['block'] += $blocks; |
|
605 } |
|
606 } |
|
607 } |
|
608 |
|
609 /** |
|
610 * Implements hook_user_presave(). |
|
611 */ |
|
612 function block_user_presave(&$edit, $account, $category) { |
|
613 if (isset($edit['block'])) { |
|
614 $edit['data']['block'] = $edit['block']; |
|
615 } |
|
616 } |
|
617 |
|
618 /** |
|
619 * Initializes blocks for enabled themes. |
|
620 * |
|
621 * @param $theme_list |
|
622 * An array of theme names. |
|
623 */ |
|
624 function block_themes_enabled($theme_list) { |
|
625 foreach ($theme_list as $theme) { |
|
626 block_theme_initialize($theme); |
|
627 } |
|
628 } |
|
629 |
|
630 /** |
|
631 * Assigns an initial, default set of blocks for a theme. |
|
632 * |
|
633 * This function is called the first time a new theme is enabled. The new theme |
|
634 * gets a copy of the default theme's blocks, with the difference that if a |
|
635 * particular region isn't available in the new theme, the block is assigned |
|
636 * to the new theme's default region. |
|
637 * |
|
638 * @param $theme |
|
639 * The name of a theme. |
|
640 */ |
|
641 function block_theme_initialize($theme) { |
|
642 // Initialize theme's blocks if none already registered. |
|
643 $has_blocks = (bool) db_query_range('SELECT 1 FROM {block} WHERE theme = :theme', 0, 1, array(':theme' => $theme))->fetchField(); |
|
644 if (!$has_blocks) { |
|
645 $default_theme = variable_get('theme_default', 'bartik'); |
|
646 // Apply only to new theme's visible regions. |
|
647 $regions = system_region_list($theme, REGIONS_VISIBLE); |
|
648 $result = db_query("SELECT * FROM {block} WHERE theme = :theme", array(':theme' => $default_theme), array('fetch' => PDO::FETCH_ASSOC)); |
|
649 foreach ($result as $block) { |
|
650 // If the region isn't supported by the theme, assign the block to the |
|
651 // theme's default region. |
|
652 if ($block['status'] && !isset($regions[$block['region']])) { |
|
653 $block['region'] = system_default_region($theme); |
|
654 } |
|
655 $block['theme'] = $theme; |
|
656 unset($block['bid']); |
|
657 drupal_write_record('block', $block); |
|
658 } |
|
659 } |
|
660 } |
|
661 |
|
662 /** |
|
663 * Returns all blocks in the specified region for the current user. |
|
664 * |
|
665 * @param $region |
|
666 * The name of a region. |
|
667 * |
|
668 * @return |
|
669 * An array of block objects, indexed with the module name and block delta |
|
670 * concatenated with an underscore, thus: MODULE_DELTA. If you are displaying |
|
671 * your blocks in one or two sidebars, you may check whether this array is |
|
672 * empty to see how many columns are going to be displayed. |
|
673 * |
|
674 * @todo |
|
675 * Now that the block table has a primary key, we should use that as the |
|
676 * array key instead of MODULE_DELTA. |
|
677 */ |
|
678 function block_list($region) { |
|
679 $blocks = &drupal_static(__FUNCTION__); |
|
680 |
|
681 if (!isset($blocks)) { |
|
682 $blocks = _block_load_blocks(); |
|
683 } |
|
684 |
|
685 // Create an empty array if there are no entries. |
|
686 if (!isset($blocks[$region])) { |
|
687 $blocks[$region] = array(); |
|
688 } |
|
689 else { |
|
690 $blocks[$region] = _block_render_blocks($blocks[$region]); |
|
691 } |
|
692 |
|
693 return $blocks[$region]; |
|
694 } |
|
695 |
|
696 /** |
|
697 * Loads a block object from the database. |
|
698 * |
|
699 * This function returns the first block matching the module and delta |
|
700 * parameters, so it should not be used for theme-specific functionality. |
|
701 * |
|
702 * @param $module |
|
703 * Name of the module that implements the block to load. |
|
704 * @param $delta |
|
705 * Unique ID of the block within the context of $module. Pass NULL to return |
|
706 * an empty block object for $module. |
|
707 * |
|
708 * @return |
|
709 * A block object. |
|
710 */ |
|
711 function block_load($module, $delta) { |
|
712 if (isset($delta)) { |
|
713 $block = db_query('SELECT * FROM {block} WHERE module = :module AND delta = :delta', array(':module' => $module, ':delta' => $delta))->fetchObject(); |
|
714 } |
|
715 |
|
716 // If the block does not exist in the database yet return a stub block |
|
717 // object. |
|
718 if (empty($block)) { |
|
719 $block = new stdClass(); |
|
720 $block->module = $module; |
|
721 $block->delta = $delta; |
|
722 } |
|
723 |
|
724 return $block; |
|
725 } |
|
726 |
|
727 /** |
|
728 * Loads blocks' information from the database. |
|
729 * |
|
730 * @return |
|
731 * An array of blocks grouped by region. |
|
732 */ |
|
733 function _block_load_blocks() { |
|
734 global $theme_key; |
|
735 |
|
736 $query = db_select('block', 'b'); |
|
737 $result = $query |
|
738 ->fields('b') |
|
739 ->condition('b.theme', $theme_key) |
|
740 ->condition('b.status', 1) |
|
741 ->orderBy('b.region') |
|
742 ->orderBy('b.weight') |
|
743 ->orderBy('b.module') |
|
744 ->addTag('block_load') |
|
745 ->addTag('translatable') |
|
746 ->execute(); |
|
747 |
|
748 $block_info = $result->fetchAllAssoc('bid'); |
|
749 // Allow modules to modify the block list. |
|
750 drupal_alter('block_list', $block_info); |
|
751 |
|
752 $blocks = array(); |
|
753 foreach ($block_info as $block) { |
|
754 $blocks[$block->region]["{$block->module}_{$block->delta}"] = $block; |
|
755 } |
|
756 return $blocks; |
|
757 } |
|
758 |
|
759 /** |
|
760 * Implements hook_block_list_alter(). |
|
761 * |
|
762 * Checks the page, user role, and user-specific visibility settings. |
|
763 * Removes the block if the visibility conditions are not met. |
|
764 */ |
|
765 function block_block_list_alter(&$blocks) { |
|
766 global $user, $theme_key; |
|
767 |
|
768 // Build an array of roles for each block. |
|
769 $block_roles = array(); |
|
770 $result = db_query('SELECT module, delta, rid FROM {block_role}'); |
|
771 foreach ($result as $record) { |
|
772 $block_roles[$record->module][$record->delta][] = $record->rid; |
|
773 } |
|
774 |
|
775 foreach ($blocks as $key => $block) { |
|
776 if (!isset($block->theme) || !isset($block->status) || $block->theme != $theme_key || $block->status != 1) { |
|
777 // This block was added by a contrib module, leave it in the list. |
|
778 continue; |
|
779 } |
|
780 |
|
781 // If a block has no roles associated, it is displayed for every role. |
|
782 // For blocks with roles associated, if none of the user's roles matches |
|
783 // the settings from this block, remove it from the block list. |
|
784 if (isset($block_roles[$block->module][$block->delta]) && !array_intersect($block_roles[$block->module][$block->delta], array_keys($user->roles))) { |
|
785 // No match. |
|
786 unset($blocks[$key]); |
|
787 continue; |
|
788 } |
|
789 |
|
790 // Use the user's block visibility setting, if necessary. |
|
791 if ($block->custom != BLOCK_CUSTOM_FIXED) { |
|
792 if ($user->uid && isset($user->data['block'][$block->module][$block->delta])) { |
|
793 $enabled = $user->data['block'][$block->module][$block->delta]; |
|
794 } |
|
795 else { |
|
796 $enabled = ($block->custom == BLOCK_CUSTOM_ENABLED); |
|
797 } |
|
798 } |
|
799 else { |
|
800 $enabled = TRUE; |
|
801 } |
|
802 |
|
803 // Limited visibility blocks must list at least one page. |
|
804 if ($block->visibility == BLOCK_VISIBILITY_LISTED && empty($block->pages)) { |
|
805 $enabled = FALSE; |
|
806 } |
|
807 |
|
808 if (!$enabled) { |
|
809 unset($blocks[$key]); |
|
810 continue; |
|
811 } |
|
812 |
|
813 // Match path if necessary. |
|
814 if ($block->pages) { |
|
815 // Convert path to lowercase. This allows comparison of the same path |
|
816 // with different case. Ex: /Page, /page, /PAGE. |
|
817 $pages = drupal_strtolower($block->pages); |
|
818 if ($block->visibility < BLOCK_VISIBILITY_PHP) { |
|
819 // Convert the Drupal path to lowercase. |
|
820 $path = drupal_strtolower(drupal_get_path_alias($_GET['q'])); |
|
821 // Compare the lowercase internal and lowercase path alias (if any). |
|
822 $page_match = drupal_match_path($path, $pages); |
|
823 if ($path != $_GET['q']) { |
|
824 $page_match = $page_match || drupal_match_path($_GET['q'], $pages); |
|
825 } |
|
826 // When $block->visibility has a value of 0 |
|
827 // (BLOCK_VISIBILITY_NOTLISTED), the block is displayed on all pages |
|
828 // except those listed in $block->pages. When set to 1 |
|
829 // (BLOCK_VISIBILITY_LISTED), it is displayed only on those pages |
|
830 // listed in $block->pages. |
|
831 $page_match = !($block->visibility xor $page_match); |
|
832 } |
|
833 elseif (module_exists('php')) { |
|
834 $page_match = php_eval($block->pages); |
|
835 } |
|
836 else { |
|
837 $page_match = FALSE; |
|
838 } |
|
839 } |
|
840 else { |
|
841 $page_match = TRUE; |
|
842 } |
|
843 if (!$page_match) { |
|
844 unset($blocks[$key]); |
|
845 } |
|
846 } |
|
847 } |
|
848 |
|
849 /** |
|
850 * Render the content and subject for a set of blocks. |
|
851 * |
|
852 * @param $region_blocks |
|
853 * An array of block objects such as returned for one region by |
|
854 * _block_load_blocks(). |
|
855 * |
|
856 * @return |
|
857 * An array of visible blocks as expected by drupal_render(). |
|
858 */ |
|
859 function _block_render_blocks($region_blocks) { |
|
860 $cacheable = TRUE; |
|
861 |
|
862 // We preserve the submission of forms in blocks, by fetching from cache only |
|
863 // if the request method is 'GET' (or 'HEAD'). |
|
864 if ($_SERVER['REQUEST_METHOD'] != 'GET' && $_SERVER['REQUEST_METHOD'] != 'HEAD') { |
|
865 $cacheable = FALSE; |
|
866 } |
|
867 // Block caching is not usually compatible with node access modules, so by |
|
868 // default it is disabled when node access modules exist. However, it can be |
|
869 // allowed by using the variable 'block_cache_bypass_node_grants'. |
|
870 elseif (!variable_get('block_cache_bypass_node_grants', FALSE) && count(module_implements('node_grants'))) { |
|
871 $cacheable = FALSE; |
|
872 } |
|
873 |
|
874 // Proceed to loop over all blocks in order to compute their respective cache |
|
875 // identifiers; this allows us to do one single cache_get_multiple() call |
|
876 // instead of doing one cache_get() call per block. |
|
877 $cached_blocks = array(); |
|
878 $cids = array(); |
|
879 |
|
880 if ($cacheable) { |
|
881 foreach ($region_blocks as $key => $block) { |
|
882 if (!isset($block->content)) { |
|
883 if (($cid = _block_get_cache_id($block))) { |
|
884 $cids[$key] = $cid; |
|
885 } |
|
886 } |
|
887 } |
|
888 |
|
889 if ($cids) { |
|
890 // We cannot pass $cids in directly because cache_get_multiple() will |
|
891 // modify it, and we need to use it later on in this function. |
|
892 $cid_values = array_values($cids); |
|
893 $cached_blocks = cache_get_multiple($cid_values, 'cache_block'); |
|
894 } |
|
895 } |
|
896 |
|
897 foreach ($region_blocks as $key => $block) { |
|
898 // Render the block content if it has not been created already. |
|
899 if (!isset($block->content)) { |
|
900 // Erase the block from the static array - we'll put it back if it has |
|
901 // content. |
|
902 unset($region_blocks[$key]); |
|
903 |
|
904 $cid = empty($cids[$key]) ? NULL : $cids[$key]; |
|
905 |
|
906 // Try fetching the block from the previously loaded cache entries. |
|
907 if (isset($cached_blocks[$cid])) { |
|
908 $array = $cached_blocks[$cid]->data; |
|
909 } |
|
910 else { |
|
911 $array = module_invoke($block->module, 'block_view', $block->delta); |
|
912 |
|
913 // Valid PHP function names cannot contain hyphens. |
|
914 $delta = str_replace('-', '_', $block->delta); |
|
915 // Allow modules to modify the block before it is viewed, via either |
|
916 // hook_block_view_alter() or hook_block_view_MODULE_DELTA_alter(). |
|
917 drupal_alter(array('block_view', "block_view_{$block->module}_{$delta}"), $array, $block); |
|
918 |
|
919 if (isset($cid)) { |
|
920 cache_set($cid, $array, 'cache_block', CACHE_TEMPORARY); |
|
921 } |
|
922 } |
|
923 |
|
924 if (isset($array) && is_array($array)) { |
|
925 foreach ($array as $k => $v) { |
|
926 $block->$k = $v; |
|
927 } |
|
928 } |
|
929 if (isset($block->content) && $block->content) { |
|
930 // Normalize to the drupal_render() structure. |
|
931 if (is_string($block->content)) { |
|
932 $block->content = array('#markup' => $block->content); |
|
933 } |
|
934 // Override default block title if a custom display title is present. |
|
935 if ($block->title) { |
|
936 // Check plain here to allow module generated titles to keep any |
|
937 // markup. |
|
938 $block->subject = $block->title == '<none>' ? '' : check_plain($block->title); |
|
939 } |
|
940 if (!isset($block->subject)) { |
|
941 $block->subject = ''; |
|
942 } |
|
943 $region_blocks["{$block->module}_{$block->delta}"] = $block; |
|
944 } |
|
945 } |
|
946 } |
|
947 return $region_blocks; |
|
948 } |
|
949 |
|
950 /** |
|
951 * Assemble the cache_id to use for a given block. |
|
952 * |
|
953 * The cache_id string reflects the viewing context for the current block |
|
954 * instance, obtained by concatenating the relevant context information |
|
955 * (user, page, ...) according to the block's cache settings (BLOCK_CACHE_* |
|
956 * constants). Two block instances can use the same cached content when |
|
957 * they share the same cache_id. |
|
958 * |
|
959 * Theme and language contexts are automatically differentiated. |
|
960 * |
|
961 * @param $block |
|
962 * The block to get the cache_id from. |
|
963 * |
|
964 * @return |
|
965 * The string used as cache_id for the block. |
|
966 */ |
|
967 function _block_get_cache_id($block) { |
|
968 global $user; |
|
969 |
|
970 // User 1 being out of the regular 'roles define permissions' schema, |
|
971 // it brings too many chances of having unwanted output get in the cache |
|
972 // and later be served to other users. We therefore exclude user 1 from |
|
973 // block caching. |
|
974 if (variable_get('block_cache', FALSE) && !in_array($block->cache, array(DRUPAL_NO_CACHE, DRUPAL_CACHE_CUSTOM)) && $user->uid != 1) { |
|
975 // Start with common sub-patterns: block identification, theme, language. |
|
976 $cid_parts[] = $block->module; |
|
977 $cid_parts[] = $block->delta; |
|
978 drupal_alter('block_cid_parts', $cid_parts, $block); |
|
979 $cid_parts = array_merge($cid_parts, drupal_render_cid_parts($block->cache)); |
|
980 |
|
981 return implode(':', $cid_parts); |
|
982 } |
|
983 } |
|
984 |
|
985 /** |
|
986 * Implements hook_flush_caches(). |
|
987 */ |
|
988 function block_flush_caches() { |
|
989 // Rehash blocks for active themes. We don't use list_themes() here, |
|
990 // because if MAINTENANCE_MODE is defined it skips reading the database, |
|
991 // and we can't tell which themes are active. |
|
992 $themes = db_query("SELECT name FROM {system} WHERE type = 'theme' AND status = 1"); |
|
993 foreach ($themes as $theme) { |
|
994 _block_rehash($theme->name); |
|
995 } |
|
996 |
|
997 return array('cache_block'); |
|
998 } |
|
999 |
|
1000 /** |
|
1001 * Processes variables for block.tpl.php. |
|
1002 * |
|
1003 * Prepares the values passed to the theme_block function to be passed |
|
1004 * into a pluggable template engine. Uses block properties to generate a |
|
1005 * series of template file suggestions. If none are found, the default |
|
1006 * block.tpl.php is used. |
|
1007 * |
|
1008 * Most themes utilize their own copy of block.tpl.php. The default is located |
|
1009 * inside "modules/block/block.tpl.php". Look in there for the full list of |
|
1010 * variables. |
|
1011 * |
|
1012 * The $variables array contains the following arguments: |
|
1013 * - $block |
|
1014 * |
|
1015 * @see block.tpl.php |
|
1016 */ |
|
1017 function template_preprocess_block(&$variables) { |
|
1018 $block_counter = &drupal_static(__FUNCTION__, array()); |
|
1019 $variables['block'] = $variables['elements']['#block']; |
|
1020 // All blocks get an independent counter for each region. |
|
1021 if (!isset($block_counter[$variables['block']->region])) { |
|
1022 $block_counter[$variables['block']->region] = 1; |
|
1023 } |
|
1024 // Same with zebra striping. |
|
1025 $variables['block_zebra'] = ($block_counter[$variables['block']->region] % 2) ? 'odd' : 'even'; |
|
1026 $variables['block_id'] = $block_counter[$variables['block']->region]++; |
|
1027 |
|
1028 // Create the $content variable that templates expect. |
|
1029 $variables['content'] = $variables['elements']['#children']; |
|
1030 |
|
1031 $variables['classes_array'][] = drupal_html_class('block-' . $variables['block']->module); |
|
1032 |
|
1033 $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->region; |
|
1034 $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module; |
|
1035 // Hyphens (-) and underscores (_) play a special role in theme suggestions. |
|
1036 // Theme suggestions should only contain underscores, because within |
|
1037 // drupal_find_theme_templates(), underscores are converted to hyphens to |
|
1038 // match template file names, and then converted back to underscores to match |
|
1039 // pre-processing and other function names. So if your theme suggestion |
|
1040 // contains a hyphen, it will end up as an underscore after this conversion, |
|
1041 // and your function names won't be recognized. So, we need to convert |
|
1042 // hyphens to underscores in block deltas for the theme suggestions. |
|
1043 $variables['theme_hook_suggestions'][] = 'block__' . $variables['block']->module . '__' . strtr($variables['block']->delta, '-', '_'); |
|
1044 |
|
1045 // Create a valid HTML ID and make sure it is unique. |
|
1046 $variables['block_html_id'] = drupal_html_id('block-' . $variables['block']->module . '-' . $variables['block']->delta); |
|
1047 } |
|
1048 |
|
1049 /** |
|
1050 * Implements hook_user_role_delete(). |
|
1051 * |
|
1052 * Removes deleted role from blocks that use it. |
|
1053 */ |
|
1054 function block_user_role_delete($role) { |
|
1055 db_delete('block_role') |
|
1056 ->condition('rid', $role->rid) |
|
1057 ->execute(); |
|
1058 } |
|
1059 |
|
1060 /** |
|
1061 * Implements hook_menu_delete(). |
|
1062 */ |
|
1063 function block_menu_delete($menu) { |
|
1064 db_delete('block') |
|
1065 ->condition('module', 'menu') |
|
1066 ->condition('delta', $menu['menu_name']) |
|
1067 ->execute(); |
|
1068 db_delete('block_role') |
|
1069 ->condition('module', 'menu') |
|
1070 ->condition('delta', $menu['menu_name']) |
|
1071 ->execute(); |
|
1072 } |
|
1073 |
|
1074 /** |
|
1075 * Implements hook_form_FORM_ID_alter(). |
|
1076 */ |
|
1077 function block_form_system_performance_settings_alter(&$form, &$form_state) { |
|
1078 $disabled = (!variable_get('block_cache_bypass_node_grants', FALSE) && count(module_implements('node_grants'))); |
|
1079 $form['caching']['block_cache'] = array( |
|
1080 '#type' => 'checkbox', |
|
1081 '#title' => t('Cache blocks'), |
|
1082 '#default_value' => variable_get('block_cache', FALSE), |
|
1083 '#disabled' => $disabled, |
|
1084 '#description' => $disabled ? t('Block caching is inactive because you have enabled modules defining content access restrictions.') : NULL, |
|
1085 '#weight' => -1, |
|
1086 ); |
|
1087 } |
|
1088 |
|
1089 /** |
|
1090 * Implements hook_admin_paths(). |
|
1091 */ |
|
1092 function block_admin_paths() { |
|
1093 $paths = array( |
|
1094 // Exclude the block demonstration page from admin (overlay) treatment. |
|
1095 // This allows us to present this page in its true form, full page. |
|
1096 'admin/structure/block/demo/*' => FALSE, |
|
1097 ); |
|
1098 return $paths; |
|
1099 } |
|
1100 |
|
1101 /** |
|
1102 * Implements hook_modules_uninstalled(). |
|
1103 * |
|
1104 * Cleans up {block} and {block_role} tables from modules' blocks. |
|
1105 */ |
|
1106 function block_modules_uninstalled($modules) { |
|
1107 db_delete('block') |
|
1108 ->condition('module', $modules, 'IN') |
|
1109 ->execute(); |
|
1110 db_delete('block_role') |
|
1111 ->condition('module', $modules, 'IN') |
|
1112 ->execute(); |
|
1113 } |