bb-config.php in the root directory of your bbPress installation.' ),
__( 'If you\'re not sure what to put here, contact your web hosting provider.' )
),
'messages' => array()
),
2 => array(
'title' => sprintf( __( '%1$s › %2$s' ), __( 'bbPress installer' ), __( 'Step 2' ) ),
'h2' => sprintf( __( '%1$s - %2$s' ), __( 'Step 2' ), __( 'WordPress integration (optional)' ) ),
'status' => __( '« skipped' ),
'intro' => array(
__( 'bbPress can integrate login and user data seamlessly with WordPress. You can safely skip this step if you do not wish to integrate with an existing WordPress install.' )
),
'messages' => array(),
'form_errors' => array()
),
3 => array(
'title' => sprintf( __( '%1$s › %2$s' ), __( 'bbPress installer' ), __( 'Step 3' ) ),
'h2' => sprintf( __( '%1$s - %2$s' ), __( 'Step 3' ), __( 'Site settings' ) ),
'status' => '',
'intro' => array(
__( 'Finalize your installation by adding a name, your first user and your first forum.' )
),
'messages' => array(),
'form_errors' => array(),
'scripts' => array()
),
4 => array(
'title' => sprintf( __( '%1$s › %2$s' ), __( 'bbPress installer' ), __( 'Finished' ) ),
'h2' => __( 'Installation complete!' ),
'messages' => array()
)
);
}
/**
* Check installation pre-requisites
*
* Checks for appropriate PHP extensions.
*
* @return boolean False if any pre-requisites are not met, otherwise true
*/
function check_prerequisites()
{
// BPDB wants the MySQL extension - this is also checked when BPDB is initialised so may be a bit redundant here
if ( !extension_loaded( 'mysql' ) ) {
$this->strings[-1]['messages']['error'][] = __( 'Your PHP installation appears to be missing the MySQL extension which is required for bbPress' );
$this->step = -1;
}
if ( defined( 'BB_IS_WP_LOADED' ) && BB_IS_WP_LOADED ) {
$this->strings[-1]['messages']['error'][] = __( 'Please complete your installation before attempting to include WordPress within bbPress' );
$this->step = -1;
}
if ( $this->step === -1 ) {
return false;
}
return true;
}
/**
* Define path constants
*
* Sets some bbPress constants if they are not otherwise available based
* on the classes initiating file path.
*
* @return boolean False if no path was supplied, otherwise always true
*/
function define_paths()
{
if ( !$this->caller ) {
return false;
}
if ( !defined( 'BACKPRESS_PATH' ) ) {
// Define BACKPRESS_PATH
// Tell us to load includes because bb-settings.php was not loaded
// bb-settings.php is generally not loaded on steps -1, 0 and 1 but
// there are exceptions, so this is safer than just reading the step
$this->load_includes = true;
define( 'BACKPRESS_PATH', BB_PATH . BB_INC . 'backpress/' );
}
// Define the language file directory
if ( !defined( 'BB_LANG_DIR' ) ) {
define( 'BB_LANG_DIR', BB_PATH . 'my-languages/' );
}
return true;
}
/**
* Gets an array of available languages form the language directory
*
* @return array
*/
function get_languages()
{
foreach ( bb_glob( BB_LANG_DIR . '*.mo' ) as $language ) {
if ( substr( $language, 0, 18 ) === 'continents-cities-' ) {
continue;
}
$language = str_replace( '.mo', '', basename( $language ) );
$this->languages[$language] = $language;
}
return $this->languages;
}
/**
* Returns a language selector for switching installation languages
*
* @return string|false Either the html for the selector or false if there are no languages
*/
function get_language_selector()
{
// Don't provide a selection if there is only english
if ( 2 > count( $this->languages ) ) {
return false;
}
$r = '' . "\n";
//$r .= '' . "\n";
echo $r;
}
/**
* Sets the current installation language
*
* @return string The currently set language
*/
function set_language()
{
if ( isset( $_COOKIE['bb_install_language'] ) && 1 < count( $this->languages ) ) {
if ( in_array( $_COOKIE['bb_install_language'], $this->languages ) ) {
$this->language = $_COOKIE['bb_install_language'];
}
}
$language_requested = false;
if ( isset( $_POST['language'] ) && $_POST['language'] ) {
$language_requested = (string) $_POST['language'];
} elseif ( isset( $_GET['language'] ) && $_GET['language'] ) {
$language_requested = (string) $_GET['language'];
}
if ( $language_requested && 1 < count( $this->languages ) ) {
if ( in_array( $language_requested, $this->languages ) ) {
$this->language = $language_requested;
setcookie( 'bb_install_language', $this->language );
}
}
if ( !$this->language || 'en_US' === $this->language ) {
$this->language = 'en_US';
setcookie( 'bb_install_language', ' ', time() - 31536000 );
}
return $this->language;
}
/**
* Tests whether database tables exist
*
* Checks for the existence of the forum table in the database that is
* currently configured.
*
* @return boolean False if the table isn't found, otherwise true
*/
function database_tables_are_installed()
{
global $bbdb;
$bbdb->suppress_errors();
$installed = (boolean) $bbdb->get_results( 'DESCRIBE `' . $bbdb->forums . '`;', ARRAY_A );
$bbdb->suppress_errors( false );
return $installed;
}
/**
* Tests whether an option is set in the database
*
* @return boolean False if the option isn't set, otherwise true
*/
function bb_options_are_set()
{
if ( $this->load_includes ) {
return false;
}
if ( !bb_get_option( 'uri' ) ) {
return false;
}
return true;
}
/**
* Tests whether bbPress is installed
*
* @return boolean False if bbPress isn't installed, otherwise true
*/
function is_installed()
{
if ( !$this->database_tables_are_installed() ) {
return false;
}
if ( !$this->bb_options_are_set() ) {
return false;
}
return true;
}
/**
* Checks for configs and sets variables describing current install state
*
* @return integer The current step we should be on based on the existence of the config file
*/
function check_configs()
{
// Check for a config file
if ( file_exists( BB_PATH . 'bb-config.php' ) ) {
$this->configs['bb-config.php'] = BB_PATH . 'bb-config.php';
} elseif ( file_exists( dirname( BB_PATH ) . '/bb-config.php' ) ) {
$this->configs['bb-config.php'] = dirname( BB_PATH ) . '/bb-config.php';
}
// Check for an old config file
if ( file_exists( BB_PATH . 'config.php' ) ) {
$this->configs['config.php'] = BB_PATH . 'config.php';
} elseif ( file_exists( dirname( BB_PATH ) . '/config.php' ) ) {
$this->configs['config.php'] = dirname( BB_PATH ) . '/config.php';
}
if ( $this->configs['config.php'] && !$this->configs['bb-config.php'] ) {
// There is an old school config file
// Step -1 is where we send fatal errors from any screen
$this->strings[-1]['messages']['error'][] = __( 'An old config.php file has been detected in your installation. You should remove it and run the installer again. You can use the same database connection details if you do.' );
$this->step = -1;
return $this->step;
}
// Check if bbPress is already installed
// Is there a current config file
if ( $this->configs['bb-config.php'] ) {
// Is it valid
if ( $this->validate_current_config() ) {
// Step 1 is complete
$this->step_status[1] = 'complete';
$this->strings[1]['status'] = __( '« completed' );
// On step 1 we want to report that the file is good and allow the user to continue
if ( $this->step === 1 ) {
// Stop form processing if it is posted
$this->stop_process = true;
// Display a nice message saying the config file exists
$this->strings[1]['messages']['message'][] = __( 'A valid configuration file was found at bb-config.phpbb-config.phpbb-config-sample.phpbb-config.php file. This usually means that you want to install bbPress.' );
$this->step = 0;
}
}
// Check if the config file path is writable
if ( file_exists( $this->configs['bb-config.php'] ) ) {
if ( is_writable( $this->configs['bb-config.php'] ) ) {
$this->configs['writable'] = true;
}
} elseif ( is_writable( BB_PATH ) ) {
$this->configs['writable'] = true;
}
return $this->step;
}
/**
* Determines if the current config is valid
*
* @return boolean False if the config is bad, otherwise true
*/
function validate_current_config()
{
// If we are validating then the config file has already been included
// So we can just check for valid constants
// The required constants for a valid config file
$required_constants = array(
'BBDB_NAME',
'BBDB_USER',
'BBDB_PASSWORD',
'BBDB_HOST'
);
// Check the required constants are defined
foreach ( $required_constants as $required_constant ) {
if ( !defined( $required_constant ) ) {
return false;
}
}
global $bb_table_prefix;
if ( !isset( $bb_table_prefix ) ) {
return false;
}
// Everthing is OK so far, validate the connection as well
return $this->validate_current_database();
}
/**
* Validates the current database settings
*
* @return boolean False if the current database isn't valid, otherwise true
*/
function validate_current_database()
{
global $bbdb;
$db = $bbdb->db_connect( "SELECT * FROM $bbdb->forums LIMIT 1" );
if ( !is_resource( $db ) ) {
return false;
}
return true;
}
/**
* Sets up default values for input data as well as labels and notes
*
* @return void
*/
function prepare_data()
{
/**
* Should be exactly the same as the default value of the KEYS in bb-config-sample.php
* @since 1.0
*/
$_bb_default_secret_key = 'put your unique phrase here';
$this->data = array(
0 => array(
'form' => array(
'forward_0_0' => array(
'value' => __( 'Go to step 1' )
)
)
),
1 => array(
'form' => array(
'bbdb_name' => array(
'value' => '',
'label' => __( 'Database name' ),
'note' => __( 'The name of the database in which you want to run bbPress.' )
),
'bbdb_user' => array(
'value' => '',
'label' => __( 'Database user' ),
'note' => __( 'The database user that has access to that database.' ),
'autocomplete' => 'off'
),
'bbdb_password' => array(
'type' => 'password',
'value' => '',
'label' => __( 'Database password' ),
'note' => __( 'That database user\'s password.' ),
'autocomplete' => 'off'
),
'bb_lang' => array(
'value' => '',
'label' => __( 'Language' ),
'note' => sprintf( __( 'The language which bbPress will be presented in once installed. Your current installer language choice (%s) will be the same for the rest of the install process.' ), $this->language )
),
'toggle_1' => array(
'value' => 0,
'label' => __( 'Show advanced settings' ),
'note' => __( 'These settings usually do not have to be changed.' ),
'checked' => '',
'display' => 'none'
),
'bbdb_host' => array(
'value' => 'localhost',
'label' => __( 'Database host' ),
'note' => __( 'The domain name or IP address of the server where the database is located. If the database is on the same server as the web site, then this probably should remain localhost.' ),
'prerequisite' => 'toggle_1'
),
'bbdb_charset' => array(
'value' => 'utf8',
'label' => __( 'Database character set' ),
'note' => __( 'The best choice is utf8, but you will need to match the character set which you created the database with.' ),
'prerequisite' => 'toggle_1'
),
'bbdb_collate' => array(
'value' => '',
'label' => __( 'Database character collation' ),
'note' => __( 'The character collation value set when the database was created.' ),
'prerequisite' => 'toggle_1'
),
/*
'bb_auth_key' => array(
'value' => $_bb_default_secret_key,
'label' => __( 'bbPress "auth" cookie key' ),
'note' => __( 'This should be a unique and secret phrase, it will be used to make your bbPress "auth" cookie unique and harder for an attacker to decipher.' ),
'prerequisite' => 'toggle_1'
),
'bb_secure_auth_key' => array(
'value' => $_bb_default_secret_key,
'label' => __( 'bbPress "secure auth" cookie key' ),
'note' => __( 'This should be a unique and secret phrase, it will be used to make your bbPress "secure auth" cookie unique and harder for an attacker to decipher.' ),
'prerequisite' => 'toggle_1'
),
'bb_logged_in_key' => array(
'value' => $_bb_default_secret_key,
'label' => __( 'bbPress "logged in" cookie key' ),
'note' => __( 'This should be a unique and secret phrase, it will be used to make your bbPress "logged in" cookie unique and harder for an attacker to decipher.' ),
'prerequisite' => 'toggle_1'
),
'bb_nonce_key' => array(
'value' => $_bb_default_secret_key,
'label' => __( 'bbPress "nonce" key' ),
'note' => __( 'This should be a unique and secret phrase, it will be used to make form submission harder for an attacker to spoof.' ),
'prerequisite' => 'toggle_1'
),
*/
'bb_table_prefix' => array(
'value' => 'bb_',
'label' => __( 'Table name prefix' ),
'note' => __( 'If you are running multiple bbPress sites in a single database, you will probably want to change this.' ),
'prerequisite' => 'toggle_1'
),
'config' => array(
'value' => '',
'label' => __( 'Contents for bb-config.php' ),
'note' => __( 'Once you have created the configuration file, you can check for it below.' )
),
'forward_1_0' => array(
'value' => __( 'Save database configuration file' )
),
'back_1_1' => array(
'value' => __( '« Go back' )
),
'forward_1_1' => array(
'value' => __( 'Check for configuration file' )
),
'forward_1_2' => array(
'value' => __( 'Go to step 2' )
)
)
),
2 => array(
'form' => array(
'toggle_2_0' => array(
'value' => 0,
'label' => __( 'Add integration settings' ),
'note' => __( 'If you want to integrate bbPress with an existing WordPress site.' ),
'checked' => '',
'display' => 'none',
'toggle_value' => array(
'target' => 'forward_2_0',
'off_value' => __( 'Skip WordPress integration' ),
'on_value' => __( 'Save WordPress integration settings' )
)
),
'toggle_2_1' => array(
'value' => 0,
'label' => __( 'Add cookie integration settings' ),
'note' => __( 'If you want to allow shared logins with an existing WordPress site.' ),
'checked' => '',
'display' => 'none',
'prerequisite' => 'toggle_2_0'
),
'wp_siteurl' => array(
'value' => '',
'label' => __( 'WordPress address (URL)' ),
'note' => __( 'This value should exactly match the WordPress address (URL) setting in your WordPress general settings.' ),
'prerequisite' => 'toggle_2_1'
),
'wp_home' => array(
'value' => '',
'label' => __( 'Blog address (URL)' ),
'note' => __( 'This value should exactly match the Blog address (URL) setting in your WordPress general settings.' ),
'prerequisite' => 'toggle_2_1'
),
'wp_auth_key' => array(
'value' => '',
'label' => __( 'WordPress "auth" cookie key' ),
'note' => __( 'This value must match the value of the constant named "AUTH_KEY" in your WordPress wp-config.php file. This will replace the bbPress "auth" cookie key set in the first step.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'wp_auth_salt' => array(
'value' => '',
'label' => __( 'WordPress "auth" cookie salt' ),
'note' => __( 'This must match the value of the WordPress setting named "auth_salt" in your WordPress site. Look for the option labeled "auth_salt" in this WordPress admin page. If you leave this blank the installer will try to fetch the value based on your WordPress database integration settings.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'wp_secure_auth_key' => array(
'value' => '',
'label' => __( 'WordPress "secure auth" cookie key' ),
'note' => __( 'This value must match the value of the constant named "SECURE_AUTH_KEY" in your WordPress wp-config.php file. This will replace the bbPress "secure auth" cookie key set in the first step.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'wp_secure_auth_salt' => array(
'value' => '',
'label' => __( 'WordPress "secure auth" cookie salt' ),
'note' => __( 'This must match the value of the WordPress setting named "secure_auth_salt" in your WordPress site. Look for the option labeled "secure_auth_salt" in this WordPress admin page. If you leave this blank the installer will try to fetch the value based on your WordPress database integration settings. Sometimes this value is not set in WordPress, in that case you can leave this setting blank as well.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'wp_logged_in_key' => array(
'value' => '',
'label' => __( 'WordPress "logged in" cookie key' ),
'note' => __( 'This value must match the value of the constant named "LOGGED_IN_KEY" in your WordPress wp-config.php file. This will replace the bbPress "logged in" cookie key set in the first step.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'wp_logged_in_salt' => array(
'value' => '',
'label' => __( 'WordPress "logged in" cookie salt' ),
'note' => __( 'This must match the value of the WordPress setting named "logged_in_salt" in your WordPress site. Look for the option labeled "logged_in_salt" in this WordPress admin page. If you leave this blank the installer will try to fetch the value based on your WordPress database integration settings.' ),
'prerequisite' => 'toggle_2_1',
'autocomplete' => 'off'
),
'toggle_2_2' => array(
'value' => 0,
'label' => __( 'Add user database integration settings' ),
'note' => __( 'If you want to share user data with an existing WordPress site.' ),
'checked' => '',
'display' => 'none',
'prerequisite' => 'toggle_2_0'
),
'wp_table_prefix' => array(
'value' => 'wp_',
'default_value' => '', // Used when setting is ignored
'label' => __( 'User database table prefix' ),
'note' => __( 'If your bbPress and WordPress sites share the same database, then this is the same value as $table_prefix in your WordPress wp-config.php file. It is usually wp_.' ),
'prerequisite' => 'toggle_2_2'
),
'wordpress_mu_primary_blog_id' => array(
'value' => '',
'default_value' => '',
'label' => __( 'WordPress MU primary blog ID' ),
'note' => __( 'If you are integrating with a WordPress MU site you need to specify the primary blog ID for that site. It is usually 1. You should probably leave this blank if you are integrating with a standard WordPress site' ),
'prerequisite' => 'toggle_2_2'
),
'toggle_2_3' => array(
'value' => 0,
'label' => __( 'Show advanced database settings' ),
'note' => __( 'If your bbPress and WordPress site do not share the same database, then you will need to add advanced settings.' ),
'checked' => '',
'display' => 'none',
'prerequisite' => 'toggle_2_2'
),
'user_bbdb_name' => array(
'value' => '',
'label' => __( 'User database name' ),
'note' => __( 'The name of the database in which your user tables reside.' ),
'prerequisite' => 'toggle_2_3'
),
'user_bbdb_user' => array(
'value' => '',
'label' => __( 'User database user' ),
'note' => __( 'The database user that has access to that database.' ),
'prerequisite' => 'toggle_2_3',
'autocomplete' => 'off'
),
'user_bbdb_password' => array(
'type' => 'password',
'value' => '',
'label' => __( 'User database password' ),
'note' => __( 'That database user\'s password.' ),
'prerequisite' => 'toggle_2_3',
'autocomplete' => 'off'
),
'user_bbdb_host' => array(
'value' => '',
'label' => __( 'User database host' ),
'note' => __( 'The domain name or IP address of the server where the database is located. If the database is on the same server as the web site, then this probably should be localhost.' ),
'prerequisite' => 'toggle_2_3'
),
'user_bbdb_charset' => array(
'value' => '',
'label' => __( 'User database character set' ),
'note' => __( 'The best choice is utf8, but you will need to match the character set which you created the database with.' ),
'prerequisite' => 'toggle_2_3'
),
'user_bbdb_collate' => array(
'value' => '',
'label' => __( 'User database character collation' ),
'note' => __( 'The character collation value set when the user database was created.' ),
'prerequisite' => 'toggle_2_3'
),
'custom_user_table' => array(
'value' => '',
'label' => __( 'User database "user" table' ),
'note' => __( 'The complete table name, including any prefix.' ),
'prerequisite' => 'toggle_2_3'
),
'custom_user_meta_table' => array(
'value' => '',
'label' => __( 'User database "user meta" table' ),
'note' => __( 'The complete table name, including any prefix.' ),
'prerequisite' => 'toggle_2_3'
),
'forward_2_0' => array(
'value' => __( 'Skip WordPress integration' )
),
'back_2_1' => array(
'value' => __( '« Go back' )
),
'forward_2_1' => array(
'value' => __( 'Go to step 3' )
)
)
),
3 => array(
'form' => array(
'name' => array(
'value' => '',
'label' => __( 'Site name' ),
'note' => __( 'This is what you are going to call your bbPress site.' )
),
'uri' => array(
'value' => $this->guess_uri(),
'label' => __( 'Site address (URL)' ),
'note' => __( 'We have attempted to guess this; it\'s usually correct, but change it here if you wish.' )
),
'keymaster_user_login' => array(
'value' => '',
'maxlength' => 60,
'label' => __( '"Key Master" Username' ),
'note' => __( 'This is the user login for the initial bbPress administrator (known as a "Key Master").' ),
'autocomplete' => 'off'
),
'keymaster_user_email' => array(
'value' => '',
'maxlength' => 100,
'label' => __( '"Key Master" Email address' ),
'note' => __( 'The login details will be emailed to this address.' ),
'autocomplete' => 'off'
),
'keymaster_user_type' => array(
'value' => 'new'
),
'forum_name' => array(
'value' => '',
'maxlength' => 150,
'label' => __( 'First forum name' ),
'note' => __( 'This can be changed after installation, so don\'t worry about it too much.' )
),
'forward_3_0' => array(
'value' => __( 'Save site settings' )
),
'back_3_1' => array(
'value' => __( '« Go back' )
),
'forward_3_1' => array(
'value' => __( 'Complete the installation' )
)
)
),
4 => array(
'form' => array(
'toggle_4' => array(
'value' => 0,
'label' => __( 'Show installation messages' )
),
'error_log' => array(
'value' => '',
'label' => __( 'Installation errors' )
),
'installation_log' => array(
'value' => '',
'label' => __( 'Installation log' )
)
)
)
);
}
/**
* Guesses the final installed URI based on the location of the install script
*
* @return string The guessed URI
*/
function guess_uri()
{
global $bb;
if ( $bb->uri ) {
$uri = $bb->uri;
} else {
$schema = 'http://';
if ( isset( $_SERVER['HTTPS'] ) && strtolower( $_SERVER['HTTPS'] ) == 'on' ) {
$schema = 'https://';
}
$uri = preg_replace( '|/bb-admin/.*|i', '/', $schema . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
}
return rtrim( $uri, " \t\n\r\0\x0B/" ) . '/';
}
/**
* Writes the given alterations to file
*
* @param $file_source string The full path to the file to be read from
* @param $file_target string The full path to the file to be written to
* @param $alterations array An array of arrays containing alterations to be made
* @return void
*/
function write_lines_to_file( $file_source, $file_target, $alterations )
{
if ( !$file_source || !file_exists( $file_source ) || !is_file( $file_source ) ) {
return -1;
}
if ( !$file_target ) {
$file_target = $file_source;
}
if ( !$alterations || !is_array( $alterations ) ) {
return -2;
}
/*
Alterations array takes the form
array(
'1st 20 chars of line' => array( 'Search string', 'Replacement string' ),
'1st 20 chars of line' => array( 'Search string', 'Replacement string' )
);
*/
// Get the existing lines in the file
$lines = file( $file_source );
// Initialise an array to store the modified lines
$modified_lines = array();
// Loop through the lines and modify them
foreach ( $lines as $line ) {
if ( isset( $alterations[substr( $line, 0, 20 )] ) ) {
$alteration = $alterations[substr( $line, 0, 20 )];
$modified_lines[] = str_replace( $alteration[0], $alteration[1], $line );
} else {
$modified_lines[] = $line;
}
}
$writable = true;
if ( file_exists( $file_target ) ) {
if ( !is_writable( $file_target ) ) {
$writable = false;
}
} else {
$dir_target = dirname( $file_target );
if ( file_exists( $dir_target ) ) {
if ( !is_writable( $dir_target ) || !is_dir( $dir_target ) ) {
$writable = false;
}
} else {
$writable = false;
}
}
if ( !$writable ) {
return trim( join( null, $modified_lines ) );
}
// Open the file for writing - rewrites the whole file
$file_handle = fopen( $file_target, 'w' );
// Write lines one by one to avoid OS specific newline hassles
foreach ( $modified_lines as $modified_line ) {
if ( false !== strpos( $modified_line, '?>' ) ) {
$modified_line = '?>';
}
fwrite( $file_handle, $modified_line );
if ( $modified_line == '?>' ) {
break;
}
}
// Close the config file
fclose( $file_handle );
@chmod( $file_target, 0666 );
return 1;
}
/**
* Reports whether the request method is post or not
*
* @return boolean True if the page was posted, otherwise false
*/
function is_posted()
{
if ( 'post' === strtolower( $_SERVER['REQUEST_METHOD'] ) ) {
return true;
}
return false;
}
/**
* Determines which step the installer is on based on user input
*
* @return boolean Always returns true
**/
function set_step()
{
if ( $this->is_posted() ) {
switch ( $this->step ) {
case 1:
$this->set_language();
if ( $_POST['forward_0_0'] ) {
$this->stop_process = 1;
}
break;
case 2:
if ( $_POST['forward_1_2'] ) {
$this->stop_process = 1;
}
break;
case 3:
// If this is actually a request to go back to step 2
if ( $_POST['back_2_1'] ) {
$this->step = 2;
break;
}
// If we have come forward from step 2 then don't process form 3
if ( $_POST['forward_2_1'] ) {
$this->stop_process = true;
}
// Determine what the status of the previous step was based on input
if ( $_POST['toggle_2_0'] ) {
$this->strings[2]['status'] = __( '« completed' );
$this->step_status[2] = 'complete';
}
break;
case 4:
// Determine what the status of the previous step was based on input
if ( $_POST['toggle_2_0'] ) {
$this->strings[2]['status'] = __( '« completed' );
$this->step_status[2] = 'complete';
}
// If this is actually a request to go back to step 3
if ( $_POST['back_3_1'] ) {
$this->step = 3;
break;
}
// We have to have come forward from step 3
if ( $_POST['forward_3_1'] ) {
$this->strings[3]['status'] = __( '« completed' );
$this->step_status[3] = 'complete';
} else {
$this->step = 2;
}
break;
}
}
return true;
}
/**
* Sanitizes all data stored in the data array
*
* @return boolean Always returns true
**/
function sanitize_form_data()
{
foreach ( $this->data as $step => $data ) {
if ( isset( $data['form'] ) && is_array( $data['form'] ) ) {
foreach ( $data['form'] as $key => $value ) {
$this->data[$step]['form'][$key]['value'] = esc_attr( $value['value'] );
}
}
}
return true;
}
/**
* Directs processing of the form data based on the current step
*
* @return boolean Always returns true
**/
function process_form()
{
if ( $this->is_posted() && !$this->stop_process ) {
switch ( $this->step ) {
case 1:
$this->process_form_config_file();
break;
case 2:
$this->process_form_wordpress_integration();
break;
case 3:
$this->process_form_site_options();
break;
case 4:
$this->process_form_finalise_installation();
break;
}
}
return true;
}
/**
* Takes inputted form data and injects it into the data array
*
* @param integer $step Which steps data to process
* @return boolean Always returns true
**/
function inject_form_values_into_data( $step )
{
$data =& $this->data[$step]['form'];
foreach ( $data as $key => $value ) {
if ( 'forward_' !== substr( $key, 0, 8 ) && 'back_' !== substr( $key, 0, 5 ) ) {
if ( isset( $data[$key]['prerequisite'] ) && !$_POST[$data[$key]['prerequisite']] ) {
if ( isset( $data[$key]['default_value'] ) ) {
$data[$key]['value'] = $data[$key]['default_value'];
}
// do nothing - keep the default value
} else {
$data[$key]['value'] = stripslashes_deep( trim( $_POST[$key] ) );
}
}
}
return true;
}
/**
* Validates the supplied config file data and writes it to the config file.
*
* @return void
**/
function process_form_config_file()
{
$this->inject_form_values_into_data( 1 );
$data =& $this->data[1]['form'];
if ( 'en_US' == $data['bb_lang']['value'] ) {
$data['bb_lang']['value'] = '';
}
if ( $data['toggle_1']['value'] ) {
$data['toggle_1']['checked'] = 'checked="checked"';
$data['toggle_1']['display'] = 'block';
// Deal with slashes in the keys
//$data['bb_auth_key']['value'] = addslashes( stripslashes( $data['bb_auth_key']['value'] ) );
//$data['bb_secure_auth_key']['value'] = addslashes( stripslashes( $data['bb_secure_auth_key']['value'] ) );
//$data['bb_logged_in_key']['value'] = addslashes( stripslashes( $data['bb_logged_in_key']['value'] ) );
//$data['bb_nonce_key']['value'] = addslashes( stripslashes( $data['bb_nonce_key']['value'] ) );
}
$requested_prefix = $data['bb_table_prefix']['value'];
$data['bb_table_prefix']['value'] = preg_replace( '/[^0-9a-zA-Z_]/', '', $data['bb_table_prefix']['value'] );
if ( $requested_prefix !== $data['bb_table_prefix']['value'] ) {
$data['toggle_1']['checked'] = 'checked="checked"';
$data['toggle_1']['display'] = 'block';
$this->step_status[1] = 'incomplete';
$this->strings[1]['messages']['error'][] = __( 'The table prefix can only contain letters, numbers and underscores.bb-config-sample.phpbb-config.phpbb-config.php in the root directory of your bbPress installation before you can continue.' );
break;
}
}
/**
* Validates the WordPress integration settings
*
* @return void
**/
function process_form_wordpress_integration()
{
// Check the referer
bb_check_admin_referer( 'bbpress-installer' );
$this->inject_form_values_into_data( 2 );
$data =& $this->data[2]['form'];
// If there are no settings then goto step 3
if ( !$data['toggle_2_0']['value'] && !$_POST['back_2_1'] ) {
$this->step_status[2] = 'complete';
$this->strings[2]['messages']['message'][] = __( 'You have chosen to skip the WordPress integration step. You can always integrate WordPress later from within the admin area of bbPress.' );
return 'complete';
}
// If integration is selected
if ( $data['toggle_2_0']['value'] ) {
$data['toggle_2_0']['checked'] = 'checked="checked"';
$data['toggle_2_0']['display'] = 'block';
$data['forward_2_0']['value'] = $data['toggle_2_0']['toggle_value']['on_value'];
if ( $data['toggle_2_1']['value'] ) {
$data['toggle_2_1']['checked'] = 'checked="checked"';
$data['toggle_2_1']['display'] = 'block';
// Check the wp_siteurl URL for errors
$data['wp_siteurl']['value'] = $data['wp_siteurl']['value'] ? rtrim( $data['wp_siteurl']['value'], " \t\n\r\0\x0B/" ) . '/' : '';
$this->strings[2]['form_errors']['wp_siteurl'][] = empty( $data['wp_siteurl']['value'] ) ? 'empty' : false;
if ( $parsed = parse_url( $data['wp_siteurl']['value'] ) ) {
$this->strings[2]['form_errors']['wp_siteurl'][] = preg_match( '/https?/i', $parsed['scheme'] ) ? false : 'urlscheme';
$this->strings[2]['form_errors']['wp_siteurl'][] = empty( $parsed['host'] ) ? 'urlhost' : false;
} else {
$this->strings[2]['form_errors']['wp_siteurl'][] = 'urlparse';
}
// Check the wp_home URL for errors
$data['wp_home']['value'] = $data['wp_home']['value'] ? rtrim( $data['wp_home']['value'], " \t\n\r\0\x0B/" ) . '/' : '';
$this->strings[2]['form_errors']['wp_home'][] = empty( $data['wp_home']['value'] ) ? 'empty' : false;
if ( $parsed = parse_url( $data['wp_home']['value'] ) ) {
$this->strings[2]['form_errors']['wp_home'][] = preg_match( '/https?/i', $parsed['scheme'] ) ? false : 'urlscheme';
$this->strings[2]['form_errors']['wp_home'][] = empty( $parsed['host'] ) ? 'urlhost' : false;
} else {
$this->strings[2]['form_errors']['wp_home'][] = 'urlparse';
}
// Deal with slashes in the keys
$data['wp_auth_key']['value'] = addslashes( stripslashes( $data['wp_auth_key']['value'] ) );
$data['wp_auth_salt']['value'] = addslashes( stripslashes( $data['wp_auth_salt']['value'] ) );
$data['wp_secure_auth_key']['value'] = addslashes( stripslashes( $data['wp_secure_auth_key']['value'] ) );
$data['wp_secure_auth_salt']['value'] = addslashes( stripslashes( $data['wp_secure_auth_salt']['value'] ) );
$data['wp_logged_in_key']['value'] = addslashes( stripslashes( $data['wp_logged_in_key']['value'] ) );
$data['wp_logged_in_salt']['value'] = addslashes( stripslashes( $data['wp_logged_in_salt']['value'] ) );
// Check the keys for errors
$this->strings[2]['form_errors']['wp_auth_key'][] = empty( $data['wp_auth_key']['value'] ) ? 'empty' : false;
$this->strings[2]['form_errors']['wp_secure_auth_key'][] = empty( $data['wp_secure_auth_key']['value'] ) ? 'empty' : false;
$this->strings[2]['form_errors']['wp_logged_in_key'][] = empty( $data['wp_logged_in_key']['value'] ) ? 'empty' : false;
// Salts can be taken from the database if specified
if ( !$data['toggle_2_2']['value'] ) {
$this->strings[2]['form_errors']['wp_auth_salt'][] = empty( $data['wp_auth_salt']['value'] ) ? 'empty' : false;
// NB; secure_auth_salt is not always set in WordPress
$this->strings[2]['form_errors']['wp_logged_in_salt'][] = empty( $data['wp_logged_in_salt']['value'] ) ? 'empty' : false;
}
}
// If database integration is selected
if ( $data['toggle_2_2']['value'] ) {
$data['toggle_2_2']['checked'] = 'checked="checked"';
$data['toggle_2_2']['display'] = 'block';
// Make the wp_table_prefix valid
$data['wp_table_prefix']['value'] = preg_replace( '/[^0-9a-zA-Z_]/', '', $data['wp_table_prefix']['value'] );
$data['wp_table_prefix']['value'] = empty( $data['wp_table_prefix']['value'] ) ? 'wp_' : $data['wp_table_prefix']['value'];
// Make the wordpress_mu_primary_blog_id valid
$data['wordpress_mu_primary_blog_id']['value'] = preg_replace( '/[^0-9]/', '', $data['wordpress_mu_primary_blog_id']['value'] );
// If advanced database integration is selected
if ( $data['toggle_2_3']['value'] ) {
$data['toggle_2_3']['checked'] = 'checked="checked"';
$data['toggle_2_3']['display'] = 'block';
}
}
if ( !$data['toggle_2_1']['value'] && !$data['toggle_2_2']['value'] ) {
$this->step_status[2] = 'incomplete';
$this->strings[2]['messages']['error'][] = __( 'You must enter your settings for integration setup to complete. Choose which integration settings you wish to enter from the options below.' );
$this->strings[2]['form_errors']['toggle_2_1'][] = true;
$this->strings[2]['form_errors']['toggle_2_2'][] = true;
return 'incomplete';
}
// Remove empty values from the error array
foreach ( $this->strings[2]['form_errors'] as $input => $types) {
$types = array_filter( $types);
if ( !count( $types ) ) {
unset( $this->strings[2]['form_errors'][$input] );
}
}
// Check for errors and build error messages
if ( count( $this->strings[2]['form_errors'] ) ) {
$this->step_status[2] = 'incomplete';
$this->strings[2]['messages']['error'][] = __( 'Your integration settings have not been processed due to errors with the items marked below.' );
foreach ( $this->strings[2]['form_errors'] as $input => $types ) {
$errors = array();
foreach ( $types as $type ) {
switch ( $type ) {
case 'empty':
// Only return this error when empty
$errors = array( __( '• This value is required to continue.' ) );
break(2);
case 'urlparse':
$errors[] = __( '• This does not appear to be a valid URL.' );
break;
case 'urlscheme':
$errors[] = __( '• The URL must begin with "http" or "https".' );
break;
case 'urlhost':
$errors[] = __( '• The URL does not contain a host name.' );
break;
}
}
$this->strings[2]['form_errors'][$input] = $errors;
}
return 'incomplete';
}
// If database integration is selected
if ( $data['toggle_2_2']['value'] ) {
// Test the db connection.
// Setup variables and constants if available
global $bb;
$bb->wp_table_prefix = $data['wp_table_prefix']['value'];
if ( $data['toggle_2_3']['value'] ) {
// These may be empty at this particular stage
if ( !empty( $data['user_bbdb_name']['value'] ) ) {
$bb->user_bbdb_name = $data['user_bbdb_name']['value'];
}
if ( !empty( $data['user_bbdb_user']['value'] ) ) {
$bb->user_bbdb_user = $data['user_bbdb_user']['value'];
}
if ( !empty( $data['user_bbdb_password']['value'] ) ) {
$bb->user_bbdb_password = $data['user_bbdb_password']['value'];
}
if ( !empty( $data['user_bbdb_host']['value'] ) ) {
$bb->user_bbdb_host = $data['user_bbdb_host']['value'];
}
if ( !empty( $data['user_bbdb_charset']['value'] ) ) {
$bb->user_bbdb_charset = preg_replace( '/[^a-z0-9_-]/i', '', $data['user_bbdb_charset']['value'] );
}
if ( !empty( $data['user_bbdb_collate']['value'] ) ) {
$bb->user_bbdb_collate = preg_replace( '/[^a-z0-9_-]/i', '', $data['user_bbdb_collate']['value'] );
}
if ( !empty( $data['custom_user_table']['value'] ) ) {
$bb->custom_user_table = preg_replace( '/[^a-z0-9_-]/i', '', $data['custom_user_table']['value'] );
}
if ( !empty( $data['custom_user_meta_table']['value'] ) ) {
$bb->custom_user_meta_table = preg_replace( '/[^a-z0-9_-]/i', '', $data['custom_user_meta_table']['value'] );
}
}
// Bring in the database object
global $bbdb;
global $bb_table_prefix;
// Resolve the custom user tables for bpdb
bb_set_custom_user_tables();
if ( isset( $bb->custom_databases) && isset( $bb->custom_databases['user'] ) ) {
$bbdb->add_db_server( 'user', $bb->custom_databases['user'] );
}
// Add custom tables if required
if ( isset( $bb->custom_tables['users'] ) || isset( $bb->custom_tables['usermeta'] ) ) {
$bbdb->tables = array_merge( $bbdb->tables, $bb->custom_tables );
if ( is_wp_error( $bbdb->set_prefix( $bb_table_prefix ) ) ) {
die( __( 'Your user table prefix may only contain letters, numbers and underscores.' ) );
}
}
// Hide errors for the test
$bbdb->hide_errors();
$result = $bbdb->query( 'DESCRIBE ' . $bbdb->users . ';' );
$result_error = $bbdb->get_error();
// Select from the user table (may fail if there are no records in the table)
if ( !$result && $result_error ) {
// We couldn't connect to the database at all
// Turn errors back on
$bbdb->show_errors();
// Set the status
$this->step_status[2] = 'incomplete';
if ( !empty( $data['user_bbdb_name']['value'] ) ) {
$this->strings[2]['form_errors']['user_bbdb_name'][] = true;
}
if ( !empty( $data['user_bbdb_user']['value'] ) ) {
$this->strings[2]['form_errors']['user_bbdb_user'][] = true;
}
if ( !empty( $data['user_bbdb_password']['value'] ) ) {
$this->strings[2]['form_errors']['user_bbdb_password'][] = true;
}
if ( !empty( $data['user_bbdb_host']['value'] ) ) {
$this->strings[2]['form_errors']['user_bbdb_host'][] = true;
}
if ( !empty( $data['custom_user_table']['value'] ) ) {
$this->strings[2]['form_errors']['custom_user_table'][] = true;
}
if ( !empty( $data['custom_user_meta_table']['value'] ) ) {
$this->strings[2]['form_errors']['custom_user_meta_table'][] = true;
}
$this->strings[2]['messages']['error'][] = __( 'There was a problem connecting to the WordPress user database you specified. Please check the settings, then try again.' );
return 'incomplete';
}
if ( $result_error ) {
// The result is an error, presumably telling us the table doesn't exist
// Turn errors back on
$bbdb->show_errors();
// Set the status
$this->step_status[2] = 'incomplete';
if ( $data['toggle_2_3']['value'] ) {
$this->strings[2]['messages']['error'][] = __( 'Existing WordPress user tables could not be found in the WordPress database you specified.' );
} else {
$this->strings[2]['messages']['error'][] = __( 'Existing WordPress user tables could not be found in the bbPress database you specified in step 1.' . $paragraph . '
' . "\n"; } } echo $r; } } /** * Prints the introduction paragraphs for the current step. * * @return void **/ function intro() { if ( 'incomplete' == $this->step_status[$this->step] && isset( $this->strings[$this->step]['intro'] ) ) { $messages = $this->strings[$this->step]['intro']; $count = count( $messages ); $i = 0; $r = ''; foreach ( $messages as $paragraph ) { $i++; $class = ( $i === $count ) ? 'intro last' : 'intro'; $r .= '' . $paragraph . '
' . "\n"; } echo $r; } } /** * Prints the standard header for each step. * * @param integer $step The number of the step whose header should be printed. * @return void **/ function step_header( $step ) { $class = ( $step == $this->step ) ? 'open' : 'closed'; $r = '' . $this->strings[$step]['status'] . '
' . "\n"; } echo $r; if ( $step == $this->step ) { $this->intro(); } $this->tabindex = 0; } /** * Prints the standard step footer. * * @return void **/ function step_footer() { $r = '