Merge branch 'MDL-59014-master' of git://github.com/junpataleta/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
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  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
52  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
53  */
54 class filter_manager {
55     /**
56      * @var moodle_text_filter[][] This list of active filters, by context, for filtering content.
57      * An array contextid => ordered array of filter name => filter objects.
58      */
59     protected $textfilters = array();
61     /**
62      * @var moodle_text_filter[][] This list of active filters, by context, for filtering strings.
63      * An array contextid => ordered array of filter name => filter objects.
64      */
65     protected $stringfilters = array();
67     /** @var array Exploded version of $CFG->stringfilters. */
68     protected $stringfilternames = array();
70     /** @var filter_manager Holds the singleton instance. */
71     protected static $singletoninstance;
73     /**
74      * Constructor. Protected. Use {@link instance()} instead.
75      */
76     protected function __construct() {
77         $this->stringfilternames = filter_get_string_filters();
78     }
80     /**
81      * Factory method. Use this to get the filter manager.
82      *
83      * @return filter_manager the singleton instance.
84      */
85     public static function instance() {
86         global $CFG;
87         if (is_null(self::$singletoninstance)) {
88             if (!empty($CFG->perfdebug) and $CFG->perfdebug > 7) {
89                 self::$singletoninstance = new performance_measuring_filter_manager();
90             } else {
91                 self::$singletoninstance = new self();
92             }
93         }
94         return self::$singletoninstance;
95     }
97     /**
98      * Resets the caches, usually to be called between unit tests
99      */
100     public static function reset_caches() {
101         if (self::$singletoninstance) {
102             self::$singletoninstance->unload_all_filters();
103         }
104         self::$singletoninstance = null;
105     }
107     /**
108      * Unloads all filters and other cached information
109      */
110     protected function unload_all_filters() {
111         $this->textfilters = array();
112         $this->stringfilters = array();
113         $this->stringfilternames = array();
114     }
116     /**
117      * Load all the filters required by this context.
118      *
119      * @param context $context the context.
120      */
121     protected function load_filters($context) {
122         $filters = filter_get_active_in_context($context);
123         $this->textfilters[$context->id] = array();
124         $this->stringfilters[$context->id] = array();
125         foreach ($filters as $filtername => $localconfig) {
126             $filter = $this->make_filter_object($filtername, $context, $localconfig);
127             if (is_null($filter)) {
128                 continue;
129             }
130             $this->textfilters[$context->id][$filtername] = $filter;
131             if (in_array($filtername, $this->stringfilternames)) {
132                 $this->stringfilters[$context->id][$filtername] = $filter;
133             }
134         }
135     }
137     /**
138      * Factory method for creating a filter.
139      *
140      * @param string $filtername The filter name, for example 'tex'.
141      * @param context $context context object.
142      * @param array $localconfig array of local configuration variables for this filter.
143      * @return moodle_text_filter The filter, or null, if this type of filter is
144      *      not recognised or could not be created.
145      */
146     protected function make_filter_object($filtername, $context, $localconfig) {
147         global $CFG;
148         $path = $CFG->dirroot .'/filter/'. $filtername .'/filter.php';
149         if (!is_readable($path)) {
150             return null;
151         }
152         include_once($path);
154         $filterclassname = 'filter_' . $filtername;
155         if (class_exists($filterclassname)) {
156             return new $filterclassname($context, $localconfig);
157         }
159         return null;
160     }
162     /**
163      * Apply a list of filters to some content.
164      * @param string $text
165      * @param moodle_text_filter[] $filterchain array filter name => filter object.
166      * @param array $options options passed to the filters.
167      * @param array $skipfilters of filter names. Any filters that should not be applied to this text.
168      * @return string $text
169      */
170     protected function apply_filter_chain($text, $filterchain, array $options = array(),
171             array $skipfilters = null) {
172         foreach ($filterchain as $filtername => $filter) {
173             if ($skipfilters !== null && in_array($filtername, $skipfilters)) {
174                 continue;
175             }
176             $text = $filter->filter($text, $options);
177         }
178         return $text;
179     }
181     /**
182      * Get all the filters that apply to a given context for calls to format_text.
183      *
184      * @param context $context
185      * @return moodle_text_filter[] A text filter
186      */
187     protected function get_text_filters($context) {
188         if (!isset($this->textfilters[$context->id])) {
189             $this->load_filters($context);
190         }
191         return $this->textfilters[$context->id];
192     }
194     /**
195      * Get all the filters that apply to a given context for calls to format_string.
196      *
197      * @param context $context the context.
198      * @return moodle_text_filter[] A text filter
199      */
200     protected function get_string_filters($context) {
201         if (!isset($this->stringfilters[$context->id])) {
202             $this->load_filters($context);
203         }
204         return $this->stringfilters[$context->id];
205     }
207     /**
208      * Filter some text
209      *
210      * @param string $text The text to filter
211      * @param context $context the context.
212      * @param array $options options passed to the filters
213      * @param array $skipfilters of filter names. Any filters that should not be applied to this text.
214      * @return string resulting text
215      */
216     public function filter_text($text, $context, array $options = array(),
217             array $skipfilters = null) {
218         $text = $this->apply_filter_chain($text, $this->get_text_filters($context), $options, $skipfilters);
219         // <nolink> tags removed for XHTML compatibility
220         $text = str_replace(array('<nolink>', '</nolink>'), '', $text);
221         return $text;
222     }
224     /**
225      * Filter a piece of string
226      *
227      * @param string $string The text to filter
228      * @param context $context the context.
229      * @return string resulting string
230      */
231     public function filter_string($string, $context) {
232         return $this->apply_filter_chain($string, $this->get_string_filters($context));
233     }
235     /**
236      * @deprecated Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.
237      * @todo MDL-50632 This will be deleted in Moodle 3.2.
238      * @param context $context the context.
239      * @return string the hash.
240      */
241     public function text_filtering_hash($context) {
242         debugging('filter_manager::text_filtering_hash() is deprecated. ' .
243                 'It was an internal part of the old format_text caching, ' .
244                 'and should not have been called from other code.', DEBUG_DEVELOPER);
245         $filters = $this->get_text_filters($context);
246         $hashes = array();
247         foreach ($filters as $filter) {
248             $hashes[] = $filter->hash();
249         }
250         return implode('-', $hashes);
251     }
253     /**
254      * Setup page with filters requirements and other prepare stuff.
255      *
256      * This method is used by {@see format_text()} and {@see format_string()}
257      * in order to allow filters to setup any page requirement (js, css...)
258      * or perform any action needed to get them prepared before filtering itself
259      * happens by calling to each every active setup() method.
260      *
261      * Note it's executed for each piece of text filtered, so filter implementations
262      * are responsible of controlling the cardinality of the executions that may
263      * be different depending of the stuff to prepare.
264      *
265      * @param moodle_page $page the page we are going to add requirements to.
266      * @param context $context the context which contents are going to be filtered.
267      * @since Moodle 2.3
268      */
269     public function setup_page_for_filters($page, $context) {
270         $filters = $this->get_text_filters($context);
271         foreach ($filters as $filter) {
272             $filter->setup($page, $context);
273         }
274     }
276     /**
277      * Setup the page for globally available filters.
278      *
279      * This helps setting up the page for filters which may be applied to
280      * the page, even if they do not belong to the current context, or are
281      * not yet visible because the content is lazily added (ajax). This method
282      * always uses to the system context which determines the globally
283      * available filters.
284      *
285      * This should only ever be called once per request.
286      *
287      * @param moodle_page $page The page.
288      * @since Moodle 3.2
289      */
290     public function setup_page_for_globally_available_filters($page) {
291         $context = context_system::instance();
292         $filterdata = filter_get_globally_enabled_filters_with_config();
293         foreach ($filterdata as $name => $config) {
294             if (isset($this->textfilters[$context->id][$name])) {
295                 $filter = $this->textfilters[$context->id][$name];
296             } else {
297                 $filter = $this->make_filter_object($name, $context, $config);
298                 if (is_null($filter)) {
299                     continue;
300                 }
301             }
302             $filter->setup($page, $context);
303         }
304     }
308 /**
309  * Filter manager subclass that does nothing. Having this simplifies the logic
310  * of format_text, etc.
311  *
312  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
313  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
314  */
315 class null_filter_manager {
316     public function filter_text($text, $context, array $options = array(),
317             array $skipfilters = null) {
318         return $text;
319     }
321     public function filter_string($string, $context) {
322         return $string;
323     }
325     public function text_filtering_hash() {
326         debugging('filter_manager::text_filtering_hash() is deprecated. ' .
327                 'It was an internal part of the old format_text caching, ' .
328                 'and should not have been called from other code.', DEBUG_DEVELOPER);
329         return '';
330     }
334 /**
335  * Filter manager subclass that tracks how much work it does.
336  *
337  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
338  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
339  */
340 class performance_measuring_filter_manager extends filter_manager {
341     /** @var int number of filter objects created. */
342     protected $filterscreated = 0;
344     /** @var int number of calls to filter_text. */
345     protected $textsfiltered = 0;
347     /** @var int number of calls to filter_string. */
348     protected $stringsfiltered = 0;
350     protected function unload_all_filters() {
351         parent::unload_all_filters();
352         $this->filterscreated = 0;
353         $this->textsfiltered = 0;
354         $this->stringsfiltered = 0;
355     }
357     protected function make_filter_object($filtername, $context, $localconfig) {
358         $this->filterscreated++;
359         return parent::make_filter_object($filtername, $context, $localconfig);
360     }
362     public function filter_text($text, $context, array $options = array(),
363             array $skipfilters = null) {
364         $this->textsfiltered++;
365         return parent::filter_text($text, $context, $options, $skipfilters);
366     }
368     public function filter_string($string, $context) {
369         $this->stringsfiltered++;
370         return parent::filter_string($string, $context);
371     }
373     /**
374      * Return performance information, in the form required by {@link get_performance_info()}.
375      * @return array the performance info.
376      */
377     public function get_performance_summary() {
378         return array(array(
379             'contextswithfilters' => count($this->textfilters),
380             'filterscreated' => $this->filterscreated,
381             'textsfiltered' => $this->textsfiltered,
382             'stringsfiltered' => $this->stringsfiltered,
383         ), array(
384             'contextswithfilters' => 'Contexts for which filters were loaded',
385             'filterscreated' => 'Filters created',
386             'textsfiltered' => 'Pieces of content filtered',
387             'stringsfiltered' => 'Strings filtered',
388         ));
389     }
393 /**
394  * Base class for text filters. You just need to override this class and
395  * implement the filter method.
396  *
397  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
398  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
399  */
400 abstract class moodle_text_filter {
401     /** @var context The context we are in. */
402     protected $context;
404     /** @var array Any local configuration for this filter in this context. */
405     protected $localconfig;
407     /**
408      * Set any context-specific configuration for this filter.
409      *
410      * @param context $context The current context.
411      * @param array $localconfig Any context-specific configuration for this filter.
412      */
413     public function __construct($context, array $localconfig) {
414         $this->context = $context;
415         $this->localconfig = $localconfig;
416     }
418     /**
419      * @deprecated Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.
420      * @todo MDL-50632 This will be deleted in Moodle 3.2.
421      * @return string The class name of the current class
422      */
423     public function hash() {
424         debugging('moodle_text_filter::hash() is deprecated. ' .
425                 'It was an internal part of the old format_text caching, ' .
426                 'and should not have been called from other code.', DEBUG_DEVELOPER);
427         return __CLASS__;
428     }
430     /**
431      * Setup page with filter requirements and other prepare stuff.
432      *
433      * Override this method if the filter needs to setup page
434      * requirements or needs other stuff to be executed.
435      *
436      * Note this method is invoked from {@see setup_page_for_filters()}
437      * for each piece of text being filtered, so it is responsible
438      * for controlling its own execution cardinality.
439      *
440      * @param moodle_page $page the page we are going to add requirements to.
441      * @param context $context the context which contents are going to be filtered.
442      * @since Moodle 2.3
443      */
444     public function setup($page, $context) {
445         // Override me, if needed.
446     }
448     /**
449      * Override this function to actually implement the filtering.
450      *
451      * @param $text some HTML content.
452      * @param array $options options passed to the filters
453      * @return the HTML content after the filtering has been applied.
454      */
455     public abstract function filter($text, array $options = array());
459 /**
460  * This is just a little object to define a phrase and some instructions
461  * for how to process it.  Filters can create an array of these to pass
462  * to the filter_phrases function below.
463  *
464  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
465  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
466  **/
467 class filterobject {
468     /** @var string */
469     var $phrase;
470     var $hreftagbegin;
471     var $hreftagend;
472     /** @var bool */
473     var $casesensitive;
474     var $fullmatch;
475     /** @var mixed */
476     var $replacementphrase;
477     var $work_phrase;
478     var $work_hreftagbegin;
479     var $work_hreftagend;
480     var $work_casesensitive;
481     var $work_fullmatch;
482     var $work_replacementphrase;
483     /** @var bool */
484     var $work_calculated;
486     /**
487      * A constructor just because I like constructing
488      *
489      * @param string $phrase
490      * @param string $hreftagbegin
491      * @param string $hreftagend
492      * @param bool $casesensitive
493      * @param bool $fullmatch
494      * @param mixed $replacementphrase
495      */
496     public function __construct($phrase, $hreftagbegin = '<span class="highlight">',
497                                    $hreftagend = '</span>',
498                                    $casesensitive = false,
499                                    $fullmatch = false,
500                                    $replacementphrase = NULL) {
502         $this->phrase           = $phrase;
503         $this->hreftagbegin     = $hreftagbegin;
504         $this->hreftagend       = $hreftagend;
505         $this->casesensitive    = $casesensitive;
506         $this->fullmatch        = $fullmatch;
507         $this->replacementphrase= $replacementphrase;
508         $this->work_calculated  = false;
510     }
513 /**
514  * Look up the name of this filter
515  *
516  * @param string $filter the filter name
517  * @return string the human-readable name for this filter.
518  */
519 function filter_get_name($filter) {
520     if (strpos($filter, 'filter/') === 0) {
521         debugging("Old '$filter'' parameter used in filter_get_name()");
522         $filter = substr($filter, 7);
523     } else if (strpos($filter, '/') !== false) {
524         throw new coding_exception('Unknown filter type ' . $filter);
525     }
527     if (get_string_manager()->string_exists('filtername', 'filter_' . $filter)) {
528         return get_string('filtername', 'filter_' . $filter);
529     } else {
530         return $filter;
531     }
534 /**
535  * Get the names of all the filters installed in this Moodle.
536  *
537  * @return array path => filter name from the appropriate lang file. e.g.
538  * array('tex' => 'TeX Notation');
539  * sorted in alphabetical order of name.
540  */
541 function filter_get_all_installed() {
542     global $CFG;
544     $filternames = array();
545     foreach (core_component::get_plugin_list('filter') as $filter => $fulldir) {
546         if (is_readable("$fulldir/filter.php")) {
547             $filternames[$filter] = filter_get_name($filter);
548         }
549     }
550     core_collator::asort($filternames);
551     return $filternames;
554 /**
555  * Set the global activated state for a text filter.
556  *
557  * @param string $filtername The filter name, for example 'tex'.
558  * @param int $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.
559  * @param int $move -1 means up, 0 means the same, 1 means down
560  */
561 function filter_set_global_state($filtername, $state, $move = 0) {
562     global $DB;
564     // Check requested state is valid.
565     if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_DISABLED))) {
566         throw new coding_exception("Illegal option '$state' passed to filter_set_global_state. " .
567                 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.");
568     }
570     if ($move > 0) {
571         $move = 1;
572     } else if ($move < 0) {
573         $move = -1;
574     }
576     if (strpos($filtername, 'filter/') === 0) {
577         //debugging("Old filtername '$filtername' parameter used in filter_set_global_state()", DEBUG_DEVELOPER);
578         $filtername = substr($filtername, 7);
579     } else if (strpos($filtername, '/') !== false) {
580         throw new coding_exception("Invalid filter name '$filtername' used in filter_set_global_state()");
581     }
583     $transaction = $DB->start_delegated_transaction();
585     $syscontext = context_system::instance();
586     $filters = $DB->get_records('filter_active', array('contextid' => $syscontext->id), 'sortorder ASC');
588     $on = array();
589     $off = array();
591     foreach($filters as $f) {
592         if ($f->active == TEXTFILTER_DISABLED) {
593             $off[$f->filter] = $f;
594         } else {
595             $on[$f->filter] = $f;
596         }
597     }
599     // Update the state or add new record.
600     if (isset($on[$filtername])) {
601         $filter = $on[$filtername];
602         if ($filter->active != $state) {
603             add_to_config_log('filter_active', $filter->active, $state, $filtername);
605             $filter->active = $state;
606             $DB->update_record('filter_active', $filter);
607             if ($filter->active == TEXTFILTER_DISABLED) {
608                 unset($on[$filtername]);
609                 $off = array($filter->filter => $filter) + $off;
610             }
612         }
614     } else if (isset($off[$filtername])) {
615         $filter = $off[$filtername];
616         if ($filter->active != $state) {
617             add_to_config_log('filter_active', $filter->active, $state, $filtername);
619             $filter->active = $state;
620             $DB->update_record('filter_active', $filter);
621             if ($filter->active != TEXTFILTER_DISABLED) {
622                 unset($off[$filtername]);
623                 $on[$filter->filter] = $filter;
624             }
625         }
627     } else {
628         add_to_config_log('filter_active', '', $state, $filtername);
630         $filter = new stdClass();
631         $filter->filter    = $filtername;
632         $filter->contextid = $syscontext->id;
633         $filter->active    = $state;
634         $filter->sortorder = 99999;
635         $filter->id = $DB->insert_record('filter_active', $filter);
637         $filters[$filter->id] = $filter;
638         if ($state == TEXTFILTER_DISABLED) {
639             $off[$filter->filter] = $filter;
640         } else {
641             $on[$filter->filter] = $filter;
642         }
643     }
645     // Move only active.
646     if ($move != 0 and isset($on[$filter->filter])) {
647         $i = 1;
648         foreach ($on as $f) {
649             $f->newsortorder = $i;
650             $i++;
651         }
653         $filter->newsortorder = $filter->newsortorder + $move;
655         foreach ($on as $f) {
656             if ($f->id == $filter->id) {
657                 continue;
658             }
659             if ($f->newsortorder == $filter->newsortorder) {
660                 if ($move == 1) {
661                     $f->newsortorder = $f->newsortorder - 1;
662                 } else {
663                     $f->newsortorder = $f->newsortorder + 1;
664                 }
665             }
666         }
668         core_collator::asort_objects_by_property($on, 'newsortorder', core_collator::SORT_NUMERIC);
669     }
671     // Inactive are sorted by filter name.
672     core_collator::asort_objects_by_property($off, 'filter', core_collator::SORT_NATURAL);
674     // Update records if necessary.
675     $i = 1;
676     foreach ($on as $f) {
677         if ($f->sortorder != $i) {
678             $DB->set_field('filter_active', 'sortorder', $i, array('id'=>$f->id));
679         }
680         $i++;
681     }
682     foreach ($off as $f) {
683         if ($f->sortorder != $i) {
684             $DB->set_field('filter_active', 'sortorder', $i, array('id'=>$f->id));
685         }
686         $i++;
687     }
689     $transaction->allow_commit();
692 /**
693  * @param string $filtername The filter name, for example 'tex'.
694  * @return boolean is this filter allowed to be used on this site. That is, the
695  *      admin has set the global 'active' setting to On, or Off, but available.
696  */
697 function filter_is_enabled($filtername) {
698     if (strpos($filtername, 'filter/') === 0) {
699         //debugging("Old filtername '$filtername' parameter used in filter_is_enabled()", DEBUG_DEVELOPER);
700         $filtername = substr($filtername, 7);
701     } else if (strpos($filtername, '/') !== false) {
702         throw new coding_exception("Invalid filter name '$filtername' used in filter_is_enabled()");
703     }
704     return array_key_exists($filtername, filter_get_globally_enabled());
707 /**
708  * Return a list of all the filters that may be in use somewhere.
709  *
710  * @staticvar array $enabledfilters
711  * @return array where the keys and values are both the filter name, like 'tex'.
712  */
713 function filter_get_globally_enabled() {
714     static $enabledfilters = null;
715     if (is_null($enabledfilters)) {
716         $filters = filter_get_global_states();
717         $enabledfilters = array();
718         foreach ($filters as $filter => $filerinfo) {
719             if ($filerinfo->active != TEXTFILTER_DISABLED) {
720                 $enabledfilters[$filter] = $filter;
721             }
722         }
723     }
724     return $enabledfilters;
727 /**
728  * Get the globally enabled filters.
729  *
730  * This returns the filters which could be used in any context. Essentially
731  * the filters which are not disabled for the entire site.
732  *
733  * @return array Keys are filter names, and values the config.
734  */
735 function filter_get_globally_enabled_filters_with_config() {
736     global $DB;
738     $sql = "SELECT f.filter, fc.name, fc.value
739               FROM {filter_active} f
740          LEFT JOIN {filter_config} fc
741                 ON fc.filter = f.filter
742                AND fc.contextid = f.contextid
743              WHERE f.contextid = :contextid
744                AND f.active != :disabled
745           ORDER BY f.sortorder";
747     $rs = $DB->get_recordset_sql($sql, [
748         'contextid' => context_system::instance()->id,
749         'disabled' => TEXTFILTER_DISABLED
750     ]);
752     // Massage the data into the specified format to return.
753     $filters = array();
754     foreach ($rs as $row) {
755         if (!isset($filters[$row->filter])) {
756             $filters[$row->filter] = array();
757         }
758         if ($row->name !== null) {
759             $filters[$row->filter][$row->name] = $row->value;
760         }
761     }
762     $rs->close();
764     return $filters;
767 /**
768  * Return the names of the filters that should also be applied to strings
769  * (when they are enabled).
770  *
771  * @return array where the keys and values are both the filter name, like 'tex'.
772  */
773 function filter_get_string_filters() {
774     global $CFG;
775     $stringfilters = array();
776     if (!empty($CFG->filterall) && !empty($CFG->stringfilters)) {
777         $stringfilters = explode(',', $CFG->stringfilters);
778         $stringfilters = array_combine($stringfilters, $stringfilters);
779     }
780     return $stringfilters;
783 /**
784  * Sets whether a particular active filter should be applied to all strings by
785  * format_string, or just used by format_text.
786  *
787  * @param string $filter The filter name, for example 'tex'.
788  * @param boolean $applytostrings if true, this filter will apply to format_string
789  *      and format_text, when it is enabled.
790  */
791 function filter_set_applies_to_strings($filter, $applytostrings) {
792     $stringfilters = filter_get_string_filters();
793     $prevfilters = $stringfilters;
794     $allfilters = core_component::get_plugin_list('filter');
796     if ($applytostrings) {
797         $stringfilters[$filter] = $filter;
798     } else {
799         unset($stringfilters[$filter]);
800     }
802     // Remove missing filters.
803     foreach ($stringfilters as $filter) {
804         if (!isset($allfilters[$filter])) {
805             unset($stringfilters[$filter]);
806         }
807     }
809     if ($prevfilters != $stringfilters) {
810         set_config('stringfilters', implode(',', $stringfilters));
811         set_config('filterall', !empty($stringfilters));
812     }
815 /**
816  * Set the local activated state for a text filter.
817  *
818  * @param string $filter The filter name, for example 'tex'.
819  * @param integer $contextid The id of the context to get the local config for.
820  * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT.
821  * @return void
822  */
823 function filter_set_local_state($filter, $contextid, $state) {
824     global $DB;
826     // Check requested state is valid.
827     if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_INHERIT))) {
828         throw new coding_exception("Illegal option '$state' passed to filter_set_local_state. " .
829                 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT.");
830     }
832     if ($contextid == context_system::instance()->id) {
833         throw new coding_exception('You cannot use filter_set_local_state ' .
834                 'with $contextid equal to the system context id.');
835     }
837     if ($state == TEXTFILTER_INHERIT) {
838         $DB->delete_records('filter_active', array('filter' => $filter, 'contextid' => $contextid));
839         return;
840     }
842     $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $contextid));
843     $insert = false;
844     if (empty($rec)) {
845         $insert = true;
846         $rec = new stdClass;
847         $rec->filter = $filter;
848         $rec->contextid = $contextid;
849     }
851     $rec->active = $state;
853     if ($insert) {
854         $DB->insert_record('filter_active', $rec);
855     } else {
856         $DB->update_record('filter_active', $rec);
857     }
860 /**
861  * Set a particular local config variable for a filter in a context.
862  *
863  * @param string $filter The filter name, for example 'tex'.
864  * @param integer $contextid The id of the context to get the local config for.
865  * @param string $name the setting name.
866  * @param string $value the corresponding value.
867  */
868 function filter_set_local_config($filter, $contextid, $name, $value) {
869     global $DB;
870     $rec = $DB->get_record('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name));
871     $insert = false;
872     if (empty($rec)) {
873         $insert = true;
874         $rec = new stdClass;
875         $rec->filter = $filter;
876         $rec->contextid = $contextid;
877         $rec->name = $name;
878     }
880     $rec->value = $value;
882     if ($insert) {
883         $DB->insert_record('filter_config', $rec);
884     } else {
885         $DB->update_record('filter_config', $rec);
886     }
889 /**
890  * Remove a particular local config variable for a filter in a context.
891  *
892  * @param string $filter The filter name, for example 'tex'.
893  * @param integer $contextid The id of the context to get the local config for.
894  * @param string $name the setting name.
895  */
896 function filter_unset_local_config($filter, $contextid, $name) {
897     global $DB;
898     $DB->delete_records('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name));
901 /**
902  * Get local config variables for a filter in a context. Normally (when your
903  * filter is running) you don't need to call this, becuase the config is fetched
904  * for you automatically. You only need this, for example, when you are getting
905  * the config so you can show the user an editing from.
906  *
907  * @param string $filter The filter name, for example 'tex'.
908  * @param integer $contextid The ID of the context to get the local config for.
909  * @return array of name => value pairs.
910  */
911 function filter_get_local_config($filter, $contextid) {
912     global $DB;
913     return $DB->get_records_menu('filter_config', array('filter' => $filter, 'contextid' => $contextid), '', 'name,value');
916 /**
917  * This function is for use by backup. Gets all the filter information specific
918  * to one context.
919  *
920  * @param int $contextid
921  * @return array Array with two elements. The first element is an array of objects with
922  *      fields filter and active. These come from the filter_active table. The
923  *      second element is an array of objects with fields filter, name and value
924  *      from the filter_config table.
925  */
926 function filter_get_all_local_settings($contextid) {
927     global $DB;
928     return array(
929         $DB->get_records('filter_active', array('contextid' => $contextid), 'filter', 'filter,active'),
930         $DB->get_records('filter_config', array('contextid' => $contextid), 'filter,name', 'filter,name,value'),
931     );
934 /**
935  * Get the list of active filters, in the order that they should be used
936  * for a particular context, along with any local configuration variables.
937  *
938  * @param context $context a context
939  * @return array an array where the keys are the filter names, for example
940  *      'tex' and the values are any local
941  *      configuration for that filter, as an array of name => value pairs
942  *      from the filter_config table. In a lot of cases, this will be an
943  *      empty array. So, an example return value for this function might be
944  *      array(tex' => array())
945  */
946 function filter_get_active_in_context($context) {
947     global $DB, $FILTERLIB_PRIVATE;
949     if (!isset($FILTERLIB_PRIVATE)) {
950         $FILTERLIB_PRIVATE = new stdClass();
951     }
953     // Use cache (this is a within-request cache only) if available. See
954     // function filter_preload_activities.
955     if (isset($FILTERLIB_PRIVATE->active) &&
956             array_key_exists($context->id, $FILTERLIB_PRIVATE->active)) {
957         return $FILTERLIB_PRIVATE->active[$context->id];
958     }
960     $contextids = str_replace('/', ',', trim($context->path, '/'));
962     // The following SQL is tricky. It is explained on
963     // http://docs.moodle.org/dev/Filter_enable/disable_by_context
964     $sql = "SELECT active.filter, fc.name, fc.value
965          FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder
966              FROM {filter_active} f
967              JOIN {context} ctx ON f.contextid = ctx.id
968              WHERE ctx.id IN ($contextids)
969              GROUP BY filter
970              HAVING MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth)
971          ) active
972          LEFT JOIN {filter_config} fc ON fc.filter = active.filter AND fc.contextid = $context->id
973          ORDER BY active.sortorder";
974     $rs = $DB->get_recordset_sql($sql);
976     // Massage the data into the specified format to return.
977     $filters = array();
978     foreach ($rs as $row) {
979         if (!isset($filters[$row->filter])) {
980             $filters[$row->filter] = array();
981         }
982         if (!is_null($row->name)) {
983             $filters[$row->filter][$row->name] = $row->value;
984         }
985     }
987     $rs->close();
989     return $filters;
992 /**
993  * Preloads the list of active filters for all activities (modules) on the course
994  * using two database queries.
995  *
996  * @param course_modinfo $modinfo Course object from get_fast_modinfo
997  */
998 function filter_preload_activities(course_modinfo $modinfo) {
999     global $DB, $FILTERLIB_PRIVATE;
1001     if (!isset($FILTERLIB_PRIVATE)) {
1002         $FILTERLIB_PRIVATE = new stdClass();
1003     }
1005     // Don't repeat preload
1006     if (!isset($FILTERLIB_PRIVATE->preloaded)) {
1007         $FILTERLIB_PRIVATE->preloaded = array();
1008     }
1009     if (!empty($FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()])) {
1010         return;
1011     }
1012     $FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()] = true;
1014     // Get contexts for all CMs
1015     $cmcontexts = array();
1016     $cmcontextids = array();
1017     foreach ($modinfo->get_cms() as $cm) {
1018         $modulecontext = context_module::instance($cm->id);
1019         $cmcontextids[] = $modulecontext->id;
1020         $cmcontexts[] = $modulecontext;
1021     }
1023     // Get course context and all other parents...
1024     $coursecontext = context_course::instance($modinfo->get_course_id());
1025     $parentcontextids = explode('/', substr($coursecontext->path, 1));
1026     $allcontextids = array_merge($cmcontextids, $parentcontextids);
1028     // Get all filter_active rows relating to all these contexts
1029     list ($sql, $params) = $DB->get_in_or_equal($allcontextids);
1030     $filteractives = $DB->get_records_select('filter_active', "contextid $sql", $params, 'sortorder');
1032     // Get all filter_config only for the cm contexts
1033     list ($sql, $params) = $DB->get_in_or_equal($cmcontextids);
1034     $filterconfigs = $DB->get_records_select('filter_config', "contextid $sql", $params);
1036     // Note: I was a bit surprised that filter_config only works for the
1037     // most specific context (i.e. it does not need to be checked for course
1038     // context if we only care about CMs) however basede on code in
1039     // filter_get_active_in_context, this does seem to be correct.
1041     // Build course default active list. Initially this will be an array of
1042     // filter name => active score (where an active score >0 means it's active)
1043     $courseactive = array();
1045     // Also build list of filter_active rows below course level, by contextid
1046     $remainingactives = array();
1048     // Array lists filters that are banned at top level
1049     $banned = array();
1051     // Add any active filters in parent contexts to the array
1052     foreach ($filteractives as $row) {
1053         $depth = array_search($row->contextid, $parentcontextids);
1054         if ($depth !== false) {
1055             // Find entry
1056             if (!array_key_exists($row->filter, $courseactive)) {
1057                 $courseactive[$row->filter] = 0;
1058             }
1059             // This maths copes with reading rows in any order. Turning on/off
1060             // at site level counts 1, at next level down 4, at next level 9,
1061             // then 16, etc. This means the deepest level always wins, except
1062             // against the -9999 at top level.
1063             $courseactive[$row->filter] +=
1064                 ($depth + 1) * ($depth + 1) * $row->active;
1066             if ($row->active == TEXTFILTER_DISABLED) {
1067                 $banned[$row->filter] = true;
1068             }
1069         } else {
1070             // Build list of other rows indexed by contextid
1071             if (!array_key_exists($row->contextid, $remainingactives)) {
1072                 $remainingactives[$row->contextid] = array();
1073             }
1074             $remainingactives[$row->contextid][] = $row;
1075         }
1076     }
1078     // Chuck away the ones that aren't active.
1079     foreach ($courseactive as $filter=>$score) {
1080         if ($score <= 0) {
1081             unset($courseactive[$filter]);
1082         } else {
1083             $courseactive[$filter] = array();
1084         }
1085     }
1087     // Loop through the contexts to reconstruct filter_active lists for each
1088     // cm on the course.
1089     if (!isset($FILTERLIB_PRIVATE->active)) {
1090         $FILTERLIB_PRIVATE->active = array();
1091     }
1092     foreach ($cmcontextids as $contextid) {
1093         // Copy course list
1094         $FILTERLIB_PRIVATE->active[$contextid] = $courseactive;
1096         // Are there any changes to the active list?
1097         if (array_key_exists($contextid, $remainingactives)) {
1098             foreach ($remainingactives[$contextid] as $row) {
1099                 if ($row->active > 0 && empty($banned[$row->filter])) {
1100                     // If it's marked active for specific context, add entry
1101                     // (doesn't matter if one exists already).
1102                     $FILTERLIB_PRIVATE->active[$contextid][$row->filter] = array();
1103                 } else {
1104                     // If it's marked inactive, remove entry (doesn't matter
1105                     // if it doesn't exist).
1106                     unset($FILTERLIB_PRIVATE->active[$contextid][$row->filter]);
1107                 }
1108             }
1109         }
1110     }
1112     // Process all config rows to add config data to these entries.
1113     foreach ($filterconfigs as $row) {
1114         if (isset($FILTERLIB_PRIVATE->active[$row->contextid][$row->filter])) {
1115             $FILTERLIB_PRIVATE->active[$row->contextid][$row->filter][$row->name] = $row->value;
1116         }
1117     }
1120 /**
1121  * List all of the filters that are available in this context, and what the
1122  * local and inherited states of that filter are.
1123  *
1124  * @param context $context a context that is not the system context.
1125  * @return array an array with filter names, for example 'tex'
1126  *      as keys. and and the values are objects with fields:
1127  *      ->filter filter name, same as the key.
1128  *      ->localstate TEXTFILTER_ON/OFF/INHERIT
1129  *      ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT.
1130  */
1131 function filter_get_available_in_context($context) {
1132     global $DB;
1134     // The complex logic is working out the active state in the parent context,
1135     // so strip the current context from the list.
1136     $contextids = explode('/', trim($context->path, '/'));
1137     array_pop($contextids);
1138     $contextids = implode(',', $contextids);
1139     if (empty($contextids)) {
1140         throw new coding_exception('filter_get_available_in_context cannot be called with the system context.');
1141     }
1143     // The following SQL is tricky, in the same way at the SQL in filter_get_active_in_context.
1144     $sql = "SELECT parent_states.filter,
1145                 CASE WHEN fa.active IS NULL THEN " . TEXTFILTER_INHERIT . "
1146                 ELSE fa.active END AS localstate,
1147              parent_states.inheritedstate
1148          FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder,
1149                     CASE WHEN MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth) THEN " . TEXTFILTER_ON . "
1150                     ELSE " . TEXTFILTER_OFF . " END AS inheritedstate
1151              FROM {filter_active} f
1152              JOIN {context} ctx ON f.contextid = ctx.id
1153              WHERE ctx.id IN ($contextids)
1154              GROUP BY f.filter
1155              HAVING MIN(f.active) > " . TEXTFILTER_DISABLED . "
1156          ) parent_states
1157          LEFT JOIN {filter_active} fa ON fa.filter = parent_states.filter AND fa.contextid = $context->id
1158          ORDER BY parent_states.sortorder";
1159     return $DB->get_records_sql($sql);
1162 /**
1163  * This function is for use by the filter administration page.
1164  *
1165  * @return array 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder'
1166  */
1167 function filter_get_global_states() {
1168     global $DB;
1169     $context = context_system::instance();
1170     return $DB->get_records('filter_active', array('contextid' => $context->id), 'sortorder', 'filter,active,sortorder');
1173 /**
1174  * Delete all the data in the database relating to a filter, prior to deleting it.
1175  *
1176  * @param string $filter The filter name, for example 'tex'.
1177  */
1178 function filter_delete_all_for_filter($filter) {
1179     global $DB;
1181     unset_all_config_for_plugin('filter_' . $filter);
1182     $DB->delete_records('filter_active', array('filter' => $filter));
1183     $DB->delete_records('filter_config', array('filter' => $filter));
1186 /**
1187  * Delete all the data in the database relating to a context, used when contexts are deleted.
1188  *
1189  * @param integer $contextid The id of the context being deleted.
1190  */
1191 function filter_delete_all_for_context($contextid) {
1192     global $DB;
1193     $DB->delete_records('filter_active', array('contextid' => $contextid));
1194     $DB->delete_records('filter_config', array('contextid' => $contextid));
1197 /**
1198  * Does this filter have a global settings page in the admin tree?
1199  * (The settings page for a filter must be called, for example, filtersettingfiltertex.)
1200  *
1201  * @param string $filter The filter name, for example 'tex'.
1202  * @return boolean Whether there should be a 'Settings' link on the config page.
1203  */
1204 function filter_has_global_settings($filter) {
1205     global $CFG;
1206     $settingspath = $CFG->dirroot . '/filter/' . $filter . '/settings.php';
1207     if (is_readable($settingspath)) {
1208         return true;
1209     }
1210     $settingspath = $CFG->dirroot . '/filter/' . $filter . '/filtersettings.php';
1211     return is_readable($settingspath);
1214 /**
1215  * Does this filter have local (per-context) settings?
1216  *
1217  * @param string $filter The filter name, for example 'tex'.
1218  * @return boolean Whether there should be a 'Settings' link on the manage filters in context page.
1219  */
1220 function filter_has_local_settings($filter) {
1221     global $CFG;
1222     $settingspath = $CFG->dirroot . '/filter/' . $filter . '/filterlocalsettings.php';
1223     return is_readable($settingspath);
1226 /**
1227  * Certain types of context (block and user) may not have local filter settings.
1228  * the function checks a context to see whether it may have local config.
1229  *
1230  * @param object $context a context.
1231  * @return boolean whether this context may have local filter settings.
1232  */
1233 function filter_context_may_have_filter_settings($context) {
1234     return $context->contextlevel != CONTEXT_BLOCK && $context->contextlevel != CONTEXT_USER;
1237 /**
1238  * Process phrases intelligently found within a HTML text (such as adding links).
1239  *
1240  * @staticvar array $usedpharses
1241  * @param string $text             the text that we are filtering
1242  * @param array $link_array       an array of filterobjects
1243  * @param array $ignoretagsopen   an array of opening tags that we should ignore while filtering
1244  * @param array $ignoretagsclose  an array of corresponding closing tags
1245  * @param bool $overridedefaultignore True to only use tags provided by arguments
1246  * @return string
1247  **/
1248 function filter_phrases($text, &$link_array, $ignoretagsopen=NULL, $ignoretagsclose=NULL,
1249         $overridedefaultignore=false) {
1251     global $CFG;
1253     static $usedphrases;
1255     $ignoretags = array();  // To store all the enclosig tags to be completely ignored.
1256     $tags = array();        // To store all the simple tags to be ignored.
1258     if (!$overridedefaultignore) {
1259         // A list of open/close tags that we should not replace within
1260         // Extended to include <script>, <textarea>, <select> and <a> tags
1261         // Regular expression allows tags with or without attributes
1262         $filterignoretagsopen  = array('<head>' , '<nolink>' , '<span class="nolink">',
1263                 '<script(\s[^>]*?)?>', '<textarea(\s[^>]*?)?>',
1264                 '<select(\s[^>]*?)?>', '<a(\s[^>]*?)?>');
1265         $filterignoretagsclose = array('</head>', '</nolink>', '</span>',
1266                  '</script>', '</textarea>', '</select>','</a>');
1267     } else {
1268         // Set an empty default list.
1269         $filterignoretagsopen = array();
1270         $filterignoretagsclose = array();
1271     }
1273     // Add the user defined ignore tags to the default list.
1274     if ( is_array($ignoretagsopen) ) {
1275         foreach ($ignoretagsopen as $open) {
1276             $filterignoretagsopen[] = $open;
1277         }
1278         foreach ($ignoretagsclose as $close) {
1279             $filterignoretagsclose[] = $close;
1280         }
1281     }
1283     // Invalid prefixes and suffixes for the fullmatch searches
1284     // Every "word" character, but the underscore, is a invalid suffix or prefix.
1285     // (nice to use this because it includes national characters (accents...) as word characters.
1286     $filterinvalidprefixes = '([^\W_])';
1287     $filterinvalidsuffixes = '([^\W_])';
1289     // Double up some magic chars to avoid "accidental matches"
1290     $text = preg_replace('/([#*%])/','\1\1',$text);
1293     //Remove everything enclosed by the ignore tags from $text
1294     filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1296     // Remove tags from $text
1297     filter_save_tags($text,$tags);
1299     // Time to cycle through each phrase to be linked
1300     $size = sizeof($link_array);
1301     for ($n=0; $n < $size; $n++) {
1302         $linkobject =& $link_array[$n];
1304         // Set some defaults if certain properties are missing
1305         // Properties may be missing if the filterobject class has not been used to construct the object
1306         if (empty($linkobject->phrase)) {
1307             continue;
1308         }
1310         // Avoid integers < 1000 to be linked. See bug 1446.
1311         $intcurrent = intval($linkobject->phrase);
1312         if (!empty($intcurrent) && strval($intcurrent) == $linkobject->phrase && $intcurrent < 1000) {
1313             continue;
1314         }
1316         // All this work has to be done ONLY it it hasn't been done before
1317          if (!$linkobject->work_calculated) {
1318             if (!isset($linkobject->hreftagbegin) or !isset($linkobject->hreftagend)) {
1319                 $linkobject->work_hreftagbegin = '<span class="highlight"';
1320                 $linkobject->work_hreftagend   = '</span>';
1321             } else {
1322                 $linkobject->work_hreftagbegin = $linkobject->hreftagbegin;
1323                 $linkobject->work_hreftagend   = $linkobject->hreftagend;
1324             }
1326             // Double up chars to protect true duplicates
1327             // be cleared up before returning to the user.
1328             $linkobject->work_hreftagbegin = preg_replace('/([#*%])/','\1\1',$linkobject->work_hreftagbegin);
1330             if (empty($linkobject->casesensitive)) {
1331                 $linkobject->work_casesensitive = false;
1332             } else {
1333                 $linkobject->work_casesensitive = true;
1334             }
1335             if (empty($linkobject->fullmatch)) {
1336                 $linkobject->work_fullmatch = false;
1337             } else {
1338                 $linkobject->work_fullmatch = true;
1339             }
1341             // Strip tags out of the phrase
1342             $linkobject->work_phrase = strip_tags($linkobject->phrase);
1344             // Double up chars that might cause a false match -- the duplicates will
1345             // be cleared up before returning to the user.
1346             $linkobject->work_phrase = preg_replace('/([#*%])/','\1\1',$linkobject->work_phrase);
1348             // Set the replacement phrase properly
1349             if ($linkobject->replacementphrase) {    //We have specified a replacement phrase
1350                 // Strip tags
1351                 $linkobject->work_replacementphrase = strip_tags($linkobject->replacementphrase);
1352             } else {                                 //The replacement is the original phrase as matched below
1353                 $linkobject->work_replacementphrase = '$1';
1354             }
1356             // Quote any regular expression characters and the delimiter in the work phrase to be searched
1357             $linkobject->work_phrase = preg_quote($linkobject->work_phrase, '/');
1359             // Work calculated
1360             $linkobject->work_calculated = true;
1362         }
1364         // If $CFG->filtermatchoneperpage, avoid previously (request) linked phrases
1365         if (!empty($CFG->filtermatchoneperpage)) {
1366             if (!empty($usedphrases) && in_array($linkobject->work_phrase,$usedphrases)) {
1367                 continue;
1368             }
1369         }
1371         // Regular expression modifiers
1372         $modifiers = ($linkobject->work_casesensitive) ? 's' : 'isu'; // works in unicode mode!
1374         // Do we need to do a fullmatch?
1375         // If yes then go through and remove any non full matching entries
1376         if ($linkobject->work_fullmatch) {
1377             $notfullmatches = array();
1378             $regexp = '/'.$filterinvalidprefixes.'('.$linkobject->work_phrase.')|('.$linkobject->work_phrase.')'.$filterinvalidsuffixes.'/'.$modifiers;
1380             preg_match_all($regexp,$text,$list_of_notfullmatches);
1382             if ($list_of_notfullmatches) {
1383                 foreach (array_unique($list_of_notfullmatches[0]) as $key=>$value) {
1384                     $notfullmatches['<*'.$key.'*>'] = $value;
1385                 }
1386                 if (!empty($notfullmatches)) {
1387                     $text = str_replace($notfullmatches,array_keys($notfullmatches),$text);
1388                 }
1389             }
1390         }
1392         // Finally we do our highlighting
1393         if (!empty($CFG->filtermatchonepertext) || !empty($CFG->filtermatchoneperpage)) {
1394             $resulttext = preg_replace('/('.$linkobject->work_phrase.')/'.$modifiers,
1395                                       $linkobject->work_hreftagbegin.
1396                                       $linkobject->work_replacementphrase.
1397                                       $linkobject->work_hreftagend, $text, 1);
1398         } else {
1399             $resulttext = preg_replace('/('.$linkobject->work_phrase.')/'.$modifiers,
1400                                       $linkobject->work_hreftagbegin.
1401                                       $linkobject->work_replacementphrase.
1402                                       $linkobject->work_hreftagend, $text);
1403         }
1406         // If the text has changed we have to look for links again
1407         if ($resulttext != $text) {
1408             // Set $text to $resulttext
1409             $text = $resulttext;
1410             // Remove everything enclosed by the ignore tags from $text
1411             filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1412             // Remove tags from $text
1413             filter_save_tags($text,$tags);
1414             // If $CFG->filtermatchoneperpage, save linked phrases to request
1415             if (!empty($CFG->filtermatchoneperpage)) {
1416                 $usedphrases[] = $linkobject->work_phrase;
1417             }
1418         }
1421         // Replace the not full matches before cycling to next link object
1422         if (!empty($notfullmatches)) {
1423             $text = str_replace(array_keys($notfullmatches),$notfullmatches,$text);
1424             unset($notfullmatches);
1425         }
1426     }
1428     // Rebuild the text with all the excluded areas
1430     if (!empty($tags)) {
1431         $text = str_replace(array_keys($tags), $tags, $text);
1432     }
1434     if (!empty($ignoretags)) {
1435         $ignoretags = array_reverse($ignoretags);     // Reversed so "progressive" str_replace() will solve some nesting problems.
1436         $text = str_replace(array_keys($ignoretags),$ignoretags,$text);
1437     }
1439     // Remove the protective doubleups
1440     $text =  preg_replace('/([#*%])(\1)/','\1',$text);
1442     // Add missing javascript for popus
1443     $text = filter_add_javascript($text);
1446     return $text;
1449 /**
1450  * @todo Document this function
1451  * @param array $linkarray
1452  * @return array
1453  */
1454 function filter_remove_duplicates($linkarray) {
1456     $concepts  = array(); // keep a record of concepts as we cycle through
1457     $lconcepts = array(); // a lower case version for case insensitive
1459     $cleanlinks = array();
1461     foreach ($linkarray as $key=>$filterobject) {
1462         if ($filterobject->casesensitive) {
1463             $exists = in_array($filterobject->phrase, $concepts);
1464         } else {
1465             $exists = in_array(core_text::strtolower($filterobject->phrase), $lconcepts);
1466         }
1468         if (!$exists) {
1469             $cleanlinks[] = $filterobject;
1470             $concepts[] = $filterobject->phrase;
1471             $lconcepts[] = core_text::strtolower($filterobject->phrase);
1472         }
1473     }
1475     return $cleanlinks;
1478 /**
1479  * Extract open/lose tags and their contents to avoid being processed by filters.
1480  * Useful to extract pieces of code like <a>...</a> tags. It returns the text
1481  * converted with some <#xTEXTFILTER_EXCL_SEPARATORx#> codes replacing the extracted text. Such extracted
1482  * texts are returned in the ignoretags array (as values), with codes as keys.
1483  *
1484  * @param string $text                  the text that we are filtering (in/out)
1485  * @param array $filterignoretagsopen  an array of open tags to start searching
1486  * @param array $filterignoretagsclose an array of close tags to end searching
1487  * @param array $ignoretags            an array of saved strings useful to rebuild the original text (in/out)
1488  **/
1489 function filter_save_ignore_tags(&$text, $filterignoretagsopen, $filterignoretagsclose, &$ignoretags) {
1491     // Remove everything enclosed by the ignore tags from $text
1492     foreach ($filterignoretagsopen as $ikey=>$opentag) {
1493         $closetag = $filterignoretagsclose[$ikey];
1494         // form regular expression
1495         $opentag  = str_replace('/','\/',$opentag); // delimit forward slashes
1496         $closetag = str_replace('/','\/',$closetag); // delimit forward slashes
1497         $pregexp = '/'.$opentag.'(.*?)'.$closetag.'/is';
1499         preg_match_all($pregexp, $text, $list_of_ignores);
1500         foreach (array_unique($list_of_ignores[0]) as $key=>$value) {
1501             $prefix = (string)(count($ignoretags) + 1);
1502             $ignoretags['<#'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$key.'#>'] = $value;
1503         }
1504         if (!empty($ignoretags)) {
1505             $text = str_replace($ignoretags,array_keys($ignoretags),$text);
1506         }
1507     }
1510 /**
1511  * Extract tags (any text enclosed by < and > to avoid being processed by filters.
1512  * It returns the text converted with some <%xTEXTFILTER_EXCL_SEPARATORx%> codes replacing the extracted text. Such extracted
1513  * texts are returned in the tags array (as values), with codes as keys.
1514  *
1515  * @param string $text   the text that we are filtering (in/out)
1516  * @param array $tags   an array of saved strings useful to rebuild the original text (in/out)
1517  **/
1518 function filter_save_tags(&$text, &$tags) {
1520     preg_match_all('/<([^#%*].*?)>/is',$text,$list_of_newtags);
1521     foreach (array_unique($list_of_newtags[0]) as $ntkey=>$value) {
1522         $prefix = (string)(count($tags) + 1);
1523         $tags['<%'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$ntkey.'%>'] = $value;
1524     }
1525     if (!empty($tags)) {
1526         $text = str_replace($tags,array_keys($tags),$text);
1527     }
1530 /**
1531  * Add missing openpopup javascript to HTML files.
1532  *
1533  * @param string $text
1534  * @return string
1535  */
1536 function filter_add_javascript($text) {
1537     global $CFG;
1539     if (stripos($text, '</html>') === FALSE) {
1540         return $text; // This is not a html file.
1541     }
1542     if (strpos($text, 'onclick="return openpopup') === FALSE) {
1543         return $text; // No popup - no need to add javascript.
1544     }
1545     $js ="
1546     <script type=\"text/javascript\">
1547     <!--
1548         function openpopup(url,name,options,fullscreen) {
1549           fullurl = \"".$CFG->httpswwwroot."\" + url;
1550           windowobj = window.open(fullurl,name,options);
1551           if (fullscreen) {
1552             windowobj.moveTo(0,0);
1553             windowobj.resizeTo(screen.availWidth,screen.availHeight);
1554           }
1555           windowobj.focus();
1556           return false;
1557         }
1558     // -->
1559     </script>";
1560     if (stripos($text, '</head>') !== FALSE) {
1561         // Try to add it into the head element.
1562         $text = str_ireplace('</head>', $js.'</head>', $text);
1563         return $text;
1564     }
1566     // Last chance - try adding head element.
1567     return preg_replace("/<html.*?>/is", "\\0<head>".$js.'</head>', $text);