vendor/dompdf/dompdf/src/Css/AttributeTranslator.php

   1 <?php
   2 /**
   3  * @package dompdf
   4  * @link    http://dompdf.github.com/
   5  * @author  Benj Carson <benjcarson@digitaljunkies.ca>
   6  * @author  Fabien Ménager <fabien.menager@gmail.com>
   7  * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
   8  */
   9 namespace Dompdf\Css;
  10
  11 use Dompdf\Frame;
  12
  13 /**
  14  * Translates HTML 4.0 attributes into CSS rules
  15  *
  16  * @package dompdf
  17  */
  18 class AttributeTranslator
  19 {
  20     static $_style_attr = "_html_style_attribute";
  21
  22     // Munged data originally from
  23     // http://www.w3.org/TR/REC-html40/index/attributes.html
  24     // http://www.cs.tut.fi/~jkorpela/html2css.html
  25     static private $__ATTRIBUTE_LOOKUP = array(
  26         //'caption' => array ( 'align' => '', ),
  27         'img' => array(
  28             'align' => array(
  29                 'bottom' => 'vertical-align: baseline;',
  30                 'middle' => 'vertical-align: middle;',
  31                 'top' => 'vertical-align: top;',
  32                 'left' => 'float: left;',
  33                 'right' => 'float: right;'
  34             ),
  35             'border' => 'border: %0.2Fpx solid;',
  36             'height' => 'height: %spx;',
  37             'hspace' => 'padding-left: %1$0.2Fpx; padding-right: %1$0.2Fpx;',
  38             'vspace' => 'padding-top: %1$0.2Fpx; padding-bottom: %1$0.2Fpx;',
  39             'width' => 'width: %spx;',
  40         ),
  41         'table' => array(
  42             'align' => array(
  43                 'left' => 'margin-left: 0; margin-right: auto;',
  44                 'center' => 'margin-left: auto; margin-right: auto;',
  45                 'right' => 'margin-left: auto; margin-right: 0;'
  46             ),
  47             'bgcolor' => 'background-color: %s;',
  48             'border' => '!set_table_border',
  49             'cellpadding' => '!set_table_cellpadding', //'border-spacing: %0.2F; border-collapse: separate;',
  50             'cellspacing' => '!set_table_cellspacing',
  51             'frame' => array(
  52                 'void' => 'border-style: none;',
  53                 'above' => 'border-top-style: solid;',
  54                 'below' => 'border-bottom-style: solid;',
  55                 'hsides' => 'border-left-style: solid; border-right-style: solid;',
  56                 'vsides' => 'border-top-style: solid; border-bottom-style: solid;',
  57                 'lhs' => 'border-left-style: solid;',
  58                 'rhs' => 'border-right-style: solid;',
  59                 'box' => 'border-style: solid;',
  60                 'border' => 'border-style: solid;'
  61             ),
  62             'rules' => '!set_table_rules',
  63             'width' => 'width: %s;',
  64         ),
  65         'hr' => array(
  66             'align' => '!set_hr_align', // Need to grab width to set 'left' & 'right' correctly
  67             'noshade' => 'border-style: solid;',
  68             'size' => '!set_hr_size', //'border-width: %0.2F px;',
  69             'width' => 'width: %s;',
  70         ),
  71         'div' => array(
  72             'align' => 'text-align: %s;',
  73         ),
  74         'h1' => array(
  75             'align' => 'text-align: %s;',
  76         ),
  77         'h2' => array(
  78             'align' => 'text-align: %s;',
  79         ),
  80         'h3' => array(
  81             'align' => 'text-align: %s;',
  82         ),
  83         'h4' => array(
  84             'align' => 'text-align: %s;',
  85         ),
  86         'h5' => array(
  87             'align' => 'text-align: %s;',
  88         ),
  89         'h6' => array(
  90             'align' => 'text-align: %s;',
  91         ),
  92         //TODO: translate more form element attributes
  93         'input' => array(
  94             'size' => '!set_input_width'
  95         ),
  96         'p' => array(
  97             'align' => 'text-align: %s;',
  98         ),
  99 //    'col' => array(
 100 //      'align'  => '',
 101 //      'valign' => '',
 102 //    ),
 103 //    'colgroup' => array(
 104 //      'align'  => '',
 105 //      'valign' => '',
 106 //    ),
 107         'tbody' => array(
 108             'align' => '!set_table_row_align',
 109             'valign' => '!set_table_row_valign',
 110         ),
 111         'td' => array(
 112             'align' => 'text-align: %s;',
 113             'bgcolor' => '!set_background_color',
 114             'height' => 'height: %s;',
 115             'nowrap' => 'white-space: nowrap;',
 116             'valign' => 'vertical-align: %s;',
 117             'width' => 'width: %s;',
 118         ),
 119         'tfoot' => array(
 120             'align' => '!set_table_row_align',
 121             'valign' => '!set_table_row_valign',
 122         ),
 123         'th' => array(
 124             'align' => 'text-align: %s;',
 125             'bgcolor' => '!set_background_color',
 126             'height' => 'height: %s;',
 127             'nowrap' => 'white-space: nowrap;',
 128             'valign' => 'vertical-align: %s;',
 129             'width' => 'width: %s;',
 130         ),
 131         'thead' => array(
 132             'align' => '!set_table_row_align',
 133             'valign' => '!set_table_row_valign',
 134         ),
 135         'tr' => array(
 136             'align' => '!set_table_row_align',
 137             'bgcolor' => '!set_table_row_bgcolor',
 138             'valign' => '!set_table_row_valign',
 139         ),
 140         'body' => array(
 141             'background' => 'background-image: url(%s);',
 142             'bgcolor' => '!set_background_color',
 143             'link' => '!set_body_link',
 144             'text' => '!set_color',
 145         ),
 146         'br' => array(
 147             'clear' => 'clear: %s;',
 148         ),
 149         'basefont' => array(
 150             'color' => '!set_color',
 151             'face' => 'font-family: %s;',
 152             'size' => '!set_basefont_size',
 153         ),
 154         'font' => array(
 155             'color' => '!set_color',
 156             'face' => 'font-family: %s;',
 157             'size' => '!set_font_size',
 158         ),
 159         'dir' => array(
 160             'compact' => 'margin: 0.5em 0;',
 161         ),
 162         'dl' => array(
 163             'compact' => 'margin: 0.5em 0;',
 164         ),
 165         'menu' => array(
 166             'compact' => 'margin: 0.5em 0;',
 167         ),
 168         'ol' => array(
 169             'compact' => 'margin: 0.5em 0;',
 170             'start' => 'counter-reset: -dompdf-default-counter %d;',
 171             'type' => 'list-style-type: %s;',
 172         ),
 173         'ul' => array(
 174             'compact' => 'margin: 0.5em 0;',
 175             'type' => 'list-style-type: %s;',
 176         ),
 177         'li' => array(
 178             'type' => 'list-style-type: %s;',
 179             'value' => 'counter-reset: -dompdf-default-counter %d;',
 180         ),
 181         'pre' => array(
 182             'width' => 'width: %s;',
 183         ),
 184     );
 185
 186     static protected $_last_basefont_size = 3;
 187     static protected $_font_size_lookup = array(
 188         // For basefont support
 189         -3 => "4pt",
 190         -2 => "5pt",
 191         -1 => "6pt",
 192         0 => "7pt",
 193
 194         1 => "8pt",
 195         2 => "10pt",
 196         3 => "12pt",
 197         4 => "14pt",
 198         5 => "18pt",
 199         6 => "24pt",
 200         7 => "34pt",
 201
 202         // For basefont support
 203         8 => "48pt",
 204         9 => "44pt",
 205         10 => "52pt",
 206         11 => "60pt",
 207     );
 208
 209     /**
 210      * @param Frame $frame
 211      */
 212     static function translate_attributes(Frame $frame)
 213     {
 214         $node = $frame->get_node();
 215         $tag = $node->nodeName;
 216
 217         if (!isset(self::$__ATTRIBUTE_LOOKUP[$tag])) {
 218             return;
 219         }
 220
 221         $valid_attrs = self::$__ATTRIBUTE_LOOKUP[$tag];
 222         $attrs = $node->attributes;
 223         $style = rtrim($node->getAttribute(self::$_style_attr), "; ");
 224         if ($style != "") {
 225             $style .= ";";
 226         }
 227
 228         foreach ($attrs as $attr => $attr_node) {
 229             if (!isset($valid_attrs[$attr])) {
 230                 continue;
 231             }
 232
 233             $value = $attr_node->value;
 234
 235             $target = $valid_attrs[$attr];
 236
 237             // Look up $value in $target, if $target is an array:
 238             if (is_array($target)) {
 239                 if (isset($target[$value])) {
 240                     $style .= " " . self::_resolve_target($node, $target[$value], $value);
 241                 }
 242             } else {
 243                 // otherwise use target directly
 244                 $style .= " " . self::_resolve_target($node, $target, $value);
 245             }
 246         }
 247
 248         if (!is_null($style)) {
 249             $style = ltrim($style);
 250             $node->setAttribute(self::$_style_attr, $style);
 251         }
 252
 253     }
 254
 255     /**
 256      * @param \DOMNode $node
 257      * @param string $target
 258      * @param string $value
 259      *
 260      * @return string
 261      */
 262     static protected function _resolve_target(\DOMNode $node, $target, $value)
 263     {
 264         if ($target[0] === "!") {
 265             // Function call
 266             $func = "_" . mb_substr($target, 1);
 267
 268             return self::$func($node, $value);
 269         }
 270
 271         return $value ? sprintf($target, $value) : "";
 272     }
 273
 274     /**
 275      * @param \DOMElement $node
 276      * @param string $new_style
 277      */
 278     static function append_style(\DOMElement $node, $new_style)
 279     {
 280         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 281         $style .= $new_style;
 282         $style = ltrim($style, ";");
 283         $node->setAttribute(self::$_style_attr, $style);
 284     }
 285
 286     /**
 287      * @param \DOMNode $node
 288      *
 289      * @return \DOMNodeList|\DOMElement[]
 290      */
 291     static protected function get_cell_list(\DOMNode $node)
 292     {
 293         $xpath = new \DOMXpath($node->ownerDocument);
 294
 295         switch ($node->nodeName) {
 296             default:
 297             case "table":
 298                 $query = "tr/td | thead/tr/td | tbody/tr/td | tfoot/tr/td | tr/th | thead/tr/th | tbody/tr/th | tfoot/tr/th";
 299                 break;
 300
 301             case "tbody":
 302             case "tfoot":
 303             case "thead":
 304                 $query = "tr/td | tr/th";
 305                 break;
 306
 307             case "tr":
 308                 $query = "td | th";
 309                 break;
 310         }
 311
 312         return $xpath->query($query, $node);
 313     }
 314
 315     /**
 316      * @param string $value
 317      *
 318      * @return string
 319      */
 320     static protected function _get_valid_color($value)
 321     {
 322         if (preg_match('/^#?([0-9A-F]{6})$/i', $value, $matches)) {
 323             $value = "#$matches[1]";
 324         }
 325
 326         return $value;
 327     }
 328
 329     /**
 330      * @param \DOMElement $node
 331      * @param string $value
 332      *
 333      * @return string
 334      */
 335     static protected function _set_color(\DOMElement $node, $value)
 336     {
 337         $value = self::_get_valid_color($value);
 338
 339         return "color: $value;";
 340     }
 341
 342     /**
 343      * @param \DOMElement $node
 344      * @param string $value
 345      *
 346      * @return string
 347      */
 348     static protected function _set_background_color(\DOMElement $node, $value)
 349     {
 350         $value = self::_get_valid_color($value);
 351
 352         return "background-color: $value;";
 353     }
 354
 355     /**
 356      * @param \DOMElement $node
 357      * @param string $value
 358      *
 359      * @return null
 360      */
 361     static protected function _set_table_cellpadding(\DOMElement $node, $value)
 362     {
 363         $cell_list = self::get_cell_list($node);
 364
 365         foreach ($cell_list as $cell) {
 366             self::append_style($cell, "; padding: {$value}px;");
 367         }
 368
 369         return null;
 370     }
 371
 372     /**
 373      * @param \DOMElement $node
 374      * @param string $value
 375      *
 376      * @return string
 377      */
 378     static protected function _set_table_border(\DOMElement $node, $value)
 379     {
 380         $cell_list = self::get_cell_list($node);
 381
 382         foreach ($cell_list as $cell) {
 383             $style = rtrim($cell->getAttribute(self::$_style_attr));
 384             $style .= "; border-width: " . ($value > 0 ? 1 : 0) . "pt; border-style: inset;";
 385             $style = ltrim($style, ";");
 386             $cell->setAttribute(self::$_style_attr, $style);
 387         }
 388
 389         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 390         $style .= "; border-width: $value" . "px; ";
 391
 392         return ltrim($style, "; ");
 393     }
 394
 395     /**
 396      * @param \DOMElement $node
 397      * @param string $value
 398      *
 399      * @return string
 400      */
 401     static protected function _set_table_cellspacing(\DOMElement $node, $value)
 402     {
 403         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 404
 405         if ($value == 0) {
 406             $style .= "; border-collapse: collapse;";
 407         } else {
 408             $style .= "; border-spacing: {$value}px; border-collapse: separate;";
 409         }
 410
 411         return ltrim($style, ";");
 412     }
 413
 414     /**
 415      * @param \DOMElement $node
 416      * @param string $value
 417      *
 418      * @return null|string
 419      */
 420     static protected function _set_table_rules(\DOMElement $node, $value)
 421     {
 422         $new_style = "; border-collapse: collapse;";
 423
 424         switch ($value) {
 425             case "none":
 426                 $new_style .= "border-style: none;";
 427                 break;
 428
 429             case "groups":
 430                 // FIXME: unsupported
 431                 return null;
 432
 433             case "rows":
 434                 $new_style .= "border-style: solid none solid none; border-width: 1px; ";
 435                 break;
 436
 437             case "cols":
 438                 $new_style .= "border-style: none solid none solid; border-width: 1px; ";
 439                 break;
 440
 441             case "all":
 442                 $new_style .= "border-style: solid; border-width: 1px; ";
 443                 break;
 444
 445             default:
 446                 // Invalid value
 447                 return null;
 448         }
 449
 450         $cell_list = self::get_cell_list($node);
 451
 452         foreach ($cell_list as $cell) {
 453             $style = $cell->getAttribute(self::$_style_attr);
 454             $style .= $new_style;
 455             $cell->setAttribute(self::$_style_attr, $style);
 456         }
 457
 458         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 459         $style .= "; border-collapse: collapse; ";
 460
 461         return ltrim($style, "; ");
 462     }
 463
 464     /**
 465      * @param \DOMElement $node
 466      * @param string $value
 467      *
 468      * @return string
 469      */
 470     static protected function _set_hr_size(\DOMElement $node, $value)
 471     {
 472         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 473         $style .= "; border-width: " . max(0, $value - 2) . "; ";
 474
 475         return ltrim($style, "; ");
 476     }
 477
 478     /**
 479      * @param \DOMElement $node
 480      * @param string $value
 481      *
 482      * @return null|string
 483      */
 484     static protected function _set_hr_align(\DOMElement $node, $value)
 485     {
 486         $style = rtrim($node->getAttribute(self::$_style_attr), ";");
 487         $width = $node->getAttribute("width");
 488
 489         if ($width == "") {
 490             $width = "100%";
 491         }
 492
 493         $remainder = 100 - (double)rtrim($width, "% ");
 494
 495         switch ($value) {
 496             case "left":
 497                 $style .= "; margin-right: $remainder %;";
 498                 break;
 499
 500             case "right":
 501                 $style .= "; margin-left: $remainder %;";
 502                 break;
 503
 504             case "center":
 505                 $style .= "; margin-left: auto; margin-right: auto;";
 506                 break;
 507
 508             default:
 509                 return null;
 510         }
 511
 512         return ltrim($style, "; ");
 513     }
 514
 515     /**
 516      * @param \DOMElement $node
 517      * @param string $value
 518      *
 519      * @return null|string
 520      */
 521     static protected function _set_input_width(\DOMElement $node, $value)
 522     {
 523         if (empty($value)) { return null; }
 524
 525         if ($node->hasAttribute("type") && in_array(strtolower($node->getAttribute("type")), array("text","password"))) {
 526             return sprintf("width: %Fem", (((int)$value * .65)+2));
 527         } else {
 528             return sprintf("width: %upx;", (int)$value);
 529         }
 530     }
 531
 532     /**
 533      * @param \DOMElement $node
 534      * @param string $value
 535      *
 536      * @return null
 537      */
 538     static protected function _set_table_row_align(\DOMElement $node, $value)
 539     {
 540         $cell_list = self::get_cell_list($node);
 541
 542         foreach ($cell_list as $cell) {
 543             self::append_style($cell, "; text-align: $value;");
 544         }
 545
 546         return null;
 547     }
 548
 549     /**
 550      * @param \DOMElement $node
 551      * @param string $value
 552      *
 553      * @return null
 554      */
 555     static protected function _set_table_row_valign(\DOMElement $node, $value)
 556     {
 557         $cell_list = self::get_cell_list($node);
 558
 559         foreach ($cell_list as $cell) {
 560             self::append_style($cell, "; vertical-align: $value;");
 561         }
 562
 563         return null;
 564     }
 565
 566     /**
 567      * @param \DOMElement $node
 568      * @param string $value
 569      *
 570      * @return null
 571      */
 572     static protected function _set_table_row_bgcolor(\DOMElement $node, $value)
 573     {
 574         $cell_list = self::get_cell_list($node);
 575         $value = self::_get_valid_color($value);
 576
 577         foreach ($cell_list as $cell) {
 578             self::append_style($cell, "; background-color: $value;");
 579         }
 580
 581         return null;
 582     }
 583
 584     /**
 585      * @param \DOMElement $node
 586      * @param string $value
 587      *
 588      * @return null
 589      */
 590     static protected function _set_body_link(\DOMElement $node, $value)
 591     {
 592         $a_list = $node->getElementsByTagName("a");
 593         $value = self::_get_valid_color($value);
 594
 595         foreach ($a_list as $a) {
 596             self::append_style($a, "; color: $value;");
 597         }
 598
 599         return null;
 600     }
 601
 602     /**
 603      * @param \DOMElement $node
 604      * @param string $value
 605      *
 606      * @return null
 607      */
 608     static protected function _set_basefont_size(\DOMElement $node, $value)
 609     {
 610         // FIXME: ? we don't actually set the font size of anything here, just
 611         // the base size for later modification by <font> tags.
 612         self::$_last_basefont_size = $value;
 613
 614         return null;
 615     }
 616
 617     /**
 618      * @param \DOMElement $node
 619      * @param string $value
 620      *
 621      * @return string
 622      */
 623     static protected function _set_font_size(\DOMElement $node, $value)
 624     {
 625         $style = $node->getAttribute(self::$_style_attr);
 626
 627         if ($value[0] === "-" || $value[0] === "+") {
 628             $value = self::$_last_basefont_size + (int)$value;
 629         }
 630
 631         if (isset(self::$_font_size_lookup[$value])) {
 632             $style .= "; font-size: " . self::$_font_size_lookup[$value] . ";";
 633         } else {
 634             $style .= "; font-size: $value;";
 635         }
 636
 637         return ltrim($style, "; ");
 638     }
 639 }