block.module

<?php
// $Id$

/**
 * @file
 * Controls the boxes that are displayed around the main content.
 */

/**
 * Implementation of hook_help().
 */
function block_help($section) {
  switch ($section) {
    case 'admin/help#block':
      return t('
<p>Blocks are the boxes visible in the sidebar(s) of your web site and other regions. These are usually generated automatically by modules (e.g. recent forum topics), but you can also create your own blocks.</p>
<p>The region each block appears in depends on both which theme you are using (some are left-only, some right, some both, and some may offer other regions), 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>');
    case 'admin/modules#description':
      return t('Controls the boxes that are displayed around the main content.');
    case 'admin/block':
      return t("
<p>Blocks are content rendered into regions, often 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 area of the page they will show up on (e.g., a sidebar) and in which order they appear (weight).  Highlighting on this page shows the regions where content will be rendered.</p>
<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.</p>
", array('%throttle' => url('admin/settings/throttle')));
    case 'admin/block/add':
      return t('<p>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.</p>', array('%overview' => url('admin/block')));
  }
}

/**
 * Implementation of hook_perm().
 */
function block_perm() {
  return array('administer blocks');
}

/**
 * Implementation of hook_menu().
 */
function block_menu($may_cache) {
  $items = array();

  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);
    $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_delete',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/block/add', 'title' => t('add block'),
      'access' => user_access('administer blocks'),
      'callback' => 'block_box_add',
      'type' => MENU_LOCAL_TASK);
    foreach (list_themes() as $key => $theme) {
      if ($theme->status) {
        if ($key == variable_get('theme_default', 'bluemarine')) {
          $items[] = array('path' => 'admin/block/list/' . $key, 'title' => t('%key settings', array('%key' => $key)),
            'access' => user_access('administer blocks'), 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
        }
        else {
          $items[] = array('path' => 'admin/block/list/' . $key, 'title' => t('%key settings', array('%key' => $key)),
            'access' => user_access('administer blocks'), 'type' => MENU_LOCAL_TASK);
        }
      }
    }
  }

  return $items;
}

/**
 * Implementation of hook_block().
 *
 * Generates the administrator-defined blocks for display.
 */
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 ? check_plain($block->info) : check_plain($block->title);
      }
      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'] = check_plain($block->title);
      $data['content'] = check_markup($block->body, $block->format, FALSE);
      return $data;
  }
}

function block_admin_save($edit) {
  foreach ($edit as $module => $blocks) {
    foreach ($blocks as $delta => $block) {
      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'], $block['throttle'], $module, $delta, $block['theme']);
    }
  }
}

/**
 * Update the 'blocks' DB table with the blocks currently exported by modules.
 *
 * @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.
 *
 * @return
 *   Blocks currently exported by modules, sorted by $order_by.
 */
function _block_rehash($order_by = array('weight')) {
  global $theme_key;

  if (empty($theme_key)) {
    init_theme();
  }

  $result = db_query("SELECT * FROM {blocks} WHERE theme = '%s'", $theme_key);
  while ($old_block = db_fetch_object($result)) {
    $old_blocks[$old_block->module][$old_block->delta] = $old_block;
  }

  db_query("DELETE FROM {blocks} WHERE theme = '%s'", $theme_key);

  foreach (module_list() as $module) {
    $module_blocks = module_invoke($module, 'block', 'list');
    if ($module_blocks) {
      foreach ($module_blocks as $delta => $block) {
        $block['module'] = $module;
        $block['delta']  = $delta;
        // If previously written to database, load values.
        if ($old_blocks[$module][$delta]) {
          $block['status'] = $old_blocks[$module][$delta]->status;
          $block['weight'] = $old_blocks[$module][$delta]->weight;
          $block['region'] = $old_blocks[$module][$delta]->region;
          $block['visibility'] = $old_blocks[$module][$delta]->visibility;
          $block['pages'] = $old_blocks[$module][$delta]->pages;
          $block['custom'] = $old_blocks[$module][$delta]->custom;
          $block['throttle'] = $old_blocks[$module][$delta]->throttle;
        }
        // Otherwise, use any set values, or else substitute defaults.
        else {
          $properties = array ('status' => 0, 'weight' => 0, 'region' => 'left', 'pages' => '', 'custom' => 0);
          foreach ($properties as $property => $default) {
            if (!isset ($block[$property])) {
              $block[$property] = $default;
            }
          }
        }

        // reinsert blocks into table
        db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, visibility, pages, custom, throttle) VALUES ('%s', '%s', '%s', %d, %d, '%s', %d, '%s', %d, %d)",
          $block['module'], $block['delta'], $theme_key, $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle']);
        $blocks[] = $block;

        // build array to sort on
        $order[$order_by[0]][] = $block[$order_by[0]];
      }
    }
  }

  // sort
  array_multisort($order[$order_by[0]], $order_by[1] ? $order_by[1] : SORT_ASC, $order_by[2] ? $order_by[2] : SORT_REGULAR, $blocks);

  return $blocks;
}

