Linux multi-monitor fullscreen support

[ryzomcore.git] / web / public_php / webtt / cake / libs / sanitize.php

<?php
/**
 * Washes strings from unwanted noise.
 *
 * Helpful methods to make unsafe strings usable.
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @package       cake
 * @subpackage    cake.cake.libs
 * @since         CakePHP(tm) v 0.10.0.1076
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

/**
 * Data Sanitization.
 *
 * Removal of alpahnumeric characters, SQL-safe slash-added strings, HTML-friendly strings,
 * and all of the above on arrays.
 *
 * @package       cake
 * @subpackage    cake.cake.libs
 */
class Sanitize {

/**
 * Removes any non-alphanumeric characters.
 *
 * @param string $string String to sanitize
 * @param array $allowed An array of additional characters that are not to be removed.
 * @return string Sanitized string
 * @access public
 * @static
 */
        function paranoid($string, $allowed = array()) {
                $allow = null;
                if (!empty($allowed)) {
                        foreach ($allowed as $value) {
                                $allow .= "\\$value";
                        }
                }

                if (is_array($string)) {
                        $cleaned = array();
                        foreach ($string as $key => $clean) {
                                $cleaned[$key] = preg_replace("/[^{$allow}a-zA-Z0-9]/", '', $clean);
                        }
                } else {
                        $cleaned = preg_replace("/[^{$allow}a-zA-Z0-9]/", '', $string);
                }
                return $cleaned;
        }

/**
 * Makes a string SQL-safe.
 *
 * @param string $string String to sanitize
 * @param string $connection Database connection being used
 * @return string SQL safe string
 * @access public
 * @static
 */
        function escape($string, $connection = 'default') {
                $db =& ConnectionManager::getDataSource($connection);
                if (is_numeric($string) || $string === null || is_bool($string)) {
                        return $string;
                }
                $string = substr($db->value($string), 1);
                $string = substr($string, 0, -1);
                return $string;
        }

/**
 * Returns given string safe for display as HTML. Renders entities.
 *
 * strip_tags() does not validating HTML syntax or structure, so it might strip whole passages
 * with broken HTML.
 *
 * ### Options:
 *
 * - remove (boolean) if true strips all HTML tags before encoding
 * - charset (string) the charset used to encode the string
 * - quotes (int) see http://php.net/manual/en/function.htmlentities.php
 *
 * @param string $string String from where to strip tags
 * @param array $options Array of options to use.
 * @return string Sanitized string
 * @access public
 * @static
 */
        function html($string, $options = array()) {
                static $defaultCharset = false;
                if ($defaultCharset === false) {
                        $defaultCharset = Configure::read('App.encoding');
                        if ($defaultCharset === null) {
                                $defaultCharset = 'UTF-8';
                        }
                }
                $default = array(
                        'remove' => false,
                        'charset' => $defaultCharset,
                        'quotes' => ENT_QUOTES
                );

                $options = array_merge($default, $options);

                if ($options['remove']) {
                        $string = strip_tags($string);
                }

                return htmlentities($string, $options['quotes'], $options['charset']);
        }

/**
 * Strips extra whitespace from output
 *
 * @param string $str String to sanitize
 * @return string whitespace sanitized string
 * @access public
 * @static
 */
        function stripWhitespace($str) {
                $r = preg_replace('/[\n\r\t]+/', '', $str);
                return preg_replace('/\s{2,}/', ' ', $r);
        }

/**
 * Strips image tags from output
 *
 * @param string $str String to sanitize
 * @return string Sting with images stripped.
 * @access public
 * @static
 */
        function stripImages($str) {
                $str = preg_replace('/(<a[^>]*>)(<img[^>]+alt=")([^"]*)("[^>]*>)(<\/a>)/i', '$1$3$5<br />', $str);
                $str = preg_replace('/(<img[^>]+alt=")([^"]*)("[^>]*>)/i', '$2<br />', $str);
                $str = preg_replace('/<img[^>]*>/i', '', $str);
                return $str;
        }

/**
 * Strips scripts and stylesheets from output
 *
 * @param string $str String to sanitize
 * @return string String with <script>, <style>, <link> elements removed.
 * @access public
 * @static
 */
        function stripScripts($str) {
                return preg_replace('/(<link[^>]+rel="[^"]*stylesheet"[^>]*>|<img[^>]*>|style="[^"]*")|<script[^>]*>.*?<\/script>|<style[^>]*>.*?<\/style>|<!--.*?-->/is', '', $str);
        }

/**
 * Strips extra whitespace, images, scripts and stylesheets from output
 *
 * @param string $str String to sanitize
 * @return string sanitized string
 * @access public
 */
        function stripAll($str) {
                $str = Sanitize::stripWhitespace($str);
                $str = Sanitize::stripImages($str);
                $str = Sanitize::stripScripts($str);
                return $str;
        }

/**
 * Strips the specified tags from output. First parameter is string from
 * where to remove tags. All subsequent parameters are tags.
 *
 * Ex.`$clean = Sanitize::stripTags($dirty, 'b', 'p', 'div');`
 *
 * Will remove all `<b>`, `<p>`, and `<div>` tags from the $dirty string.
 *
 * @param string $str String to sanitize
 * @param string $tag Tag to remove (add more parameters as needed)
 * @return string sanitized String
 * @access public
 * @static
 */
        function stripTags() {
                $params = params(func_get_args());
                $str = $params[0];

                for ($i = 1, $count = count($params); $i < $count; $i++) {
                        $str = preg_replace('/<' . $params[$i] . '\b[^>]*>/i', '', $str);
                        $str = preg_replace('/<\/' . $params[$i] . '[^>]*>/i', '', $str);
                }
                return $str;
        }

/**
 * Sanitizes given array or value for safe input. Use the options to specify
 * the connection to use, and what filters should be applied (with a boolean
 * value). Valid filters:
 *
 * - odd_spaces - removes any non space whitespace characters
 * - encode - Encode any html entities. Encode must be true for the `remove_html` to work.
 * - dollar - Escape `$` with `\$`
 * - carriage - Remove `\r`
 * - unicode -
 * - escape - Should the string be SQL escaped.
 * - backslash -
 * - remove_html - Strip HTML with strip_tags. `encode` must be true for this option to work.
 *
 * @param mixed $data Data to sanitize
 * @param mixed $options If string, DB connection being used, otherwise set of options
 * @return mixed Sanitized data
 * @access public
 * @static
 */
        function clean($data, $options = array()) {
                if (empty($data)) {
                        return $data;
                }

                if (is_string($options)) {
                        $options = array('connection' => $options);
                } else if (!is_array($options)) {
                        $options = array();
                }

                $options = array_merge(array(
                        'connection' => 'default',
                        'odd_spaces' => true,
                        'remove_html' => false,
                        'encode' => true,
                        'dollar' => true,
                        'carriage' => true,
                        'unicode' => true,
                        'escape' => true,
                        'backslash' => true
                ), $options);

                if (is_array($data)) {
                        foreach ($data as $key => $val) {
                                $data[$key] = Sanitize::clean($val, $options);
                        }
                        return $data;
                } else {
                        if ($options['odd_spaces']) {
                                $data = str_replace(chr(0xCA), '', str_replace(' ', ' ', $data));
                        }
                        if ($options['encode']) {
                                $data = Sanitize::html($data, array('remove' => $options['remove_html']));
                        }
                        if ($options['dollar']) {
                                $data = str_replace("\\\$", "$", $data);
                        }
                        if ($options['carriage']) {
                                $data = str_replace("\r", "", $data);
                        }

                        $data = str_replace("'", "'", str_replace("!", "!", $data));

                        if ($options['unicode']) {
                                $data = preg_replace("/&amp;#([0-9]+);/s", "&#\\1;", $data);
                        }
                        if ($options['escape']) {
                                $data = Sanitize::escape($data, $options['connection']);
                        }
                        if ($options['backslash']) {
                                $data = preg_replace("/\\\(?!&amp;#|\?#)/", "\\", $data);
                        }
                        return $data;
                }
        }

/**
 * Formats column data from definition in DBO's $columns array
 *
 * @param Model $model The model containing the data to be formatted
 * @access public
 * @static
 */
        function formatColumns(&$model) {
                foreach ($model->data as $name => $values) {
                        if ($name == $model->alias) {
                                $curModel =& $model;
                        } elseif (isset($model->{$name}) && is_object($model->{$name}) && is_subclass_of($model->{$name}, 'Model')) {
                                $curModel =& $model->{$name};
                        } else {
                                $curModel = null;
                        }

                        if ($curModel != null) {
                                foreach ($values as $column => $data) {
                                        $colType = $curModel->getColumnType($column);

                                        if ($colType != null) {
                                                $db =& ConnectionManager::getDataSource($curModel->useDbConfig);
                                                $colData = $db->columns[$colType];

                                                if (isset($colData['limit']) && strlen(strval($data)) > $colData['limit']) {
                                                        $data = substr(strval($data), 0, $colData['limit']);
                                                }

                                                if (isset($colData['formatter']) || isset($colData['format'])) {

                                                        switch (strtolower($colData['formatter'])) {
                                                                case 'date':
                                                                        $data = date($colData['format'], strtotime($data));
                                                                break;
                                                                case 'sprintf':
                                                                        $data = sprintf($colData['format'], $data);
                                                                break;
                                                                case 'intval':
                                                                        $data = intval($data);
                                                                break;
                                                                case 'floatval':
                                                                        $data = floatval($data);
                                                                break;
                                                        }
                                                }
                                                $model->data[$name][$column]=$data;
                                                /*
                                                switch ($colType) {
                                                        case 'integer':
                                                        case 'int':
                                                                return  $data;
                                                        break;
                                                        case 'string':
                                                        case 'text':
                                                        case 'binary':
                                                        case 'date':
                                                        case 'time':
                                                        case 'datetime':
                                                        case 'timestamp':
                                                        case 'date':
                                                                return "'" . $data . "'";
                                                        break;
                                                }
                                                */
                                        }
                                }
                        }
                }
        }
}