Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * | |
38 | */ | |
39 | class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { | |
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 | * Get all groups from database, filtered by permissions | |
66 | * for this user | |
67 | * | |
68 | * @param string $groupType type of group(Access/Mailing) | |
69 | * @param boolen $excludeHidden exclude hidden groups. | |
70 | * | |
71 | * @access public | |
72 | * | |
73 | * @return array - array reference of all groups. | |
74 | * | |
75 | */ | |
76 | public function group($groupType = NULL, $excludeHidden = TRUE) { | |
77 | if (!isset($this->_viewPermissionedGroups)) { | |
78 | $this->_viewPermissionedGroups = $this->_editPermissionedGroups = array(); | |
79 | } | |
80 | ||
81 | $groupKey = $groupType ? $groupType : 'all'; | |
82 | ||
83 | if (!isset($this->_viewPermissionedGroups[$groupKey])) { | |
84 | $this->_viewPermissionedGroups[$groupKey] = $this->_editPermissionedGroups[$groupKey] = array(); | |
85 | ||
86 | $groups = CRM_Core_PseudoConstant::allGroup($groupType, $excludeHidden); | |
87 | ||
88 | if ($this->check('edit all contacts')) { | |
89 | // this is the most powerful permission, so we return | |
90 | // immediately rather than dilute it further | |
91 | $this->_editAdminUser = $this->_viewAdminUser = TRUE; | |
92 | $this->_editPermission = $this->_viewPermission = TRUE; | |
93 | $this->_editPermissionedGroups[$groupKey] = $groups; | |
94 | $this->_viewPermissionedGroups[$groupKey] = $groups; | |
95 | return $this->_viewPermissionedGroups[$groupKey]; | |
96 | } | |
97 | elseif ($this->check('view all contacts')) { | |
98 | $this->_viewAdminUser = TRUE; | |
99 | $this->_viewPermission = TRUE; | |
100 | $this->_viewPermissionedGroups[$groupKey] = $groups; | |
101 | } | |
102 | ||
103 | ||
104 | $ids = CRM_ACL_API::group(CRM_Core_Permission::VIEW, NULL, 'civicrm_saved_search', $groups); | |
aafd773a DL |
105 | if (!empty($ids)) { |
106 | foreach (array_values($ids) as $id) { | |
107 | $title = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'title'); | |
108 | $this->_viewPermissionedGroups[$groupKey][$id] = $title; | |
109 | $this->_viewPermission = TRUE; | |
110 | } | |
6a488035 TO |
111 | } |
112 | ||
113 | $ids = CRM_ACL_API::group(CRM_Core_Permission::EDIT, NULL, 'civicrm_saved_search', $groups); | |
aafd773a DL |
114 | if (!empty($ids)) { |
115 | foreach (array_values($ids) as $id) { | |
116 | $title = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $id, 'title'); | |
117 | $this->_editPermissionedGroups[$groupKey][$id] = $title; | |
118 | $this->_viewPermissionedGroups[$groupKey][$id] = $title; | |
119 | $this->_editPermission = TRUE; | |
120 | $this->_viewPermission = TRUE; | |
121 | } | |
6a488035 TO |
122 | } |
123 | } | |
124 | ||
125 | return $this->_viewPermissionedGroups[$groupKey]; | |
126 | } | |
5a55a476 | 127 | |
6a488035 | 128 | /** |
5a55a476 | 129 | * Get group clause for this user. The group Clause filters the |
130 | * list of groups that the user is permitted to see in a group listing. | |
131 | * For example it will filter both the list on the 'Manage Groups' page | |
132 | * and on the contact 'Groups' tab | |
133 | * | |
134 | * the aclGroup hook & configured ACLs contribute to this data. | |
135 | * If the contact is allowed to see all contacts the function will return ( 1 ) | |
136 | * | |
137 | * @todo the history of this function is that there was some confusion as to | |
138 | * whether it was filtering contacts or groups & some cruft may remain | |
6a488035 TO |
139 | * |
140 | * @param int $type the type of permission needed | |
5a55a476 | 141 | * @param array $tables (reference) add the tables that are needed for the select clause |
142 | * @param array $whereTables (reference) add the tables that are needed for the where clause | |
6a488035 | 143 | * |
5a55a476 | 144 | * @return string the clause to add to the query retrieving viewable groups |
6a488035 TO |
145 | * @access public |
146 | */ | |
147 | public function groupClause($type, &$tables, &$whereTables) { | |
148 | if (!isset($this->_viewPermissionedGroups)) { | |
149 | $this->group(); | |
150 | } | |
151 | ||
152 | // we basically get all the groups here | |
153 | $groupKey = 'all'; | |
154 | if ($type == CRM_Core_Permission::EDIT) { | |
155 | if ($this->_editAdminUser) { | |
156 | $clause = ' ( 1 ) '; | |
157 | } | |
158 | elseif (empty($this->_editPermissionedGroups[$groupKey])) { | |
159 | $clause = ' ( 0 ) '; | |
160 | } | |
161 | else { | |
162 | $clauses = array(); | |
163 | $groups = implode(', ', $this->_editPermissionedGroups[$groupKey]); | |
164 | $clauses[] = ' ( civicrm_group_contact.group_id IN ( ' . implode(', ', array_keys($this->_editPermissionedGroups[$groupKey])) . " ) AND civicrm_group_contact.status = 'Added' ) "; | |
165 | $tables['civicrm_group_contact'] = 1; | |
166 | $whereTables['civicrm_group_contact'] = 1; | |
167 | ||
168 | // foreach group that is potentially a saved search, add the saved search clause | |
169 | foreach (array_keys($this->_editPermissionedGroups[$groupKey]) as $id) { | |
170 | $group = new CRM_Contact_DAO_Group(); | |
171 | $group->id = $id; | |
172 | if ($group->find(TRUE) && $group->saved_search_id) { | |
173 | $clause = CRM_Contact_BAO_SavedSearch::whereClause($group->saved_search_id, | |
174 | $tables, | |
175 | $whereTables | |
176 | ); | |
177 | if (trim($clause)) { | |
178 | $clauses[] = $clause; | |
179 | } | |
180 | } | |
181 | } | |
182 | $clause = ' ( ' . implode(' OR ', $clauses) . ' ) '; | |
183 | } | |
184 | } | |
185 | else { | |
186 | if ($this->_viewAdminUser) { | |
187 | $clause = ' ( 1 ) '; | |
188 | } | |
189 | elseif (empty($this->_viewPermissionedGroups[$groupKey])) { | |
190 | $clause = ' ( 0 ) '; | |
191 | } | |
192 | else { | |
193 | $clauses = array(); | |
194 | $groups = implode(', ', $this->_viewPermissionedGroups[$groupKey]); | |
5a55a476 | 195 | $clauses[] = ' civicrm_group.id IN (' . implode(', ', array_keys($this->_viewPermissionedGroups[$groupKey])) . " ) "; |
196 | $tables['civicrm_group'] = 1; | |
197 | $whereTables['civicrm_group'] = 1; | |
6a488035 TO |
198 | $clause = ' ( ' . implode(' OR ', $clauses) . ' ) '; |
199 | } | |
200 | } | |
201 | ||
202 | return $clause; | |
203 | } | |
204 | ||
205 | /** | |
206 | * get the current permission of this user | |
207 | * | |
208 | * @return string the permission of the user (edit or view or null) | |
209 | */ | |
210 | public function getPermission() { | |
211 | $this->group(); | |
212 | ||
213 | if ($this->_editPermission) { | |
214 | return CRM_Core_Permission::EDIT; | |
215 | } | |
216 | elseif ($this->_viewPermission) { | |
217 | return CRM_Core_Permission::VIEW; | |
218 | } | |
219 | return NULL; | |
220 | } | |
221 | ||
6a488035 TO |
222 | function getContactEmails($uids) { |
223 | if (empty($uids)) { | |
224 | return ''; | |
225 | } | |
226 | $uidString = implode(',', $uids); | |
227 | $sql = " | |
228 | SELECT e.email | |
229 | FROM civicrm_contact c | |
230 | INNER JOIN civicrm_email e ON ( c.id = e.contact_id AND e.is_primary = 1 ) | |
231 | INNER JOIN civicrm_uf_match uf ON ( c.id = uf.contact_id ) | |
232 | WHERE c.is_deceased = 0 | |
233 | AND c.is_deleted = 0 | |
234 | AND uf.uf_id IN ( $uidString ) | |
235 | "; | |
236 | ||
237 | $dao = CRM_Core_DAO::executeQuery($sql); | |
238 | ||
239 | $emails = array(); | |
240 | while ($dao->fetch()) { | |
241 | $emails[] = $dao->email; | |
242 | } | |
243 | ||
244 | return implode(', ', $emails); | |
245 | } | |
6a488035 | 246 | } |