/**
 * Prepare the main block administration form.
 */
function block_admin_display() {
  global $theme_key;
  $throttle = module_exist('throttle');

  $blocks = _block_rehash();
  $block_regions = system_region_list($theme_key);

  $form[action] = arg(3) ? url('admin/block/list/' . $theme_key) : url('admin/block');
  $form[tree] = TRUE;
  foreach ($blocks as $block) {
    $form[$block['module']][$block['delta']]['info'] = array(type => 'markup', value => $block['info']);
    $form[$block['module']][$block['delta']]['status'] = array(type => 'checkbox', default_value => $block['status']);
    $form[$block['module']][$block['delta']]['theme'] = array(type => 'hidden', value => $theme_key);
    $form[$block['module']][$block['delta']]['weight'] = array(type => 'weight', default_value => $block['weight']);
    $form[$block['module']][$block['delta']]['region'] = array(type => 'select', default_value => isset($block['region']) ? $block['region'] : system_default_region(), options => $block_regions);

    if ($throttle) {
      $form[$block['module']][$block['delta']]['throttle'] = array(type => 'checkbox', default_value => $block['throttle']);
    }
    $form[$block['module']][$block['delta']]['configure'] = array(type => 'markup', value => l(t('configure'), 'admin/block/configure/'. $block['module'] .'/'. $block['delta']));
    if ($block['module'] == 'block') {
      $form[$block['module']][$block['delta']]['delete'] = array(type => 'markup', value => l(t('delete'), 'admin/block/delete/'. $block['delta']));
    }
  }
  $form['submit'] = array(type => 'submit', value => t('Save blocks'));

  return drupal_get_form('block_admin_display', $form);
}

function theme_block_admin_display($form) {

  global $theme_key, $custom_theme;
  $throttle = module_exist('throttle');

  // If non-default theme configuration has been selected, set the custom theme.
  if (arg(3)) {
    $custom_theme = arg(3);
    init_theme();
  }
  $block_regions = system_region_list($theme_key);

  // Highlight regions on page, to provide visual reference.
  foreach ($block_regions as $key => $value) {
    drupal_set_content($key, '<div class="block-region">' . $value . '</div>');
  }
  $regions = array();
  $disabled = array();
  foreach (element_children($form) as $module) {
    // Don't take form control structures
    if (is_array($form[$module])) {
      foreach ($form[$module] as $delta => $element) {
        // Only take form elements that are blocks
        if (is_array($form[$module][$delta]['info'])) {
          $block = $form[$module][$delta];
          $row = array(array('data' => form_render($block['info']), 'class' => 'block'), form_render($block['status']) . form_render($block['theme']), form_render($block['weight']), form_render($block['region']));
          if ($throttle) {
            $row[] = form_render($block['throttle']);
          }
          $row[] = form_render($block['configure']);
          $row[] = $block['delete'] ? form_render($block['delete']) : '';
          if ($block['status'][default_value]) {
            $regions[$block['region'][default_value]][] = $row;
          }
          else if ($block['region'][default_value] <= 1) {
            $disabled[] = $row;
          }
        }
      }
    }
  }

  $rows = array();
  if (count($regions)) {
    foreach ($regions as $region => $row) {
      $region_title = t('%region', array ('%region' => ucfirst($block_regions[$region])));
      $rows[] = array(array('data' => $region_title, 'class' => 'region', 'colspan' => ($throttle ? 7 : 6)));
      $rows = array_merge($rows, $row);
    }
  }
  if (count($disabled)) {
    $rows[] = array(array('data' => t('Disabled'), 'class' => 'region', 'colspan' => ($throttle ? 7 : 6)));
    $rows = array_merge($rows, $disabled);
  }
  $header = array(t('Block'), t('Enabled'), t('Weight'), t('Placement'));
  if ($throttle) {
    $header[] = t('Throttle');
  }
  $header[] = array('data' => t('Operations'), 'colspan' => 2);
  $output = theme('table', $header, $rows, array('id' => 'blocks'));
  $output .= form_render($form['submit']);
  return $output;
}

function block_box_get($bid) {
  return db_fetch_array(db_query('SELECT * FROM {boxes} WHERE bid = %d', $bid));
}

/**
 * Menu callback; displays the block configuration form.
 */
