Config.php 30.8 KB
Newer Older
Zot's avatar
Zot committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php

/**
 * Configuration object that triggers customizable behavior.
 *
 * @warning This class is strongly defined: that means that the class
 *          will fail if an undefined directive is retrieved or set.
 *
 * @note Many classes that could (although many times don't) use the
 *       configuration object make it a mandatory parameter.  This is
 *       because a configuration object should always be forwarded,
 *       otherwise, you run the risk of missing a parameter and then
 *       being stumped when a configuration directive doesn't work.
 *
 * @todo Reconsider some of the public member variables
 */
class HTMLPurifier_Config
{

    /**
     * HTML Purifier's version
22
     * @type string
Zot's avatar
Zot committed
23
     */
24
    public $version = '4.9.3';
Zot's avatar
Zot committed
25
26

    /**
27
28
29
     * Whether or not to automatically finalize
     * the object if a read operation is done.
     * @type bool
Zot's avatar
Zot committed
30
31
32
33
34
35
     */
    public $autoFinalize = true;

    // protected member variables

    /**
36
37
38
     * Namespace indexed array of serials for specific namespaces.
     * @see getSerial() for more info.
     * @type string[]
Zot's avatar
Zot committed
39
40
41
42
     */
    protected $serials = array();

    /**
43
44
     * Serial for entire configuration object.
     * @type string
Zot's avatar
Zot committed
45
46
47
48
     */
    protected $serial;

    /**
49
50
     * Parser for variables.
     * @type HTMLPurifier_VarParser_Flexible
Zot's avatar
Zot committed
51
     */
52
    protected $parser = null;
Zot's avatar
Zot committed
53
54

    /**
55
56
     * Reference HTMLPurifier_ConfigSchema for value checking.
     * @type HTMLPurifier_ConfigSchema
Zot's avatar
Zot committed
57
58
59
60
61
62
     * @note This is public for introspective purposes. Please don't
     *       abuse!
     */
    public $def;

    /**
63
64
     * Indexed array of definitions.
     * @type HTMLPurifier_Definition[]
Zot's avatar
Zot committed
65
66
67
68
     */
    protected $definitions;

    /**
69
70
     * Whether or not config is finalized.
     * @type bool
Zot's avatar
Zot committed
71
72
73
74
75
     */
    protected $finalized = false;

    /**
     * Property list containing configuration directives.
76
     * @type array
Zot's avatar
Zot committed
77
78
79
80
     */
    protected $plist;

    /**
81
82
     * Whether or not a set is taking place due to an alias lookup.
     * @type bool
Zot's avatar
Zot committed
83
84
85
86
     */
    private $aliasMode;

    /**
87
88
89
90
     * Set to false if you do not want line and file numbers in errors.
     * (useful when unit testing).  This will also compress some errors
     * and exceptions.
     * @type bool
Zot's avatar
Zot committed
91
92
93
94
95
     */
    public $chatty = true;

    /**
     * Current lock; only gets to this namespace are allowed.
96
     * @type string
Zot's avatar
Zot committed
97
98
99
100
     */
    private $lock;

    /**
101
102
103
104
     * Constructor
     * @param HTMLPurifier_ConfigSchema $definition ConfigSchema that defines
     * what directives are allowed.
     * @param HTMLPurifier_PropertyList $parent
Zot's avatar
Zot committed
105
     */
106
107
    public function __construct($definition, $parent = null)
    {
Zot's avatar
Zot committed
108
109
110
111
112
113
114
115
116
117
118
119
        $parent = $parent ? $parent : $definition->defaultPlist;
        $this->plist = new HTMLPurifier_PropertyList($parent);
        $this->def = $definition; // keep a copy around for checking
        $this->parser = new HTMLPurifier_VarParser_Flexible();
    }

