<!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][13986] trunk: Allow creating messages with non-empty content.</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/13986">13986</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/13986","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>espellcaste</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-27 19:16:17 +0000 (Sat, 27 Jul 2024)</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'>Allow creating messages with non-empty content.
Use of the PHP `empty` function to check if the message content is empty is not ideal when creating a message. Update the logic to consider any `string` as non-empty.
Props emaralive, niftythree.
See <a href="http://buddypress.trac.wordpress.org/ticket/9175">#9175</a>
Closes https://github.com/buddypress/buddypress/pull/330</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesfunctionsphp">trunk/src/bp-messages/bp-messages-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesmessagesfunctionsphp">trunk/tests/phpunit/testcases/messages/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-functions.php 2024-07-27 19:04:10 UTC (rev 13985)
+++ trunk/src/bp-messages/bp-messages-functions.php 2024-07-27 19:16:17 UTC (rev 13986)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,8 +56,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'messages_new_message'
</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">+ // Check if the message content is empty.
+ $content = $r['content'];
+ $empty_content = false;
+
+ // Any string is considered non-empty.
+ if ( ! is_string( $content ) || '' === $content ) {
+ $empty_content = true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Bail if no sender or no content.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $r['sender_id'] ) || empty( $r['content'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $r['sender_id'] ) || $empty_content ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'wp_error' === $r['error_type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['sender_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $error_code = 'messages_empty_sender';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,10 +77,9 @@
</span><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"> return new WP_Error( $error_code, $feedback );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- return false;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</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"> // Create a new message object.
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmessagesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/messages/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/messages/functions.php 2024-07-27 19:04:10 UTC (rev 13985)
+++ trunk/tests/phpunit/testcases/messages/functions.php 2024-07-27 19:16:17 UTC (rev 13986)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,7 +26,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, messages_get_unread_count( $u2 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // send another message and get recheck unread count
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $t2 = messages_new_message( array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ messages_new_message( array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'sender_id' => $u1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'recipients' => array( $u2 ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'subject' => 'A new message',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,8 +42,79 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider provider_new_message_empty_content_options
+ *
+ * @ticket BP9175
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group messages_new_message
</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_messages_new_message_empty_content( $content ) {
+ $t1 = messages_new_message(
+ array(
+ 'sender_id' => self::factory()->user->create(),
+ 'recipients' => array( self::factory()->user->create() ),
+ 'subject' => 'A new message',
+ 'content' => $content,
+ 'error_type' => 'wp_error'
+ )
+ );
+
+ $this->assertSame(
+ 'Your message was not sent. Please enter some content.',
+ $t1->get_error_message()
+ );
+ }
+
+ /**
+ * @dataProvider provider_new_message_irregular_content_options
+ *
+ * @ticket BP9175
+ * @group messages_new_message
+ */
+ public function test_messages_new_message_irregular_content( $content ) {
+ $t1 = messages_new_message( array(
+ 'sender_id' => self::factory()->user->create(),
+ 'recipients' => array( self::factory()->user->create() ),
+ 'subject' => 'A new message',
+ 'content' => $content,
+ 'error_type' => 'wp_error'
+ ) );
+
+ $this->assertTrue( is_int( $t1 ) );
+ }
+
+ /**
+ * Provider for the test_messages_new_message_irregular_content_options() test.
+ *
+ * @return array
+ */
+ public function provider_new_message_irregular_content_options() {
+ return array(
+ array( '0' ),
+ array( '00' ),
+ array( 'false' ),
+ );
+ }
+
+ /**
+ * Provider for the test_messages_new_message_empty_content() test.
+ *
+ * @return array
+ */
+ public function provider_new_message_empty_content_options() {
+ return array(
+ array( '' ),
+ array( "" ),
+ array( null ),
+ array( false ),
+ array( 0 ), // '0' is a valid message content.
+ array( array() ),
+ array( new stdClass() ),
+ );
+ }
+
+ /**
+ * @group messages_new_message
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_messages_new_message_invalid_recipient_error_message() {
</span><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>