[1.6.1] Implement vspace and hspace transformations in img.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1001 48356398-32a2-884e-a903-53898d9a118a

NEWS

@@ -17,6 +17,8 @@ NEWS ( CHANGELOG and HISTORY )                                     HTMLPurifier
   are now preserved.
 ! %Core.RemoveInvalidImg is now operational, when set to false invalid
   images will hang around with an empty src
+! Support for more deprecated attributes via transformations:
+  + hspace and vspace in img
 - Possibly fatal bug with __autoload() fixed in module manager
 - Invert HTMLModuleManager->addModule() processing order to check
   prefixes first and then the literal module

TODO

@@ -8,7 +8,6 @@ TODO List
 ==========================
 
 1.6.1 [Oh Dear, We Missed Something!]
- # vspace and hspace in img
  # align in img and table
  # target in a
  # noshade and size in hr

docs/dev-progress.html

@@ -277,7 +277,7 @@ Mozilla on inside and needs -moz-outline, no IE support.</td></tr>
 <tr class="impl-no"><td>compact</td><td>DL, OL, UL</td><td>Boolean, needs custom CSS class; rarely used anyway</td></tr>
 <tr class="required impl-yes"><td>dir</td><td>BDO</td><td>Required, insert ltr (or configuration value) if none</td></tr>
 <tr class="impl-yes"><td>height</td><td>TD, TH</td><td>Near-equiv style 'height', needs px suffix if original was in pixels</td></tr>
-<tr><td>hspace</td><td>IMG</td><td>Near-equiv styles 'margin-top' and 'margin-bottom', needs px suffix</td></tr>
+<tr class="impl-yes"><td>hspace</td><td>IMG</td><td>Near-equiv styles 'margin-top' and 'margin-bottom', needs px suffix</td></tr>
 <tr class="impl-yes"><td>lang</td><td>*</td><td>Copy value to xml:lang</td></tr>
 <tr class="impl-yes"><td rowspan="2">name</td><td>IMG</td><td>Turn into ID</td></tr>
     <tr class="impl-yes"><td>A</td><td>Turn into ID</td></tr>
@@ -290,7 +290,7 @@ Mozilla on inside and needs -moz-outline, no IE support.</td></tr>
     <tr><td>OL</td></tr>
     <tr><td>UL</td></tr>
 <tr class="impl-yes"><td>value</td><td>LI</td><td>Poorly supported 'counter-reset', allowed in loose, dropped in strict</td></tr>
-<tr><td>vspace</td><td>IMG</td><td>Near-equiv styles 'margin-left' and 'margin-right', needs px suffix, see hspace</td></tr>
+<tr class="impl-yes"><td>vspace</td><td>IMG</td><td>Near-equiv styles 'margin-left' and 'margin-right', needs px suffix, see hspace</td></tr>
 <tr class="impl-yes"><td rowspan="2">width</td><td>HR</td><td rowspan="2">Near-equiv style 'width', needs px suffix if original was pixels</td></tr>
     <tr class="impl-yes"><td>TD, TH</td></tr>
 </tbody>

library/HTMLPurifier/AttrTransform/ImgSpace.php

@@ -0,0 +1,50 @@
+<?php
+
+require_once 'HTMLPurifier/AttrTransform.php';
+
+/**
+ * Pre-transform that changes deprecated hspace and vspace attributes to CSS
+ */
+class HTMLPurifier_AttrTransform_ImgSpace
+extends HTMLPurifier_AttrTransform {
+    
+    var $attr;
+    var $css = array(
+        'hspace' => array('left', 'right'),
+        'vspace' => array('top', 'bottom')
+    );
+    
+    function HTMLPurifier_AttrTransform_ImgSpace($attr) {
+        $this->attr = $attr;
+        if (!isset($this->css[$attr])) {
+            trigger_error(htmlspecialchars($attr) . ' is not valid space attribute');
+        }
+    }
+    
+    function transform($attr, $config, &$context) {
+        
+        if (!isset($attr[$this->attr])) return $attr;
+        
+        $width = $attr[$this->attr];
+        unset($attr[$this->attr]);
+        // some validation could happen here
+        
+        if (!isset($this->css[$this->attr])) return $attr;
+        
+        $attr['style'] = isset($attr['style']) ? $attr['style'] : '';
+        
+        $style = '';
+        foreach ($this->css[$this->attr] as $suffix) {
+            $property = "margin-$suffix";
+            $style .= "$property:{$width}px;";
+        }
+        
+        $attr['style'] = $style . $attr['style'];
+        
+        return $attr;
+        
+    }
+    
+}
+
+?>

