webmaster@1: <?php
webmaster@7: // $Id: block.admin.inc,v 1.14.2.2 2008/06/24 14:40:08 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Admin page callbacks for the block module.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback for admin/build/block.
webmaster@1:  */
webmaster@1: function block_admin_display($theme = NULL) {
webmaster@1:   global $custom_theme;
webmaster@1: 
webmaster@1:   // If non-default theme configuration has been selected, set the custom theme.
webmaster@1:   $custom_theme = isset($theme) ? $theme : variable_get('theme_default', 'garland');
webmaster@1: 
webmaster@1:   // Fetch and sort blocks
webmaster@1:   $blocks = _block_rehash();
webmaster@1:   usort($blocks, '_block_compare');
webmaster@1: 
webmaster@1:   return drupal_get_form('block_admin_display_form', $blocks, $theme);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Generate main blocks administration form.
webmaster@1:  */
webmaster@1: function block_admin_display_form(&$form_state, $blocks, $theme = NULL) {
webmaster@1:   global $theme_key, $custom_theme;
webmaster@1: 
webmaster@1:   // Add CSS
webmaster@1:   drupal_add_css(drupal_get_path('module', 'block') .'/block.css', 'module', 'all', FALSE);
webmaster@1: 
webmaster@1:   // If non-default theme configuration has been selected, set the custom theme.
webmaster@1:   $custom_theme = isset($theme) ? $theme : variable_get('theme_default', 'garland');
webmaster@1:   init_theme();
webmaster@1: 
webmaster@1:   $throttle = module_exists('throttle');
webmaster@1:   $block_regions = system_region_list($theme_key) + array(BLOCK_REGION_NONE => '<'. t('none') .'>');
webmaster@1: 
webmaster@1:   // Build form tree
webmaster@1:   $form = array(
webmaster@1:     '#action' => arg(3) ? url('admin/build/block/list/'. $theme_key) : url('admin/build/block'),
webmaster@1:     '#tree' => TRUE,
webmaster@1:   );
webmaster@1: 
webmaster@1:   foreach ($blocks as $i => $block) {
webmaster@1:     $key = $block['module'] .'_'. $block['delta'];
webmaster@1:     $form[$key]['module'] = array(
webmaster@1:       '#type' => 'value',
webmaster@1:       '#value' => $block['module'],
webmaster@1:     );
webmaster@1:     $form[$key]['delta'] = array(
webmaster@1:       '#type' => 'value',
webmaster@1:       '#value' => $block['delta'],
webmaster@1:     );
webmaster@1:     $form[$key]['info'] = array(
webmaster@1:       '#value' => check_plain($block['info'])
webmaster@1:     );
webmaster@1:     $form[$key]['theme'] = array(
webmaster@1:       '#type' => 'hidden',
webmaster@1:       '#value' => $theme_key
webmaster@1:     );
webmaster@1:     $form[$key]['weight'] = array(
webmaster@1:       '#type' => 'weight',
webmaster@1:       '#default_value' => $block['weight'],
webmaster@1:     );
webmaster@1:     $form[$key]['region'] = array(
webmaster@1:       '#type' => 'select',
webmaster@1:       '#default_value' => $block['region'],
webmaster@1:       '#options' => $block_regions,
webmaster@1:     );
webmaster@1: 
webmaster@1:     if ($throttle) {
webmaster@1:       $form[$key]['throttle'] = array('#type' => 'checkbox', '#default_value' => isset($block['throttle']) ? $block['throttle'] : FALSE);
webmaster@1:     }
webmaster@1:     $form[$key]['configure'] = array('#value' => l(t('configure'), 'admin/build/block/configure/'. $block['module'] .'/'. $block['delta']));
webmaster@1:     if ($block['module'] == 'block') {
webmaster@1:       $form[$key]['delete'] = array('#value' => l(t('delete'), 'admin/build/block/delete/'. $block['delta']));
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   $form['submit'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => t('Save blocks'),
webmaster@1:   );
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Process main blocks administration form submission.
webmaster@1:  */
webmaster@1: function block_admin_display_form_submit($form, &$form_state) {
webmaster@1:   foreach ($form_state['values'] as $block) {
webmaster@1:     $block['status'] = $block['region'] != BLOCK_REGION_NONE;
webmaster@1:     $block['region'] = $block['status'] ? $block['region'] : '';
webmaster@1:     db_query("UPDATE {blocks} SET status = %d, weight = %d, region = '%s', throttle = %d WHERE module = '%s' AND delta = '%s' AND theme = '%s'", $block['status'], $block['weight'], $block['region'], isset($block['throttle']) ? $block['throttle'] : 0, $block['module'], $block['delta'], $block['theme']);
webmaster@1:   }
webmaster@1:   drupal_set_message(t('The block settings have been updated.'));
webmaster@1:   cache_clear_all();
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Helper function for sorting blocks on admin/build/block.
webmaster@1:  *
webmaster@1:  * Active blocks are sorted by region, then by weight.
webmaster@1:  * Disabled blocks are sorted by name.
webmaster@1:  */
webmaster@1: function _block_compare($a, $b) {
webmaster@1:   global $theme_key;
webmaster@1:   static $regions;
webmaster@1: 
webmaster@1:   // We need the region list to correctly order by region.
webmaster@1:   if (!isset($regions)) {
webmaster@1:     $regions = array_flip(array_keys(system_region_list($theme_key)));
webmaster@1:     $regions[BLOCK_REGION_NONE] = count($regions);
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Separate enabled from disabled.
webmaster@1:   $status = $b['status'] - $a['status'];
webmaster@1:   if ($status) {
webmaster@1:     return $status;
webmaster@1:   }
webmaster@1:   // Sort by region (in the order defined by theme .info file).
webmaster@3:   if ((!empty($a['region']) && !empty($b['region'])) && ($place = ($regions[$a['region']] - $regions[$b['region']]))) {
webmaster@1:     return $place;
webmaster@1:   }
webmaster@1:   // Sort by weight.
webmaster@1:   $weight = $a['weight'] - $b['weight'];
webmaster@1:   if ($weight) {
webmaster@1:     return $weight;
webmaster@1:   }
webmaster@1:   // Sort by title.
webmaster@1:   return strcmp($a['info'], $b['info']);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; displays the block configuration form.
webmaster@1:  */
webmaster@1: function block_admin_configure(&$form_state, $module = NULL, $delta = 0) {
webmaster@1: 
webmaster@1:   $form['module'] = array('#type' => 'value', '#value' => $module);
webmaster@1:   $form['delta'] = array('#type' => 'value', '#value' => $delta);
webmaster@1: 
webmaster@1:   $edit = db_fetch_array(db_query("SELECT pages, visibility, custom, title FROM {blocks} WHERE module = '%s' AND delta = '%s'", $module, $delta));
webmaster@1: 
webmaster@1:   $form['block_settings'] = array(
webmaster@1:     '#type' => 'fieldset',
webmaster@1:     '#title' => t('Block specific settings'),
webmaster@1:     '#collapsible' => TRUE,
webmaster@1:   );
webmaster@1:   $form['block_settings']['title'] = array(
webmaster@1:     '#type' => 'textfield',
webmaster@1:     '#title' => t('Block title'),
webmaster@1:     '#maxlength' => 64,
webmaster@1:     '#description' => $module == 'block' ? t('The title of the block as shown to the user.') : t('Override the default title for the block. Use <em>&lt;none&gt;</em> to display no title, or leave blank to use the default block title.'),
webmaster@1:     '#default_value' => $edit['title'],
webmaster@1:     '#weight' => -18,
webmaster@1:   );
webmaster@1: 
webmaster@1: 
webmaster@1:   // Module-specific block configurations.
webmaster@1:   if ($settings = module_invoke($module, 'block', 'configure', $delta)) {
webmaster@1:     foreach ($settings as $k => $v) {
webmaster@1:       $form['block_settings'][$k] = $v;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Get the block subject for the page title.
webmaster@1:   $info = module_invoke($module, 'block', 'list');
webmaster@1:   if (isset($info[$delta])) {
webmaster@1:     drupal_set_title(t("'%name' block", array('%name' => $info[$delta]['info'])));
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Standard block configurations.
webmaster@1:   $form['user_vis_settings'] = array(
webmaster@1:     '#type' => 'fieldset',
webmaster@1:     '#title' => t('User specific visibility settings'),
webmaster@1:     '#collapsible' => TRUE,
webmaster@1:   );
webmaster@1:   $form['user_vis_settings']['custom'] = array(
webmaster@1:     '#type' => 'radios',
webmaster@1:     '#title' => t('Custom visibility settings'),
webmaster@1:     '#options' => array(
webmaster@1:       t('Users cannot control whether or not they see this block.'),
webmaster@1:       t('Show this block by default, but let individual users hide it.'),
webmaster@1:       t('Hide this block by default but let individual users show it.')
webmaster@1:     ),
webmaster@1:     '#description' => t('Allow individual users to customize the visibility of this block in their account settings.'),
webmaster@1:     '#default_value' => $edit['custom'],
webmaster@1:   );
webmaster@1: 
webmaster@1:   // Role-based visibility settings
webmaster@1:   $default_role_options = array();
webmaster@1:   $result = db_query("SELECT rid FROM {blocks_roles} WHERE module = '%s' AND delta = '%s'", $module, $delta);
webmaster@1:   while ($role = db_fetch_object($result)) {
webmaster@1:     $default_role_options[] = $role->rid;
webmaster@1:   }
webmaster@1:   $result = db_query('SELECT rid, name FROM {role} ORDER BY name');
webmaster@1:   $role_options = array();
webmaster@1:   while ($role = db_fetch_object($result)) {
webmaster@1:     $role_options[$role->rid] = $role->name;
webmaster@1:   }
webmaster@1:   $form['role_vis_settings'] = array(
webmaster@1:     '#type' => 'fieldset',
webmaster@1:     '#title' => t('Role specific visibility settings'),
webmaster@1:     '#collapsible' => TRUE,
webmaster@1:   );
webmaster@1:   $form['role_vis_settings']['roles'] = array(
webmaster@1:     '#type' => 'checkboxes',
webmaster@1:     '#title' => t('Show block for specific roles'),
webmaster@1:     '#default_value' => $default_role_options,
webmaster@1:     '#options' => $role_options,
webmaster@1:     '#description' => t('Show this block only for the selected role(s). If you select no roles, the block will be visible to all users.'),
webmaster@1:   );
webmaster@1: 
webmaster@1:   $form['page_vis_settings'] = array(
webmaster@1:     '#type' => 'fieldset',
webmaster@1:     '#title' => t('Page specific visibility settings'),
webmaster@1:     '#collapsible' => TRUE,
webmaster@1:   );
webmaster@1:   $access = user_access('use PHP for block visibility');
webmaster@1: 
webmaster@1:   if ($edit['visibility'] == 2 && !$access) {
webmaster@1:     $form['page_vis_settings'] = array();
webmaster@1:     $form['page_vis_settings']['visibility'] = array('#type' => 'value', '#value' => 2);
webmaster@1:     $form['page_vis_settings']['pages'] = array('#type' => 'value', '#value' => $edit['pages']);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $options = array(t('Show on every page except the listed pages.'), t('Show on only the listed pages.'));
webmaster@1:     $description = t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array('%blog' => 'blog', '%blog-wildcard' => 'blog/*', '%front' => '<front>'));
webmaster@1: 
webmaster@1:     if ($access) {
webmaster@1:       $options[] = t('Show if the following PHP code returns <code>TRUE</code> (PHP-mode, experts only).');
webmaster@1:       $description .= ' '. t('If the PHP-mode is chosen, enter PHP code between %php. Note that executing incorrect PHP-code can break your Drupal site.', array('%php' => '<?php ?>'));
webmaster@1:     }
webmaster@1:     $form['page_vis_settings']['visibility'] = array(
webmaster@1:       '#type' => 'radios',
webmaster@1:       '#title' => t('Show block on specific pages'),
webmaster@1:       '#options' => $options,
webmaster@1:       '#default_value' => $edit['visibility'],
webmaster@1:     );
webmaster@1:     $form['page_vis_settings']['pages'] = array(
webmaster@1:       '#type' => 'textarea',
webmaster@1:       '#title' => t('Pages'),
webmaster@1:       '#default_value' => $edit['pages'],
webmaster@1:       '#description' => $description,
webmaster@1:     );
webmaster@1:   }
webmaster@1: 
webmaster@1:   $form['submit'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => t('Save block'),
webmaster@1:   );
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: function block_admin_configure_validate($form, &$form_state) {
webmaster@1:   if ($form_state['values']['module'] == 'block') {
webmaster@1:     if (empty($form_state['values']['info']) || db_result(db_query("SELECT COUNT(*) FROM {boxes} WHERE bid != %d AND info = '%s'", $form_state['values']['delta'], $form_state['values']['info']))) {
webmaster@1:       form_set_error('info', t('Please ensure that each block description is unique.'));
webmaster@1:     }
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: function block_admin_configure_submit($form, &$form_state) {
webmaster@1:   if (!form_get_errors()) {
webmaster@1:     db_query("UPDATE {blocks} SET visibility = %d, pages = '%s', custom = %d, title = '%s' WHERE module = '%s' AND delta = '%s'", $form_state['values']['visibility'], trim($form_state['values']['pages']), $form_state['values']['custom'], $form_state['values']['title'], $form_state['values']['module'], $form_state['values']['delta']);
webmaster@1:     db_query("DELETE FROM {blocks_roles} WHERE module = '%s' AND delta = '%s'", $form_state['values']['module'], $form_state['values']['delta']);
webmaster@1:     foreach (array_filter($form_state['values']['roles']) as $rid) {
webmaster@1:       db_query("INSERT INTO {blocks_roles} (rid, module, delta) VALUES (%d, '%s', '%s')", $rid, $form_state['values']['module'], $form_state['values']['delta']);
webmaster@1:     }
webmaster@1:     module_invoke($form_state['values']['module'], 'block', 'save', $form_state['values']['delta'], $form_state['values']);
webmaster@1:     drupal_set_message(t('The block configuration has been saved.'));
webmaster@1:     cache_clear_all();
webmaster@1:     $form_state['redirect'] = 'admin/build/block';
webmaster@1:     return;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback: display the custom block addition form.
webmaster@1:  */
webmaster@1: function block_add_block_form(&$form_state) {
webmaster@1:   return block_admin_configure($form_state, 'block', NULL);
webmaster@1: }
webmaster@1: 
webmaster@1: function block_add_block_form_validate($form, &$form_state) {
webmaster@1:   if (empty($form_state['values']['info']) || db_result(db_query("SELECT COUNT(*) FROM {boxes} WHERE info = '%s'", $form_state['values']['info']))) {
webmaster@1:     form_set_error('info', t('Please ensure that each block description is unique.'));
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Save the new custom block.
webmaster@1:  */
webmaster@1: function block_add_block_form_submit($form, &$form_state) {
webmaster@1:   db_query("INSERT INTO {boxes} (body, info, format) VALUES ('%s', '%s', %d)", $form_state['values']['body'], $form_state['values']['info'], $form_state['values']['format']);
webmaster@1:   $delta = db_last_insert_id('boxes', 'bid');
webmaster@1: 
webmaster@1:   foreach (list_themes() as $key => $theme) {
webmaster@1:     if ($theme->status) {
webmaster@1:       db_query("INSERT INTO {blocks} (visibility, pages, custom, title, module, theme, status, weight, delta, cache) VALUES(%d, '%s', %d, '%s', '%s', '%s', %d, %d, %d, %d)", $form_state['values']['visibility'], trim($form_state['values']['pages']), $form_state['values']['custom'], $form_state['values']['title'], $form_state['values']['module'], $theme->name, 0, 0, $delta, BLOCK_NO_CACHE);
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   foreach (array_filter($form_state['values']['roles']) as $rid) {
webmaster@1:     db_query("INSERT INTO {blocks_roles} (rid, module, delta) VALUES (%d, '%s', '%s')", $rid, $form_state['values']['module'], $delta);
webmaster@1:   }
webmaster@1: 
webmaster@1:   drupal_set_message(t('The block has been created.'));
webmaster@1:   cache_clear_all();
webmaster@1: 
webmaster@1:   $form_state['redirect'] = 'admin/build/block';
webmaster@1:   return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; confirm deletion of custom blocks.
webmaster@1:  */
webmaster@1: function block_box_delete(&$form_state, $bid = 0) {
webmaster@1:   $box = block_box_get($bid);
webmaster@7:   $form['info'] = array('#type' => 'hidden', '#value' => $box['info']);
webmaster@1:   $form['bid'] = array('#type' => 'hidden', '#value' => $bid);
webmaster@1: 
webmaster@1:   return confirm_form($form, t('Are you sure you want to delete the block %name?', array('%name' => $box['info'])), 'admin/build/block', '', t('Delete'), t('Cancel'));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Deletion of custom blocks.
webmaster@1:  */
webmaster@1: function block_box_delete_submit($form, &$form_state) {
webmaster@1:   db_query('DELETE FROM {boxes} WHERE bid = %d', $form_state['values']['bid']);
webmaster@1:   db_query("DELETE FROM {blocks} WHERE module = 'block' AND delta = %d", $form_state['values']['bid']);
webmaster@1:   drupal_set_message(t('The block %name has been removed.', array('%name' => $form_state['values']['info'])));
webmaster@1:   cache_clear_all();
webmaster@1:   $form_state['redirect'] = 'admin/build/block';
webmaster@1:   return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Process variables for block-admin-display.tpl.php.
webmaster@1:  *
webmaster@1:  * The $variables array contains the following arguments:
webmaster@1:  * - $form
webmaster@1:  *
webmaster@1:  * @see block-admin-display.tpl.php
webmaster@1:  * @see theme_block_admin_display()
webmaster@1:  */
webmaster@1: function template_preprocess_block_admin_display_form(&$variables) {
webmaster@1:   global $theme_key;
webmaster@1: 
webmaster@1:   $block_regions = system_region_list($theme_key);
webmaster@1:   $variables['throttle'] = module_exists('throttle');
webmaster@1:   $variables['block_regions'] = $block_regions + array(BLOCK_REGION_NONE => t('Disabled'));
webmaster@1: 
webmaster@1:   foreach ($block_regions as $key => $value) {
webmaster@1:     // Highlight regions on page to provide visual reference.
webmaster@1:     drupal_set_content($key, '<div class="block-region">'. $value .'</div>');
webmaster@1:     // Initialize an empty array for the region.
webmaster@1:     $variables['block_listing'][$key] = array();
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Initialize disabled blocks array.
webmaster@1:   $variables['block_listing'][BLOCK_REGION_NONE] = array();
webmaster@1: 
webmaster@1:   // Set up to track previous region in loop.
webmaster@1:   $last_region = '';
webmaster@1:   foreach (element_children($variables['form']) as $i) {
webmaster@1:     $block = &$variables['form'][$i];
webmaster@1: 
webmaster@1:     // Only take form elements that are blocks.
webmaster@1:     if (isset($block['info'])) {
webmaster@1:       // Fetch region for current block.
webmaster@1:       $region = $block['region']['#default_value'];
webmaster@1: 
webmaster@1:       // Set special classes needed for table drag and drop.
webmaster@1:       $variables['form'][$i]['region']['#attributes']['class'] = 'block-region-select block-region-'. $region;
webmaster@1:       $variables['form'][$i]['weight']['#attributes']['class'] = 'block-weight block-weight-'. $region;
webmaster@1: 
webmaster@1:       $variables['block_listing'][$region][$i]->row_class = isset($block['#attributes']['class']) ? $block['#attributes']['class'] : '';
webmaster@1:       $variables['block_listing'][$region][$i]->block_modified = isset($block['#attributes']['class']) && strpos($block['#attributes']['class'], 'block-modified') !== FALSE ? TRUE : FALSE;
webmaster@1:       $variables['block_listing'][$region][$i]->block_title =  drupal_render($block['info']);
webmaster@1:       $variables['block_listing'][$region][$i]->region_select = drupal_render($block['region']) . drupal_render($block['theme']);
webmaster@1:       $variables['block_listing'][$region][$i]->weight_select = drupal_render($block['weight']);
webmaster@1:       $variables['block_listing'][$region][$i]->throttle_check = $variables['throttle'] ? drupal_render($block['throttle']) : '';
webmaster@1:       $variables['block_listing'][$region][$i]->configure_link = drupal_render($block['configure']);
webmaster@1:       $variables['block_listing'][$region][$i]->delete_link = !empty($block['delete']) ? drupal_render($block['delete']) : '';
webmaster@1:       $variables['block_listing'][$region][$i]->printed = FALSE;
webmaster@1: 
webmaster@1:       $last_region = $region;
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   $variables['form_submit'] = drupal_render($variables['form']);
webmaster@1: }