/usr/share/php/Horde/Variables.php is in php-horde-util 2.5.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 | <?php
/**
* Copyright 2009-2014 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Horde
* @copyright 2009-2014 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Util
*/
/**
* An OO-way to access form variables.
*
* @author Robert E. Coyle <robertecoyle@hotmail.com>
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Michael Slusarz <slusarz@horde.org>
* @category Horde
* @copyright 2009-2014 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Util
*/
class Horde_Variables implements ArrayAccess, Countable, IteratorAggregate
{
/**
* The list of expected variables.
*
* @var array
*/
protected $_expected = array();
/**
* Has the input been sanitized?
*
* @var boolean
*/
protected $_sanitized = false;
/**
* Array of form variables.
*
* @var array
*/
protected $_vars;
/**
* Returns a Horde_Variables object populated with the form input.
*
* @param string $sanitize Sanitize the input variables?
*
* @return Horde_Variables Variables object.
*/
static public function getDefaultVariables($sanitize = false)
{
return new self(null, $sanitize);
}
/**
* Constructor.
*
* @param array $vars The list of form variables (if null, defaults
* to PHP's $_REQUEST value). If '_formvars'
* exists, it must be a JSON encoded array that
* contains the list of allowed form variables.
* @param string $sanitize Sanitize the input variables?
*/
public function __construct($vars = array(), $sanitize = false)
{
if (is_null($vars)) {
$request_copy = $_REQUEST;
$vars = Horde_Util::dispelMagicQuotes($request_copy);
}
if (isset($vars['_formvars'])) {
$this->_expected = @json_decode($vars['_formvars'], true);
unset($vars['_formvars']);
}
$this->_vars = $vars;
if ($sanitize) {
$this->sanitize();
}
}
/**
* Sanitize the form input.
*/
public function sanitize()
{
if (!$this->_sanitized) {
foreach (array_keys($this->_vars) as $key) {
$this->$key = $this->filter($key);
}
$this->_sanitized = true;
}
}
/**
* Alias of isset().
*
* @see __isset()
*/
public function exists($varname)
{
return isset($this->$varname);
}
/**
* isset() implementation.
*
* @param string $varname The form variable name.
*
* @return boolean Does $varname form variable exist?
*/
public function __isset($varname)
{
return count($this->_expected)
? $this->_getExists($this->_expected, $varname, $value)
: $this->_getExists($this->_vars, $varname, $value);
}
/**
* Implements isset() for ArrayAccess interface.
*
* @see __isset()
*/
public function offsetExists($field)
{
return $this->__isset($field);
}
/**
* Returns the value of a given form variable.
*
* @param string $varname The form variable name.
* @param string $default The default form variable value.
*
* @return mixed The form variable, or $default if it doesn't exist.
*/
public function get($varname, $default = null)
{
return $this->_getExists($this->_vars, $varname, $value)
? $value
: $default;
}
/**
* Returns the value of a given form variable.
*
* @param string $varname The form variable name.
*
* @return mixed The form variable, or null if it doesn't exist.
*/
public function __get($varname)
{
$this->_getExists($this->_vars, $varname, $value);
return $value;
}
/**
* Implements getter for ArrayAccess interface.
*
* @see __get()
*/
public function offsetGet($field)
{
return $this->__get($field);
}
/**
* Given a variable name, returns the value and sets a variable indicating
* whether the value exists in the form data.
*
* @param string $varname The form variable name.
* @param boolean &$exists Reference to variable that will indicate
* whether $varname existed in form data.
*
* @return mixed The form variable, or null if it doesn't exist.
*/
public function getExists($varname, &$exists)
{
$exists = $this->_getExists($this->_vars, $varname, $value);
return $value;
}
/**
* Sets the value of a given form variable.
*
* @see __set()
*/
public function set($varname, $value)
{
$this->$varname = $value;
}
/**
* Sets the value of a given form variable.
*
* @param string $varname The form variable name.
* @param mixed $value The value to set.
*/
public function __set($varname, $value)
{
$keys = array();
if (Horde_Array::getArrayParts($varname, $base, $keys)) {
array_unshift($keys, $base);
$place = &$this->_vars;
$i = count($keys);
while ($i--) {
$key = array_shift($keys);
if (!isset($place[$key])) {
$place[$key] = array();
}
$place = &$place[$key];
}
$place = $value;
} else {
$this->_vars[$varname] = $value;
}
}
/**
* Implements setter for ArrayAccess interface.
*
* @see __set()
*/
public function offsetSet($field, $value)
{
$this->__set($field, $value);
}
/**
* Deletes a given form variable.
*
* @see __unset()
*/
public function remove($varname)
{
unset($this->$varname);
}
/**
* Deletes a given form variable.
*
* @param string $varname The form variable name.
*/
public function __unset($varname)
{
Horde_Array::getArrayParts($varname, $base, $keys);
if (is_null($base)) {
unset($this->_vars[$varname]);
} else {
$ptr = &$this->_vars[$base];
$end = count($keys) - 1;
foreach ($keys as $key => $val) {
if (!isset($ptr[$val])) {
break;
}
if ($end == $key) {
array_splice($ptr, array_search($val, array_keys($ptr)), 1);
} else {
$ptr = &$ptr[$val];
}
}
}
}
/**
* Implements unset() for ArrayAccess interface.
*
* @see __unset()
*/
public function offsetUnset($field)
{
$this->__unset($field);
}
/**
* Merges a list of variables into the current form variable list.
*
* @param array $vars Form variables.
*/
public function merge($vars)
{
foreach ($vars as $varname => $value) {
$this->$varname = $value;
}
}
/**
* Set $varname to $value ONLY if it's not already present.
*
* @param string $varname The form variable name.
* @param mixed $value The value to set.
*
* @return boolean True if the value was altered.
*/
public function add($varname, $value)
{
if ($this->exists($varname)) {
return false;
}
$this->_vars[$varname] = $value;
return true;
}
/**
* Filters a form value so that it can be used in HTML output.
*
* @param string $varname The form variable name.
*
* @return mixed The filtered variable, or null if it doesn't exist.
*/
public function filter($varname)
{
$val = $this->$varname;
if (is_null($val) || $this->_sanitized) {
return $val;
}
return is_array($val)
? filter_var_array($val, FILTER_SANITIZE_STRING)
: filter_var($val, FILTER_SANITIZE_STRING);
}
/* Protected methods. */
/**
* Fetch the requested variable ($varname) into $value, and return
* whether or not the variable was set in $array.
*
* @param array $array The array to search in (usually either
* $this->_vars or $this->_expected).
* @param string $varname The name of the variable to look for.
* @param mixed &$value $varname's value gets assigned to this variable.
*
* @return boolean Whether or not the variable was set (or, if we've
* checked $this->_expected, should have been set).
*/
protected function _getExists($array, $varname, &$value)
{
if (Horde_Array::getArrayParts($varname, $base, $keys)) {
if (!isset($array[$base])) {
$value = null;
return false;
}
$searchspace = &$array[$base];
$i = count($keys);
while ($i--) {
$key = array_shift($keys);
if (!isset($searchspace[$key])) {
$value = null;
return false;
}
$searchspace = &$searchspace[$key];
}
$value = $searchspace;
return true;
}
$value = isset($array[$varname])
? $array[$varname]
: null;
return !is_null($value);
}
/* Countable methods. */
/**
*/
public function count()
{
return count($this->_vars);
}
/* IteratorAggregate method. */
public function getIterator()
{
return new ArrayIterator($this->_vars);
}
}
|