class-give-roles.php — GiveWP – Donation Plugin and Fundraising Platform 2.1.2

give / includes / class-give-roles.php

give / includes Last commit date

class-give-roles.php

358 lines

1	<?php
2	/**
3	* Roles and Capabilities
4	*
5	* @package Give
6	* @subpackage Classes/Give_Roles
7	* @copyright Copyright (c) 2016, WordImpress
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Give_Roles Class
19	*
20	* This class handles the role creation and assignment of capabilities for those roles.
21	*
22	* These roles let us have Give Accountants, Give Workers, etc, each of whom can do
23	* certain things within the plugin.
24	*
25	* @since 1.0
26	*/
27	class Give_Roles {
28
29	/**
30	* Class Constructor
31	*
32	* Set up the Give Roles Class.
33	*
34	* @since 1.0
35	* @access public
36	*/
37	public function __construct() {
38	add_filter( 'give_map_meta_cap', array( $this, 'meta_caps' ), 10, 4 );
39	add_filter( 'woocommerce_disable_admin_bar', array( $this, 'manage_admin_dashboard' ), 10, 1 );
40	add_filter( 'woocommerce_prevent_admin_access', array( $this, 'manage_admin_dashboard' ), 10 );
41	}
42
43	/**
44	* Add Roles
45	*
46	* Add new shop roles with default WordPress capabilities.
47	*
48	* @since 1.0
49	* @access public
50	*
51	* @return void
52	*/
53	public function add_roles() {
54	add_role( 'give_manager', __( 'Give Manager', 'give' ), array(
55	'read' => true,
56	'edit_posts' => true,
57	'delete_posts' => true,
58	'unfiltered_html' => true,
59	'upload_files' => true,
60	'export' => false,
61	'import' => false,
62	'delete_others_pages' => false,
63	'delete_others_posts' => false,
64	'delete_pages' => true,
65	'delete_private_pages' => true,
66	'delete_private_posts' => true,
67	'delete_published_pages' => true,
68	'delete_published_posts' => true,
69	'edit_others_pages' => false,
70	'edit_others_posts' => false,
71	'edit_pages' => true,
72	'edit_private_pages' => true,
73	'edit_private_posts' => true,
74	'edit_published_pages' => true,
75	'edit_published_posts' => true,
76	'manage_categories' => false,
77	'manage_links' => true,
78	'moderate_comments' => true,
79	'publish_pages' => true,
80	'publish_posts' => true,
81	'read_private_pages' => true,
82	'read_private_posts' => true,
83	) );
84
85	add_role( 'give_accountant', __( 'Give Accountant', 'give' ), array(
86	'read' => true,
87	'edit_posts' => false,
88	'delete_posts' => false,
89	) );
90
91	add_role( 'give_worker', __( 'Give Worker', 'give' ), array(
92	'read' => true,
93	'edit_posts' => true,
94	'edit_pages' => true,
95	'upload_files' => true,
96	'delete_posts' => false,
97	) );
98
99	add_role( 'give_donor', __( 'Give Donor', 'give' ), array(
100	'read' => true,
101	) );
102
103	}
104
105	/**
106	* Add Capabilities
107	*
108	* Add new shop-specific capabilities.
109	*
110	* @since 1.0
111	* @access public
112	*
113	* @global WP_Roles $wp_roles
114	*
115	* @return void
116	*/
117	public function add_caps() {
118	global $wp_roles;
119
120	if ( class_exists( 'WP_Roles' ) ) {
121	if ( ! isset( $wp_roles ) ) {
122	$wp_roles = new WP_Roles();
123	}
124	}
125
126	if ( is_object( $wp_roles ) ) {
127	$wp_roles->add_cap( 'give_manager', 'view_give_reports' );
128	$wp_roles->add_cap( 'give_manager', 'view_give_sensitive_data' );
129	$wp_roles->add_cap( 'give_manager', 'export_give_reports' );
130	$wp_roles->add_cap( 'give_manager', 'manage_give_settings' );
131
132	$wp_roles->add_cap( 'administrator', 'view_give_reports' );
133	$wp_roles->add_cap( 'administrator', 'view_give_sensitive_data' );
134	$wp_roles->add_cap( 'administrator', 'export_give_reports' );
135	$wp_roles->add_cap( 'administrator', 'manage_give_settings' );
136	$wp_roles->add_cap( 'administrator', 'view_give_payments' );
137
138	// Add the main post type capabilities.
139	$capabilities = $this->get_core_caps();
140	foreach ( $capabilities as $cap_group ) {
141	foreach ( $cap_group as $cap ) {
142	$wp_roles->add_cap( 'administrator', $cap );
143	$wp_roles->add_cap( 'give_manager', $cap );
144	}
145	}
146
147	// Add Capabilities to Give Workers User Role.
148	$wp_roles->add_cap( 'give_worker', 'edit_give_payments' );
149	$wp_roles->add_cap( 'give_worker', 'delete_give_forms' );
150	$wp_roles->add_cap( 'give_worker', 'delete_others_give_forms' );
151	$wp_roles->add_cap( 'give_worker', 'delete_private_give_forms' );
152	$wp_roles->add_cap( 'give_worker', 'delete_published_give_forms' );
153	$wp_roles->add_cap( 'give_worker', 'edit_give_forms' );
154	$wp_roles->add_cap( 'give_worker', 'edit_others_give_forms' );
155	$wp_roles->add_cap( 'give_worker', 'edit_private_give_forms' );
156	$wp_roles->add_cap( 'give_worker', 'edit_published_give_forms' );
157	$wp_roles->add_cap( 'give_worker', 'publish_give_forms' );
158	$wp_roles->add_cap( 'give_worker', 'read_private_give_forms' );
159
160	// Add Capabilities to Give Accountant User Role.
161	$wp_roles->add_cap( 'give_accountant', 'edit_give_forms' );
162	$wp_roles->add_cap( 'give_accountant', 'read_private_give_forms' );
163	$wp_roles->add_cap( 'give_accountant', 'view_give_reports' );
164	$wp_roles->add_cap( 'give_accountant', 'export_give_reports' );
165	$wp_roles->add_cap( 'give_accountant', 'edit_give_payments' );
166	$wp_roles->add_cap( 'give_accountant', 'view_give_payments' );
167
168	}
169	}
170
171	/**
172	* Get Core Capabilities
173	*
174	* Retrieve core post type capabilities.
175	*
176	* @since 1.0
177	* @access public
178	*
179	* @return array $capabilities Core post type capabilities.
180	*/
181	public function get_core_caps() {
182	$capabilities = array();
183
184	$capability_types = array( 'give_form', 'give_payment' );
185
186	foreach ( $capability_types as $capability_type ) {
187	$capabilities[ $capability_type ] = array(
188	// Post type.
189	"edit_{$capability_type}",
190	"read_{$capability_type}",
191	"delete_{$capability_type}",
192	"edit_{$capability_type}s",
193	"edit_others_{$capability_type}s",
194	"publish_{$capability_type}s",
195	"read_private_{$capability_type}s",
196	"delete_{$capability_type}s",
197	"delete_private_{$capability_type}s",
198	"delete_published_{$capability_type}s",
199	"delete_others_{$capability_type}s",
200	"edit_private_{$capability_type}s",
201	"edit_published_{$capability_type}s",
202
203	// Terms / taxonomies.
204	"manage_{$capability_type}_terms",
205	"edit_{$capability_type}_terms",
206	"delete_{$capability_type}_terms",
207	"assign_{$capability_type}_terms",
208
209	// Custom capabilities.
210	"view_{$capability_type}_stats",
211	"import_{$capability_type}s",
212	);
213	}
214
215	return $capabilities;
216	}
217
218	/**
219	* Meta Capabilities
220	*
221	* Map meta capabilities to primitive capabilities.
222	*
223	* @since 1.0
224	* @access public
225	*
226	* @param array $caps Returns the user's actual capabilities.
227	* @param string $cap Capability name.
228	* @param int $user_id The user ID.
229	* @param array $args Adds the context to the cap. Typically the object ID.
230	*
231	* @return array $caps Meta capabilities.
232	*/
233	public function meta_caps( $caps, $cap, $user_id, $args ) {
234
235	switch ( $cap ) {
236
237	case 'view_give_form_stats' :
238
239	if ( empty( $args[0] ) ) {
240	break;
241	}
242
243	$form = get_post( $args[0] );
244	if ( empty( $form ) ) {
245	break;
246	}
247
248	if ( user_can( $user_id, 'view_give_reports' ) \|\| $user_id == $form->post_author ) {
249	$caps = array();
250	}
251
252	break;
253	}
254
255	return $caps;
256
257	}
258
259	/**
260	* Remove Capabilities
261	*
262	* Remove core post type capabilities (called on uninstall).
263	*
264	* @since 1.0
265	* @access public
266	*
267	* @global WP_Roles $wp_roles
268	*
269	* @return void
270	*/
271	public function remove_caps() {
272
273	global $wp_roles;
274
275	if ( class_exists( 'WP_Roles' ) ) {
276	if ( ! isset( $wp_roles ) ) {
277	$wp_roles = new WP_Roles();
278	}
279	}
280
281	if ( is_object( $wp_roles ) ) {
282	// Give Manager Capabilities.
283	$wp_roles->remove_cap( 'give_manager', 'view_give_reports' );
284	$wp_roles->remove_cap( 'give_manager', 'view_give_sensitive_data' );
285	$wp_roles->remove_cap( 'give_manager', 'export_give_reports' );
286	$wp_roles->remove_cap( 'give_manager', 'manage_give_settings' );
287
288	// Site Administrator Capabilities.
289	$wp_roles->remove_cap( 'administrator', 'view_give_reports' );
290	$wp_roles->remove_cap( 'administrator', 'view_give_sensitive_data' );
291	$wp_roles->remove_cap( 'administrator', 'export_give_reports' );
292	$wp_roles->remove_cap( 'administrator', 'manage_give_settings' );
293	$wp_roles->remove_cap( 'administrator', 'view_give_payments' );
294
295	// Remove the Main Post Type Capabilities.
296	$capabilities = $this->get_core_caps();
297
298	foreach ( $capabilities as $cap_group ) {
299	foreach ( $cap_group as $cap ) {
300	$wp_roles->remove_cap( 'give_manager', $cap );
301	$wp_roles->remove_cap( 'administrator', $cap );
302
303	}
304	}
305
306	// Remove capabilities from the Give Worker role.
307	$wp_roles->remove_cap( 'give_worker', 'edit_give_payments' );
308	$wp_roles->remove_cap( 'give_worker', 'delete_give_forms' );
309	$wp_roles->remove_cap( 'give_worker', 'delete_others_give_forms' );
310	$wp_roles->remove_cap( 'give_worker', 'delete_private_give_forms' );
311	$wp_roles->remove_cap( 'give_worker', 'delete_published_give_forms' );
312	$wp_roles->remove_cap( 'give_worker', 'edit_give_forms' );
313	$wp_roles->remove_cap( 'give_worker', 'edit_others_give_forms' );
314	$wp_roles->remove_cap( 'give_worker', 'edit_private_give_forms' );
315	$wp_roles->remove_cap( 'give_worker', 'edit_published_give_forms' );
316	$wp_roles->remove_cap( 'give_worker', 'publish_give_forms' );
317	$wp_roles->remove_cap( 'give_worker', 'read_private_give_forms' );
318
319	// Remove Capabilities from Give Accountant User Role.
320	$wp_roles->remove_cap( 'give_accountant', 'edit_give_forms' );
321	$wp_roles->remove_cap( 'give_accountant', 'read_private_give_forms' );
322	$wp_roles->remove_cap( 'give_accountant', 'view_give_reports' );
323	$wp_roles->remove_cap( 'give_accountant', 'export_give_reports' );
324	$wp_roles->remove_cap( 'give_accountant', 'edit_give_payments' );
325	$wp_roles->remove_cap( 'give_accountant', 'view_give_payments' );
326
327	}
328	}
329
330	/**
331	* Allow admin dashboard to User with Give Accountant Role.
332	*
333	* Note: WooCommerce doesn't allow the user to access the WP dashboard who holds "Give Accountant" role.
334	*
335	* @since 1.8.14
336	* @updated 1.8.18 - Fixed Give conflicting by not returning $show_admin_bar https://github.com/WordImpress/Give/issues/2539
337	*
338	* @param bool
339	*
340	* @return bool
341	*/
342	public function manage_admin_dashboard($show_admin_bar) {
343
344	// Get the current logged user.
345	$current_user = wp_get_current_user();
346
347	// If user with "Give Accountant" user role is logged-in .
348	if ( 0 !== $current_user->ID && in_array( 'give_accountant', (array) $current_user->roles, true ) ) {
349
350	// Return false, means no prevention.
351	return false;
352	}
353
354	return $show_admin_bar;
355
356	}
357	}
358