31bfdf3ab1d0c9715f4459d19d18215784da7db2
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
39 class CRM_Core_Permission_Base
{
42 * Translate permission
44 * @param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset"
45 * @param string $nativePrefix
46 * @param array $map array($portableName => $nativeName)
47 * @return NULL|string a permission name
49 public function translatePermission($perm, $nativePrefix, $map) {
50 list ($civiPrefix, $name) = CRM_Utils_String
::parsePrefix(':', $perm, NULL);
51 switch ($civiPrefix) {
53 return $name; // pass through
55 return CRM_Utils_Array
::value($name, $map, CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
);
59 return CRM_Core_Permission
::ALWAYS_DENY_PERMISSION
;
64 * get the current permission of this user
66 * @return string the permission of the user (edit or view or null)
68 public function getPermission() {
69 return CRM_Core_Permission
::EDIT
;
73 * Get the permissioned where clause for the user
75 * @param int $type the type of permission needed
76 * @param array $tables (reference ) add the tables that are needed for the select clause
77 * @param array $whereTables (reference ) add the tables that are needed for the where clause
79 * @return string the group where clause for this user
82 public function whereClause($type, &$tables, &$whereTables) {
86 * Get the permissioned where clause for the user when trying to see groups
88 * @param int $type the type of permission needed
89 * @param array $tables (reference ) add the tables that are needed for the select clause
90 * @param array $whereTables (reference ) add the tables that are needed for the where clause
92 * @return string the group where clause for this user
95 public function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
97 return $this->groupClause($type, $tables, $whereTables);
100 * Get all groups from database, filtered by permissions
103 * @param string $groupType type of group(Access/Mailing)
104 * @param boolen $excludeHidden exclude hidden groups.
108 * @return array - array reference of all groups.
111 public function group($groupType = NULL, $excludeHidden = TRUE) {
112 return CRM_Core_PseudoConstant
::allGroup($groupType, $excludeHidden);
116 * Get group clause for this user
118 * @param int $type the type of permission needed
119 * @param array $tables (reference ) add the tables that are needed for the select clause
120 * @param array $whereTables (reference ) add the tables that are needed for the where clause
122 * @return string the group where clause for this user
125 public function groupClause($type, &$tables, &$whereTables) {
130 * given a permission string, check for access requirements
132 * @param string $str the permission to check
134 * @return boolean true if yes, else false
138 function check($str) {
139 //no default behaviour
143 * Given a roles array, check for access requirements
145 * @param array $array the roles to check
147 * @return boolean true if yes, else false
151 function checkGroupRole($array) {
156 * Get all the contact emails for users that have a specific permission
158 * @param string $permissionName name of the permission we are interested in
160 * @return string a comma separated list of email addresses
162 public function permissionEmails($permissionName) {
163 CRM_Core_Error
::fatal("this function only works in Drupal 6 at the moment");
167 * Get all the contact emails for users that have a specific role
169 * @param string $roleName name of the role we are interested in
171 * @return string a comma separated list of email addresses
173 public function roleEmails($roleName) {
174 CRM_Core_Error
::fatal("this function only works in Drupal 6 at the moment");
178 * Determine whether the permission store allows us to store
179 * a list of permissions generated dynamically (eg by
180 * hook_civicrm_permissions.)
184 public function isModulePermissionSupported() {
189 * Ensure that the CMS supports all the permissions defined by CiviCRM
190 * and its extensions. If there are stale permissions, they should be
191 * deleted. This is useful during module upgrade when the newer module
192 * version has removed permission that were defined in the older version.
194 * @param array $permissions same format as CRM_Core_Permission::getCorePermissions().
195 * @see CRM_Core_Permission::getCorePermissions
197 function upgradePermissions($permissions) {
198 throw new CRM_Core_Exception("Unimplemented method: CRM_Core_Permission_*::upgradePermissions");
202 * Get the permissions defined in the hook_civicrm_permission implementation
203 * of the given module.
205 * Note: At time of writing, this is only used with native extension-modules, so
206 * there's one, predictable calling convention (regardless of CMS).
208 * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
209 * @see CRM_Core_Permission::getCorePermissions
211 static function getModulePermissions($module) {
212 $return_permissions = array();
213 $fn_name = "{$module}_civicrm_permission";
214 if (function_exists($fn_name)) {
215 $module_permissions = array();
216 $fn_name($module_permissions);
217 $return_permissions = $module_permissions;
219 return $return_permissions;
223 * Get the permissions defined in the hook_civicrm_permission implementation
224 * in all enabled CiviCRM module extensions.
226 * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
228 function getAllModulePermissions() {
229 $permissions = array();
230 CRM_Utils_Hook
::permission($permissions);