tableofcontents.module in Table of Contents 6.3

This is a filter module to generate a collapsible jquery enabled mediawiki style table of contents based on <h[1-6]> tags. Transforms header tags into named anchors.

It is a complete rewrite of the original non-jquery enabled tableofcontents filter module as follows: +added jquery to make ToC collapsible +preserves attributes on the header tags +checks for existing ID on headers and uses that if found (if none, creates one) +extends the minimum header level to 1 +header conversion is case insensitive +made the regex match for options on the <!--tableofcontents--> marker tolerant of spaces +replaced the comment with [tag ...] +added a more explanatory error message for invalid options & concatenated it into one string to prevent duplicates from being displayed +added several divs to make ToC themable via CSS +provided basic CSS

File

tableofcontents.module

<?php

/**
 * @file
 * This is a filter module to generate a collapsible jquery enabled mediawiki
 * style table of contents based on <h[1-6]> tags. Transforms header tags into
 * named anchors.
 *
 * It is a complete rewrite of the original non-jquery enabled tableofcontents
 * filter module as follows:
 *   +added jquery to make ToC collapsible
 *   +preserves attributes on the header tags
 *   +checks for existing ID on headers and uses that if found (if none,
 *    creates one)
 *   +extends the minimum header level to 1
 *   +header conversion is case insensitive
 *   +made the regex match for options on the <!--tableofcontents-->
 *    marker tolerant of spaces
 *   +replaced the comment with [tag ...]
 *   +added a more explanatory error message for invalid options & concatenated
 *    it into one string to prevent duplicates from being displayed
 *   +added several divs to make ToC themable via CSS
 *   +provided basic CSS
 */
define('TABLEOFCONTENTS_REMOVE_PATTERN', '/(?:<p(?:\\s[^>]*)?' . '>)?\\[toc(?:\\s[^]]*?)?\\](?:<\\/p\\s*>)?/');
define('TABLEOFCONTENTS_ALLOWED_TAGS', '<em> <i> <strong> <b> <u> <del> <ins> <sub> <sup> <cite> <strike> <s> <tt> <span> <font> <abbr> <acronym> <dfn> <q> <bdo> <big> <small>');

/**
 * Implementation of hook_init()
 *
 * We load the JS/CSS files here so we can cache the filter results.
 */
function tableofcontents_init() {

  // we probably should not do that on non-node pages!
  // (how do you determine that?)
  $path = drupal_get_path('module', 'tableofcontents');
  drupal_add_js($path . '/jquery.scrollTo-min.js');
  drupal_add_js($path . '/jquery.localscroll-min.js');
  drupal_add_js($path . '/tableofcontents.js');
  drupal_add_css($path . '/tableofcontents.css');
}

/**
 * Implementation of hook_help().
 */
function tableofcontents_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      return t('A module to create a table of contents based on HTML header tags. Changes headers to anchors for processing so it may be incompatible with other filters that process header tags. It does use existing IDs on the header tags if already present and only operates on header levels 1 - 6.');
  }
}

/**
 * Implementation of hook_filter_tips().
 */
function tableofcontents_filter_tips($delta, $format, $long = FALSE) {
  $override = variable_get('tableofcontents_allow_override_' . $format, TRUE);
  $op = $delta * 4 | ($long ? 2 : 0) | ($override ? 1 : 0);
  switch ($op) {

    // ($delta, $long, $override)
    case 0:

      // (0, 0, 0)
      return t('Use [toc ...] to insert a mediawiki style collapsible table of contents.');
    case 1:

      // (0, 0, 1)
      return t('Use [toc list: ol; title: Table of Contents; minlevel: 2; maxlevel: 3; attachments: yes;] to insert a mediawiki style collapsible table of contents. All the arguments are optional.');
    case 2:

      // (0, 1, 0)
      return t('Every instance of "[toc ...]" in the input text will be replaced with a collapsible mediawiki-style table of contents.');
    case 3:

      // (0, 1, 1)
      return t('Every instance of "[toc ...]" in the input text will be replaced with a collapsible mediawiki-style table of contents. Accepts options for title, list style, minimum heading level, and maximum heading level, and attachments as follows: [toc list: ol; title: Table of Contents; minlevel: 2; maxlevel: 3; attachments: yes;]. All arguments are optional.');
    case 4:

    // (1, 0, 0)
    case 5:

      // (1, 0, 1)
      return t('Add an identifier to all the anchors without one.');
    case 6:

    // (1, 1, 0)
    case 7:

      // (1, 1, 1)
      return t('Add an identifier to all the anchors without one. In most cases, this filter is not necessary with the table of contents block. However, once in a while, the automatic detection may fail. In those cases, add this filter to your pages so as to make sure to get all the anchors defined as necessary for the table of contents links to work.');
  }
}