    /**
     * Convenience constructor that creates a config object based on a mixed var
     * @param mixed $config Variable that defines the state of the config
     *                      object. Can be: a HTMLPurifier_Config() object,
     *                      an array of directives based on loadArray(),
     *                      or a string filename of an ini file.
120
121
     * @param HTMLPurifier_ConfigSchema $schema Schema object
     * @return HTMLPurifier_Config Configured object
Zot's avatar
Zot committed
122
     */
123
124
    public static function create($config, $schema = null)
    {
Zot's avatar
Zot committed
125
126
127
128
129
130
131
132
133
        if ($config instanceof HTMLPurifier_Config) {
            // pass-through
            return $config;
        }
        if (!$schema) {
            $ret = HTMLPurifier_Config::createDefault();
        } else {
            $ret = new HTMLPurifier_Config($schema);
        }
134
135
136
        if (is_string($config)) {
            $ret->loadIni($config);
        } elseif (is_array($config)) $ret->loadArray($config);
Zot's avatar
Zot committed
137
138
139
140
141
        return $ret;
    }

    /**
     * Creates a new config object that inherits from a previous one.
142
     * @param HTMLPurifier_Config $config Configuration object to inherit from.
Zot's avatar
Zot committed
143
144
     * @return HTMLPurifier_Config object with $config as its parent.
     */
145
146
    public static function inherit(HTMLPurifier_Config $config)
    {
Zot's avatar
Zot committed
147
148
149
150
151
        return new HTMLPurifier_Config($config->def, $config->plist);
    }

    /**
     * Convenience constructor that creates a default configuration object.
152
     * @return HTMLPurifier_Config default object.
Zot's avatar
Zot committed
153
     */
154
155
    public static function createDefault()
    {
Zot's avatar
Zot committed
156
157
158
159
160
161
        $definition = HTMLPurifier_ConfigSchema::instance();
        $config = new HTMLPurifier_Config($definition);
        return $config;
    }

    /**
162
163
164
165
166
167
     * Retrieves a value from the configuration.
     *
     * @param string $key String key
     * @param mixed $a
     *
     * @return mixed
Zot's avatar
Zot committed
168
     */
169
170
    public function get($key, $a = null)
    {
Zot's avatar
Zot committed
171
        if ($a !== null) {
172
173
174
175
            $this->triggerError(
                "Using deprecated API: use \$config->get('$key.$a') instead",
                E_USER_WARNING
            );
Zot's avatar
Zot committed
176
177
            $key = "$key.$a";
        }
178
179
180
        if (!$this->finalized) {
            $this->autoFinalize();
        }
Zot's avatar
Zot committed
181
182
        if (!isset($this->def->info[$key])) {
            // can't add % due to SimpleTest bug
183
184
185
186
            $this->triggerError(
                'Cannot retrieve value of undefined directive ' . htmlspecialchars($key),
                E_USER_WARNING
            );
Zot's avatar
Zot committed
187
188
189
190
            return;
        }
        if (isset($this->def->info[$key]->isAlias)) {
            $d = $this->def->info[$key];
191
192
193
194
            $this->triggerError(
                'Cannot get value from aliased directive, use real name ' . $d->key,
                E_USER_ERROR
            );
Zot's avatar
Zot committed
195
196
197
198
199
            return;
        }
        if ($this->lock) {
            list($ns) = explode('.', $key);
            if ($ns !== $this->lock) {
200
201
202
203
204
205
206
                $this->triggerError(
                    'Cannot get value of namespace ' . $ns . ' when lock for ' .
                    $this->lock .
                    ' is active, this probably indicates a Definition setup method ' .
                    'is accessing directives that are not within its namespace',
                    E_USER_ERROR
                );
Zot's avatar
Zot committed
207
208
209
210
211
212
213
                return;
            }
        }
        return $this->plist->get($key);
    }

    /**
214
215
216
217
218
     * Retrieves an array of directives to values from a given namespace
     *
     * @param string $namespace String namespace
     *
     * @return array
Zot's avatar
Zot committed
219
     */
220
221
222
223
224
    public function getBatch($namespace)
    {
        if (!$this->finalized) {
            $this->autoFinalize();
        }
Zot's avatar
Zot committed
225
226
        $full = $this->getAll();
        if (!isset($full[$namespace])) {
227
228
229
230
231
            $this->triggerError(
                'Cannot retrieve undefined namespace ' .
                htmlspecialchars($namespace),
                E_USER_WARNING
            );
Zot's avatar
Zot committed
232
233
234
235
236
237
            return;
        }
        return $full[$namespace];
    }

