Changeset 12451 for trunk/src/bp-core/bp-core-rest-api.php

Timestamp:

08/28/2019 08:38:00 PM (5 years ago)

Author:

imath

Message:

Prepare BuddyPress to welcome the BP REST API

• Add a grunt tasks to import the master branch of the BP REST API into the BuddyPress /build directory.
• Add some other grunt tasks to move each BP REST Controller class into their corresponding component classes directory.
• Add the needed mechanism to make sure activating the BP REST API plugin will take over the BP REST API in BuddyPress core so that it is possible to iterate/fix bugs from the BP REST API GitHub repository.
• Make sure the buddypress.pot is generated once the BP REST API has been imported.
• Update the BuddyPress class autoloader to manage the loading of the BP REST API Controllers.
• Add a new method rest_api_init() to the BP Component API to register the BP REST Controllers from their belonging component classes.

Props boonebgorges & espellcaste

See #7156

File:

• trunk/src/bp-core/bp-core-rest-api.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-rest-api.php

@@ -23 +23 @@
 
 /**
+ * Should we use the REST Endpoints of built BuddyPress?
+ *
+ * If the BP REST plugin is active, it overrides BuddyPress REST enpoints.
+ * This allows us to carry on maintaining all the BP REST API endpoints from
+ * the BP REST plugin on GitHub.
+ *
+ * @since 5.0.0
+ *
+ * @return bool Whether to use the REST Endpoints of built BuddyPress.
+ */
+function bp_rest_in_buddypress() {
+    $is_src = defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src';
+
+    return ! $is_src && ! bp_rest_is_plugin_active();
+}
+
+/**
  * Check the availability of the BP REST API.
  *
@@ -30 +47 @@
  */
 function bp_rest_api_is_available() {
+
     /**
      * Filter here to disable the BP REST API.
@@ -39 +57 @@
      * @param boolean $value True if the BP REST API is available. False otherwise.
      */
-    return apply_filters( 'bp_rest_api_is_available', function_exists( 'create_initial_rest_routes' ) && bp_rest_is_plugin_active() );
+    return apply_filters( 'bp_rest_api_is_available', function_exists( 'create_initial_rest_routes' ) && bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
 }
 
@@ -76 +94 @@
 }
 add_action( 'bp_init', 'bp_rest_api_register_request_script' );