library/HTMLPurifier/HTMLModule/TransformToStrict.php

@@ -12,6 +12,7 @@ require_once 'HTMLPurifier/AttrTransform/BgColor.php';
 require_once 'HTMLPurifier/AttrTransform/Border.php';
 require_once 'HTMLPurifier/AttrTransform/Name.php';
 require_once 'HTMLPurifier/AttrTransform/Length.php';
+require_once 'HTMLPurifier/AttrTransform/ImgSpace.php';
 
 /**
  * Proprietary module that transforms deprecated elements into Strict
@@ -95,6 +96,9 @@ class HTMLPurifier_HTMLModule_TransformToStrict extends HTMLPurifier_HTMLModule
         $this->info['td']->attr_transform_pre['height'] = 
         $this->info['th']->attr_transform_pre['height'] = new HTMLPurifier_AttrTransform_Length('height');
         
+        $this->info['img']->attr_transform_pre['hspace'] = new HTMLPurifier_AttrTransform_ImgSpace('hspace');
+        $this->info['img']->attr_transform_pre['vspace'] = new HTMLPurifier_AttrTransform_ImgSpace('vspace');
+        
     }
     
     var $defines_child_def = true;

tests/HTMLPurifier/AttrTransform/ImgSpaceTest.php

@@ -0,0 +1,57 @@
+<?php
+
+require_once 'HTMLPurifier/AttrTransform/ImgSpace.php';
+require_once 'HTMLPurifier/AttrTransformHarness.php';
+
+
+class HTMLPurifier_AttrTransform_ImgSpaceTest extends HTMLPurifier_AttrTransformHarness
+{
+    
+    function setUp() {
+        parent::setUp();
+    }
+    
+    function testVertical() {
+        
+        $this->obj = new HTMLPurifier_AttrTransform_ImgSpace('vspace');
+        
+        $this->assertResult( array() );
+        
+        $this->assertResult(
+            array('vspace' => '1'),
+            array('style' => 'margin-top:1px;margin-bottom:1px;')
+        );
+        
+        // no validation done here, we expect CSS validator to catch it
+        $this->assertResult(
+            array('vspace' => '10%'),
+            array('style' => 'margin-top:10%px;margin-bottom:10%px;')
+        );
+        
+        $this->assertResult(
+            array('vspace' => '23', 'style' => 'font-weight:bold;'),
+            array('style' => 'margin-top:23px;margin-bottom:23px;font-weight:bold;')
+        );
+        
+    }
+    
+    function testHorizontal() {
+        $this->obj = new HTMLPurifier_AttrTransform_ImgSpace('hspace');
+        $this->assertResult(
+            array('hspace' => '1'),
+            array('style' => 'margin-left:1px;margin-right:1px;')
+        );
+    }
+    
+    function testInvalid() {
+        $this->expectError('ispace is not valid space attribute');
+        $this->obj = new HTMLPurifier_AttrTransform_ImgSpace('ispace');
+        $this->assertResult(
+            array('ispace' => '1'),
+            array()
+        );
+    }
+    
+}
+
+?>

tests/HTMLPurifier/Strategy/ValidateAttributesTest.php

@@ -192,6 +192,13 @@ class HTMLPurifier_Strategy_ValidateAttributesTest extends
             array('Attr.AllowedRel' => 'nofollow')
         );
         
+        // border
+        $this->assertResult(
+            '<img src="foo" alt="foo" hspace="1" vspace="3" />',
+            '<img src="foo" alt="foo" style="margin-top:3px;margin-bottom:3px;margin-left:1px;margin-right:1px;" />',
+            array('Attr.AllowedRel' => 'nofollow')
+        );
+        
     }
     
 }

tests/test_files.php

@@ -38,6 +38,7 @@ $test_files[] = 'AttrTransform/BdoDirTest.php';
 $test_files[] = 'AttrTransform/BgColorTest.php';
 $test_files[] = 'AttrTransform/BorderTest.php';
 $test_files[] = 'AttrTransform/ImgRequiredTest.php';
+$test_files[] = 'AttrTransform/ImgSpaceTest.php';
 $test_files[] = 'AttrTransform/LangTest.php';
 $test_files[] = 'AttrTransform/LengthTest.php';
 $test_files[] = 'AttrTransform/NameTest.php';