codefilter.module in Code Filter 5

File

codefilter.module

<?php

/**
 * Implementation of hook_filter_tips()
 */
function codefilter_filter_tips($delta, $format, $long = false) {
  if ($long) {
    return t('To post pieces of code, surround them with &lt;code&gt;...&lt;/code&gt; tags. For PHP code, you can use &lt;?php ... ?&gt;, which will also colour it based on syntax.');
  }
  else {
    return t('You may post code using &lt;code&gt;...&lt;/code&gt; (generic) or &lt;?php ... ?&gt; (highlighted PHP) tags.');
  }
}

/**
 * Implementation of hook_menu()
 *
 * Adds the codefilter stylesheet to the page
 */
function codefilter_menu($may_cache) {
  if (!$may_cache) {
    drupal_add_css(drupal_get_path('module', 'codefilter') . '/codefilter.css');
  }
}

/**
 * Processes chunks of escaped PHP code into HTML.
 */
function codefilter_process_php($text) {

  // Note, pay attention to odd preg_replace-with-/e behaviour on slashes
  // Undo possible linebreak filter conversion
  $text = preg_replace('@</?(br|p)\\s*/?>@', '', str_replace('\\"', '"', $text));

  // Undo the escaping in the prepare step
  $text = decode_entities($text);

  // Trim leading and trailing linebreaks
  $text = trim($text, "\r\n");

  // Highlight as PHP
  $text = '<div class="codeblock">' . highlight_string("<?php\n{$text}\n?>", 1) . '</div>';

  // In PHP4, highlight_string() returns font tags; replace them with span tags.
  $text = str_replace(array(
    '<font color="',
    '</font>',
  ), array(
    '<span style="color: ',
    '</span>',
  ), $text);

  // Remove newlines to avoid clashing with the linebreak filter
  $text = str_replace("\n", '', $text);
  return codefilter_fix_spaces($text);
}

/**
 * Helper function for codefilter_process_code().
 */
function codefilter_process_php_inline($matches) {

  // Undo nl2br
  $text = str_replace('<br />', '', $matches[0]);

  // Decode entities (the highlighter re-entifies) and highlight text
  $text = highlight_string(decode_entities($text), 1);

  // In PHP4, highlight_string() returns font tags; replace them with span tags.
  $text = str_replace(array(
    '<font color="',
    '</font>',
  ), array(
    '<span style="color: ',
    '</span>',
  ), $text);

  // Remove PHP's own added code tags
  $text = str_replace(array(
    '<code>',
    '</code>',
    "\n",
  ), array(
    '',
    '',
    '',
  ), $text);
  return $text;
}

/**
 * Processes chunks of escaped code into HTML.
 */
function codefilter_process_code($text) {

  // Undo linebreak escaping
  $text = str_replace('&#10;', "\n", $text);

  // Inline or block level piece?
  $multiline = strpos($text, "\n") !== FALSE;

  // Note, pay attention to odd preg_replace-with-/e behaviour on slashes
  $text = preg_replace("/^\n/", '', preg_replace('@</?(br|p)\\s*/?>@', '', str_replace('\\"', '"', $text)));

  // Trim leading and trailing linebreaks
  $text = trim($text, "\n");

  // Escape newlines
  $text = nl2br($text);

  // PHP code in regular code
  $text = preg_replace_callback('/&lt;\\?php.+?\\?&gt;/s', 'codefilter_process_php_inline', $text);
  $text = '<code>' . codefilter_fix_spaces(str_replace(' ', '&nbsp;', $text)) . '</code>';
  if ($multiline) {
    $text = '<div class="codeblock">' . $text . '</div>';
  }

  // Remove newlines to avoid clashing with the linebreak filter
  return str_replace("\n", '', $text);
}
function codefilter_fix_spaces($text) {
  return preg_replace('@&nbsp;(?!&nbsp;)@', ' ', $text);
}

/**
 * Escape code blocks during input filter 'prepare'.
 *
 * @param $text
 *   The string to escape.
 * @param $type
 *   The type of code block, either 'code' or 'php'.
 * @return
 *   The escaped string.
 */
function codefilter_escape($text, $type = 'code') {

  // Note, pay attention to odd preg_replace-with-/e behaviour on slashes
  $text = check_plain(str_replace('\\"', '"', $text));

  // Protect newlines from line break converter
  $text = str_replace(array(
    "\r",
    "\n",
  ), array(
    '',
    '&#10;',
  ), $text);

  // Add codefilter escape tags
  $text = "[codefilter_{$type}]{$text}[/codefilter_{$type}]";
  return $text;
}

/**
 * Implementation of hook_filter()
 */
function codefilter_filter($op, $delta = 0, $format = -1, $text = '') {
  switch ($op) {
    case 'list':
      return array(
        0 => t('Code filter'),
      );
    case 'description':
      return t('Allows users to post code verbatim using &lt;code&gt; and &lt;?php ?&gt; tags.');
    case 'prepare':

      /* Note: we replace <code> </code>, <?php ?>, [?php ?], <% %>, and [% %]
         to prevent other filters from acting on them. */
      $text = preg_replace('@<code>(.+?)</code>@se', "codefilter_escape('\$1', 'code')", $text);
      $text = preg_replace('@[\\[<](\\?php|%)(.+?)(\\?|%)[\\]>]@se', "codefilter_escape('\$2', 'php')", $text);
      return $text;
    case 'process':
      $text = preg_replace('@\\[codefilter_code\\](.+?)\\[/codefilter_code\\]@se', "codefilter_process_code('\$1')", $text);
      $text = preg_replace('@\\[codefilter_php\\](.+?)\\[/codefilter_php\\]@se', "codefilter_process_php('\$1')", $text);
      return $text;
    default:
      return $text;
  }
}

Functions

Name	Description
codefilter_escape	Escape code blocks during input filter 'prepare'.
codefilter_filter	Implementation of hook_filter()
codefilter_filter_tips	Implementation of hook_filter_tips()
codefilter_fix_spaces
codefilter_menu	Implementation of hook_menu()
codefilter_process_code	Processes chunks of escaped code into HTML.
codefilter_process_php	Processes chunks of escaped PHP code into HTML.
codefilter_process_php_inline	Helper function for codefilter_process_code().