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
|
<?php
declare(strict_types=1);
namespace Shaarli\Front\Controller\Visitor;
use Shaarli\Bookmark\BookmarkFilter;
use Shaarli\TestCase;
use Slim\Http\Request;
use Slim\Http\Response;
/**
* Class ShaarliControllerTest
*
* This class is used to test default behavior of ShaarliVisitorController abstract class.
* It uses a dummy non abstract controller.
*/
class ShaarliVisitorControllerTest extends TestCase
{
use FrontControllerMockHelper;
/** @var LoginController */
protected $controller;
/** @var mixed[] List of variable assigned to the template */
protected $assignedValues;
/** @var Request */
protected $request;
public function setUp(): void
{
$this->createContainer();
$this->controller = new class($this->container) extends ShaarliVisitorController
{
public function assignView(string $key, $value): ShaarliVisitorController
{
return parent::assignView($key, $value);
}
public function render(string $template): string
{
return parent::render($template);
}
public function redirectFromReferer(
Request $request,
Response $response,
array $loopTerms = [],
array $clearParams = [],
string $anchor = null
): Response {
return parent::redirectFromReferer($request, $response, $loopTerms, $clearParams, $anchor);
}
};
$this->assignedValues = [];
$this->request = $this->createMock(Request::class);
}
public function testAssignView(): void
{
$this->assignTemplateVars($this->assignedValues);
$self = $this->controller->assignView('variableName', 'variableValue');
static::assertInstanceOf(ShaarliVisitorController::class, $self);
static::assertSame('variableValue', $this->assignedValues['variableName']);
}
public function testRender(): void
{
$this->assignTemplateVars($this->assignedValues);
$this->container->bookmarkService
->method('count')
->willReturnCallback(function (string $visibility): int {
return $visibility === BookmarkFilter::$PRIVATE ? 5 : 10;
})
;
$this->container->pluginManager
->method('executeHooks')
->willReturnCallback(function (string $hook, array &$data, array $params): array {
return $data[$hook] = $params;
});
$this->container->pluginManager->method('getErrors')->willReturn(['error']);
$this->container->loginManager->method('isLoggedIn')->willReturn(true);
$render = $this->controller->render('templateName');
static::assertSame('templateName', $render);
static::assertSame(10, $this->assignedValues['linkcount']);
static::assertSame(5, $this->assignedValues['privateLinkcount']);
static::assertSame(['error'], $this->assignedValues['plugin_errors']);
static::assertSame('templateName', $this->assignedValues['plugins_includes']['render_includes']['target']);
static::assertTrue($this->assignedValues['plugins_includes']['render_includes']['loggedin']);
static::assertSame('templateName', $this->assignedValues['plugins_header']['render_header']['target']);
static::assertTrue($this->assignedValues['plugins_header']['render_header']['loggedin']);
static::assertSame('templateName', $this->assignedValues['plugins_footer']['render_footer']['target']);
static::assertTrue($this->assignedValues['plugins_footer']['render_footer']['loggedin']);
}
/**
* Test redirectFromReferer() - Default behaviour
*/
public function testRedirectFromRefererDefault(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/controller?query=param&other=2'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term not matched in the referer
*/
public function testRedirectFromRefererWithUnmatchedLoopTerm(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['nope']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/controller?query=param&other=2'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term matching the referer in its path -> redirect to default
*/
public function testRedirectFromRefererWithMatchingLoopTermInPath(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['nope', 'controller']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term matching the referer in its query parameters -> redirect to default
*/
public function testRedirectFromRefererWithMatchingLoopTermInQueryParam(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['nope', 'other']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term matching the referer in its query value
* -> we do not block redirection for query parameter values.
*/
public function testRedirectFromRefererWithMatchingLoopTermInQueryValue(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['nope', 'param']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/controller?query=param&other=2'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term matching the referer in its domain name
* -> we do not block redirection for shaarli's hosts
*/
public function testRedirectFromRefererWithLoopTermInDomain(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['shaarli']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/controller?query=param&other=2'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - With a loop term matching a query parameter AND clear this query param
* -> the param should be cleared before checking if it matches the redir loop terms
*/
public function testRedirectFromRefererWithMatchingClearedParam(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://shaarli/subfolder/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['query'], ['query']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/controller?other=2'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - From another domain -> we ignore the given referrer.
*/
public function testRedirectExternalReferer(): void
{
$this->container->environment['HTTP_REFERER'] = 'http://other.domain.tld/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['query'], ['query']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('location'));
}
/**
* Test redirectFromReferer() - From another domain -> we ignore the given referrer.
*/
public function testRedirectExternalRefererExplicitDomainName(): void
{
$this->container->environment['SERVER_NAME'] = 'my.shaarli.tld';
$this->container->environment['HTTP_REFERER'] = 'http://your.shaarli.tld/controller?query=param&other=2';
$response = new Response();
$result = $this->controller->redirectFromReferer($this->request, $response, ['query'], ['query']);
static::assertSame(302, $result->getStatusCode());
static::assertSame(['/subfolder/'], $result->getHeader('location'));
}
}
|