function block_admin_configure($module = NULL, $delta = 0) {
  $edit = $_POST['edit'];
  $op = $_POST['op'];

  switch ($op) {
    case t('Save block'):
      db_query("UPDATE {blocks} SET visibility = %d, pages = '%s', custom = %d WHERE module = '%s' AND delta = '%s'", $edit['visibility'], $edit['pages'], $edit['custom'], $module, $delta);
      module_invoke($module, 'block', 'save', $delta, $edit);
      drupal_set_message(t('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, visibility, custom FROM {blocks} WHERE module = '%s' AND delta = '%s'", $module, $delta));
      }

      // Module-specific block configurations.
      if ($settings = module_invoke($module, 'block', 'configure', $delta)) {
          $form['block_settings'] = array(type => 'fieldset',
            title => t('Block specific settings'),
            collapsible => true,
            collapsed => false,
            weight => 0);

          foreach ($settings as $k => $v) {
            $form['block_settings'][$k] = $v;
          }
      }

      // 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.

      $form['user_vis_settings'] = array(type => 'fieldset',
        title => t('User specific visibility settings'),
        collapsible => true,
        collapsed => false,
        weight => 0);

      $form['user_vis_settings']['custom'] = array(
        type => 'radios',
        title => t('Custom visibility settings'),
        default_value => $edit['custom'],
        options => 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.'),
        default_value => $edit['custom']);


      $form['page_vis_settings'] = array(type => 'fieldset',
        title => t('Page specific visibility settings'),
        collapsible => true,
        collapsed => false,
        weight => 0);


      $form['page_vis_settings']['visibility'] = array(
        type => 'radios',
        title => t('Show block on specific pages'),
        default_value => $edit['visibility'],
        options => array(t('Show on every page except the listed pages.'), t('Show on only the listed pages.'), t('Show if the following PHP code returns <code>TRUE</code> (PHP-mode, experts only).')),
        default_value => $edit['visibility']);

      $form['page_vis_settings']['pages'] = array(
        type => 'textarea',
        title => t('Pages'),
        default_value => $edit['pages'],
        cols => 60,
        rows => 5,
        description => t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are '%blog' for the blog page and %blog1 for every personal blog. %front is the front page. If the PHP-mode is chosen, enter PHP code between %php.  Note that executing incorrect PHP-code can break your Drupal site.", array('%blog' => theme('placeholder', 'blog'), '%blog1' =>  theme('placeholder', 'blog/*'), '%front' => theme('placeholder', '<front>'), '%php' => theme('placeholder', '<?php ?>'))));

      $form['submit'] = array(type => 'submit', value => t('Save block'));

      return drupal_get_form('block_config', $form);
  }
}

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

  switch ($op) {
    case t('Save block'):
      if (block_box_save($edit)) {
        drupal_set_message(t('The block has been created.'));
        drupal_goto('admin/block');
      }
      // deliberate no break
    default:
      $form = block_box_form($edit);
      $form['submit'] = array(type => 'submit', value => t('Save block'));
  }

  return drupal_get_form('block_box_add', $form);
}

/**
 * Menu callback; confirm deletion of custom blocks.
 */
function block_box_delete($bid = 0) {
  $box = block_box_get($bid);
  $form['info'] = array(type => 'hidden', value => $box['info'] ? $box['info'] : $box['title']);
  $form['bid'] = array(type => 'hidden', value => $bid);

  return confirm_form('block_box_delete_confirm', $form, t('Are you sure you want to delete the block %name?', array('%name' => theme('placeholder', $info))), 'admin/block', '', t('Delete'), t('Cancel'));
}

/**
 * Deletion of custom blocks.
 */
function block_box_delete_confirm_execute($form_id, $edit) {
  $form = $GLOBALS['form_values'];
  db_query('DELETE FROM {boxes} WHERE bid = %d', $form['bid']);
  drupal_set_message(t('The block %name has been removed.', array('%name' => theme('placeholder', $form['info']))));
  cache_clear_all();
  drupal_goto('admin/block');
};


function block_box_form($edit = array()) {
  $form['title'] = array(type => 'textfield', title => t('Block title'), default_value => $edit['title'], size => 60, maxlength => 64, description => t('The title of the block as shown to the user.'));
  $form['format'] = filter_form($edit['format']);
  $form['body'] = array(type => 'textarea', title => t('Block body'), default_value => $edit['body'], cols => 60, rows => 15, description => t('The content of the block as shown to the user.'));
  $form['info'] = array(type => 'textfield', title => t('Block description'), default_value => $edit['info'], size => 60, maxlength => 64, description => t('A brief description of your block. Used on the <a href="%overview">block overview page</a>.', array('%overview' => url('admin/block'))), required => TRUE);

  return $form;
}

function block_box_save($edit, $delta = NULL) {
  if (!filter_access($edit['format'])) {
    $edit['format'] = FILTER_FORMAT_DEFAULT;
  }

  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);
  }
  else {
    if (empty($edit['info']) || db_num_rows(db_query("SELECT info FROM {boxes} WHERE info = '%s'", $edit['info']))) {
      form_set_error('info', t('Please ensure that each block description is unique.'));
      return false;
    }
    db_query("INSERT INTO {boxes} (title, body, info, format) VALUES  ('%s', '%s', '%s', %d)", $edit['title'], $edit['body'], $edit['info'], $edit['format']);
  }
  return true;
}

