<!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][7363] branches/1.8: Fix hidden xprofile fields for admins</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/7363">7363</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-09-02 02:52:13 +0000 (Mon, 02 Sep 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Fix hidden xprofile fields for admins

XProfile field visibility was not being calculated correctly for admins,
due to incorrect logic in bp_xprofile_get_hidden_fields_for_user(). This
changeset clears up the logic, by moving the bp_moderate check earlier
in the flow.

To make the changes easier to implement and to test, this changeset also
breaks the calculation of visibility levels for a user-user pair into
a separate function, bp_xprofile_get_hidden_field_types_for_user().

Also introduces unit tests for the latter function.

Fixes <a href="http://buddypress.trac.wordpress.org/ticket/4984">#4984</a>

Props imath</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#branches18bpxprofilebpxprofilefunctionsphp">branches/1.8/bp-xprofile/bp-xprofile-functions.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li>branches/1.8/tests/testcases/xprofile/</li>
<li><a href="#branches18teststestcasesxprofilefunctionsphp">branches/1.8/tests/testcases/xprofile/functions.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches18bpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: branches/1.8/bp-xprofile/bp-xprofile-functions.php (7362 => 7363)</h4>
<pre class="diff"><span>
<span class="info">--- branches/1.8/bp-xprofile/bp-xprofile-functions.php       2013-09-02 02:52:10 UTC (rev 7362)
+++ branches/1.8/bp-xprofile/bp-xprofile-functions.php  2013-09-02 02:52:13 UTC (rev 7363)
</span><span class="lines">@@ -677,38 +677,53 @@
</span><span class="cx">  }
</span><span class="cx"> 
</span><span class="cx">  // @todo - This is where you'd swap out for current_user_can() checks
</span><del>-       $hidden_levels = $hidden_fields = array();
</del><ins>+        $hidden_levels = bp_xprofile_get_hidden_field_types_for_user( $displayed_user_id, $current_user_id );
+       $hidden_fields = bp_xprofile_get_fields_by_visibility_levels( $displayed_user_id, $hidden_levels );
</ins><span class="cx"> 
</span><ins>+       return apply_filters( 'bp_xprofile_get_hidden_fields_for_user', $hidden_fields, $displayed_user_id, $current_user_id );
+}
+
+/**
+ * Get the visibility levels that should be hidden for this user pair
+ *
+ * Field visibility is determined based on the relationship between the
+ * logged-in user, the displayed user, and the visibility setting for the
+ * current field. (See bp_xprofile_get_hidden_fields_for_user().) This
+ * utility function speeds up this matching by fetching the visibility levels
+ * that should be hidden for the current user pair.
+ *
+ * @since BuddyPress (1.8.2)
+ * @see bp_xprofile_get_hidden_fields_for_user()
+ *
+ * @param int $displayed_user_id The id of the user the profile fields belong to
+ * @param int $current_user_id The id of the user viewing the profile
+ * @return array An array of visibility levels hidden to the current user
+ */
+function bp_xprofile_get_hidden_field_types_for_user( $displayed_user_id = 0, $current_user_id = 0 ) {
+
</ins><span class="cx">   // Current user is logged in
</span><del>-       if ( $current_user_id ) {
</del><ins>+        if ( ! empty( $current_user_id ) ) {
</ins><span class="cx"> 
</span><del>-               // If you're viewing your own profile, nothing's private
-               if ( $displayed_user_id == $current_user_id ) {
</del><ins>+                // Nothing's private when viewing your own profile, or when the
+               // current user is an admin
+               if ( $displayed_user_id == $current_user_id || bp_current_user_can( 'bp_moderate' ) ) {
+                       $hidden_levels = array();
</ins><span class="cx"> 
</span><span class="cx">          // If the current user and displayed user are friends, show all
</span><span class="cx">          } elseif ( bp_is_active( 'friends' ) && friends_check_friendship( $displayed_user_id, $current_user_id ) ) {
</span><del>-                       if ( ! bp_current_user_can( 'bp_moderate' ) )
-                               $hidden_levels[] = 'adminsonly';
</del><ins>+                        $hidden_levels = array( 'adminsonly', );
</ins><span class="cx"> 
</span><del>-                       $hidden_fields = bp_xprofile_get_fields_by_visibility_levels( $displayed_user_id, $hidden_levels );
-
-               // current user is logged-in but not friends, so exclude friends-only
</del><ins>+                // current user is logged in but not friends, so exclude friends-only
</ins><span class="cx">           } else {
</span><del>-                       $hidden_levels = array( 'friends' );
-
-                       if ( ! bp_current_user_can( 'bp_moderate' ) )
-                               $hidden_levels[] = 'adminsonly';
-
-                       $hidden_fields = bp_xprofile_get_fields_by_visibility_levels( $displayed_user_id, $hidden_levels );
</del><ins>+                        $hidden_levels = array( 'friends', 'adminsonly', );
</ins><span class="cx">           }
</span><span class="cx"> 
</span><span class="cx">  // Current user is not logged in, so exclude friends-only, loggedin, and adminsonly.
</span><span class="cx">  } else {
</span><span class="cx">          $hidden_levels = array( 'friends', 'loggedin', 'adminsonly', );
</span><del>-               $hidden_fields = bp_xprofile_get_fields_by_visibility_levels( $displayed_user_id, $hidden_levels );
</del><span class="cx">   }
</span><span class="cx"> 
</span><del>-       return apply_filters( 'bp_xprofile_get_hidden_fields_for_user', $hidden_fields, $displayed_user_id, $current_user_id );
</del><ins>+        return $hidden_levels;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> /**
</span></span></pre></div>
<a id="branches18teststestcasesxprofilefunctionsphp"></a>
<div class="addfile"><h4>Added: branches/1.8/tests/testcases/xprofile/functions.php (0 => 7363)</h4>
<pre class="diff"><span>
<span class="info">--- branches/1.8/tests/testcases/xprofile/functions.php                              (rev 0)
+++ branches/1.8/tests/testcases/xprofile/functions.php 2013-09-02 02:52:13 UTC (rev 7363)
</span><span class="lines">@@ -0,0 +1,65 @@
</span><ins>+<?php
+
+/**
+ * @group xprofile
+ * @group functions
+ */
+class BP_Tests_XProfile_Functions extends BP_UnitTestCase {
+       public function setUp() {
+               parent::setUp();
+       }
+
+       public function tearDown() {
+               parent::tearDown();
+       }
+
+       public function test_get_hidden_field_types_for_user_loggedout() {
+               $duser = $this->create_user();
+
+               $old_current_user = bp_loggedin_user_id();
+               $this->set_current_user( 0 );
+
+               $this->assertEquals( array( 'friends', 'loggedin', 'adminsonly' ), bp_xprofile_get_hidden_field_types_for_user( $duser, bp_loggedin_user_id() ) );
+
+               $this->set_current_user( $old_current_user );
+       }
+
+       public function test_get_hidden_field_types_for_user_loggedin() {
+               $duser = $this->create_user();
+               $cuser = $this->create_user();
+
+               $old_current_user = bp_loggedin_user_id();
+               $this->set_current_user( $cuser );
+
+               $this->assertEquals( array( 'friends', 'adminsonly' ), bp_xprofile_get_hidden_field_types_for_user( $duser, bp_loggedin_user_id() ) );
+
+               $this->set_current_user( $old_current_user );
+       }
+
+       public function test_get_hidden_field_types_for_user_friends() {
+               $duser = $this->create_user();
+               $cuser = $this->create_user();
+               friends_add_friend( $duser, $cuser, true );
+
+               $old_current_user = bp_loggedin_user_id();
+               $this->set_current_user( $cuser );
+
+               $this->assertEquals( array( 'adminsonly' ), bp_xprofile_get_hidden_field_types_for_user( $duser, bp_loggedin_user_id() ) );
+
+               $this->set_current_user( $old_current_user );
+       }
+
+       public function test_get_hidden_field_types_for_user_admin() {
+               $duser = $this->create_user();
+               $cuser = $this->create_user();
+               $this->grant_bp_moderate( $cuser );
+
+               $old_current_user = bp_loggedin_user_id();
+               $this->set_current_user( $cuser );
+
+               $this->assertEquals( array(), bp_xprofile_get_hidden_field_types_for_user( $duser, bp_loggedin_user_id() ) );
+
+               $this->revoke_bp_moderate( $cuser );
+               $this->set_current_user( $old_current_user );
+       }
+}
</ins></span></pre>
</div>
</div>

</body>
</html>