<!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][12483] branches/5.0: Only load BP REST API Avatar Controllers when avatar uploads are on</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12483">12483</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12483","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-10-27 04:53:16 +0000 (Sun, 27 Oct 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Only load BP REST API Avatar Controllers when avatar uploads are on
- Move the loading of the `BP_REST_Attachments_Member_Avatar_Endpoint` controller into the xProfile component's class. User Avatar is an xProfile feature.
- Make sure to check the community administrator allowed member avatar uploads before loading this controller.
- Make sure to check the community administrator allowed group avatar uploads before loading `BP_REST_Attachments_Group_Avatar_Endpoint`.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8151">#8151</a> (Branch 5.0)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcbpgroupsclassesclassbpgroupscomponentphp">branches/5.0/src/bp-groups/classes/class-bp-groups-component.php</a></li>
<li><a href="#branches50srcbpmembersclassesclassbpmemberscomponentphp">branches/5.0/src/bp-members/classes/class-bp-members-component.php</a></li>
<li><a href="#branches50srcbpxprofileclassesclassbpxprofilecomponentphp">branches/5.0/src/bp-xprofile/classes/class-bp-xprofile-component.php</a></li>
<li><a href="#branches50testsphpunitassetsbprestapicontrollersphp">branches/5.0/tests/phpunit/assets/bp-rest-api-controllers.php</a></li>
<li><a href="#branches50testsphpunittestcasescoreclassbpcomponentphp">branches/5.0/tests/phpunit/testcases/core/class-bp-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcbpgroupsclassesclassbpgroupscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/bp-groups/classes/class-bp-groups-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/bp-groups/classes/class-bp-groups-component.php 2019-10-27 04:10:39 UTC (rev 12482)
+++ branches/5.0/src/bp-groups/classes/class-bp-groups-component.php 2019-10-27 04:53:16 UTC (rev 12483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -932,12 +932,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * description.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function rest_api_init( $controllers = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- parent::rest_api_init( array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $controllers = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Groups_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Group_Membership_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Group_Invites_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Group_Membership_Request_Endpoint',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'BP_REST_Attachments_Group_Avatar_Endpoint',
- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ );
+
+ // Only Load the Group's Avatar controller if Group Avatar uploads are allowed.
+ if ( ! bp_disable_group_avatar_uploads() ) {
+ $controllers[] = 'BP_REST_Attachments_Group_Avatar_Endpoint';
+ }
+
+ parent::rest_api_init( $controllers );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches50srcbpmembersclassesclassbpmemberscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/bp-members/classes/class-bp-members-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/bp-members/classes/class-bp-members-component.php 2019-10-27 04:10:39 UTC (rev 12482)
+++ branches/5.0/src/bp-members/classes/class-bp-members-component.php 2019-10-27 04:53:16 UTC (rev 12483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -473,7 +473,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Components_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Members_Endpoint',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'BP_REST_Attachments_Member_Avatar_Endpoint',
</del><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches50srcbpxprofileclassesclassbpxprofilecomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/bp-xprofile/classes/class-bp-xprofile-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/bp-xprofile/classes/class-bp-xprofile-component.php 2019-10-27 04:10:39 UTC (rev 12482)
+++ branches/5.0/src/bp-xprofile/classes/class-bp-xprofile-component.php 2019-10-27 04:53:16 UTC (rev 12483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -499,10 +499,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * description.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function rest_api_init( $controllers = array() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- parent::rest_api_init( array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $controllers = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_XProfile_Fields_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_XProfile_Field_Groups_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_XProfile_Data_Endpoint',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ );
+
+ // Only Load the Member's Avatar controller if Avatar uploads are allowed.
+ if ( ! bp_disable_avatar_uploads() ) {
+ $controllers[] = 'BP_REST_Attachments_Member_Avatar_Endpoint';
+ }
+
+ parent::rest_api_init( $controllers );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches50testsphpunitassetsbprestapicontrollersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/assets/bp-rest-api-controllers.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/assets/bp-rest-api-controllers.php 2019-10-27 04:10:39 UTC (rev 12482)
+++ branches/5.0/tests/phpunit/assets/bp-rest-api-controllers.php 2019-10-27 04:53:16 UTC (rev 12483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_REST_Attachments_Member_Avatar_Endpoint extends BP_REST_Mock_Class {
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->rest_base = 'members';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->rest_base = 'xprofile';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function register_routes( $controller = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,3 +52,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::register_routes( 'BP_REST_Members_Endpoint' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * BP xProfiles Data REST Controller's mock.
+ */
+class BP_REST_XProfile_Data_Endpoint extends BP_REST_Mock_Class {
+ public function __construct() {
+ $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+ $this->rest_base = 'xprofile';
+ }
+
+ public function register_routes( $controller = '' ) {
+ parent::register_routes( 'BP_REST_XProfile_Data_Endpoint' );
+ }
+}
+
+/**
+ * BP xProfiles Field Groups REST Controller's mock.
+ */
+class BP_REST_XProfile_Field_Groups_Endpoint extends BP_REST_Mock_Class {
+ public function __construct() {
+ $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+ $this->rest_base = 'xprofile/groups';
+ }
+
+ public function register_routes( $controller = '' ) {
+ parent::register_routes( 'BP_REST_XProfile_Field_Groups_Endpoint' );
+ }
+}
+
+/**
+ * BP xProfiles Fields REST Controller's mock.
+ */
+class BP_REST_XProfile_Fields_Endpoint extends BP_REST_Mock_Class {
+ public function __construct() {
+ $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+ $this->rest_base = 'xprofile/fields';
+ }
+
+ public function register_routes( $controller = '' ) {
+ parent::register_routes( 'BP_REST_XProfile_Fields_Endpoint' );
+ }
+}
</ins></span></pre></div>
<a id="branches50testsphpunittestcasescoreclassbpcomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/testcases/core/class-bp-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/testcases/core/class-bp-component.php 2019-10-27 04:10:39 UTC (rev 12482)
+++ branches/5.0/tests/phpunit/testcases/core/class-bp-component.php 2019-10-27 04:53:16 UTC (rev 12483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +32,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $bp->unit_test_rest->controllers, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Components_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Members_Endpoint',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'BP_REST_Attachments_Member_Avatar_Endpoint',
</del><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,7 +47,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $bp->unit_test_rest->controllers, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Components_Endpoint',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'BP_REST_Attachments_Member_Avatar_Endpoint',
</del><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,7 +63,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $bp->unit_test_rest->controllers, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Components_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Members_Endpoint',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ) );
+ }
+
+ public function test_rest_api_init_for_xprofile_component() {
+ $bp_xprofile = new BP_XProfile_Component();
+ $bp = buddypress();
+
+ $bp_xprofile->rest_api_init();
+
+ $this->assertSame( $bp->unit_test_rest->controllers, array(
+ 'BP_REST_XProfile_Fields_Endpoint',
+ 'BP_REST_XProfile_Field_Groups_Endpoint',
+ 'BP_REST_XProfile_Data_Endpoint',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'BP_REST_Attachments_Member_Avatar_Endpoint',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ public function test_rest_api_init_for_xprofile_component_without_avatar_enabled() {
+ add_filter( 'bp_disable_avatar_uploads', '__return_true' );
+
+ $bp_xprofile = new BP_XProfile_Component();
+ $bp = buddypress();
+
+ $bp_xprofile->rest_api_init();
+
+ remove_filter( 'bp_disable_avatar_uploads', '__return_true' );
+
+ $this->assertSame( $bp->unit_test_rest->controllers, array(
+ 'BP_REST_XProfile_Fields_Endpoint',
+ 'BP_REST_XProfile_Field_Groups_Endpoint',
+ 'BP_REST_XProfile_Data_Endpoint',
+ ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>