Changeset 5319

Timestamp:

11/09/2011 06:38:28 AM (13 years ago)

Author:

johnjamesjacoby

Message:

Performance improvements and phpdoc to bp-core-catchuri.php. Introduce bp_core_enable_root_profiles() function as wrapper for constant.

Location:

trunk

Files:

• bp-core/bp-core-catchuri.php (modified) (9 diffs)
• bp-members/bp-members-functions.php (modified) (1 diff)

trunk/bp-core/bp-core-catchuri.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress URI catcher
+ *
+ * Functions for parsing the URI and determining which BuddyPress template file
+ * to use on-screen.
+ *
+ * Based on contributions from: Chris Taylor - http://www.stillbreathing.co.uk/
+ * Modified for BuddyPress by: Andy Peatling - http://apeatling.wordpress.com/
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ */
+
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
 
-/*
-Based on contributions from: Chris Taylor - http://www.stillbreathing.co.uk/
-Modified for BuddyPress by: Andy Peatling - http://apeatling.wordpress.com/
-*/
-
 /**
  * Analyzes the URI structure and breaks it down into parts for use in code.
- * The idea is that BuddyPress can use complete custom friendly URI's without the
- * user having to add new re-write rules.
- *
- * Future custom components would then be able to use their own custom URI structure.
+ * BuddyPress can use complete custom friendly URI's without the user having to
+ * add new re-write rules. Custom components are able to use their own custom
+ * URI structures with very little work.
  *
  * @package BuddyPress Core
@@ -36 +44 @@
         return false;
 
+    // Define local variables
+    $root_profile = $match   = false;
+    $key_slugs    = $matches = $uri_chunks = array();
+
     // Fetch all the WP page names for each component
     if ( empty( $bp->pages ) )
@@ -49 +61 @@
     $path = apply_filters( 'bp_uri', $path );
 
-    // Take GET variables off the URL to avoid problems,
-    // they are still registered in the global $_GET variable
-    if ( $noget = substr( $path, 0, strpos( $path, '?' ) ) )
-        $path = $noget;
-
-    // Fetch the current URI and explode each part separated by '/' into an array
+    // Take GET variables off the URL to avoid problems
+    $path = strtok( $path, '?' );
+
+    // Fetch current URI and explode each part separated by '/' into an array
     $bp_uri = explode( '/', $path );
 
     // Loop and remove empties
-    foreach ( (array)$bp_uri as $key => $uri_chunk )
-        if ( empty( $bp_uri[$key] ) ) unset( $bp_uri[$key] );
-
-    // Running off blog other than root
+    foreach ( (array)$bp_uri as $key => $uri_chunk ) {
+        if ( empty( $bp_uri[$key] ) ) {
+            unset( $bp_uri[$key] );
+        }
+    }
+
+    // If running off blog other than root, any subdirectory names must be
+    // removed from $bp_uri. This includes two cases:
+    // 
+    //    1. when WP is installed in a subdirectory,
+    //    2. when BP is running on secondary blog of a subdirectory
+    //       multisite installation. Phew!
     if ( is_multisite() && !is_subdomain_install() && ( bp_is_multiblog_mode() || 1 != bp_get_root_blog_id() ) ) {
 
-        // Any subdirectory names must be removed from $bp_uri.
-        // This includes two cases: (1) when WP is installed in a subdirectory,
-        // and (2) when BP is running on secondary blog of a subdirectory
-        // multisite installation. Phew!
-        if ( $chunks = explode( '/', $current_blog->path ) ) {
+        // Blow chunks
+        $chunks = explode( '/', $current_blog->path );
+
+        // If chunks exist...
+        if ( !empty( $chunks ) ) {
+
+            // ...loop through them...
             foreach( $chunks as $key => $chunk ) {
                 $bkey = array_search( $chunk, $bp_uri );
 
-                if ( $bkey !== false ) {
+                // ...and unset offending keys
+                if ( false !== $bkey ) {
                     unset( $bp_uri[$bkey] );
                 }
@@ -80 +101 @@
         }
     }
-
-    // Set the indexes, these are incresed by one if we are not on a VHOST install
-    $component_index = 0;
-    $action_index    = $component_index + 1;
 
     // Get site path items
@@ -178 +195 @@
 
     // URLs with BP_ENABLE_ROOT_PROFILES enabled won't be caught above
-    if ( empty( $matches ) && defined( 'BP_ENABLE_ROOT_PROFILES' ) && BP_ENABLE_ROOT_PROFILES ) {
+    if ( empty( $matches ) && bp_core_enable_root_profiles() ) {
 
         // Make sure there's a user corresponding to $bp_uri[0]
@@ -296 +313 @@
 
 /**
+ * Are root profiles enabled and allowed
+ * 
+ * @since BuddyPress (1.6)
+ * @return bool True if yes, false if no
+ */
+function bp_core_enable_root_profiles() {
+    
+    $retval = false;
+
+    if ( defined( 'BP_ENABLE_ROOT_PROFILES' ) && ( true == BP_ENABLE_ROOT_PROFILES ) )
+        $retval = true;
+    
+    return apply_filters( 'bp_core_enable_root_profiles', $retval );
+}
+
+/**
  * bp_core_load_template()
  *
@@ -310 +343 @@
  */
 function bp_core_load_template( $templates ) {
-    global $post, $bp, $wpdb, $wp_query;
-
-    // Determine if the root object WP page exists for this request (TODO: is there an API function for this?
-    if ( !empty( $bp->unfiltered_uri_offset ) && !$page_exists = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_name = %s", $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) ) )
+    global $post, $bp, $wp_query;
+
+    // Bail if there is no offset
+    if ( empty( $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) )
+        return false;
+
+    // Determine if the root object WP page exists for this request
+    if ( !get_page_by_path( $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) )
         return false;
 
     // Set the root object as the current wp_query-ied item
     $object_id = 0;
-    foreach ( (array)$bp->pages as $page ) {
-        if ( isset( $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) && ( $page->name == $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) ) {
+    foreach ( (array) $bp->pages as $page ) {
+        if ( $page->name == $bp->unfiltered_uri[$bp->unfiltered_uri_offset] ) {
             $object_id = $page->id;
         }
@@ -331 +368 @@
     }
 
+    // Define local variables
+    $located_template   = false;
+    $filtered_templates = array();
+
     // Fetch each template and add the php suffix
-    foreach ( (array)$templates as $template )
+    foreach ( (array) $templates as $template )
         $filtered_templates[] = $template . '.php';
 
     // Filter the template locations so that plugins can alter where they are located
-    if ( $located_template = apply_filters( 'bp_located_template', locate_template( (array) $filtered_templates, false ), $filtered_templates ) ) {
+    $located_template = apply_filters( 'bp_located_template', locate_template( (array) $filtered_templates, false ), $filtered_templates );
+    if ( !empty( $located_template ) ) {
+
         // Template was located, lets set this as a valid page and not a 404.
         status_header( 200 );
@@ -405 +448 @@
 
     // Apply filters to these variables
-    $mode       = apply_filters( 'bp_no_access_mode', $mode, $root, $redirect, $message );
-    $redirect   = apply_filters( 'bp_no_access_redirect', $redirect, $root, $message, $mode );
-    $root       = trailingslashit( apply_filters( 'bp_no_access_root', $root, $redirect, $message, $mode ) );
-    $message    = apply_filters( 'bp_no_access_message', $message, $root, $redirect, $mode );
+    $mode       = apply_filters( 'bp_no_access_mode',     $mode,     $root,     $redirect, $message );
+    $redirect   = apply_filters( 'bp_no_access_redirect', $redirect, $root,     $message,  $mode    );
+    $root       = apply_filters( 'bp_no_access_root',     $root,     $redirect, $message,  $mode    );
+    $message    = apply_filters( 'bp_no_access_message',  $message,  $root,     $redirect, $mode    );
+    $root       = trailingslashit( $root );
 
     switch ( $mode ) {

trunk/bp-members/bp-members-functions.php

@@ -110 +110 @@
             $username = rawurlencode( $username );
 
-        // If we are using a members slug, include it.
-        if ( !defined( 'BP_ENABLE_ROOT_PROFILES' ) )
-            $domain = bp_get_root_domain() . '/' . bp_get_members_root_slug() . '/' . $username;
-        else
-            $domain = bp_get_root_domain() . '/' . $username;
-
-        // Add a slash at the end, and filter before caching
-        $domain = apply_filters( 'bp_core_get_user_domain_pre_cache', trailingslashit( $domain ), $user_id, $user_nicename, $user_login );
+        $after_domain = bp_core_enable_root_profiles() ? $username : bp_get_members_root_slug() . '/' . $username;
+        $domain       = trailingslashit( bp_get_root_domain() . '/' . $after_domain );
+        $domain       = apply_filters( 'bp_core_get_user_domain_pre_cache', $domain, $user_id, $user_nicename, $user_login );
 
         // Cache the link
-        if ( !empty( $domain ) )
+        if ( !empty( $domain ) ) {
             wp_cache_set( 'bp_user_domain_' . $user_id, $domain, 'bp' );
+        }
     }