wp-members-install.php

<?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 http://rocketgeek.com
 * Copyright (c) 2006-2015  Chad Butler
 * WP-Members(tm) is a trademark of butlerblog.com
 *
 * @package WordPress
 * @subpackage WP-Members
 * @author Chad Butler
 * @copyright 2006-2015
 *
 * Functions included:
 * - wpmem_do_install
 * - wpmem_update_settings
 * - wpmem_append_email
 * - wpmem_update_captcha
 */

 
/**
 * Installs or upgrades the plugin.
 *
 * @since 2.2.2
 */
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;

	if ( ! get_option( 'wpmembers_settings' ) || $chk_force == true ) {

		// This is a clean install (or an upgrade from 2.1 or earlier).
		
		$wpmem_settings = array(
			'version' => WPMEM_VERSION,
			'block'   => array(
				'post' => 1,
				'page' => 0,
			),
			'show_excerpt' => array(
				'post' => 0,
				'page' => 0,
			),
			'show_reg' => array(
				'post' => 1,
				'page' => 1,
			),
			'show_login' => array(
				'post' => 1,
				'page' => 1,
			),
			'notify'    => 0,
			'mod_reg'   => 0,
			'captcha'   => 0,
			'use_exp'   => 0,
			'use_trial' => 0,
			'warnings'  => 0,
			'user_pages' => array(
				'profile'  => '',
				'register' => '',
				'login'    => '',
			),
			'cssurl'    => '',
			'style'     => plugin_dir_url ( __FILE__ ) . 'css/generic-no-float.css',
			'autoex'    => array(
				'auto_ex'     => '',
				'auto_ex_len' => '',
			),
			'attrib'    => 0,
		);

		// Using update_option to allow for forced update.
		update_option( 'wpmembers_settings', $wpmem_settings, '', 'yes' );

		/*
		 * Field array elements:
		 * 
		 * 	array(
		 * 		order, 
		 * 		label, 
		 *		optionname, 
		 * 		type, 
		 * 		display, 
		 * 		required, 
		 * 		native, 
		 * 		checked value, 
		 * 		checked by default,
		 * 	);
		 */
		$wpmem_fields_options_arr = array(
			array( 1,  'First Name',         'first_name',       'text',     'y', 'y', 'y' ),
			array( 2,  'Last Name',          'last_name',        'text',     'y', 'y', 'y' ),
			array( 3,  'Address 1',          'addr1',            'text',     'y', 'y', 'n' ),
			array( 4,  'Address 2',          'addr2',            'text',     'y', 'n', 'n' ),
			array( 5,  'City',               'city',             'text',     'y', 'y', 'n' ),
			array( 6,  'State',              'thestate',         'text',     'y', 'y', 'n' ),
			array( 7,  'Zip',                'zip',              'text',     'y', 'y', 'n' ),
			array( 8,  'Country',            'country',          'text',     'y', 'y', 'n' ),
			array( 9,  'Day Phone',          'phone1',           'text',     'y', 'y', 'n' ),
			array( 10, 'Email',              'user_email',       'text',     'y', 'y', 'y' ),
			array( 11, 'Confirm Email',      'confirm_email',    'text',     'n', 'n', 'n' ),
			array( 12, 'Website',            'user_url',         'text',     '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, 'TOS',                'tos',              'checkbox', 'n', 'n', 'n', 'agree', 'n' ),
		);

		update_option( 'wpmembers_fields', $wpmem_fields_options_arr, '', 'yes' ); // using update_option to allow for forced update

		$wpmem_dialogs_arr = array(
			"This content is restricted to site members.  If you are an existing user, please log in.  New users may register below.",
			"Sorry, that username is taken, please try another.",
			"Sorry, that email address already has an account.<br />Please try another.",
			"Congratulations! Your registration was successful.<br /><br />You may now log in using the password that was emailed to you.",
			"Your information was updated!",
			"Passwords did not match.<br /><br />Please try again.",
			"Password successfully changed!",
			"Either the username or email address do not exist in our records.",
			"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
		wpmem_append_email();

		// If it's a new install, use the Twenty Twelve stylesheet.
		update_option( 'wpmembers_style', plugin_dir_url ( __FILE__ ) . 'css/generic-no-float.css', '', 'yes' );

	} else {
		
		wpmem_update_settings();
		wpmem_update_captcha();
		wpmem_update_dialogs();
		wpmem_append_email();
		
	}
}


/**
 * Updates the existing settings if doing an update.
 *
 * @since 3.0
 *
 * @return array $wpmem_newsettings
 */
function wpmem_update_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 ( $is_three ) {
		return;
	} else {

		// Can only upgrade from 2.5.1 or higher.
		$show_reg = ( $wpmem_settings[7] == 0 ) ? 1 : 0;
		$wpmem_newsettings = array(
			'version' => WPMEM_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'    => $wpmem_settings[6],
			'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' ),
			'style'      => get_option( 'wpmembers_style'  ),
			'autoex'     => get_option( 'wpmembers_autoex' ),
			'attrib'     => get_option( 'wpmembers_attrib' ),
		);
		
		$wpmem_newsettings = array_merge( $wpmem_settings, $wpmem_newsettings ); 
		
		update_option( 'wpmembers_settings', $wpmem_newsettings );

		// Final 3.0 will remove the following settings when updating. 
		/*
		delete_option( 'wpmembers_msurl'  );
		delete_option( 'wpmembers_regurl' );
		delete_option( 'wpmembers_logurl' );
		delete_option( 'wpmembers_cssurl' );
		delete_option( 'wpmembers_style'  );
		delete_option( 'wpmembers_autoex' );
		delete_option( 'wpmembers_attrib' );
		*/
		
		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 login here:
[reglink]

You may change your password here:
[members-area]
';

	$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 login and change your password here:
[members-area]

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 );
	}

	return true;
}


/**
 * Checks the dialogs array for string changes.
 *
 * Was update_dialogs() since 2.9.3, changed to wpmem_update_dialogs() in 3.0.
 *
 * @since 2.9.3
 */
function wpmem_update_dialogs() {

	$wpmem_dialogs_arr = get_option( 'wpmembers_dialogs' );
	$do_update = false;

	if ( $wpmem_dialogs_arr[0] == "This content is restricted to site members.  If you are an existing user, please login.  New users may register below." ) {
		$wpmem_dialogs_arr[0] = "This content is restricted to site members.  If you are an existing user, please log in.  New users may register below.";
		$do_update = true;
	}

	if ( $wpmem_dialogs_arr[3] == "Congratulations! Your registration was successful.<br /><br />You may now login using the password that was emailed to you." ) {
		$wpmem_dialogs_arr[3] = "Congratulations! Your registration was successful.<br /><br />You may now log in using the password that was emailed to you.";
		$do_update = true;
	}

	if ( $do_update ) {
		update_option( 'wpmembers_dialogs', $wpmem_dialogs_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
 */
function wpmem_update_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;
}

/** End of File **/