3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
36 * The various type of permissions.
48 * Given a permission string, check for access requirements
51 * The permission to check.
52 * @param int $contactID
53 * The contactID for whom the check is made.
56 * true if yes, else false
58 public static function check($str, $contactID = NULL) {
59 if ($contactID == NULL) {
60 $contactID = CRM_Core_Session
::getLoggedInContactID();
68 return CRM_ACL_BAO_ACL
::check($str, $contactID);
72 * Get the permissioned where clause for the user.
75 * The type of permission needed.
76 * @param array $tables
77 * (reference ) add the tables that are needed for the select clause.
78 * @param array $whereTables
79 * (reference ) add the tables that are needed for the where clause.
80 * @param int $contactID
81 * The contactID for whom the check is made.
82 * @param bool $onlyDeleted
83 * Whether to include only deleted contacts.
84 * @param bool $skipDeleteClause
85 * Don't add delete clause if this is true,.
86 * this means it is handled by generating query
89 * the group where clause for this user
91 public static function whereClause(
97 $skipDeleteClause = FALSE
99 // the default value which is valid for the final AND
100 $deleteClause = ' ( 1 ) ';
101 if (!$skipDeleteClause) {
102 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
103 $deleteClause = '(contact_a.is_deleted)';
107 $deleteClause = '(contact_a.is_deleted = 0)';
111 // first see if the contact has edit / view all contacts
112 if (CRM_Core_Permission
::check('edit all contacts') ||
113 ($type == self
::VIEW
&& CRM_Core_Permission
::check('view all contacts'))
115 return $deleteClause;
119 $contactID = CRM_Core_Session
::getLoggedInContactID();
121 $contactID = (int) $contactID;
123 $where = implode(' AND ',
125 CRM_ACL_BAO_ACL
::whereClause($type,
134 // Add permission on self
135 if ($contactID && (CRM_Core_Permission
::check('edit my contact') ||
136 $type == self
::VIEW
&& CRM_Core_Permission
::check('view my contact'))
138 $where = "(contact_a.id = $contactID OR ($where))";
144 * Get all the groups the user has access to for the given operation.
147 * The type of permission needed.
148 * @param int $contactID
149 * The contactID for whom the check is made.
151 * @param string $tableName
152 * @param null $allGroups
153 * @param null $includedGroups
156 * 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 $contactID = CRM_Core_Session
::getLoggedInContactID();
174 return CRM_ACL_BAO_ACL
::group($type, $contactID, $tableName, $allGroups, $includedGroups);
178 * Check if the user has access to this group for operation $type
181 * The type of permission needed.
182 * @param int $groupID
183 * @param int $contactID
184 * The contactID for whom the check is made.
185 * @param string $tableName
186 * @param null $allGroups
187 * @param null $includedGroups
191 * the ids of the groups for which the user has permissions
193 public static function groupPermission(
197 $tableName = 'civicrm_saved_search',
199 $includedGroups = NULL,
203 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;
227 if (empty($groups)) {
231 return in_array($groupID, $groups) ?
TRUE : FALSE;