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
|
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
require_once dirname(__FILE__) . '/../mock/container_builder.php';
require_once dirname(__FILE__) . '/../mock/auth_provider.php';
/**
* This class exists to setup an instance of phpbb's session class for testing.
*
* The session class has rather complex dependencies, so in order to make its
* tests more * understandable and to make its dependencies more visible this
* factory class sets up all the necessary global state & variable contents.
*/
class phpbb_session_testable_factory
{
protected $container;
protected $config_data;
protected $cache_data;
protected $cookies;
protected $config;
protected $cache;
protected $request;
/**
* Initialises the factory with a set of default config and cache values.
*/
public function __construct()
{
// default configuration values
$this->config_data = array(
'allow_autologin' => false,
'auth_method' => 'db',
'forwarded_for_check' => true,
'active_sessions' => 0, // disable
'rand_seed' => 'foo',
'rand_seed_last_update' => 0,
'max_autologin_time' => 0,
'session_length' => 100,
'form_token_lifetime' => 100,
'cookie_name' => '',
'limit_load' => 0,
'limit_search_load' => 0,
'ip_check' => 3,
'browser_check' => 1,
);
$this->cache_data = array(
'_bots' => array(),
);
$this->cookies = array();
$this->server_data = $_SERVER;
}
/**
* Retrieve the configured session class instance
*
* @param \phpbb\db\driver\driver_interface $dbal The database connection to use for session data
* @return phpbb_mock_session_testable A session instance
*/
public function get_session(\phpbb\db\driver\driver_interface $dbal)
{
// set up all the global variables used by session
global $SID, $_SID, $db, $config, $cache, $request, $phpbb_container;
$request = $this->request = new phpbb_mock_request(
array(),
array(),
$this->cookies,
$this->server_data
);
request_var(null, null, null, null, $request);
$config = $this->config = new \phpbb\config\config($this->get_config_data());
set_config(null, null, null, $config);
$db = $dbal;
$cache = $this->cache = new phpbb_mock_cache($this->get_cache_data());
$SID = $_SID = null;
$phpbb_container = $this->container = new phpbb_mock_container_builder();
$phpbb_container->set(
'auth.provider.db',
new phpbb_mock_auth_provider()
);
$phpbb_container->set(
'auth.provider_collection',
array('auth.provider.db' => $phpbb_container->get('auth.provider.db'))
);
$session = new phpbb_mock_session_testable;
return $session;
}
/**
* Set the cookies which should be present in the request data.
*
* @param array $cookies The cookie data, structured like $_COOKIE contents.
*/
public function set_cookies(array $cookies)
{
$this->cookies = $cookies;
}
/**
* Check if the cache used for the generated session contains correct data.
*
* @param PHPUnit_Framework_Assert $test The test case to call assert methods
* on
*/
public function check(PHPUnit_Framework_Assert $test)
{
$this->cache->check($test, $this->get_cache_data());
}
/**
* Merge config data with the current config data to be supplied to session.
*
* New values overwrite new ones.
*
* @param array $config_data The config data to merge with previous data
*/
public function merge_config_data(array $config_data)
{
$this->config_data = array_merge($this->config_data, $config_data);
}
/**
* Retrieve the entire config data to be passed to the session.
*
* @return array Configuration
*/
public function get_config_data()
{
return $this->config_data;
}
/**
* Merge the cache contents with more data.
*
* New values overwrite old ones.
*
* @param array $cache_data The additional cache data
*/
public function merge_cache_data(array $cache_data)
{
$this->cache_data = array_merge($this->cache_data, $cache_data);
}
/**
* Retrieve the entire cache data to be passed to the session.
*
* @return array Cache contents
*/
public function get_cache_data()
{
return $this->cache_data;
}
/**
* Merge the current server info ($_SERVER) with more data.
*
* New values overwrite old ones.
*
* @param array $server_data The additional server variables
*/
public function merge_server_data($server_data)
{
return $this->server_data = array_merge($this->server_data, $server_data);
}
/**
* Set cookies, merge config and server data in one step.
*
* New values overwrite old ones.
*
* @param $session_id
* @param $user_id
* @param $user_agent
* @param $ip
* @param int $time
*/
public function merge_test_data($session_id, $user_id, $user_agent, $ip, $time = 0)
{
$this->set_cookies(array(
'_sid' => $session_id,
'_u' => $user_id,
));
$this->merge_config_data(array(
'session_length' => time() + $time, // need to do this to allow sessions started at time 0
));
$this->merge_server_data(array(
'HTTP_USER_AGENT' => $user_agent,
'REMOTE_ADDR' => $ip,
));
}
/**
* Retrieve all server variables to be passed to the session.
*
* @return array Server variables
*/
public function get_server_data()
{
return $this->server_data;
}
}
|
