Source for file jFilter.class.php

Documentation is available at jFilter.class.php

<?php
/**
* @package jelix
* @subpackage utils
* @author Laurent Jouanneau
* @contributor Julien Issler
* @link http://www.jelix.org
* @licence http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
*/
/**
* utility class to check values
* @package jelix
* @subpackage utils
* @since 1.0b1
*/
class jFilter {
private function _construct() {}
static public function usePhpFilter(){
return true;
}
/**
* check if the given value is an integer
* @param string $val the value
* @param int $min minimum value (optional), null if no minimum
* @param int $max maximum value (optional), null if no maximum
* @return boolean true if it is valid
*/
static public function isInt ($val, $min=null, $max=null){
// @FIXME no doc on the way to use min/max on filters
if(filter_var($val, FILTER_VALIDATE_INT) === false) return false;
if($min !== null && intval($val) < $min) return false;
if($max !== null && intval($val) > $max) return false;
return true;
}
/**
* check if the given value is an hexadecimal integer
* @param string $val the value
* @param int $min minimum value (optional), null if no minimum
* @param int $max maximum value (optional), null if no maximum
* @return boolean true if it is valid
*/
static public function isHexInt ($val, $min=null, $max=null){
// @FIXME no doc on the way to use min/max on filters
if(filter_var($val, FILTER_VALIDATE_INT, FILTER_FLAG_ALLOW_HEX) === false) return false;
if($min !== null && intval($val,16) < $min) return false;
if($max !== null && intval($val,16) > $max) return false;
return true;
}
/**
* check if the given value is a boolean
* @param string $val the value
* @return boolean true if it is valid
*/
static public function isBool ($val){
// we don't use filter_var because it return false when a boolean is "false" or "FALSE" etc..
//return filter_var($val, FILTER_VALIDATE_BOOLEAN);
return in_array($val, array('true','false','1','0','TRUE', 'FALSE','on','off'));
}
/**
* check if the given value is a float
* @param string $val the value
* @param int $min minimum value (optional), null if no minimum
* @param int $max maximum value (optional), null if no maximum
* @return boolean true if it is valid
*/
static public function isFloat ($val, $min=null, $max=null){
// @FIXME no doc on the way to use min/max on filters
if(filter_var($val, FILTER_VALIDATE_FLOAT) === false) return false;
if($min !== null && floatval($val) < $min) return false;
if($max !== null && floatval($val) > $max) return false;
return true;
}
/**
* check if the given value is
* @param string $url the url
* @return boolean true if it is valid
*/
static public function isUrl ($url, $schemeRequired=false,
$hostRequired=false, $pathRequired=false,
$queryRequired=false ){
/*
FIXME php 5.3
because of a bug in filter_var (error when no scheme even if there isn't
FILTER_FLAG_SCHEME_REQUIRED flag), we don't use filter_var here
$flag=0;
if($schemeRequired) $flag |= FILTER_FLAG_SCHEME_REQUIRED;
if($hostRequired) $flag |= FILTER_FLAG_HOST_REQUIRED;
if($pathRequired) $flag |= FILTER_FLAG_PATH_REQUIRED;
if($queryRequired) $flag |= FILTER_FLAG_QUERY_REQUIRED;
return filter_var($url, FILTER_VALIDATE_URL, $flag);
*/
// php filter use in fact parse_url, so we use the same function to have same result.
// however, note that it doesn't validate all bad url...
$res = @parse_url($url);
if($res === false) return false;
if($schemeRequired && !isset($res['scheme'])) return false;
if($hostRequired && !isset($res['host'])) return false;
if($pathRequired && !isset($res['path'])) return false;
if($queryRequired && !isset($res['query'])) return false;
return true;
}
/**
* check if the given value is an IP version 4
* @param string $val the value
* @return boolean true if it is valid
*/
static public function isIPv4 ($val){
return filter_var($val, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false;
}
/**
* check if the given value is an IP version 6
* @param string $val the value
* @return boolean true if it is valid
*/
static public function isIPv6 ($val){
return filter_var($val, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false;
}
/**
* check if the given value is an email
* @param string $val the value
* @return boolean true if it is valid
*/
static public function isEmail ($val){
return filter_var($val, FILTER_VALIDATE_EMAIL) !== false;
}
const INVALID_HTML = 1;
const BAD_SAVE_HTML = 2;
/**
* remove all javascript things in a html content
* The html content should be a subtree of a body tag, not a whole document
* @param string $html html content
* @return string the cleaned html content
* @since 1.1
*/
static public function cleanHtml($html, $isXhtml = false) {
$charset = jApp::config()->charset;
$doc = new DOMDocument('1.0',$charset);
$foot = '</body></html>';
if (strpos($html, "\r") !== false) {
$html = str_replace("\r\n", "\n", $html); // removed \r
$html = str_replace("\r", "\n", $html); // removed standalone \r
}
/*if($isXhtml) {
$head = '<?xml version="1.0" encoding=""?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset='.$charset.'"/><title></title></head><body>';
if(!$doc->loadXML($head.$html.$foot)) {
return 1;
}
}else{*/
$head = '<html><head><meta http-equiv="Content-Type" content="text/html; charset='.$charset.'"/><title></title></head><body>';
if(!@$doc->loadHTML($head.$html.$foot)) {
return jFilter::INVALID_HTML;
}
//}
$items = $doc->getElementsByTagName('script');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('applet');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('base');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('basefont');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('frame');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('frameset');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('noframes');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('isindex');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('iframe');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
$items = $doc->getElementsByTagName('noscript');
foreach ($items as $item) {
$item->parentNode->removeChild($item);
}
self::cleanAttr($doc->getElementsByTagName('body')->item(0));
$doc->formatOutput = true;
if ($isXhtml) {
$result = $doc->saveXML();
}
else {
$result = $doc->saveHTML();
}
if(!preg_match('!<body>(.*)</body>!smU', $result, $m))
return jFilter::BAD_SAVE_HTML;
return $m[1];
}
static protected function cleanAttr($node) {
$child=$node->firstChild;
while($child) {
if($child->nodeType == XML_ELEMENT_NODE) {
$attrs = $child->attributes;
foreach($attrs as $attr) {
if(strtolower(substr($attr->localName,0,2)) == 'on')
$child->removeAttributeNode($attr);
else if(strtolower($attr->localName) == 'href') {
if(preg_match("/^([a-z\-]+)\:.*/i",trim($attr->nodeValue), $m)) {
if(!preg_match('/^http|https|mailto|ftp|irc|about|news/i', $m[1]))
$child->removeAttributeNode($attr);
}
}
}
self::cleanAttr($child);
}
$child = $child->nextSibling;
}
}
}

Documentation generated on Wed, 04 Jan 2017 22:54:10 +0100 by phpDocumentor 1.4.3