    /**
238
     * Returns a SHA-1 signature of a segment of the configuration object
Zot's avatar
Zot committed
239
     * that uniquely identifies that particular configuration
240
241
242
243
     *
     * @param string $namespace Namespace to get serial for
     *
     * @return string
Zot's avatar
Zot committed
244
245
246
     * @note Revision is handled specially and is removed from the batch
     *       before processing!
     */
247
248
    public function getBatchSerial($namespace)
    {
Zot's avatar
Zot committed
249
250
251
        if (empty($this->serials[$namespace])) {
            $batch = $this->getBatch($namespace);
            unset($batch['DefinitionRev']);
252
            $this->serials[$namespace] = sha1(serialize($batch));
Zot's avatar
Zot committed
253
254
255
256
257
        }
        return $this->serials[$namespace];
    }

    /**
258
     * Returns a SHA-1 signature for the entire configuration object
Zot's avatar
Zot committed
259
     * that uniquely identifies that particular configuration
260
261
     *
     * @return string
Zot's avatar
Zot committed
262
     */
263
264
    public function getSerial()
    {
Zot's avatar
Zot committed
265
        if (empty($this->serial)) {
266
            $this->serial = sha1(serialize($this->getAll()));
Zot's avatar
Zot committed
267
268
269
270
271
272
        }
        return $this->serial;
    }

    /**
     * Retrieves all directives, organized by namespace
273
     *
Zot's avatar
Zot committed
274
275
     * @warning This is a pretty inefficient function, avoid if you can
     */
276
277
278
279
280
    public function getAll()
    {
        if (!$this->finalized) {
            $this->autoFinalize();
        }
Zot's avatar
Zot committed
281
282
283
284
285
286
287
288
289
290
        $ret = array();
        foreach ($this->plist->squash() as $name => $value) {
            list($ns, $key) = explode('.', $name, 2);
            $ret[$ns][$key] = $value;
        }
        return $ret;
    }

    /**
     * Sets a value to configuration.
291
292
293
294
     *
     * @param string $key key
     * @param mixed $value value
     * @param mixed $a
Zot's avatar
Zot committed
295
     */
296
297
    public function set($key, $value, $a = null)
    {
Zot's avatar
Zot committed
298
299
300
301
302
303
304
305
306
        if (strpos($key, '.') === false) {
            $namespace = $key;
            $directive = $value;
            $value = $a;
            $key = "$key.$directive";
            $this->triggerError("Using deprecated API: use \$config->set('$key', ...) instead", E_USER_NOTICE);
        } else {
            list($namespace) = explode('.', $key);
        }
307
308
309
        if ($this->isFinalized('Cannot set directive after finalization')) {
            return;
        }
Zot's avatar
Zot committed
310
        if (!isset($this->def->info[$key])) {
311
312
313
314
            $this->triggerError(
                'Cannot set undefined directive ' . htmlspecialchars($key) . ' to value',
                E_USER_WARNING
            );
Zot's avatar
Zot committed
315
316
317
318
319
320
            return;
        }
        $def = $this->def->info[$key];

        if (isset($def->isAlias)) {
            if ($this->aliasMode) {
321
322
323
324
325
                $this->triggerError(
                    'Double-aliases not allowed, please fix '.
                    'ConfigSchema bug with' . $key,
                    E_USER_ERROR
                );
Zot's avatar
Zot committed
326
327
328
329
330
331
332
333
334
335
                return;
            }
            $this->aliasMode = true;
            $this->set($def->key, $value);
            $this->aliasMode = false;
            $this->triggerError("$key is an alias, preferred directive name is {$def->key}", E_USER_NOTICE);
            return;
        }

        // Raw type might be negative when using the fully optimized form
336
        // of stdClass, which indicates allow_null == true
Zot's avatar
Zot committed
337
338
339
340
341
342
343
344
345
346
347
348
        $rtype = is_int($def) ? $def : $def->type;
        if ($rtype < 0) {
            $type = -$rtype;
            $allow_null = true;
        } else {
            $type = $rtype;
            $allow_null = isset($def->allow_null);
        }

        try {
            $value = $this->parser->parse($value, $type, $allow_null);
        } catch (HTMLPurifier_VarParserException $e) {
349
350
351
352
353
            $this->triggerError(
                'Value for ' . $key . ' is of invalid type, should be ' .
                HTMLPurifier_VarParser::getTypeName($type),
                E_USER_WARNING
            );
Zot's avatar
Zot committed
354
355
356
357
358
359
360
361
362
            return;
        }
        if (is_string($value) && is_object($def)) {
            // resolve value alias if defined
            if (isset($def->aliases[$value])) {
                $value = $def->aliases[$value];
            }
            // check to see if the value is allowed
            if (isset($def->allowed) && !isset($def->allowed[$value])) {
363
364
365
366
367
                $this->triggerError(
                    'Value not supported, valid values are: ' .
                    $this->_listify($def->allowed),
                    E_USER_WARNING
                );
Zot's avatar
Zot committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
                return;
            }
        }
        $this->plist->set($key, $value);

        // reset definitions if the directives they depend on changed
        // this is a very costly process, so it's discouraged
        // with finalization
        if ($namespace == 'HTML' || $namespace == 'CSS' || $namespace == 'URI') {
            $this->definitions[$namespace] = null;
        }

        $this->serials[$namespace] = false;
    }

