3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
28 require_once 'CiviTest/CiviUnitTestCase.php';
31 * This class is intended to test ACL permission using the multisite module
33 * @package CiviCRM_APIv3
34 * @subpackage API_Contact
37 class api_v3_ACLPermissionTest
extends CiviUnitTestCase
{
38 protected $_apiversion = 3;
40 protected $hookClass = NULL;
41 public $DBResetRequired = FALSE;
43 public $_eNoticeCompliant = TRUE;
49 $baoObj = new CRM_Core_DAO();
50 $baoObj->createTestObject('CRM_Pledge_BAO_Pledge', array(), 1, 0);
51 $baoObj->createTestObject('CRM_Core_BAO_Phone', array(), 1, 0);
52 $this->hookClass
= CRM_Utils_Hook
::singleton();
53 $config = CRM_Core_Config
::singleton();
54 $config->userPermissionClass
->permissions
= array();
59 * @see CiviUnitTestCase::tearDown()
62 CRM_Utils_Hook
::singleton()->reset();
63 $tablesToTruncate = array(
66 $this->quickCleanup($tablesToTruncate);
67 $config = CRM_Core_Config
::singleton();
68 unset($config->userPermissionClass
->permissions
);
72 * Function tests that an empty where hook returns no results
74 function testContactGetNoResultsHook() {
75 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookNoResults'));
76 $result = $this->callAPISuccess('contact', 'get', array(
77 'check_permissions' => 1,
78 'return' => 'display_name',
80 $this->assertEquals(0, $result['count']);
84 * Function tests all results are returned
86 function testContactGetAllResultsHook() {
87 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
88 $result = $this->callAPISuccess('contact', 'get', array(
89 'check_permissions' => 1,
90 'return' => 'display_name',
93 $this->assertEquals(2, $result['count']);
97 * Function tests that deleted contacts are not returned
99 function testContactGetPermissionHookNoDeleted() {
100 $result = $this->callAPISuccess('contact', 'create', array('id' => 2, 'is_deleted' => 1));
101 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
102 $result = $this->callAPISuccess('contact', 'get', array(
103 'check_permissions' => 1,
104 'return' => 'display_name',
106 $this->assertEquals(1, $result['count']);
110 * test permissions limited by hook
112 function testContactGetHookLimitingHook() {
113 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
115 $result = $this->callAPISuccess('contact', 'get', array(
116 'check_permissions' => 1,
117 'return' => 'display_name',
119 $this->assertEquals(1, $result['count']);
123 * confirm that without check permissions we still get 2 contacts returned
125 function testContactGetHookLimitingHookDontCheck() {
127 $result = $this->callAPISuccess('contact', 'get', array(
128 'check_permissions' => 0,
129 'return' => 'display_name',
131 $this->assertEquals(2, $result['count']);
135 * Check that id works as a filter
137 function testContactGetIDFilter() {
138 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
139 $result = $this->callAPISuccess('contact', 'get', array(
142 'check_permissions' => 1,
145 $this->assertEquals(1, $result['count']);
146 $this->assertEquals(2, $result['id']);
150 * Check that address IS returned
152 function testContactGetAddressReturned() {
153 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
154 $fullresult = $this->callAPISuccess('contact', 'get', array(
157 //return doesn't work for all keys - can't fix that here so let's skip ...
158 //prefix & suffix are inconsistent due to CRM-7929
159 // unsure about others but return doesn't work on them
160 $elementsReturnDoesntSupport = array(
171 $expectedReturnElements = array_diff(array_keys($fullresult['values'][0]), $elementsReturnDoesntSupport);
172 $result = $this->callAPISuccess('contact', 'get', array(
173 'check_permissions' => 1,
174 'return' => $expectedReturnElements,
177 $this->assertEquals(1, $result['count']);
178 foreach ($expectedReturnElements as $element) {
179 $this->assertArrayHasKey($element, $result['values'][0]);
184 * Check that pledge IS not returned
186 function testContactGetPledgeIDNotReturned() {
187 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
188 $fullresult = $this->callAPISuccess('contact', 'get', array(
191 $result = $this->callAPISuccess('contact', 'get', array(
192 'check_permissions' => 1,
193 'return' => 'pledge_id',
196 $this->assertArrayNotHasKey('pledge_id', $result['values'][0]);
200 * Check that pledge IS not an allowable filter
202 function testContactGetPledgeIDNotFiltered() {
203 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
204 $fullresult = $this->callAPISuccess('contact', 'get', array(
207 $result = $this->callAPISuccess('contact', 'get', array(
208 'check_permissions' => 1,
212 $this->assertEquals(2, $result['count']);
216 * Check that chaining doesn't bypass permissions
218 function testContactGetPledgeNotChainable() {
219 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
220 $fullresult = $this->callAPISuccess('contact', 'get', array(
223 $result = $this->callAPIFailure('contact', 'get', array(
224 'check_permissions' => 1,
225 'api.pledge.get' => 1,
228 'Error in call to pledge_get : API permission check failed for pledge/get call; missing permission: access CiviCRM.'
233 * no results returned
235 function aclWhereHookNoResults($type, &$tables, &$whereTables, &$contactID, &$where) {
239 * all results returned
241 function aclWhereHookAllResults($type, &$tables, &$whereTables, &$contactID, &$where) {
246 * full results returned
248 function aclWhereOnlySecond($type, &$tables, &$whereTables, &$contactID, &$where) {
249 $where = " contact_a.id > 1";