4 * Defines allowed CSS attributes and what their values are.
5 * @see HTMLPurifier_HTMLDefinition
7 class HTMLPurifier_CSSDefinition
extends HTMLPurifier_Definition
13 * Assoc array of attribute name to definition object.
14 * @type HTMLPurifier_AttrDef[]
16 public $info = array();
19 * Constructs the info array. The meat of this class.
20 * @param HTMLPurifier_Config $config
22 protected function doSetup($config)
24 $this->info
['text-align'] = new HTMLPurifier_AttrDef_Enum(
25 array('left', 'right', 'center', 'justify'),
30 $this->info
['border-bottom-style'] =
31 $this->info
['border-right-style'] =
32 $this->info
['border-left-style'] =
33 $this->info
['border-top-style'] = new HTMLPurifier_AttrDef_Enum(
49 $this->info
['border-style'] = new HTMLPurifier_AttrDef_CSS_Multiple($border_style);
51 $this->info
['clear'] = new HTMLPurifier_AttrDef_Enum(
52 array('none', 'left', 'right', 'both'),
55 $this->info
['float'] = new HTMLPurifier_AttrDef_Enum(
56 array('none', 'left', 'right'),
59 $this->info
['font-style'] = new HTMLPurifier_AttrDef_Enum(
60 array('normal', 'italic', 'oblique'),
63 $this->info
['font-variant'] = new HTMLPurifier_AttrDef_Enum(
64 array('normal', 'small-caps'),
68 $uri_or_none = new HTMLPurifier_AttrDef_CSS_Composite(
70 new HTMLPurifier_AttrDef_Enum(array('none')),
71 new HTMLPurifier_AttrDef_CSS_URI()
75 $this->info
['list-style-position'] = new HTMLPurifier_AttrDef_Enum(
76 array('inside', 'outside'),
79 $this->info
['list-style-type'] = new HTMLPurifier_AttrDef_Enum(
93 $this->info
['list-style-image'] = $uri_or_none;
95 $this->info
['list-style'] = new HTMLPurifier_AttrDef_CSS_ListStyle($config);
97 $this->info
['text-transform'] = new HTMLPurifier_AttrDef_Enum(
98 array('capitalize', 'uppercase', 'lowercase', 'none'),
101 $this->info
['color'] = new HTMLPurifier_AttrDef_CSS_Color();
103 $this->info
['background-image'] = $uri_or_none;
104 $this->info
['background-repeat'] = new HTMLPurifier_AttrDef_Enum(
105 array('repeat', 'repeat-x', 'repeat-y', 'no-repeat')
107 $this->info
['background-attachment'] = new HTMLPurifier_AttrDef_Enum(
108 array('scroll', 'fixed')
110 $this->info
['background-position'] = new HTMLPurifier_AttrDef_CSS_BackgroundPosition();
113 $this->info
['border-top-color'] =
114 $this->info
['border-bottom-color'] =
115 $this->info
['border-left-color'] =
116 $this->info
['border-right-color'] =
117 $this->info
['background-color'] = new HTMLPurifier_AttrDef_CSS_Composite(
119 new HTMLPurifier_AttrDef_Enum(array('transparent')),
120 new HTMLPurifier_AttrDef_CSS_Color()
124 $this->info
['background'] = new HTMLPurifier_AttrDef_CSS_Background($config);
126 $this->info
['border-color'] = new HTMLPurifier_AttrDef_CSS_Multiple($border_color);
129 $this->info
['border-top-width'] =
130 $this->info
['border-bottom-width'] =
131 $this->info
['border-left-width'] =
132 $this->info
['border-right-width'] = new HTMLPurifier_AttrDef_CSS_Composite(
134 new HTMLPurifier_AttrDef_Enum(array('thin', 'medium', 'thick')),
135 new HTMLPurifier_AttrDef_CSS_Length('0') //disallow negative
139 $this->info
['border-width'] = new HTMLPurifier_AttrDef_CSS_Multiple($border_width);
141 $this->info
['letter-spacing'] = new HTMLPurifier_AttrDef_CSS_Composite(
143 new HTMLPurifier_AttrDef_Enum(array('normal')),
144 new HTMLPurifier_AttrDef_CSS_Length()
148 $this->info
['word-spacing'] = new HTMLPurifier_AttrDef_CSS_Composite(
150 new HTMLPurifier_AttrDef_Enum(array('normal')),
151 new HTMLPurifier_AttrDef_CSS_Length()
155 $this->info
['font-size'] = new HTMLPurifier_AttrDef_CSS_Composite(
157 new HTMLPurifier_AttrDef_Enum(
170 new HTMLPurifier_AttrDef_CSS_Percentage(),
171 new HTMLPurifier_AttrDef_CSS_Length()
175 $this->info
['line-height'] = new HTMLPurifier_AttrDef_CSS_Composite(
177 new HTMLPurifier_AttrDef_Enum(array('normal')),
178 new HTMLPurifier_AttrDef_CSS_Number(true), // no negatives
179 new HTMLPurifier_AttrDef_CSS_Length('0'),
180 new HTMLPurifier_AttrDef_CSS_Percentage(true)
185 $this->info
['margin-top'] =
186 $this->info
['margin-bottom'] =
187 $this->info
['margin-left'] =
188 $this->info
['margin-right'] = new HTMLPurifier_AttrDef_CSS_Composite(
190 new HTMLPurifier_AttrDef_CSS_Length(),
191 new HTMLPurifier_AttrDef_CSS_Percentage(),
192 new HTMLPurifier_AttrDef_Enum(array('auto'))
196 $this->info
['margin'] = new HTMLPurifier_AttrDef_CSS_Multiple($margin);
200 $this->info
['padding-top'] =
201 $this->info
['padding-bottom'] =
202 $this->info
['padding-left'] =
203 $this->info
['padding-right'] = new HTMLPurifier_AttrDef_CSS_Composite(
205 new HTMLPurifier_AttrDef_CSS_Length('0'),
206 new HTMLPurifier_AttrDef_CSS_Percentage(true)
210 $this->info
['padding'] = new HTMLPurifier_AttrDef_CSS_Multiple($padding);
212 $this->info
['text-indent'] = new HTMLPurifier_AttrDef_CSS_Composite(
214 new HTMLPurifier_AttrDef_CSS_Length(),
215 new HTMLPurifier_AttrDef_CSS_Percentage()
219 $trusted_wh = new HTMLPurifier_AttrDef_CSS_Composite(
221 new HTMLPurifier_AttrDef_CSS_Length('0'),
222 new HTMLPurifier_AttrDef_CSS_Percentage(true),
223 new HTMLPurifier_AttrDef_Enum(array('auto'))
226 $max = $config->get('CSS.MaxImgLength');
228 $this->info
['width'] =
229 $this->info
['height'] =
232 new HTMLPurifier_AttrDef_Switch(
235 new HTMLPurifier_AttrDef_CSS_Composite(
237 new HTMLPurifier_AttrDef_CSS_Length('0', $max),
238 new HTMLPurifier_AttrDef_Enum(array('auto'))
241 // For everyone else:
245 $this->info
['text-decoration'] = new HTMLPurifier_AttrDef_CSS_TextDecoration();
247 $this->info
['font-family'] = new HTMLPurifier_AttrDef_CSS_FontFamily();
249 // this could use specialized code
250 $this->info
['font-weight'] = new HTMLPurifier_AttrDef_Enum(
269 // MUST be called after other font properties, as it references
270 // a CSSDefinition object
271 $this->info
['font'] = new HTMLPurifier_AttrDef_CSS_Font($config);
274 $this->info
['border'] =
275 $this->info
['border-bottom'] =
276 $this->info
['border-top'] =
277 $this->info
['border-left'] =
278 $this->info
['border-right'] = new HTMLPurifier_AttrDef_CSS_Border($config);
280 $this->info
['border-collapse'] = new HTMLPurifier_AttrDef_Enum(
281 array('collapse', 'separate')
284 $this->info
['caption-side'] = new HTMLPurifier_AttrDef_Enum(
285 array('top', 'bottom')
288 $this->info
['table-layout'] = new HTMLPurifier_AttrDef_Enum(
289 array('auto', 'fixed')
292 $this->info
['vertical-align'] = new HTMLPurifier_AttrDef_CSS_Composite(
294 new HTMLPurifier_AttrDef_Enum(
306 new HTMLPurifier_AttrDef_CSS_Length(),
307 new HTMLPurifier_AttrDef_CSS_Percentage()
311 $this->info
['border-spacing'] = new HTMLPurifier_AttrDef_CSS_Multiple(new HTMLPurifier_AttrDef_CSS_Length(), 2);
313 // These CSS properties don't work on many browsers, but we live
315 $this->info
['white-space'] = new HTMLPurifier_AttrDef_Enum(
316 array('nowrap', 'normal', 'pre', 'pre-wrap', 'pre-line')
319 if ($config->get('CSS.Proprietary')) {
320 $this->doSetupProprietary($config);
323 if ($config->get('CSS.AllowTricky')) {
324 $this->doSetupTricky($config);
327 if ($config->get('CSS.Trusted')) {
328 $this->doSetupTrusted($config);
331 $allow_important = $config->get('CSS.AllowImportant');
332 // wrap all attr-defs with decorator that handles !important
333 foreach ($this->info
as $k => $v) {
334 $this->info
[$k] = new HTMLPurifier_AttrDef_CSS_ImportantDecorator($v, $allow_important);
337 $this->setupConfigStuff($config);
341 * @param HTMLPurifier_Config $config
343 protected function doSetupProprietary($config)
345 // Internet Explorer only scrollbar colors
346 $this->info
['scrollbar-arrow-color'] = new HTMLPurifier_AttrDef_CSS_Color();
347 $this->info
['scrollbar-base-color'] = new HTMLPurifier_AttrDef_CSS_Color();
348 $this->info
['scrollbar-darkshadow-color'] = new HTMLPurifier_AttrDef_CSS_Color();
349 $this->info
['scrollbar-face-color'] = new HTMLPurifier_AttrDef_CSS_Color();
350 $this->info
['scrollbar-highlight-color'] = new HTMLPurifier_AttrDef_CSS_Color();
351 $this->info
['scrollbar-shadow-color'] = new HTMLPurifier_AttrDef_CSS_Color();
353 // technically not proprietary, but CSS3, and no one supports it
354 $this->info
['opacity'] = new HTMLPurifier_AttrDef_CSS_AlphaValue();
355 $this->info
['-moz-opacity'] = new HTMLPurifier_AttrDef_CSS_AlphaValue();
356 $this->info
['-khtml-opacity'] = new HTMLPurifier_AttrDef_CSS_AlphaValue();
358 // only opacity, for now
359 $this->info
['filter'] = new HTMLPurifier_AttrDef_CSS_Filter();
362 $this->info
['page-break-after'] =
363 $this->info
['page-break-before'] = new HTMLPurifier_AttrDef_Enum(
372 $this->info
['page-break-inside'] = new HTMLPurifier_AttrDef_Enum(array('auto', 'avoid'));
377 * @param HTMLPurifier_Config $config
379 protected function doSetupTricky($config)
381 $this->info
['display'] = new HTMLPurifier_AttrDef_Enum(
393 'table-header-group',
394 'table-footer-group',
396 'table-column-group',
403 $this->info
['visibility'] = new HTMLPurifier_AttrDef_Enum(
404 array('visible', 'hidden', 'collapse')
406 $this->info
['overflow'] = new HTMLPurifier_AttrDef_Enum(array('visible', 'hidden', 'auto', 'scroll'));
410 * @param HTMLPurifier_Config $config
412 protected function doSetupTrusted($config)
414 $this->info
['position'] = new HTMLPurifier_AttrDef_Enum(
415 array('static', 'relative', 'absolute', 'fixed')
418 $this->info
['left'] =
419 $this->info
['right'] =
420 $this->info
['bottom'] = new HTMLPurifier_AttrDef_CSS_Composite(
422 new HTMLPurifier_AttrDef_CSS_Length(),
423 new HTMLPurifier_AttrDef_CSS_Percentage(),
424 new HTMLPurifier_AttrDef_Enum(array('auto')),
427 $this->info
['z-index'] = new HTMLPurifier_AttrDef_CSS_Composite(
429 new HTMLPurifier_AttrDef_Integer(),
430 new HTMLPurifier_AttrDef_Enum(array('auto')),
436 * Performs extra config-based processing. Based off of
437 * HTMLPurifier_HTMLDefinition.
438 * @param HTMLPurifier_Config $config
439 * @todo Refactor duplicate elements into common class (probably using
440 * composition, not inheritance).
442 protected function setupConfigStuff($config)
444 // setup allowed elements
445 $support = "(for information on implementing this, see the " .
447 $allowed_properties = $config->get('CSS.AllowedProperties');
448 if ($allowed_properties !== null) {
449 foreach ($this->info
as $name => $d) {
450 if (!isset($allowed_properties[$name])) {
451 unset($this->info
[$name]);
453 unset($allowed_properties[$name]);
456 foreach ($allowed_properties as $name => $d) {
457 // :TODO: Is this htmlspecialchars() call really necessary?
458 $name = htmlspecialchars($name);
459 trigger_error("Style attribute '$name' is not supported $support", E_USER_WARNING
);
463 $forbidden_properties = $config->get('CSS.ForbiddenProperties');
464 if ($forbidden_properties !== null) {
465 foreach ($this->info
as $name => $d) {
466 if (isset($forbidden_properties[$name])) {
467 unset($this->info
[$name]);
474 // vim: et sw=4 sts=4