Changeset 5309 for trunk/bp-loader.php

Timestamp:

11/08/2011 08:39:23 PM (13 years ago)

Author:

johnjamesjacoby

Message:

bp-loader.php is a real boy! Introduce BuddyPress class to handle the loading of BuddyPress core and provide declarations to the $bp global variables. Ports several functions and methods from bbPress 2.0 into bp-core-update.php to manage the hand-off into the update routine. See #3739.

File:

• trunk/bp-loader.php (modified) (3 diffs)

trunk/bp-loader.php

@@ -1 +1 @@
 <?php
+
+/**
+ * The BuddyPress Plugin
+ *
+ * BuddyPress is social networking software with a twist from the creators of WordPress.
+ *
+ * @package BuddyPress
+ * @subpackage Main
+ */
+
 /**
  * Plugin Name: BuddyPress
@@ -5 +15 @@
  * Description: Social networking in a box. Build a social network for your company, school, sports team or niche community all based on the power and flexibility of WordPress.
  * Author:      The BuddyPress Community
+ * Author URI:  http://buddypress.org/community/members/
  * Version:     1.6-bleeding
- * Author URI:  http://buddypress.org/community/members/
+ * Text Domain: buddypress
+ * Domain Path: /bp-languages/
  * Network:     true
  */
@@ -14 +26 @@
 
 /** Constants *****************************************************************/
