File Source for FormUtil.class.php

<?php
/**
* Zikula Application Framework
*
* @copyright Robert Gasch
* @link http://www.zikula.org
* @version $Id: FormUtil.class.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Robert Gasch rgasch@gmail.com
* @package Zikula_Core
* @subpackage FormUtil
*/
/**
* FormUtil
*
* @package Zikula_Core
* @subpackage FormUtil
*/
class FormUtil
{
/**
* Return the requested key from input in a safe way. This function
* is safe to use for recursive arrays and either returns a non-empty
* string or the (optional) default.
*
* This method is based on pnVarCleanFromInput but array-safe.
*
* @param key The field to return
* @param default The value to return if the requested field is not found (optional) (default=false)
* @param source The sourc field to get a parameter from
*
* @return The requested input key or the specified default
*/
function getPassedValue ($key, $default=null, $source=null)
{
if (!$key) {
return pn_exit ('Empty key passed to FormUtil::getPassedValueSafe() ...');
}
static $cache = array();
$source = strtoupper($source);
$src = ($source ? $source : 'REQUEST') . '_' . ($default != null ? $default : 'null');
if (!defined('_PNINSTALLVER') && isset($cache[$src][$key])) {
return $cache[$src][$key];
}
$doClean = false;
switch (true)
{
case (isset($_REQUEST[$key]) && !isset($_FILES[$key]) && (!$source || $source=='R' || $source=='REQUEST')):
$value = $_REQUEST[$key];
$doClean = true;
break;
case isset($_GET[$key]) && (!$source || $source=='G' || $source=='GET'):
$value = $_GET[$key];
$doClean = true;
break;
case isset($_POST[$key]) && (!$source || $source=='P' || $source=='POST'):
$value = $_POST[$key];
$doClean = true;
break;
case isset($_COOKIE[$key]) && (!$source || $source=='C' || $source=='COOKIE'):
$value = $_COOKIE[$key];
$doClean = true;
break;
case isset($_FILES[$key]) && ($source=='F' || $source=='FILES'):
$value = $_FILES[$key];
break;
case (isset($_GET[$key]) || isset($_POST[$key])) && ($source=='GP' || $source=='GETPOST'):
if (isset($_GET[$key])) {
$value = $_GET[$key];
}
if (isset($_POST[$key])) {
$value = $_POST[$key];
}
$doClean = true;
break;
default:
if ($source) {
static $valid = array ('R', 'REQUEST', 'G', 'GET', 'P', 'POST', 'C', 'COOKIE', 'F', 'FILES', 'GP', 'GETPOST');
if (!in_array($source, $valid)) {
pn_exit ('Invalid input source [' . DataUtil::formatForDisplay($source) . '] received ...');
return $default;
}
}
}
if (isset($value) && !is_null($value))
{
if (is_array($value)) {
FormUtil::cleanArray ($value);
}
else
{
static $alwaysclean = array('name', 'module', 'type', 'file', 'authid');
if (in_array($key, $alwaysclean)) {
$doClean = true;
}
if ($doClean && !defined('_PNINSTALLVER')) {
FormUtil::cleanValue ($value);
}
}
$cache[$src][$key] = $value;
return $value;
}
$cache[$src][$key] = $default;
return $default;
}
/**
* Clean an array acquired from input. This method is safe to use for recursive arrays
* and cleans the array in place as well as returning it.
*
* @param array The array to clean up
*
* @return The the altered/cleaned data array.
*/
function cleanArray (&$array)
{
if (!is_array($array)) {
return pn_exit ('Non-array passed to FormUtil::cleanArray () ...');
}
$ak = array_keys ($array);
$kc = count($ak);
for ($i=0; $i<$kc; $i++)
{
$key = $ak[$i];
if (is_array($array[$key])) {
FormUtil::cleanArray($array[$key]);
}
else {
FormUtil::cleanValue($array[$key]);
}
}
return $array;
}
/**
* Clean an individual data element in place; cleans the array in place
* as well as returning it.
*
* @param value The value to clean
*
* @return A reference to the original (altered/cleaned) data array
*/
function cleanValue (&$value)
{
static $isAdmin = null;
if ($isAdmin === null)
$isAdmin = SecurityUtil::checkPermission('.*', '.*', ACCESS_ADMIN);
if (!$value) {
return $value;
}
if (get_magic_quotes_gpc()) {
pnStripslashes($value);
}
if (!$isAdmin)
{
static $replace = array();
static $search = array('|</?\s*SCRIPT.*?>|si',
'|</?\s*FRAME.*?>|si',
'|</?\s*OBJECT.*?>|si',
'|</?\s*META.*?>|si',
'|</?\s*APPLET.*?>|si',
'|</?\s*LINK.*?>|si',
'|</?\s*IFRAME.*?>|si',
'|STYLE\s*=\s*"[^"]*"|si');
$value = preg_replace($search, $replace, $value);
}
$value = trim($value);
return $value;
}
/**
* Return a boolean indicating whether the specified field is required
*
* @param validationInfo The plain (non-structured) validation array
* @param field The fieldname
*
* @return A boolean indicating whether or not the specified field is required
*/
function isRequiredField ($validationInfo, $field)
{
if (!$validationInfo) {
return pn_exit ('Empty validationInfo passed to FormUtil::isRequiredField() ...');
}
if (!$field) {
return pn_exit ('Empty fieldname passed to FormUtil::isRequiredField() ...');
}
$rec = $validationInfo[$field];
if (!$rec) {
return false;
}
return $rec[1];
}
/**
* Get the required field marker (or nothing) for the specified field
*
* @param validationInfo The plain (non-structured) validation array
* @param field The fieldname
*
* @return The required field marker or an empty string
*/
function getRequiredFieldMarker ($validationInfo, $field)
{
if (FormUtil::isRequiredField($validationInfo, $field)) {
return _REQUIRED_MARKER;
}
return _MARKER_NONE;
}
/**
* Clear the validation error array
*
* @param objectType The (string) object type
*
* @return nothing
*/
function clearValidationErrors ($objectType=null)
{
if ($objectType) {
if (isset($_SESSION['validationErrors'][$objectType])) {
unset ($_SESSION['validationErrors'][$objectType]);
}
} else {
if (isset($_SESSION['validationErrors'])) {
unset ($_SESSION['validationErrors']);
}
}
}
/**
* Clear the objects which failed validation
*
* @param objectType The (string) object type
*
* @return nothing
*/
function clearValidationFailedObjects ($objectType=null)
{
if ($objectType) {
if (isset($_SESSION['validationFailedObjects'][$objectType])) {
unset ($_SESSION['validationFailedObjects'][$objectType]);
}
} else {
if (isset($_SESSION['validationFailedObjects'])) {
unset ($_SESSION['validationFailedObjects']);
}
}
}
/**
* Get the validation errors
*
* @return The validation error array or null
*/
function getValidationErrors ()
{
static $ve = null;
if (!$ve) {
if (isset($_SESSION['validationErrors']) && is_array($_SESSION['validationErrors'])) {
$ve = $_SESSION['validationErrors'];
unset ($_SESSION['validationErrors']);
}
}
return $ve;
}
/**
* Return the objects which failed validation
*
* @return The validation error array or null
*/
function getFailedValidationObjects ($objectType=null)
{
static $objects = null;
if (!$objects) {
if (isset($_SESSION['validationFailedObjects']) && is_array($_SESSION['validationFailedObjects'])) {
if ($objectType) {
$objects = $_SESSION['validationFailedObjects'][$objectType];
unset ($_SESSION['validationFailedObjects'][$objectType]);
} else {
$objects = $_SESSION['validationFailedObjects'];
unset ($_SESSION['validationFailedObjects']);
}
}
}
return $objects;
}
/**
* Return a boolean indicating whether or not the specified field failed validation
*
* @param objectType The (string) object type
* @param field The fieldname (optional) (default=null)
*
* @return A boolean indicating whether or not the specified field failed validation
*/
function hasValidationErrors ($objectType, $field=null)
{
if (!$objectType) {
return pn_exit ('Empty objectType passed to FormUtil::hasValidationErrors() ...');
}
if (!$field) {
return pn_exit ('Empty field passed to FormUtil::hasValidationErrors() ...');
}
$ve = FormUtil::getValidationErrors ();
return (boolean)($ve[$objectType][$field]);
}
/**
* Get the required field marker (or nothing) for the specified field
*
* @param objectType The (string) object type
* @param field The fieldname
*
* @return The validation error marker or an empty string
*/
function getValidationFieldMarker ($objectType, $field)
{
if (FormUtil::hasValidationErrors($objectType, $field)) {
return _VALIDATION_MARKER;
}
return _MARKER_NONE;
}
/**
* Get the validation error for the specified field
*
* @param objectType The (string) object type
* @param field The fieldname to get the error for
*
* @return The validation error or an empty string
*/
function getValidationError ($objectType, $field)
{
if (!FormUtil::hasValidationErrors($objectType, $field)) {
return '';
}
$ve = FormUtil::getValidationErrors ();
$error = $ve[$objectType][$field];
if ($error) {
$error = ' ' . $error;
}
return $error;
}
/**
* Get the appropriate field marker
*
* @param objectType The (string) object type
* @param validationInfo The plain (non-structured) validation array
* @param field The fieldname
*
* @return The a marker string or an 'nbsp';
*/
function getFieldMarker ($objectType, $validationInfo, $field)
{
if (FormUtil::hasValidationErrors($objectType, $field)) {
return _VALIDATION_MARKER;
}
else
if (FormUtil::isRequiredField($validationInfo, $field)) {
return _REQUIRED_MARKER;
}
return _MARKER_NONE;
}
/**
* Return a newly created pnFormRender instance with the given name
*
* @return The newly created pnFormRender instance.
*/
function newPNForm ($name)
{
Loader::requireOnce('includes/pnForm.php');
return new pnFormRender ($name);
}
}

Source for file FormUtil.class.php