3feb6ded3a7a45656be7b21461a9fd9a7440879b
[moodle.git] / lib / filterlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library functions for managing text filter plugins.
20  *
21  * @package    core
22  * @subpackage filter
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /** The states a filter can be in, stored in the filter_active table. */
30 define('TEXTFILTER_ON', 1);
31 /** The states a filter can be in, stored in the filter_active table. */
32 define('TEXTFILTER_INHERIT', 0);
33 /** The states a filter can be in, stored in the filter_active table. */
34 define('TEXTFILTER_OFF', -1);
35 /** The states a filter can be in, stored in the filter_active table. */
36 define('TEXTFILTER_DISABLED', -9999);
38 /**
39  * Define one exclusive separator that we'll use in the temp saved tags
40  *  keys. It must be something rare enough to avoid having matches with
41  *  filterobjects. MDL-18165
42  */
43 define('TEXTFILTER_EXCL_SEPARATOR', '-%-');
46 /**
47  * Class to manage the filtering of strings. It is intended that this class is
48  * only used by weblib.php. Client code should probably be using the
49  * format_text and format_string functions.
50  *
51  * This class is a singleton.
52  *
53  * @package    core
54  * @subpackage filter
55  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
56  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57  */
58 class filter_manager {
59     /**
60      * @var array This list of active filters, by context, for filtering content.
61      * An array contextid => array of filter objects.
62      */
63     protected $textfilters = array();
65     /**
66      * @var array This list of active filters, by context, for filtering strings.
67      * An array contextid => array of filter objects.
68      */
69     protected $stringfilters = array();
71     /** @var array Exploded version of $CFG->stringfilters. */
72     protected $stringfilternames = array();
74     /** @var object Holds the singleton instance. */
75     protected static $singletoninstance;
77     protected function __construct() {
78         $this->stringfilternames = filter_get_string_filters();
79     }
81     /**
82      * @return filter_manager the singleton instance.
83      */
84     public static function instance() {
85         global $CFG;
86         if (is_null(self::$singletoninstance)) {
87             if (!empty($CFG->perfdebug)) {
88                 self::$singletoninstance = new performance_measuring_filter_manager();
89             } else {
90                 self::$singletoninstance = new self();
91             }
92         }
93         return self::$singletoninstance;
94     }
96     /**
97      * Load all the filters required by this context.
98      *
99      * @param object $context
100      */
101     protected function load_filters($context) {
102         $filters = filter_get_active_in_context($context);
103         $this->textfilters[$context->id] = array();
104         $this->stringfilters[$context->id] = array();
105         foreach ($filters as $filtername => $localconfig) {
106             $filter = $this->make_filter_object($filtername, $context, $localconfig);
107             if (is_null($filter)) {
108                 continue;
109             }
110             $this->textfilters[$context->id][] = $filter;
111             if (in_array($filtername, $this->stringfilternames)) {
112                 $this->stringfilters[$context->id][] = $filter;
113             }
114         }
115     }
117     /**
118      * Factory method for creating a filter
119      *
120      * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
121      * @param object $context context object.
122      * @param array $localconfig array of local configuration variables for this filter.
123      * @return object moodle_text_filter The filter, or null, if this type of filter is
124      *      not recognised or could not be created.
125      */
126     protected function make_filter_object($filtername, $context, $localconfig) {
127         global $CFG;
128         $path = $CFG->dirroot .'/'. $filtername .'/filter.php';
129         if (!is_readable($path)) {
130             return null;
131         }
132         include_once($path);
134         $filterclassname = 'filter_' . basename($filtername);
135         if (class_exists($filterclassname)) {
136             return new $filterclassname($context, $localconfig);
137         }
139         $legacyfunctionname = basename($filtername) . '_filter';
140         if (function_exists($legacyfunctionname)) {
141             return new legacy_filter($legacyfunctionname, $context, $localconfig);
142         }
144         return null;
145     }
147     /**
148      * @todo Document this function
149      * @param string $text
150      * @param array $filterchain
151      * @param array $options options passed to the filters
152      * @return string $text
153      */
154     protected function apply_filter_chain($text, $filterchain, array $options = array()) {
155         foreach ($filterchain as $filter) {
156             $text = $filter->filter($text, $options);
157         }
158         return $text;
159     }
161     /**
162      * @todo Document this function
163      * @param object $context
164      * @return object A text filter
165      */
166     protected function get_text_filters($context) {
167         if (!isset($this->textfilters[$context->id])) {
168             $this->load_filters($context);
169         }
170         return $this->textfilters[$context->id];
171     }
173     /**
174      * @todo Document this function
175      * @param object $context
176      * @return object A string filter
177      */
178     protected function get_string_filters($context) {
179         if (!isset($this->stringfilters[$context->id])) {
180             $this->load_filters($context);
181         }
182         return $this->stringfilters[$context->id];
183     }
185     /**
186      * Filter some text
187      *
188      * @param string $text The text to filter
189      * @param object $context
190      * @param array $options options passed to the filters
191      * @return string resulting text
192      */
193     public function filter_text($text, $context, array $options = array()) {
194         $text = $this->apply_filter_chain($text, $this->get_text_filters($context), $options);
195         /// <nolink> tags removed for XHTML compatibility
196         $text = str_replace(array('<nolink>', '</nolink>'), '', $text);
197         return $text;
198     }
200     /**
201      * Filter a piece of string
202      *
203      * @param string $string The text to filter
204      * @param object $context
205      * @return string resulting string
206      */
207     public function filter_string($string, $context) {
208         return $this->apply_filter_chain($string, $this->get_string_filters($context));
209     }
211     /**
212      * @todo Document this function
213      * @param object $context
214      * @return object A string filter
215      */
216     public function text_filtering_hash($context) {
217         $filters = $this->get_text_filters($context);
218         $hashes = array();
219         foreach ($filters as $filter) {
220             $hashes[] = $filter->hash();
221         }
222         return implode('-', $hashes);
223     }
226 /**
227  * Filter manager subclass that does nothing. Having this simplifies the logic
228  * of format_text, etc.
229  *
230  * @todo Document this class
231  *
232  * @package    core
233  * @subpackage filter
234  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
235  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
236  */
237 class null_filter_manager {
238     /**
239      * @return string
240      */
241     public function filter_text($text, $context, $options) {
242         return $text;
243     }
245     /**
246      * @return string
247      */
248     public function filter_string($string, $context) {
249         return $string;
250     }
252     /**
253      * @return string
254      */
255     public function text_filtering_hash() {
256         return '';
257     }
260 /**
261  * Filter manager subclass that tacks how much work it does.
262  *
263  * @todo Document this class
264  *
265  * @package    core
266  * @subpackage filter
267  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
268  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
269  */
270 class performance_measuring_filter_manager extends filter_manager {
271     /** @var int */
272     protected $filterscreated = 0;
273     protected $textsfiltered = 0;
274     protected $stringsfiltered = 0;
276     /**
277      * @param string $filtername
278      * @param object $context
279      * @param mixed $localconfig
280      * @return mixed
281      */
282     protected function make_filter_object($filtername, $context, $localconfig) {
283         $this->filterscreated++;
284         return parent::make_filter_object($filtername, $context, $localconfig);
285     }
287     /**
288      * @param string $text
289      * @param object $context
290      * @param array $options options passed to the filters
291      * @return mixed
292      */
293     public function filter_text($text, $context, array $options = array()) {
294         $this->textsfiltered++;
295         return parent::filter_text($text, $context, $options);
296     }
298     /**
299      * @param string $string
300      * @param object $context
301      * @return mixed
302      */
303     public function filter_string($string, $context) {
304         $this->stringsfiltered++;
305         return parent::filter_string($string, $context);
306     }
308     /**
309      * @return array
310      */
311     public function get_performance_summary() {
312         return array(array(
313             'contextswithfilters' => count($this->textfilters),
314             'filterscreated' => $this->filterscreated,
315             'textsfiltered' => $this->textsfiltered,
316             'stringsfiltered' => $this->stringsfiltered,
317         ), array(
318             'contextswithfilters' => 'Contexts for which filters were loaded',
319             'filterscreated' => 'Filters created',
320             'textsfiltered' => 'Pieces of content filtered',
321             'stringsfiltered' => 'Strings filtered',
322         ));
323     }
326 /**
327  * Base class for text filters. You just need to override this class and
328  * implement the filter method.
329  *
330  * @package    core
331  * @subpackage filter
332  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
333  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
334  */
335 abstract class moodle_text_filter {
336     /** @var object The context we are in. */
337     protected $context;
338     /** @var array Any local configuration for this filter in this context. */
339     protected $localconfig;
341     /**
342      * Set any context-specific configuration for this filter.
343      * @param object $context The current course id.
344      * @param object $context The current context.
345      * @param array $config Any context-specific configuration for this filter.
346      */
347     public function __construct($context, array $localconfig) {
348         $this->context = $context;
349         $this->localconfig = $localconfig;
350     }
352     /**
353      * @return string The class name of the current class
354      */
355     public function hash() {
356         return __CLASS__;
357     }
359     /**
360      * Override this function to actually implement the filtering.
361      *
362      * @param $text some HTML content.
363      * @param array $options options passed to the filters
364      * @return the HTML content after the filtering has been applied.
365      */
366     public abstract function filter($text, array $options = array());
369 /**
370  * moodle_text_filter implementation that encapsulates an old-style filter that
371  * only defines a function, not a class.
372  *
373  * @package    core
374  * @subpackage filter
375  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
376  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
377  */
378 class legacy_filter extends moodle_text_filter {
379     /** @var string */
380     protected $filterfunction;
381     protected $courseid;
383     /**
384      * Set any context-specific configuration for this filter.
385      *
386      * @param string $filterfunction
387      * @param object $context The current context.
388      * @param array $config Any context-specific configuration for this filter.
389      */
390     public function __construct($filterfunction, $context, array $localconfig) {
391         parent::__construct($context, $localconfig);
392         $this->filterfunction = $filterfunction;
393         $this->courseid = get_courseid_from_context($this->context);
394     }
396     /**
397      * @param string $text
398      * @param array $options options - not supported for legacy filters
399      * @return mixed
400      */
401     public function filter($text, array $options = array()) {
402         if ($this->courseid) {
403             // old filters are called only when inside courses
404             return call_user_func($this->filterfunction, $this->courseid, $text);
405         } else {
406             return $text;
407         }
408     }
411 /**
412  * This is just a little object to define a phrase and some instructions
413  * for how to process it.  Filters can create an array of these to pass
414  * to the filter_phrases function below.
415  *
416  * @package    core
417  * @subpackage filter
418  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
419  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
420  **/
421 class filterobject {
422     /** @var string */
423     var $phrase;
424     var $hreftagbegin;
425     var $hreftagend;
426     /** @var bool */
427     var $casesensitive;
428     var $fullmatch;
429     /** @var mixed */
430     var $replacementphrase;
431     var $work_phrase;
432     var $work_hreftagbegin;
433     var $work_hreftagend;
434     var $work_casesensitive;
435     var $work_fullmatch;
436     var $work_replacementphrase;
437     /** @var bool */
438     var $work_calculated;
440     /**
441      * A constructor just because I like constructing
442      *
443      * @param string $phrase
444      * @param string $hreftagbegin
445      * @param string $hreftagend
446      * @param bool $casesensitive
447      * @param bool $fullmatch
448      * @param mixed $replacementphrase
449      */
450     function filterobject($phrase, $hreftagbegin = '<span class="highlight">',
451                                    $hreftagend = '</span>',
452                                    $casesensitive = false,
453                                    $fullmatch = false,
454                                    $replacementphrase = NULL) {
456         $this->phrase           = $phrase;
457         $this->hreftagbegin     = $hreftagbegin;
458         $this->hreftagend       = $hreftagend;
459         $this->casesensitive    = $casesensitive;
460         $this->fullmatch        = $fullmatch;
461         $this->replacementphrase= $replacementphrase;
462         $this->work_calculated  = false;
464     }
467 /**
468  * Look up the name of this filter in the most appropriate location.
469  * If $filterlocation = 'mod' then does get_string('filtername', $filter);
470  * else if $filterlocation = 'filter' then does get_string('filtername', 'filter_' . $filter);
471  * with a fallback to get_string('filtername', $filter) for backwards compatibility.
472  * These are the only two options supported at the moment.
473  *
474  * @param string $filter the folder name where the filter lives.
475  * @return string the human-readable name for this filter.
476  */
477 function filter_get_name($filter) {
478     list($type, $filter) = explode('/', $filter);
479     switch ($type) {
480         case 'filter':
481             $strfiltername = get_string('filtername', 'filter_' . $filter);
482             if (substr($strfiltername, 0, 2) != '[[') {
483                 // found a valid string.
484                 return $strfiltername;
485             }
486             // Fall through to try the legacy location.
488         case 'mod':
489             $strfiltername = get_string('filtername', $filter);
490             if (substr($strfiltername, 0, 2) == '[[') {
491                 $strfiltername .= ' (' . $type . '/' . $filter . ')';
492             }
493             return $strfiltername;
495         default:
496             throw new coding_exception('Unknown filter type ' . $type);
497     }
500 /**
501  * Get the names of all the filters installed in this Moodle.
502  *
503  * @global object
504  * @return array path => filter name from the appropriate lang file. e.g.
505  * array('mod/glossary' => 'Glossary Auto-linking', 'filter/tex' => 'TeX Notation');
506  * sorted in alphabetical order of name.
507  */
508 function filter_get_all_installed() {
509     global $CFG;
510     $filternames = array();
511     // TODO: deprecated in 2.2, delete support for "mod" legacy filters location in 2.3. MDL-29996
512     $filterlocations = array('mod', 'filter');
513     foreach ($filterlocations as $filterlocation) {
514         // TODO: move get_list_of_plugins() to get_plugin_list()
515         $filters = get_list_of_plugins($filterlocation);
516         foreach ($filters as $filter) {
517             // MDL-29994 - Ignore mod/data and mod/glossary filters forever, this will be out in 2.3
518             if ($filterlocation == 'mod' && ($filter == 'data' || $filter == 'glossary')) {
519                 continue;
520             }
521             $path = $filterlocation . '/' . $filter;
522             if (is_readable($CFG->dirroot . '/' . $path . '/filter.php')) {
523                 $strfiltername = filter_get_name($path);
524                 $filternames[$path] = $strfiltername;
525             }
526         }
527     }
528     collatorlib::asort($filternames);
529     return $filternames;
532 /**
533  * Set the global activated state for a text filter.
534  *
535  * @global object
536  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
537  * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.
538  * @param integer $sortorder (optional) a position in the sortorder to place this filter.
539  *      If not given defaults to:
540  *      No change in order if we are updating an existing record, and not changing to or from TEXTFILTER_DISABLED.
541  *      Just after the last currently active filter when adding an unknown filter
542  *          in state TEXTFILTER_ON or TEXTFILTER_OFF, or enabling/disabling an existing filter.
543  *      Just after the very last filter when adding an unknown filter in state TEXTFILTER_DISABLED
544  */
545 function filter_set_global_state($filter, $state, $sortorder = false) {
546     global $DB;
548     // Check requested state is valid.
549     if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_DISABLED))) {
550         throw new coding_exception("Illegal option '$state' passed to filter_set_global_state. " .
551                 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.");
552     }
554     // Check sortorder is valid.
555     if ($sortorder !== false) {
556         if ($sortorder < 1 || $sortorder > $DB->get_field('filter_active', 'MAX(sortorder)', array()) + 1) {
557             throw new coding_exception("Invalid sort order passed to filter_set_global_state.");
558         }
559     }
561     // See if there is an existing record.
562     $syscontext = get_context_instance(CONTEXT_SYSTEM);
563     $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $syscontext->id));
564     if (empty($rec)) {
565         $insert = true;
566         $rec = new stdClass;
567         $rec->filter = $filter;
568         $rec->contextid = $syscontext->id;
569     } else {
570         $insert = false;
571         if ($sortorder === false && !($rec->active == TEXTFILTER_DISABLED xor $state == TEXTFILTER_DISABLED)) {
572             $sortorder = $rec->sortorder;
573         }
574     }
576     // Automatic sort order.
577     if ($sortorder === false) {
578         if ($state == TEXTFILTER_DISABLED && $insert) {
579             $prevmaxsortorder = $DB->get_field('filter_active', 'MAX(sortorder)', array());
580         } else {
581             $prevmaxsortorder = $DB->get_field_select('filter_active', 'MAX(sortorder)', 'active <> ?', array(TEXTFILTER_DISABLED));
582         }
583         if (empty($prevmaxsortorder)) {
584             $sortorder = 1;
585         } else {
586             $sortorder = $prevmaxsortorder + 1;
587             if (!$insert && $state == TEXTFILTER_DISABLED) {
588                 $sortorder = $prevmaxsortorder;
589             }
590         }
591     }
593     // Move any existing records out of the way of the sortorder.
594     if ($insert) {
595         $DB->execute('UPDATE {filter_active} SET sortorder = sortorder + 1 WHERE sortorder >= ?', array($sortorder));
596     } else if ($sortorder != $rec->sortorder) {
597         $sparesortorder = $DB->get_field('filter_active', 'MIN(sortorder)', array()) - 1;
598         $DB->set_field('filter_active', 'sortorder', $sparesortorder, array('filter' => $filter, 'contextid' => $syscontext->id));
599         if ($sortorder < $rec->sortorder) {
600             $DB->execute('UPDATE {filter_active} SET sortorder = sortorder + 1 WHERE sortorder >= ? AND sortorder < ?',
601                     array($sortorder, $rec->sortorder));
602         } else if ($sortorder > $rec->sortorder) {
603             $DB->execute('UPDATE {filter_active} SET sortorder = sortorder - 1 WHERE sortorder <= ? AND sortorder > ?',
604                     array($sortorder, $rec->sortorder));
605         }
606     }
608     // Insert/update the new record.
609     $rec->active = $state;
610     $rec->sortorder = $sortorder;
611     if ($insert) {
612         $DB->insert_record('filter_active', $rec);
613     } else {
614         $DB->update_record('filter_active', $rec);
615     }
618 /**
619  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
620  * @return boolean is this filter allowed to be used on this site. That is, the
621  *      admin has set the global 'active' setting to On, or Off, but available.
622  */
623 function filter_is_enabled($filter) {
624     return array_key_exists($filter, filter_get_globally_enabled());
627 /**
628  * Return a list of all the filters that may be in use somewhere.
629  *
630  * @staticvar array $enabledfilters
631  * @return array where the keys and values are both the filter name, like 'filter/tex'.
632  */
633 function filter_get_globally_enabled() {
634     static $enabledfilters = null;
635     if (is_null($enabledfilters)) {
636         $filters = filter_get_global_states();
637         $enabledfilters = array();
638         foreach ($filters as $filter => $filerinfo) {
639             if ($filerinfo->active != TEXTFILTER_DISABLED) {
640                 $enabledfilters[$filter] = $filter;
641             }
642         }
643     }
644     return $enabledfilters;
647 /**
648  * Return the names of the filters that should also be applied to strings
649  * (when they are enabled).
650  *
651  * @global object
652  * @return array where the keys and values are both the filter name, like 'filter/tex'.
653  */
654 function filter_get_string_filters() {
655     global $CFG;
656     $stringfilters = array();
657     if (!empty($CFG->filterall) && !empty($CFG->stringfilters)) {
658         $stringfilters = explode(',', $CFG->stringfilters);
659         $stringfilters = array_combine($stringfilters, $stringfilters);
660     }
661     return $stringfilters;
664 /**
665  * Sets whether a particular active filter should be applied to all strings by
666  * format_string, or just used by format_text.
667  *
668  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
669  * @param boolean $applytostrings if true, this filter will apply to format_string
670  *      and format_text, when it is enabled.
671  */
672 function filter_set_applies_to_strings($filter, $applytostrings) {
673     $stringfilters = filter_get_string_filters();
674     $numstringfilters = count($stringfilters);
675     if ($applytostrings) {
676         $stringfilters[$filter] = $filter;
677     } else {
678         unset($stringfilters[$filter]);
679     }
680     if (count($stringfilters) != $numstringfilters) {
681         set_config('stringfilters', implode(',', $stringfilters));
682         set_config('filterall', !empty($stringfilters));
683     }
686 /**
687  * Set the local activated state for a text filter.
688  *
689  * @global object
690  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
691  * @param integer $contextid The id of the context to get the local config for.
692  * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT.
693  * @return void
694  */
695 function filter_set_local_state($filter, $contextid, $state) {
696     global $DB;
698     // Check requested state is valid.
699     if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_INHERIT))) {
700         throw new coding_exception("Illegal option '$state' passed to filter_set_local_state. " .
701                 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT.");
702     }
704     if ($contextid == get_context_instance(CONTEXT_SYSTEM)->id) {
705         throw new coding_exception('You cannot use filter_set_local_state ' .
706                 'with $contextid equal to the system context id.');
707     }
709     if ($state == TEXTFILTER_INHERIT) {
710         $DB->delete_records('filter_active', array('filter' => $filter, 'contextid' => $contextid));
711         return;
712     }
714     $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $contextid));
715     $insert = false;
716     if (empty($rec)) {
717         $insert = true;
718         $rec = new stdClass;
719         $rec->filter = $filter;
720         $rec->contextid = $contextid;
721     }
723     $rec->active = $state;
725     if ($insert) {
726         $DB->insert_record('filter_active', $rec);
727     } else {
728         $DB->update_record('filter_active', $rec);
729     }
732 /**
733  * Set a particular local config variable for a filter in a context.
734  *
735  * @global object
736  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
737  * @param integer $contextid The id of the context to get the local config for.
738  * @param string $name the setting name.
739  * @param string $value the corresponding value.
740  */
741 function filter_set_local_config($filter, $contextid, $name, $value) {
742     global $DB;
743     $rec = $DB->get_record('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name));
744     $insert = false;
745     if (empty($rec)) {
746         $insert = true;
747         $rec = new stdClass;
748         $rec->filter = $filter;
749         $rec->contextid = $contextid;
750         $rec->name = $name;
751     }
753     $rec->value = $value;
755     if ($insert) {
756         $DB->insert_record('filter_config', $rec);
757     } else {
758         $DB->update_record('filter_config', $rec);
759     }
762 /**
763  * Remove a particular local config variable for a filter in a context.
764  *
765  * @global object
766  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
767  * @param integer $contextid The id of the context to get the local config for.
768  * @param string $name the setting name.
769  */
770 function filter_unset_local_config($filter, $contextid, $name) {
771     global $DB;
772     $DB->delete_records('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name));
775 /**
776  * Get local config variables for a filter in a context. Normally (when your
777  * filter is running) you don't need to call this, becuase the config is fetched
778  * for you automatically. You only need this, for example, when you are getting
779  * the config so you can show the user an editing from.
780  *
781  * @global object
782  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
783  * @param integer $contextid The ID of the context to get the local config for.
784  * @return array of name => value pairs.
785  */
786 function filter_get_local_config($filter, $contextid) {
787     global $DB;
788     return $DB->get_records_menu('filter_config', array('filter' => $filter, 'contextid' => $contextid), '', 'name,value');
791 /**
792  * This function is for use by backup. Gets all the filter information specific
793  * to one context.
794  *
795  * @global object
796  * @param int $contextid
797  * @return array Array with two elements. The first element is an array of objects with
798  *      fields filter and active. These come from the filter_active table. The
799  *      second element is an array of objects with fields filter, name and value
800  *      from the filter_config table.
801  */
802 function filter_get_all_local_settings($contextid) {
803     global $DB;
804     $context = get_context_instance(CONTEXT_SYSTEM);
805     return array(
806         $DB->get_records('filter_active', array('contextid' => $contextid), 'filter', 'filter,active'),
807         $DB->get_records('filter_config', array('contextid' => $contextid), 'filter,name', 'filter,name,value'),
808     );
811 /**
812  * Get the list of active filters, in the order that they should be used
813  * for a particular context, along with any local configuration variables.
814  *
815  * @global object
816  * @param object $context a context
817  * @return array an array where the keys are the filter names, for example
818  *      'filter/tex' or 'mod/glossary' and the values are any local
819  *      configuration for that filter, as an array of name => value pairs
820  *      from the filter_config table. In a lot of cases, this will be an
821  *      empty array. So, an example return value for this function might be
822  *      array('filter/tex' => array(), 'mod/glossary' => array('glossaryid', 123))
823  */
824 function filter_get_active_in_context($context) {
825     global $DB, $FILTERLIB_PRIVATE;
827     // Use cache (this is a within-request cache only) if available. See
828     // function filter_preload_activities.
829     if (isset($FILTERLIB_PRIVATE->active) &&
830             array_key_exists($context->id, $FILTERLIB_PRIVATE->active)) {
831         return $FILTERLIB_PRIVATE->active[$context->id];
832     }
834     $contextids = str_replace('/', ',', trim($context->path, '/'));
836     // The following SQL is tricky. It is explained on
837     // http://docs.moodle.org/dev/Filter_enable/disable_by_context
838     $sql = "SELECT active.filter, fc.name, fc.value
839          FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder
840              FROM {filter_active} f
841              JOIN {context} ctx ON f.contextid = ctx.id
842              WHERE ctx.id IN ($contextids)
843              GROUP BY filter
844              HAVING MAX(f.active * " . $DB->sql_cast_2signed('ctx.depth') .
845                     ") > -MIN(f.active * " . $DB->sql_cast_2signed('ctx.depth') . ")
846          ) active
847          LEFT JOIN {filter_config} fc ON fc.filter = active.filter AND fc.contextid = $context->id
848          ORDER BY active.sortorder";
849     $rs = $DB->get_recordset_sql($sql);
851     // Masssage the data into the specified format to return.
852     $filters = array();
853     foreach ($rs as $row) {
854         if (!isset($filters[$row->filter])) {
855             $filters[$row->filter] = array();
856         }
857         if (!is_null($row->name)) {
858             $filters[$row->filter][$row->name] = $row->value;
859         }
860     }
862     $rs->close();
864     return $filters;
867 /**
868  * Preloads the list of active filters for all activities (modules) on the course
869  * using two database queries.
870  * @param course_modinfo $modinfo Course object from get_fast_modinfo
871  */
872 function filter_preload_activities(course_modinfo $modinfo) {
873     global $DB, $FILTERLIB_PRIVATE;
875     // Don't repeat preload
876     if (!isset($FILTERLIB_PRIVATE->preloaded)) {
877         $FILTERLIB_PRIVATE->preloaded = array();
878     }
879     if (!empty($FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()])) {
880         return;
881     }
882     $FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()] = true;
884     // Get contexts for all CMs
885     $cmcontexts = array();
886     $cmcontextids = array();
887     foreach ($modinfo->get_cms() as $cm) {
888         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
889         $cmcontextids[] = $modulecontext->id;
890         $cmcontexts[] = $modulecontext;
891     }
893     // Get course context and all other parents...
894     $coursecontext = get_context_instance(CONTEXT_COURSE, $modinfo->get_course_id());
895     $parentcontextids = explode('/', substr($coursecontext->path, 1));
896     $allcontextids = array_merge($cmcontextids, $parentcontextids);
898     // Get all filter_active rows relating to all these contexts
899     list ($sql, $params) = $DB->get_in_or_equal($allcontextids);
900     $filteractives = $DB->get_records_select('filter_active', "contextid $sql", $params);
902     // Get all filter_config only for the cm contexts
903     list ($sql, $params) = $DB->get_in_or_equal($cmcontextids);
904     $filterconfigs = $DB->get_records_select('filter_config', "contextid $sql", $params);
906     // Note: I was a bit surprised that filter_config only works for the
907     // most specific context (i.e. it does not need to be checked for course
908     // context if we only care about CMs) however basede on code in
909     // filter_get_active_in_context, this does seem to be correct.
911     // Build course default active list. Initially this will be an array of
912     // filter name => active score (where an active score >0 means it's active)
913     $courseactive = array();
915     // Also build list of filter_active rows below course level, by contextid
916     $remainingactives = array();
918     // Array lists filters that are banned at top level
919     $banned = array();
921     // Add any active filters in parent contexts to the array
922     foreach ($filteractives as $row) {
923         $depth = array_search($row->contextid, $parentcontextids);
924         if ($depth !== false) {
925             // Find entry
926             if (!array_key_exists($row->filter, $courseactive)) {
927                 $courseactive[$row->filter] = 0;
928             }
929             // This maths copes with reading rows in any order. Turning on/off
930             // at site level counts 1, at next level down 4, at next level 9,
931             // then 16, etc. This means the deepest level always wins, except
932             // against the -9999 at top level.
933             $courseactive[$row->filter] +=
934                 ($depth + 1) * ($depth + 1) * $row->active;
936             if ($row->active == TEXTFILTER_DISABLED) {
937                 $banned[$row->filter] = true;
938             }
939         } else {
940             // Build list of other rows indexed by contextid
941             if (!array_key_exists($row->contextid, $remainingactives)) {
942                 $remainingactives[$row->contextid] = array();
943             }
944             $remainingactives[$row->contextid][] = $row;
945         }
946     }
948     // Chuck away the ones that aren't active
949     foreach ($courseactive as $filter=>$score) {
950         if ($score <= 0) {
951             unset($courseactive[$filter]);
952         } else {
953             $courseactive[$filter] = array();
954         }
955     }
957     // Loop through the contexts to reconstruct filter_active lists for each
958     // cm on the course
959     if (!isset($FILTERLIB_PRIVATE->active)) {
960         $FILTERLIB_PRIVATE->active = array();
961     }
962     foreach ($cmcontextids as $contextid) {
963         // Copy course list
964         $FILTERLIB_PRIVATE->active[$contextid] = $courseactive;
966         // Are there any changes to the active list?
967         if (array_key_exists($contextid, $remainingactives)) {
968             foreach ($remainingactives[$contextid] as $row) {
969                 if ($row->active > 0 && empty($banned[$row->filter])) {
970                     // If it's marked active for specific context, add entry
971                     // (doesn't matter if one exists already)
972                     $FILTERLIB_PRIVATE->active[$contextid][$row->filter] = array();
973                 } else {
974                     // If it's marked inactive, remove entry (doesn't matter
975                     // if it doesn't exist)
976                     unset($FILTERLIB_PRIVATE->active[$contextid][$row->filter]);
977                 }
978             }
979         }
980     }
982     // Process all config rows to add config data to these entries
983     foreach ($filterconfigs as $row) {
984         if (isset($FILTERLIB_PRIVATE->active[$row->contextid][$row->filter])) {
985             $FILTERLIB_PRIVATE->active[$row->contextid][$row->filter][$row->name] = $row->value;
986         }
987     }
990 /**
991  * List all of the filters that are available in this context, and what the
992  * local and inherited states of that filter are.
993  *
994  * @global object
995  * @param object $context a context that is not the system context.
996  * @return array an array with filter names, for example 'filter/tex' or
997  *      'mod/glossary' as keys. and and the values are objects with fields:
998  *      ->filter filter name, same as the key.
999  *      ->localstate TEXTFILTER_ON/OFF/INHERIT
1000  *      ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT.
1001  */
1002 function filter_get_available_in_context($context) {
1003     global $DB;
1005     // The complex logic is working out the active state in the parent context,
1006     // so strip the current context from the list.
1007     $contextids = explode('/', trim($context->path, '/'));
1008     array_pop($contextids);
1009     $contextids = implode(',', $contextids);
1010     if (empty($contextids)) {
1011         throw new coding_exception('filter_get_available_in_context cannot be called with the system context.');
1012     }
1014     // The following SQL is tricky, in the same way at the SQL in filter_get_active_in_context.
1015     $sql = "SELECT parent_states.filter,
1016                 CASE WHEN fa.active IS NULL THEN " . TEXTFILTER_INHERIT . "
1017                 ELSE fa.active END AS localstate,
1018              parent_states.inheritedstate
1019          FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder,
1020                     CASE WHEN MAX(f.active * " . $DB->sql_cast_2signed('ctx.depth') .
1021                             ") > -MIN(f.active * " . $DB->sql_cast_2signed('ctx.depth') . ") THEN " . TEXTFILTER_ON . "
1022                     ELSE " . TEXTFILTER_OFF . " END AS inheritedstate
1023              FROM {filter_active} f
1024              JOIN {context} ctx ON f.contextid = ctx.id
1025              WHERE ctx.id IN ($contextids)
1026              GROUP BY f.filter
1027              HAVING MIN(f.active) > " . TEXTFILTER_DISABLED . "
1028          ) parent_states
1029          LEFT JOIN {filter_active} fa ON fa.filter = parent_states.filter AND fa.contextid = $context->id
1030          ORDER BY parent_states.sortorder";
1031     return $DB->get_records_sql($sql);
1034 /**
1035  * This function is for use by the filter administration page.
1036  *
1037  * @global object
1038  * @return array 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder'
1039  */
1040 function filter_get_global_states() {
1041     global $DB;
1042     $context = get_context_instance(CONTEXT_SYSTEM);
1043     return $DB->get_records('filter_active', array('contextid' => $context->id), 'sortorder', 'filter,active,sortorder');
1046 /**
1047  * Delete all the data in the database relating to a filter, prior to deleting it.
1048  *
1049  * @global object
1050  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
1051  */
1052 function filter_delete_all_for_filter($filter) {
1053     global $DB;
1054     if (substr($filter, 0, 7) == 'filter/') {
1055         unset_all_config_for_plugin('filter_' . basename($filter));
1056     }
1057     $DB->delete_records('filter_active', array('filter' => $filter));
1058     $DB->delete_records('filter_config', array('filter' => $filter));
1061 /**
1062  * Delete all the data in the database relating to a context, used when contexts are deleted.
1063  *
1064  * @param integer $contextid The id of the context being deleted.
1065  */
1066 function filter_delete_all_for_context($contextid) {
1067     global $DB;
1068     $DB->delete_records('filter_active', array('contextid' => $contextid));
1069     $DB->delete_records('filter_config', array('contextid' => $contextid));
1072 /**
1073  * Does this filter have a global settings page in the admin tree?
1074  * (The settings page for a filter must be called, for example,
1075  * filtersettingfiltertex or filtersettingmodglossay.)
1076  *
1077  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
1078  * @return boolean Whether there should be a 'Settings' link on the config page.
1079  */
1080 function filter_has_global_settings($filter) {
1081     global $CFG;
1082     $settingspath = $CFG->dirroot . '/' . $filter . '/filtersettings.php';
1083     return is_readable($settingspath);
1086 /**
1087  * Does this filter have local (per-context) settings?
1088  *
1089  * @param string $filter The filter name, for example 'filter/tex' or 'mod/glossary'.
1090  * @return boolean Whether there should be a 'Settings' link on the manage filters in context page.
1091  */
1092 function filter_has_local_settings($filter) {
1093     global $CFG;
1094     $settingspath = $CFG->dirroot . '/' . $filter . '/filterlocalsettings.php';
1095     return is_readable($settingspath);
1098 /**
1099  * Certain types of context (block and user) may not have local filter settings.
1100  * the function checks a context to see whether it may have local config.
1101  *
1102  * @param object $context a context.
1103  * @return boolean whether this context may have local filter settings.
1104  */
1105 function filter_context_may_have_filter_settings($context) {
1106     return $context->contextlevel != CONTEXT_BLOCK && $context->contextlevel != CONTEXT_USER;
1109 /**
1110  * Process phrases intelligently found within a HTML text (such as adding links)
1111  *
1112  * @staticvar array $usedpharses
1113  * @param string $text             the text that we are filtering
1114  * @param array $link_array       an array of filterobjects
1115  * @param array $ignoretagsopen   an array of opening tags that we should ignore while filtering
1116  * @param array $ignoretagsclose  an array of corresponding closing tags
1117  * @param bool $overridedefaultignore True to only use tags provided by arguments
1118  * @return string
1119  **/
1120 function filter_phrases($text, &$link_array, $ignoretagsopen=NULL, $ignoretagsclose=NULL,
1121         $overridedefaultignore=false) {
1123     global $CFG;
1125     static $usedphrases;
1127     $ignoretags = array();  //To store all the enclosig tags to be completely ignored
1128     $tags = array();        //To store all the simple tags to be ignored
1130     if (!$overridedefaultignore) {
1131         // A list of open/close tags that we should not replace within
1132         // Extended to include <script>, <textarea>, <select> and <a> tags
1133         // Regular expression allows tags with or without attributes
1134         $filterignoretagsopen  = array('<head>' , '<nolink>' , '<span class="nolink">',
1135                 '<script(\s[^>]*?)?>', '<textarea(\s[^>]*?)?>',
1136                 '<select(\s[^>]*?)?>', '<a(\s[^>]*?)?>');
1137         $filterignoretagsclose = array('</head>', '</nolink>', '</span>',
1138                  '</script>', '</textarea>', '</select>','</a>');
1139     } else {
1140         // Set an empty default list
1141         $filterignoretagsopen = array();
1142         $filterignoretagsclose = array();
1143     }
1145     // Add the user defined ignore tags to the default list
1146     if ( is_array($ignoretagsopen) ) {
1147         foreach ($ignoretagsopen as $open) {
1148             $filterignoretagsopen[] = $open;
1149         }
1150         foreach ($ignoretagsclose as $close) {
1151             $filterignoretagsclose[] = $close;
1152         }
1153     }
1155 /// Invalid prefixes and suffixes for the fullmatch searches
1156 /// Every "word" character, but the underscore, is a invalid suffix or prefix.
1157 /// (nice to use this because it includes national characters (accents...) as word characters.
1158     $filterinvalidprefixes = '([^\W_])';
1159     $filterinvalidsuffixes = '([^\W_])';
1161     //// Double up some magic chars to avoid "accidental matches"
1162     $text = preg_replace('/([#*%])/','\1\1',$text);
1165 ////Remove everything enclosed by the ignore tags from $text
1166     filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1168 /// Remove tags from $text
1169     filter_save_tags($text,$tags);
1171 /// Time to cycle through each phrase to be linked
1172     $size = sizeof($link_array);
1173     for ($n=0; $n < $size; $n++) {
1174         $linkobject =& $link_array[$n];
1176     /// Set some defaults if certain properties are missing
1177     /// Properties may be missing if the filterobject class has not been used to construct the object
1178         if (empty($linkobject->phrase)) {
1179             continue;
1180         }
1182     /// Avoid integers < 1000 to be linked. See bug 1446.
1183         $intcurrent = intval($linkobject->phrase);
1184         if (!empty($intcurrent) && strval($intcurrent) == $linkobject->phrase && $intcurrent < 1000) {
1185             continue;
1186         }
1188     /// All this work has to be done ONLY it it hasn't been done before
1189     if (!$linkobject->work_calculated) {
1190             if (!isset($linkobject->hreftagbegin) or !isset($linkobject->hreftagend)) {
1191                 $linkobject->work_hreftagbegin = '<span class="highlight"';
1192                 $linkobject->work_hreftagend   = '</span>';
1193             } else {
1194                 $linkobject->work_hreftagbegin = $linkobject->hreftagbegin;
1195                 $linkobject->work_hreftagend   = $linkobject->hreftagend;
1196             }
1198         /// Double up chars to protect true duplicates
1199         /// be cleared up before returning to the user.
1200             $linkobject->work_hreftagbegin = preg_replace('/([#*%])/','\1\1',$linkobject->work_hreftagbegin);
1202             if (empty($linkobject->casesensitive)) {
1203                 $linkobject->work_casesensitive = false;
1204             } else {
1205                 $linkobject->work_casesensitive = true;
1206             }
1207             if (empty($linkobject->fullmatch)) {
1208                 $linkobject->work_fullmatch = false;
1209             } else {
1210                 $linkobject->work_fullmatch = true;
1211             }
1213         /// Strip tags out of the phrase
1214             $linkobject->work_phrase = strip_tags($linkobject->phrase);
1216         /// Double up chars that might cause a false match -- the duplicates will
1217         /// be cleared up before returning to the user.
1218             $linkobject->work_phrase = preg_replace('/([#*%])/','\1\1',$linkobject->work_phrase);
1220         /// Set the replacement phrase properly
1221             if ($linkobject->replacementphrase) {    //We have specified a replacement phrase
1222             /// Strip tags
1223                 $linkobject->work_replacementphrase = strip_tags($linkobject->replacementphrase);
1224             } else {                                 //The replacement is the original phrase as matched below
1225                 $linkobject->work_replacementphrase = '$1';
1226             }
1228         /// Quote any regular expression characters and the delimiter in the work phrase to be searched
1229             $linkobject->work_phrase = preg_quote($linkobject->work_phrase, '/');
1231         /// Work calculated
1232             $linkobject->work_calculated = true;
1234         }
1236     /// If $CFG->filtermatchoneperpage, avoid previously (request) linked phrases
1237         if (!empty($CFG->filtermatchoneperpage)) {
1238             if (!empty($usedphrases) && in_array($linkobject->work_phrase,$usedphrases)) {
1239                 continue;
1240             }
1241         }
1243     /// Regular expression modifiers
1244         $modifiers = ($linkobject->work_casesensitive) ? 's' : 'isu'; // works in unicode mode!
1246     /// Do we need to do a fullmatch?
1247     /// If yes then go through and remove any non full matching entries
1248         if ($linkobject->work_fullmatch) {
1249             $notfullmatches = array();
1250             $regexp = '/'.$filterinvalidprefixes.'('.$linkobject->work_phrase.')|('.$linkobject->work_phrase.')'.$filterinvalidsuffixes.'/'.$modifiers;
1252             preg_match_all($regexp,$text,$list_of_notfullmatches);
1254             if ($list_of_notfullmatches) {
1255                 foreach (array_unique($list_of_notfullmatches[0]) as $key=>$value) {
1256                     $notfullmatches['<*'.$key.'*>'] = $value;
1257                 }
1258                 if (!empty($notfullmatches)) {
1259                     $text = str_replace($notfullmatches,array_keys($notfullmatches),$text);
1260                 }
1261             }
1262         }
1264     /// Finally we do our highlighting
1265         if (!empty($CFG->filtermatchonepertext) || !empty($CFG->filtermatchoneperpage)) {
1266             $resulttext = preg_replace('/('.$linkobject->work_phrase.')/'.$modifiers,
1267                                       $linkobject->work_hreftagbegin.
1268                                       $linkobject->work_replacementphrase.
1269                                       $linkobject->work_hreftagend, $text, 1);
1270         } else {
1271             $resulttext = preg_replace('/('.$linkobject->work_phrase.')/'.$modifiers,
1272                                       $linkobject->work_hreftagbegin.
1273                                       $linkobject->work_replacementphrase.
1274                                       $linkobject->work_hreftagend, $text);
1275         }
1278     /// If the text has changed we have to look for links again
1279         if ($resulttext != $text) {
1280         /// Set $text to $resulttext
1281             $text = $resulttext;
1282         /// Remove everything enclosed by the ignore tags from $text
1283             filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1284         /// Remove tags from $text
1285             filter_save_tags($text,$tags);
1286         /// If $CFG->filtermatchoneperpage, save linked phrases to request
1287             if (!empty($CFG->filtermatchoneperpage)) {
1288                 $usedphrases[] = $linkobject->work_phrase;
1289             }
1290         }
1293     /// Replace the not full matches before cycling to next link object
1294         if (!empty($notfullmatches)) {
1295             $text = str_replace(array_keys($notfullmatches),$notfullmatches,$text);
1296             unset($notfullmatches);
1297         }
1298     }
1300 /// Rebuild the text with all the excluded areas
1302     if (!empty($tags)) {
1303         $text = str_replace(array_keys($tags), $tags, $text);
1304     }
1306     if (!empty($ignoretags)) {
1307         $ignoretags = array_reverse($ignoretags); /// Reversed so "progressive" str_replace() will solve some nesting problems.
1308         $text = str_replace(array_keys($ignoretags),$ignoretags,$text);
1309     }
1311     //// Remove the protective doubleups
1312     $text =  preg_replace('/([#*%])(\1)/','\1',$text);
1314 /// Add missing javascript for popus
1315     $text = filter_add_javascript($text);
1318     return $text;
1321 /**
1322  * @todo Document this function
1323  * @param array $linkarray
1324  * @return array
1325  */
1326 function filter_remove_duplicates($linkarray) {
1328     $concepts  = array(); // keep a record of concepts as we cycle through
1329     $lconcepts = array(); // a lower case version for case insensitive
1331     $cleanlinks = array();
1333     foreach ($linkarray as $key=>$filterobject) {
1334         if ($filterobject->casesensitive) {
1335             $exists = in_array($filterobject->phrase, $concepts);
1336         } else {
1337             $exists = in_array(moodle_strtolower($filterobject->phrase), $lconcepts);
1338         }
1340         if (!$exists) {
1341             $cleanlinks[] = $filterobject;
1342             $concepts[] = $filterobject->phrase;
1343             $lconcepts[] = moodle_strtolower($filterobject->phrase);
1344         }
1345     }
1347     return $cleanlinks;
1350 /**
1351  * Extract open/lose tags and their contents to avoid being processed by filters.
1352  * Useful to extract pieces of code like <a>...</a> tags. It returns the text
1353  * converted with some <#xTEXTFILTER_EXCL_SEPARATORx#> codes replacing the extracted text. Such extracted
1354  * texts are returned in the ignoretags array (as values), with codes as keys.
1355  *
1356  * @param string $text                  the text that we are filtering (in/out)
1357  * @param array $filterignoretagsopen  an array of open tags to start searching
1358  * @param array $filterignoretagsclose an array of close tags to end searching
1359  * @param array $ignoretags            an array of saved strings useful to rebuild the original text (in/out)
1360  **/
1361 function filter_save_ignore_tags(&$text, $filterignoretagsopen, $filterignoretagsclose, &$ignoretags) {
1363 /// Remove everything enclosed by the ignore tags from $text
1364     foreach ($filterignoretagsopen as $ikey=>$opentag) {
1365         $closetag = $filterignoretagsclose[$ikey];
1366     /// form regular expression
1367         $opentag  = str_replace('/','\/',$opentag); // delimit forward slashes
1368         $closetag = str_replace('/','\/',$closetag); // delimit forward slashes
1369         $pregexp = '/'.$opentag.'(.*?)'.$closetag.'/is';
1371         preg_match_all($pregexp, $text, $list_of_ignores);
1372         foreach (array_unique($list_of_ignores[0]) as $key=>$value) {
1373             $prefix = (string)(count($ignoretags) + 1);
1374             $ignoretags['<#'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$key.'#>'] = $value;
1375         }
1376         if (!empty($ignoretags)) {
1377             $text = str_replace($ignoretags,array_keys($ignoretags),$text);
1378         }
1379     }
1382 /**
1383  * Extract tags (any text enclosed by < and > to avoid being processed by filters.
1384  * It returns the text converted with some <%xTEXTFILTER_EXCL_SEPARATORx%> codes replacing the extracted text. Such extracted
1385  * texts are returned in the tags array (as values), with codes as keys.
1386  *
1387  * @param string $text   the text that we are filtering (in/out)
1388  * @param array $tags   an array of saved strings useful to rebuild the original text (in/out)
1389  **/
1390 function filter_save_tags(&$text, &$tags) {
1392     preg_match_all('/<([^#%*].*?)>/is',$text,$list_of_newtags);
1393     foreach (array_unique($list_of_newtags[0]) as $ntkey=>$value) {
1394         $prefix = (string)(count($tags) + 1);
1395         $tags['<%'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$ntkey.'%>'] = $value;
1396     }
1397     if (!empty($tags)) {
1398         $text = str_replace($tags,array_keys($tags),$text);
1399     }
1402 /**
1403  * Add missing openpopup javascript to HTML files.
1404  *
1405  * @param string $text
1406  * @return string
1407  */
1408 function filter_add_javascript($text) {
1409     global $CFG;
1411     if (stripos($text, '</html>') === FALSE) {
1412         return $text; // this is not a html file
1413     }
1414     if (strpos($text, 'onclick="return openpopup') === FALSE) {
1415         return $text; // no popup - no need to add javascript
1416     }
1417     $js ="
1418     <script type=\"text/javascript\">
1419     <!--
1420         function openpopup(url,name,options,fullscreen) {
1421           fullurl = \"".$CFG->httpswwwroot."\" + url;
1422           windowobj = window.open(fullurl,name,options);
1423           if (fullscreen) {
1424             windowobj.moveTo(0,0);
1425             windowobj.resizeTo(screen.availWidth,screen.availHeight);
1426           }
1427           windowobj.focus();
1428           return false;
1429         }
1430     // -->
1431     </script>";
1432     if (stripos($text, '</head>') !== FALSE) {
1433         //try to add it into the head element
1434         $text = str_ireplace('</head>', $js.'</head>', $text);
1435         return $text;
1436     }
1438     //last chance - try adding head element
1439     return preg_replace("/<html.*?>/is", "\\0<head>".$js.'</head>', $text);