Changeset 7840

Timestamp:

02/11/2014 02:58:50 AM (11 years ago)

Author:

boonebgorges

Message:

Migrate groupmeta functions to the WP metadata API

See #4551

Props boonebgorges, johnjamesjacoby

Location:

trunk

Files:

• bp-core/bp-core-filters.php (modified) (1 diff)
• bp-groups/bp-groups-functions.php (modified) (1 diff)
• bp-groups/bp-groups-loader.php (modified) (2 diffs)

trunk/bp-core/bp-core-filters.php

@@ -530 +530 @@
 }
 add_filter( 'wp_setup_nav_menu_item', 'bp_setup_nav_menu_item', 10, 1 );
+
+/**
+ * Filter SQL query strings to swap out the 'meta_id' column.
+ *
+ * WordPress uses the meta_id column for commentmeta and postmeta, and so
+ * hardcodes the column name into its *_metadata() functions. BuddyPress, on
+ * the other hand, uses 'id' for the primary column. To make WP's functions
+ * usable for BuddyPress, we use this just-in-time filter on 'query' to swap
+ * 'meta_id' with 'id.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @access private Do not use.
+ *
+ * @param string $q SQL query.
+ * @return string
+ */
+function bp_filter_metaid_column_name( $q ) {
+    return str_replace( 'meta_id', 'id', $q );
+}

trunk/bp-groups/bp-groups-functions.php

@@ -957 +957 @@
 /*** Group Meta ****************************************************/
 
-function groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false ) {
-    global $wpdb, $bp;
-
-    if ( !is_numeric( $group_id ) )
-        return false;
-
+/**
+ * Delete metadata for a group.
+ *
+ * @param int $group_id ID of the group.
+ * @param string $meta_key The key of the row to delete.
+ * @param string $meta_value Optional. Metadata value. If specified, only delete
+ *        metadata entries with this value.
+ * @param bool $delete_all Optional. If true, delete matching metadata entries
+ *        for all groups. Default: false.
+ * @return bool True on success, false on failure.
+ */
+function groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
+
+    // Legacy - return false if non-int group ID
+    if ( ! is_numeric( $group_id ) ) {
+        return false;
+    }
+
+    // Legacy - Sanitize keys
     $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
 
-    if ( is_array( $meta_value ) || is_object( $meta_value ) )
-        $meta_value = serialize($meta_value);
-
-    $meta_value = trim( $meta_value );
-
-    if ( !$meta_key )
-        $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d", $group_id ) );
-    else if ( $meta_value )
-        $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s AND meta_value = %s", $group_id, $meta_key, $meta_value ) );
-    else
-        $wpdb->query( $wpdb->prepare( "DELETE FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key ) );
-
-    // Delete the cached object
-    wp_cache_delete( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );
-
-    return true;
-}
-
-function groups_get_groupmeta( $group_id, $meta_key = '') {
-    global $wpdb, $bp;
-
-    $group_id = (int) $group_id;
-
-    if ( !$group_id )
-        return false;
-
-    if ( !empty($meta_key) ) {
-        $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-        $metas = wp_cache_get( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, 'bp' );
-        if ( false === $metas ) {
-            $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key ) );
-            wp_cache_set( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, $metas, 'bp' );
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = delete_metadata( 'group', $group_id, $meta_key, $meta_value, $delete_all );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    return $retval;
+}
+
+/**
+ * Get a piece of group metadata.
+ *
+ * @param int $group_id ID of the group.
+ * @param string $meta_key Metadata key.
+ * @param bool $single Optional. If true, return only the first value of the
+ *        specified meta_key. This parameter has no effect if meta_key is
+ *        empty.
+ * @return mixed Metadata value.
+ */
+function groups_get_groupmeta( $group_id, $meta_key = '', $single = true ) {
+
+    // Legacy - Sanitize keys
+    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = get_metadata( 'group', $group_id, $meta_key, $single );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    // Legacy - If fetching all meta for a group, just return values
+    if ( empty( $meta_key ) ) {
+        $values = array();
+        foreach ( (array) $retval as $r ) {
+            $values[] = array_pop( $r );
         }
-    } else {
-        $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d", $group_id ) );
-    }
-
-    if ( empty( $metas ) ) {
-        if ( empty( $meta_key ) )
-            return array();
-        else
-            return '';
-    }
-
-    $metas = array_map( 'maybe_unserialize', (array) $metas );
-
-    if ( 1 == count( $metas ) )
-        return $metas[0];
-    else
-        return $metas;
-}
-
+        $retval = $values;
+    }
+
+    return $retval;
+}
+
+/**
+ * Update a piece of group metadata.
+ *
+ * @param int $group_id ID of the group.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Value to store.
+ * @return bool True on success, false on failure.
+ */
 function groups_update_groupmeta( $group_id, $meta_key, $meta_value ) {
-    global $wpdb, $bp;
-
-    if ( !is_numeric( $group_id ) )
-        return false;
-
-    $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
-
-    if ( is_string( $meta_value ) ) {
-        $meta_value = stripslashes( $meta_value );
-    }
-
-    $meta_value = maybe_serialize( $meta_value );
-
-    $cur = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM " . $bp->groups->table_name_groupmeta . " WHERE group_id = %d AND meta_key = %s", $group_id, $meta_key ) );
-
-    if ( !$cur )
-        $wpdb->query( $wpdb->prepare( "INSERT INTO " . $bp->groups->table_name_groupmeta . " ( group_id, meta_key, meta_value ) VALUES ( %d, %s, %s )", $group_id, $meta_key, $meta_value ) );
-    else if ( $cur->meta_value != $meta_value )
-        $wpdb->query( $wpdb->prepare( "UPDATE " . $bp->groups->table_name_groupmeta . " SET meta_value = %s WHERE group_id = %d AND meta_key = %s", $meta_value, $group_id, $meta_key ) );
-    else
-        return false;
-
-    // Update the cached object and recache
-    wp_cache_set( 'bp_groups_groupmeta_' . $group_id . '_' . $meta_key, $meta_value, 'bp' );
-
-    return true;
+
+    add_filter( 'query', 'bp_filter_metaid_column_name' );
+    $retval = update_metadata( 'group', $group_id, $meta_key, $meta_value );
+    remove_filter( 'query', 'bp_filter_metaid_column_name' );
+
+    // Legacy - return true if we fall through to add_metadata()
+    if ( is_int( $retval ) ) {
+        $retval = true;
+    }
+
+    return $retval;
 }
 

trunk/bp-groups/bp-groups-loader.php

@@ -137 +137 @@
         );
 
+        // Metadata tables for groups component
+        $meta_tables = array(
+            'group' => $bp->table_prefix . 'bp_groups_groupmeta',
+        );
+
         // All globals for groups component.
         // Note that global_tables is included in this array.
@@ -145 +150 @@
             'notification_callback' => 'groups_format_notifications',
             'search_string'         => __( 'Search Groups...', 'buddypress' ),
-            'global_tables'         => $global_tables
+            'global_tables'         => $global_tables,
+            'meta_tables'           => $meta_tables,
         );