? files ? install.php ? tmp ? includes/drupal.php ? modules/trackback.module Index: modules/aggregator.module =================================================================== RCS file: /cvs/drupal/drupal/modules/aggregator.module,v retrieving revision 1.214 diff -u -F^f -r1.214 aggregator.module --- modules/aggregator.module 19 Oct 2004 18:02:23 -0000 1.214 +++ modules/aggregator.module 21 Oct 2004 21:55:05 -0000 @@ -231,7 +231,7 @@ function aggregator_block($op, $delta) { $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title)); } } - else { + else if ($op == 'view') { list($type, $id) = split(':', $delta); switch ($type) { case 'feed': Index: modules/archive.module =================================================================== RCS file: /cvs/drupal/drupal/modules/archive.module,v retrieving revision 1.67 diff -u -F^f -r1.67 archive.module --- modules/archive.module 8 Oct 2004 11:29:31 -0000 1.67 +++ modules/archive.module 21 Oct 2004 21:55:05 -0000 @@ -184,7 +184,7 @@ function archive_block($op = 'list', $de $blocks[0]['info'] = t('Calendar to browse archives'); return $blocks; } - else if (user_access('access content')) { + else if ($op == 'view' && user_access('access content')) { $block['subject'] = t('Browse archives'); $block['content'] = archive_calendar(); return $block; Index: modules/block.module =================================================================== RCS file: /cvs/drupal/drupal/modules/block.module,v retrieving revision 1.139 diff -u -F^f -r1.139 block.module --- modules/block.module 14 Oct 2004 21:27:33 -0000 1.139 +++ modules/block.module 21 Oct 2004 21:55:05 -0000 @@ -12,20 +12,28 @@ function block_help($section) { switch ($section) { case 'admin/help#block': - return t(" + return t('
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.
-The sidebar each block appears in depends on both which theme you're using (some are left-only, some right, some both), and on the settings in block management.
Whether a block is visible in the first place depends on four things:
The block management screen also 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.
-The path setting lets you define the pages on which a specific block is visible. If you leave the path blank it will appear on all pages. The path uses a regular expression syntax so remember to escape special characters! The path expression is matched against the relative URL of a Drupal page, e.g. book
, node/12
, admin
.
In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on Perl-Compatible Regular Expressions (PCRE).
-However, for basic tasks it is sufficient to look at the following examples:
-If the block should only show up on blog pages, use <^blog>. To display on all node views use <^node>. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use <^(forum|book)>. The round brackets form a group of expressions, divided by the | character. It matches if any of the expressions in it match. A more complicated example is <^node/add/(story|blog|image)>. Blocks which have their paths set to this expression will show up on story, block, or image composition pages. If you want to show a block an all pages, but not the search page, use <^(?!search)>.
-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.
", array('%pcre' => 'http://php.net/pcre/')); +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.
+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.
+A block is visible when:
+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.
'); case 'admin/modules#description': return t('Controls the boxes that are displayed around the main content.'); case 'admin/block': - return t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the chosen theme. They are made available active modules or created manually. The \"enabled\" checkbox sets the default status of the block. Only enabled blocks are shown. When the \"custom\" checkbox is checked, your users can show or hide the block using their account settings. In that case, the 'enabled' checkbox signifies the block's default status. You can assign the block's placement by giving it a region and a weight. The region specifies which side of the page the block is on, and the weight sorts blocks within a region. Lighter (smaller weight value) blocks \"float up\" towards the top of the page. The path setting lets you define which pages you want a block to be shown on. Blocks can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by checking throttle. The auto-throttle functionality must be enabled on the throttle configuration page after having enabled the throttle module.", array('%throttle' => url('admin/settings/throttle'))); + return t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the chosen theme. They are made available active modules or created manually. Only enabled blocks may be shown. You can assign the block's placement by giving it a region and a weight. The region specifies which side of the page the block is on, and the weight sorts blocks within a region. Lighter (smaller weight value) blocks \"float up\" towards the top of the page. Blocks can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by checking throttle. The auto-throttle functionality must be enabled on the throttle configuration page after having enabled the throttle module.", array('%throttle' => url('admin/settings/throttle'))); case 'admin/block/add': 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 blocks. The title is used when displaying the block. The description is used in the \"block\" column on the blocks page.", array('%overview' => url('admin/block'))); } @@ -57,13 +65,17 @@ function block_menu($may_cache) { 'callback' => 'block_admin'); $items[] = array('path' => 'admin/block/list', 'title' => t('list'), 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10); - $items[] = array('path' => 'admin/block/edit', 'title' => t('edit block'), + $items[] = array('path' => 'admin/block/configure', 'title' => t('configure block'), + 'access' => user_access('administer blocks'), + '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_edit', + 'callback' => 'block_box_delete', 'type' => MENU_CALLBACK); $items[] = array('path' => 'admin/block/add', 'title' => t('add'), 'access' => user_access('administer blocks'), - 'callback' => 'block_box_edit', + 'callback' => 'block_box_add', 'type' => MENU_LOCAL_TASK); } @@ -75,31 +87,43 @@ function block_menu($may_cache) { * * Generates the administrator-defined blocks for display. */ -function block_block($op = 'list', $delta = 0) { - if ($op == '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; - } - else { - $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; +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 'configure 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; } } function block_admin_save($edit) { foreach ($edit as $module => $blocks) { foreach ($blocks as $delta => $block) { - db_query("UPDATE {blocks} SET region = %d, status = %d, custom = %d, path = '%s', weight = %d, throttle = %d WHERE module = '%s' AND delta = '%s'", - $block['region'], $block['status'], $block['custom'], $block['path'], $block['weight'], $block['throttle'], $module, $delta); + 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); } } - return t('the block settings have been updated.'); + return t('The block settings have been updated.'); } /** @@ -130,18 +154,19 @@ function _block_rehash($order_by = array $block['status'] = $old_blocks[$module][$delta]->status; $block['weight'] = $old_blocks[$module][$delta]->weight; $block['region'] = $old_blocks[$module][$delta]->region; - $block['path'] = $old_blocks[$module][$delta]->path; + $block['pages_show'] = $old_blocks[$module][$delta]->pages_show; + $block['pages'] = $old_blocks[$module][$delta]->pages; $block['custom'] = $old_blocks[$module][$delta]->custom; $block['throttle'] = $old_blocks[$module][$delta]->throttle; } else { $block['status'] = $block['weight'] = $block['region'] = $block['custom'] = 0; - $block['path'] = ''; + $block['pages'] = ''; } // reinsert blocks into table - db_query("INSERT INTO {blocks} (module, delta, status, weight, region, path, custom, throttle) VALUES ('%s', '%s', %d, %d, %d, '%s', %d, %d)", - $block['module'], $block['delta'], $block['status'], $block['weight'], $block['region'], $block['path'], $block['custom'], $block['throttle']); + db_query("INSERT INTO {blocks} (module, delta, status, weight, region, pages_show, pages, custom, throttle) VALUES ('%s', '%s', %d, %d, %d, %d, '%s', %d, %d)", + $block['module'], $block['delta'], $block['status'], $block['weight'], $block['region'], $block['pages_show'], $block['pages'], $block['custom'], $block['throttle']); $blocks[] = $block; @@ -161,27 +186,19 @@ function _block_rehash($order_by = array * Prepare the main block administration form. */ function block_admin_display() { - $blocks = _block_rehash(); - // Fetch input formats used by admin-defined boxes. - $formats = array(); - $result = db_query('SELECT bid, format FROM {boxes}'); - while ($box = db_fetch_object($result)) { - $formats[$box->bid] = $box->format; - } - - $header = array(t('Block'), t('Enabled'), t('Custom'), t('Throttle'), t('Weight'), t('Region'), t('Path'), array('data' => t('Operations'))); + $header = array(t('Block'), t('Enabled'), t('Throttle'), t('Weight'), t('Region'), array('data' => t('Operations'), 'colspan' => 2)); foreach ($blocks as $block) { - if ($block['module'] == 'block' && filter_access($formats[$block['delta']])) { - $edit = l(t('edit block'), 'admin/block/edit/'. $block['delta']); + if ($block['module'] == 'block') { + $operation = l(t('delete'), 'admin/block/delete/'. $block['delta']); } else { - $edit = ''; + $operation = ''; } - $rows[] = array($block['info'], array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][status', 1, $block['status']), 'align' => 'center'), array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][custom', 1, $block['custom']), 'align' => 'center'), array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][throttle', 1, $block['throttle'], NULL, module_exist('throttle') ? NULL : array('disabled' => 'disabled')), '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'))), form_textfield(NULL, $block['module'] .']['. $block['delta'] .'][path', $block['path'], 10, 255), $edit); + $rows[] = array($block['info'], array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][status', 1, $block['status']), 'align' => 'center'), array('data' => form_checkbox(NULL, $block['module'] .']['. $block['delta'] .'][throttle', 1, $block['throttle'], NULL, module_exist('throttle') ? NULL : array('disabled' => 'disabled')), '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'))), l(t('configure'), 'admin/block/configure/'. $block['module'] .'/'. $block['delta']), $operation); } $output = theme('table', $header, $rows); @@ -195,39 +212,88 @@ function block_box_get($bid) { } /** - * Menu callback; displays the block editing form. - * - * On edit, saves changes and displays the block overview. + * Menu callback; displays the block configuration form. */ -function block_box_edit($bid = 0) { +function block_admin_configure($module = NULL, $delta = 0) { $edit = $_POST['edit']; $op = $_POST['op']; switch ($op) { case t('Save block'): - drupal_set_message(block_box_save($edit)); + db_query("UPDATE {blocks} SET pages_show = %d, pages = '%s', custom = %d WHERE module = '%s' AND delta = '%s'", $edit['pages_show'], $edit['pages'], $edit['custom'], $module, $delta); + module_invoke($module, 'block', 'configure save', $delta, $edit); + drupal_set_message('The block configuration has been saved.'); cache_clear_all(); drupal_goto('admin/block'); + + default: + // Always evaluates to TRUE, but a validation step may be added later. + if (!$edit) { + $edit = db_fetch_array(db_query("SELECT pages, pages_show, custom FROM {blocks} WHERE module = '%s' AND delta = '%s'", $module, $delta)); + } - case t('Delete block'): - $form = ''. t('Are you sure you want to delete the block %name?', array('%name' => ''. $edit['info'] .'')) ."
\n"; - $form .= form_submit(t('Delete')); - $output = form($form); - break; + // Module-specific block configurations. + if ($settings = module_invoke($module, 'block', 'configure', $delta)) { + $form = form_group(t('Block-specific settings'), $settings); + } + + // 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']))); + + // Standard block configurations. + $group = form_radios(NULL, 'pages_show', $edit['pages_show'], array(t('Show on every page except the listed pages.'), t('Show on only the listed pages.'))); + $group .= 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 'blog' for the blog page and 'blog/*' for every personal blog. '<front>' is the front page. ")); + + $group .= form_radios(t('User options'), 'custom', $edit['custom'], array(t('Users may not turn on or off this block.'), t('Users may turn this block on or off, on by default.'), t('Users may turn this block on or off, off by default.')), t('Users can decide which blocks they want on or off on their account editing page.')); + + $form .= form_group(t('Visibility settings'), $group); + + $form .= form_submit(t('Save block')); + + print theme('page', form($form)); + } +} + +/** + * Menu callback; displays the block creation form. + */ +function block_box_add($bid = 0) { + $edit = $_POST['edit']; + $op = $_POST['op']; + + switch ($op) { + case t('Save block'): + drupal_set_message(block_box_save($edit)); + 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) { case t('Delete'): db_query('DELETE FROM {boxes} WHERE bid = %d', $bid); - drupal_set_message(t('The block has been deleted.')); + drupal_set_message(t('The block %name has been deleted.', array('%name' => ''. $box['info'] .''))); cache_clear_all(); drupal_goto('admin/block'); default: - if ($bid) { - $output = block_box_form(block_box_get($bid)); - } - else { - $output = block_box_form(); - } + $form = ''. t('Are you sure you want to delete the block %name?', array('%name' => ''. $box['info'] .'')) ."
\n"; + $form .= form_submit(t('Delete')); + $output = form($form); } print theme('page', $output); @@ -239,25 +305,16 @@ function block_box_form($edit = array()) $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 block overview page.', array('%overview' => url('admin/block')))); - if ($edit['bid']) { - $output .= form_hidden('bid', $edit['bid']); - } - - $output .= form_submit(t('Save block')); - if ($edit['bid']) { - $output .= form_submit(t('Delete block')); - } - - return form($output); + return $output; } -function block_box_save($edit) { +function block_box_save($edit, $delta = NULL) { if (!filter_access($edit['format'])) { $edit['format'] = FILTER_FORMAT_DEFAULT; } - if ($edit['bid']) { - db_query("UPDATE {boxes} SET title = '%s', body = '%s', info = '%s', format = %d WHERE bid = %d", $edit['title'], $edit['body'], $edit['info'], $edit['format'], $edit['bid']); + 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); return t('The block has been updated.'); } else { @@ -291,12 +348,12 @@ function block_user($type, $edit, &$user switch ($type) { case 'form': if ($category == 'account') { - $result = db_query('SELECT * FROM {blocks} WHERE custom = %d ORDER BY module, delta', 1); + $result = db_query('SELECT * FROM {blocks} WHERE status = 1 AND custom != 0 ORDER BY weight, module, delta'); while ($block = db_fetch_object($result)) { $data = module_invoke($block->module, 'block', 'list'); if ($data[$block->delta]['info']) { - $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->status); + $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)); } } @@ -333,35 +390,38 @@ function block_list($region) { if (!isset($blocks[$region])) { $blocks[$region] = array(); - $result = db_query('SELECT * FROM {blocks} WHERE (status = 1 OR custom = 1) '. ($region != 'all' ? 'AND region = %d ' : '') .'ORDER BY weight, module', $region == 'left' ? 0 : 1); + $result = db_query('SELECT * FROM {blocks} WHERE status = 1 '. ($region != 'all' ? 'AND region = %d ' : '') .'ORDER BY weight, module', $region == 'left' ? 0 : 1); while ($result && ($block = db_fetch_array($result))) { - // When the user's account setting is empty, we use the block's regular 'status' (which is the default) - if ($block['custom'] && $user->uid && !isset($user->block[$block['module']][$block['delta']])) { - $user->block[$block['module']][$block['delta']] = $block['status']; + // 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; } - - // Determine block visibility - $enabled = $block['status'] && (!$user->uid || !$block['custom']); - $custom = $block['custom'] && $user->block[$block['module']][$block['delta']]; // Match path if necessary - if ($block['path']) { + if ($block['pages']) { $base = parse_url($base_url); $session = session_name() .'='. session_id(); $url = str_replace(array($base['path'], '?'. $session), '', request_uri()); $url = ereg_replace('^/(\?q=)?', '', $url); - $matched = preg_match($block['path'], $url); + $regexp = '/^('. preg_replace(array('/(\r\n?|\n)/', '/\\\\\*/', '/(^|\|)\\\\