htmlpurifier.module

   1 <?php
   2 // $Id: htmlpurifier.module,v 1.2 2007/12/09 21:33:38 ezyang Exp $
   3
   4 /**
   5  * Implementation of hook_help().
   6  *
   7  * Used by drupal 4.7
   8  */
   9 function htmlpurifier_help($section) {
  10   switch ($section) {
  11     case 'admin/modules#description':
  12       $output = t('Filter that removes malicious HTML and ensures standards compliant output.');
  13       break;
  14   }
  15   return $output;
  16 }
  17
  18 /**
  19  * Implementation of hook_filter().
  20  */
  21 function htmlpurifier_filter($op, $delta = 0, $format = -1, $text = '') {
  22   switch ($op) {
  23     case 'list':
  24       return array(0 => t('HTML Purifier'));
  25
  26     case 'no cache':
  27       // caching HTML Purifier's output is STRONGLY recommended due to
  28       // HTML Purifier's data-intensive nature
  29       return FALSE;
  30
  31     case 'description':
  32       // TODO: Include description of what tags and properties are active
  33       return t('Removes malicious HTML code and ensures that the output is standards compliant.');
  34
  35     case 'prepare':
  36       return $text;
  37
  38     case 'process':
  39       $config = _htmlpurifier_get_config($format);
  40       $purifier = htmlpurifier_create_purifier($config);
  41       _htmlpurifier_add_filters($format, $purifier);
  42       return $purifier->purify($text);
  43
  44     case 'settings':
  45       return _htmlpurifier_settings($format);
  46
  47     default:
  48       return NULL;
  49   }
  50 }
  51
  52 function htmlpurifier_purify($text, $config) {
  53   $purifier = htmlpurifier_create_purifier($config);
  54   return $purifier->purify($text);
  55 }
  56
  57 function htmlpurifier_create_purifier($config) {
  58   // Load HTML Purifier library
  59   $module_path = drupal_get_path('module', 'htmlpurifier');
  60   require_once "$module_path/library/HTMLPurifier.auto.php";
  61
  62   // Overload HTML Purifiers default cache handler with our own so that
  63   // Drupals built-in cache is used
  64   require_once "$module_path/HTMLPurifier_DefinitionCache_Drupal.php";
  65   $factory =& HTMLPurifier_DefinitionCacheFactory::instance();
  66   if (method_exists($factory, 'register')) {
  67     $factory->register('Drupal', 'HTMLPurifier_DefinitionCache_Drupal');
  68   } else {
  69     // Brittle, used for previous HTML Purifier version compatibility
  70     $factory->caches['Drupal']['HTML'] = new HTMLPurifier_DefinitionCache_Drupal('HTML');
  71     $factory->caches['Drupal']['CSS']  = new HTMLPurifier_DefinitionCache_Drupal('CSS');
  72     $factory->caches['Drupal']['URI']  = new HTMLPurifier_DefinitionCache_Drupal('URI');
  73   }
  74   $config['Cache.DefinitionImpl'] = 'Drupal';
  75
  76   return new HTMLPurifier($config);
  77 }
  78
  79 function _htmlpurifier_settings($format) {
  80   $form = array();
  81
  82   $form['htmlpurifier'] = array(
  83     '#type' => 'fieldset',
  84     '#title' => t('HTML Purifier'),
  85     '#collapsible' => TRUE,
  86   );
  87   $form['htmlpurifier']["htmlpurifier_enableattrid_$format"] = array(
  88     '#type' => 'checkbox',
  89     '#title' => t('Allow the ID attribute in HTML'),
  90     '#default_value' => variable_get("htmlpurifier_enableattrid_$format", FALSE),
  91     '#description' => t('If enabled, allows the use of ID attributes in HTML tags. This is disabled by default due to the fact that without proper configuration user input can easily break the validation of a webpage by specifying an ID that is already on the surrounding HTML.'),
  92   );
  93   $form['htmlpurifier']["htmlpurifier_preserveyoutube_$format"] = array(
  94     '#type' => 'checkbox',
  95     '#title' => t('Preserve embedded YouTube videos'),
  96     '#default_value' => variable_get("htmlpurifier_preserveyoutube_$format", FALSE),
  97     '#description' => t('If enabled, allows the use of embedded YouTube videos. See !url for more information.', array('!url' => l('Embedding YouTube Videos', 'http://hp.jpsband.org/live/docs/enduser-youtube.html'))),
  98   );
  99   $form['htmlpurifier']["htmlpurifier_help_$format"] = array(
 100     '#type' => 'checkbox',
 101     '#title' => t('Display help text'),
 102     '#default_value' => variable_get("htmlpurifier_help_$format", TRUE),
 103     '#description' => t('If enabled, a short note will be added to the filter tips explaining that HTML will be transformed to conform with HTML standards. You may want to disable this option when the HTML Purifier is used to check the output of another filter like BBCode.'),
 104   );
 105
 106   return $form;
 107 }
 108
 109 function _htmlpurifier_get_config($format) {
 110   $config = array(
 111     'HTML.EnableAttrID' => variable_get("htmlpurifier_enableattrid_$format", FALSE),
 112   );
 113   return $config;
 114 }
 115
 116 function _htmlpurifier_add_filters($format, &$purifier) {
 117   if (variable_get("htmlpurifier_preserveyoutube_$format", FALSE) && version_compare($purifier->version, '1.4.1', '>=')) {
 118     require_once 'HTMLPurifier/Filter/YouTube.php';
 119     $purifier->addFilter(new HTMLPurifier_Filter_YouTube());
 120   }
 121 }
 122
 123 /**
 124  * Implementation of hook_filter_tips().
 125  */
 126 function htmlpurifier_filter_tips($delta, $format, $long = FALSE) {
 127   if (variable_get("htmlpurifier_help_$format", TRUE)) {
 128     return t('HTML tags will be transformed to conform to HTML standards.');
 129   }
 130 }