s2member / includes / classes / files.inc.php

files.inc.php in s2Member – Excellent for All Kinds of Memberships, Content Restriction Paywalls & Member Access Subscriptions 111206, at includes/classes/files.inc.php

299 lines 18.6 KB

Raw Download Zip

1	<?php
2	/**
3	* File Download routines for s2Member.
4	*
5	* Copyright: © 2009-2011
6	* {@link http://www.websharks-inc.com/ WebSharks, Inc.}
7	* ( coded in the USA )
8	*
9	* Released under the terms of the GNU General Public License.
10	* You should have received a copy of the GNU General Public License,
11	* along with this software. In the main directory, see: /licensing/
12	* If not, see: {@link http://www.gnu.org/licenses/}.
13	*
14	* @package s2Member\Files
15	* @since 3.5
16	*/
17	if (realpath (__FILE__) === realpath ($_SERVER["SCRIPT_FILENAME"]))
18	exit ("Do not access this file directly.");
19	/**/
20	if (!class_exists ("c_ws_plugin__s2member_files"))
21	{
22	/**
23	* File Download routines for s2Member.
24	*
25	* @package s2Member\Files
26	* @since 3.5
27	*/
28	class c_ws_plugin__s2member_files
29	{
30	/**
31	* Handles Download Access permissions.
32	*
33	* @package s2Member\Files
34	* @since 110524RC
35	*
36	* @attaches-to ``add_action("init");``
37	* @also-called-by API Function {@link s2Member\API_Functions\s2member_file_download_url()}, w/ ``$create_file_download_url`` param.
38	*
39	* @param array $create_file_download_url Optional. If this function is called directly, we can pass arguments through this array.
40	* Possible array elements: `file_download` (required), `file_download_key`, `file_stream`, `file_inline`, `file_storage`, `file_remote`, `file_ssl`, `file_rewrite`, `file_rewrite_base`, `skip_confirmation`, `url_to_storage_source`, `count_against_user`, `check_user`.
41	* @return null\|str If called directly with ``$create_file_download_url``, returns a string with the URL, based on configuration.
42	* Else, this function may exit script execution after serving a File Download.
43	*/
44	public static function check_file_download_access ($create_file_download_url = FALSE) /* Calls inner routine. */
45	{
46	if (is_array ($create_file_download_url) \|\| !empty ($_GET["s2member_file_download"])) /* Call inner routine? */
47	{
48	return c_ws_plugin__s2member_files_in::check_file_download_access ($create_file_download_url);
49	}
50	}
51	/**
52	* Generates a File Download URL for access to a file protected by s2Member.
53	*
54	* @package s2Member\Files
55	* @since 110926
56	*
57	* @param array $config Required. This is an array of configuration options associated with permissions being checked against the current User/Member; and also the actual URL generated by this routine.
58	* Possible ``$config`` array elements: `file_download` (required), `file_download_key`, `file_stream`, `file_inline`, `file_storage`, `file_remote`, `file_ssl`, `file_rewrite`, `file_rewrite_base`, `skip_confirmation`, `url_to_storage_source`, `count_against_user`, `check_user`.
59	* @param bool $get_streamer_array Optional. Defaults to `false`. If `true`, this function will return an array with the following elements: `streamer`, `file`, `url`. For further details, please review this section in your Dashboard: `s2Member -> Download Options -> JW Player® & RTMP Protocol Examples`.
60	* @return str A File Download URL string on success; or an array on success, with elements `streamer`, `file`, `url` when/if ``$get_streamer_array`` is true; else false on any type of failure.
61	*
62	* @see s2Member\API_Functions\s2member_file_download_url()
63	*/
64	public static function create_file_download_url ($config = FALSE, $get_streamer_array = FALSE) /* Calls inner routine. */
65	{
66	return c_ws_plugin__s2member_files_in::create_file_download_url ($config, $get_streamer_array);
67	}
68	/**
69	* Auto-configures an Amazon® S3 Bucket's ACLs.
70	*
71	* @package s2Member\Files
72	* @since 110926
73	*
74	* @return bool\|array True on success, else array on failure.
75	* Failure array will contain a failure `code`, and a failure `message`.
76	*/
77	public static function amazon_s3_auto_configure_acls () /* Calls inner routine. */
78	{
79	return c_ws_plugin__s2member_files_in::amazon_s3_auto_configure_acls ();
80	}
81	/**
82	* Auto-configures Amazon® S3/CloudFront distros.
83	*
84	* @package s2Member\Files
85	* @since 110926
86	*
87	* @return bool\|array True on success, else array on failure.
88	* Failure array will contain a failure `code`, and a failure `message`.
89	*/
90	public static function amazon_s3_cf_auto_configure_distros () /* Calls inner routine. */
91	{
92	return c_ws_plugin__s2member_files_in::amazon_s3_cf_auto_configure_distros ();
93	}
94	/**
95	* Determines the max period ( in days ), for Download Access.
96	*
97	* @package s2Member\Files
98	* @since 3.5
99	*
100	* @return int Number of days, where 0 means no access to files is allowed.
101	* Will not return a value > `365`, because this routine also controls the age of download logs to archives.
102	*
103	* @deprecated Deprecated in v111029. This function is no longer used by s2Member.
104	*/
105	public static function max_download_period /* No longer used by s2Member. */ ()
106	{
107	do_action ("ws_plugin__s2member_before_max_download_period", get_defined_vars ());
108	/**/
109	for ($n = 0, $max = 0; $n <= $GLOBALS["WS_PLUGIN__"]["s2member"]["c"]["levels"]; $n++)
110	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"]))
111	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"]))
112	if (($days = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"]))
113	$max = ($max < $days) ? $days : $max;
114	/**/
115	return apply_filters ("ws_plugin__s2member_max_download_period", (($max > 365) ? 365 : $max), get_defined_vars ());
116	}
117	/**
118	* Determines the minimum Level required for File Download Access.
119	*
120	* @package s2Member\Files
121	* @since 3.5
122	*
123	* @return bool\|int False if no access is allowed, else Level number (int) 0+.
124	*/
125	public static function min_level_4_downloads () /* Multipurpose. False if no access. */
126	{
127	do_action ("ws_plugin__s2member_before_min_level_4_downloads", get_defined_vars ());
128	/**/
129	for ($n = 0, $min = false; $n <= $GLOBALS["WS_PLUGIN__"]["s2member"]["c"]["levels"]; $n++)
130	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"]))
131	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"]))
132	if (($min = $n) >= 0)
133	break;
134	/**/
135	return apply_filters ("ws_plugin__s2member_min_level_4_downloads", ((is_int ($min)) ? $min : false), get_defined_vars ());
136	}
137	/**
138	* Creates a File Download Key.
139	*
140	* Builds a hash of: ``date("Y-m-d") . $_SERVER["REMOTE_ADDR"] . $_SERVER["HTTP_USER_AGENT"] . $file``.
141	*
142	* @package s2Member\Files
143	* @since 3.5
144	*
145	* @param str $file Location of your protected file, relative to the `/s2member-files/` directory.
146	* In other words, just the name of the file (i.e. `file.zip` ).
147	* @param str $directive Optional. One of `ip-forever\|universal\|cache-compatible`.
148	* `ip-forever` = a Download Key that never expires, tied only to a specific file and IP address.
149	* `universal` and/or `cache-compatible` = a Download Key which never expires, and is NOT tied to any specific User. Use at your own risk.
150	* @return str A Download Key. MD5 hash, 32 characters, URL-safe.
151	*/
152	public static function file_download_key ($file = FALSE, $directive = FALSE)
153	{
154	eval ('foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;');
155	do_action ("ws_plugin__s2member_before_file_download_key", get_defined_vars ());
156	unset ($__refs, $__v); /* Unset defined __refs, __v. */
157	/**/
158	$file = ($file && is_string ($file) && ($file = trim ($file, "/"))) ? $file : "";
159	/**/
160	if ($directive === "ip-forever") /* Current IP forever. */
161	eval ('$allow_caching = false; $salt = $file . $_SERVER["REMOTE_ADDR"];');
162	/**/
163	else if ($directive === "universal" \|\| $directive === "cache-compatible" \|\| $directive)
164	eval ('$allow_caching = true; $salt = $file;');
165	/**/
166	else /* Otherwise, we use the default ``$salt``, which is VERY restrictive; even to a specific browser. */
167	eval ('$allow_caching = false; $salt = date ("Y-m-d") . $_SERVER["REMOTE_ADDR"] . $_SERVER["HTTP_USER_AGENT"] . $file;');
168	/**/
169	$key = md5 (c_ws_plugin__s2member_utils_encryption::xencrypt ($salt, false, false));
170	/**/
171	if ($allow_caching === false) /* Disallow caching? */
172	c_ws_plugin__s2member_no_cache::no_cache_constants (true);
173	/**/
174	return apply_filters ("ws_plugin__s2member_file_download_key", $key, get_defined_vars ());
175	}
176	/**
177	* Download details on a per-User basis.
178	*
179	* @package s2Member\Files
180	* @since 3.5
181	*
182	* @param obj $user Optional. A `WP_User` object. Defaults to the current User's object.
183	* @param str $not_counting_this_particular_file Optional. If you want to exclude a particular file,
184	* relative to the `/s2member-files/` directory, or relative to the root of your Amazon® S3 Bucket ( when applicable ).
185	* @param array $user_log Optional. Prevents another database connection ( i.e. the User's log does not need to be pulled again ).
186	* @param array $user_arc Optional. Prevents another database connection ( i.e. the User's archive does not need to be pulled again ).
187	* @return array An array with the following elements... File Downloads allowed for this User: (int)`allowed`, Download Period for this User in days: (int)`allowed_days`, Files downloaded by this User in the current Period: (int)`currently`, log of all Files downloaded in the current Period, with file names/dates: (array)`log`, archive of all Files downloaded in prior Periods, with file names/dates: (array)`archive`.
188	*
189	* @note Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.
190	* @todo Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.
191	*/
192	public static function user_downloads ($user = FALSE, $not_counting_this_particular_file = FALSE, $user_log = FALSE, $user_arc = FALSE)
193	{
194	eval ('foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;');
195	do_action ("ws_plugin__s2member_before_user_downloads", get_defined_vars ());
196	unset ($__refs, $__v); /* Unset defined __refs, __v. */
197	/**/
198	$allowed = $allowed_days = $currently = 0; /* Initialize these to zero. */
199	$log = $arc = array (); /* Initialize these to a default empty array value. */
200	/**/
201	if ((is_object ($user) \|\| is_object ($user = (is_user_logged_in ()) ? wp_get_current_user () : false)) && !empty ($user->ID) && ($user_id = $user->ID))
202	{
203	for ($n = 0; $n <= $GLOBALS["WS_PLUGIN__"]["s2member"]["c"]["levels"]; $n++)
204	{
205	if ($user->has_cap ("access_s2member_level" . $n)) /* Do they have access? */
206	{
207	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"]) && !empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"]))
208	{
209	$allowed = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"];
210	$allowed_days = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"];
211	}
212	if ($user->has_cap ("s2member_level" . $n)) /* We can stop now, if this is their Role. */
213	break; /* Break now. */
214	}
215	}
216	$log = (is_array ($user_log)) ? $user_log : ((is_array ($log = get_user_option ("s2member_file_download_access_log", $user_id)) && $log !== array (false)) ? $log : array ());
217	$arc = (is_array ($user_arc)) ? $user_arc : ((is_array ($arc = get_user_option ("s2member_file_download_access_arc", $user_id)) && $arc !== array (false)) ? $arc : array ());
218	/**/
219	foreach (($user_file_download_access_log = $log) as $user_file_download_access_log_entry_key => $user_file_download_access_log_entry)
220	if (isset ($user_file_download_access_log_entry["date"]) && strtotime ($user_file_download_access_log_entry["date"]) >= strtotime ("-" . $allowed_days . " days"))
221	if (isset ($user_file_download_access_log_entry["file"]) && $user_file_download_access_log_entry["file"] !== $not_counting_this_particular_file)
222	$currently = $currently + 1;
223	}
224	/**/
225	return apply_filters ("ws_plugin__s2member_user_downloads", array ("allowed" => $allowed, "allowed_days" => $allowed_days, "currently" => $currently, "log" => $log, "archive" => $arc), get_defined_vars ());
226	}
227	/**
228	* Total downloads of a particular file; possibly by a particular User.
229	*
230	* @package s2Member\Files
231	* @since 111026
232	*
233	* @param str $file Required. Location of the file, relative to the `/s2member-files/` directory, or relative to the root of your Amazon® S3 Bucket ( when applicable ).
234	* @param str\|int $user_id Optional. If specified, s2Member will return total downloads by a particular User/Member, instead of collectively ( i.e among all Users/Members ).
235	* @param bool $check_archives_too Optional. Defaults to true. When true, s2Member checks its File Download Archive too, instead of ONLY looking at Files downloaded in the current Period. Period is based on your Basic Download Restrictions setting of allowed days across various Levels of Membership, for each respective User/Member. Or, if ``$user_id`` is specified, based solely on a specific User's `allowed_days`, configured in your Basic Download Restrictions, at the User's current Membership Level.
236	* @return int The total for this particular ``$file``, based on configuration of function arguments.
237	*
238	* @note Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.
239	* @todo Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.
240	*/
241	public static function total_downloads_of ($file = FALSE, $user_id = FALSE, $check_archives_too = TRUE)
242	{
243	global $wpdb; /* Global database object reference. */
244	/**/
245	if ($file && is_string ($file)) /* Was ``$file`` passed in properly? */
246	{
247	if (is_array ($results = $wpdb->get_results ("SELECT `meta_key`, `meta_value` FROM `" . $wpdb->usermeta . "` WHERE " . ((is_numeric ($user_id)) ? "`user_id` = '" . esc_sql ($user_id) . "' AND " : "") . "(`meta_key` = '" . $wpdb->prefix . "s2member_file_download_access_log'" . (($check_archives_too) ? " OR `meta_key` = '" . $wpdb->prefix . "s2member_file_download_access_arc'" : "") . ") AND `meta_value` REGEXP '.\"file\";s:[0-9]+:\"" . esc_sql ($file) . "\".'")))
248	{
249	foreach ($results as $r /* Go through the entire array of results found in the `REGEXP` database query above. */)
250	if (is_array ($la_entries = /* Unserialize the array. */ maybe_unserialize ($r->meta_value)) && !empty ($la_entries))
251	/**/
252	foreach ($la_entries as $la_entry /* Go through all of the entries in each result ``$r``; collecting `counter` values. */)
253	if (!empty ($la_entry["file"]) && $la_entry["file"] === $file && /* Back compatibility. Is `counter` even set? */ (!empty ($la_entry["counter"]) \|\| ($la_entry["counter"] = 1)))
254	{
255	$total = (!empty ($total)) ? $total + (int)$la_entry["counter"] : (int)$la_entry["counter"];
256	break; /* Break now. No need to continue looping; ``$file`` found in these entries. */
257	}
258	}
259	}
260	return (!empty ($total)) ? $total : /* Else return zero by default. */ 0;
261	}
262	/**
263	* Total unique downloads of a particular file; possibly by a particular User.
264	*
265	* @package s2Member\Files
266	* @since 111026
267	*
268	* @param str $file Required. Location of the file, relative to the `/s2member-files/` directory, or relative to the root of your Amazon® S3 Bucket ( when applicable ).
269	* @param str\|int $user_id Optional. If specified, s2Member will return total downloads by a particular User/Member, instead of collectively ( i.e among all Users/Members ).
270	* @param bool $check_archives_too Optional. Defaults to true. When true, s2Member checks its File Download Archive too, instead of ONLY looking at Files downloaded in the current Period. Period is based on your Basic Download Restrictions setting of allowed days across various Levels of Membership, for each respective User/Member. Or, if ``$user_id`` is specified, based solely on a specific User's `allowed_days`, configured in your Basic Download Restrictions, at the User's current Membership Level.
271	* @return int The total for this particular ``$file``, based on configuration of function arguments.
272	*
273	* @note Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.
274	* @todo Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.
275	*/
276	public static function total_unique_downloads_of ($file = FALSE, $user_id = FALSE, $check_archives_too = TRUE)
277	{
278	global $wpdb; /* Global database object reference. */
279	/**/
280	if ($file && is_string ($file)) /* Was ``$file`` passed in properly? */
281	{
282	if (is_array ($results = $wpdb->get_results ("SELECT `meta_key`, `meta_value` FROM `" . $wpdb->usermeta . "` WHERE " . ((is_numeric ($user_id)) ? "`user_id` = '" . esc_sql ($user_id) . "' AND " : "") . "(`meta_key` = '" . $wpdb->prefix . "s2member_file_download_access_log'" . (($check_archives_too) ? " OR `meta_key` = '" . $wpdb->prefix . "s2member_file_download_access_arc'" : "") . ") AND `meta_value` REGEXP '.\"file\";s:[0-9]+:\"" . esc_sql ($file) . "\".'")))
283	{
284	foreach ($results as $r /* Go through the entire array of results found in the `REGEXP` database query above. */)
285	if (is_array ($la_entries = /* Unserialize the array. */ maybe_unserialize ($r->meta_value)) && !empty ($la_entries))
286	/**/
287	foreach ($la_entries as $la_entry /* Go through all of the entries in each result ``$r``; collecting `counter` values. */)
288	if (!empty ($la_entry["file"]) && $la_entry["file"] === $file && /* Back compatibility. Is `counter` even set? */ (!empty ($la_entry["counter"]) \|\| ($la_entry["counter"] = 1)))
289	{
290	$total = (!empty ($total)) ? /* Only count `1` here ( i.e. unique downloads ). */ $total + 1 : 1;
291	break; /* Break now. No need to continue looping; ``$file`` found in these entries. */
292	}
293	}
294	}
295	return (!empty ($total)) ? $total : /* Else return zero by default. */ 0;
296	}
297	}
298	}
299	?>