39 '/&([A-Za-z0-9\x80-\xff]+);
41 |&\#[xX]([0-9A-Fa-f]+);
357 if ( self::$attribsRegex ===
null ) {
358 $spaceChars =
'\x09\x0a\x0c\x0d\x20';
359 $space =
"[{$spaceChars}]";
360 $attrib =
"[^{$spaceChars}\/>=]";
361 $attribFirst =
"(?:{$attrib}|=)";
362 self::$attribsRegex =
363 "/({$attribFirst}{$attrib}*)
366 # The attribute value: quoted or alone
373 return self::$attribsRegex;
386 if ( self::$attribNameRegex ===
null ) {
387 $attribFirst =
"[:_\p{L}\p{N}]";
388 $attrib =
"[:_\.\-\p{L}\p{N}]";
389 self::$attribNameRegex =
"/^({$attribFirst}{$attrib}*)$/sxu";
391 return self::$attribNameRegex;
403 static $htmlpairsStatic, $htmlsingle, $htmlsingleonly, $htmlnest, $tabletags,
404 $htmllist, $listtags, $htmlsingleallowed, $htmlelementsStatic, $staticInitialised;
409 if ( !$staticInitialised || $staticInitialised != $globalContext ) {
410 $htmlpairsStatic = [ # Tags
that must be closed
411 'b',
'bdi',
'del',
'i',
'ins',
'u',
'font',
'big',
'small',
'sub',
'sup',
'h1',
412 'h2',
'h3',
'h4',
'h5',
'h6',
'cite',
'code',
'em',
's',
413 'strike',
'strong',
'tt',
'var',
'div',
'center',
414 'blockquote',
'ol',
'ul',
'dl',
'table',
'caption',
'pre',
415 'ruby',
'rb',
'rp',
'rt',
'rtc',
'p',
'span',
'abbr',
'dfn',
416 'kbd',
'samp',
'data',
'time',
'mark'
419 'br',
'wbr',
'hr',
'li',
'dt',
'dd',
'meta',
'link'
422 # Elements that cannot have close tags. This is (not coincidentally)
423 # also the list of tags for which the HTML 5 parsing algorithm
424 # requires you to "acknowledge the token's self-closing flag", i.e.
425 # a self-closing tag like <br/> is not an HTML 5 parse error only
428 'br',
'wbr',
'hr',
'meta',
'link'
431 $htmlnest = [ # Tags
that can be nested--??
432 'table',
'tr',
'td',
'th',
'div',
'blockquote',
'ol',
'ul',
433 'li',
'dl',
'dt',
'dd',
'font',
'big',
'small',
'sub',
'sup',
'span',
434 'var',
'kbd',
'samp',
'em',
'strong',
'q',
'ruby',
'bdo'
436 $tabletags = [ # Can only appear inside
table, we
will close
them
442 $listtags = [ # Tags
that can appear
in a
list
447 $htmlsingle[] =
'img';
448 $htmlsingleonly[] =
'img';
451 $htmlsingleallowed = array_unique( array_merge( $htmlsingle, $tabletags ) );
452 $htmlelementsStatic = array_unique( array_merge( $htmlsingle, $htmlpairsStatic, $htmlnest ) );
454 # Convert them all to hashtables for faster lookup
455 $vars = [
'htmlpairsStatic',
'htmlsingle',
'htmlsingleonly',
'htmlnest',
'tabletags',
456 'htmllist',
'listtags',
'htmlsingleallowed',
'htmlelementsStatic' ];
458 $$var = array_flip( $$var );
460 $staticInitialised = $globalContext;
463 # Populate $htmlpairs and $htmlelements with the $extratags and $removetags arrays
464 $extratags = array_flip( $extratags );
465 $removetags = array_flip( $removetags );
466 $htmlpairs = array_merge( $extratags, $htmlpairsStatic );
467 $htmlelements = array_diff_key( array_merge( $extratags, $htmlelementsStatic ), $removetags );
470 'htmlpairs' => $htmlpairs,
471 'htmlsingle' => $htmlsingle,
472 'htmlsingleonly' => $htmlsingleonly,
473 'htmlnest' => $htmlnest,
474 'tabletags' => $tabletags,
475 'htmllist' => $htmllist,
476 'listtags' => $listtags,
477 'htmlsingleallowed' => $htmlsingleallowed,
478 'htmlelements' => $htmlelements,
498 $args = [], $extratags = [], $removetags = [], $warnCallback =
null
500 $tagData = self::getRecognizedTagData( $extratags, $removetags );
501 $htmlpairs = $tagData[
'htmlpairs'];
502 $htmlsingle = $tagData[
'htmlsingle'];
503 $htmlsingleonly = $tagData[
'htmlsingleonly'];
504 $htmlnest = $tagData[
'htmlnest'];
505 $tabletags = $tagData[
'tabletags'];
506 $htmllist = $tagData[
'htmllist'];
507 $listtags = $tagData[
'listtags'];
508 $htmlsingleallowed = $tagData[
'htmlsingleallowed'];
509 $htmlelements = $tagData[
'htmlelements'];
511 # Remove HTML comments
512 $text = self::removeHTMLcomments( $text );
513 $bits = explode(
'<', $text );
514 $text = str_replace(
'>',
'>', array_shift( $bits ) );
517 $tagstack = $tablestack = [];
518 foreach ( $bits
as $x ) {
520 # $slash: Does the current element start with a '/'?
521 # $t: Current element name
522 # $params: String between element name and >
523 # $brace: Ending '>' or '/>'
524 # $rest: Everything until the next element of $bits
525 if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
528 $slash =
$t =
$params = $brace = $rest =
null;
532 $t = strtolower(
$t );
533 if ( isset( $htmlelements[
$t] ) ) {
535 if ( $slash && isset( $htmlsingleonly[
$t] ) ) {
537 } elseif ( $slash ) {
538 # Closing a tag... is it the one we just opened?
539 Wikimedia\suppressWarnings();
540 $ot = array_pop( $tagstack );
541 Wikimedia\restoreWarnings();
544 if ( isset( $htmlsingleallowed[$ot] ) ) {
545 # Pop all elements with an optional close tag
546 # and see if we find a match below them
548 array_push( $optstack, $ot );
549 Wikimedia\suppressWarnings();
550 $ot = array_pop( $tagstack );
551 Wikimedia\restoreWarnings();
552 while ( $ot !=
$t && isset( $htmlsingleallowed[$ot] ) ) {
553 array_push( $optstack, $ot );
554 Wikimedia\suppressWarnings();
555 $ot = array_pop( $tagstack );
556 Wikimedia\restoreWarnings();
559 # No match. Push the optional elements back again
561 Wikimedia\suppressWarnings();
562 $ot = array_pop( $optstack );
563 Wikimedia\restoreWarnings();
565 array_push( $tagstack, $ot );
566 Wikimedia\suppressWarnings();
567 $ot = array_pop( $optstack );
568 Wikimedia\restoreWarnings();
572 Wikimedia\suppressWarnings();
573 array_push( $tagstack, $ot );
574 Wikimedia\restoreWarnings();
576 # <li> can be nested in <ul> or <ol>, skip those cases:
577 if ( !isset( $htmllist[$ot] ) || !isset( $listtags[
$t] ) ) {
581 } elseif (
$t ==
'table' ) {
582 $tagstack = array_pop( $tablestack );
586 # Keep track for later
587 if ( isset( $tabletags[
$t] ) && !in_array(
'table', $tagstack ) ) {
589 } elseif ( in_array(
$t, $tagstack ) && !isset( $htmlnest[
$t] ) ) {
591 # Is it a self closed htmlpair ? (T7487)
592 } elseif ( $brace ==
'/>' && isset( $htmlpairs[
$t] ) ) {
598 if ( is_callable( $warnCallback ) ) {
599 call_user_func_array( $warnCallback, [
'deprecated-self-close-category' ] );
602 } elseif ( isset( $htmlsingleonly[
$t] ) ) {
603 # Hack to force empty tag for unclosable elements
605 } elseif ( isset( $htmlsingle[
$t] ) ) {
606 # Hack to not close $htmlsingle tags
608 # Still need to push this optionally-closed tag to
609 # the tag stack so that we can match end tags
610 # instead of marking them as bad.
611 array_push( $tagstack,
$t );
612 } elseif ( isset( $tabletags[
$t] ) && in_array(
$t, $tagstack ) ) {
616 if (
$t ==
'table' ) {
617 array_push( $tablestack, $tagstack );
620 array_push( $tagstack,
$t );
623 # Replace any variables or template parameters with
625 if ( is_callable( $processCallback ) ) {
626 call_user_func_array( $processCallback, [ &
$params,
$args ] );
629 if ( !self::validateTag(
$params,
$t ) ) {
633 # Strip non-approved attributes from the tag
634 $newparams = self::fixTagAttributes(
$params,
$t );
637 $rest = str_replace(
'>',
'>', $rest );
638 $close = ( $brace ==
'/>' && !$slash ) ?
' /' :
'';
639 $text .=
"<$slash$t$newparams$close>$rest";
643 $text .=
'<' . str_replace(
'>',
'>', $x );
645 # Close off any remaining tags
646 while ( is_array( $tagstack ) && (
$t = array_pop( $tagstack ) ) ) {
648 if (
$t ==
'table' ) {
649 $tagstack = array_pop( $tablestack );
653 # this might be possible using tidy itself
654 foreach ( $bits
as $x ) {
655 if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
659 $t = strtolower(
$t );
660 if ( isset( $htmlelements[
$t] ) ) {
661 if ( is_callable( $processCallback ) ) {
662 call_user_func_array( $processCallback, [ &
$params,
$args ] );
665 if ( $brace ==
'/>' && !( isset( $htmlsingle[
$t] ) || isset( $htmlsingleonly[
$t] ) ) ) {
671 if ( is_callable( $warnCallback ) ) {
672 call_user_func_array( $warnCallback, [
'deprecated-self-close-category' ] );
675 if ( !self::validateTag(
$params,
$t ) ) {
679 $newparams = self::fixTagAttributes(
$params,
$t );
681 if ( $brace ===
'/>' && !isset( $htmlsingleonly[
$t] ) ) {
682 # Interpret self-closing tags as empty tags even when
683 # HTML 5 would interpret them as start tags. Such input
684 # is commonly seen on Wikimedia wikis with this intention.
688 $rest = str_replace(
'>',
'>', $rest );
689 $text .=
"<$slash$t$newparams$brace$rest";
694 $text .=
'<' . str_replace(
'>',
'>', $x );
710 while ( ( $start = strpos( $text,
'<!--' ) ) !==
false ) {
711 $end = strpos( $text,
'-->', $start + 4 );
712 if ( $end ===
false ) {
713 # Unterminated comment; bail out
719 # Trim space and newline if the comment is both
720 # preceded and followed by a newline
721 $spaceStart = max( $start - 1, 0 );
722 $spaceLen = $end - $spaceStart;
723 while ( substr( $text, $spaceStart, 1 ) ===
' ' && $spaceStart > 0 ) {
727 while ( substr( $text, $spaceStart + $spaceLen, 1 ) ===
' ' ) {
730 if ( substr( $text, $spaceStart, 1 ) ===
"\n"
731 && substr( $text, $spaceStart + $spaceLen, 1 ) ===
"\n" ) {
732 # Remove the comment, leading and trailing
733 # spaces, and leave only one newline.
734 $text = substr_replace( $text,
"\n", $spaceStart, $spaceLen + 1 );
736 # Remove just the comment.
737 $text = substr_replace( $text,
'', $start, $end - $start );
758 if ( $element ==
'meta' || $element ==
'link' ) {
759 if ( !isset(
$params[
'itemprop'] ) ) {
763 if ( $element ==
'meta' && !isset(
$params[
'content'] ) ) {
767 if ( $element ==
'link' && !isset(
$params[
'href'] ) ) {
792 return self::validateAttributes(
$attribs,
793 self::attributeWhitelist( $element ) );
812 $whitelist = array_flip( $whitelist );
817 # Allow XML namespace declaration to allow RDFa
818 if ( preg_match( self::XMLNS_ATTRIBUTE_PATTERN, $attribute ) ) {
819 if ( !preg_match( self::EVIL_URI_PATTERN,
$value ) ) {
826 # Allow any attribute beginning with "data-"
828 # * Disallow data attributes used by MediaWiki code
829 # * Ensure that the attribute is not namespaced by banning
831 if ( !preg_match(
'/^data-[^:]*$/i', $attribute )
832 && !isset( $whitelist[$attribute] )
833 || self::isReservedDataAttribute( $attribute )
838 # Strip javascript "expression" from stylesheets.
840 if ( $attribute ==
'style' ) {
844 # Escape HTML id attributes
845 if ( $attribute ===
'id' ) {
846 $value = self::escapeIdForAttribute(
$value, self::ID_PRIMARY );
849 # Escape HTML id reference lists
850 if ( $attribute ===
'aria-describedby'
851 || $attribute ===
'aria-flowto'
852 || $attribute ===
'aria-labelledby'
853 || $attribute ===
'aria-owns'
860 if ( $attribute ===
'rel' || $attribute ===
'rev'
862 || $attribute ===
'about' || $attribute ===
'property'
863 || $attribute ===
'resource' || $attribute ===
'datatype'
864 || $attribute ===
'typeof'
866 || $attribute ===
'itemid' || $attribute ===
'itemprop'
867 || $attribute ===
'itemref' || $attribute ===
'itemscope'
868 || $attribute ===
'itemtype'
871 if ( preg_match( self::EVIL_URI_PATTERN,
$value ) ) {
876 # NOTE: even though elements using href/src are not allowed directly, supply
877 # validation code that can be used by tag hook handlers, etc
878 if ( $attribute ===
'href' || $attribute ===
'src' || $attribute ===
'poster' ) {
879 if ( !preg_match( $hrefExp,
$value ) ) {
890 # itemtype, itemid, itemref don't make sense without itemscope
891 if ( !array_key_exists(
'itemscope',
$out ) ) {
892 unset(
$out[
'itemtype'] );
893 unset(
$out[
'itemid'] );
894 unset(
$out[
'itemref'] );
896 # TODO: Strip itemprop if we aren't descendants of an itemscope or pointed to by an itemref.
916 return (
bool)preg_match(
'/^data-(ooui|mw|parsoid)/i', $attr );
930 $out = array_merge( $a, $b );
931 if ( isset( $a[
'class'] ) && isset( $b[
'class'] )
932 && is_string( $a[
'class'] ) && is_string( $b[
'class'] )
933 && $a[
'class'] !== $b[
'class']
935 $classes = preg_split(
'/\s+/',
"{$a['class']} {$b['class']}",
936 -1, PREG_SPLIT_NO_EMPTY );
937 $out[
'class'] = implode(
' ', array_unique( $classes ) );
965 if ( !$decodeRegex ) {
966 $space =
'[\\x20\\t\\r\\n\\f]';
967 $nl =
'(?:\\n|\\r\\n|\\r|\\f)';
969 $decodeRegex =
"/ $backslash
971 ($nl) | # 1. Line continuation
972 ([0-9A-Fa-f]{1,6})$space? | # 2. character number
973 (.) | # 3. backslash cancelling special meaning
974 () | # 4. backslash at end of string
977 $value = preg_replace_callback( $decodeRegex,
978 [ __CLASS__,
'cssDecodeCallback' ],
$value );
981 $value = preg_replace_callback(
984 $cp = UtfNormal\Utils::utf8ToCodepoint(
$matches[0] );
985 if ( $cp ===
false ) {
988 return chr( $cp - 65248 );
996 [
'ʀ',
'ɴ',
'ⁿ',
'ʟ',
'ɪ',
'⁽',
'₍' ],
997 [
'r',
'n',
'n',
'l',
'i',
'(',
'(' ],
1004 if ( !preg_match(
'! ^ \s* /\* [^*\\/]* \*/ \s* $ !x',
$value ) ) {
1015 $commentPos = strpos(
$value,
'/*' );
1016 if ( $commentPos !==
false ) {
1025 \xE3\x80\xB1 | # U+3031
1026 \xE3\x82\x9D | # U+309D
1027 \xE3\x83\xBC | # U+30FC
1028 \xE3\x83\xBD | # U+30FD
1029 \xEF\xB9\xBC | # U+FE7C
1030 \xEF\xB9\xBD | # U+FE7D
1031 \xEF\xBD\xB0 # U+FF70
1062 if ( preg_match(
'/[\000-\010\013\016-\037\177]/',
$value ) ||
1063 strpos(
$value, UtfNormal\Constants::UTF8_REPLACEMENT ) !==
false ) {
1064 return '/* invalid control char */';
1065 } elseif ( preg_match(
1070 | -o-link-source\s*:
1075 | attr\s*\([^)]+[\s,]+url
1078 return '/* insecure input */';
1092 $char = UtfNormal\Utils::codepointToUtf8( hexdec(
$matches[2] ) );
1098 if ( $char ==
"\n" || $char ==
'"' || $char ==
"'" || $char ==
'\\' ) {
1101 return '\\' . dechex( ord( $char ) ) .
' ';
1130 if ( trim( $text ) ==
'' ) {
1134 $decoded = self::decodeTagAttributes( $text );
1135 $stripped = self::validateTagAttributes( $decoded, $element );
1141 return self::safeEncodeTagAttributes( $stripped );
1150 $encValue = htmlspecialchars( $text, ENT_QUOTES );
1155 $encValue = strtr( $encValue, [
1176 # French spaces, last one Guillemet-left
1177 # only if there is something before the space
1178 # and a non-word character after the punctuation.
1179 '/(\S) (?=[?:;!%»›](?!\w))/u' =>
"\\1$space",
1180 # French spaces, Guillemet-right
1181 '/([«‹]) /u' =>
"\\1$space",
1183 return preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
1193 $encValue = self::encodeAttribute( $text );
1195 # Templates and links may be expanded in later parsing,
1196 # creating invalid or dangerous output. Suppress this.
1197 $encValue = strtr( $encValue, [
1205 "''" =>
'''',
1206 'ISBN' =>
'ISBN',
1208 'PMID' =>
'PMID',
1213 # Armor against French spaces detection (T5158)
1214 $encValue = self::armorFrenchSpaces( $encValue,
' ' );
1217 $encValue = preg_replace_callback(
1220 return str_replace(
':',
':',
$matches[1] );
1263 $id = urlencode( strtr( $id,
' ',
'_' ) );
1264 $id = strtr( $id, $replace );
1266 if ( !preg_match(
'/^[a-zA-Z]/', $id ) && !in_array(
'noninitial',
$options ) ) {
1292 if ( $mode === self::ID_PRIMARY ) {
1293 throw new UnexpectedValueException(
'$wgFragmentMode is configured with no primary mode' );
1300 return self::escapeIdInternal( $id, $internalMode );
1319 throw new UnexpectedValueException(
'$wgFragmentMode is configured with no primary mode' );
1324 $id = self::escapeIdInternal( $id, $mode );
1356 $id = str_replace(
' ',
'_', $id );
1365 $id = urlencode( str_replace(
' ',
'_', $id ) );
1366 $id = strtr( $id, $replace );
1369 throw new InvalidArgumentException(
"Invalid mode '$mode' passed to '" . __METHOD__ );
1385 # Explode the space delimited list string into an array of tokens
1386 $references = preg_split(
'/\s+/',
"{$referenceString}", -1, PREG_SPLIT_NO_EMPTY );
1388 # Escape each token as an id
1389 foreach ( $references
as &$ref ) {
1390 $ref = self::escapeIdForAttribute( $ref );
1393 # Merge the array back to a space delimited list string
1394 # If the array is empty, the result will be an empty string ('')
1395 $referenceString = implode(
' ', $references );
1397 return $referenceString;
1413 return rtrim( preg_replace(
1414 [
'/(^[0-9\\-])|[\\x00-\\x20!"#$%&\'()*+,.\\/:;<=>?@[\\]^`{|}~]|\\xC2\\xA0/',
'/_+/' ],
1428 # It seems wise to escape ' as well as ", as a matter of course. Can't
1429 # hurt. Use ENT_SUBSTITUTE so that incorrectly truncated multibyte characters
1430 # don't cause the entire string to disappear.
1431 $html = htmlspecialchars( $html, ENT_QUOTES | ENT_SUBSTITUTE );
1443 public static function decodeTagAttributes( $text ) {
1444 if ( trim( $text ) == '' ) {
1449 if ( !preg_match_all(
1450 self::getAttribsRegex(),
1453 PREG_SET_ORDER ) ) {
1458 foreach ( $pairs as $set ) {
1459 $attribute = strtolower( $set[1] );
1461 // Filter attribute names with unacceptable characters
1462 if ( !preg_match( self::getAttribNameRegex(), $attribute ) ) {
1466 $value = self::getTagAttributeCallback( $set );
1468 // Normalize whitespace
1469 $value = preg_replace( '/[\t\r\n ]+/', ' ', $value );
1470 $value = trim( $value );
1472 // Decode character references
1473 $attribs[$attribute] = self::decodeCharReferences( $value );
1485 public static function safeEncodeTagAttributes( $assoc_array ) {
1487 foreach ( $assoc_array as $attribute => $value ) {
1488 $encAttribute = htmlspecialchars( $attribute );
1489 $encValue = self::safeEncodeAttribute( $value );
1491 $attribs[] = "$encAttribute=\"$encValue\"";
1505 if ( isset( $set[5] ) ) {
1508 } elseif ( isset( $set[4] ) ) {
1511 } elseif ( isset( $set[3] ) ) {
1514 } elseif ( !isset( $set[2] ) ) {
1515 # In XHTML, attributes must have a value so return an empty string.
1516 # See "Empty attribute syntax",
1520 throw new MWException(
"Tag conditions not met. This should never happen and is a bug." );
1529 return trim( preg_replace(
1530 '/(?:\r\n|[\x20\x0d\x0a\x09])+/',
1544 return trim( preg_replace(
'/[ _]+/',
' ',
$section ) );
1563 return preg_replace_callback(
1564 self::CHAR_REFS_REGEX,
1565 [ self::class,
'normalizeCharReferencesCallback' ],
1582 if ( is_null(
$ret ) ) {
1583 return htmlspecialchars(
$matches[0] );
1600 if ( isset( self::$htmlEntityAliases[
$name] ) ) {
1601 return '&' . self::$htmlEntityAliases[
$name] .
';';
1602 } elseif ( in_array(
$name, [
'lt',
'gt',
'amp',
'quot' ] ) ) {
1604 } elseif ( isset( self::$htmlEntities[
$name] ) ) {
1605 return '&#' . self::$htmlEntities[
$name] .
';';
1607 return "&$name;";
1616 $point = intval( $codepoint );
1617 if ( self::validateCodepoint( $point ) ) {
1618 return sprintf(
'&#%d;', $point );
1629 $point = hexdec( $codepoint );
1630 if ( self::validateCodepoint( $point ) ) {
1631 return sprintf(
'&#x%x;', $point );
1644 # U+000C is valid in HTML5 but not allowed in XML.
1645 # U+000D is valid in XML but not allowed in HTML5.
1646 # U+007F - U+009F are disallowed in HTML5 (control characters).
1647 return $codepoint == 0x09
1648 || $codepoint == 0x0a
1649 || ( $codepoint >= 0x20 && $codepoint <= 0x7e )
1650 || ( $codepoint >= 0xa0 && $codepoint <= 0xd7ff )
1651 || ( $codepoint >= 0xe000 && $codepoint <= 0xfffd )
1652 || ( $codepoint >= 0x10000 && $codepoint <= 0x10ffff );
1663 return preg_replace_callback(
1664 self::CHAR_REFS_REGEX,
1665 [ self::class,
'decodeCharReferencesCallback' ],
1680 $text = preg_replace_callback(
1681 self::CHAR_REFS_REGEX,
1682 [ self::class,
'decodeCharReferencesCallback' ],
1689 return MediaWikiServices::getInstance()->getContentLanguage()->normalize( $text );
1701 return self::decodeEntity(
$matches[1] );
1703 return self::decodeChar( intval(
$matches[2] ) );
1705 return self::decodeChar( hexdec(
$matches[3] ) );
1707 # Last case should be an ampersand by itself
1719 if ( self::validateCodepoint( $codepoint ) ) {
1720 return UtfNormal\Utils::codepointToUtf8( $codepoint );
1722 return UtfNormal\Constants::UTF8_REPLACEMENT;
1735 if ( isset( self::$htmlEntityAliases[
$name] ) ) {
1738 if ( isset( self::$htmlEntities[
$name] ) ) {
1739 return UtfNormal\Utils::codepointToUtf8( self::$htmlEntities[
$name] );
1752 $list = self::setupAttributeWhitelist();
1753 return $list[$element] ?? [];
1764 if ( $whitelist !==
null ) {
1786 # These attributes are specified in section 9 of
1794 # Microdata. These are specified by
1803 $block = array_merge( $common, [
'align' ] );
1804 $tablealign = [
'align',
'valign' ];
1812 'nowrap', # deprecated
1813 'width', # deprecated
1814 'height', # deprecated
1815 'bgcolor', # deprecated
1818 # Numbers refer to sections in HTML 4.01 standard describing the element.
1823 'center' => $common, # deprecated
1842 'strong' => $common,
1853 'blockquote' => array_merge( $common, [
'cite' ] ),
1854 'q' => array_merge( $common, [
'cite' ] ),
1864 'br' => array_merge( $common, [
'clear' ] ),
1870 'pre' => array_merge( $common, [
'width' ] ),
1873 'ins' => array_merge( $common, [
'cite',
'datetime' ] ),
1874 'del' => array_merge( $common, [
'cite',
'datetime' ] ),
1877 'ul' => array_merge( $common, [
'type' ] ),
1878 'ol' => array_merge( $common, [
'type',
'start',
'reversed' ] ),
1879 'li' => array_merge( $common, [
'type',
'value' ] ),
1887 'table' => array_merge( $common,
1888 [
'summary',
'width',
'border',
'frame',
1889 'rules',
'cellspacing',
'cellpadding',
1894 'caption' => $block,
1902 'colgroup' => array_merge( $common, [
'span' ] ),
1903 'col' => array_merge( $common, [
'span' ] ),
1906 'tr' => array_merge( $common, [
'bgcolor' ], $tablealign ),
1909 'td' => array_merge( $common, $tablecell, $tablealign ),
1910 'th' => array_merge( $common, $tablecell, $tablealign ),
1913 # NOTE: <a> is not allowed directly, but the attrib
1914 # whitelist is used from the Parser object
1915 'a' => array_merge( $common, [
'href',
'rel',
'rev' ] ), # rel/rev esp.
for RDFa
1918 # Not usually allowed, but may be used for extension-style hooks
1919 # such as <math> when it is rasterized, or if $wgAllowImageTag is
1921 'img' => array_merge( $common, [
'alt',
'src',
'width',
'height',
'srcset' ] ),
1923 'video' => array_merge( $common, [
'poster',
'controls',
'preload',
'width',
'height' ] ),
1924 'source' => array_merge( $common, [
'type',
'src' ] ),
1925 'track' => array_merge( $common, [
'type',
'src',
'srclang',
'kind',
'label' ] ),
1933 'strike' => $common,
1938 'font' => array_merge( $common, [
'size',
'color',
'face' ] ),
1942 'hr' => array_merge( $common, [
'width' ] ),
1944 # HTML Ruby annotation text module, simple ruby only.
1950 'rt' => $common, # array_merge( $common,
array(
'rbspan' ) ),
1953 # MathML root element, where used for extensions
1954 # 'title' may not be 100% valid here; it's XHTML
1956 'math' => [
'class',
'style',
'id',
'title' ],
1959 'figure' => $common,
1960 'figcaption' => $common,
1962 # HTML 5 section 4.6
1965 # HTML5 elements, defined by:
1967 'data' => array_merge( $common, [
'value' ] ),
1968 'time' => array_merge( $common, [
'datetime' ] ),
1976 'meta' => [
'itemprop',
'content' ],
1977 'link' => [
'itemprop',
'href',
'title' ],
1996 $tokenizer =
new RemexHtml\Tokenizer\Tokenizer(
$handler,
$html, [
1997 'ignoreErrors' =>
true,
1999 'ignoreNulls' =>
true,
2000 'skipPreprocess' =>
true,
2002 $tokenizer->execute();
2005 $text = self::normalizeWhitespace( $text );
2019 $out =
"<!DOCTYPE html [\n";
2020 foreach ( self::$htmlEntities
as $entity => $codepoint ) {
2021 $out .=
"<!ENTITY $entity \"&#$codepoint;\">";
2032 # Normalize any HTML entities in input. They will be
2033 # re-escaped by makeExternalLink().
2034 $url = self::decodeCharReferences( $url );
2036 # Escape any control characters introduced by the above step
2037 $url = preg_replace_callback(
'/[\][<>"\\x00-\\x20\\x7F\|]/',
2038 [ __CLASS__,
'cleanUrlCallback' ], $url );
2040 # Validate hostname portion
2042 if ( preg_match(
'!^([^:]+:)(//[^/]+)?(.*)$!iD', $url,
$matches ) ) {
2049 \\s| # general whitespace
2050 \xc2\xad| # 00ad SOFT HYPHEN
2051 \xe1\xa0\x86| # 1806 MONGOLIAN TODO SOFT HYPHEN
2052 \xe2\x80\x8b| # 200b ZERO WIDTH SPACE
2053 \xe2\x81\xa0| # 2060 WORD JOINER
2054 \xef\xbb\xbf| # feff ZERO WIDTH NO-BREAK SPACE
2055 \xcd\x8f| # 034f COMBINING GRAPHEME JOINER
2056 \xe1\xa0\x8b| # 180b MONGOLIAN FREE VARIATION SELECTOR ONE
2057 \xe1\xa0\x8c| # 180c MONGOLIAN FREE VARIATION SELECTOR TWO
2058 \xe1\xa0\x8d| # 180d MONGOLIAN FREE VARIATION SELECTOR THREE
2059 \xe2\x80\x8c| # 200c ZERO WIDTH NON-JOINER
2060 \xe2\x80\x8d| # 200d ZERO WIDTH JOINER
2061 [\xef\xb8\x80-\xef\xb8\x8f] # fe00-fe0f VARIATION SELECTOR-1-16
2064 $host = preg_replace( $strip,
'', $host );
2067 if ( substr_compare(
"//%5B", $host, 0, 5 ) === 0 &&
2068 preg_match(
'!^//%5B([0-9A-Fa-f:.]+)%5D((:\d+)?)$!', $host,
$matches )
2075 return $protocol . $host . $rest;
2119 if ( !Hooks::run(
'isValidEmailAddr', [ $addr, &
$result ] ) ) {
2126 $rfc5322_atext =
"a-z0-9!#$%&'*+\\-\/=?^_`{|}~";
2127 $rfc1034_ldh_str =
"a-z0-9\\-";
2129 $html5_email_regexp =
"/
2131 [$rfc5322_atext\\.]+ # user part which is liberal :p
2133 [$rfc1034_ldh_str]+ # First domain part
2134 (\\.[$rfc1034_ldh_str]+)* # Following part prefixed with a dot
2138 return (
bool)preg_match( $html5_email_regexp, $addr );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
$wgAllowImageTag
A different approach to the above: simply allow the "<img>" tag to be used.
$wgFragmentMode
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of...
$wgExternalInterwikiFragmentMode
Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragment...
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
HTML sanitizer for MediaWiki.
static fixTagAttributes( $text, $element, $sorted=false)
Take a tag soup fragment listing an HTML element's attributes and normalize it to well-formed XML,...
const CHAR_REFS_REGEX
Regular expression to match various types of character references in Sanitizer::normalizeCharReferenc...
static validateAttributes( $attribs, $whitelist)
Take an array of attribute names and values and normalize or discard illegal values for the given whi...
static decCharReference( $codepoint)
static isReservedDataAttribute( $attr)
Given an attribute name, checks whether it is a reserved data attribute (such as data-mw-foo) which i...
static decodeChar( $codepoint)
Return UTF-8 string for a codepoint if that is a valid character reference, otherwise U+FFFD REPLACEM...
static escapeHtmlAllowEntities( $html)
Given HTML input, escape with htmlspecialchars but un-escape entities.
static getAttribNameRegex()
Used in Sanitizer::decodeTagAttributes to filter attributes.
static checkCss( $value)
Pick apart some CSS and check it for forbidden or unsafe structures.
static decodeEntity( $name)
If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, return the UTF-8 encoding of that chara...
static normalizeEntity( $name)
If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, return the equivalent numeric entity re...
static armorFrenchSpaces( $text, $space=' ')
Armor French spaces with a replacement character.
static getRecognizedTagData( $extratags=[], $removetags=[])
Return the various lists of recognized tags.
static $attribsRegex
Lazy-initialised attributes regex, see getAttribsRegex()
static escapeIdForLink( $id)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid URL...
static removeHTMLcomments( $text)
Remove '', and everything between.
static encodeAttribute( $text)
Encode an attribute value for HTML output.
static hexCharReference( $codepoint)
static validateTagAttributes( $attribs, $element)
Take an array of attribute names and values and normalize or discard illegal values for the given ele...
static escapeClass( $class)
Given a value, escape it so that it can be used as a CSS class and return it.
const EVIL_URI_PATTERN
Blacklist for evil uris like javascript: WARNING: DO NOT use this in any place that actually requires...
static normalizeSectionNameWhitespace( $section)
Normalizes whitespace in a section name, such as might be returned by Parser::stripSectionName(),...
static setupAttributeWhitelist()
Foreach array key (an allowed HTML element), return an array of allowed attributes.
static normalizeCharReferencesCallback( $matches)
static hackDocType()
Hack up a private DOCTYPE with HTML's standard entity declarations.
static cleanUrlCallback( $matches)
static normalizeCharReferences( $text)
Ensure that any entities and character references are legal for XML and XHTML specifically.
static cssDecodeCallback( $matches)
static escapeIdReferenceList( $referenceString)
Given a string containing a space delimited list of ids, escape each id to match ids escaped by the e...
static normalizeWhitespace( $text)
static removeHTMLtags( $text, $processCallback=null, $args=[], $extratags=[], $removetags=[], $warnCallback=null)
Cleans up HTML, removes dangerous tags and attributes, and removes HTML comments.
static getAttribsRegex()
Regular expression to match HTML/XML attribute pairs within a tag.
static validateCodepoint( $codepoint)
Returns true if a given Unicode codepoint is a valid character in both HTML5 and XML.
const ID_FALLBACK
Tells escapeUrlForHtml() to encode the ID using the fallback encoding, or return false if no fallback...
static $htmlEntities
List of all named character entities defined in HTML 4.01 https://www.w3.org/TR/html4/sgml/entities....
static decodeCharReferences( $text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string.
static escapeIdForAttribute( $id, $mode=self::ID_PRIMARY)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid HTM...
static $attribNameRegex
Lazy-initialised attribute name regex, see getAttribNameRegex()
static getTagAttributeCallback( $set)
Pick the appropriate attribute value from a match set from the attribs regex matches.
static escapeIdInternal( $id, $mode)
Helper for escapeIdFor*() functions.
static validateTag( $params, $element)
Takes attribute names and values for a tag and the tag name and validates that the tag is allowed to ...
static stripAllTags( $html)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed,...
static decodeCharReferencesAndNormalize( $text)
Decode any character references, numeric or named entities, in the next and normalize the resulting s...
static $htmlEntityAliases
Character entity aliases accepted by MediaWiki.
static escapeId( $id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it.
static attributeWhitelist( $element)
Fetch the whitelist of acceptable attributes for a given element name.
static decodeCharReferencesCallback( $matches)
static mergeAttributes( $a, $b)
Merge two sets of HTML attributes.
static escapeIdForExternalInterwiki( $id)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid URL...
static validateEmail( $addr)
Does a string look like an e-mail address?
const ID_PRIMARY
Tells escapeUrlForHtml() to encode the ID using the wiki's primary encoding.
const ELEMENT_BITS_REGEX
Acceptable tag name charset from HTML5 parsing spec https://www.w3.org/TR/html5/syntax....
static safeEncodeAttribute( $text)
Encode an attribute value for HTML tags, with extra armoring against further wiki processing.
const XMLNS_ATTRIBUTE_PATTERN
static normalizeCss( $value)
Normalize CSS into a format we can easily search for hostile input.
static delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags='')
Perform an operation equivalent to preg_replace() with flags.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing them
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
null for the local wiki Added in
you don t have to do a grep find to see where the $wgReverseTitle variable is used
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Allows to change the fields on the form that will be generated $name
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))