Changeset 9182

Timestamp:

11/26/2014 06:08:03 AM (11 years ago)

Author:

r-a-y

Message:

Messages: Introduces meta table and related cache functions.

This commit alters the messages DB schema to add a meta table, which will
allow plugin developers to record information about a message.

The new message meta functions in bp-messages-functions.php mirrors those
in other BP components (activity, groups, etc.).

The DB version is also bumped to 9181.

See #3083.

Location:

trunk/src

Files:

• bp-core/admin/bp-core-schema.php (modified) (1 diff)
• bp-core/bp-core-update.php (modified) (2 diffs)
• bp-loader.php (modified) (1 diff)
• bp-messages/bp-messages-cache.php (modified) (1 diff)
• bp-messages/bp-messages-functions.php (modified) (1 diff)
• bp-messages/bp-messages-loader.php (modified) (1 diff)

trunk/src/bp-core/admin/bp-core-schema.php

@@ -305 +305 @@
             ) {$charset_collate};";
 
+    $sql[] = "CREATE TABLE {$bp_prefix}bp_messages_meta (
+                id bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY,
+                message_id bigint(20) NOT NULL,
+                meta_key varchar(255) DEFAULT NULL,
+                meta_value longtext DEFAULT NULL,
+                KEY message_id (message_id),
+                KEY meta_key (meta_key)
+            ) {$charset_collate};";
+
     dbDelta( $sql );
 }

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

@@ -241 +241 @@
         if ( $raw_db_version < 8311 ) {
             bp_update_to_2_0_1();
+        }
+
+        // 2.2
+        if ( $raw_db_version < 9181 ) {
+            bp_update_to_2_2();
         }
     }
@@ -391 +396 @@
 
 /**
+ * 2.2.0 update routine.
+ *
+ * - Add messages meta table
+ *
+ * @since BuddyPress (2.2.0)
+ */
+function bp_update_to_2_2() {
+    if ( bp_is_active( 'messages' ) ) {
+        bp_core_install_private_messaging();
+    }
+}
+
+/**
  * Redirect user to BP's What's New page on first page load after activation.
  *

trunk/src/bp-loader.php

@@ -302 +302 @@
 
         $this->version    = '2.2-alpha';
-        $this->db_version = 9167;
+        $this->db_version = 9181;
 
         /** Loading ***********************************************************/

trunk/src/bp-messages/bp-messages-cache.php

@@ -12 +12 @@
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Slurp up metadata for a set of messages.
+ *
+ * It grabs all message meta associated with all of the messages passed in
+ * $message_ids and adds it to WP cache. This improves efficiency when using
+ * message meta within a loop context.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int|str|array $message_ids Accepts a single message_id, or a
+ *        comma-separated list or array of message ids.
+ */
+function bp_messages_update_meta_cache( $message_ids = false ) {
+    bp_update_meta_cache( array(
+        'object_ids'       => $message_ids,
+        'object_type'      => buddypress()->messages->id,
+        'cache_group'      => 'message_meta',
+        'object_column'    => 'message_id',
+        'meta_table'       => buddypress()->messages->table_name_meta,
+        'cache_key_prefix' => 'bp_messages_meta'
+    ) );
+}
 
 // List actions to clear super cached pages on, if super cache is installed

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

@@ -336 +336 @@
     return BP_Messages_Thread::is_valid( $thread_id );
 }
+
+/** Messages Meta *******************************************************/
+
+/**
+ * Delete metadata for a message.
+ *
+ * If $meta_key is false, this will delete all meta for the message ID.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see delete_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_delete_meta( $message_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
+    // Legacy - if no meta_key is passed, delete all for the item
+    if ( empty( $meta_key ) ) {
+        global $wpdb;
+
+        $keys = $wpdb->get_col( $wpdb->prepare( "SELECT meta_key FROM {$wpdb->messagemeta} WHERE message_id = %d", $message_id ) );
+
+        // With no meta_key, ignore $delete_all
+        $delete_all = false;
+    } else {
+        $keys = array( $meta_key );
+    }
+
+    // no keys, so stop now!
+    if ( empty( $keys ) ) {
+        return false;
+    }
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    foreach ( $keys as $key ) {
+        $retval = delete_metadata( 'message', $message_id, $key, $meta_value, $delete_all );
+    }
+
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
+/**
+ * Get a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see get_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_get_meta( $message_id, $meta_key = '', $single = true ) {
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = get_metadata( 'message', $message_id, $meta_key, $single );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
+/**
+ * Update a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see update_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_messages_update_meta( $message_id, $meta_key, $meta_value, $prev_value = '' ) {
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = update_metadata( 'message', $message_id, $meta_key, $meta_value, $prev_value );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
+/**
+ * Add a piece of message metadata.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @see add_metadata() for full documentation excluding $meta_type variable.
+ */
+function bp_message_add_meta( $message_id, $meta_key, $meta_value, $unique = false ) {
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = add_metadata( 'message', $message_id, $meta_key, $meta_value, $unique );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}

trunk/src/bp-messages/bp-messages-loader.php

@@ -91 +91 @@
             'table_name_notices'    => $bp->table_prefix . 'bp_messages_notices',
             'table_name_messages'   => $bp->table_prefix . 'bp_messages_messages',
-            'table_name_recipients' => $bp->table_prefix . 'bp_messages_recipients'
-        );
+            'table_name_recipients' => $bp->table_prefix . 'bp_messages_recipients',
+            'table_name_meta'       => $bp->table_prefix . 'bp_messages_meta',
+        );
+
+        // Metadata tables for messaging component
+        $meta_tables = array(
+            'message' => $bp->table_prefix . 'bp_messages_meta',
+        );
+
+        $this->autocomplete_all = defined( 'BP_MESSAGES_AUTOCOMPLETE_ALL' );
 
         // All globals for messaging component.
         // Note that global_tables is included in this array.
-        $globals = array(
+        parent::setup_globals( array(
             'slug'                  => BP_MESSAGES_SLUG,
             'has_directory'         => false,
             'notification_callback' => 'messages_format_notifications',
             'search_string'         => __( 'Search Messages...', 'buddypress' ),
-            'global_tables'         => $global_tables
-        );
-
-        $this->autocomplete_all = defined( 'BP_MESSAGES_AUTOCOMPLETE_ALL' );
-
-        parent::setup_globals( $globals );
+            'global_tables'         => $global_tables,
+            'meta_tables'           => $meta_tables
+        ) );
     }