File: Codendi_Request.class.php

package info (click to toggle)
fusionforge 5.3.2%2B20141104-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 60,472 kB
  • sloc: php: 271,846; sql: 36,817; python: 14,575; perl: 6,406; sh: 5,980; xml: 4,294; pascal: 1,411; makefile: 911; cpp: 52; awk: 27
file content (205 lines) | stat: -rw-r--r-- 5,552 bytes parent folder | download | duplicates (3)
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
<?php
/**
 * Copyright (c) Xerox Corporation, Codendi Team, 2001-2009. All rights reserved
 *
 * This file is a part of Fusionforge.
 *
 * Fusionforge is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Fusionforge is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Codendi. If not, see <http://www.gnu.org/licenses/>.
 */

/* abstract */ class Codendi_Request {
	/**
	 * @var array
	 * @access private
	 */
	var $_validated_input;

	/**
	 * @var array
	 * @access private
	 */
	var $_last_access_to_input;

	/**
	 * @var array
	 */
	var $params;

	/**
	 * Constructor
	 */
	function Codendi_Request($params) {
		$this->params = $params;
		$this->_validated_input = array();
		$this->_last_access_to_input = array();
	}

	/**
	 * Get the value of $variable in $this->params (user submitted values).
	 *
	 * @param string $variable Name of the parameter to get.
	 * @return mixed If the variable exist, the value is returned (string)
	 * otherwise return false;
	 */
	function get($variable) {

		return $this->_get($variable, $this->params);
	}

	/**
	 * Add a param and/or set its value
	 *
	 */
	function set($name, $value) {
		$this->params[$name] = $value;
	}

	/**
	 * Get the value of $variable in $array.
	 *
	 * @access private
	 * @param string $variable Name of the parameter to get.
	 * @param array $array Name of the parameter to get.
	 * @return bool
	 */
	function _get($variable, $array) {
		if ($this->_exist($variable, $array)) {
			return $array[$variable];
		} else {
			return false;
		}
	}

	/**
	 * Returns from where the variable is accessed.
	 *
	 * @return string
	 */
	function _getCallTrace() {
		$backtrace = debug_backtrace();
		$files = explode('/', $backtrace[1]['file']);
		return $files[count($files) - 4] . '/'.
			$files[count($files) - 3] . '/'.
			$files[count($files) - 2] . '/'.
			$files[count($files) - 1] . ' Line: '.
			$backtrace[1]['line'];
	}

	/**
	 * Check if $variable exists in user submitted parameters.
	 *
	 * @param string $variable Name of the parameter.
	 * @return boolean
	 */
	function exist($variable) {
		return $this->_exist($variable, $this->params);
	}

	/**
	 * Check if $variable exists in $array.
	 *
	 * @access private
	 * @param string $variable Name of the parameter.
	 * @param array	$array
	 * @return boolean
	 */
	function _exist($variable, $array) {
		return isset($array[$variable]);
	}
	/**
	 * Apply validator on submitted user value.
	 *
	 * @param Valid  Validator to apply
	 * @return boolean
	 */
	function valid(&$validator) {
		$this->_validated_input[$validator->getKey()] = true;
		return $validator->validate($this->get($validator->getKey()));
	}

	/**
	 * Apply validator on all values of a submitted user array.
	 *
	 * @param Valid  Validator to apply
	 * @return boolean
	 */
	function validArray(&$validator) {
		$this->_validated_input[$validator->getKey()] = true;
		$isValid = true;
		$array = $this->get($validator->getKey());
		if (is_array($array)) {
			if (count($array)>0) {
				foreach ($array as $key => $v) {
					if (!$validator->validate($v)) {
						$isValid = false;
					}
				}
			} else {
				$isValid = $validator->validate(null);
			}
		} else {
			$isValid = false;
		}
		return $isValid;
	}
	/**
	 * Apply validator on submitted user value and return the value if valid
	 * Else return default value
	 * @param string $variable Name of the parameter to get.
	 * @param mixed $validator Name of the validator (string, uint, email) or an instance of a validator
	 * @param mixed $default_value Value return if the validator is not valid. Optional, default is null.
	 * @return mixed
	 */
	function getValidated($variable, $validator = 'string', $default_value = null) {
		/*$is_valid = false;
		  if ($v = ValidFactory::getInstance($validator, $variable)) {
		  $is_valid = $this->valid($v);
		  } else {
		  trigger_error('Validator '. $validator .' is not found', E_USER_ERROR);
		  }
		  return $is_valid ? $this->get($variable) : $default_value;*/
		return $this->get($variable);
	}
	/**
	 * Apply validator on submitted user array.
	 *
	 * @param string Index in the user submitted values where the array stands.
	 * @param Valid  Validator to apply
	 * @return boolean
	 */
	function validInArray($index, &$validator) {
		$this->_validated_input[$index][$validator->getKey()] = true;
		return $validator->validate($this->getInArray($index, $validator->getKey()));
	}
	/**
	 * Get value of $idx[$variable] in $this->params (user submitted values).
	 *
	 * @param string $idx		The index of the variable array in $this->params.
	 * @param string $variable	Name of the parameter to get.
	 * @return mixed If the variable exist, the value is returned (string)
	 * otherwise return false;
	 */
	function getInArray($idx, $variable) {
		$this->_last_access_to_input[$idx][$variable] = $this->_getCallTrace();
		if(is_array($this->params[$idx])) {
			return $this->_get($variable, $this->params[$idx]);
		} else {
			return false;
		}
	}

	function isAjax() {
		return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && strtoupper($_SERVER['HTTP_X_REQUESTED_WITH']) == 'XMLHTTPREQUEST';
	}
}