    /**
     * Convenience function for error reporting
385
386
387
388
     *
     * @param array $lookup
     *
     * @return string
Zot's avatar
Zot committed
389
     */
390
391
    private function _listify($lookup)
    {
Zot's avatar
Zot committed
392
        $list = array();
393
394
395
        foreach ($lookup as $name => $b) {
            $list[] = $name;
        }
Zot's avatar
Zot committed
396
397
398
399
400
        return implode(', ', $list);
    }

    /**
     * Retrieves object reference to the HTML definition.
401
402
     *
     * @param bool $raw Return a copy that has not been setup yet. Must be
Zot's avatar
Zot committed
403
     *             called before it's been setup, otherwise won't work.
404
405
406
407
408
409
410
411
412
413
414
415
     * @param bool $optimized If true, this method may return null, to
     *             indicate that a cached version of the modified
     *             definition object is available and no further edits
     *             are necessary.  Consider using
     *             maybeGetRawHTMLDefinition, which is more explicitly
     *             named, instead.
     *
     * @return HTMLPurifier_HTMLDefinition
     */
    public function getHTMLDefinition($raw = false, $optimized = false)
    {
        return $this->getDefinition('HTML', $raw, $optimized);
Zot's avatar
Zot committed
416
417
418
419
    }

    /**
     * Retrieves object reference to the CSS definition
420
421
     *
     * @param bool $raw Return a copy that has not been setup yet. Must be
Zot's avatar
Zot committed
422
     *             called before it's been setup, otherwise won't work.
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
     * @param bool $optimized If true, this method may return null, to
     *             indicate that a cached version of the modified
     *             definition object is available and no further edits
     *             are necessary.  Consider using
     *             maybeGetRawCSSDefinition, which is more explicitly
     *             named, instead.
     *
     * @return HTMLPurifier_CSSDefinition
     */
    public function getCSSDefinition($raw = false, $optimized = false)
    {
        return $this->getDefinition('CSS', $raw, $optimized);
    }

    /**
     * Retrieves object reference to the URI definition
     *
     * @param bool $raw Return a copy that has not been setup yet. Must be
     *             called before it's been setup, otherwise won't work.
     * @param bool $optimized If true, this method may return null, to
     *             indicate that a cached version of the modified
     *             definition object is available and no further edits
     *             are necessary.  Consider using
     *             maybeGetRawURIDefinition, which is more explicitly
     *             named, instead.
     *
     * @return HTMLPurifier_URIDefinition
     */
    public function getURIDefinition($raw = false, $optimized = false)
    {
        return $this->getDefinition('URI', $raw, $optimized);
Zot's avatar
Zot committed
454
455
456
457
    }