/**
 * Implementation of hook_filter().
 */
function tableofcontents_filter($op, $delta = 0, $format = -1, $text = '') {
  global $_tableofcontents_block_processing;
  if ($op == 'list') {
    return array(
      0 => t('Table of contents'),
      1 => t('Assign an ID to each header'),
    );
  }
  switch ($op) {
    case 'description':
      switch ($delta) {
        default:
          return t('Inserts a table of contents in place of [toc ...] tags.');
        case 1:
          return t('Add an ID to all the anchors on the page. May be necessary in case the table of contents block is used.');
      }

      /*NOTREACHED*/
      break;
    case 'no cache':

      // allow caching
      return FALSE;
    case 'settings':
      module_load_include('admin.inc', 'tableofcontents');
      return _tableofcontents_settings($format);
    case 'prepare':
      if ($delta != 1) {
        module_load_include('pages.inc', 'tableofcontents');
        return _tableofcontents_prepare($delta, $format, $text);
      }
      return $text;
    case 'process':

      // NOTE: we cannot test for a [toc:...] and skip if none
      //       because the user could have the auto-toc turned on.
      if (!$_tableofcontents_block_processing) {
        module_load_include('pages.inc', 'tableofcontents');
        return _tableofcontents_process($delta, $format, $text);
      }
      return $text;
  }
}

/**
 * Save the extra data the TOC adds to nodes.
 */
function _tableofcontents_save($node) {

  // new nodes will not have our parameter set, make sure we have a default
  if (!isset($node->tableofcontents_toc_automatic)) {
    $node->tableofcontents_toc_automatic = 0;
  }
  $sql = "UPDATE {tableofcontents_node_toc} SET toc_automatic = %d WHERE nid = %d";
  db_query($sql, $node->tableofcontents_toc_automatic, $node->nid);
  if (db_affected_rows() == 0) {
    $sql = "INSERT INTO {tableofcontents_node_toc} (nid, toc_automatic) VALUES (%d, %d)";
    db_query($sql, $node->nid, $node->tableofcontents_toc_automatic);
  }
}

/**
 * Load the extra data for the node from the TOC table.
 */
function _tableofcontents_load(&$node) {
  $sql = "SELECT toc_automatic FROM {tableofcontents_node_toc} WHERE nid = %d";
  $result = db_query($sql, $node->nid);
  if ($toc = db_fetch_object($result)) {
    $node->tableofcontents_toc_automatic = $toc->toc_automatic;
  }
  else {
    $node->tableofcontents_toc_automatic = 0;
  }
}

/**
 * Implementation of hook_nodeapi
 *
 * We need to clear the cache to cover the case where file attachments have changed, but
 * the body hasn't. This might be a little aggressive, in that we clear the cache for any node
 * with attachments, but since this only occurs during editing or creating the load should be
 * pretty minimal. It also only happens if the node has file attachments.
 */
