2 require_once 'CiviTest/CiviUnitTestCase.php';
5 * Class CRM_Group_Page_AjaxTest
7 class CRM_Group_Page_AjaxTest
extends CiviUnitTestCase
{
9 * Permissioned group is used both as an active group the contact can see and as a group that allows
10 * logged in user to see contacts
13 protected $_permissionedGroup;
15 * AS disabled group the contact has permission to
18 protected $_permissionedDisabledGroup;
22 protected $_params = array();
29 'name' => 'Contact BAOs',
30 'description' => 'Test all Contact_BAO_Contact methods.',
31 'group' => 'CiviCRM BAO Tests',
37 $this->_params
= array(
44 'is_unit_test' => TRUE,
46 $this->hookClass
= CRM_Utils_Hook
::singleton();
47 $this->createLoggedInUser();
48 $this->_permissionedDisabledGroup
= $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
49 $this->_permissionedGroup
= $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
50 $this->groupCreate(array('title' => 'not-me-disabled', 'is_active' => 0, 'name' => 'not-me-disabled'));
51 $this->groupCreate(array('title' => 'not-me-active', 'is_active' => 1, 'name' => 'not-me-active'));
55 CRM_Utils_Hook
::singleton()->reset();
56 $this->quickCleanup(array('civicrm_group'));
57 $config = CRM_Core_Config
::singleton();
58 unset($config->userPermissionClass
->permissions
);
65 function setPermissionAndRequest($permission) {
66 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array($permission);
67 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
69 $_REQUEST = $this->_params
;
76 function setHookAndRequest($permission, $hook) {
77 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array($permission);
78 $this->hookClass
->setHook('civicrm_aclGroup', array($this, $hook));
79 CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
81 $_REQUEST = $this->_params
;
84 * Retrieve groups as 'view all contacts'
86 function testGroupListViewAllContacts() {
87 $this->setPermissionAndRequest('view all contacts');
88 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
89 $this->assertEquals(2, $total);
90 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
91 $this->assertEquals('not-me-active', $groups[4]['group_name']);
95 * Retrieve groups as 'view all contacts' permissioned user
96 * Without setting params the default is both enabled & disabled
97 * (if you do set default it is enabled only)
99 function testGroupListViewAllContactsFoundTitle() {
100 $this->_params
['title'] = 'p';
101 $this->setPermissionAndRequest('view all contacts');
102 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
103 $this->assertEquals(2, $total);
104 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
105 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
109 * Retrieve groups as 'view all contacts'
111 function testGroupListViewAllContactsNotFoundTitle() {
112 $this->_params
['title'] = 'z';
113 $this->setPermissionAndRequest('view all contacts');
114 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
115 $this->assertEquals(0, $total);
118 * Retrieve groups as 'edit all contacts'
120 function testGroupListEditAllContacts() {
121 $this->setPermissionAndRequest('edit all contacts');
122 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
123 $this->assertEquals(2, $total);
124 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
125 $this->assertEquals('not-me-active', $groups[4]['group_name']);
129 * Retrieve groups as 'view all contacts'
131 function testGroupListViewAllContactsEnabled() {
132 $this->_params
['status'] = 1;
133 $this->setPermissionAndRequest('view all contacts');
134 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
135 $this->assertEquals(2, $total);
136 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
137 $this->assertEquals('not-me-active', $groups[4]['group_name']);
141 * Retrieve groups as 'view all contacts'
143 function testGroupListViewAllContactsDisabled() {
144 $this->_params
['status'] = 2;
145 $this->setPermissionAndRequest('view all contacts');
146 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
147 $this->assertEquals(2, $total);
148 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
149 $this->assertEquals('not-me-disabled', $groups[3]['group_name']);
153 * Retrieve groups as 'view all contacts'
155 function testGroupListViewAllContactsDisabledNotFoundTitle() {
156 $this->_params
['status'] = 2;
157 $this->_params
['title'] = 'n';
158 $this->setPermissionAndRequest('view all contacts');
159 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
160 $this->assertEquals(1, $total);
161 $this->assertEquals('not-me-disabled', $groups[3]['group_name']);
165 * Retrieve groups as 'view all contacts'
167 function testGroupListViewAllContactsDisabledFoundTitle() {
168 $this->_params
['status'] = 2;
169 $this->_params
['title'] = 'p';
170 $this->setPermissionAndRequest('view all contacts');
171 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
172 $this->assertEquals(1, $total);
173 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
177 * Retrieve groups as 'view all contacts'
179 function testGroupListViewAllContactsAll() {
180 $this->_params
['status'] = 3;
181 $this->setPermissionAndRequest('view all contacts');
182 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
183 $this->assertEquals(4, $total);
184 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
185 $this->assertEquals('not-me-disabled', $groups[3]['group_name']);
186 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
187 $this->assertEquals('not-me-active', $groups[4]['group_name']);
192 * Retrieve groups as 'view all contacts'
194 function testGroupListAccessCiviCRM() {
195 $this->setPermissionAndRequest('access CiviCRM');
196 $permissionClause = CRM_Contact_BAO_Group
::getPermissionClause(TRUE);
197 $this->assertEquals('1 = 0', $permissionClause);
198 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
199 $this->assertEquals(0, count($groups));
200 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
203 * Retrieve groups as 'view all contacts'
205 function testGroupListAccessCiviCRMEnabled() {
206 $this->_params
['status'] = 1;
207 $this->setPermissionAndRequest('access CiviCRM');
208 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
209 $this->assertEquals(0, count($groups));
210 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
213 * Retrieve groups as 'view all contacts'
215 function testGroupListAccessCiviCRMDisabled() {
216 $this->_params
['status'] = 2;
217 $this->setPermissionAndRequest('access CiviCRM');
218 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
219 $this->assertEquals(0, count($groups));
220 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
224 * Retrieve groups as 'view all contacts'
226 function testGroupListAccessCiviCRMAll() {
227 $this->_params
['status'] = 2;
228 $this->setPermissionAndRequest('access CiviCRM');
229 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
230 $this->assertEquals(0, count($groups));
231 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
235 * Retrieve groups as 'view all contacts'
237 function testGroupListAccessCiviCRMFound() {
238 $this->_params
['title'] = 'p';
239 $this->setPermissionAndRequest('access CiviCRM');
240 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
241 $this->assertEquals(0, count($groups));
242 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
246 * Retrieve groups as 'view all contacts'
248 function testGroupListAccessCiviCRMNotFound() {
249 $this->_params
['title'] = 'z';
250 $this->setPermissionAndRequest('access CiviCRM');
251 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
252 $this->assertEquals(0, count($groups));
253 $this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
256 function testTraditionalACL () {
258 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
259 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
260 $this->assertEquals(1, $total, 'Total needs to be set correctly');
261 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
264 function testTraditionalACLNotFoundTitle () {
265 $this->_params
['title'] = 'n';
267 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
268 $this->assertEquals(0, count($groups), 'Returned groups should exclude disabled by default');
269 $this->assertEquals(0, $total, 'Total needs to be set correctly');
272 function testTraditionalACLFoundTitle () {
273 $this->_params
['title'] = 'p';
275 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
276 $this->assertEquals(2, count($groups), 'Returned groups should exclude disabled by default');
277 $this->assertEquals(2, $total, 'Total needs to be set correctly');
278 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
279 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
282 function testTraditionalACLDisabled () {
283 $this->_params
['status'] = 2;
285 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
286 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
287 $this->assertEquals(1, $total, 'Total needs to be set correctly');
288 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
291 function testTraditionalACLDisabledFoundTitle () {
292 $this->_params
['status'] = 2;
293 $this->_params
['title'] = 'p';
295 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
296 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
297 $this->assertEquals(1, $total, 'Total needs to be set correctly');
298 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
301 function testTraditionalACLDisabledNotFoundTitle () {
302 $this->_params
['status'] = 2;
303 $this->_params
['title'] = 'n';
305 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
306 $this->assertEquals(0, count($groups), 'Returned groups should exclude disabled by default');
307 $this->assertEquals(0, $total, 'Total needs to be set correctly');
310 function testTraditionalACLEnabled () {
311 $this->_params
['status'] = 1;
313 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
314 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
315 $this->assertEquals(1, $total, 'Total needs to be set correctly');
316 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
319 function testTraditionalACLAll () {
320 $this->_params
['status'] = 3;
322 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
323 $this->assertEquals(2, count($groups), 'Returned groups should exclude disabled by default');
324 $this->assertEquals(2, $total, 'Total needs to be set correctly');
325 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
326 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
332 function testGroupListAclGroupHookDisabled() {
333 $this->_params
['status'] = 2;
334 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
335 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
336 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
337 $this->assertEquals(1, $total, 'Total needs to be set correctly');
338 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
344 function testGroupListAclGroupHookDisabledFound() {
345 $this->_params
['status'] = 2;
346 $this->_params
['title'] = 'p';
347 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
348 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
349 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
350 $this->assertEquals(1, $total, 'Total needs to be set correctly');
351 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
357 function testGroupListAclGroupHookDisabledNotFound() {
358 $this->_params
['status'] = 2;
359 $this->_params
['title'] = 'n';
360 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
361 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
362 $this->assertEquals(0, count($groups), 'Returned groups should exclude disabled by default');
363 $this->assertEquals(0, $total, 'Total needs to be set correctly');
370 function testGroupListAclGroupHook() {
371 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
372 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
373 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
374 $this->assertEquals(1, $total, 'Total needs to be set correctly');
375 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
381 function testGroupListAclGroupHookTitleNotFound() {
382 $this->_params
['title'] = 'n';
383 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
384 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
385 $this->assertEquals(0, $total, 'Total needs to be set correctly');
386 $this->assertEquals(0, count($groups), 'Returned groups should exclude disabled by default');
392 function testGroupListAclGroupHookTitleFound() {
393 $this->_params
['title'] = 'p';
394 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
395 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
396 $this->assertEquals(2, count($groups), 'Returned groups should exclude disabled by default');
397 $this->assertEquals(2, $total, 'Total needs to be set correctly');
398 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
399 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
405 function testGroupListAclGroupHookAll() {
406 $this->_params
['status'] = 3;
407 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
408 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
409 $this->assertEquals(2, count($groups), 'Returned groups should exclude disabled by default');
410 $this->assertEquals(2, $total, 'Total needs to be set correctly');
411 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
412 $this->assertEquals('pick-me-disabled', $groups[1]['group_name']);
418 function testGroupListAclGroupHookEnabled() {
419 $this->_params
['status'] = 1;
420 $this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
421 list($groups, $total) = CRM_Group_Page_AJAX
::getGroupList();
422 $this->assertEquals(1, count($groups), 'Returned groups should exclude disabled by default');
423 $this->assertEquals(1, $total, 'Total needs to be set correctly');
424 $this->assertEquals('pick-me-active', $groups[2]['group_name']);
428 * Implements ACLGroup hook
429 * aclGroup function returns a list of permitted groups
430 * @param string $type
431 * @param integer $contactID
432 * @param string $tableName
433 * @param array $allGroups
434 * @param array $currentGroups
436 function hook_civicrm_aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
437 //don't use api - you will get a loop
438 $sql = " SELECT * FROM civicrm_group WHERE name LIKE '%pick%'";
440 $dao = CRM_Core_DAO
::executeQuery($sql);
441 while ($dao->fetch()) {
442 $groups[] = $dao->id
;
445 if(!empty($allGroups)) {
446 //all groups is empty if we really mean all groups but if a filter like 'is_disabled' is already applied
447 // it is populated, ajax calls from Manage Groups will leave empty but calls from New Mailing pass in a filtered list
448 $currentGroups = array_intersect($groups, array_flip($allGroups));
451 $currentGroups = $groups;