    /**
     * Retrieves a definition
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
     *
     * @param string $type Type of definition: HTML, CSS, etc
     * @param bool $raw Whether or not definition should be returned raw
     * @param bool $optimized Only has an effect when $raw is true.  Whether
     *        or not to return null if the result is already present in
     *        the cache.  This is off by default for backwards
     *        compatibility reasons, but you need to do things this
     *        way in order to ensure that caching is done properly.
     *        Check out enduser-customize.html for more details.
     *        We probably won't ever change this default, as much as the
     *        maybe semantics is the "right thing to do."
     *
     * @throws HTMLPurifier_Exception
     * @return HTMLPurifier_Definition
     */
    public function getDefinition($type, $raw = false, $optimized = false)
    {
        if ($optimized && !$raw) {
            throw new HTMLPurifier_Exception("Cannot set optimized = true when raw = false");
        }
        if (!$this->finalized) {
            $this->autoFinalize();
        }
Zot's avatar
Zot committed
481
482
483
484
485
486
487
        // temporarily suspend locks, so we can handle recursive definition calls
        $lock = $this->lock;
        $this->lock = null;
        $factory = HTMLPurifier_DefinitionCacheFactory::instance();
        $cache = $factory->create($type, $this);
        $this->lock = $lock;
        if (!$raw) {
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
            // full definition
            // ---------------
            // check if definition is in memory
            if (!empty($this->definitions[$type])) {
                $def = $this->definitions[$type];
                // check if the definition is setup
                if ($def->setup) {
                    return $def;
                } else {
                    $def->setup($this);
                    if ($def->optimized) {
                        $cache->add($def, $this);
                    }
                    return $def;
                }
            }
            // check if definition is in cache
            $def = $cache->get($this);
            if ($def) {
                // definition in cache, save to memory and return it
                $this->definitions[$type] = $def;
                return $def;
            }
            // initialize it
            $def = $this->initDefinition($type);
            // set it up
            $this->lock = $type;
            $def->setup($this);
            $this->lock = null;
            // save in cache
            $cache->add($def, $this);
            // return it
            return $def;
        } else {
            // raw definition
            // --------------
            // check preconditions
            $def = null;
            if ($optimized) {
                if (is_null($this->get($type . '.DefinitionID'))) {
                    // fatally error out if definition ID not set
                    throw new HTMLPurifier_Exception(
                        "Cannot retrieve raw version without specifying %$type.DefinitionID"
                    );
                }
            }
Zot's avatar
Zot committed
534
            if (!empty($this->definitions[$type])) {
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
                $def = $this->definitions[$type];
                if ($def->setup && !$optimized) {
                    $extra = $this->chatty ?
                        " (try moving this code block earlier in your initialization)" :
                        "";
                    throw new HTMLPurifier_Exception(
                        "Cannot retrieve raw definition after it has already been setup" .
                        $extra
                    );
                }
                if ($def->optimized === null) {
                    $extra = $this->chatty ? " (try flushing your cache)" : "";
                    throw new HTMLPurifier_Exception(
                        "Optimization status of definition is unknown" . $extra
                    );
                }
                if ($def->optimized !== $optimized) {
                    $msg = $optimized ? "optimized" : "unoptimized";
                    $extra = $this->chatty ?
                        " (this backtrace is for the first inconsistent call, which was for a $msg raw definition)"
                        : "";
                    throw new HTMLPurifier_Exception(
                        "Inconsistent use of optimized and unoptimized raw definition retrievals" . $extra
                    );
Zot's avatar
Zot committed
559
560
                }
            }
561
562
563
564
565
566
567
568
            // check if definition was in memory
            if ($def) {
                if ($def->setup) {
                    // invariant: $optimized === true (checked above)
                    return null;
                } else {
                    return $def;
                }
Zot's avatar
Zot committed
569
            }
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
            // if optimized, check if definition was in cache
            // (because we do the memory check first, this formulation
            // is prone to cache slamming, but I think
            // guaranteeing that either /all/ of the raw
            // setup code or /none/ of it is run is more important.)
            if ($optimized) {
                // This code path only gets run once; once we put
                // something in $definitions (which is guaranteed by the
                // trailing code), we always short-circuit above.
                $def = $cache->get($this);
                if ($def) {
                    // save the full definition for later, but don't
                    // return it yet
                    $this->definitions[$type] = $def;
                    return null;
                }
            }
            // check invariants for creation
            if (!$optimized) {
                if (!is_null($this->get($type . '.DefinitionID'))) {
                    if ($this->chatty) {
                        $this->triggerError(
                            'Due to a documentation error in previous version of HTML Purifier, your ' .
                            'definitions are not being cached.  If this is OK, you can remove the ' .
                            '%$type.DefinitionRev and %$type.DefinitionID declaration.  Otherwise, ' .
                            'modify your code to use maybeGetRawDefinition, and test if the returned ' .
                            'value is null before making any edits (if it is null, that means that a ' .
                            'cached version is available, and no raw operations are necessary).  See ' .
                            '<a href="http://htmlpurifier.org/docs/enduser-customize.html#optimized">' .
                            'Customize</a> for more details',
                            E_USER_WARNING
                        );
                    } else {
                        $this->triggerError(
                            "Useless DefinitionID declaration",
                            E_USER_WARNING
                        );
                    }
                }
            }
            // initialize it
            $def = $this->initDefinition($type);
            $def->optimized = $optimized;
            return $def;
Zot's avatar
Zot committed
614
        }
615
616
617
618
619
620
621
622
623
624
625
626
627
        throw new HTMLPurifier_Exception("The impossible happened!");
    }

