public function testIsValidV4Or6()
{
$this->assertTrue(CIp::isValidV4Or6("12.34.56.78"));
$this->assertTrue(CIp::isValidV4Or6("0:0:0:0:0:FFFF:5DB8:D877"));
$this->assertTrue(CIp::isValidV4Or6("12.34.56.78", CIp::DISALLOW_PRIVATE_RANGE));
$this->assertFalse(CIp::isValidV4Or6("172.16.0.0", CIp::DISALLOW_PRIVATE_RANGE));
$this->assertTrue(CIp::isValidV4Or6("0:0:0:0:0:FFFF:5DB8:D877", CIp::DISALLOW_PRIVATE_RANGE));
$this->assertFalse(CIp::isValidV4Or6("FD:0:0:0:0:FFFF:5DB8:D877", CIp::DISALLOW_PRIVATE_RANGE));
}
/**
* Composes a URL string from specified URL parts and returns it.
*
* If the URL string needs to be normalized after having been composed, you can use `normalize` static method for
* that.
*
* @param string $host The host part. This includes the domain and the subdomains, if any.
* @param string $protocol **OPTIONAL. Default is** "http". The protocol.
* @param string|CUrlPath $path **OPTIONAL. Default is** "/". The path. Should start with "/".
* @param string|CUrlQuery $query **OPTIONAL. Default is** *none*. The query.
* @param string $fragmentId **OPTIONAL. Default is** *none*. The fragment ID.
* @param int $port **OPTIONAL. Default is** *none*. The number of the destination port.
* @param string $user **OPTIONAL. Default is** *none*. The user name.
* @param string $password **OPTIONAL. Default is** *none*. The password.
*
* @return CUStringObject The composed URL string.
*
* @link #method_normalize normalize
*/
public static function makeUrlString($host, $protocol = self::DEFAULT_PROTOCOL, $path = null, $query = null, $fragmentId = null, $port = null, $user = null, $password = null)
{
assert('is_cstring($host) && is_cstring($protocol) && ' . '(!isset($path) || is_cstring($path) || $path instanceof CUrlPath) && ' . '(!isset($query) || is_cstring($query) || $query instanceof CUrlQuery) && ' . '(!isset($fragmentId) || is_cstring($fragmentId)) && (!isset($port) || is_int($port)) && ' . '(!isset($user) || is_cstring($user)) && (!isset($password) || is_cstring($password))', vs(isset($this), get_defined_vars()));
$url = "";
// Protocol.
$url .= "{$protocol}://";
// User and password.
if (isset($user)) {
$url .= $user;
}
if (isset($password)) {
$url .= ":{$password}";
}
if (isset($user) || isset($password)) {
$url .= "@";
}
// Host.
if (!CIp::isValidV6($host)) {
$url .= $host;
} else {
$url .= "[{$host}]";
}
// Port.
if (isset($port)) {
$url .= ":{$port}";
}
// Path.
if (!isset($path)) {
$url .= "/";
} else {
if (is_cstring($path)) {
assert('CString::startsWith($path, "/")', vs(isset($this), get_defined_vars()));
$url .= $path;
} else {
$url .= $path->pathString();
}
}
// Query string.
if (isset($query)) {
$queryString;
if (is_cstring($query)) {
$queryString = $query;
} else {
$queryString = $query->queryString(false);
}
$url .= "?{$queryString}";
}
// Fragment ID.
if (isset($fragmentId)) {
$url .= "#{$fragmentId}";
}
return $url;
}
/**
* Filters a string or a collection of strings according to the expected output type(s) and returns the output
* value(s).
*
* @param mixed $inputStringOrDecodedCollection The string to be filtered or the array or map containing the
* strings to be filtered. If the parameter's value is a JSON-encoded string, the output value is going to be
* either an array or map.
* @param reference $success **OUTPUT.** After the method is called, the value of this parameter tells whether
* the filtering was successful.
*
* @return mixed The output value or a collection of values of the expected type(s) after having been put through
* the filter.
*/
public function filter($inputStringOrDecodedCollection, &$success)
{
assert('is_cstring($inputStringOrDecodedCollection) || is_collection($inputStringOrDecodedCollection)', vs(isset($this), get_defined_vars()));
$success = true;
if ($this->m_expectedType != self::CARRAY && $this->m_expectedType != self::CMAP) {
// The expected output type is not a collection; the input value must be of string type.
if (!is_cstring($inputStringOrDecodedCollection)) {
$success = false;
return oop_x($this->m_defaultValue);
}
$inputString = $inputStringOrDecodedCollection;
if ($this->m_expectedType == self::BOOL || $this->m_expectedType == self::INT || $this->m_expectedType == self::FLOAT || $this->m_expectedType == self::EMAIL || $this->m_expectedType == self::URL || $this->m_expectedType == self::IP) {
// Trim the input string on both sides from whitespace, including Unicode whitespace and control
// characters.
$trimmingSubjectRe = CUString::TRIMMING_AND_SPACING_NORM_SUBJECT_RE;
$inputString = CRegex::remove($inputString, "/^({$trimmingSubjectRe})+|({$trimmingSubjectRe})+\\z/u");
}
// Pre-process the string for integer and floating-point types.
$looksLikeHex;
if ($this->m_expectedType == self::INT || $this->m_expectedType == self::FLOAT) {
if (CString::startsWith($inputString, "+")) {
// Remove the plus sign.
$inputString = CString::substr($inputString, 1);
}
$looksLikeHex = CRegex::find($inputString, "/^-?0x/i");
if ($this->m_allowLeadingZeros && !($this->m_expectedType == self::INT && $this->m_allowHex && $looksLikeHex)) {
// Remove any leading zeros (except for special cases).
$inputString = CRegex::replace($inputString, "/^(\\D*)0*(?!\\b)/", "\$1");
}
if ($this->m_allowComma) {
$inputString = CRegex::remove($inputString, "/,(?=\\d{3}\\b)/");
}
}
// Validate and sanitize the value according to its expected type.
if ($this->m_expectedType == self::BOOL) {
if (!CRegex::find($inputString, "/^(1|true|yes|on|0|false|no|off)\\z/i")) {
$success = false;
return $this->m_defaultValue;
}
return CString::equals($inputString, "1") || CString::equalsCi($inputString, "true") || CString::equalsCi($inputString, "yes") || CString::equalsCi($inputString, "on");
}
if ($this->m_expectedType == self::INT) {
$value;
if (!($this->m_allowHex && $looksLikeHex)) {
// Regular.
if (!CRegex::find($inputString, "/^-?(?!0(?!\\b))\\d+\\z/")) {
$success = false;
return $this->m_defaultValue;
}
$value = CString::toInt($inputString);
} else {
// Hex.
if (!CRegex::find($inputString, "/^-?0x[0-9A-F]+\\z/i")) {
$success = false;
return $this->m_defaultValue;
}
$value = CString::toIntFromHex($inputString);
}
if (isset($this->m_intValidMin) && $value < $this->m_intValidMin || isset($this->m_intValidMax) && $value > $this->m_intValidMax) {
$success = false;
return $this->m_defaultValue;
}
if (isset($this->m_intClampingMin) && $value < $this->m_intClampingMin) {
$value = $this->m_intClampingMin;
}
if (isset($this->m_intClampingMax) && $value > $this->m_intClampingMax) {
$value = $this->m_intClampingMax;
}
return $value;
}
if ($this->m_expectedType == self::FLOAT) {
if (!CRegex::find($inputString, "/^-?(?!0(?!\\b))\\d*\\.?\\d+(e[\\-+]?\\d+)?\\z/i")) {
$success = false;
return $this->m_defaultValue;
}
$value = CString::toFloat($inputString);
if (isset($this->m_floatValidMin) && $value < $this->m_floatValidMin || isset($this->m_floatValidMax) && $value > $this->m_floatValidMax) {
$success = false;
return $this->m_defaultValue;
}
if (isset($this->m_floatClampingMin) && $value < $this->m_floatClampingMin) {
$value = $this->m_floatClampingMin;
}
if (isset($this->m_floatClampingMax) && $value > $this->m_floatClampingMax) {
$value = $this->m_floatClampingMax;
}
return $value;
}
if ($this->m_expectedType == self::CSTRING) {
$value = $inputString;
if (!CString::isValid($value)) {
$success = false;
return $this->m_defaultValue;
}
if (!$this->m_keepAbnormalNewlines) {
$value = CString::normNewlines($value);
}
if (!$this->m_keepNonPrintable) {
if (!$this->m_keepTabsAndNewlines) {
$value = CRegex::remove($value, "/[\\x00-\\x1F\\x7F-\\xFF]/");
} else {
$value = CRegex::remove($value, "/[\\x00-\\x1F\\x7F-\\xFF](?<![\\x09\\x0A\\x0D])/");
}
} else {
if (!$this->m_keepTabsAndNewlines) {
$value = CRegex::remove($value, "/[\\x09\\x0A\\x0D]/");
}
}
if (!$this->m_keepSideSpacing) {
$value = CString::trim($value);
}
if (!$this->m_keepExtraSpacing) {
$value = CString::normSpacing($value);
}
return $value;
}
if ($this->m_expectedType == self::CUSTRING) {
$value = $inputString;
if (!CUString::isValid($value)) {
$success = false;
return $this->m_defaultValue;
}
if (!$this->m_keepAbnormalNewlines) {
$value = CUString::normNewlines($value);
}
if (!$this->m_keepNonPrintable) {
if (!$this->m_keepTabsAndNewlines) {
$value = CRegex::remove($value, "/\\p{C}|\\p{Zl}|\\p{Zp}/u");
} else {
$value = CRegex::remove($value, "/\\p{C}(?<!\\x{0009}|\\x{000A}|\\x{000D})/u");
}
} else {
if (!$this->m_keepTabsAndNewlines) {
$value = CRegex::remove($value, "/\\x{0009}|\\x{000A}|\\x{000D}|\\p{Zl}|\\p{Zp}/u");
}
}
if (!$this->m_keepSideSpacing) {
$value = CUString::trim($value);
}
if (!$this->m_keepExtraSpacing) {
$value = CUString::normSpacing($value);
}
return $value;
}
if ($this->m_expectedType == self::EMAIL) {
$value = filter_var($inputString, FILTER_VALIDATE_EMAIL);
if (!is_cstring($value)) {
$success = false;
return $this->m_defaultValue;
}
return $value;
}
if ($this->m_expectedType == self::URL) {
$value = $inputString;
if (!CUrl::isValid($value, $this->m_ignoreProtocolAbsence)) {
$success = false;
return $this->m_defaultValue;
}
if ($this->m_ignoreProtocolAbsence) {
$value = CUrl::ensureProtocol($value);
}
return $value;
}
if ($this->m_expectedType == self::IP) {
$value = $inputString;
$options = CBitField::ALL_UNSET;
if (!$this->m_allowPrivateRange) {
$options |= CIp::DISALLOW_PRIVATE_RANGE;
}
if (!$this->m_allowReservedRange) {
$options |= CIp::DISALLOW_RESERVED_RANGE;
}
$isValid;
if (!$this->m_ipV6 && !$this->m_ipV4OrV6) {
$isValid = CIp::isValidV4($value, $options);
} else {
if (!$this->m_ipV4OrV6) {
$isValid = CIp::isValidV6($value, $options);
} else {
$isValid = CIp::isValidV4($value, $options) || CIp::isValidV6($value, $options);
}
}
if (!$isValid) {
$success = false;
return $this->m_defaultValue;
}
return $value;
}
} else {
if ($this->m_expectedType == self::CARRAY) {
if (!is_cstring($inputStringOrDecodedCollection) && !is_carray($inputStringOrDecodedCollection)) {
$success = false;
return oop_x($this->m_defaultValue);
}
$value;
if (is_cstring($inputStringOrDecodedCollection)) {
// Assume JSON format for the input string.
$json = new CJson($inputStringOrDecodedCollection, $this->m_jsonStrictness);
$value = $json->decode($success);
if (!$success) {
return oop_x($this->m_defaultValue);
}
if (!is_carray($value)) {
$success = false;
return oop_x($this->m_defaultValue);
}
} else {
$value = $inputStringOrDecodedCollection;
}
$value = self::recurseCollectionFiltering($value, $this->m_collectionInputFilters, $success, 0);
if (!$success) {
return oop_x($this->m_defaultValue);
}
return $value;
} else {
if (!is_cstring($inputStringOrDecodedCollection) && !is_cmap($inputStringOrDecodedCollection)) {
$success = false;
return oop_x($this->m_defaultValue);
}
$value;
if (is_cstring($inputStringOrDecodedCollection)) {
// Assume JSON format for the input string.
$json = new CJson($inputStringOrDecodedCollection, $this->m_jsonStrictness);
$value = $json->decode($success);
if (!$success) {
return oop_x($this->m_defaultValue);
}
if (!is_cmap($value)) {
$success = false;
return oop_x($this->m_defaultValue);
}
} else {
$value = $inputStringOrDecodedCollection;
}
$value = self::recurseCollectionFiltering($value, $this->m_collectionInputFilters, $success, 0);
if (!$success) {
return oop_x($this->m_defaultValue);
}
return $value;
}
}
}
