Implement CSS property Font.

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

NEWS

@@ -5,6 +5,7 @@ NEWS ( CHANGELOG and HISTORY )                                     HTMLPurifier
 - Fixed broken numeric entity conversion
 - Malformed UTF-8 and non-SGML character detection and cleaning implemented
 - API documentation completed
+- Shorthand CSS properties implemented: font
 
 1.0.0beta, released 2006-08-16
 - First public release, most functionality implemented. Notable omissions are:

TODO

@@ -5,7 +5,6 @@ Core:
     - border-collapse, caption-side, empty-cells, table-layout, vertical-align
     - background (and friends)
     - border, border-*
-    - font
     - list-style
  - Implement all non-essential attribute transforms
  - Microsoft Word HTML cleaning

docs/progress.html

@@ -148,7 +148,7 @@ thead th {text-align:left;padding:0.1em;background-color:#EEE;}
 <tr class="css1 impl-yes"><td>color</td><td>&lt;color&gt;</td></tr>
 <tr class="css1 impl-yes"><td>float</td><td>ENUM(left, right, none), May require layout
     precautions with clear</td></tr>
-<tr class="css1"><td>font</td><td>SHORTHAND</td></tr>
+<tr class="css1 impl-yes"><td>font</td><td>SHORTHAND</td></tr>
 <tr class="css1 impl-yes"><td>font-family</td><td>CSS validator may complain if fallback font
     family not specified</td></tr>
 <tr class="css1 impl-yes"><td>font-size</td><td>COMPOSITE(&lt;absolute-size&gt;,

library/HTMLPurifier/AttrDef/Font.php

@@ -0,0 +1,154 @@
+<?php
+
+require_once 'HTMLPurifier/AttrDef.php';
+
+/**
+ * Validates shorthand CSS property font.
+ */
+class HTMLPurifier_AttrDef_Font extends HTMLPurifier_AttrDef
+{
+    
+    /**
+     * Local copy of component validators.
+     * 
+     * @note If we moved specific CSS property definitions to their own
+     *       classes instead of having them be assembled at run time by
+     *       CSSDefinition, this wouldn't be necessary.  We'd instantiate
+     *       our own copies.
+     */
+    var $info = array();
+    
+    /**
+     * System font keywords.
+     */
+    var $system_fonts = array(
+        'caption' => true,
+        'icon' => true,
+        'menu' => true,
+        'message-box' => true,
+        'small-caption' => true,
+        'status-bar' => true
+    );
+    
+    function HTMLPurifier_AttrDef_Font() {
+        $def = HTMLPurifier_CSSDefinition::instance();
+        $this->info['font-style']   = $def->info['font-style'];
+        $this->info['font-variant'] = $def->info['font-variant'];
+        $this->info['font-weight']  = $def->info['font-weight'];
+        $this->info['font-size']    = $def->info['font-size'];
+        $this->info['line-height']  = $def->info['line-height'];
+        $this->info['font-family']  = $def->info['font-family'];
+    }
+    
+    function validate($string, $config, &$context) {
+        
+        // regular pre-processing
+        $string = $this->parseCDATA($string);
+        if ($string === '') return false;
+        
+        // check if it's one of the keywords
+        $lowercase_string = strtolower($string);
+        if (isset($this->system_fonts[$lowercase_string])) {
+            return $lowercase_string;
+        }
+        
+        $bits = explode(' ', $string); // bits to process
+        $stage = 0; // this indicates what we're looking for
+        $caught = array(); // which stage 0 properties have we caught?
+        $stage_1 = array('font-style', 'font-variant', 'font-weight');
+        $final = ''; // output
+        
+        for ($i = 0, $size = count($bits); $i < $size; $i++) {
+            if ($bits[$i] === '') continue;
+            switch ($stage) {
+                
+                // attempting to catch font-style, font-variant or font-weight
+                case 0:
+                    foreach ($stage_1 as $validator_name) {
+                        if (isset($caught[$validator_name])) continue;
+                        $r = $this->info[$validator_name]->validate(
+                                                $bits[$i], $config, &$context);
+                        if ($r !== false) {
+                            $final .= $r . ' ';
+                            $caught[$validator_name] = true;
+                            break;
+                        }
+                    }
+                    // all three caught, continue on
+                    if (count($caught) >= 3) $stage = 1;
+                    if ($r !== false) break;
+                
+                // attempting to catch font-size and perhaps line-height
+                case 1:
+                    $found_slash = false;
+                    if (strpos($bits[$i], '/') !== false) {
+                        list($font_size, $line_height) =
+                                                    explode('/', $bits[$i]);
+                        if ($line_height === '') {
+                            // ooh, there's a space after the slash!
+                            $line_height = false;
+                            $found_slash = true;
+                        }
+                    } else {
+                        $font_size = $bits[$i];
+                        $line_height = false;
+                    }
+                    $r = $this->info['font-size']->validate(
+                                              $font_size, $config, &$context);
+                    if ($r !== false) {
+                        $final .= $r;
+                        // attempt to catch line-height
+                        if ($line_height === false) {
+                            // we need to scroll forward
+                            for ($j = $i + 1; $j < $size; $j++) {
+                                if ($bits[$j] === '') continue;
+                                if ($bits[$j] === '/') {
+                                    if ($found_slash) {
+                                        return false;
+                                    } else {
+                                        $found_slash = true;
+                                        continue;
+                                    }
+                                }
+                                $line_height = $bits[$j];
+                                break;
+                            }
+                        } else {
+                            // slash already found
+                            $found_slash = true;
+                            $j = $i;
+                        }
+                        if ($found_slash) {
+                            $i = $j;
+                            $r = $this->info['line-height']->validate(
+                                              $line_height, $config, &$context);
+                            if ($r !== false) {
+                                $final .= '/' . $r;
+                            }
+                        }
+                        $final .= ' ';
+                        $stage = 2;
+                        break;
+                    }
+                    return false;
+                
+                // attempting to catch font-family
+                case 2:
+                    $font_family =
+                        implode(' ', array_slice($bits, $i, $size - $i));
+                    $r = $this->info['font-family']->validate(
+                                              $font_family, $config, &$context);
+                    if ($r !== false) {
+                        $final .= $r . ' ';
+                        // processing completed successfully
+                        return rtrim($final);
+                    }
+                    return false;
+            }
+        }
+        return false;
+    }
+    
+}
+
+?>

library/HTMLPurifier/CSSDefinition.php

@@ -8,6 +8,7 @@ require_once 'HTMLPurifier/AttrDef/Percentage.php';
 require_once 'HTMLPurifier/AttrDef/Multiple.php';
 require_once 'HTMLPurifier/AttrDef/TextDecoration.php';
 require_once 'HTMLPurifier/AttrDef/FontFamily.php';
+require_once 'HTMLPurifier/AttrDef/Font.php';
 
 /**
  * Defines allowed CSS attributes and what their values are.
@@ -165,6 +166,10 @@ class HTMLPurifier_CSSDefinition
             array('normal', 'bold', 'bolder', 'lighter', '100', '200', '300',
             '400', '500', '600', '700', '800', '900'), false);
         
+        // MUST be called after other font properties, as it references
+        // a CSSDefinition object
+        $this->info['font'] = new HTMLPurifier_AttrDef_Font();
+        
     }
     
 }

tests/HTMLPurifier/AttrDef/CSSTest.php

@@ -60,6 +60,7 @@ class HTMLPurifier_AttrDef_CSSTest extends HTMLPurifier_AttrDefHarness
         $this->assertDef('text-decoration:underline;');
         $this->assertDef('font-family:sans-serif;');
         $this->assertDef('font-family:Gill, \'Times New Roman\', sans-serif;');
+        //$this->assertDef('font:12px serif;');
         
         // duplicates
         $this->assertDef('text-align:right;text-align:left;',

tests/HTMLPurifier/AttrDef/FontTest.php

@@ -0,0 +1,36 @@
+<?php
+
+require_once 'HTMLPurifier/AttrDefHarness.php';
+require_once 'HTMLPurifier/AttrDef/Font.php';
+
+class HTMLPurifier_AttrDef_FontTest extends HTMLPurifier_AttrDefHarness
+{
+    
+    function test() {
+        
+        $this->def = new HTMLPurifier_AttrDef_Font();
+        
+        // hodgepodge of usage cases from W3C spec, but " -> '
+        $this->assertDef('12px/14px sans-serif');
+        $this->assertDef('80% sans-serif');
+        $this->assertDef('x-large/110% \'New Century Schoolbook\', serif');
+        $this->assertDef('bold italic large Palatino, serif');
+        $this->assertDef('normal small-caps 120%/120% fantasy');
+        $this->assertDef('300 italic 1.3em/1.7em \'FB Armada\', sans-serif');
+        $this->assertDef('600 9px Charcoal');
+        $this->assertDef('600 9px/ 12px Charcoal', '600 9px/12px Charcoal');
+        
+        // spacing
+        $this->assertDef('12px / 14px sans-serif', '12px/14px sans-serif');
+        
+        // system fonts
+        $this->assertDef('menu');
+        
+        $this->assertDef('800', false);
+        $this->assertDef('600 9px//12px Charcoal', false);
+        
+    }
+    
+}
+
+?>

tests/index.php

@@ -75,6 +75,7 @@ $test_files[] = 'AttrDef/FontFamilyTest.php';
 $test_files[] = 'AttrDef/HostTest.php';
 $test_files[] = 'AttrDef/IPv4Test.php';
 $test_files[] = 'AttrDef/IPv6Test.php';
+$test_files[] = 'AttrDef/FontTest.php';
 $test_files[] = 'IDAccumulatorTest.php';
 $test_files[] = 'TagTransformTest.php';
 $test_files[] = 'AttrTransform/LangTest.php';