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