/**
 * Menu callback; displays the block overview page.
 */
function block_admin() {
  $edit = $_POST['edit'];
  $op = $_POST['op'];

  if ($op == t('Save blocks')) {
    block_admin_save($edit);
    drupal_set_message(t('The blocks have been saved.'));
    cache_clear_all();
    drupal_goto($_GET['q']);
  }
  return block_admin_display();
}

/**
 * Implementation of hook_user().
 *
 * Allow users to decide which custom blocks to display when they visit
 * the site.
 */
function block_user($type, $edit, &$user, $category = NULL) {
  switch ($type) {
    case 'form':
      if ($category == 'account') {
        $result = db_query('SELECT * FROM {blocks} WHERE status = 1 AND custom != 0 ORDER BY weight, module, delta');
        $form['block'] = array(type => 'fieldset', title => t('Block configuration'), weight => 3, collapsible => TRUE, collapsed => FALSE, tree => TRUE);
        while ($block = db_fetch_object($result)) {
          $data = module_invoke($block->module, 'block', 'list');
          if ($data[$block->delta]['info']) {
            $return = TRUE;
            $form['block'][$block->module][$block->delta] = array(type => 'checkbox', title => $data[$block->delta]['info'], default_value => isset($user->block[$block->module][$block->delta]) ? $user->block[$block->module][$block->delta] : ($block->custom == 1));
          }
        }

        if ($return) {
          return $form;
        }
      }

      break;
    case 'validate':
      if (!$edit['block']) {
        $edit['block'] = array();
      }
      return $edit;
  }
}

/**
 * Return all blocks in the specified region for the current user.
 *
 * @param $region
 *   The name of a region.
 *
 * @return
 *   An array of block objects, indexed with <i>module</i>_<i>delta</i>.
 *   If you are displaying your blocks in one or two sidebars, you may check
 *   whether this array is empty to see how many columns are going to be
 *   displayed.
 *
 * @todo
 *   Add a proper primary key (bid) to the blocks table so we don't have
 *   to mess around with this <i>module</i>_<i>delta</i> construct.
 *   Currently, the blocks table has no primary key defined!
 */
function block_list($region) {
  global $user, $theme_key;

  static $blocks = array();

  if (!count($blocks)) {
    $result = db_query("SELECT * FROM {blocks} WHERE theme = '%s' AND status = 1 ORDER BY region, weight, module", $theme_key);
    while ($block = db_fetch_object($result)) {
      if(!isset($blocks[$block->region])) {
        $blocks[$block->region] = array();
      }
      // 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;
      }

      // Match path if necessary
      if ($block->pages) {
        if ($block->visibility < 2) {
          $path = drupal_get_path_alias($_GET['q']);
          $regexp = '/^('. preg_replace(array('/(\r\n?|\n)/', '/\\\\\*/', '/(^|\|)\\\\<front\\\\>($|\|)/'), array('|', '.*', '\1'. preg_quote(variable_get('site_frontpage', 'node'), '/') .'\2'), preg_quote($block->pages, '/')) .')$/';
          $page_match = !($block->visibility xor preg_match($regexp, $path));
        }
        else {
          $page_match = drupal_eval($block->pages);
        }
      }
      else {
        $page_match = TRUE;
      }

      if ($enabled && $page_match) {
        // Check the current throttle status and see if block should be displayed
        // based on server load.
        if (!($block->throttle && (module_invoke('throttle', 'status') > 0))) {
          if (is_array($array = module_invoke($block->module, 'block', 'view', $block->delta))) {
            foreach ($array as $k => $v) {
              $block->$k = $v;
            }
          }
        }
        if (isset($block->content) && $block->content) {
          $blocks[$block->region]["{$block->module}_{$block->delta}"] = $block;
        }
      }
    }
  }
  // Create an empty array if there were no entries
  if(!isset($blocks[$region])) {
    $blocks[$region] = array();
  }
  return $blocks[$region];
}