3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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
39 class CRM_Core_Permission_Base
{
41 // permission mapping to stub check() calls
42 public $permissions = NULL;
45 * Translate permission
48 * @param string $nativePrefix
49 * @param array $map array($portableName => $nativeName)
51 * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset"
52 * @return NULL|string a permission name
54 public function translatePermission($perm, $nativePrefix, $map) {
55 list ($civiPrefix, $name) = CRM_Utils_String
::parsePrefix(':', $perm, NULL);
56 switch ($civiPrefix) {
58 return $name; // pass through
60 return CRM_Utils_Array
::value($name, $map, CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
);
64 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
69 * Get the current permission of this user
71 * @return string the permission of the user (edit or view or null)
73 public function getPermission() {
74 return CRM_Core_Permission
::EDIT
;
78 * Get the permissioned where clause for the user
80 * @param int $type the type of permission needed
81 * @param array $tables (reference ) add the tables that are needed for the select clause
82 * @param array $whereTables (reference ) add the tables that are needed for the where clause
84 * @return string the group where clause for this user
87 public function whereClause($type, &$tables, &$whereTables) {
91 * Get the permissioned where clause for the user when trying to see groups
93 * @param int $type the type of permission needed
94 * @param array $tables (reference ) add the tables that are needed for the select clause
95 * @param array $whereTables (reference ) add the tables that are needed for the where clause
97 * @return string the group where clause for this user
100 public function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
102 return $this->groupClause($type, $tables, $whereTables);
106 * Get all groups from database, filtered by permissions
109 * @param string $groupType type of group(Access/Mailing)
110 * @param bool|\boolen $excludeHidden exclude hidden groups.
114 * @return array - array reference of all groups.
116 public function group($groupType = NULL, $excludeHidden = TRUE) {
117 return CRM_Core_PseudoConstant
::allGroup($groupType, $excludeHidden);
121 * Get group clause for this user
123 * @param int $type the type of permission needed
124 * @param array $tables (reference ) add the tables that are needed for the select clause
125 * @param array $whereTables (reference ) add the tables that are needed for the where clause
127 * @return string the group where clause for this user
130 public function groupClause($type, &$tables, &$whereTables) {
135 * Given a permission string, check for access requirements
137 * @param string $str the permission to check
139 * @return boolean true if yes, else false
143 function check($str) {
144 //no default behaviour
148 * Given a roles array, check for access requirements
150 * @param array $array the roles to check
152 * @return boolean true if yes, else false
156 function checkGroupRole($array) {
161 * Get all the contact emails for users that have a specific permission
163 * @param string $permissionName name of the permission we are interested in
165 * @return string a comma separated list of email addresses
167 public function permissionEmails($permissionName) {
168 CRM_Core_Error
::fatal("this function only works in Drupal 6 at the moment");
172 * Get all the contact emails for users that have a specific role
174 * @param string $roleName name of the role we are interested in
176 * @return string a comma separated list of email addresses
178 public function roleEmails($roleName) {
179 CRM_Core_Error
::fatal("this function only works in Drupal 6 at the moment");
183 * Determine whether the permission store allows us to store
184 * a list of permissions generated dynamically (eg by
185 * hook_civicrm_permissions.)
189 public function isModulePermissionSupported() {
194 * Ensure that the CMS supports all the permissions defined by CiviCRM
195 * and its extensions. If there are stale permissions, they should be
196 * deleted. This is useful during module upgrade when the newer module
197 * version has removed permission that were defined in the older version.
199 * @param array $permissions same format as CRM_Core_Permission::getCorePermissions().
201 * @throws CRM_Core_Exception
202 * @see CRM_Core_Permission::getCorePermissions
204 function upgradePermissions($permissions) {
205 throw new CRM_Core_Exception("Unimplemented method: CRM_Core_Permission_*::upgradePermissions");
209 * Get the permissions defined in the hook_civicrm_permission implementation
210 * of the given module.
212 * Note: At time of writing, this is only used with native extension-modules, so
213 * there's one, predictable calling convention (regardless of CMS).
217 * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
218 * @see CRM_Core_Permission::getCorePermissions
220 static function getModulePermissions($module) {
221 $return_permissions = array();
222 $fn_name = "{$module}_civicrm_permission";
223 if (function_exists($fn_name)) {
224 $module_permissions = array();
225 $fn_name($module_permissions);
226 $return_permissions = $module_permissions;
228 return $return_permissions;
232 * Get the permissions defined in the hook_civicrm_permission implementation
233 * in all enabled CiviCRM module extensions.
235 * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
237 function getAllModulePermissions() {
238 $permissions = array();
239 CRM_Utils_Hook
::permission($permissions);