Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/ -> filterlib.php (source)
Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403] [Versions 39 and 310]
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/>. 16 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 */ 24 25 defined('MOODLE_INTERNAL') || die(); 26 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); 35 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', chr(0x1F) . '%' . chr(0x1F)); 42 43 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(); 60 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(); 66 67 /** @var array Exploded version of $CFG->stringfilters. */ 68 protected $stringfilternames = array(); 69 70 /** @var filter_manager Holds the singleton instance. */ 71 protected static $singletoninstance; 72 73 /** 74 * Constructor. Protected. Use {@link instance()} instead. 75 */ 76 protected function __construct() { 77 $this->stringfilternames = filter_get_string_filters(); 78 } 79 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 } 96 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 } 106 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 } 115 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 } 136 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); 153 154 $filterclassname = 'filter_' . $filtername; 155 if (class_exists($filterclassname)) { 156 return new $filterclassname($context, $localconfig); 157 } 158 159 return null; 160 } 161 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 } 180 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 } 193 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 } 206 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 // Remove <nolink> tags for XHTML compatibility. 220 $text = str_replace(array('<nolink>', '</nolink>'), '', $text); 221 return $text; 222 } 223 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 } 234 235 /** 236 * @deprecated Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more. 237 */ 238 public function text_filtering_hash() { 239 throw new coding_exception('filter_manager::text_filtering_hash() can not be used any more'); 240 } 241 242 /** 243 * Setup page with filters requirements and other prepare stuff. 244 * 245 * This method is used by {@see format_text()} and {@see format_string()} 246 * in order to allow filters to setup any page requirement (js, css...) 247 * or perform any action needed to get them prepared before filtering itself 248 * happens by calling to each every active setup() method. 249 * 250 * Note it's executed for each piece of text filtered, so filter implementations 251 * are responsible of controlling the cardinality of the executions that may 252 * be different depending of the stuff to prepare. 253 * 254 * @param moodle_page $page the page we are going to add requirements to. 255 * @param context $context the context which contents are going to be filtered. 256 * @since Moodle 2.3 257 */ 258 public function setup_page_for_filters($page, $context) { 259 $filters = $this->get_text_filters($context); 260 foreach ($filters as $filter) { 261 $filter->setup($page, $context); 262 } 263 } 264 265 /** 266 * Setup the page for globally available filters. 267 * 268 * This helps setting up the page for filters which may be applied to 269 * the page, even if they do not belong to the current context, or are 270 * not yet visible because the content is lazily added (ajax). This method 271 * always uses to the system context which determines the globally 272 * available filters. 273 * 274 * This should only ever be called once per request. 275 * 276 * @param moodle_page $page The page. 277 * @since Moodle 3.2 278 */ 279 public function setup_page_for_globally_available_filters($page) { 280 $context = context_system::instance(); 281 $filterdata = filter_get_globally_enabled_filters_with_config(); 282 foreach ($filterdata as $name => $config) { 283 if (isset($this->textfilters[$context->id][$name])) { 284 $filter = $this->textfilters[$context->id][$name]; 285 } else { 286 $filter = $this->make_filter_object($name, $context, $config); 287 if (is_null($filter)) { 288 continue; 289 } 290 } 291 $filter->setup($page, $context); 292 } 293 } 294 } 295 296 297 /** 298 * Filter manager subclass that does nothing. Having this simplifies the logic 299 * of format_text, etc. 300 * 301 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 302 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 303 */ 304 class null_filter_manager { 305 /** 306 * As for the equivalent {@link filter_manager} method. 307 * 308 * @param string $text The text to filter 309 * @param context $context not used. 310 * @param array $options not used 311 * @param array $skipfilters not used 312 * @return string resulting text. 313 */ 314 public function filter_text($text, $context, array $options = array(), 315 array $skipfilters = null) { 316 return $text; 317 } 318 319 /** 320 * As for the equivalent {@link filter_manager} method. 321 * 322 * @param string $string The text to filter 323 * @param context $context not used. 324 * @return string resulting string 325 */ 326 public function filter_string($string, $context) { 327 return $string; 328 } 329 330 /** 331 * As for the equivalent {@link filter_manager} method. 332 * 333 * @deprecated Since Moodle 3.0 MDL-50491. 334 */ 335 public function text_filtering_hash() { 336 throw new coding_exception('filter_manager::text_filtering_hash() can not be used any more'); 337 } 338 } 339 340 341 /** 342 * Filter manager subclass that tracks how much work it does. 343 * 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 class performance_measuring_filter_manager extends filter_manager { 348 /** @var int number of filter objects created. */ 349 protected $filterscreated = 0; 350 351 /** @var int number of calls to filter_text. */ 352 protected $textsfiltered = 0; 353 354 /** @var int number of calls to filter_string. */ 355 protected $stringsfiltered = 0; 356 357 protected function unload_all_filters() { 358 parent::unload_all_filters(); 359 $this->filterscreated = 0; 360 $this->textsfiltered = 0; 361 $this->stringsfiltered = 0; 362 } 363 364 protected function make_filter_object($filtername, $context, $localconfig) { 365 $this->filterscreated++; 366 return parent::make_filter_object($filtername, $context, $localconfig); 367 } 368 369 public function filter_text($text, $context, array $options = array(), 370 array $skipfilters = null) { 371 $this->textsfiltered++; 372 return parent::filter_text($text, $context, $options, $skipfilters); 373 } 374 375 public function filter_string($string, $context) { 376 $this->stringsfiltered++; 377 return parent::filter_string($string, $context); 378 } 379 380 /** 381 * Return performance information, in the form required by {@link get_performance_info()}. 382 * @return array the performance info. 383 */ 384 public function get_performance_summary() { 385 return array(array( 386 'contextswithfilters' => count($this->textfilters), 387 'filterscreated' => $this->filterscreated, 388 'textsfiltered' => $this->textsfiltered, 389 'stringsfiltered' => $this->stringsfiltered, 390 ), array( 391 'contextswithfilters' => 'Contexts for which filters were loaded', 392 'filterscreated' => 'Filters created', 393 'textsfiltered' => 'Pieces of content filtered', 394 'stringsfiltered' => 'Strings filtered', 395 )); 396 } 397 } 398 399 400 /** 401 * Base class for text filters. You just need to override this class and 402 * implement the filter method. 403 * 404 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 405 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 406 */ 407 abstract class moodle_text_filter { 408 /** @var context The context we are in. */ 409 protected $context; 410 411 /** @var array Any local configuration for this filter in this context. */ 412 protected $localconfig; 413 414 /** 415 * Set any context-specific configuration for this filter. 416 * 417 * @param context $context The current context. 418 * @param array $localconfig Any context-specific configuration for this filter. 419 */ 420 public function __construct($context, array $localconfig) { 421 $this->context = $context; 422 $this->localconfig = $localconfig; 423 } 424 425 /** 426 * @deprecated Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more. 427 */ 428 public function hash() { 429 throw new coding_exception('moodle_text_filter::hash() can not be used any more'); 430 } 431 432 /** 433 * Setup page with filter requirements and other prepare stuff. 434 * 435 * Override this method if the filter needs to setup page 436 * requirements or needs other stuff to be executed. 437 * 438 * Note this method is invoked from {@see setup_page_for_filters()} 439 * for each piece of text being filtered, so it is responsible 440 * for controlling its own execution cardinality. 441 * 442 * @param moodle_page $page the page we are going to add requirements to. 443 * @param context $context the context which contents are going to be filtered. 444 * @since Moodle 2.3 445 */ 446 public function setup($page, $context) { 447 // Override me, if needed. 448 } 449 450 /** 451 * Override this function to actually implement the filtering. 452 * 453 * @param string $text some HTML content to process. 454 * @param array $options options passed to the filters 455 * @return string the HTML content after the filtering has been applied. 456 */ 457 public abstract function filter($text, array $options = array()); 458 } 459 460 461 /** 462 * This is just a little object to define a phrase and some instructions 463 * for how to process it. Filters can create an array of these to pass 464 * to the @{link filter_phrases()} function below. 465 * 466 * Note that although the fields here are public, you almost certainly should 467 * never use that. All that is supported is contructing new instances of this 468 * class, and then passing an array of them to filter_phrases. 469 * 470 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 471 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 472 */ 473 class filterobject { 474 /** @var string this is the phrase that should be matched. */ 475 public $phrase; 476 477 /** @var bool whether to match complete words. If true, 'T' won't be matched in 'Tim'. */ 478 public $fullmatch; 479 480 /** @var bool whether the match needs to be case sensitive. */ 481 public $casesensitive; 482 483 /** @var string HTML to insert before any match. */ 484 public $hreftagbegin; 485 /** @var string HTML to insert after any match. */ 486 public $hreftagend; 487 488 /** @var null|string replacement text to go inside begin and end. If not set, 489 * the body of the replacement will be the original phrase. 490 */ 491 public $replacementphrase; 492 493 /** @var null|string once initialised, holds the regexp for matching this phrase. */ 494 public $workregexp = null; 495 496 /** @var null|string once initialised, holds the mangled HTML to replace the regexp with. */ 497 public $workreplacementphrase = null; 498 499 /** 500 * Constructor. 501 * 502 * @param string $phrase this is the phrase that should be matched. 503 * @param string $hreftagbegin HTML to insert before any match. Default '<span class="highlight">'. 504 * @param string $hreftagend HTML to insert after any match. Default '</span>'. 505 * @param bool $casesensitive whether the match needs to be case sensitive 506 * @param bool $fullmatch whether to match complete words. If true, 'T' won't be matched in 'Tim'. 507 * @param mixed $replacementphrase replacement text to go inside begin and end. If not set, 508 * the body of the replacement will be the original phrase. 509 * @param callback $replacementcallback if set, then this will be called just before 510 * $hreftagbegin, $hreftagend and $replacementphrase are needed, so they can be computed only if required. 511 * The call made is 512 * list($linkobject->hreftagbegin, $linkobject->hreftagend, $linkobject->replacementphrase) = 513 * call_user_func_array($linkobject->replacementcallback, $linkobject->replacementcallbackdata); 514 * so the return should be an array [$hreftagbegin, $hreftagend, $replacementphrase], the last of which may be null. 515 * @param array $replacementcallbackdata data to be passed to $replacementcallback (optional). 516 */ 517 public function __construct($phrase, $hreftagbegin = '<span class="highlight">', 518 $hreftagend = '</span>', 519 $casesensitive = false, 520 $fullmatch = false, 521 $replacementphrase = null, 522 $replacementcallback = null, 523 array $replacementcallbackdata = null) { 524 525 $this->phrase = $phrase; 526 $this->hreftagbegin = $hreftagbegin; 527 $this->hreftagend = $hreftagend; 528 $this->casesensitive = !empty($casesensitive); 529 $this->fullmatch = !empty($fullmatch); 530 $this->replacementphrase = $replacementphrase; 531 $this->replacementcallback = $replacementcallback; 532 $this->replacementcallbackdata = $replacementcallbackdata; 533 } 534 } 535 536 /** 537 * Look up the name of this filter 538 * 539 * @param string $filter the filter name 540 * @return string the human-readable name for this filter. 541 */ 542 function filter_get_name($filter) { 543 if (strpos($filter, 'filter/') === 0) { 544 debugging("Old '$filter'' parameter used in filter_get_name()"); 545 $filter = substr($filter, 7); 546 } else if (strpos($filter, '/') !== false) { 547 throw new coding_exception('Unknown filter type ' . $filter); 548 } 549 550 if (get_string_manager()->string_exists('filtername', 'filter_' . $filter)) { 551 return get_string('filtername', 'filter_' . $filter); 552 } else { 553 return $filter; 554 } 555 } 556 557 /** 558 * Get the names of all the filters installed in this Moodle. 559 * 560 * @return array path => filter name from the appropriate lang file. e.g. 561 * array('tex' => 'TeX Notation'); 562 * sorted in alphabetical order of name. 563 */ 564 function filter_get_all_installed() { 565 $filternames = array(); 566 foreach (core_component::get_plugin_list('filter') as $filter => $fulldir) { 567 if (is_readable("$fulldir/filter.php")) { 568 $filternames[$filter] = filter_get_name($filter); 569 } 570 } 571 core_collator::asort($filternames); 572 return $filternames; 573 } 574 575 /** 576 * Set the global activated state for a text filter. 577 * 578 * @param string $filtername The filter name, for example 'tex'. 579 * @param int $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED. 580 * @param int $move -1 means up, 0 means the same, 1 means down 581 */ 582 function filter_set_global_state($filtername, $state, $move = 0) { 583 global $DB; 584 585 // Check requested state is valid. 586 if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_DISABLED))) { 587 throw new coding_exception("Illegal option '$state' passed to filter_set_global_state. " . 588 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED."); 589 } 590 591 if ($move > 0) { 592 $move = 1; 593 } else if ($move < 0) { 594 $move = -1; 595 } 596 597 if (strpos($filtername, 'filter/') === 0) { 598 $filtername = substr($filtername, 7); 599 } else if (strpos($filtername, '/') !== false) { 600 throw new coding_exception("Invalid filter name '$filtername' used in filter_set_global_state()"); 601 } 602 603 $transaction = $DB->start_delegated_transaction(); 604 605 $syscontext = context_system::instance(); 606 $filters = $DB->get_records('filter_active', array('contextid' => $syscontext->id), 'sortorder ASC'); 607 608 $on = array(); 609 $off = array(); 610 611 foreach ($filters as $f) { 612 if ($f->active == TEXTFILTER_DISABLED) { 613 $off[$f->filter] = $f; 614 } else { 615 $on[$f->filter] = $f; 616 } 617 } 618 619 // Update the state or add new record. 620 if (isset($on[$filtername])) { 621 $filter = $on[$filtername]; 622 if ($filter->active != $state) { 623 add_to_config_log('filter_active', $filter->active, $state, $filtername); 624 625 $filter->active = $state; 626 $DB->update_record('filter_active', $filter); 627 if ($filter->active == TEXTFILTER_DISABLED) { 628 unset($on[$filtername]); 629 $off = array($filter->filter => $filter) + $off; 630 } 631 632 } 633 634 } else if (isset($off[$filtername])) { 635 $filter = $off[$filtername]; 636 if ($filter->active != $state) { 637 add_to_config_log('filter_active', $filter->active, $state, $filtername); 638 639 $filter->active = $state; 640 $DB->update_record('filter_active', $filter); 641 if ($filter->active != TEXTFILTER_DISABLED) { 642 unset($off[$filtername]); 643 $on[$filter->filter] = $filter; 644 } 645 } 646 647 } else { 648 add_to_config_log('filter_active', '', $state, $filtername); 649 650 $filter = new stdClass(); 651 $filter->filter = $filtername; 652 $filter->contextid = $syscontext->id; 653 $filter->active = $state; 654 $filter->sortorder = 99999; 655 $filter->id = $DB->insert_record('filter_active', $filter); 656 657 $filters[$filter->id] = $filter; 658 if ($state == TEXTFILTER_DISABLED) { 659 $off[$filter->filter] = $filter; 660 } else { 661 $on[$filter->filter] = $filter; 662 } 663 } 664 665 // Move only active. 666 if ($move != 0 and isset($on[$filter->filter])) { 667 $i = 1; 668 foreach ($on as $f) { 669 $f->newsortorder = $i; 670 $i++; 671 } 672 673 $filter->newsortorder = $filter->newsortorder + $move; 674 675 foreach ($on as $f) { 676 if ($f->id == $filter->id) { 677 continue; 678 } 679 if ($f->newsortorder == $filter->newsortorder) { 680 if ($move == 1) { 681 $f->newsortorder = $f->newsortorder - 1; 682 } else { 683 $f->newsortorder = $f->newsortorder + 1; 684 } 685 } 686 } 687 688 core_collator::asort_objects_by_property($on, 'newsortorder', core_collator::SORT_NUMERIC); 689 } 690 691 // Inactive are sorted by filter name. 692 core_collator::asort_objects_by_property($off, 'filter', core_collator::SORT_NATURAL); 693 694 // Update records if necessary. 695 $i = 1; 696 foreach ($on as $f) { 697 if ($f->sortorder != $i) { 698 $DB->set_field('filter_active', 'sortorder', $i, array('id' => $f->id)); 699 } 700 $i++; 701 } 702 foreach ($off as $f) { 703 if ($f->sortorder != $i) { 704 $DB->set_field('filter_active', 'sortorder', $i, array('id' => $f->id)); 705 } 706 $i++; 707 } 708 709 $transaction->allow_commit(); 710 } 711 712 /** 713 * Returns the active state for a filter in the given context. 714 * 715 * @param string $filtername The filter name, for example 'tex'. 716 * @param integer $contextid The id of the context to get the data for. 717 * @return int value of active field for the given filter. 718 */ 719 function filter_get_active_state(string $filtername, $contextid = null): int { 720 global $DB; 721 722 if ($contextid === null) { 723 $contextid = context_system::instance()->id; 724 } 725 if (is_object($contextid)) { 726 $contextid = $contextid->id; 727 } 728 729 if (strpos($filtername, 'filter/') === 0) { 730 $filtername = substr($filtername, 7); 731 } else if (strpos($filtername, '/') !== false) { 732 throw new coding_exception("Invalid filter name '$filtername' used in filter_is_enabled()"); 733 } 734 if ($active = $DB->get_field('filter_active', 'active', array('filter' => $filtername, 'contextid' => $contextid))) { 735 return $active; 736 } 737 738 return TEXTFILTER_DISABLED; 739 } 740 741 /** 742 * @param string $filtername The filter name, for example 'tex'. 743 * @return boolean is this filter allowed to be used on this site. That is, the 744 * admin has set the global 'active' setting to On, or Off, but available. 745 */ 746 function filter_is_enabled($filtername) { 747 if (strpos($filtername, 'filter/') === 0) { 748 $filtername = substr($filtername, 7); 749 } else if (strpos($filtername, '/') !== false) { 750 throw new coding_exception("Invalid filter name '$filtername' used in filter_is_enabled()"); 751 } 752 return array_key_exists($filtername, filter_get_globally_enabled()); 753 } 754 755 /** 756 * Return a list of all the filters that may be in use somewhere. 757 * 758 * @return array where the keys and values are both the filter name, like 'tex'. 759 */ 760 function filter_get_globally_enabled() { 761 $cache = \cache::make_from_params(\cache_store::MODE_REQUEST, 'core_filter', 'global_filters'); 762 $enabledfilters = $cache->get('enabled'); 763 if ($enabledfilters !== false) { 764 return $enabledfilters; 765 } 766 767 $filters = filter_get_global_states(); 768 $enabledfilters = array(); 769 foreach ($filters as $filter => $filerinfo) { 770 if ($filerinfo->active != TEXTFILTER_DISABLED) { 771 $enabledfilters[$filter] = $filter; 772 } 773 } 774 775 $cache->set('enabled', $enabledfilters); 776 return $enabledfilters; 777 } 778 779 /** 780 * Get the globally enabled filters. 781 * 782 * This returns the filters which could be used in any context. Essentially 783 * the filters which are not disabled for the entire site. 784 * 785 * @return array Keys are filter names, and values the config. 786 */ 787 function filter_get_globally_enabled_filters_with_config() { 788 global $DB; 789 790 $sql = "SELECT f.filter, fc.name, fc.value 791 FROM {filter_active} f 792 LEFT JOIN {filter_config} fc 793 ON fc.filter = f.filter 794 AND fc.contextid = f.contextid 795 WHERE f.contextid = :contextid 796 AND f.active != :disabled 797 ORDER BY f.sortorder"; 798 799 $rs = $DB->get_recordset_sql($sql, [ 800 'contextid' => context_system::instance()->id, 801 'disabled' => TEXTFILTER_DISABLED 802 ]); 803 804 // Massage the data into the specified format to return. 805 $filters = array(); 806 foreach ($rs as $row) { 807 if (!isset($filters[$row->filter])) { 808 $filters[$row->filter] = array(); 809 } 810 if ($row->name !== null) { 811 $filters[$row->filter][$row->name] = $row->value; 812 } 813 } 814 $rs->close(); 815 816 return $filters; 817 } 818 819 /** 820 * Return the names of the filters that should also be applied to strings 821 * (when they are enabled). 822 * 823 * @return array where the keys and values are both the filter name, like 'tex'. 824 */ 825 function filter_get_string_filters() { 826 global $CFG; 827 $stringfilters = array(); 828 if (!empty($CFG->filterall) && !empty($CFG->stringfilters)) { 829 $stringfilters = explode(',', $CFG->stringfilters); 830 $stringfilters = array_combine($stringfilters, $stringfilters); 831 } 832 return $stringfilters; 833 } 834 835 /** 836 * Sets whether a particular active filter should be applied to all strings by 837 * format_string, or just used by format_text. 838 * 839 * @param string $filter The filter name, for example 'tex'. 840 * @param boolean $applytostrings if true, this filter will apply to format_string 841 * and format_text, when it is enabled. 842 */ 843 function filter_set_applies_to_strings($filter, $applytostrings) { 844 $stringfilters = filter_get_string_filters(); 845 $prevfilters = $stringfilters; 846 $allfilters = core_component::get_plugin_list('filter'); 847 848 if ($applytostrings) { 849 $stringfilters[$filter] = $filter; 850 } else { 851 unset($stringfilters[$filter]); 852 } 853 854 // Remove missing filters. 855 foreach ($stringfilters as $filter) { 856 if (!isset($allfilters[$filter])) { 857 unset($stringfilters[$filter]); 858 } 859 } 860 861 if ($prevfilters != $stringfilters) { 862 set_config('stringfilters', implode(',', $stringfilters)); 863 set_config('filterall', !empty($stringfilters)); 864 } 865 } 866 867 /** 868 * Set the local activated state for a text filter. 869 * 870 * @param string $filter The filter name, for example 'tex'. 871 * @param integer $contextid The id of the context to get the local config for. 872 * @param integer $state One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT. 873 * @return void 874 */ 875 function filter_set_local_state($filter, $contextid, $state) { 876 global $DB; 877 878 // Check requested state is valid. 879 if (!in_array($state, array(TEXTFILTER_ON, TEXTFILTER_OFF, TEXTFILTER_INHERIT))) { 880 throw new coding_exception("Illegal option '$state' passed to filter_set_local_state. " . 881 "Must be one of TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT."); 882 } 883 884 if ($contextid == context_system::instance()->id) { 885 throw new coding_exception('You cannot use filter_set_local_state ' . 886 'with $contextid equal to the system context id.'); 887 } 888 889 if ($state == TEXTFILTER_INHERIT) { 890 $DB->delete_records('filter_active', array('filter' => $filter, 'contextid' => $contextid)); 891 return; 892 } 893 894 $rec = $DB->get_record('filter_active', array('filter' => $filter, 'contextid' => $contextid)); 895 $insert = false; 896 if (empty($rec)) { 897 $insert = true; 898 $rec = new stdClass; 899 $rec->filter = $filter; 900 $rec->contextid = $contextid; 901 } 902 903 $rec->active = $state; 904 905 if ($insert) { 906 $DB->insert_record('filter_active', $rec); 907 } else { 908 $DB->update_record('filter_active', $rec); 909 } 910 } 911 912 /** 913 * Set a particular local config variable for a filter in a context. 914 * 915 * @param string $filter The filter name, for example 'tex'. 916 * @param integer $contextid The id of the context to get the local config for. 917 * @param string $name the setting name. 918 * @param string $value the corresponding value. 919 */ 920 function filter_set_local_config($filter, $contextid, $name, $value) { 921 global $DB; 922 $rec = $DB->get_record('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name)); 923 $insert = false; 924 if (empty($rec)) { 925 $insert = true; 926 $rec = new stdClass; 927 $rec->filter = $filter; 928 $rec->contextid = $contextid; 929 $rec->name = $name; 930 } 931 932 $rec->value = $value; 933 934 if ($insert) { 935 $DB->insert_record('filter_config', $rec); 936 } else { 937 $DB->update_record('filter_config', $rec); 938 } 939 } 940 941 /** 942 * Remove a particular local config variable for a filter in a context. 943 * 944 * @param string $filter The filter name, for example 'tex'. 945 * @param integer $contextid The id of the context to get the local config for. 946 * @param string $name the setting name. 947 */ 948 function filter_unset_local_config($filter, $contextid, $name) { 949 global $DB; 950 $DB->delete_records('filter_config', array('filter' => $filter, 'contextid' => $contextid, 'name' => $name)); 951 } 952 953 /** 954 * Get local config variables for a filter in a context. Normally (when your 955 * filter is running) you don't need to call this, becuase the config is fetched 956 * for you automatically. You only need this, for example, when you are getting 957 * the config so you can show the user an editing from. 958 * 959 * @param string $filter The filter name, for example 'tex'. 960 * @param integer $contextid The ID of the context to get the local config for. 961 * @return array of name => value pairs. 962 */ 963 function filter_get_local_config($filter, $contextid) { 964 global $DB; 965 return $DB->get_records_menu('filter_config', array('filter' => $filter, 'contextid' => $contextid), '', 'name,value'); 966 } 967 968 /** 969 * This function is for use by backup. Gets all the filter information specific 970 * to one context. 971 * 972 * @param int $contextid 973 * @return array Array with two elements. The first element is an array of objects with 974 * fields filter and active. These come from the filter_active table. The 975 * second element is an array of objects with fields filter, name and value 976 * from the filter_config table. 977 */ 978 function filter_get_all_local_settings($contextid) { 979 global $DB; 980 return array( 981 $DB->get_records('filter_active', array('contextid' => $contextid), 'filter', 'filter,active'), 982 $DB->get_records('filter_config', array('contextid' => $contextid), 'filter,name', 'filter,name,value'), 983 ); 984 } 985 986 /** 987 * Get the list of active filters, in the order that they should be used 988 * for a particular context, along with any local configuration variables. 989 * 990 * @param context $context a context 991 * @return array an array where the keys are the filter names, for example 992 * 'tex' and the values are any local 993 * configuration for that filter, as an array of name => value pairs 994 * from the filter_config table. In a lot of cases, this will be an 995 * empty array. So, an example return value for this function might be 996 * array(tex' => array()) 997 */ 998 function filter_get_active_in_context($context) { 999 global $DB, $FILTERLIB_PRIVATE; 1000 1001 if (!isset($FILTERLIB_PRIVATE)) { 1002 $FILTERLIB_PRIVATE = new stdClass(); 1003 } 1004 1005 // Use cache (this is a within-request cache only) if available. See 1006 // function filter_preload_activities. 1007 if (isset($FILTERLIB_PRIVATE->active) && 1008 array_key_exists($context->id, $FILTERLIB_PRIVATE->active)) { 1009 return $FILTERLIB_PRIVATE->active[$context->id]; 1010 } 1011 1012 $contextids = str_replace('/', ',', trim($context->path, '/')); 1013 1014 // The following SQL is tricky. It is explained on 1015 // http://docs.moodle.org/dev/Filter_enable/disable_by_context. 1016 $sql = "SELECT active.filter, fc.name, fc.value 1017 FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder 1018 FROM {filter_active} f 1019 JOIN {context} ctx ON f.contextid = ctx.id 1020 WHERE ctx.id IN ($contextids) 1021 GROUP BY filter 1022 HAVING MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth) 1023 ) active 1024 LEFT JOIN {filter_config} fc ON fc.filter = active.filter AND fc.contextid = $context->id 1025 ORDER BY active.sortorder"; 1026 $rs = $DB->get_recordset_sql($sql); 1027 1028 // Massage the data into the specified format to return. 1029 $filters = array(); 1030 foreach ($rs as $row) { 1031 if (!isset($filters[$row->filter])) { 1032 $filters[$row->filter] = array(); 1033 } 1034 if (!is_null($row->name)) { 1035 $filters[$row->filter][$row->name] = $row->value; 1036 } 1037 } 1038 1039 $rs->close(); 1040 1041 return $filters; 1042 } 1043 1044 /** 1045 * Preloads the list of active filters for all activities (modules) on the course 1046 * using two database queries. 1047 * 1048 * @param course_modinfo $modinfo Course object from get_fast_modinfo 1049 */ 1050 function filter_preload_activities(course_modinfo $modinfo) { 1051 global $DB, $FILTERLIB_PRIVATE; 1052 1053 if (!isset($FILTERLIB_PRIVATE)) { 1054 $FILTERLIB_PRIVATE = new stdClass(); 1055 } 1056 1057 // Don't repeat preload. 1058 if (!isset($FILTERLIB_PRIVATE->preloaded)) { 1059 $FILTERLIB_PRIVATE->preloaded = array(); 1060 } 1061 if (!empty($FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()])) { 1062 return; 1063 } 1064 $FILTERLIB_PRIVATE->preloaded[$modinfo->get_course_id()] = true; 1065 1066 // Get contexts for all CMs. 1067 $cmcontexts = array(); 1068 $cmcontextids = array(); 1069 foreach ($modinfo->get_cms() as $cm) { 1070 $modulecontext = context_module::instance($cm->id); 1071 $cmcontextids[] = $modulecontext->id; 1072 $cmcontexts[] = $modulecontext; 1073 } 1074 1075 // Get course context and all other parents. 1076 $coursecontext = context_course::instance($modinfo->get_course_id()); 1077 $parentcontextids = explode('/', substr($coursecontext->path, 1)); 1078 $allcontextids = array_merge($cmcontextids, $parentcontextids); 1079 1080 // Get all filter_active rows relating to all these contexts. 1081 list ($sql, $params) = $DB->get_in_or_equal($allcontextids); 1082 $filteractives = $DB->get_records_select('filter_active', "contextid $sql", $params, 'sortorder'); 1083 1084 // Get all filter_config only for the cm contexts. 1085 list ($sql, $params) = $DB->get_in_or_equal($cmcontextids); 1086 $filterconfigs = $DB->get_records_select('filter_config', "contextid $sql", $params); 1087 1088 // Note: I was a bit surprised that filter_config only works for the 1089 // most specific context (i.e. it does not need to be checked for course 1090 // context if we only care about CMs) however basede on code in 1091 // filter_get_active_in_context, this does seem to be correct. 1092 1093 // Build course default active list. Initially this will be an array of 1094 // filter name => active score (where an active score >0 means it's active). 1095 $courseactive = array(); 1096 1097 // Also build list of filter_active rows below course level, by contextid. 1098 $remainingactives = array(); 1099 1100 // Array lists filters that are banned at top level. 1101 $banned = array(); 1102 1103 // Add any active filters in parent contexts to the array. 1104 foreach ($filteractives as $row) { 1105 $depth = array_search($row->contextid, $parentcontextids); 1106 if ($depth !== false) { 1107 // Find entry. 1108 if (!array_key_exists($row->filter, $courseactive)) { 1109 $courseactive[$row->filter] = 0; 1110 } 1111 // This maths copes with reading rows in any order. Turning on/off 1112 // at site level counts 1, at next level down 4, at next level 9, 1113 // then 16, etc. This means the deepest level always wins, except 1114 // against the -9999 at top level. 1115 $courseactive[$row->filter] += 1116 ($depth + 1) * ($depth + 1) * $row->active; 1117 1118 if ($row->active == TEXTFILTER_DISABLED) { 1119 $banned[$row->filter] = true; 1120 } 1121 } else { 1122 // Build list of other rows indexed by contextid. 1123 if (!array_key_exists($row->contextid, $remainingactives)) { 1124 $remainingactives[$row->contextid] = array(); 1125 } 1126 $remainingactives[$row->contextid][] = $row; 1127 } 1128 } 1129 1130 // Chuck away the ones that aren't active. 1131 foreach ($courseactive as $filter => $score) { 1132 if ($score <= 0) { 1133 unset($courseactive[$filter]); 1134 } else { 1135 $courseactive[$filter] = array(); 1136 } 1137 } 1138 1139 // Loop through the contexts to reconstruct filter_active lists for each 1140 // cm on the course. 1141 if (!isset($FILTERLIB_PRIVATE->active)) { 1142 $FILTERLIB_PRIVATE->active = array(); 1143 } 1144 foreach ($cmcontextids as $contextid) { 1145 // Copy course list. 1146 $FILTERLIB_PRIVATE->active[$contextid] = $courseactive; 1147 1148 // Are there any changes to the active list? 1149 if (array_key_exists($contextid, $remainingactives)) { 1150 foreach ($remainingactives[$contextid] as $row) { 1151 if ($row->active > 0 && empty($banned[$row->filter])) { 1152 // If it's marked active for specific context, add entry 1153 // (doesn't matter if one exists already). 1154 $FILTERLIB_PRIVATE->active[$contextid][$row->filter] = array(); 1155 } else { 1156 // If it's marked inactive, remove entry (doesn't matter 1157 // if it doesn't exist). 1158 unset($FILTERLIB_PRIVATE->active[$contextid][$row->filter]); 1159 } 1160 } 1161 } 1162 } 1163 1164 // Process all config rows to add config data to these entries. 1165 foreach ($filterconfigs as $row) { 1166 if (isset($FILTERLIB_PRIVATE->active[$row->contextid][$row->filter])) { 1167 $FILTERLIB_PRIVATE->active[$row->contextid][$row->filter][$row->name] = $row->value; 1168 } 1169 } 1170 } 1171 1172 /** 1173 * List all of the filters that are available in this context, and what the 1174 * local and inherited states of that filter are. 1175 * 1176 * @param context $context a context that is not the system context. 1177 * @return array an array with filter names, for example 'tex' 1178 * as keys. and and the values are objects with fields: 1179 * ->filter filter name, same as the key. 1180 * ->localstate TEXTFILTER_ON/OFF/INHERIT 1181 * ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT. 1182 */ 1183 function filter_get_available_in_context($context) { 1184 global $DB; 1185 1186 // The complex logic is working out the active state in the parent context, 1187 // so strip the current context from the list. 1188 $contextids = explode('/', trim($context->path, '/')); 1189 array_pop($contextids); 1190 $contextids = implode(',', $contextids); 1191 if (empty($contextids)) { 1192 throw new coding_exception('filter_get_available_in_context cannot be called with the system context.'); 1193 } 1194 1195 // The following SQL is tricky, in the same way at the SQL in filter_get_active_in_context. 1196 $sql = "SELECT parent_states.filter, 1197 CASE WHEN fa.active IS NULL THEN " . TEXTFILTER_INHERIT . " 1198 ELSE fa.active END AS localstate, 1199 parent_states.inheritedstate 1200 FROM (SELECT f.filter, MAX(f.sortorder) AS sortorder, 1201 CASE WHEN MAX(f.active * ctx.depth) > -MIN(f.active * ctx.depth) THEN " . TEXTFILTER_ON . " 1202 ELSE " . TEXTFILTER_OFF . " END AS inheritedstate 1203 FROM {filter_active} f 1204 JOIN {context} ctx ON f.contextid = ctx.id 1205 WHERE ctx.id IN ($contextids) 1206 GROUP BY f.filter 1207 HAVING MIN(f.active) > " . TEXTFILTER_DISABLED . " 1208 ) parent_states 1209 LEFT JOIN {filter_active} fa ON fa.filter = parent_states.filter AND fa.contextid = $context->id 1210 ORDER BY parent_states.sortorder"; 1211 return $DB->get_records_sql($sql); 1212 } 1213 1214 /** 1215 * This function is for use by the filter administration page. 1216 * 1217 * @return array 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder' 1218 */ 1219 function filter_get_global_states() { 1220 global $DB; 1221 $context = context_system::instance(); 1222 return $DB->get_records('filter_active', array('contextid' => $context->id), 'sortorder', 'filter,active,sortorder'); 1223 } 1224 1225 /** 1226 * Delete all the data in the database relating to a filter, prior to deleting it. 1227 * 1228 * @param string $filter The filter name, for example 'tex'. 1229 */ 1230 function filter_delete_all_for_filter($filter) { 1231 global $DB; 1232 1233 unset_all_config_for_plugin('filter_' . $filter); 1234 $DB->delete_records('filter_active', array('filter' => $filter)); 1235 $DB->delete_records('filter_config', array('filter' => $filter)); 1236 } 1237 1238 /** 1239 * Delete all the data in the database relating to a context, used when contexts are deleted. 1240 * 1241 * @param integer $contextid The id of the context being deleted. 1242 */ 1243 function filter_delete_all_for_context($contextid) { 1244 global $DB; 1245 $DB->delete_records('filter_active', array('contextid' => $contextid)); 1246 $DB->delete_records('filter_config', array('contextid' => $contextid)); 1247 } 1248 1249 /** 1250 * Does this filter have a global settings page in the admin tree? 1251 * (The settings page for a filter must be called, for example, filtersettingfiltertex.) 1252 * 1253 * @param string $filter The filter name, for example 'tex'. 1254 * @return boolean Whether there should be a 'Settings' link on the config page. 1255 */ 1256 function filter_has_global_settings($filter) { 1257 global $CFG; 1258 $settingspath = $CFG->dirroot . '/filter/' . $filter . '/settings.php'; 1259 if (is_readable($settingspath)) { 1260 return true; 1261 } 1262 $settingspath = $CFG->dirroot . '/filter/' . $filter . '/filtersettings.php'; 1263 return is_readable($settingspath); 1264 } 1265 1266 /** 1267 * Does this filter have local (per-context) settings? 1268 * 1269 * @param string $filter The filter name, for example 'tex'. 1270 * @return boolean Whether there should be a 'Settings' link on the manage filters in context page. 1271 */ 1272 function filter_has_local_settings($filter) { 1273 global $CFG; 1274 $settingspath = $CFG->dirroot . '/filter/' . $filter . '/filterlocalsettings.php'; 1275 return is_readable($settingspath); 1276 } 1277 1278 /** 1279 * Certain types of context (block and user) may not have local filter settings. 1280 * the function checks a context to see whether it may have local config. 1281 * 1282 * @param object $context a context. 1283 * @return boolean whether this context may have local filter settings. 1284 */ 1285 function filter_context_may_have_filter_settings($context) { 1286 return $context->contextlevel != CONTEXT_BLOCK && $context->contextlevel != CONTEXT_USER; 1287 } 1288 1289 /** 1290 * Process phrases intelligently found within a HTML text (such as adding links). 1291 * 1292 * @param string $text the text that we are filtering 1293 * @param filterobject[] $linkarray an array of filterobjects 1294 * @param array $ignoretagsopen an array of opening tags that we should ignore while filtering 1295 * @param array $ignoretagsclose an array of corresponding closing tags 1296 * @param bool $overridedefaultignore True to only use tags provided by arguments 1297 * @param bool $linkarrayalreadyprepared True to say that filter_prepare_phrases_for_filtering 1298 * has already been called for $linkarray. Default false. 1299 * @return string 1300 */ 1301 function filter_phrases($text, $linkarray, $ignoretagsopen = null, $ignoretagsclose = null, 1302 $overridedefaultignore = false, $linkarrayalreadyprepared = false) { 1303 1304 global $CFG; 1305 1306 // Used if $CFG->filtermatchoneperpage is on. Array with keys being the workregexp 1307 // for things that have already been matched on this page. 1308 static $usedphrases = []; 1309 1310 $ignoretags = array(); // To store all the enclosing tags to be completely ignored. 1311 $tags = array(); // To store all the simple tags to be ignored. 1312 1313 if (!$linkarrayalreadyprepared) { 1314 $linkarray = filter_prepare_phrases_for_filtering($linkarray); 1315 } 1316 1317 if (!$overridedefaultignore) { 1318 // A list of open/close tags that we should not replace within. 1319 // Extended to include <script>, <textarea>, <select> and <a> tags. 1320 // Regular expression allows tags with or without attributes. 1321 $filterignoretagsopen = array('<head>', '<nolink>', '<span(\s[^>]*?)?class="nolink"(\s[^>]*?)?>', 1322 '<script(\s[^>]*?)?>', '<textarea(\s[^>]*?)?>', 1323 '<select(\s[^>]*?)?>', '<a(\s[^>]*?)?>'); 1324 $filterignoretagsclose = array('</head>', '</nolink>', '</span>', 1325 '</script>', '</textarea>', '</select>', '</a>'); 1326 } else { 1327 // Set an empty default list. 1328 $filterignoretagsopen = array(); 1329 $filterignoretagsclose = array(); 1330 } 1331 1332 // Add the user defined ignore tags to the default list. 1333 if ( is_array($ignoretagsopen) ) { 1334 foreach ($ignoretagsopen as $open) { 1335 $filterignoretagsopen[] = $open; 1336 } 1337 foreach ($ignoretagsclose as $close) { 1338 $filterignoretagsclose[] = $close; 1339 } 1340 } 1341 1342 // Double up some magic chars to avoid "accidental matches". 1343 $text = preg_replace('/([#*%])/', '\1\1', $text); 1344 1345 // Remove everything enclosed by the ignore tags from $text. 1346 filter_save_ignore_tags($text, $filterignoretagsopen, $filterignoretagsclose, $ignoretags); 1347 1348 // Remove tags from $text. 1349 filter_save_tags($text, $tags); 1350 1351 // Prepare the limit for preg_match calls. 1352 if (!empty($CFG->filtermatchonepertext) || !empty($CFG->filtermatchoneperpage)) { 1353 $pregreplacelimit = 1; 1354 } else { 1355 $pregreplacelimit = -1; // No limit. 1356 } 1357 1358 // Time to cycle through each phrase to be linked. 1359 foreach ($linkarray as $key => $linkobject) { 1360 if ($linkobject->workregexp === null) { 1361 // This is the case if, when preparing the phrases for filtering, 1362 // we decided that this was not a suitable phrase to match. 1363 continue; 1364 } 1365 1366 // If $CFG->filtermatchoneperpage, avoid previously matched linked phrases. 1367 if (!empty($CFG->filtermatchoneperpage) && isset($usedphrases[$linkobject->workregexp])) { 1368 continue; 1369 } 1370 1371 // Do our highlighting. 1372 $resulttext = preg_replace_callback($linkobject->workregexp, 1373 function ($matches) use ($linkobject) { 1374 if ($linkobject->workreplacementphrase === null) { 1375 filter_prepare_phrase_for_replacement($linkobject); 1376 } 1377 1378 return str_replace('$1', $matches[1], $linkobject->workreplacementphrase); 1379 }, $text, $pregreplacelimit); 1380 1381 // If the text has changed we have to look for links again. 1382 if ($resulttext != $text) { 1383 $text = $resulttext; 1384 // Remove everything enclosed by the ignore tags from $text. 1385 filter_save_ignore_tags($text, $filterignoretagsopen, $filterignoretagsclose, $ignoretags); 1386 // Remove tags from $text. 1387 filter_save_tags($text, $tags); 1388 // If $CFG->filtermatchoneperpage, save linked phrases to request. 1389 if (!empty($CFG->filtermatchoneperpage)) { 1390 $usedphrases[$linkobject->workregexp] = 1; 1391 } 1392 } 1393 } 1394 1395 // Rebuild the text with all the excluded areas. 1396 if (!empty($tags)) { 1397 $text = str_replace(array_keys($tags), $tags, $text); 1398 } 1399 1400 if (!empty($ignoretags)) { 1401 $ignoretags = array_reverse($ignoretags); // Reversed so "progressive" str_replace() will solve some nesting problems. 1402 $text = str_replace(array_keys($ignoretags), $ignoretags, $text); 1403 } 1404 1405 // Remove the protective doubleups. 1406 $text = preg_replace('/([#*%])(\1)/', '\1', $text); 1407 1408 // Add missing javascript for popus. 1409 $text = filter_add_javascript($text); 1410 1411 return $text; 1412 } 1413 1414 /** 1415 * Prepare a list of link for processing with {@link filter_phrases()}. 1416 * 1417 * @param filterobject[] $linkarray the links that will be passed to filter_phrases(). 1418 * @return filterobject[] the updated list of links with necessary pre-processing done. 1419 */ 1420 function filter_prepare_phrases_for_filtering(array $linkarray) { 1421 // Time to cycle through each phrase to be linked. 1422 foreach ($linkarray as $linkobject) { 1423 1424 // Set some defaults if certain properties are missing. 1425 // Properties may be missing if the filterobject class has not been used to construct the object. 1426 if (empty($linkobject->phrase)) { 1427 continue; 1428 } 1429 1430 // Avoid integers < 1000 to be linked. See bug 1446. 1431 $intcurrent = intval($linkobject->phrase); 1432 if (!empty($intcurrent) && strval($intcurrent) == $linkobject->phrase && $intcurrent < 1000) { 1433 continue; 1434 } 1435 1436 // Strip tags out of the phrase. 1437 $linkobject->workregexp = strip_tags($linkobject->phrase); 1438 1439 if (!$linkobject->casesensitive) { 1440 $linkobject->workregexp = core_text::strtolower($linkobject->workregexp); 1441 } 1442 1443 // Double up chars that might cause a false match -- the duplicates will 1444 // be cleared up before returning to the user. 1445 $linkobject->workregexp = preg_replace('/([#*%])/', '\1\1', $linkobject->workregexp); 1446 1447 // Quote any regular expression characters and the delimiter in the work phrase to be searched. 1448 $linkobject->workregexp = preg_quote($linkobject->workregexp, '/'); 1449 1450 // If we ony want to match entire words then add \b assertions. However, only 1451 // do this if the first or last thing in the phrase to match is a word character. 1452 if ($linkobject->fullmatch) { 1453 if (preg_match('~^\w~', $linkobject->workregexp)) { 1454 $linkobject->workregexp = '\b' . $linkobject->workregexp; 1455 } 1456 if (preg_match('~\w$~', $linkobject->workregexp)) { 1457 $linkobject->workregexp = $linkobject->workregexp . '\b'; 1458 } 1459 } 1460 1461 $linkobject->workregexp = '/(' . $linkobject->workregexp . ')/s'; 1462 1463 if (!$linkobject->casesensitive) { 1464 $linkobject->workregexp .= 'iu'; 1465 } 1466 } 1467 1468 return $linkarray; 1469 } 1470 1471 /** 1472 * Fill in the remaining ->work... fields, that would be needed to replace the phrase. 1473 * 1474 * @param filterobject $linkobject the link object on which to set additional fields. 1475 */ 1476 function filter_prepare_phrase_for_replacement(filterobject $linkobject) { 1477 if ($linkobject->replacementcallback !== null) { 1478 list($linkobject->hreftagbegin, $linkobject->hreftagend, $linkobject->replacementphrase) = 1479 call_user_func_array($linkobject->replacementcallback, $linkobject->replacementcallbackdata); 1480 } 1481 1482 if (!isset($linkobject->hreftagbegin) or !isset($linkobject->hreftagend)) { 1483 $linkobject->hreftagbegin = '<span class="highlight"'; 1484 $linkobject->hreftagend = '</span>'; 1485 } 1486 1487 // Double up chars to protect true duplicates 1488 // be cleared up before returning to the user. 1489 $hreftagbeginmangled = preg_replace('/([#*%])/', '\1\1', $linkobject->hreftagbegin); 1490 1491 // Set the replacement phrase properly. 1492 if ($linkobject->replacementphrase) { // We have specified a replacement phrase. 1493 $linkobject->workreplacementphrase = strip_tags($linkobject->replacementphrase); 1494 } else { // The replacement is the original phrase as matched below. 1495 $linkobject->workreplacementphrase = '$1'; 1496 } 1497 1498 $linkobject->workreplacementphrase = $hreftagbeginmangled . 1499 $linkobject->workreplacementphrase . $linkobject->hreftagend; 1500 } 1501 1502 /** 1503 * Remove duplicate from a list of {@link filterobject}. 1504 * 1505 * @param filterobject[] $linkarray a list of filterobject. 1506 * @return filterobject[] the same list, but with dupicates removed. 1507 */ 1508 function filter_remove_duplicates($linkarray) { 1509 1510 $concepts = array(); // Keep a record of concepts as we cycle through. 1511 $lconcepts = array(); // A lower case version for case insensitive. 1512 1513 $cleanlinks = array(); 1514 1515 foreach ($linkarray as $key => $filterobject) { 1516 if ($filterobject->casesensitive) { 1517 $exists = in_array($filterobject->phrase, $concepts); 1518 } else { 1519 $exists = in_array(core_text::strtolower($filterobject->phrase), $lconcepts); 1520 } 1521 1522 if (!$exists) { 1523 $cleanlinks[] = $filterobject; 1524 $concepts[] = $filterobject->phrase; 1525 $lconcepts[] = core_text::strtolower($filterobject->phrase); 1526 } 1527 } 1528 1529 return $cleanlinks; 1530 } 1531 1532 /** 1533 * Extract open/lose tags and their contents to avoid being processed by filters. 1534 * Useful to extract pieces of code like <a>...</a> tags. It returns the text 1535 * converted with some <#xTEXTFILTER_EXCL_SEPARATORx#> codes replacing the extracted text. Such extracted 1536 * texts are returned in the ignoretags array (as values), with codes as keys. 1537 * 1538 * @param string $text the text that we are filtering (in/out) 1539 * @param array $filterignoretagsopen an array of open tags to start searching 1540 * @param array $filterignoretagsclose an array of close tags to end searching 1541 * @param array $ignoretags an array of saved strings useful to rebuild the original text (in/out) 1542 **/ 1543 function filter_save_ignore_tags(&$text, $filterignoretagsopen, $filterignoretagsclose, &$ignoretags) { 1544 1545 // Remove everything enclosed by the ignore tags from $text. 1546 foreach ($filterignoretagsopen as $ikey => $opentag) { 1547 $closetag = $filterignoretagsclose[$ikey]; 1548 // Form regular expression. 1549 $opentag = str_replace('/', '\/', $opentag); // Delimit forward slashes. 1550 $closetag = str_replace('/', '\/', $closetag); // Delimit forward slashes. 1551 $pregexp = '/'.$opentag.'(.*?)'.$closetag.'/is'; 1552 1553 preg_match_all($pregexp, $text, $listofignores); 1554 foreach (array_unique($listofignores[0]) as $key => $value) { 1555 $prefix = (string) (count($ignoretags) + 1); 1556 $ignoretags['<#'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$key.'#>'] = $value; 1557 } 1558 if (!empty($ignoretags)) { 1559 $text = str_replace($ignoretags, array_keys($ignoretags), $text); 1560 } 1561 } 1562 } 1563 1564 /** 1565 * Extract tags (any text enclosed by < and > to avoid being processed by filters. 1566 * It returns the text converted with some <%xTEXTFILTER_EXCL_SEPARATORx%> codes replacing the extracted text. Such extracted 1567 * texts are returned in the tags array (as values), with codes as keys. 1568 * 1569 * @param string $text the text that we are filtering (in/out) 1570 * @param array $tags an array of saved strings useful to rebuild the original text (in/out) 1571 **/ 1572 function filter_save_tags(&$text, &$tags) { 1573 1574 preg_match_all('/<([^#%*].*?)>/is', $text, $listofnewtags); 1575 foreach (array_unique($listofnewtags[0]) as $ntkey => $value) { 1576 $prefix = (string)(count($tags) + 1); 1577 $tags['<%'.$prefix.TEXTFILTER_EXCL_SEPARATOR.$ntkey.'%>'] = $value; 1578 } 1579 if (!empty($tags)) { 1580 $text = str_replace($tags, array_keys($tags), $text); 1581 } 1582 } 1583 1584 /** 1585 * Add missing openpopup javascript to HTML files. 1586 * 1587 * @param string $text 1588 * @return string 1589 */ 1590 function filter_add_javascript($text) { 1591 global $CFG; 1592 1593 if (stripos($text, '</html>') === false) { 1594 return $text; // This is not a html file. 1595 } 1596 if (strpos($text, 'onclick="return openpopup') === false) { 1597 return $text; // No popup - no need to add javascript. 1598 } 1599 $js = " 1600 <script type=\"text/javascript\"> 1601 <!-- 1602 function openpopup(url,name,options,fullscreen) { 1603 fullurl = \"".$CFG->wwwroot."\" + url; 1604 windowobj = window.open(fullurl,name,options); 1605 if (fullscreen) { 1606 windowobj.moveTo(0,0); 1607 windowobj.resizeTo(screen.availWidth,screen.availHeight); 1608 } 1609 windowobj.focus(); 1610 return false; 1611 } 1612 // --> 1613 </script>"; 1614 if (stripos($text, '</head>') !== false) { 1615 // Try to add it into the head element. 1616 $text = str_ireplace('</head>', $js.'</head>', $text); 1617 return $text; 1618 } 1619 1620 // Last chance - try adding head element. 1621 return preg_replace("/<html.*?>/is", "\\0<head>".$js.'</head>', $text); 1622 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
