s2member / src / includes / classes / option-forces.inc.php

option-forces.inc.php in s2Member – Excellent for All Kinds of Memberships, Content Restriction Paywalls & Member Access Subscriptions 261011, at src/includes/classes/option-forces.inc.php

270 lines 13.1 KB

Raw Download Zip

1	<?php
2	// @codingStandardsIgnoreFile
3	/**
4	* Forces WordPress options.
5	*
6	* Copyright: © 2009-2011
7	* {@link http://websharks-inc.com/ WebSharks, Inc.}
8	* (coded in the USA)
9	*
10	* Released under the terms of the GNU General Public License.
11	* You should have received a copy of the GNU General Public License,
12	* along with this software. In the main directory, see: /licensing/
13	* If not, see: {@link http://www.gnu.org/licenses/}.
14	*
15	* @package s2Member\Option_Forces
16	* @since 3.5
17	*/
18	if(!defined('WPINC')) // MUST have WordPress.
19	exit("Do not access this file directly.");
20
21	if (!class_exists ("c_ws_plugin__s2member_option_forces"))
22	{
23	/**
24	* Forces WordPress options.
25	*
26	* @package s2Member\Option_Forces
27	* @since 3.5
28	*/
29	class c_ws_plugin__s2member_option_forces
30	{
31	/**
32	* Forces a default Role for new registrations, NOT tied to an incoming payment.
33	*
34	* @package s2Member\Option_Forces
35	* @since 3.5
36	*
37	* @attaches-to ``add_filter("pre_option_default_role");``
38	*
39	* @param string $default_role Expects a default Role to be passed by the Filter.
40	* @return string Default Role, as configured by s2Member.
41	*/
42	public static function force_default_role ($default_role = FALSE)
43	{
44	do_action("ws_plugin__s2member_before_force_default_role", get_defined_vars ());
45
46	return apply_filters("ws_plugin__s2member_force_default_role", ($default_role = "subscriber"), get_defined_vars ());
47	}
48	/**
49	* Forces a default Role for new Multisite registrations (on the Main Site) NOT tied to an incoming payment.
50	*
51	* @package s2Member\Option_Forces
52	* @since 3.5
53	*
54	* @attaches-to ``add_filter("pre_site_option_default_user_role");``
55	*
56	* @param string $default_role Expects a default Role to be passed by the Filter.
57	* @return string Default Role, as configured by s2Member.
58	*/
59	public static function force_mms_default_role ($default_role = FALSE)
60	{
61	do_action("ws_plugin__s2member_before_force_mms_default_role", get_defined_vars ());
62
63	return apply_filters("ws_plugin__s2member_force_mms_default_role", ($default_role = "subscriber"), get_defined_vars ());
64	}
65	/**
66	* Forces a specific Role to demote to, whenever a Member is demoted in one way or another.
67	*
68	* Use by the PayPal IPN routines, and also by the Auto-EOT system.
69	*
70	* @package s2Member\Option_Forces
71	* @since 3.5
72	*
73	* @param string $demotion_role Expects the role to demote the user to.
74	* @param \WP_User\|null $user Optional user being demoted, for EOT-specific destination filters.
75	* @return string Role users are demoted to, as configured by s2Member.
76	*/
77	public static function force_demotion_role ($demotion_role = FALSE, $user = NULL)
78	{
79	do_action("ws_plugin__s2member_before_force_demotion_role", get_defined_vars ());
80
81	//260916.1840 Use the administrator's configured EOT destination first; the long-standing filter remains the final developer override.
82	$demotion_role = !empty($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["eot_demotion_to_role"]) ? $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["eot_demotion_to_role"] : "subscriber";
83	//260916.2306 Validate registered-role existence here, after s2Member is fully loaded; doing this in bootstrap option validation can initialize WordPress roles too early.
84	if(in_array($demotion_role, array('administrator', 'editor', 'author', 'contributor', 's2member_pending_deletion'), TRUE) \|\| !get_role($demotion_role))
85	$demotion_role = "subscriber";
86
87	//261007.2005 Resolve user-specific EOT destinations before the established final developer override.
88	$demotion_role = apply_filters("ws_plugin__s2member_eot_demotion_role", $demotion_role, get_defined_vars ());
89
90	return apply_filters("ws_plugin__s2member_force_demotion_role", $demotion_role, get_defined_vars ());
91	}
92	/**
93	* Allows new Users to be created on a Multisite Network.
94	*
95	* @package s2Member\Option_Forces
96	* @since 3.5
97	*
98	* @attaches-to ``add_filter("pre_site_option_add_new_users");``
99	*
100	* @param int\|string $allow Numeric string (`1`) or (`0`), expected by the Filter.
101	* @return string Numeric (`1`) or (`0`) indicating true or false. Forces to (`1`) true.
102	*/
103	public static function mms_allow_new_users ($allow = FALSE)
104	{
105	do_action("ws_plugin__s2member_before_mms_allow_new_users", get_defined_vars ());
106
107	return apply_filters("ws_plugin__s2member_mms_allow_new_users", ($allow = "1"), get_defined_vars ());
108	}
109	/**
110	* Forces a Multisite Dashboard Blog to be the Main Site.
111	*
112	* @package s2Member\Option_Forces
113	* @since 3.5
114	*
115	* @attaches-to ``add_filter("pre_site_option_dashboard_blog");``
116	*
117	* @param int\|string $dashboard_blog Numeric Dashboard Blog ID passed through by the Filter.
118	* @return int\|str Numeric Dashboard Blog ID, as configured by s2Member. Forces to the Main Site.
119	*/
120	public static function mms_dashboard_blog ($dashboard_blog = FALSE)
121	{
122	global /* For Multisite support. */ $current_site, $current_blog;
123
124	do_action("ws_plugin__s2member_before_mms_dashboard_blog", get_defined_vars ());
125
126	$main_site = ((is_multisite ()) ? $current_site->blog_id : "1"); // Forces the Main Site.
127
128	return apply_filters("ws_plugin__s2member_mms_dashboard_blog", ($dashboard_blog = $main_site), get_defined_vars ());
129	}
130	/**
131	* Allows access to the Registration Form.
132	*
133	* @package s2Member\Option_Forces
134	* @since 3.5
135	*
136	* @attaches-to ``add_filter("pre_option_users_can_register");``
137	*
138	* @param int\|string $users_can_register Numeric (`1`) or (`0`), indicating true or false; passed through by the Filter.
139	* @return string Numeric value of (`1`) or (`0`), indicating true or false; depending on several factors.
140	*/
141	public static function check_register_access ($users_can_register = FALSE)
142	{
143	global $wpdb; // Global database object reference
144
145	foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;
146	do_action("ws_plugin__s2member_before_check_register_access", get_defined_vars ());
147	unset($__refs, $__v);
148
149	$by_default = $users_can_register = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["allow_subscribers_in"];
150
151	if (is_multisite () && c_ws_plugin__s2member_utils_conds::is_multisite_farm () && is_main_site ())
152	return apply_filters("ws_plugin__s2member_check_register_access", ($users_can_register = "0"), get_defined_vars ());
153
154	else if (!is_admin () && !$users_can_register) // Do NOT run these security checks on option pages; it's confusing.
155	if (!is_multisite () \|\| !c_ws_plugin__s2member_utils_conds::is_multisite_farm () \|\| !is_main_site () \|\| current_user_can ("create_users") \|\| is_super_admin ())
156	{
157	if (current_user_can ("create_users") \|\| (is_multisite () && is_super_admin ()) \|\| c_ws_plugin__s2member_register_access::reg_cookies_ok ())
158	{
159	return apply_filters("ws_plugin__s2member_check_register_access", ($users_can_register = "1"), get_defined_vars ());
160	}
161	}
162
163	return apply_filters("ws_plugin__s2member_check_register_access", $users_can_register, get_defined_vars ());
164	}
165	/**
166	* Allows access to the main Multisite Registration Form.
167	*
168	* @package s2Member\Option_Forces
169	* @since 3.5
170	*
171	* @attaches-to ``add_filter("pre_site_option_registration");``
172	*
173	* @param string $users_can_register Expects ( `none`, `all`, `blog`, `user` ), passed through by the Filter.
174	* @return string One of `none\|all\|user`; depending on several factors.
175	*/
176	public static function check_mms_register_access ($users_can_register = FALSE)
177	{
178	global $wpdb; // Global database object reference
179	global /* For Multisite support. */ $current_site, $current_blog;
180
181	foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;
182	do_action("ws_plugin__s2member_before_check_register_access", get_defined_vars ());
183	unset($__refs, $__v);
184
185	$by_default = $users_can_register = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["mms_registration_grants"];
186
187	if (c_ws_plugin__s2member_utils_conds::bp_is_installed () && is_multisite () && /* BP Multisite / but NOT offering Blogs? */ !c_ws_plugin__s2member_utils_conds::is_multisite_farm ())
188	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = ((c_ws_plugin__s2member_option_forces::check_register_access ()) ? "user" : "none")), get_defined_vars ());
189
190	else if (!is_multisite () \|\| !c_ws_plugin__s2member_utils_conds::is_multisite_farm ()) // Blog Farm?
191	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "none"), get_defined_vars ());
192
193	else if (!is_network_admin () && $users_can_register !== "all") // Do NOT run these checks on Network option pages; it's confusing.
194	{
195	if ((is_main_site () && current_user_can ("create_users")) \|\| is_super_admin ()) // Creates Users on the Main Site?
196	{
197	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "all"), get_defined_vars ());
198	}
199
200	else if (is_user_logged_in () && is_object ($user = wp_get_current_user ()) && $user->ID && is_object ($user = new WP_User ($user->ID, $current_site->blog_id)) && $user->ID && $user->has_cap ("access_s2member_level1"))
201	{
202	$mms_options = c_ws_plugin__s2member_utilities::mms_options ();
203	$blogs_allowed = (int)@$mms_options["mms_registration_blogs_level" . c_ws_plugin__s2member_user_access::user_access_level ($user)];
204	$user_blogs = (is_array($blogs = get_blogs_of_user ($user->ID))) ? count ($blogs) - 1 : 0;
205
206	$user_blogs = ($user_blogs >= 0) ? $user_blogs : 0; // NOT less than zero.
207	$blogs_allowed = ($blogs_allowed >= 0) ? $blogs_allowed : 0;
208
209	if ($user_blogs < $blogs_allowed) // Are they within their limit?
210	{
211	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "all"), get_defined_vars ());
212	}
213	}
214	else if (!is_user_logged_in () && is_main_site () && ($reg_cookies = c_ws_plugin__s2member_register_access::reg_cookies_ok ()) && extract ($reg_cookies))
215	{
216	if (preg_match ($GLOBALS["WS_PLUGIN__"]["s2member"]["c"]["membership_item_number_w_level_regex"], $item_number, $m) && !empty($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["mms_registration_blogs_level" . $m[1]]))
217	{
218	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "all"), get_defined_vars ());
219	}
220	else // Otherwise, we MUST allow them to at least create an account; they paid for it! Defaults to `user`.
221	{
222	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "user"), get_defined_vars ());
223	}
224	}
225	}
226
227	else if (!is_network_admin () && $users_can_register === "all") // Do NOT run these security checks on option pages; it's confusing to a site owner.
228	{
229	if (is_user_logged_in () && !(is_main_site () && current_user_can ("create_users")) && !is_super_admin () && is_object ($user = wp_get_current_user ()) && $user->ID && is_object ($user = new WP_User ($user->ID, $current_site->blog_id)) && $user->ID)
230	{
231	$mms_options = c_ws_plugin__s2member_utilities::mms_options ();
232	$blogs_allowed = (int)@$mms_options["mms_registration_blogs_level" . c_ws_plugin__s2member_user_access::user_access_level ($user)];
233	$user_blogs = (is_array($blogs = get_blogs_of_user ($user->ID))) ? count ($blogs) - 1 : 0;
234
235	$user_blogs = ($user_blogs >= 0) ? $user_blogs : 0; // NOT less than zero.
236	$blogs_allowed = ($blogs_allowed >= 0) ? $blogs_allowed : 0;
237
238	if ($user_blogs >= $blogs_allowed) // Are they at their limit?
239	{
240	return apply_filters("ws_plugin__s2member_check_mms_register_access", ($users_can_register = "none"), get_defined_vars ());
241	}
242	}
243	}
244
245	return apply_filters("ws_plugin__s2member_check_mms_register_access", $users_can_register, get_defined_vars ());
246	}
247	/**
248	* Register access in BuddyPress, for Multisite compatibility.
249	*
250	* BuddyPress bypasses the default Filter `pre_site_option_registration`, and instead uses: ``bp_core_get_root_options()``.
251	*
252	* @package s2Member\Option_Forces
253	* @since 3.5
254	*
255	* @attaches-to ``add_filter("bp_core_get_root_options");``
256	* @attaches-to ``add_filter("bp_core_get_site_options");`` (before BuddyPress v1.5).
257	*
258	* @param array $site_options Expects array of BuddyPress site options.
259	* @return array Site options array, after having been Filtered by this routine.
260	*/
261	public static function check_bp_mms_register_access ($site_options = FALSE)
262	{
263	if (is_multisite ()) // Only if Multisite Networking is enabled. Pointless otherwise.
264	$site_options["registration"] = c_ws_plugin__s2member_option_forces::check_mms_register_access ($site_options["registration"]);
265
266	return apply_filters("ws_plugin__s2member_check_bp_mms_register_access", $site_options, get_defined_vars ());
267	}
268	}
269	}
270