    /**
     * Initialise definition
     *
     * @param string $type What type of definition to create
     *
     * @return HTMLPurifier_CSSDefinition|HTMLPurifier_HTMLDefinition|HTMLPurifier_URIDefinition
     * @throws HTMLPurifier_Exception
     */
    private function initDefinition($type)
    {
Zot's avatar
Zot committed
628
629
        // quick checks failed, let's create the object
        if ($type == 'HTML') {
630
            $def = new HTMLPurifier_HTMLDefinition();
Zot's avatar
Zot committed
631
        } elseif ($type == 'CSS') {
632
            $def = new HTMLPurifier_CSSDefinition();
Zot's avatar
Zot committed
633
        } elseif ($type == 'URI') {
634
            $def = new HTMLPurifier_URIDefinition();
Zot's avatar
Zot committed
635
        } else {
636
637
638
            throw new HTMLPurifier_Exception(
                "Definition of $type type not supported"
            );
Zot's avatar
Zot committed
639
        }
640
641
642
643
644
645
646
647
648
        $this->definitions[$type] = $def;
        return $def;
    }

    public function maybeGetRawDefinition($name)
    {
        return $this->getDefinition($name, true, true);
    }

649
650
651
    /**
     * @return HTMLPurifier_HTMLDefinition
     */
652
653
654
655
    public function maybeGetRawHTMLDefinition()
    {
        return $this->getDefinition('HTML', true, true);
    }
656
657
658
659
    
    /**
     * @return HTMLPurifier_CSSDefinition
     */
660
661
662
663
    public function maybeGetRawCSSDefinition()
    {
        return $this->getDefinition('CSS', true, true);
    }
664
665
666
667
    
    /**
     * @return HTMLPurifier_URIDefinition
     */
668
669
670
    public function maybeGetRawURIDefinition()
    {
        return $this->getDefinition('URI', true, true);
Zot's avatar
Zot committed
671
672
673
674
675
    }

    /**
     * Loads configuration values from an array with the following structure:
     * Namespace.Directive => Value
676
677
     *
     * @param array $config_array Configuration associative array
Zot's avatar
Zot committed
678
     */
679
680
681
682
683
    public function loadArray($config_array)
    {
        if ($this->isFinalized('Cannot load directives after finalization')) {
            return;
        }
Zot's avatar
Zot committed
684
685
686
687
688
689
690
        foreach ($config_array as $key => $value) {
            $key = str_replace('_', '.', $key);
            if (strpos($key, '.') !== false) {
                $this->set($key, $value);
            } else {
                $namespace = $key;
                $namespace_values = $value;
691
692
                foreach ($namespace_values as $directive => $value2) {
                    $this->set($namespace .'.'. $directive, $value2);
Zot's avatar
Zot committed
693
694
695
696
697
698
699
700
701
                }
            }
        }
    }

