Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
46.67% covered (danger)
46.67%
70 / 150
75.00% covered (warning)
75.00%
9 / 12
CRAP
0.00% covered (danger)
0.00%
0 / 1
phpbb_functions_obtain_online_test
46.67% covered (danger)
46.67%
70 / 150
75.00% covered (warning)
75.00%
9 / 12
33.85
0.00% covered (danger)
0.00%
0 / 1
 getDataSet
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setUp
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
1
 obtain_guest_count_data
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 test_obtain_guest_count
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 obtain_users_online_data
0.00% covered (danger)
0.00%
0 / 50
0.00% covered (danger)
0.00%
0 / 1
2
 test_obtain_users_online
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
1
 obtain_users_online_string_data
0.00% covered (danger)
0.00%
0 / 26
0.00% covered (danger)
0.00%
0 / 1
2
 test_obtain_users_online_string
100.00% covered (success)
100.00%
22 / 22
100.00% covered (success)
100.00%
1 / 1
1
 create_guest_sessions
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 create_user_sessions
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
1
 add_session
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
1
 load_language
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2/**
3*
4* This file is part of the phpBB Forum Software package.
5*
6* @copyright (c) phpBB Limited <https://www.phpbb.com>
7* @license GNU General Public License, version 2 (GPL-2.0)
8*
9* For full copyright and license information, please see
10* the docs/CREDITS.txt file.
11*
12*/
13
14class phpbb_functions_obtain_online_test extends phpbb_database_test_case
15{
16    protected $db;
17
18    public function getDataSet()
19    {
20        return $this->createXMLDataSet(__DIR__.'/fixtures/obtain_online.xml');
21    }
22
23    protected function setUp(): void
24    {
25        parent::setUp();
26
27        global $config, $db, $user;
28
29        $user = new StdClass;
30        $db = $this->db = $this->new_dbal();
31        $config = array(
32            'load_online_time'    => 5,
33        );
34    }
35
36    public static function obtain_guest_count_data()
37    {
38        return array(
39            array(0, 2),
40            array(1, 1),
41        );
42    }
43
44    /**
45    * @dataProvider obtain_guest_count_data
46    */
47    public function test_obtain_guest_count($forum_id, $expected)
48    {
49        $this->db->sql_query('DELETE FROM phpbb_sessions');
50
51        $time = time();
52        $this->create_guest_sessions($time);
53        $this->assertEquals($expected, obtain_guest_count($forum_id));
54    }
55
56    public static function obtain_users_online_data()
57    {
58        return array(
59            array(0, false, array(
60                'online_users'            => array(2 => 2, 3 => 3, 6 => 6, 7 => 7, 10 => 10),
61                'hidden_users'            => array(6 => 6, 7 => 7, 10 => 10),
62                'total_online'            => 5,
63                'visible_online'        => 2,
64                'hidden_online'            => 3,
65                'guests_online'            => 0,
66            )),
67            array(0, true, array(
68                'online_users'            => array(2 => 2, 3 => 3, 6 => 6, 7 => 7, 10 => 10),
69                'hidden_users'            => array(6 => 6, 7 => 7, 10 => 10),
70                'total_online'            => 7,
71                'visible_online'        => 2,
72                'hidden_online'            => 3,
73                'guests_online'            => 2,
74            )),
75            array(1, false, array(
76                'online_users'            => array(3 => 3, 7 => 7),
77                'hidden_users'            => array(7 => 7),
78                'total_online'            => 2,
79                'visible_online'        => 1,
80                'hidden_online'            => 1,
81                'guests_online'            => 0,
82            )),
83            array(1, true, array(
84                'online_users'            => array(3 => 3, 7 => 7),
85                'hidden_users'            => array(7 => 7),
86                'total_online'            => 3,
87                'visible_online'        => 1,
88                'hidden_online'            => 1,
89                'guests_online'            => 1,
90            )),
91            array(2, false, array(
92                'online_users'            => array(),
93                'hidden_users'            => array(),
94                'total_online'            => 0,
95                'visible_online'        => 0,
96                'hidden_online'            => 0,
97                'guests_online'            => 0,
98            )),
99            array(2, true, array(
100                'online_users'            => array(),
101                'hidden_users'            => array(),
102                'total_online'            => 0,
103                'visible_online'        => 0,
104                'hidden_online'            => 0,
105                'guests_online'            => 0,
106            )),
107        );
108    }
109
110    /**
111    * @dataProvider obtain_users_online_data
112    */
113    public function test_obtain_users_online($forum_id, $display_guests, $expected)
114    {
115        $this->db->sql_query('DELETE FROM phpbb_sessions');
116
117        global $config;
118        $config['load_online_guests'] = $display_guests;
119
120        $time = time();
121        $this->create_guest_sessions($time);
122        $this->create_user_sessions($time);
123        $this->assertEquals($expected, obtain_users_online($forum_id));
124    }
125
126    public static function obtain_users_online_string_data()
127    {
128        return array(
129            array(0, false, array(
130                'online_userlist'    => 'REGISTERED_USERS <span class="username">2</span>, <span class="username">3</span>',
131                'l_online_users'    => 'ONLINE_USERS_TOTAL 5 REG_USERS_TOTAL 2 HIDDEN_USERS_TOTAL 3',
132            )),
133            array(0, true, array(
134                'online_userlist'    => 'REGISTERED_USERS <span class="username">2</span>, <span class="username">3</span>',
135                'l_online_users'    => 'ONLINE_USERS_TOTAL_GUESTS 7 REG_USERS_TOTAL 2 HIDDEN_USERS_TOTAL 3 GUEST_USERS_TOTAL 2',
136            )),
137            array(1, false, array(
138                'online_userlist'    => 'BROWSING_FORUM <span class="username">3</span>',
139                'l_online_users'    => 'ONLINE_USERS_TOTAL 2 REG_USERS_TOTAL 1 HIDDEN_USERS_TOTAL 1',
140            )),
141            array(1, true, array(
142                'online_userlist'    => 'BROWSING_FORUM_GUESTS 1 <span class="username">3</span>',
143                'l_online_users'    => 'ONLINE_USERS_TOTAL_GUESTS 3 REG_USERS_TOTAL 1 HIDDEN_USERS_TOTAL 1 GUEST_USERS_TOTAL 1',
144            )),
145            array(2, false, array(
146                'online_userlist'    => 'BROWSING_FORUM NO_ONLINE_USERS',
147                'l_online_users'    => 'ONLINE_USERS_TOTAL 0 REG_USERS_TOTAL 0 HIDDEN_USERS_TOTAL 0',
148            )),
149            array(2, true, array(
150                'online_userlist'    => 'BROWSING_FORUM_GUESTS 0 NO_ONLINE_USERS',
151                'l_online_users'    => 'ONLINE_USERS_TOTAL_GUESTS 0 REG_USERS_TOTAL 0 HIDDEN_USERS_TOTAL 0 GUEST_USERS_TOTAL 0',
152            )),
153        );
154    }
155
156    /**
157    * @dataProvider obtain_users_online_string_data
158    */
159    public function test_obtain_users_online_string($forum_id, $display_guests, $expected)
160    {
161        $this->db->sql_query('DELETE FROM phpbb_sessions');
162
163        global $config, $user, $auth, $phpbb_dispatcher;
164        $config['load_online_guests'] = $display_guests;
165        $user = new phpbb_mock_user();
166        $user->data['user_id'] = 100;
167        $user->lang = $this->load_language();
168        $auth = $this->createMock('\phpbb\auth\auth');
169        $acl_get_map = array(
170            array('u_viewonline', true),
171            array('u_viewprofile', true),
172        );
173        $auth->expects($this->any())
174            ->method('acl_get')
175            ->with($this->stringContains('_'),
176                $this->anything())
177            ->will($this->returnValueMap($acl_get_map));
178        $phpbb_dispatcher = new phpbb_mock_event_dispatcher();
179
180        $time = time();
181        $this->create_guest_sessions($time);
182        $this->create_user_sessions($time);
183
184        $online_users = obtain_users_online($forum_id);
185        $this->assertEquals($expected, obtain_users_online_string($online_users, $forum_id));
186    }
187
188    protected function create_guest_sessions($time)
189    {
190        $this->add_session(1, '0001', '192.168.0.1', 0, true, $time);
191        $this->add_session(1, '0002', '192.168.0.2', 1, true, $time);
192        $this->add_session(1, '0003', '192.168.0.3', 0, true, $time, 10);
193        $this->add_session(1, '0004', '192.168.0.4', 1, true, $time, 10);
194    }
195
196    protected function create_user_sessions($time)
197    {
198        $this->add_session(2, '0005', '192.168.0.5', 0, true, $time);
199        $this->add_session(3, '0006', '192.168.0.6', 1, true, $time);
200        $this->add_session(4, '0007', '192.168.0.7', 0, true, $time, 10);
201        $this->add_session(5, '0008', '192.168.0.8', 1, true, $time, 10);
202        $this->add_session(6, '0005', '192.168.0.9', 0, false, $time);
203        $this->add_session(7, '0006', '192.168.0.10', 1, false, $time);
204        $this->add_session(8, '0007', '192.168.0.11', 0, false, $time, 10);
205        $this->add_session(9, '0008', '192.168.0.12', 1, false, $time, 10);
206        $this->add_session(10, '009', '192.168.0.13', 0, false, $time);
207    }
208
209    protected function add_session($user_id, $session_id, $user_ip, $forum_id, $view_online, $time, $time_delta = 0)
210    {
211        $sql_ary = array(
212            'session_id'            => $user_id . '_' . $forum_id . '_session00000000000000000' . $session_id,
213            'session_user_id'        => $user_id,
214            'session_ip'            => $user_ip,
215            'session_forum_id'        => $forum_id,
216            'session_time'            => $time - $time_delta * 60,
217            'session_viewonline'    => $view_online,
218        );
219        $this->db->sql_query('INSERT INTO phpbb_sessions ' . $this->db->sql_build_array('INSERT', $sql_ary));
220    }
221
222    protected function load_language()
223    {
224        return array(
225            'NO_ONLINE_USERS'    => 'NO_ONLINE_USERS',
226            'REGISTERED_USERS'    => 'REGISTERED_USERS',
227            'BROWSING_FORUM'    => 'BROWSING_FORUM %s',
228            'BROWSING_FORUM_GUEST'    => 'BROWSING_FORUM_GUEST %s %d',
229            'BROWSING_FORUM_GUESTS'    => 'BROWSING_FORUM_GUESTS %s %d',
230        );
231    }
232}