CRM-15180 - https://issues.civicrm.org/jira/browse/CRM-15180
[civicrm-core.git] / CRM / Core / Permission / Drupal.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2014
32 * $Id$
33 *
34 */
35
36 /**
37 *
38 */
39 class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{
40
41 /**
42 * Is this user someone with access for the entire system
43 *
44 * @var boolean
45 */
46 protected $_viewAdminUser = FALSE;
47 protected $_editAdminUser = FALSE;
48
49 /**
50 * Am in in view permission or edit permission?
51 * @var boolean
52 */
53 protected $_viewPermission = FALSE;
54 protected $_editPermission = FALSE;
55
56 /**
57 * The current set of permissioned groups for the user
58 *
59 * @var array
60 */
61 protected $_viewPermissionedGroups;
62 protected $_editPermissionedGroups;
63
64
65 /**
66 * Given a permission string, check for access requirements
67 *
68 * @param string $str the permission to check
69 *
70 * @param int $contactID
71 *
72 * @return boolean true if yes, else false
73 * @access public
74 */
75 function check($str, $contactID = NULL) {
76 $str = $this->translatePermission($str, 'Drupal', array(
77 'view user account' => 'access user profiles',
78 'administer users' => 'administer users',
79 ));
80 if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
81 return FALSE;
82 }
83 if ($str == CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
84 return TRUE;
85 }
86 if (function_exists('user_access')) {
87 return user_access($str) ? TRUE : FALSE;
88 }
89 return TRUE;
90 }
91
92 /**
93 * Given a roles array, check for access requirements
94 *
95 * @param array $array the roles to check
96 *
97 * @return boolean true if yes, else false
98 * @access public
99 */
100 function checkGroupRole($array) {
101 if (function_exists('user_load') && isset($array)) {
102 $user = user_load( $GLOBALS['user']->uid);
103 //if giver roles found in user roles - return true
104 foreach ($array as $key => $value) {
105 if (in_array($value, $user->roles)) {
106 return TRUE;
107 }
108 }
109 }
110 return FALSE;
111 }
112
113 /**
114 * {@inheritDoc}
115 */
116 public function isModulePermissionSupported() {
117 return TRUE;
118 }
119
120 /**
121 * {@inheritdoc}
122 */
123 function upgradePermissions($permissions) {
124 if (empty($permissions)) {
125 throw new CRM_Core_Exception("Cannot upgrade permissions: permission list missing");
126 }
127 $query = db_delete('role_permission')
128 ->condition('module', 'civicrm')
129 ->condition('permission', array_keys($permissions), 'NOT IN');
130 $query->execute();
131 }
132
133 /**
134 * Get all the contact emails for users that have a specific permission
135 *
136 * @param string $permissionName name of the permission we are interested in
137 *
138 * @return string a comma separated list of email addresses
139 */
140 public function permissionEmails($permissionName) {
141 static $_cache = array();
142
143 if (isset($_cache[$permissionName])) {
144 return $_cache[$permissionName];
145 }
146
147 $uids = array();
148 $sql = "
149 SELECT {users}.uid, {role_permission}.permission
150 FROM {users}
151 JOIN {users_roles}
152 ON {users}.uid = {users_roles}.uid
153 JOIN {role_permission}
154 ON {role_permission}.rid = {users_roles}.rid
155 WHERE {role_permission}.permission = '{$permissionName}'
156 AND {users}.status = 1
157 ";
158
159 $result = db_query($sql);
160 foreach ( $result as $record ) {
161 $uids[] = $record->uid;
162 }
163
164 $_cache[$permissionName] = self::getContactEmails($uids);
165 return $_cache[$permissionName];
166 }
167 }
168