    /**
     * Returns a list of array(namespace, directive) for all directives
     * that are allowed in a web-form context as per an allowed
     * namespaces/directives list.
702
703
704
705
706
707
708
709
     *
     * @param array $allowed List of allowed namespaces/directives
     * @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
     *
     * @return array
     */
    public static function getAllowedDirectivesForForm($allowed, $schema = null)
    {
Zot's avatar
Zot committed
710
711
712
713
        if (!$schema) {
            $schema = HTMLPurifier_ConfigSchema::instance();
        }
        if ($allowed !== true) {
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
            if (is_string($allowed)) {
                $allowed = array($allowed);
            }
            $allowed_ns = array();
            $allowed_directives = array();
            $blacklisted_directives = array();
            foreach ($allowed as $ns_or_directive) {
                if (strpos($ns_or_directive, '.') !== false) {
                    // directive
                    if ($ns_or_directive[0] == '-') {
                        $blacklisted_directives[substr($ns_or_directive, 1)] = true;
                    } else {
                        $allowed_directives[$ns_or_directive] = true;
                    }
                } else {
                    // namespace
                    $allowed_ns[$ns_or_directive] = true;
                }
            }
Zot's avatar
Zot committed
733
734
735
736
737
        }
        $ret = array();
        foreach ($schema->info as $key => $def) {
            list($ns, $directive) = explode('.', $key, 2);
            if ($allowed !== true) {
738
739
740
741
742
743
744
745
746
747
748
749
                if (isset($blacklisted_directives["$ns.$directive"])) {
                    continue;
                }
                if (!isset($allowed_directives["$ns.$directive"]) && !isset($allowed_ns[$ns])) {
                    continue;
                }
            }
            if (isset($def->isAlias)) {
                continue;
            }
            if ($directive == 'DefinitionID' || $directive == 'DefinitionRev') {
                continue;
Zot's avatar
Zot committed
750
751
752
753
754
755
756
757
758
            }
            $ret[] = array($ns, $directive);
        }
        return $ret;
    }

    /**
     * Loads configuration values from $_GET/$_POST that were posted
     * via ConfigForm
759
760
761
762
763
764
765
766
767
768
769
     *
     * @param array $array $_GET or $_POST array to import
     * @param string|bool $index Index/name that the config variables are in
     * @param array|bool $allowed List of allowed namespaces/directives
     * @param bool $mq_fix Boolean whether or not to enable magic quotes fix
     * @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
     *
     * @return mixed
     */
    public static function loadArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true, $schema = null)
    {
Zot's avatar
Zot committed
770
771
772
773
774
775
776
        $ret = HTMLPurifier_Config::prepareArrayFromForm($array, $index, $allowed, $mq_fix, $schema);
        $config = HTMLPurifier_Config::create($ret, $schema);
        return $config;
    }

    /**
     * Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
777
778
779
780
781
782
783
784
     *
     * @param array $array $_GET or $_POST array to import
     * @param string|bool $index Index/name that the config variables are in
     * @param array|bool $allowed List of allowed namespaces/directives
     * @param bool $mq_fix Boolean whether or not to enable magic quotes fix
     */
    public function mergeArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true)
    {
Zot's avatar
Zot committed
785
786
787
788
789
790
791
         $ret = HTMLPurifier_Config::prepareArrayFromForm($array, $index, $allowed, $mq_fix, $this->def);
         $this->loadArray($ret);
    }

    /**
     * Prepares an array from a form into something usable for the more
     * strict parts of HTMLPurifier_Config
792
793
794
795
796
797
798
799
800
801
802
803
804
805
     *
     * @param array $array $_GET or $_POST array to import
     * @param string|bool $index Index/name that the config variables are in
     * @param array|bool $allowed List of allowed namespaces/directives
     * @param bool $mq_fix Boolean whether or not to enable magic quotes fix
     * @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
     *
     * @return array
     */
    public static function prepareArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true, $schema = null)
    {
        if ($index !== false) {
            $array = (isset($array[$index]) && is_array($array[$index])) ? $array[$index] : array();
        }
Zot's avatar
Zot committed
806
807
808
809
810
811
812
813
814
815
816
        $mq = $mq_fix && function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc();

        $allowed = HTMLPurifier_Config::getAllowedDirectivesForForm($allowed, $schema);
        $ret = array();
        foreach ($allowed as $key) {
            list($ns, $directive) = $key;
            $skey = "$ns.$directive";
            if (!empty($array["Null_$skey"])) {
                $ret[$ns][$directive] = null;
                continue;
            }
817
818
819
            if (!isset($array[$skey])) {
                continue;
            }
Zot's avatar
Zot committed
820
821
822
823
824
825
826
827
            $value = $mq ? stripslashes($array[$skey]) : $array[$skey];
            $ret[$ns][$directive] = $value;
        }
        return $ret;
    }

    /**
     * Loads configuration values from an ini file
828
829
     *
     * @param string $filename Name of ini file
Zot's avatar
Zot committed
830
     */
