3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
38 * The various type of permissions
50 * Given a permission string, check for access requirements
53 * The permission to check.
54 * @param int $contactID
55 * The contactID for whom the check is made.
57 * @return boolean true if yes, else false
60 public static function check($str, $contactID = NULL) {
61 if ($contactID == NULL) {
62 $session = CRM_Core_Session
::singleton();
63 $contactID = $session->get('userID');
71 return CRM_ACL_BAO_ACL
::check($str, $contactID);
75 * Get the permissioned where clause for the user
78 * The type of permission needed.
79 * @param array $tables
80 * (reference ) add the tables that are needed for the select clause.
81 * @param array $whereTables
82 * (reference ) add the tables that are needed for the where clause.
83 * @param int $contactID
84 * The contactID for whom the check is made.
85 * @param bool $onlyDeleted
86 * Whether to include only deleted contacts.
87 * @param bool $skipDeleteClause
88 * Don't add delete clause if this is true,.
89 * this means it is handled by generating query
91 * @return string the group where clause for this user
93 public static function whereClause(
99 $skipDeleteClause = FALSE
101 // the default value which is valid for rhe final AND
102 $deleteClause = ' ( 1 ) ';
103 if (!$skipDeleteClause) {
104 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
105 $deleteClause = '(contact_a.is_deleted)';
109 $deleteClause = '(contact_a.is_deleted = 0)';
113 // first see if the contact has edit / view all contacts
114 if (CRM_Core_Permission
::check('edit all contacts') ||
115 ($type == self
::VIEW
&&
116 CRM_Core_Permission
::check('view all contacts')
119 return $skipDeleteClause ?
' ( 1 ) ' : $deleteClause;
122 if ($contactID == NULL) {
123 $session = CRM_Core_Session
::singleton();
124 $contactID = $session->get('userID');
132 return implode(' AND ',
134 CRM_ACL_BAO_ACL
::whereClause($type,
145 * Get all the groups the user has access to for the given operation
148 * The type of permission needed.
149 * @param int $contactID
150 * The contactID for whom the check is made.
152 * @param string $tableName
153 * @param null $allGroups
154 * @param null $includedGroups
156 * @return array the ids of the groups for which the user has permissions
158 public static function group(
161 $tableName = 'civicrm_saved_search',
163 $includedGroups = NULL
165 if ($contactID == NULL) {
166 $session = CRM_Core_Session
::singleton();
167 $contactID = $session->get('userID');
175 return CRM_ACL_BAO_ACL
::group($type, $contactID, $tableName, $allGroups, $includedGroups);
179 * Check if the user has access to this group for operation $type
182 * The type of permission needed.
183 * @param int $groupID
184 * @param int $contactID
185 * The contactID for whom the check is made.
187 * @param string $tableName
188 * @param null $allGroups
189 * @param null $includedGroups
192 * @return array the ids of the groups for which the user has permissions
194 public static function groupPermission(
198 $tableName = 'civicrm_saved_search',
200 $includedGroups = NULL,
204 static $cache = array();
205 //@todo this is pretty hacky!!!
206 //adding a way for unit tests to flush the cache
212 $session = CRM_Core_Session
::singleton();
214 if ($session->get('userID')) {
215 $contactID = $session->get('userID');
219 $key = "{$tableName}_{$type}_{$contactID}";
220 if (array_key_exists($key, $cache)) {
221 $groups = &$cache[$key];
224 $groups = self
::group($type, $contactID, $tableName, $allGroups, $includedGroups);
225 $cache[$key] = $groups;
228 return in_array($groupID, $groups) ?
TRUE : FALSE;