%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* WP-Members Installation Functions
*
* Functions to install and upgrade WP-Members.
*
* This file is part of the WP-Members plugin by Chad Butler
* You can find out more about this plugin at https://rocketgeek.com
* Copyright (c) 2006-2020 Chad Butler
* WP-Members(tm) is a trademark of butlerblog.com
*
* @package WP-Members
* @author Chad Butler
* @copyright 2006-2020
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit();
}
/**
* @todo Updates/install revisions needed:
* - if reCAPTCHA is "1", update to "3" - reCAPTCHA v1 is fully obsolete by Google.
*/
/**
* Installs or upgrades the plugin.
*
* @since 2.2.2
* @since 3.1.6 Returns $wpmem_settings.
*
* @return array $wpmem_settings
*/
function wpmem_do_install() {
/*
* If you need to force an install, set $chk_force = true.
*
* Important notes:
*
* 1. This will override any settings you already have for any of the plugin settings.
* 2. This will not effect any WP settings or registered users.
*/
$chk_force = false;
$existing_settings = get_option( 'wpmembers_settings' );
if ( false === $existing_settings || $chk_force == true ) {
// New install.
$wpmem_settings = wpmem_install_settings();
wpmem_install_fields();
wpmem_install_dialogs();
wpmem_append_email();
//update_option( 'wpmembers_style', 'generic-no-float.css', '', 'yes' );
} else {
// Upgrade.
$wpmem_settings = wpmem_upgrade_settings();
// Not 100% certain where we needed to add wpmem_append_email(), but it was likely before 3.1.0.
if ( version_compare( $existing_settings['version'], '3.1.1', '<' ) ) {
wpmem_upgrade_dialogs();
wpmem_upgrade_captcha();
wpmem_append_email();
}
// Only run these if DB version is < 2.2.0
if ( version_compare( $existing_settings['db_version'], '2.2.0', '<' ) ) {
wpmem_upgrade_fields();
wpmem_upgrade_product_expiration();
}
// Only run this if DB version < 2.2.1
if ( version_compare( $existing_settings['db_version'], '2.2.1', '<' ) ) {
wpmem_upgrade_validation_email();
wpmem_upgrade_woo_reg();
}
}
return $wpmem_settings;
}
/**
* Updates the existing settings if doing an update.
*
* @since 3.0.0
* @since 3.1.0 Changed from wpmem_update_settings() to wpmem_upgrade_settings().
*
* @return array $wpmem_newsettings
*/
function wpmem_upgrade_settings() {
$wpmem_settings = get_option( 'wpmembers_settings' );
// Is this an update from pre-3.0 or 3.0+?
$is_three = ( array_key_exists( 'version', $wpmem_settings ) ) ? true : false;
// If install is 3.0 or higher.
if ( $is_three ) {
if ( ! isset( $wpmem_settings['enable_products'] ) ) {
$wpmem_settings['enable_products'] = 0;
}
if ( ! isset( $wpmem_settings['clone_menus'] ) ) {
$wpmem_settings['clone_menus'] = 0;
}
// reCAPTCHA v1 is obsolete.
if ( isset( $wpmem_settings['captcha'] ) && 1 == $wpmem_settings['captcha'] ) {
$wpmem_settings['captcha'] = 3;
}
// If old auto excerpt settings exists, update it.
if ( isset( $wpmem_settings['autoex']['auto_ex'] ) ) {
// Update Autoex setting.
if ( $wpmem_settings['autoex']['auto_ex'] == 1 || $wpmem_settings['autoex']['auto_ex'] == "1" ) {
// If Autoex is set, move it to posts/pages.
$wpmem_settings['autoex']['post'] = array( 'enabled' => 1, 'length' => $wpmem_settings['autoex']['auto_ex_len'] );
$wpmem_settings['autoex']['page'] = array( 'enabled' => 1, 'length' => $wpmem_settings['autoex']['auto_ex_len'] );
} else {
// If it is not turned on (!=1), set it to off in new setting (-1).
$wpmem_settings['autoex']['post'] = array( 'enabled' => 0, 'length' => '' );
$wpmem_settings['autoex']['page'] = array( 'enabled' => 0, 'length' => '' );
}
unset( $wpmem_settings['autoex']['auto_ex'] );
unset( $wpmem_settings['autoex']['auto_ex_len'] );
}
// If post types settings does not exist, set as empty array.
if ( ! isset( $wpmem_settings['post_types'] ) ) {
$wpmem_settings['post_types'] = array();
}
// If form tags is not set, add default.
if ( ! isset( $wpmem_settings['form_tags'] ) ) {
$wpmem_settings['form_tags'] = array( 'default' => 'Registration Default' );
}
// If email is set in the settings array, change it back to the pre-3.1 option.
if ( isset( $wpmem_settings['email'] ) ) {
$from = ( is_array( $wpmem_settings['email'] ) ) ? $wpmem_settings['email']['from'] : '';
$name = ( is_array( $wpmem_settings['email'] ) ) ? $wpmem_settings['email']['from_name'] : '';
update_option( 'wpmembers_email_wpfrom', $from );
update_option( 'wpmembers_email_wpname', $name );
unset( $wpmem_settings['email'] );
}
// @since 3.3.0 Upgrade stylesheet setting.
$wpmem_settings['select_style'] = wpmem_upgrade_style_setting( $wpmem_settings );
// Version number should be updated no matter what.
$wpmem_settings['version'] = WPMEM_VERSION;
$wpmem_settings['db_version'] = WPMEM_DB_VERSION;
update_option( 'wpmembers_settings', $wpmem_settings );
return $wpmem_settings;
} else {
// Update pre 3.0 installs (must be 2.5.1 or higher).
// Handle show registration setting change.
$show_reg = ( $wpmem_settings[7] == 0 ) ? 1 : 0;
// Create new settings array.
$wpmem_newsettings = array(
'version' => WPMEM_VERSION,
'db_version' => WPMEM_DB_VERSION,
'block' => array(
'post' => $wpmem_settings[1],
'page' => $wpmem_settings[2],
),
'show_excerpt' => array(
'post' => $wpmem_settings[3],
'page' => $wpmem_settings[3],
),
'show_reg' => array(
'post' => $show_reg,
'page' => $show_reg,
),
'show_login' => array(
'post' => 1,
'page' => 1,
),
'notify' => $wpmem_settings[4],
'mod_reg' => $wpmem_settings[5],
'captcha' => ( 1 == $wpmem_settings[6] ) ? 3 : $wpmem_settings[6], // reCAPTCHA v1 is obsolete, move to v2.
'use_exp' => $wpmem_settings[9],
'use_trial' => $wpmem_settings[10],
'warnings' => $wpmem_settings[11],
'user_pages' => array(
'profile' => get_option( 'wpmembers_msurl' ),
'register' => get_option( 'wpmembers_regurl' ),
'login' => get_option( 'wpmembers_logurl' ),
),
'cssurl' => get_option( 'wpmembers_cssurl' ),
'select_style' => get_option( 'wpmembers_style' ),
'attrib' => get_option( 'wpmembers_attrib' ),
'clone_menus' => 0,
'enable_products' => 0,
);
// Handle auto excerpt setting change and add to setting array.
$autoex = get_option( 'wpmembers_autoex' );
if ( $autoex['auto_ex'] == 1 || $autoex['auto_ex'] == "1" ) {
// If Autoex is set, move it to posts/pages.
$wpmem_newsettings['autoex']['post'] = array( 'enabled' => 1, 'length' => $autoex['auto_ex_len'] );
$wpmem_newsettings['autoex']['page'] = array( 'enabled' => 1, 'length' => $autoex['auto_ex_len'] );
} else {
// If it is not turned on, set it to off in new setting.
$wpmem_newsettings['autoex']['post'] = array( 'enabled' => 0, 'length' => '' );
$wpmem_newsettings['autoex']['page'] = array( 'enabled' => 0, 'length' => '' );
}
// Add new settings.
$wpmem_newsettings['post_types'] = array();
$wpmem_settings['form_tags'] = array( 'default' => 'Registration Default' );
$wpmem_settings['select_style'] = wpmem_upgrade_style_setting( $wpmem_settings );
// Merge settings.
$wpmem_newsettings = array_merge( $wpmem_settings, $wpmem_newsettings );
update_option( 'wpmembers_settings', $wpmem_newsettings );
return $wpmem_newsettings;
}
}
/**
* Adds the fields for email messages.
*
* Was append_email() since 2.7, changed to wpmem_append_email() in 3.0.
*
* @since 2.7
*/
function wpmem_append_email() {
// Email for a new registration.
$subj = 'Your registration info for [blogname]';
$body = 'Thank you for registering for [blogname]
Your registration information is below.
You may wish to retain a copy for your records.
username: [username]
password: [password]
You may log in here:
[reglink]
You may change your password here:
[user-profile]
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_newreg' ) ) {
update_option( 'wpmembers_email_newreg', $arr, false );
}
$arr = $subj = $body = '';
// Email for new registration, registration is moderated.
$subj = 'Thank you for registering for [blogname]';
$body = 'Thank you for registering for [blogname].
Your registration has been received and is pending approval.
You will receive login instructions upon approval of your account
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_newmod' ) ) {
update_option( 'wpmembers_email_newmod', $arr, false );
}
$arr = $subj = $body = '';
// Email for registration is moderated, user is approved.
$subj = 'Your registration for [blogname] has been approved';
$body = 'Your registration for [blogname] has been approved.
Your registration information is below.
You may wish to retain a copy for your records.
username: [username]
password: [password]
You may log in and change your password here:
[user-profile]
You originally registered at:
[reglink]
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_appmod' ) ) {
update_option( 'wpmembers_email_appmod', $arr, false );
}
$arr = $subj = $body = '';
// Email for password reset.
$subj = 'Your password reset for [blogname]';
$body = 'Your password for [blogname] has been reset
Your new password is included below. You may wish to retain a copy for your records.
password: [password]
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_repass' ) ) {
update_option( 'wpmembers_email_repass', $arr, false );
}
$arr = $subj = $body = '';
// Email for admin notification.
$subj = 'New user registration for [blogname]';
$body = 'The following user registered for [blogname]:
username: [username]
email: [email]
[fields]
This user registered here:
[reglink]
user IP: [user-ip]
activate user: [activate-user]
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_notify' ) ) {
update_option( 'wpmembers_email_notify', $arr, false );
}
$arr = $subj = $body = '';
// Email footer (no subject).
$body = '----------------------------------
This is an automated message from [blogname]
Please do not reply to this address';
if ( ! get_option( 'wpmembers_email_footer' ) ) {
update_option( 'wpmembers_email_footer', $body, false );
}
$arr = $subj = $body = '';
// Email for retrieve username.
$subj = 'Username for [blogname]';
$body = 'Your username for [blogname] is below.
username: [username]
';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_getuser' ) ) {
update_option( 'wpmembers_email_getuser', $arr, false );
}
return true;
}
/**
* Checks the dialogs array for necessary changes.
*
* @since 2.9.3
* @since 3.0.0 Changed from update_dialogs() to wpmem_update_dialogs().
* @since 3.1.0 Changed from wpmem_update_dialogs() to wpmem_upgrade_dialogs().
* @since 3.1.1 Converts numeric dialog array to associative.
*/
function wpmem_upgrade_dialogs() {
$wpmem_dialogs = get_option( 'wpmembers_dialogs' );
if ( ! array_key_exists( 'restricted_msg', $wpmem_dialogs ) ) {
// Update is needed.
$new_arr = array();
$new_keys = array( 'restricted_msg', 'user', 'email', 'success', 'editsuccess', 'pwdchangerr', 'pwdchangesuccess', 'pwdreseterr', 'pwdresetsuccess' );
foreach ( $wpmem_dialogs as $key => $val ) {
$new_arr[ $new_keys[ $key ] ] = $val;
}
update_option( 'wpmembers_dialogs', $new_arr, '', 'yes' );
}
return;
}
/**
* Downgrades dialogs array for pre-3.1.1 version rollback.
*
* @since 3.1.1
*/
function wpmem_downgrade_dialogs() {
$wpmem_dialogs = get_option( 'wpmembers_dialogs' );
if ( array_key_exists( 'restricted_msg', $wpmem_dialogs ) ) {
// Update is needed.
$new_arr = array();
$i = 0;
foreach ( $wpmem_dialogs as $key => $val ) {
$new_arr[ $i ] = $val;
$i++;
}
update_option( 'wpmembers_dialogs', $new_arr, '', 'yes' );
}
return;
}
/**
* Checks the captcha settings and updates accordingly.
*
* Was update_captcha() since 2.9.5, changed to wpmem_update_captcha() in 3.0.
*
* @since 2.9.5
* @since 3.0.0 Changed from update_captcha() to wpmem_update_captcha().
* @since 3.1.0 Changed from wpmem_update_captcha() to wpmem_upgrade_captcha().
*/
function wpmem_upgrade_captcha() {
$captcha_settings = get_option( 'wpmembers_captcha' );
// If there captcha settings, update them.
if ( $captcha_settings && ! array_key_exists( 'recaptcha', $captcha_settings ) ) {
// Check to see if the array keys are numeric.
$is_numeric = false;
foreach ( $captcha_settings as $key => $setting ) {
$is_numeric = ( is_int( $key ) ) ? true : $is_numeric;
}
if ( $is_numeric ) {
$new_captcha = array();
// These are old recaptcha settings.
$new_captcha['recaptcha']['public'] = $captcha_settings[0];
$new_captcha['recaptcha']['private'] = $captcha_settings[1];
$new_captcha['recaptcha']['theme'] = $captcha_settings[2];
update_option( 'wpmembers_captcha', $new_captcha );
}
}
return;
}
/**
* Does install of default settings.
*
* @since 3.1.5
* @since 3.1.6 Returns $wpmem_settings
*
* @return array $wpmem_settings
*/
function wpmem_install_settings() {
$wpmem_settings = array(
'version' => WPMEM_VERSION,
'db_version' => WPMEM_DB_VERSION,
'block' => array(
'post' => ( is_multisite() ) ? 0 : 1,
'page' => 0,
),
'show_excerpt' => array(
'post' => 0,
'page' => 0,
),
'show_reg' => array(
'post' => 1,
'page' => 1,
),
'show_login' => array(
'post' => 1,
'page' => 1,
),
'autoex' => array(
'post' => array( 'enabled' => 0, 'length' => '' ),
'page' => array( 'enabled' => 0, 'length' => '' ),
),
'enable_products' => 0,
'clone_menus' => 0,
'notify' => 0,
'mod_reg' => 0,
'captcha' => 0,
'use_exp' => 0,
'use_trial' => 0,
'warnings' => 0,
'user_pages' => array(
'profile' => '',
'register' => '',
'login' => '',
),
'cssurl' => '',
'select_style' => 'generic-no-float',
'attrib' => 0,
'post_types' => array(),
'form_tags' => array( 'default' => 'Registration Default' ),
);
// Using update_option to allow for forced update.
update_option( 'wpmembers_settings', $wpmem_settings, '', 'yes' );
return $wpmem_settings;
}
/**
* Installs default fields.
*
* @since 3.1.5
*
* @return array $fields {
* @type array {
* order,
* label,
* meta key,
* type,
* display,
* required,
* native,
* checked value,
* checked by default,
* }
* }
*/
function wpmem_install_fields() {
$fields = array(
array( 0, 'Choose a Username', 'username', 'text', 'y', 'y', 'y' ),
array( 1, 'First Name', 'first_name', 'text', 'y', 'y', 'y' ),
array( 2, 'Last Name', 'last_name', 'text', 'y', 'y', 'y' ),
array( 3, 'Address 1', 'billing_address_1', 'text', 'y', 'y', 'n' ),
array( 4, 'Address 2', 'billing_address_2', 'text', 'y', 'n', 'n' ),
array( 5, 'City', 'billing_city', 'text', 'y', 'y', 'n' ),
array( 6, 'State', 'billing_state', 'text', 'y', 'y', 'n' ),
array( 7, 'Zip', 'billing_postcode', 'text', 'y', 'y', 'n' ),
array( 8, 'Country', 'billing_country', 'text', 'y', 'y', 'n' ),
array( 9, 'Phone', 'billing_phone', 'text', 'y', 'y', 'n' ),
array( 10, 'Email', 'user_email', 'email', 'y', 'y', 'y' ),
array( 11, 'Confirm Email', 'confirm_email', 'email', 'n', 'n', 'n' ),
array( 12, 'Website', 'user_url', 'url', 'n', 'n', 'y' ),
array( 13, 'Biographical Info', 'description', 'textarea', 'n', 'n', 'y' ),
array( 14, 'Password', 'password', 'password', 'n', 'n', 'n' ),
array( 15, 'Confirm Password', 'confirm_password', 'password', 'n', 'n', 'n' ),
array( 16, 'Terms of Service', 'tos', 'checkbox', 'n', 'n', 'n', 'agree', 'n' ),
);
update_option( 'wpmembers_fields', $fields, '', 'yes' ); // using update_option to allow for forced update
return $fields;
}
/**
* Installs default dialogs.
*
* @since 3.1.5
*/
function wpmem_install_dialogs() {
$wpmem_dialogs_arr = array(
'restricted_msg' => "This content is restricted to site members. If you are an existing user, please log in. New users may register below.",
'user' => "Sorry, that username is taken, please try another.",
'email' => "Sorry, that email address already has an account.<br />Please try another.",
'success' => "Congratulations! Your registration was successful.<br /><br />You may now log in using the password that was emailed to you.",
'editsuccess' => "Your information was updated!",
'pwdchangerr' => "Passwords did not match.<br /><br />Please try again.",
'pwdchangesuccess' => "Password successfully changed!",
'pwdreseterr' => "Either the username or email address do not exist in our records.",
'pwdresetsuccess' => "Password successfully reset!<br /><br />An email containing a new password has been sent to the email address on file for your account.",
);
// Insert TOS dialog placeholder.
$dummy_tos = "Put your TOS (Terms of Service) text here. You can use HTML markup.";
update_option( 'wpmembers_tos', $dummy_tos );
update_option( 'wpmembers_dialogs', $wpmem_dialogs_arr, '', 'yes' ); // using update_option to allow for forced update
}
/**
* Upgrades fields settings.
*
* @since 3.2.0
*/
function wpmem_upgrade_fields() {
$fields = get_option( 'wpmembers_fields' );
$old_style = false;
foreach ( $fields as $key => $val ) {
if ( is_numeric( $key ) ) {
$old_style = true;
$check_array[] = $val[2];
}
}
if ( $old_style && ! in_array( 'username', $check_array ) ) {
$username_array = array( 0, 'Choose a Username', 'username', 'text', 'y', 'y', 'y' );
array_unshift( $fields, $username_array );
update_option( 'wpmembers_fields', $fields, '', 'yes' );
}
}
/**
* Upgrades the stylesheet setting from pre-3.0.
*
* This is a basic fix for users who have a WP-Members packaged stylesheet saved
* with the full URL. I believe 90% or more users simply use the default stylesheet
* so this should handle most updates.
*
* @since 3.2.7
*
* @param array $settings
*/
function wpmem_upgrade_style_setting( $settings ) {
/*
* IF $settings['style'] is "use_custom", then it's a custom value. Otherwise
* it's the value in $settings['style'].
*
* We need to first check the simple - if it's use_custom - set the new value
* to the custom value ($settings['cssurl']).
*
* Next, logically determine if it's a self-loaded custom value (unlikely),
* or a WP-Members default.
*
* Lastly, as a fallback, set it to the default no-float sheet.
*/
$wpmem_dir = plugin_dir_url ( __DIR__ );
if ( isset( $settings['style'] ) ) {
if ( 'use_custom' == $settings['style'] ) {
// Check to see if the custom value is a default stylesheet.
$chk_path_for = '/wp-content/plugins/wp-members/css/';
if ( strpos( $settings['cssurl'], $chk_path_for ) ) {
$strpos = strpos( $settings['cssurl'], $chk_path_for );
$substr = substr( $settings['cssurl'], $strpos );
$style = str_replace( array( $chk_path_for, '.css' ), array( '','' ), $substr );
return $style;
}
return $settings['style'];
} else {
// we don't care here if it's http:// or https://
$string = str_replace( array( 'http://', 'https://' ), array( '','' ), $settings['style'] );
if ( ! strpos( $wpmem_dir, $string ) ) {
$pieces = explode( '/', $string );
$slug = str_replace( '.css', '', end( $pieces ) );
// Is $css_slug one of the "official" slugs?
$haystack = array( 'generic-no-float', 'generic-rigid', 'wp-members-2016-no-float', 'wp-members-2015', 'wp-members-2015-no-float', 'wp-members-2014', 'wp-members-2014-no-float' );
if ( in_array( $slug, $haystack ) ) {
return $slug;
}
} else {
// Fallback to purposely load custom value for updating.
return 'use_custom';
}
}
} else {
$maybe_style = get_option( 'wpmembers_style' );
if ( $maybe_style ) {
// Does stylesheet setting point to the WP-Members /css/ directory?
if ( strpos( $maybe_style, $wpmem_dir ) ) {
return str_replace( array( $wpmem_dir . 'css/', '.css' ), array( '', '' ), $settings['style'] );
}
}
}
// Fallback default.
return 'generic-no-float';
}
/**
* Upgrades product expiration meta from a single meta array
* to individual meta for each product. Single meta array is
* still maintained for legacy reasons and rollback possiblity.
*
* @since 3.3.0
*/
function wpmem_upgrade_product_expiration() {
$users = get_users( array( 'fields'=>'ID' ) );
foreach ( $users as $user_id ) {
$products = get_user_meta( $user_id, '_wpmem_products', true );
// If the user has legacy products, update to new single meta.
if ( $products ) {
// Update each product meta.
foreach ( $products as $key => $product ) {
// If it's an expiration product,
if ( ! is_bool( $product ) ) {
if ( DateTime::createFromFormat( 'Y-m-d H:i:s', $product ) !== FALSE ) {
$value = strtotime( $product );
}
} else {
$value = $product;
}
// Save new meta
if ( $key ) {
update_user_meta( $user_id, '_wpmem_products_' . $key, $value );
}
}
}
}
}
/**
* Adds the user email validation success email.<br>8
*
* @since 3.3.8
*/
function wpmem_upgrade_validation_email() {
$subj = 'Thank you for confirming your email for your [blogname] account';
$body = 'Thank you for confirming your email address for access to [blogname]!';
$arr = array(
"subj" => $subj,
"body" => $body,
);
if ( ! get_option( 'wpmembers_email_validated' ) ) {
update_option( 'wpmembers_email_validated', $arr, false );
}
$arr = $subj = $body = '';
}
/**
* Adds woo_reg settings.
*
* @since 3.3.8
*/
function wpmem_upgrade_woo_reg() {
$wpmem_settings = get_option( 'wpmembers_settings' );
if ( ! isset( $wpmem_settings['woo'] ) ) {
$wpmem_settings['woo'] = array(
'add_my_account_fields' => 1,
'add_checkout_fields' => 1,
);
update_option( 'wpmembers_settings', $wpmem_settings );
}
}
// End of file.
Zerion Mini Shell 1.0