<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][8544] trunk/src/bp-core/bp-core-buddybar.php: Break redirect/display hook logic out of bp_core_new_subnav_item()</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8544">8544</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-06-22 18:30:38 +0000 (Sun, 22 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Break redirect/display hook logic out of bp_core_new_subnav_item()
By moving some of the critical logic into bp_core_maybe_hook_new_subnav_screen_function(),
it becomes possible to write unit tests for it.
See <a href="http://buddypress.trac.wordpress.org/ticket/5720">#5720</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorebuddybarphp">trunk/src/bp-core/bp-core-buddybar.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorebuddybarphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-core/bp-core-buddybar.php (8543 => 8544)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-core/bp-core-buddybar.php 2014-06-21 17:58:16 UTC (rev 8543)
+++ trunk/src/bp-core/bp-core-buddybar.php 2014-06-22 18:30:38 UTC (rev 8544)
</span><span class="lines">@@ -295,7 +295,7 @@
</span><span class="cx"> if ( empty( $item_css_id ) )
</span><span class="cx"> $item_css_id = $slug;
</span><span class="cx">
</span><del>- $bp->bp_options_nav[$parent_slug][$slug] = array(
</del><ins>+ $subnav_item = array(
</ins><span class="cx"> 'name' => $name,
</span><span class="cx"> 'link' => trailingslashit( $link ),
</span><span class="cx"> 'slug' => $slug,
</span><span class="lines">@@ -304,6 +304,7 @@
</span><span class="cx"> 'user_has_access' => $user_has_access,
</span><span class="cx"> 'screen_function' => &$screen_function
</span><span class="cx"> );
</span><ins>+ $bp->bp_options_nav[$parent_slug][$slug] = $subnav_item;
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * The last step is to hook the screen function for the added subnav item. But this only
</span><span class="lines">@@ -329,46 +330,88 @@
</span><span class="cx"> // If we *do* meet condition (2), then the added subnav item is currently being requested
</span><span class="cx"> if ( ( bp_current_action() && bp_is_current_action( $slug ) ) || ( bp_is_user() && ! bp_current_action() && ( $screen_function == $bp->bp_nav[$parent_slug]['screen_function'] ) ) ) {
</span><span class="cx">
</span><del>- // Before hooking the screen function, check user access
- if ( !empty( $user_has_access ) ) {
- // Add our screen hook if screen function is callable
- if ( is_callable( $screen_function ) ) {
- add_action( 'bp_screens', $screen_function, 3 );
- }
</del><ins>+ $hooked = bp_core_maybe_hook_new_subnav_screen_function( $subnav_item );
+
+ // If redirect args have been returned, perform the redirect now
+ if ( ! empty( $hooked['status'] ) && 'failure' === $hooked['status'] && isset( $hooked['redirect_args'] ) ) {
+ bp_core_no_access( $hooked['redirect_args'] );
+ }
+ }
+}
+
+/**
+ * For a given subnav item, either hook the screen function or generate redirect arguments, as necessary.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $subnav_item The subnav array added to bp_options_nav in
+ * bp_core_new_subnav_item().
+ * @return array
+ */
+function bp_core_maybe_hook_new_subnav_screen_function( $subnav_item ) {
+ $retval = array(
+ 'status' => '',
+ );
+
+ // User has access, so let's try to hook the display callback
+ if ( ! empty( $subnav_item['user_has_access'] ) ) {
+
+ // Screen function is invalid
+ if ( ! is_callable( $subnav_item['screen_function'] ) ) {
+ $retval['status'] = 'failure';
+
+ // Success - hook to bp_screens
</ins><span class="cx"> } else {
</span><ins>+ add_action( 'bp_screens', $subnav_item['screen_function'], 3 );
+ $retval['status'] = 'success';
+ }
</ins><span class="cx">
</span><del>- // When the content is off-limits, we handle the situation
- // differently depending on whether the current user is logged in
- if ( is_user_logged_in() ) {
- if ( !bp_is_my_profile() && empty( $bp->bp_nav[$bp->default_component]['show_for_displayed_user'] ) ) {
</del><ins>+ // User doesn't have access. Determine redirect arguments based on
+ // user status
+ } else {
+ $retval['status'] = 'failure';
</ins><span class="cx">
</span><del>- // This covers the edge case where the default component is
- // a non-public tab, like 'messages'
- if ( bp_is_active( 'activity' ) && isset( $bp->pages->activity ) ) {
- $redirect_to = trailingslashit( bp_displayed_user_domain() . bp_get_activity_slug() );
- } else {
- $redirect_to = trailingslashit( bp_displayed_user_domain() . ( 'xprofile' == $bp->profile->id ? 'profile' : $bp->profile->id ) );
- }
</del><ins>+ if ( is_user_logged_in() ) {
</ins><span class="cx">
</span><del>- $message = '';
</del><ins>+ $bp = buddypress();
+
+ // Redirect to the displayed user's default component
+ // If the displayed user is different from the logged-
+ // in user, we first check to ensure that the user has
+ // access to the default component
+ if ( bp_is_my_profile() || ! empty( $bp->bp_nav[ $bp->default_component ]['show_for_displayed_user'] ) ) {
+ $message = __( 'You do not have access to this page.', 'buddypress' );
+ $redirect_to = bp_displayed_user_domain();
+
+ // In some cases, the default tab is not accessible to
+ // the logged-in user. So we look for a fallback.
+ } else {
+ // Try 'activity' first
+ if ( bp_is_active( 'activity' ) && isset( $bp->pages->activity ) ) {
+ $redirect_to = trailingslashit( bp_displayed_user_domain() . bp_get_activity_slug() );
+ // Then try 'profile'
</ins><span class="cx"> } else {
</span><del>- $message = __( 'You do not have access to this page.', 'buddypress' );
- $redirect_to = bp_displayed_user_domain();
</del><ins>+ $redirect_to = trailingslashit( bp_displayed_user_domain() . ( 'xprofile' == $bp->profile->id ? 'profile' : $bp->profile->id ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Off-limits to this user. Throw an error and redirect to the displayed user's domain
- bp_core_no_access( array(
- 'message' => $message,
- 'root' => $redirect_to,
- 'redirect' => false
- ) );
</del><ins>+ $message = '';
+ }
</ins><span class="cx">
</span><del>- // Not logged in. Allow the user to log in, and attempt to redirect
- } else {
- bp_core_no_access();
- }
</del><ins>+ $retval['redirect_args'] = array(
+ 'message' => $message,
+ 'root' => $redirect_to,
+ 'redirect' => false,
+ );
+
+ } else {
+ // When the user is logged out, pass an empty array
+ // This indicates that the default arguments should be
+ // used in bp_core_no_access()
+ $retval['redirect_args'] = array();
</ins><span class="cx"> }
</span><span class="cx"> }
</span><ins>+
+ return $retval;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>