function tableofcontents_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
  global $user, $theme_key, $_tableofcontents_block_processing;
  switch ($op) {
    case 'prepare':
      if (isset($node->files)) {

        // Remove the cached version if there are attachments on this node
        $cid = $node->format . ':' . md5($node->body);
        cache_clear_all($cid, 'cache_filter');
      }
      break;
    case 'presave':
      if (variable_get('tableofcontents_remove_teaser_' . $node->format, TRUE)) {
        module_load_include('admin.inc', 'tableofcontents');
        _tableofcontents_hide_in_teaser($node);
      }
      break;
    case 'insert':
    case 'update':
      _tableofcontents_save($node);
      break;
    case 'load':
      _tableofcontents_load($node);
      break;
    case 'view':

      // $a3 represents the $teaser flag
      // $a4 represents the $page flag
      if (!$_tableofcontents_block_processing) {
        $processed = FALSE;
        if (variable_get('tableofcontents_nodetype_toc_vtoc_' . $node->type, FALSE)) {

          // ugly test to make sure we don't double the TOC (i.e. if automatic is turned
          // on we would apply the TOC twice when [toc] was used and the filter includes
          // the TOC!)
          if (strpos($node->content['body']['#value'], 'class="toc"') === FALSE) {
            $node->content['body']['#value'] = str_replace('[vtoc', '[toc', $node->content['body']['#value']);
            if (!$a4 || $a3 && variable_get('tableofcontents_nodetype_toc_remove_from_teaser_' . $node->type, TRUE)) {

              // remove from teaser or "non-page"
              $node->content['body']['#value'] = preg_replace(TABLEOFCONTENTS_REMOVE_PATTERN, '', $node->content['body']['#value']);
            }
            else {

              // TODO: if $a3 is true, then we should process the body and save the resulting table in the teaser
              //       (in other words, make sure we get the complete table of content instead of only the teaser part!)
              module_load_include('pages.inc', 'tableofcontents');
              $text = _tableofcontents_process(0, $node->format, $node->content['body']['#value']);
              if ($node->content['body']['#value'] != $text) {

                // if tableofcontents_hide_table_<format> is TRUE, then this is wrong...
                if (!variable_get('tableofcontents_hide_table_' . $node->format, FALSE)) {
                  $processed = TRUE;
                }
                $node->content['body']['#value'] = $text;
              }
            }
          }
        }
        if (!$processed) {

          // is the table of contents block visible?
          $rids = array_keys($user->roles);
          $sql = "SELECT b.bid FROM {blocks} b" . " LEFT JOIN {blocks_roles} r ON b.module = r.module AND b.delta = r.delta" . " WHERE b.delta = '0' AND b.module = 'tableofcontents_block' AND b.theme = '%s'" . " AND b.status = 1 AND (r.rid IN (" . db_placeholders($rids) . ") OR r.rid IS NULL)";
          $sql = db_rewrite_sql($sql, 'b', 'bid');
          $result = db_query($sql, array_merge(array(
            $theme_key,
          ), $rids));
          if (db_fetch_array($result)) {

            // there is a table of contents block, but the node was node parsed...
            // do that now
            module_load_include('pages.inc', 'tableofcontents');
            $node->content['body']['#value'] = _tableofcontents_process(1, $node->format, $node->content['body']['#value']);
          }
        }
      }
      break;
  }
}

/**
 * Add a field in nodes so one can mark the node as using a TOC without
 * the need for the [toc] tag.
 */
function tableofcontents_form_alter(&$form, $form_state, $form_id) {
  if (!$form_state['submitted']) {
    if (substr($form_id, -10) == '_node_form' && isset($form['nid'])) {
      module_load_include('admin.inc', 'tableofcontents');
      _tableofcontents_node_form_alter($form);
    }
    elseif ($form_id == 'node_type_form' && isset($form['identity']['type'])) {
      module_load_include('admin.inc', 'tableofcontents');
      _tableofcontents_nodetype_form_alter($form);
    }
  }
}

/**
 * Implementation of hook_theme().
 *
 * @return
 *   Array of theme hooks this module implements.
 */
function tableofcontents_theme() {
  return array(
    'tableofcontents_toc' => array(
      'arguments' => array(
        'toc' => NULL,
      ),
      'file' => 'tableofcontents.pages.inc',
    ),
    'tableofcontents_toc_text' => array(
      'arguments' => array(
        'toc' => NULL,
      ),
      'file' => 'tableofcontents.pages.inc',
    ),
    'tableofcontents_back_to_top' => array(
      'arguments' => array(
        'toc' => NULL,
      ),
      'file' => 'tableofcontents.pages.inc',
    ),
    'tableofcontents_number' => array(
      'arguments' => array(
        'toc' => NULL,
      ),
      'file' => 'tableofcontents.pages.inc',
    ),
    'tableofcontents_number_text' => array(
      'arguments' => array(
        'toc' => NULL,
      ),
      'file' => 'tableofcontents.pages.inc',
    ),
  );
}

// vim: ts=2 sw=2 et syntax=php

Functions

Name	Description
tableofcontents_filter	Implementation of hook_filter().
tableofcontents_filter_tips	Implementation of hook_filter_tips().
tableofcontents_form_alter	Add a field in nodes so one can mark the node as using a TOC without the need for the [toc] tag.
tableofcontents_help	Implementation of hook_help().
tableofcontents_init	Implementation of hook_init()
tableofcontents_nodeapi	Implementation of hook_nodeapi
tableofcontents_theme	Implementation of hook_theme().
_tableofcontents_load	Load the extra data for the node from the TOC table.
_tableofcontents_save	Save the extra data the TOC adds to nodes.

Constants

Name	Description
TABLEOFCONTENTS_ALLOWED_TAGS
TABLEOFCONTENTS_REMOVE_PATTERN	@file This is a filter module to generate a collapsible jquery enabled mediawiki style table of contents based on <h[1-6]> tags. Transforms header tags into named anchors.