Changeset 1562

Timestamp:

06/21/2008 05:10:20 AM (17 years ago)

Author:

sambauers

Message:

• Some re-organisation of bb-settings.
• More sane treatment of BB_INSTALLING constant.
• Add additional $_SERVER stabilisation code from WordPress
• Start of PHPdoc for bb-settings

Location:

trunk

Files:

• bb-includes/functions.php (modified) (2 diffs)
• bb-includes/pluggable.php (modified) (3 diffs)
• bb-settings.php (modified) (8 diffs)

trunk/bb-includes/functions.php

@@ -1723 +1723 @@
 
     if ( false === $r = wp_cache_get( $option, 'bb_option' ) ) {
-        //if ( defined( 'BB_INSTALLING' ) ) $bbdb->return_errors();
+        //if ( BB_INSTALLING ) $bbdb->return_errors();
         $row = $bbdb->get_row( $bbdb->prepare( "SELECT meta_value FROM $bbdb->meta WHERE object_type = 'bb_option' AND meta_key = %s", $option ) );
-        //if ( defined( 'BB_INSTALLING' ) ) $bbdb->show_errors();
+        //if ( BB_INSTALLING ) $bbdb->show_errors();
 
         if ( is_object($row) ) {
@@ -2528 +2528 @@
         
         $uri = false;
-        if ( function_exists('bb_get_option') && ( !defined('BB_INSTALLING') || !BB_INSTALLING ) )
+        if ( function_exists('bb_get_option') && !BB_INSTALLING )
             $uri = bb_get_option('uri');
         

trunk/bb-includes/pluggable.php

@@ -50 +50 @@
 //This is only used at initialization.  Use bb_get_current_user_info() (or $bb_current_user global if really needed) to grab user info.
 function bb_current_user() {
-    if ( defined( 'BB_INSTALLING' ) )
+    if (BB_INSTALLING)
         return false;
 
@@ -243 +243 @@
         $salt = BB_SECRET_SALT;
     } else {
-        if (!defined('BB_INSTALLING')) {
+        if (!BB_INSTALLING) {
             $salt = bb_get_option('secret');
             if ( empty($salt) ) {
@@ -382 +382 @@
         return false;
 
-    if ( defined( 'BB_INSTALLING' ) ) {
+    if (BB_INSTALLING) {
         bb_update_usermeta( $user['ID'], $bbdb->prefix . 'capabilities', array('keymaster' => true) );
     } else {        

trunk/bb-settings.php

@@ -1 +1 @@
 <?php
+/**
+ * Used to setup and fix common variables and include
+ * the bbPress and BackPress procedural and class libraries.
+ *
+ * You should not have to change this file, some configuration
+ * is possible in bb-config.php
+ *
+ * @package bbPress
+ */
+
+
+
+/**
+ * Low level reasons to die
+ */
+
+// Die if PHP is not new enough
 if ( version_compare(PHP_VERSION, '4.3', '<') )
     die(sprintf('Your server is running PHP version %s but bbPress requires at least 4.3', PHP_VERSION) );
 
+// Die if called directly
+if ( !defined('BB_PATH') )
+    die('This file cannot be called directly.');
+
+// Die if there is no database table prefix
 if ( !$bb_table_prefix )
     die('You must specify a table prefix in your <code>bb-config.php</code> file.');
 
-if ( !defined('BB_PATH') )
-    die('This file cannot be called directly.');
-
-// Turn register globals off
+
+
+// Modify error reporting levels to exclude PHP notices
+error_reporting(E_ALL ^ E_NOTICE);
+
+/**
+ * bb_unregister_GLOBALS() - Turn register globals off
+ *
+ * @access private
+ * @return null Will return null if register_globals PHP directive was disabled
+ */
 function bb_unregister_GLOBALS() {
     if ( !ini_get('register_globals') )
@@ -27 +56 @@
         }
 }
-
 bb_unregister_GLOBALS();
 
+
+
+/**
+ * bb_timer_start() - PHP 4 standard microtime start capture
+ *
+ * @access private
+ * @global int $bb_timestart Seconds and Microseconds added together from when function is called
+ * @return bool Always returns true
+ */
 function bb_timer_start() {
     global $bb_timestart;
@@ -38 +75 @@
 bb_timer_start();
 
+
+
+/**
+ * Whether the server software is IIS or something else
+ * @global bool $is_IIS
+ */
 $is_IIS = strstr($_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS') ? 1 : 0;
+
+
+
+/**
+ * Stabilise $_SERVER variables in various PHP environments
+ */
+
 // Fix for IIS, which doesn't set REQUEST_URI
 if ( empty( $_SERVER['REQUEST_URI'] ) ) {
-    $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME']; // Does this work under CGI?
-
-    // Append the query string if it exists and isn't null
-    if (isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING']))
-        $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
-}
-
-// Modify error reporting levels
-error_reporting(E_ALL ^ E_NOTICE);
-
+
+    // IIS Mod-Rewrite
+    if (isset($_SERVER['HTTP_X_ORIGINAL_URL'])) {
+        $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
+    }
+    // IIS Isapi_Rewrite
+    else if (isset($_SERVER['HTTP_X_REWRITE_URL'])) {
+        $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
+    }
+    else
+    {
+        // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
+        if ( isset($_SERVER['PATH_INFO']) ) {
+            if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
+                $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
+            else
+                $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
+        }
+
+        // Append the query string if it exists and isn't null
+        if (isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING'])) {
+            $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
+        }
+    }
+}
+
+// Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests
+if ( isset($_SERVER['SCRIPT_FILENAME']) && ( strpos($_SERVER['SCRIPT_FILENAME'], 'php.cgi') == strlen($_SERVER['SCRIPT_FILENAME']) - 7 ) )
+    $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED'];
+
+// Fix for Dreamhost and other PHP as CGI hosts
+if (strpos($_SERVER['SCRIPT_NAME'], 'php.cgi') !== false)
+    unset($_SERVER['PATH_INFO']);
+
+// Fix empty PHP_SELF
+$PHP_SELF = $_SERVER['PHP_SELF'];
+if ( empty($PHP_SELF) )
+    $_SERVER['PHP_SELF'] = $PHP_SELF = preg_replace("/(\?.*)?$/",'',$_SERVER["REQUEST_URI"]);
+
+
+
+/**
+ * Let bbPress know where we are, or aren't
+ */
+
+/**
+ * Whether the current script is in the admin area or not
+ */
 if ( !defined( 'BB_IS_ADMIN' ) )
     define( 'BB_IS_ADMIN', false );
+
+/**
+ * Whether the current script is part of the installation process or not
+ * @since 1.0-beta
+ */
+if ( !defined( 'BB_INSTALLING' ) )
+    define( 'BB_INSTALLING', false );
+
+
 
 // Define the include path
@@ -71 +168 @@
     define( 'BB_DATABASE_CLASS', 'BPDB_Multi' );
 
-function bb_init_bbdb() {
-    global $bbdb;
-    
-    $bbdb_class = BB_DATABASE_CLASS;
-    $bbdb =& new $bbdb_class( array(
-        'name' => BBDB_NAME,
-        'user' => BBDB_USER,
-        'password' => BBDB_PASSWORD,
-        'host' => BBDB_HOST,
-        'charset' => defined( 'BBDB_CHARSET' ) ? BBDB_CHARSET : false,
-        'collate' => defined( 'BBDB_COLLATE' ) ? BBDB_COLLATE : false
-    ) );
-    unset($bbdb_class);
-    
-    $bbdb->tables = array(
-        'forums'             => false,
-        'meta'               => false,
-        'posts'              => false,
-        'tagged'             => false, // Deprecated
-        'tags'               => false, // Deprecated
-        'terms'              => false,
-        'term_relationships' => false,
-        'term_taxonomy'      => false,
-        'topics'             => false,
-        'topicmeta'          => false, // Deprecated
-        'users'              => false,
-        'usermeta'           => false
-    );
-}
-
-bb_init_bbdb();
-
+$bbdb_class = BB_DATABASE_CLASS;
+$bbdb =& new $bbdb_class( array(
+    'name' => BBDB_NAME,
+    'user' => BBDB_USER,
+    'password' => BBDB_PASSWORD,
+    'host' => BBDB_HOST,
+    'charset' => defined( 'BBDB_CHARSET' ) ? BBDB_CHARSET : false,
+    'collate' => defined( 'BBDB_COLLATE' ) ? BBDB_COLLATE : false
+) );
+unset($bbdb_class);
+
+$bbdb->tables = array(
+    'forums'             => false,
+    'meta'               => false,
+    'posts'              => false,
+    'tagged'             => false, // Deprecated
+    'tags'               => false, // Deprecated
+    'terms'              => false,
+    'term_relationships' => false,
+    'term_taxonomy'      => false,
+    'topics'             => false,
+    'topicmeta'          => false, // Deprecated
+    'users'              => false,
+    'usermeta'           => false
+);
 
 // Define BackPress Database errors if not already done - no internationalisation at this stage
@@ -172 +262 @@
     require( BB_COMMUNITIES_INCLUDE );
 
-if ( !bb_is_installed() && ( !defined('BB_INSTALLING') || !BB_INSTALLING ) ) {
+if ( !BB_INSTALLING && !bb_is_installed() ) {
     $link = preg_replace('|(/bb-admin)?/[^/]+?$|', '/', $_SERVER['PHP_SELF']) . 'bb-admin/install.php';
     require( BB_PATH . BB_INC . 'pluggable.php');
@@ -182 +272 @@
 // TODO: consider seperating into external upgrade script for 1.0
 $bbdb->suppress_errors();
-if ( ( !defined('BB_INSTALLING') || !BB_INSTALLING ) && !bb_get_option_from_db( 'bb_db_version' ) ) {
+if ( !BB_INSTALLING && !bb_get_option_from_db( 'bb_db_version' ) ) {
     $meta_exists = $bbdb->query("SELECT * FROM $bbdb->meta LIMIT 1");
     if (!$meta_exists) {
@@ -208 +298 @@
 unset($o, $oo);
 
-if ( defined('BB_INSTALLING') && BB_INSTALLING )
-foreach ( array('active_plugins') as $i )
-    $bb->$i = false;
-unset($i);
+if ( BB_INSTALLING ) {
+    foreach ( array('active_plugins') as $i )
+        $bb->$i = false;
+    unset($i);
+}
 
 require( BB_PATH . BB_INC . 'formatting-functions.php');
@@ -262 +353 @@
 }
 // Die if no URI
-if ( ( !defined('BB_INSTALLING') || !BB_INSTALLING ) && !$bb->uri ) {
+if ( !BB_INSTALLING && !$bb->uri ) {
     bb_die( __('Could not determine site URI') );
 }