/
LSHttpRequest.php
270 lines (238 loc) · 10 KB
/
LSHttpRequest.php
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
<?php
/*
* LimeSurvey
* Copyright (C) 2007-2011 The LimeSurvey Project Team / Carsten Schmitz
* All rights reserved.
* License: GNU/GPL License v2 or later, see LICENSE.php
* LimeSurvey is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/
/**
* Description of HttpRequest
*
*
* Used in LSYii_Application.php
* <pre>
* 'request'=>array(
* 'class'=>'HttpRequest',
* 'noCsrfValidationRoutes'=>array(
* '^services/wsdl.*$'
* ),
* 'enableCsrfValidation'=>true,
* 'enableCookieValidation'=>true,
* ),
* </pre>
*
* Every route will be interpreted as a regex pattern.
*
*/
class LSHttpRequest extends CHttpRequest
{
private $_pathInfo;
public $noCsrfValidationRoutes = array();
public $noCsrfValidationParams = array();
/** @var array<string,mixed>|null the request query parameters (name-value pairs) */
private $queryParams;
/**
* Return the referal url,
* it's used for the "close" buttons, and the "save and close" buttons
* So it checks if the referrer url is the same than the current url to avoid looping.
* If it the case, a paramater can be set to tell what referrer to return.
* If the referrer is an external url, Yii return by default the current url.
*
* DEPRECATED
* #To avoid looping between two urls (like simpleStatistics <=> Expert Statistics),
* #it can be necessary to check if the referrer contains a specific word (an action in general)
* #So if you want to forbid a return to a certain page, just provide an alternative url, and the forbidden key world
*
* The checkLoopInNavigationStack-Method will check for looping, though the forbiddenUrl array is not required anymore
*
* Not all "close" and "save and close" buttons should use it.
* Only close button for pages that can be accessed since different places.
* eg: edit question, that can be accessed from question list or question
*
*
* TODO: implement it for all those pages
* List of pages where it should be implemented :
* - All pages accessible via the top nav-bar (eg: create a new survey, edit template, etc.)
* - All pages accessible via quick actions (home page, survey quick actions, question group quick actions, etc.)
* - All pages accessible via question explorer (only "add question to group" for now)
* - Edition of question and question group, which are accessible via summary or list
* - Import question, question group
*
* TODO: remove misused of it
* It should not be used for pages accessible from only one place
* - Token activation
* etc.
*
* In doubt, just use getUrlReferrer with a default link to home page for full page layout pages,
* or a link to the survey summary for sidemenu layout pages,
* with the controller action as forbidden world.
* So the close button will never loop.
*
* TODO : Each time a new quick action or button is added to access an existing page, the "close" & "save and close" button should be updated to use getUrlReferrer()
*
* @param $sAlternativeUrl string, the url to return if referrer url is the same than current url.
* @return string if success, else null
*/
public function getUrlReferrer($sAlternativeUrl = null)
{
$referrer = parent::getUrlReferrer();
$baseReferrer = str_replace(Yii::app()->getBaseUrl(true), "", (string) $referrer);
$baseRequestUri = str_replace(Yii::app()->getBaseUrl(), "", (string) Yii::app()->request->requestUri);
$referrer = ($baseReferrer != $baseRequestUri) ? $referrer : null;
//Use alternative url if the $referrer is still available in the checkLoopInNavigationStack
if (($this->checkLoopInNavigationStack($referrer)) || (is_null($referrer))) {
// Checks if the alternative url should be used
if (isset($sAlternativeUrl)) {
$referrer = $sAlternativeUrl;
} else {
return App()->createUrl('admin/index');
}
}
return $referrer;
}
public function getOriginalUrlReferrer()
{
return parent::getUrlReferrer();
}
/**
* Method to update the LimeSurvey Navigation Stack to prevent looping
*/
public function updateNavigationStack()
{
$referrer = parent::getUrlReferrer();
$navStack = App()->session['LSNAVSTACK'];
if (!is_array($navStack)) {
$navStack = array();
}
array_unshift($navStack, $referrer);
if (count($navStack) > 5) {
array_pop($navStack);
}
App()->session['LSNAVSTACK'] = $navStack;
}
/**
* Method to check if an url is part of the stack
* @return bool Returns true, when an url is saved in the stack
* @param string $referrerURL The URL that is checked against the stack
*/
protected function checkLoopInNavigationStack($referrerURL)
{
$navStack = App()->session['LSNAVSTACK'];
foreach ($navStack as $url) {
$refEqualsUrl = ($referrerURL == $url);
if ($refEqualsUrl) {
return true;
}
}
return false;
}
protected function normalizeRequest()
{
parent::normalizeRequest();
// Dont run this code in console
if (php_sapi_name() == 'cli') {
return;
}
$route = Yii::app()->getUrlManager()->parseUrl($this);
if ($this->enableCsrfValidation) {
$validationRoutes = $this->noCsrfValidationRoutes;
$validationParams = $this->noCsrfValidationParams;
// $validationRoutes[] = 'plugins/direct/plugin/AuthSAML/function/acs';
// $validationParams['request'] = 'acs';
foreach ($validationRoutes as $cr) {
if (self::routeMatchesNoCsrfValidationRule($route, $cr)) {
Yii::app()->detachEventHandler(
'onBeginRequest',
array($this, 'validateCsrfToken')
);
Yii::trace('Route "' . $route . ' passed without CSRF validation');
break; // found first route and break
}
}
foreach ($validationParams as $key => $value) {
if ($this->getParam($key) === $value) {
Yii::app()->detachEventHandler(
'onBeginRequest',
array($this, 'validateCsrfToken')
);
Yii::trace('Route "' . $route . ' passed without CSRF validation');
break; // found first param and break
}
}
}
}
public function getPathInfo()
{
if ($this->_pathInfo === null) {
$pathInfo = $this->getRequestUri();
if (($pos = strpos((string) $pathInfo, '?')) !== false) {
$pathInfo = substr((string) $pathInfo, 0, $pos);
}
$pathInfo = $this->decodePathInfo($pathInfo);
$scriptUrl = $this->getScriptUrl();
$baseUrl = $this->getBaseUrl();
if (strpos((string) $pathInfo, (string) $scriptUrl) === 0) {
$pathInfo = substr((string) $pathInfo, strlen((string) $scriptUrl));
} elseif ($baseUrl === '' || strpos((string) $pathInfo, (string) $baseUrl) === 0) {
$pathInfo = substr((string) $pathInfo, strlen((string) $baseUrl));
} elseif (strpos((string) $_SERVER['PHP_SELF'], (string) $scriptUrl) === 0) {
$pathInfo = substr((string) $_SERVER['PHP_SELF'], strlen((string) $scriptUrl));
} else {
throw new CException(Yii::t('yii', 'CHttpRequest is unable to determine the path info of the request.'));
}
if ($pathInfo === '/') {
$pathInfo = '';
} elseif (!empty($pathInfo) && $pathInfo[0] === '/') {
$pathInfo = substr($pathInfo, 1);
}
if (($posEnd = strlen($pathInfo) - 1) > 0 && $pathInfo[$posEnd] === '/') {
$pathInfo = substr($pathInfo, 0, $posEnd);
}
$this->_pathInfo = $pathInfo;
}
return $this->_pathInfo;
}
/**
* Returns the request parameters given in the [[queryString]].
*
* This method will return the contents of `$_GET` if params where not explicitly set.
* @return array the request GET parameter values.
* @see setQueryParams()
*/
public function getQueryParams()
{
if ($this->queryParams === null) {
return $_GET;
}
return $this->queryParams;
}
/**
* Sets the request [[queryString]] parameters.
* @param array $values the request query parameters (name-value pairs)
* @see getQueryParams()
*/
public function setQueryParams($values)
{
$this->queryParams = $values;
}
/**
* Returns true if the route matches the given validation rule.
* @param string $route the route to be checked
* @param string $rule the validation rule
* @return bool true if the route matches the given validation rule
*/
public static function routeMatchesNoCsrfValidationRule($route, $rule)
{
// The rule should either match the whole route, or the start of the route followed by a slash.
// For example the routes "rest" (in the case of "index.php/rest?...") or "rest/..." (in the case of
// "index.php/rest/...") should be matched by the rule "rest", but the route "admin/menus/sa/restore"
// should not.
$route = ltrim($route, '/');
return preg_match('#^' . $rule . '$|^' . $rule . '/#', (string) $route);
}
}