s2member / includes / classes / files.inc.php

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

223 lines 11.1 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	* @todo Remove the limitation of `365` days somehow.
104	*/
105	public static function max_download_period ()
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 ()
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	* Determines how many File Downloads are allowed, also provides some extended details.
139	*
140	* @package s2Member\Files
141	* @since 3.5
142	*
143	* @param obj $user Optional. Defaults to the current User's object.
144	* @param str $not_counting_this_particular_file Optional. If you want to exclude a particular file.
145	* @param array $log Optional. Prevents another database connection ( i.e. the log does not need to be pulled again ).
146	* @return array An array with three elements: `allowed`, `allowed_days`, `currently`.
147	*/
148	public static function user_downloads ($user = FALSE, $not_counting_this_particular_file = FALSE, $log = NULL)
149	{
150	eval('foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;');
151	do_action ("ws_plugin__s2member_before_user_downloads", get_defined_vars ());
152	unset ($__refs, $__v); /* Unset defined __refs, __v. */
153	/**/
154	$allowed = $allowed_days = $currently = 0; /* Initialize all of these to zero. */
155	/**/
156	if ((is_object ($user) \|\| is_object ($user = (is_user_logged_in ()) ? wp_get_current_user () : false)) && !empty ($user->ID) && ($user_id = $user->ID))
157	{
158	for ($n = 0; $n <= $GLOBALS["WS_PLUGIN__"]["s2member"]["c"]["levels"]; $n++)
159	{
160	if ($user->has_cap ("access_s2member_level" . $n)) /* Do they have access? */
161	{
162	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"]))
163	if (!empty ($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"]))
164	{
165	$allowed = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed"];
166	$allowed_days = $GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["level" . $n . "_file_downloads_allowed_days"];
167	}
168	if ($user->has_cap ("s2member_level" . $n)) /* We can stop now, if this is their Role. */
169	break; /* Break now. */
170	}
171	}
172	/**/
173	$file_download_access_log = (isset ($log)) ? (array)$log : (array)get_user_option ("s2member_file_download_access_log", $user_id);
174	foreach ($file_download_access_log as $file_download_access_log_entry_key => $file_download_access_log_entry)
175	if (strtotime ($file_download_access_log_entry["date"]) >= strtotime ("-" . $allowed_days . " days"))
176	if ($file_download_access_log_entry["file"] !== $not_counting_this_particular_file)
177	$currently = $currently + 1;
178	}
179	/**/
180	return apply_filters ("ws_plugin__s2member_user_downloads", array ("allowed" => $allowed, "allowed_days" => $allowed_days, "currently" => $currently), get_defined_vars ());
181	}
182	/**
183	* Creates a File Download Key.
184	*
185	* Builds a hash of: ``date("Y-m-d") . $_SERVER["REMOTE_ADDR"] . $_SERVER["HTTP_USER_AGENT"] . $file``.
186	*
187	* @package s2Member\Files
188	* @since 3.5
189	*
190	* @param str $file Location of your protected file, relative to the `/s2member-files/` directory.
191	* In other words, just the name of the file (i.e. `file.zip` ).
192	* @param str $directive Optional. One of `ip-forever\|universal\|cache-compatible`.
193	* `ip-forever` = a Download Key that never expires, tied only to a specific file and IP address.
194	* `universal` and/or `cache-compatible` = a Download Key which never expires, and is NOT tied to any specific User. Use at your own risk.
195	* @return str A Download Key. MD5 hash, 32 characters, URL-safe.
196	*/
197	public static function file_download_key ($file = FALSE, $directive = FALSE)
198	{
199	eval('foreach(array_keys(get_defined_vars())as$__v)$__refs[$__v]=&$$__v;');
200	do_action ("ws_plugin__s2member_before_file_download_key", get_defined_vars ());
201	unset ($__refs, $__v); /* Unset defined __refs, __v. */
202	/**/
203	$file = ($file && is_string ($file) && ($file = trim ($file, "/"))) ? $file : "";
204	/**/
205	if ($directive === "ip-forever") /* Allows the current IP forever. */
206	eval('$allow_caching = false; $salt = $file . $_SERVER["REMOTE_ADDR"];');
207	/**/
208	else if ($directive === "universal" \|\| $directive === "cache-compatible" \|\| $directive)
209	eval('$allow_caching = true; $salt = $file;');
210	/**/
211	else /* Otherwise, we use the default ``$salt``, which is VERY restrictive; even to a specific browser. */
212	eval('$allow_caching = false; $salt = date ("Y-m-d") . $_SERVER["REMOTE_ADDR"] . $_SERVER["HTTP_USER_AGENT"] . $file;');
213	/**/
214	$key = md5 (c_ws_plugin__s2member_utils_encryption::xencrypt ($salt));
215	/**/
216	if ($allow_caching === false) /* Disallow caching? */
217	c_ws_plugin__s2member_no_cache::no_cache_constants (true);
218	/**/
219	return apply_filters ("ws_plugin__s2member_file_download_key", $key, get_defined_vars ());
220	}
221	}
222	}
223	?>