Validates a host according to the IPv4, IPv6 and DNS (future) specifications. More...

Inheritance diagram for HTMLPurifier_AttrDef_URI_Host:

Collaboration diagram for HTMLPurifier_AttrDef_URI_Host:

Public Member Functions
	__construct ()

	validate ($string, $config, $context)

Public Member Functions inherited from HTMLPurifier_AttrDef
	validate ($string, $config, $context)
	Validates and cleans passed string according to a definition. More...

	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA. More...

	make ($string)
	Factory method for creating this class from a string. More...

Protected Attributes
	$ipv4
	IPv4 sub-validator. More...

	$ipv6
	IPv6 sub-validator. More...

Additional Inherited Members
Data Fields inherited from HTMLPurifier_AttrDef
	$minimized = false
	Tells us whether or not an HTML attribute is minimized. More...

	$required = false
	Tells us whether or not an HTML attribute is required. More...

Protected Member Functions inherited from HTMLPurifier_AttrDef
	mungeRgb ($string)
	Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. More...

	expandCSSEscape ($string)
	Parses a possibly escaped CSS string and returns the "pure" version of it. More...

Detailed Description

Validates a host according to the IPv4, IPv6 and DNS (future) specifications.

Definition at line 6 of file Host.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_AttrDef_URI_Host::__construct ( )

Definition at line 21 of file Host.php.

     {
         $this->ipv4 = new HTMLPurifier_AttrDef_URI_IPv4();
         $this->ipv6 = new HTMLPurifier_AttrDef_URI_IPv6();
     }

Member Function Documentation

◆ validate()

HTMLPurifier_AttrDef_URI_Host::validate	(	$string,
		$config,
		$context
	)

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool|string

Definition at line 33 of file Host.php.

References $ipv4, and $valid.

     {
         $length = strlen($string);
         // empty hostname is OK; it's usually semantically equivalent:
         // the default host as defined by a URI scheme is used:
         //
         //      If the URI scheme defines a default for host, then that
         //      default applies when the host subcomponent is undefined
         //      or when the registered name is empty (zero length).
         if ($string === '') {
             return '';
         }
         if ($length > 1 && $string[0] === '[' && $string[$length - 1] === ']') {
             //IPv6
             $ip = substr($string, 1, $length - 2);
             $valid = $this->ipv6->validate($ip, $config, $context);
             if ($valid === false) {
                 return false;
             }
             return '[' . $valid . ']';
         }
 
         // need to do checks on unusual encodings too
         $ipv4 = $this->ipv4->validate($string, $config, $context);
         if ($ipv4 !== false) {
             return $ipv4;
         }
 
         // A regular domain name.
 
         // This doesn't match I18N domain names, but we don't have proper IRI support,
         // so force users to insert Punycode.
 
         // There is not a good sense in which underscores should be
         // allowed, since it's technically not! (And if you go as
         // far to allow everything as specified by the DNS spec...
         // well, that's literally everything, modulo some space limits
         // for the components and the overall name (which, by the way,
         // we are NOT checking!).  So we (arbitrarily) decide this:
         // let's allow underscores wherever we would have allowed
         // hyphens, if they are enabled.  This is a pretty good match
         // for browser behavior, for example, a large number of browsers
         // cannot handle foo_.example.com, but foo_bar.example.com is
         // fairly well supported.
         $underscore = $config->get('Core.AllowHostnameUnderscore') ? '_' : '';
 
         // The productions describing this are:
         $a   = '[a-z]';     // alpha
         $an  = '[a-z0-9]';  // alphanum
         $and = "[a-z0-9-$underscore]"; // alphanum | "-"
         // domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum
         $domainlabel = "$an($and*$an)?";
         // toplabel    = alpha | alpha *( alphanum | "-" ) alphanum
         $toplabel = "$a($and*$an)?";
         // hostname    = *( domainlabel "." ) toplabel [ "." ]
         if (preg_match("/^($domainlabel\.)*$toplabel\.?$/i", $string)) {
             return $string;
         }
 
         // If we have Net_IDNA2 support, we can support IRIs by
         // punycoding them. (This is the most portable thing to do,
         // since otherwise we have to assume browsers support
         // mjansen-patch: begin
         if (function_exists('idn_to_ascii')) {
             return idn_to_ascii($string);
             // If we have Net_IDNA2 support, we can support IRIs by
             // punycoding them. (This is the most portable thing to do,
             // since otherwise we have to assume browsers support
         } elseif ($config->get('Core.EnableIDNA')) {
         // mjansen-patch: end
             $idna = new Net_IDNA2(array('encoding' => 'utf8', 'overlong' => false, 'strict' => true));
             // we need to encode each period separately
             $parts = explode('.', $string);
             try {
                 $new_parts = array();
                 foreach ($parts as $part) {
                     $encodable = false;
                     for ($i = 0, $c = strlen($part); $i < $c; $i++) {
                         if (ord($part[$i]) > 0x7a) {
                             $encodable = true;
                             break;
                         }
                     }
                     if (!$encodable) {
                         $new_parts[] = $part;
                     } else {
                         $new_parts[] = $idna->encode($part);
                     }
                 }
                 $string = implode('.', $new_parts);
                 if (preg_match("/^($domainlabel\.)*$toplabel\.?$/i", $string)) {
                     return $string;
                 }
             } catch (Exception $e) {
                 // XXX error reporting
             }
         }
         return false;
     }

Field Documentation

◆ $ipv4

HTMLPurifier_AttrDef_URI_Host::$ipv4

protected

IPv4 sub-validator.

HTMLPurifier_AttrDef_URI_IPv4

Definition at line 13 of file Host.php.

Referenced by validate().

◆ $ipv6

HTMLPurifier_AttrDef_URI_Host::$ipv6

protected

IPv6 sub-validator.

HTMLPurifier_AttrDef_URI_IPv6

Definition at line 19 of file Host.php.

The documentation for this class was generated from the following file:

Services/Html/HtmlPurifier/library/HTMLPurifier/AttrDef/URI/Host.php

Public Member Functions

Protected Attributes

Additional Inherited Members