Whitespace cleanup and inline docs. Props nacin. see #12027

git-svn-id: http://svn.automattic.com/wordpress/trunk@12865 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2010-01-27 13:48:37 +00:00
parent 54d1dfeccf
commit b7bde3492d

View File

@ -2,30 +2,28 @@
/** /**
* Network settings administration panel. * Network settings administration panel.
* *
* @since 3.0 * A multi-step process allowing the user to enable a network of WordPress sites.
*
* @since 3.0.0
* *
* @package WordPress * @package WordPress
* @subpackage Administration * @subpackage Administration
*/ */
/** WordPress Administration Bootstrap */ /** WordPress Administration Bootstrap */
require_once('./admin.php'); require_once( './admin.php' );
if ( ! is_super_admin() ) if ( ! is_super_admin() )
wp_die(__('You do not have sufficient permissions to manage options for this blog.')); wp_die( __( 'You do not have sufficient permissions to manage options for this blog.' ) );
$title = __('Network Settings'); $title = __( 'Network Settings' );
$parent_file = 'tools.php'; $parent_file = 'tools.php';
add_contextual_help($current_screen, __('<a href="http://codex.wordpress.org/Settings_Network_SubPanel" target="_blank">Network Settings</a>')); add_contextual_help( $current_screen, __( '<a href="http://codex.wordpress.org/Settings_Network_SubPanel" target="_blank">Network Settings</a>') );
include('./admin-header.php'); include( './admin-header.php' );
/*
This option panel does not save data to the options table.
It contains a multi-step process allowing the user to enable a network of WordPress sites.
*/
$dirs = array( substr( ABSPATH, 0, -1), ABSPATH . "wp-content" ); $dirs = array( substr( ABSPATH, 0, -1 ), ABSPATH . 'wp-content' );
?> ?>
<div class="wrap"> <div class="wrap">
<?php screen_icon(); ?> <?php screen_icon(); ?>
@ -33,91 +31,107 @@ $dirs = array( substr( ABSPATH, 0, -1), ABSPATH . "wp-content" );
<form method="post" action="network.php"> <form method="post" action="network.php">
<?php <?php
/**
* Prints summary of server statistics in preparation for setting up a network.
*
* @since 3.0.0
*/
function filestats( $err ) { function filestats( $err ) {
?> ?>
<h2><?php esc_html_e('Server Summary'); ?></h2> <h2><?php esc_html_e( 'Server Summary' ); ?></h2>
<p><?php _e('If you post a message to the WordPress support forum at <a target="_blank" href="http://wordpress.org/support/">http://wordpress.org/support/</a> then copy and paste the following information into your message:'); ?></p> <p><?php _e( 'If you post a message to the WordPress support forum at <a target="_blank" href="http://wordpress.org/support/">http://wordpress.org/support/</a> then copy and paste the following information into your message:' ); ?></p>
<blockquote style="background: #eee; border: 1px solid #333; padding: 5px;"> <blockquote style="background: #eee; border: 1px solid #333; padding: 5px;">
<br /><strong><?php echo __('ERROR:') . " $err"; ?></strong><br /> <br /><strong><?php printf( __( 'ERROR: %s' ), $err ); ?></strong><br />
<?php <?php
clearstatcache(); clearstatcache();
$files = array( "htaccess.dist", ".htaccess" ); $files = array( 'htaccess.dist', '.htaccess' );
$indent = '&nbsp;&nbsp;&nbsp;&nbsp;'; $indent = '&nbsp;&nbsp;&nbsp;&nbsp;';
foreach ( (array) $files as $val ) { foreach ( (array) $files as $val ) {
$stats = @stat( $val ); $stats = @stat( $val );
if( $stats ) { if ( $stats ) {
?> ?>
<h2><?php echo esc_html( $val ); ?></h2> <h2><?php echo esc_html( $val ); ?></h2>
<?php echo $indent . sprintf( __('uid/gid: %1$s/%2$s'), $stats[ 'uid' ], $stats[ 'gid' ] ); ?><br /> <?php echo $indent . sprintf( __( 'uid/gid: %1$s/%2$s' ), $stats['uid'], $stats['gid'] ); ?><br />
<?php echo $indent . sprintf( __('size: %s'), $stats['size'] ); ?><br/> <?php echo $indent . sprintf( __( 'size: %s' ), $stats['size'] ); ?><br/>
<?php echo $indent . sprintf( __('perms: %s'), substr( sprintf('%o', fileperms( $val ) ), -4 ) ); ?><br/> <?php echo $indent . sprintf( __( 'perms: %s' ), substr( sprintf( '%o', fileperms( $val ) ), -4 ) ); ?><br/>
<?php echo $indent . sprintf( __('readable: %s'), is_readable( $val ) ? __('yes') : __('no') ); ?><br/> <?php echo $indent . sprintf( __( 'readable: %s' ), is_readable( $val ) ? __( 'yes' ) : __( 'no' ) ); ?><br/>
<?php echo $indent . sprintf( __('writeable: %s'), is_writeable( $val ) ? __('yes') : __('no') ); ?><br/> <?php echo $indent . sprintf( __( 'writeable: %s' ), is_writeable( $val ) ? __( 'yes' ) : __( 'no' ) ); ?><br/>
<?php <?php
} elseif( ! file_exists( $val ) ) { } elseif ( ! file_exists( $val ) ) {
?> ?>
<h2><?php echo esc_html( $val ); ?></h2> <h2><?php echo esc_html( $val ); ?></h2>
<?php echo $indent . sprintf( __('FILE NOT FOUND: %s'), $val ); ?><br/> <?php echo $indent . sprintf( __( 'FILE NOT FOUND: %s' ), $val ); ?><br/>
<?php <?php
} }
} }
echo "</blockquote>"; echo "</blockquote>";
} }
/**
* Prints .htaccess component of step 2 for network settings.
*
* @since 3.0.0
*/
function step2_htaccess() { function step2_htaccess() {
global $base; global $base;
// remove ending slash from $base and $url // remove ending slash from $base and $url
$htaccess = ''; $htaccess = '';
if( substr($base, -1 ) == '/') { if ( substr( $base, -1 ) == '/' )
$base = substr($base, 0, -1); $base = substr( $base, 0, -1 );
}
$htaccess_sample = ABSPATH . 'wp-admin/includes/htaccess.ms'; $htaccess_sample = ABSPATH . 'wp-admin/includes/htaccess.ms';
if ( !file_exists( $htaccess_sample ) ) if ( ! file_exists( $htaccess_sample ) )
wp_die( sprintf( __('Sorry, I need a %s to work from. Please re-upload this file to your WordPress installation.'), $htaccess_sample ) ); wp_die( sprintf( __( 'Sorry, I need a %s to work from. Please re-upload this file to your WordPress installation.' ), $htaccess_sample ) );
$htaccess_file = file( $htaccess_sample ); $htaccess_file = file( $htaccess_sample );
$fp = @fopen( $htaccess_sample, "r" ); $fp = @fopen( $htaccess_sample, "r" );
if( $fp ) { if ( $fp ) {
while( !feof( $fp ) ) { while ( ! feof( $fp ) ) {
$htaccess .= fgets( $fp, 4096 ); $htaccess .= fgets( $fp, 4096 );
} }
fclose( $fp ); fclose( $fp );
$htaccess_file = str_replace( "BASE", $base, $htaccess ); $htaccess_file = str_replace( "BASE", $base, $htaccess );
} else { } else {
wp_die( sprintf( __('Sorry, I need to be able to read %s. Please check the permissions on this file.'), $htaccess_sample ) ); wp_die( sprintf( __( 'Sorry, I need to be able to read %s. Please check the permissions on this file.' ), $htaccess_sample ) );
} }
//@todo: check for super-cache in use //@todo: check for super-cache in use
?> ?>
<li><p><?php _e('Replace the contents of your <code>.htaccess</code> with the following:'); ?></p> <li><p><?php _e( 'Replace the contents of your <code>.htaccess</code> with the following:' ); ?></p>
<textarea name="htaccess" cols="120" rows="20"> <textarea name="htaccess" cols="120" rows="20">
<?php echo $htaccess_file; ?> <?php echo wp_htmledit_pre( $htaccess_file ); ?>
</textarea> </textarea>
</li> </li>
<?php <?php
} }
/**
* Prints part of step 1 for network settings and checks for mod_rewrite.
*
* @since 3.0.0
* @return bool Whether mod_rewrite is enabled.
*/
function step1() { function step1() {
$rewrite_enabled = false; $rewrite_enabled = false;
?> ?>
<h2><?php esc_html_e('Installing Network of WordPress Sites'); ?></h2> <h2><?php esc_html_e( 'Installing Network of WordPress Sites' ); ?></h2>
<p><?php _e('I will help you enable the features for creating a network of sites by asking you a few questions so that you can create configuration files and make a directory to store all your uploaded files.'); ?></p> <p><?php _e( 'I will help you enable the features for creating a network of sites by asking you a few questions so that you can create configuration files and make a directory to store all your uploaded files.' ); ?></p>
<h2><?php esc_html_e('What do I need?'); ?></h2> <h2><?php esc_html_e( 'What do I need?' ); ?></h2>
<ul> <ul>
<li><?php _e( 'Access to your server to change directory permissions. This can be done through ssh or ftp for example.' ); ?></li> <li><?php _e( 'Access to your server to change directory permissions. This can be done through ssh or ftp for example.' ); ?></li>
<li><?php _e( 'A valid email where your password and administrative emails will be sent.' ); ?></li> <li><?php _e( 'A valid email where your password and administrative emails will be sent.' ); ?></li>
<li><?php _e( "Wildcard dns records if you're going to use the virtual host (sub-domain) functionality. Check the <a href='http://trac.mu.wordpress.org/browser/trunk/README.txt'>README</a> for further details."); ?></li> <li><?php _e( "Wildcard dns records if you're going to use the virtual host (sub-domain) functionality. Check the <a href='http://trac.mu.wordpress.org/browser/trunk/README.txt'>README</a> for further details." ); ?></li>
</ul> </ul>
<?php <?php
$mod_rewrite_msg = "\n<p>" . __( "If the <code>mod_rewrite</code> module is disabled ask your administrator to enable that module, or look at the <a href='http://httpd.apache.org/docs/mod/mod_rewrite.html'>Apache documentation</a> or <a href='http://www.google.com/search?q=apache+mod_rewrite'>elsewhere</a> for help setting it up." ) . '</p>'; $mod_rewrite_msg = "\n<p>" . __( 'If the <code>mod_rewrite</code> module is disabled ask your administrator to enable that module, or look at the <a href="http://httpd.apache.org/docs/mod/mod_rewrite.html">Apache documentation</a> or <a href="http://www.google.com/search?q=apache+mod_rewrite">elsewhere</a> for help setting it up.' ) . '</p>';
if ( function_exists( 'apache_get_modules' ) ) { if ( function_exists( 'apache_get_modules' ) ) {
$modules = apache_get_modules(); $modules = apache_get_modules();
if ( ! in_array( 'mod_rewrite', $modules ) ) if ( ! in_array( 'mod_rewrite', $modules ) )
echo '<p>' . __('<strong>Warning!</strong> It looks like mod_rewrite is not installed.') . '</p>' . $mod_rewrite_msg; echo '<p>' . __( '<strong>Warning!</strong> It looks like mod_rewrite is not installed.' ) . '</p>' . $mod_rewrite_msg;
else else
$rewrite_enabled = true; $rewrite_enabled = true;
} else { } else {
@ -126,11 +140,17 @@ function step1() {
return $rewrite_enabled; return $rewrite_enabled;
} }
/**
* Prints most of step 1 for network settings.
*
* @since 3.0.0
* @param bool $rewrite_enabled Whether mod_rewrite is enabled. Default false.
*/
function printstep1form( $rewrite_enabled = false ) { function printstep1form( $rewrite_enabled = false ) {
$weblog_title = sprintf( __('%s Sites'), ucfirst( get_option( 'blogname' ) ) ); $weblog_title = sprintf( __( '%s Sites' ), ucfirst( get_option( 'blogname' ) ) );
$email = get_option( 'admin_email' ); $email = get_option( 'admin_email' );
$hostname = get_clean_basedomain(); $hostname = get_clean_basedomain();
if( substr( $hostname, 0, 4 ) == 'www.' ) if ( substr( $hostname, 0, 4 ) == 'www.' )
$nowww = substr( $hostname, 4 ); $nowww = substr( $hostname, 4 );
wp_nonce_field( 'install-network-1' ); wp_nonce_field( 'install-network-1' );
@ -138,12 +158,12 @@ function printstep1form( $rewrite_enabled = false ) {
<input type='hidden' name='action' value='step2' /> <input type='hidden' name='action' value='step2' />
<h2><?php esc_html_e( 'Site Addresses' ); ?></h2> <h2><?php esc_html_e( 'Site Addresses' ); ?></h2>
<p><?php _e( 'Please choose whether you would like sites in your WordPress install to use sub-domains or sub-directories. You cannot change this later.' ); ?></p> <p><?php _e( 'Please choose whether you would like sites in your WordPress install to use sub-domains or sub-directories. You cannot change this later.' ); ?></p>
<?php if ( !$rewrite_enabled ) { ?> <?php if ( ! $rewrite_enabled ) { ?>
<p><?php _e( '<strong>Note</strong> It looks like <code>mod_rewrite</code> is not installed.'); ?></p> <p><?php _e( '<strong>Note</strong> It looks like <code>mod_rewrite</code> is not installed.' ); ?></p>
<?php } ?> <?php } ?>
<p class="blog-address"> <p class="blog-address">
<label><input type='radio' name='vhost' value='yes'<?php if( $rewrite_enabled ) echo ' checked="checked"'; ?> /> <?php _e( 'Sub-domains (like <code>blog1.example.com</code>)' ); ?></label><br /> <label><input type='radio' name='vhost' value='yes'<?php if ( $rewrite_enabled ) echo ' checked="checked"'; ?> /> <?php _e( 'Sub-domains (like <code>blog1.example.com</code>)' ); ?></label><br />
<label><input type='radio' name='vhost' value='no'<?php if( !$rewrite_enabled ) echo ' checked="checked"'; ?> /> <?php _e( 'Sub-directories (like <code>example.com/blog1</code>) '); ?></label> <label><input type='radio' name='vhost' value='no'<?php if ( ! $rewrite_enabled ) echo ' checked="checked"'; ?> /> <?php _e( 'Sub-directories (like <code>example.com/blog1</code>)' ); ?></label>
</p> </p>
<h2><?php esc_html_e( 'Server Address' ); ?></h2> <h2><?php esc_html_e( 'Server Address' ); ?></h2>
@ -182,6 +202,11 @@ function printstep1form( $rewrite_enabled = false ) {
<?php <?php
} }
/**
* Prints step 2 for network settings.
*
* @since 3.0.0
*/
function step2() { function step2() {
?> ?>
<h2><?php esc_html_e( 'Enabling WordPress Sites' ); ?></h2> <h2><?php esc_html_e( 'Enabling WordPress Sites' ); ?></h2>
@ -194,14 +219,19 @@ function step2() {
<?php <?php
} }
/**
* Prints configuration file component of step 2 for network settings.
*
* @since 3.0.0
*/
function step2_config() { function step2_config() {
global $base, $wpdb, $vhost; global $base, $wpdb, $vhost;
$vhost = stripslashes($_POST['vhost' ]); $vhost = stripslashes( $_POST['vhost' ] );
$prefix = $wpdb->base_prefix; $prefix = $wpdb->base_prefix;
$config_sample = ABSPATH . 'wp-admin/includes/wp-config.ms'; $config_sample = ABSPATH . 'wp-admin/includes/wp-config.ms';
if ( !file_exists( $config_sample ) ) if ( ! file_exists( $config_sample ) )
wp_die( sprintf( __( 'Sorry, I need a <code>%s</code> to work from. Please re-upload this file to your WordPress installation.' ), $config_sample ) ); wp_die( sprintf( __( 'Sorry, I need a <code>%s</code> to work from. Please re-upload this file to your WordPress installation.' ), $config_sample ) );
$wp_config_file = file( $config_sample ); $wp_config_file = file( $config_sample );
@ -209,35 +239,35 @@ function step2_config() {
<li><p><?php _e( 'Replace the contents of your <code>wp-config.php</code> with the following:' ); ?></p> <li><p><?php _e( 'Replace the contents of your <code>wp-config.php</code> with the following:' ); ?></p>
<textarea name="wp-config" cols="120" rows="20"> <textarea name="wp-config" cols="120" rows="20">
<?php <?php
foreach ($wp_config_file as $line) { foreach ( $wp_config_file as $line ) {
switch ( trim( substr($line,0,16) ) ) { switch ( trim( substr( $line, 0, 16 ) ) ) {
case "define('DB_NAME'": case "define('DB_NAME'":
$output = str_replace("wordpress", DB_NAME, $line); $output = str_replace( "wordpress", DB_NAME, $line );
break; break;
case "define('DB_USER'": case "define('DB_USER'":
$output = str_replace("username", DB_USER, $line); $output = str_replace( "username", DB_USER, $line );
break; break;
case "define('DB_PASSW": case "define('DB_PASSW":
$output = str_replace("password", DB_PASSWORD, $line); $output = str_replace( "password", DB_PASSWORD, $line );
break; break;
case "define('DB_HOST'": case "define('DB_HOST'":
$output = str_replace("localhost", DB_HOST, $line); $output = str_replace( "localhost", DB_HOST, $line );
break; break;
case "define('VHOST',": case "define('VHOST',":
$output = str_replace("VHOSTSETTING", $vhost, $line); $output = str_replace( "VHOSTSETTING", $vhost, $line );
break; break;
case '$table_prefix =': case '$table_prefix =':
$output = str_replace('wp_', $prefix, $line); $output = str_replace( 'wp_', $prefix, $line );
break; break;
case '$base = \'BASE\';': case '$base = \'BASE\';':
$output = str_replace('BASE', $base, $line); $output = str_replace( 'BASE', $base, $line );
break; break;
case "define('DOMAIN_C": case "define('DOMAIN_C":
$domain = get_clean_basedomain(); $domain = get_clean_basedomain();
$output = str_replace("current_site_domain", $domain, $line); $output = str_replace( "current_site_domain", $domain, $line );
break; break;
case "define('PATH_CUR": case "define('PATH_CUR":
$output = str_replace("current_site_path", $base, $line); $output = str_replace( "current_site_path", $base, $line );
break; break;
case "define('AUTH_KEY": case "define('AUTH_KEY":
case "define('AUTH_SAL": case "define('AUTH_SAL":
@ -249,7 +279,7 @@ function step2_config() {
$hash = constant( $constant ); $hash = constant( $constant );
else else
$hash = md5( mt_rand() ) . md5( mt_rand() ); $hash = md5( mt_rand() ) . md5( mt_rand() );
$output = str_replace('put your unique phrase here', $hash, $line); $output = str_replace( 'put your unique phrase here', $hash, $line );
break; break;
default: default:
$output = $line; $output = $line;
@ -263,39 +293,45 @@ function step2_config() {
<?php <?php
} }
/**
* Gets base domain of network.
*
* @since 3.0.0
*/
function get_clean_basedomain() { function get_clean_basedomain() {
global $wpdb; global $wpdb;
$domain = preg_replace( '|https?://|', '', get_option( 'siteurl') ); $domain = preg_replace( '|https?://|', '', get_option( 'siteurl' ) );
if( strpos( $domain, '/' ) ) if ( strpos( $domain, '/' ) )
$domain = substr( $domain, 0, strpos( $domain, '/' ) ); $domain = substr( $domain, 0, strpos( $domain, '/' ) );
return $domain; return $domain;
} }
$action = isset($_POST[ 'action' ]) ? $_POST[ 'action' ] : null; $action = isset( $_POST[ 'action' ] ) ? $_POST[ 'action' ] : null;
switch($action) {
case "step2": switch( $action ) {
case 'step2':
check_admin_referer( 'install-network-1' ); check_admin_referer( 'install-network-1' );
// Install! // Install!
$base = stripslashes( dirname( dirname($_SERVER["SCRIPT_NAME"]) ) ); $base = stripslashes( dirname( dirname( $_SERVER['SCRIPT_NAME'] ) ) );
if( $base != "/") if ( $base != '/' )
$base .= "/"; $base .= '/';
require_once( ABSPATH . 'wp-admin/includes/upgrade.php' ); require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
// create network tables // create network tables
$domain = get_clean_basedomain(); $domain = get_clean_basedomain();
install_network(); install_network();
populate_network( 1, $domain, sanitize_email( $_POST[ 'email' ] ), $_POST[ 'weblog_title' ], $base, $_POST[ 'vhost' ] ); populate_network( 1, $domain, sanitize_email( $_POST['email'] ), $_POST['weblog_title'], $base, $_POST['vhost'] );
// create wp-config.php / htaccess // create wp-config.php / htaccess
step2(); step2();
break; break;
default: default:
//@todo: give an informative screen instead //@todo: give an informative screen instead
if ( is_multisite() ) { if ( is_multisite() ) {
_e('Network already enabled'); _e( 'Network already enabled.' );
} else { } else {
$rewrite_enabled = step1(); $rewrite_enabled = step1();
printstep1form($rewrite_enabled); printstep1form( $rewrite_enabled );
} }
break; break;
} }
@ -303,4 +339,4 @@ switch($action) {
</form> </form>
</div> </div>
<?php include('./admin-footer.php'); ?> <?php include( './admin-footer.php' ); ?>