Changeset 12121

Timestamp:

05/25/2018 03:48:20 AM (7 years ago)

Author:

imath

Message:

BP Nouveau: Improve Messages UI extensibility

In BP Nouveau, the Messages UI is a Backbone based one. This means current legacy hooks inserted into the JS templates are a bit more different to use for plugin developers as it requires them to use JavaScript to get the data models. If the current AJAX requests still need a way to be extended to fetch extra data such as specific Messages metas, this commit is a first step to help plugin developers to insert content into the Messages UI without changing their habits about using the PHP Messages template global variables to get data about the Messages loop. This is done by introducing the back compatibility function bp_nouveau_messages_catch_hook_content(). This function is used during the AJAX requests that are fetching messages for a specific thread. As a start, 2 legacy hooks have been moved from the JS Template level to this higher level :

• bp_before_message_content
• bp_after_message_content

If actions are attached to these hooks their outputs will be caught using the buffer and will be "transported" as new properties, respectively beforeContent and afterContent, of the JSON reply that is used by the Messages UI. If these 2 properties are set and populated, their content will be output inside the corresponding JS templates.

Props pareshradadiya

See #7847 (Trunk)

Location:

trunk/src

Files:

• bp-core/bp-core-functions.php (modified) (1 diff)
• bp-templates/bp-nouveau/buddypress/common/js-templates/messages/index.php (modified) (1 diff)
• bp-templates/bp-nouveau/includes/messages/ajax.php (modified) (4 diffs)
• bp-templates/bp-nouveau/includes/messages/functions.php (modified) (1 diff)

trunk/src/bp-core/bp-core-functions.php

@@ -3841 +3841 @@
     ) );
 }
+
+/**
+ * Remove script and style tags from a string.
+ *
+ * @since 3.0.1
+ *
+ * @param  string $string The string to strip tags from.
+ * @return string         The stripped tags string.
+ */
+function bp_strip_script_and_style_tags( $string ) {
+    return preg_replace( '@<(script|style)[^>]*?>.*?</\\1>@si', '', $string );
+}

trunk/src/bp-templates/bp-nouveau/buddypress/common/js-templates/messages/index.php

@@ -273 +273 @@
     </div>
 
-    <?php bp_nouveau_messages_hook( 'before', 'content' ); ?>
-
-    <div class="message-content"><# print( data.content ) #></div>
-
-    <?php bp_nouveau_messages_hook( 'after', 'content' ); ?>
+    <# if ( data.beforeContent ) { #>
+        <div class="bp-messages-hook before-message-content">{{{data.beforeContent}}}</div>
+    <# } #>
+
+    <div class="message-content">{{{data.content}}}</div>
+
+    <# if ( data.afterContent ) { #>
+        <div class="bp-messages-hook after-message-content">{{{data.afterContent}}}</div>
+    <# } #>
 
 </script>

trunk/src/bp-templates/bp-nouveau/includes/messages/ajax.php

@@ -135 +135 @@
     }
 
-    // Get the message bye pretending we're in the message loop.
+    // Get the message by pretending we're in the message loop.
     global $thread_template;
+
+    $bp           = buddypress();
+    $reset_action = $bp->current_action;
+
+    // Override bp_current_action().
+    $bp->current_action = 'view';
 
     bp_thread_has_messages( array( 'thread_id' => (int) $_POST['thread_id'] ) );
@@ -183 +189 @@
     }
 
+    $extra_content = bp_nouveau_messages_catch_hook_content( array(
+        'beforeContent' => 'bp_before_message_content',
+        'afterContent'  => 'bp_after_message_content',
+    ) );
+
+    if ( array_filter( $extra_content ) ) {
+        $reply = array_merge( $reply, $extra_content );
+    }
+
     // Clean up the loop.
     bp_thread_messages();
+
+    // Remove the bp_current_action() override.
+    $bp->current_action = $reset_action;
 
     wp_send_json_success( array(
@@ -357 +375 @@
     }
 
-    $thread_id = (int) $_POST['id'];
+    $thread_id    = (int) $_POST['id'];
+    $bp           = buddypress();
+    $reset_action = $bp->current_action;
+
+    // Override bp_current_action().
+    $bp->current_action = 'view';
 
     // Simulate the loop.
     if ( ! bp_thread_has_messages( array( 'thread_id' => $thread_id ) ) ) {
+        // Remove the bp_current_action() override.
+        $bp->current_action = $reset_action;
+
         wp_send_json_error( $response );
     }
@@ -423 +449 @@
         }
 
+        $extra_content = bp_nouveau_messages_catch_hook_content( array(
+            'beforeContent' => 'bp_before_message_content',
+            'afterContent'  => 'bp_after_message_content',
+        ) );
+
+        if ( array_filter( $extra_content ) ) {
+            $thread->messages[ $i ] = array_merge( $thread->messages[ $i ], $extra_content );
+        }
+
         $i += 1;
     endwhile;
 
     $thread->messages = array_filter( $thread->messages );
+
+    // Remove the bp_current_action() override.
+    $bp->current_action = $reset_action;
 
     wp_send_json_success( $thread );

trunk/src/bp-templates/bp-nouveau/includes/messages/functions.php

@@ -439 +439 @@
     );
 }
+
+/**
+ * Fires Messages Legacy hooks to catch the content and add them
+ * as extra keys to the JSON Messages UI reply.
+ *
+ * @since 3.0.1
+ *
+ * @param array $hooks The list of hooks to fire.
+ * @return array       An associative containing the caught content.
+ */
+function bp_nouveau_messages_catch_hook_content( $hooks = array() ) {
+    $content = array();
+
+    ob_start();
+    foreach ( $hooks as $js_key => $hook ) {
+        if ( ! has_action( $hook ) ) {
+            continue;
+        }
+
+        // Fire the hook.
+        do_action( $hook );
+
+        // Catch the sanitized content.
+        $content[ $js_key ] = bp_strip_script_and_style_tags( ob_get_contents() );
+
+        // Clean the buffer.
+        ob_clean();
+    }
+    ob_end_clean();
+
+    return $content;
+}