Auto-configures Amazon® CloudFront distros.

Since:

130209

Returns:

bool|array - True on success, else array on failure. Failure array will contain a failure code, and a failure message.

Auto-configures an Amazon® S3 Bucket's ACLs.

Since:

110926

Returns:

bool|array - True on success, else array on failure. Failure array will contain a failure code, and a failure message.

Handles Download Access permissions.

Since:

110524RC

Attaches-to:

add_action("init");

Also-called-by:

API Function s2Member\API_Functions → s2member_file_download_url(), w/ $create_file_download_url param.

Parameters:

array $create_file_download_url - Optional. If this function is called directly, we can pass arguments through this array. 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.

Returns:

null|str - If called directly with $create_file_download_url, returns a string with the URL, based on configuration. Else, this function may exit script execution after serving a File Download.

Generates a File Download URL for access to a file protected by s2Member.

Since:

110926

Parameters:

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. 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.

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.

Returns:

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.

See Also:

s2Member\API_Functions → s2member_file_download_url()

Creates a File Download Key.

Builds a hash of: date("Y-m-d") . $_SERVER["REMOTE_ADDR"] . $_SERVER["HTTP_USER_AGENT"] . $file.

Since:

3.5

Parameters:

str $file - Location of your protected file, relative to the /s2member-files/ directory. In other words, just the name of the file (i.e. file.zip ).

str $directive - Optional. One of ip-forever|universal|cache-compatible. ip-forever = a Download Key that never expires, tied only to a specific file and IP address. universal and/or cache-compatible = a Download Key which never expires, and is NOT tied to any specific User. Use at your own risk.

Returns:

str - A Download Key. MD5 hash, 32 characters, URL-safe.

Determines the max period (in days), for Download Access.

Since:

3.5

Returns:

int - Number of days, where 0 means no access to files is allowed. Will not return a value > 365, because this routine also controls the age of download logs to archives.

Deprecated:

Deprecated in v111029. This function is no longer used by s2Member.

Determines the minimum Level required for File Download Access.

Since:

3.5

Returns:

bool|int - False if no access is allowed, else Level number (int) 0+.

Checks for GZIP rules in root .htaccess file.

Since:

120212

Returns:

bool - True if rules exist, else false.

Removes no GZIP rules in root .htaccess file.

Since:

120212

Returns:

bool - True if successful, else false on any type of failure.

Total downloads of a particular file; possibly by a particular User.

Since:

111026

Parameters:

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).

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).

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.

Returns:

int - The total for this particular $file, based on configuration of function arguments.

Note:

Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.

Todo:

Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.

Total unique downloads of a particular file; possibly by a particular User.

Since:

111026

Parameters:

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).

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).

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.

Returns:

int - The total for this particular $file, based on configuration of function arguments.

Note:

Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.

Todo:

Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.

Download details on a per-User basis.

Since:

3.5

Parameters:

obj $user - Optional. A WP_User object. Defaults to the current User's object.

str $not_counting_this_particular_file - Optional. If you want to exclude a particular file, relative to the /s2member-files/ directory, or relative to the root of your Amazon® S3 Bucket (when applicable).

array $user_log - Optional. Prevents another database connection (i.e. the User's log does not need to be pulled again).

array $user_arc - Optional. Prevents another database connection (i.e. the User's archive does not need to be pulled again).

Returns:

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.

Note:

Calculations returned by this function do NOT include File Downloads that were accessed with an Advanced File Download Key.

Todo:

Make it possible for s2Member to keep a count of files downloaded with an Advanced Download Key.

Writes no GZIP rules into root .htaccess file.

Since:

120212

Returns:

bool - True if successfull, else false on any type of failure.