-global $wpdb;
-
-// Define the BuddyPress version
-if ( !defined( 'BP_VERSION' ) )
-    define( 'BP_VERSION', '1.6-bleeding' );
-
-// Define the database version
-if ( !defined( 'BP_DB_VERSION' ) )
-    define( 'BP_DB_VERSION', 5249 );
-
-// Place your custom code (actions/filters) in a file called
-// '/plugins/bp-custom.php' and it will be loaded before anything else.
-if ( file_exists( WP_PLUGIN_DIR . '/bp-custom.php' ) )
-    require( WP_PLUGIN_DIR . '/bp-custom.php' );
-
-// Define on which blog ID BuddyPress should run
-if ( !defined( 'BP_ROOT_BLOG' ) ) {
-
-    // Root blog is the main site on this network
-    if ( is_multisite() && !defined( 'BP_ENABLE_MULTIBLOG' ) ) {
-        $current_site = get_current_site();
-        $root_blog_id = $current_site->blog_id;
-
-    // Root blog is every site on this network
-    } elseif ( is_multisite() && defined( 'BP_ENABLE_MULTIBLOG' ) ) {
-        $root_blog_id = get_current_blog_id();
-
-    // Root blog is the only blog on this network
-    } elseif( !is_multisite() ) {
-        $root_blog_id = 1;
+
+if ( !class_exists( 'BuddyPress' ) ) :
+/**
+ * Main BuddyPress Class
+ *
+ * Tap tap tap... Is this thing on?
+ *
+ * @since BuddyPress (1.6)
+ */
+class BuddyPress {
+
+    /**
+     * Note to Plugin and Theme authors:
+     *
+     * Do not directly reference the variables below in your code. Their names
+     * and locations in the BuddyPress class are subject to change at any time.
+     *
+     * Most of them have reference functions located in bp-core-functions.php.
+     * The ones that don't can be accessed via their respective WordPress API's.
+     * 
+     * Components are encouraged to store their data in the $bp global rather
+     * than new globals to keep all BuddyPress data in one place.
+     */
+
+    /** Version ***************************************************************/
+
+    /**
+     * @var string BuddyPress version
+     */
+    public $version = '1.6-bleeding';
+
+    /**
+     * @var int Database version of current BuddyPress files
+     */
+    public $db_version = 5249;
+    
+    /**
+     * @var int Database version raw from database connection
+     */
+    public $db_version_raw = 0;
+    
+    /**
+     * @var string State of BuddyPress installation
+     */
+    public $maintenance_mode = '';
+
+    /** Paths *****************************************************************/
+
+    /**
+     * @var string Basename of the BuddyPress plugin directory
+     */
+    public $basename = '';
+
+    /**
+     * @var string Absolute path to the BuddyPress plugin directory
+     */
+    public $plugin_dir = '';
+
+    /**
+     * @var string Absolute path to the BuddyPress themes directory
+     */
+    public $themes_dir = '';
+
+    /**
+     * @var string Absolute path to the BuddyPress language directory
+     */
+    public $lang_dir = '';
+
+    /** URLs ******************************************************************/
+
+    /**
+     * @var string URL to the BuddyPress plugin directory
+     */
+    public $plugin_url = '';
+
+    /**
+     * @var string URL to the BuddyPress themes directory
+     */
+    public $themes_url = '';
+
+    /** Users *****************************************************************/
+
+    /**
+     * @var object Current user
+     */
+    public $current_user = array();
+
+    /**
+     * @var object Displayed user
+     */
+    public $displayed_user = array();
+
+    /** Errors ****************************************************************/
+
+    /**
+     * @var WP_Error Used to log and display errors
+     */
+    public $errors = array();
+
+    /** Forms *****************************************************************/
+
+    /**
+     * @var int The current tab index for form building
+     */
+    public $tab_index = 0;
+
+    /** Theme Compat **********************************************************/
+
+    /**
+     * @var string Theme to use for theme compatibility
+     */
+    public $theme_compat = '';
+
+    /** Extensions ************************************************************/
+
+    /**
+     * @var mixed BuddyPress add-ons should append globals to this
+     */
+    public $extend = false;
+
+    /** Option Overload *******************************************************/
+
+    /**
+     * @var array Optional Overloads default options retrieved from get_option()
+     */
+    public $options = array();
+
+    /** Permastructs **********************************************************/
+
+    /**
+     * @var string User struct
+     */
+    public $user_id = '';
+
+    /**
+     * @var string Edit struct
+     */
+    public $edit_id = '';
+
+    /** Statuses **************************************************************/
+
+    /**
+     * @var string Public post status id. Used by forums, topics, and replies.
+     */
+    public $public_status_id = '';
+
+    /**
+     * @var string Pending post status id. Used by topics and replies
+     */
+    public $pending_status_id = '';
+
+    /**
+     * @var string Private post status id. Used by forums and topics.
+     */
+    public $private_status_id = '';
+
+    /**
+     * @var string Closed post status id. Used by topics.
+     */
+    public $closed_status_id = '';
+
+    /**
+     * @var string Spam post status id. Used by topics and replies.
+     */
+    public $spam_status_id = '';
+
+    /**
+     * @var string Trash post status id. Used by topics and replies.
+     */
+    public $trash_status_id = '';
+
+    /**
+     * @var string Orphan post status id. Used by topics and replies.
+     */
+    public $orphan_status_id = '';
+
+    /**
+     * @var string Hidden post status id. Used by forums.
+     */
+    public $hidden_status_id = '';
+
+    /** Functions *************************************************************/
+
+    /**
+     * The main BuddyPress loader
+     *
+     * @since BuddyPress (1.6)
+     *
+     * @uses BuddyPress::constants() Setup legacy constants
+     * @uses BuddyPress::setup_globals() Setup globals needed
+     * @uses BuddyPress::includes() Includ required files
+     * @uses BuddyPress::setup_actions() Setup hooks and actions
+     */
+    public function __construct() {
+        $this->constants();
+        $this->setup_globals();
+        $this->includes();
+        $this->setup_actions();
     }
 
-    define( 'BP_ROOT_BLOG', $root_blog_id );
-}
-
-// Path and URL
-if ( !defined( 'BP_PLUGIN_DIR' ) )
-    define( 'BP_PLUGIN_DIR', WP_PLUGIN_DIR . '/buddypress' );
-
-if ( !defined( 'BP_PLUGIN_URL' ) )
-    define( 'BP_PLUGIN_URL', plugins_url( 'buddypress' ) );
-
-// The search slug has to be defined nice and early because of the way search requests are loaded
-if ( !defined( 'BP_SEARCH_SLUG' ) )
-    define( 'BP_SEARCH_SLUG', 'search' );
-
-/** Loader ********************************************************************/
-
-// Load the WP abstraction file so BuddyPress can run on all WordPress setups.
-require( BP_PLUGIN_DIR . '/bp-core/bp-core-wpabstraction.php' );
-
-// Test to see whether this is a new installation or an upgraded version of BuddyPress
-if ( !$bp->database_version = get_site_option( 'bp-db-version' ) ) {
-    if ( $bp->database_version = get_option( 'bp-db-version' ) ) {
-        $bp->is_network_activate = 1;
-    } else {
-        $bp->database_version = get_site_option( 'bp-core-db-version' );  // BP 1.2 option
+    /**
+     * Legacy BuddyPress constants
+     * 
+     * Try to avoid using these. Their values have been moved into variables
+     * in the $bp global, and have matching functions to get/set their value.
+     *
+     * @since BuddyPress (1.6)
+     *
+     * @uses is_multisite()
+     * @uses get_current_site()
+     * @uses get_current_blog_id()
+     * @uses plugin_dir_path()
+     * @uses plugin_dir_url()
+     */
+    public function constants() {
+
+        // Define the BuddyPress version
+        if ( !defined( 'BP_VERSION' ) )
+            define( 'BP_VERSION', $this->version );
+
+        // Define the database version
+        if ( !defined( 'BP_DB_VERSION' ) )
+            define( 'BP_DB_VERSION', $this->db_version );
+
+        // Place your custom code (actions/filters) in a file called
+        // '/plugins/bp-custom.php' and it will be loaded before anything else.
+        if ( file_exists( WP_PLUGIN_DIR . '/bp-custom.php' ) )
+            require( WP_PLUGIN_DIR . '/bp-custom.php' );
+
+        // Define on which blog ID BuddyPress should run
+        if ( !defined( 'BP_ROOT_BLOG' ) ) {
+
+            // Default to 1
+            $root_blog_id = 1;
+            
+            // Root blog is the main site on this network
+            if ( is_multisite() && !defined( 'BP_ENABLE_MULTIBLOG' ) ) {
+                $current_site = get_current_site();
+                $root_blog_id = $current_site->blog_id;
+
+            // Root blog is every site on this network
+            } elseif ( is_multisite() && defined( 'BP_ENABLE_MULTIBLOG' ) ) {
+                $root_blog_id = get_current_blog_id();
+            }
+
+            define( 'BP_ROOT_BLOG', $root_blog_id );
+        }
+
+        // Path and URL
+        if ( !defined( 'BP_PLUGIN_DIR' ) )
+            define( 'BP_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
+
+        if ( !defined( 'BP_PLUGIN_URL' ) )
+            define( 'BP_PLUGIN_URL', plugin_dir_url ( __FILE__ ) );
+
+        // The search slug has to be defined nice and early because of the way
+        // search requests are loaded
+        //
+        // @todo Maxe this better
+        if ( !defined( 'BP_SEARCH_SLUG' ) )
+            define( 'BP_SEARCH_SLUG', 'search' );   
+    }
+
+    /**
+     * Component global variables
+     *
+     * @since BuddyPress (1.6)
+     * @access private
+     *
+     * @uses plugin_dir_path() To generate BuddyPress plugin path
+     * @uses plugin_dir_url() To generate BuddyPress plugin url
+     * @uses apply_filters() Calls various filters
+     */
+    private function setup_globals() {
+
+        /** Paths *************************************************************/
+
+        // BuddyPress root directory
+        $this->file       = __FILE__;
+        $this->basename   = plugin_basename( $this->file );
+        $this->plugin_dir = plugin_dir_path( $this->file );
+        $this->plugin_url = plugin_dir_url ( $this->file );
+
+        // Themes
+        $this->themes_dir = $this->plugin_dir . 'bp-themes';
+        $this->themes_url = $this->plugin_url . 'bp-themes';
+
+        // Languages
+        $this->lang_dir   = $this->plugin_dir . 'bp-languages';
+
+        /** Identifiers *******************************************************/
+
+        // Status identifiers
+        $this->spam_status_id     = apply_filters( 'bp_spam_post_status',    'spam'    );
+        $this->closed_status_id   = apply_filters( 'bp_closed_post_status',  'closed'  );
+        $this->orphan_status_id   = apply_filters( 'bp_orphan_post_status',  'orphan'  );
+        $this->public_status_id   = apply_filters( 'bp_public_post_status',  'publish' );
+        $this->pending_status_id  = apply_filters( 'bp_pending_post_status', 'pending' );
+        $this->private_status_id  = apply_filters( 'bp_private_post_status', 'private' );
+        $this->hidden_status_id   = apply_filters( 'bp_hidden_post_status',  'hidden'  );
+        $this->trash_status_id    = apply_filters( 'bp_trash_post_status',   'trash'   );
+
+        // Other identifiers
+        $this->user_id            = apply_filters( 'bp_user_id', 'bp_user' );
+        $this->edit_id            = apply_filters( 'bp_edit_id', 'edit'     );
+
+        /** Misc **************************************************************/
+
+        // Errors
+        $this->errors             = new WP_Error();
+
+        // Tab Index
+        $this->tab_index          = apply_filters( 'bp_default_tab_index', 100 );
+    }
+
+    /**
+     * Include required files
+     *
+     * @since BuddyPress (1.6)
+     * @access private
+     *
+     * @uses is_admin() If in WordPress admin, load additional file
+     */
+    private function includes() {
+
+        // Load the WP abstraction file so BuddyPress can run on all WordPress setups.
+        require( BP_PLUGIN_DIR . '/bp-core/bp-core-wpabstraction.php' );
+
+        // Get the possible DB versions
+        $versions               = array();
+        $versions['1.2']        = get_site_option( 'bp-core-db-version' );
+        $versions['1.5-single'] = get_site_option( 'bp-db-version'      );
+        $versions['1.5-multi']  = get_option     ( 'bp-db-version'      );
+        $versions['1.6']        = get_option     ( '_bp_db_version'     );
+
+        // Remove empty array items
+        $versions = array_filter( $versions );
+
+        // Get the largest version
+        $this->db_version_raw      = (int) max( $versions );
+
+        // Are we network activated?
+        $this->is_network_activate = !empty( $versions['1.5-multi'] );
+            
+        // This is a new installation
+        if ( empty( $this->db_version_raw ) ) {
+            $this->maintenance_mode = 'install';
+            require( $this->plugin_dir . '/bp-core/admin/bp-core-update.php' );
+
+        // There is a previous installation
+        } else {
+
+            // Setup the BuddyPress theme directory
+            register_theme_directory( $this->themes_dir );
+
+            // Load core
+            require( $this->plugin_dir . '/bp-core/bp-core-loader.php' );
+
+            // Check if an update is required
+            if ( (int) $this->db_version_raw < (int) $this->db_version || ( !empty( $this->is_network_activate ) ) ) {
+                $this->maintenance_mode = 'update';
+                require( $this->plugin_dir . '/bp-core/admin/bp-core-update.php' );
+            }
+        }       
+    }
+
+    /**
+     * Setup the default hooks and actions
+     *
+     * @since BuddyPress (1.6)
+     * @access private
+     *
+     * @uses register_activation_hook() To register the activation hook
+     * @uses register_deactivation_hook() To register the deactivation hook
+     * @uses add_action() To add various actions
+     */
+    private function setup_actions() {
+
+        // Add actions to plugin activation and deactivation hooks
+        add_action( 'activate_'   . $this->basename, 'bp_activation'   );
+        add_action( 'deactivate_' . $this->basename, 'bp_deactivation' );
+
+        // If BuddyPress is being deactivated, do not add any actions
+        if ( bp_is_deactivation( $this->basename ) )
+            return;
+
+        // Array of BuddyPress core actions
+        $actions = array(
+            'setup_current_user',       // Setup currently logged in user
+            'register_post_types',      // Register post types
+            'register_post_statuses',   // Register post statuses
+            'register_taxonomies',      // Register taxonomies
+            'register_views',           // Register the views
+            'register_theme_directory', // Register the theme directory
+            'load_textdomain',          // Load textdomain
+            'add_rewrite_tags',         // Add rewrite tags
+            'generate_rewrite_rules'    // Generate rewrite rules
+        );
+
+        // Add the actions
+        foreach( $actions as $class_action )
+            add_action( 'bp_' . $class_action, array( $this, $class_action ), 5 );
     }
 }
 
-// This is a new installation.
-if ( empty( $bp->database_version ) ) {
-    $bp->maintenance_mode = 'install';
-    require( BP_PLUGIN_DIR . '/bp-core/admin/bp-core-update.php' );
-
-// There is a previous installation
-} else {
-
-    // Setup the BuddyPress theme directory
-    register_theme_directory( BP_PLUGIN_DIR . '/bp-themes' );
-
-    // Load core
-    require( BP_PLUGIN_DIR . '/bp-core/bp-core-loader.php' );
-
-    // Check if an update is required
-    if ( (int)$bp->database_version < (int)constant( 'BP_DB_VERSION' ) || isset( $bp->is_network_activate ) ) {
-        $bp->maintenance_mode = 'update';
-        require( BP_PLUGIN_DIR . '/bp-core/admin/bp-core-update.php' );
-    }
-}
+// "And now for something completely different"
+$_GLOBALS['bp'] = new BuddyPress;
+
+endif;
 
 /** Activation ****************************************************************/
+
+// @todo Move this code into bp-core-update.php
 
 if ( !function_exists( 'bp_loader_activate' ) ) :