+
+/**
+ * BuddyPress REST API namespace.
+ *
+ * @since 5.0.0
+ *
+ * @return string
+ */
+function bp_rest_namespace() {
+
+    /**
+     * Filter API namespace.
+     *
+     * @since 5.0.0
+     *
+     * @param string $namespace BuddyPress core namespace.
+     */
+    return apply_filters( 'bp_rest_namespace', 'buddypress' );
+}
+
+/**
+ * BuddyPress REST API version.
+ *
+ * @since 5.0.0
+ *
+ * @return string
+ */
+function bp_rest_version() {
+
+    /**
+     * Filter API version.
+     *
+     * @since 5.0.0
+     *
+     * @param string $version BuddyPress core version.
+     */
+    return apply_filters( 'bp_rest_version', 'v1' );
+}
+
+/**
+ * Get user URL.
+ *
+ * @since 5.0.0
+ *
+ * @param  int $user_id User ID.
+ * @return string
+ */
+function bp_rest_get_user_url( $user_id ) {
+    return sprintf(
+        '/%s/%s/members/%d',
+        bp_rest_namespace(),
+        bp_rest_version(),
+        $user_id
+    );
+}
+
+/**
+ * Set headers to let the Client Script be aware of the pagination.
+ *
+ * @since 5.0.0
+ *
+ * @param  WP_REST_Response $response The response data.
+ * @param  integer          $total    The total number of found items.
+ * @param  integer          $per_page The number of items per page of results.
+ * @return WP_REST_Response $response The response data.
+ */
+function bp_rest_response_add_total_headers( WP_REST_Response $response, $total = 0, $per_page = 0 ) {
+    if ( ! $total || ! $per_page ) {
+        return $response;
+    }
+
+    $total_items = (int) $total;
+    $max_pages   = ceil( $total_items / (int) $per_page );
+
+    $response->header( 'X-WP-Total', $total_items );
+    $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+    return $response;
+}
+
+/**
+ * Convert the input date to RFC3339 format.
+ *
+ * @since 5.0.0
+ *
+ * @param string      $date_gmt Date GMT format.
+ * @param string|null $date     Optional. Date object.
+ * @return string|null ISO8601/RFC3339 formatted datetime.
+ */
+function bp_rest_prepare_date_response( $date_gmt, $date = null ) {
+    if ( isset( $date ) ) {
+        return mysql_to_rfc3339( $date );
+    }
+
+    if ( '0000-00-00 00:00:00' === $date_gmt ) {
+        return null;
+    }
+
+    return mysql_to_rfc3339( $date_gmt );
+}
+
+/**
+ * Clean up member_type input.
+ *
+ * @since 5.0.0
+ *
+ * @param string $value Comma-separated list of group types.
+ * @return array|null
+ */
+function bp_rest_sanitize_member_types( $value ) {
+    if ( empty( $value ) ) {
+        return $value;
+    }
+
+    $types              = explode( ',', $value );
+    $registered_types   = bp_get_member_types();
+    $registered_types[] = 'any';
+    $valid_types        = array_intersect( $types, $registered_types );
+
+    return ( ! empty( $valid_types ) ) ? $valid_types : null;
+}
+
+/**
+ * Validate member_type input.
+ *
+ * @since 5.0.0
+ *
+ * @param  mixed $value Mixed value.
+ * @return WP_Error|boolean
+ */
+function bp_rest_validate_member_types( $value ) {
+    if ( empty( $value ) ) {
+        return true;
+    }
+
+    $types            = explode( ',', $value );
+    $registered_types = bp_get_member_types();
+
+    // Add the special value.
+    $registered_types[] = 'any';
+    foreach ( $types as $type ) {
+        if ( ! in_array( $type, $registered_types, true ) ) {
+            return new WP_Error(
+                'bp_rest_invalid_group_type',
+                sprintf(
+                    /* translators: %1$s and %2$s is replaced with the registered type(s) */
+                    __( 'The member type you provided, %$1s, is not one of %$2s.', 'buddypress' ),
+                    $type,
+                    implode( ', ', $registered_types )
+                )
+            );
+        }
+    }
+}
+
+/**
+ * Clean up group_type input.
+ *
+ * @since 5.0.0
+ *
+ * @param string $value Comma-separated list of group types.
+ * @return array|null
+ */
+function bp_rest_sanitize_group_types( $value ) {
+    if ( empty( $value ) ) {
+        return null;
+    }
+
+    $types       = explode( ',', $value );
+    $valid_types = array_intersect( $types, bp_groups_get_group_types() );
+
+    return empty( $valid_types ) ? null : $valid_types;
+}
+
+/**
+ * Validate group_type input.
+ *
+ * @since 5.0.0
+ *
+ * @param  mixed $value Mixed value.
+ * @return WP_Error|bool
+ */
+function bp_rest_validate_group_types( $value ) {
+    if ( empty( $value ) ) {
+        return true;
+    }
+
+    $types            = explode( ',', $value );
+    $registered_types = bp_groups_get_group_types();
+    foreach ( $types as $type ) {
+        if ( ! in_array( $type, $registered_types, true ) ) {
+            return new WP_Error(
+                'bp_rest_invalid_group_type',
+                sprintf(
+                    /* translators: %1$s and %2$s is replaced with the registered types */
+                    __( 'The group type you provided, %1$s, is not one of %2$s.', 'buddypress' ),
+                    $type,
+                    implode( ', ', $registered_types )
+                )
+            );
+        }
+    }
+}
+
+/**
+ * Clean up an array, comma- or space-separated list of strings.
+ *
+ * @since 5.0.0
+ *
+ * @param array|string $list List of strings.
+ * @return array Sanitized array of strings.
+ */
+function bp_rest_sanitize_string_list( $list ) {
+    if ( ! is_array( $list ) ) {
+        $list = preg_split( '/[\s,]+/', $list );
+    }
+
+    return array_unique( array_map( 'sanitize_text_field', $list ) );
+}
+
+/**
+ * Get the user object, if the ID is valid.
+ *
+ * @since 5.0.0
+ *
+ * @param int $user_id Supplied user ID.
+ * @return WP_User|boolean
+ */
+function bp_rest_get_user( $user_id ) {
+    if ( (int) $user_id <= 0 ) {
+        return false;
+    }
+
+    $user = get_userdata( (int) $user_id );
+    if ( empty( $user ) || ! $user->exists() ) {
+        return false;
+    }
+
+    return $user;
+}
+
+/**
+ * Registers a new field on an existing BuddyPress object.
+ *
+ * @since 5.0.0
+ *
+ * @param string $component_id The name of the *active* component (eg: `activity`, `groups`, `xprofile`).
+ *                             Required.
+ * @param string $attribute    The attribute name. Required.
+ * @param array  $args {
+ *     Optional. An array of arguments used to handle the registered field.
+ *     @see `register_rest_field()` for a full description.
+ * }
+ * @param string $object_type  The xProfile object type to get. This parameter is only required for
+ *                             the Extended Profiles component. Not used for all other components.
+ *                             Possible values are `data`, `field` or `group`.
+ * @return bool                True if the field has been registered successfully. False otherwise.
+ */
+function bp_rest_register_field( $component_id, $attribute, $args = array(), $object_type = '' ) {
+    $registered_fields = false;
+
+    if ( ! $component_id || ! bp_is_active( $component_id ) || ! $attribute ) {
+        return $registered_fields;
+    }
+
+    // Use the `bp_` prefix as we're using a WordPress global used for Post Types.
+    $field_name = 'bp_' . $component_id;
+
+    // Use the meta type as a suffix for the field name.
+    if ( 'xprofile' === $component_id ) {
+        if ( ! in_array( $object_type, array( 'data', 'field', 'group' ), true ) ) {
+            return $registered_fields;
+        }
+
+        $field_name .= '_' . $object_type;
+    }
+
+    $args = bp_parse_args(
+        $args,
+        array(
+            'get_callback'    => null,
+            'update_callback' => null,
+            'schema'          => null,
+        ),
+        'rest_register_field'
+    );
+
+    // Register the field.
+    register_rest_field( $field_name, $attribute, $args );
+
+    if ( isset( $GLOBALS['wp_rest_additional_fields'][ $field_name ] ) ) {
+        $registered_fields = $GLOBALS['wp_rest_additional_fields'][ $field_name ];
+    }
+
+    // Check it has been registered.
+    return isset( $registered_fields[ $attribute ] );
+}