831
832
833
834
835
    public function loadIni($filename)
    {
        if ($this->isFinalized('Cannot load directives after finalization')) {
            return;
        }
Zot's avatar
Zot committed
836
837
838
839
840
841
        $array = parse_ini_file($filename, true);
        $this->loadArray($array);
    }

    /**
     * Checks whether or not the configuration object is finalized.
842
843
844
845
     *
     * @param string|bool $error String error message, or false for no error
     *
     * @return bool
Zot's avatar
Zot committed
846
     */
847
848
    public function isFinalized($error = false)
    {
Zot's avatar
Zot committed
849
850
851
852
853
854
855
856
857
858
        if ($this->finalized && $error) {
            $this->triggerError($error, E_USER_ERROR);
        }
        return $this->finalized;
    }

    /**
     * Finalizes configuration only if auto finalize is on and not
     * already finalized
     */
859
860
    public function autoFinalize()
    {
Zot's avatar
Zot committed
861
862
863
864
865
866
867
868
869
870
        if ($this->autoFinalize) {
            $this->finalize();
        } else {
            $this->plist->squash(true);
        }
    }

    /**
     * Finalizes a configuration object, prohibiting further change
     */
871
872
    public function finalize()
    {
Zot's avatar
Zot committed
873
        $this->finalized = true;
874
        $this->parser = null;
Zot's avatar
Zot committed
875
876
877
878
    }

    /**
     * Produces a nicely formatted error message by supplying the
879
880
881
882
     * stack frame information OUTSIDE of HTMLPurifier_Config.
     *
     * @param string $msg An error message
     * @param int $no An error number
Zot's avatar
Zot committed
883
     */
884
885
    protected function triggerError($msg, $no)
    {
Zot's avatar
Zot committed
886
        // determine previous stack frame
887
888
889
890
891
892
893
894
895
896
897
898
899
        $extra = '';
        if ($this->chatty) {
            $trace = debug_backtrace();
            // zip(tail(trace), trace) -- but PHP is not Haskell har har
            for ($i = 0, $c = count($trace); $i < $c - 1; $i++) {
                // XXX this is not correct on some versions of HTML Purifier
                if ($trace[$i + 1]['class'] === 'HTMLPurifier_Config') {
                    continue;
                }
                $frame = $trace[$i];
                $extra = " invoked on line {$frame['line']} in file {$frame['file']}";
                break;
            }
Zot's avatar
Zot committed
900
901
902
903
904
905
906
        }
        trigger_error($msg . $extra, $no);
    }

    /**
     * Returns a serialized form of the configuration object that can
     * be reconstituted.
907
908
     *
     * @return string
Zot's avatar
Zot committed
909
     */
910
911
    public function serialize()
    {
Zot's avatar
Zot committed
912
913
914
915
916
917
918
919
920
        $this->getDefinition('HTML');
        $this->getDefinition('CSS');
        $this->getDefinition('URI');
        return serialize($this);
    }

}

// vim: et sw=4 sts=4