feat(content-gate): support group subscriptions access rule (#4442)

Author: miguelpeixe

includes/content-gate/class-access-rules.php

@@ -276,13 +276,50 @@ public static function get_subscription_products_options() {
 
 	/**
 	 * Whether the user has an active subscription for one of the given products.
+	 * Also checks if the user is a member of a group subscription with the required products.
 	 *
 	 * @param int   $user_id User ID.
 	 * @param array $product_ids Required product IDs.
 	 * @return bool
 	 */
 	public static function has_active_subscription( $user_id, $product_ids ) {
-		return ! empty( WooCommerce_Connection::get_active_subscriptions_for_user( $user_id, $product_ids ) );
+		$has_subscription = false;
+
+		// Check user's own subscriptions.
+		if ( ! empty( WooCommerce_Connection::get_active_subscriptions_for_user( $user_id, $product_ids ) ) ) {
+			$has_subscription = true;
+		}
+
+		// Check group subscriptions the user is a member of.
+		if ( ! $has_subscription && function_exists( 'wcs_get_subscription' ) ) {
+			$group_subscriptions = Group_Subscription::get_group_subscriptions_for_user( $user_id );
+			foreach ( $group_subscriptions as $subscription ) {
+				if ( ! $subscription || ! $subscription->has_status( WooCommerce_Connection::ACTIVE_SUBSCRIPTION_STATUSES ) ) {
+					continue;
+				}
+				// If no product filter, any active group subscription grants access.
+				if ( empty( $product_ids ) ) {
+					$has_subscription = true;
+					break;
+				}
+				// Check if the subscription has any of the required products.
+				foreach ( $product_ids as $product_id ) {
+					if ( $subscription->has_product( $product_id ) ) {
+						$has_subscription = true;
+						break 2;
+					}
+				}
+			}
+		}
+
+		/**
+		 * Filters whether a user has an active subscription for the given products.
+		 *
+		 * @param bool  $has_subscription Whether the user has an active subscription.
+		 * @param int   $user_id          User ID.
+		 * @param array $product_ids      Required product IDs.
+		 */
+		return apply_filters( 'newspack_access_rules_has_active_subscription', $has_subscription, $user_id, $product_ids );
 	}
 
 	/**

includes/plugins/woocommerce-subscriptions/group-subscription/class-group-subscription.php

@@ -21,7 +21,7 @@ class Group_Subscription {
 	/**
 	 * Check if a subscription is a group subscription.
 	 *
-	 * @param WC_Subscription|int $subscription The subscription object or ID.
+	 * @param \WC_Subscription|int $subscription The subscription object or ID.
 	 *
 	 * @return bool Whether the subscription is a group subscription.
 	 */
@@ -33,7 +33,7 @@ public static function is_group_subscription( $subscription ) {
 	/**
 	 * Get the managers of a group subscription.
 	 *
-	 * @param WC_Subscription|int $subscription The subscription object or ID.
+	 * @param \WC_Subscription|int $subscription The subscription object or ID.
 	 *
 	 * @return int[] The group manager user IDs.
 	 */
@@ -55,7 +55,7 @@ public static function get_managers( $subscription ) {
 	/**
 	 * Get the members of a group subscription.
 	 *
-	 * @param WC_Subscription|int $subscription The subscription object or ID.
+	 * @param \WC_Subscription|int $subscription The subscription object or ID.
 	 *
 	 * @return int[] Array of user IDs for the group subscription members.
 	 */
@@ -88,19 +88,19 @@ function( $user ) {
 		 * Filter the members of a group subscription.
 		 *
 		 * @param int[] $members Array of user IDs for group subscription members.
-		 * @param WC_Subscription $subscription The subscription object.
+		 * @param \WC_Subscription $subscription The subscription object.
 		 */
 		return apply_filters( 'newspack_group_subscription_members', $members, $subscription );
 	}
 
 	/**
 	 * Update the member IDs for a group subscription.
 	 *
-	 * @param WC_Subscription|int $subscription The subscription object or ID.
-	 * @param int[]               $members_to_add Group member user IDs to add the subscription.
-	 * @param int[]               $members_to_remove Group member user IDs to remove from the subscription.
+	 * @param \WC_Subscription|int $subscription The subscription object or ID.
+	 * @param int[]                $members_to_add Group member user IDs to add the subscription.
+	 * @param int[]                $members_to_remove Group member user IDs to remove from the subscription.
 	 *
-	 * @return object|WP_Error Added/removed results.
+	 * @return array|\WP_Error Added/removed results.
 	 */
 	public static function update_members( $subscription, $members_to_add, $members_to_remove = [] ) {
 		if ( ! function_exists( 'wcs_get_subscription' ) ) {
@@ -168,8 +168,8 @@ public static function update_members( $subscription, $members_to_add, $members_
 	/**
 	 * Check if a user is a member or manager of a group subscription.
 	 *
-	 * @param int                 $user_id The user ID.
-	 * @param WC_Subscription|int $subscription The subscription object or ID.
+	 * @param int                  $user_id The user ID.
+	 * @param \WC_Subscription|int $subscription The subscription object or ID.
 	 *
 	 * @return bool|null Whether the user has access to the group subscription, or null if not a group subscription.
 	 */
@@ -190,7 +190,7 @@ public static function user_is_member( $user_id, $subscription ) {
 		 *
 		 * @param bool|null $is_member Whether the user is a member or manager of the group subscription, or null if not a group subscription.
 		 * @param int $user_id The user ID.
-		 * @param WC_Subscription|int $subscription The subscription object or ID.
+		 * @param \WC_Subscription|int $subscription The subscription object or ID.
 		 */
 		return apply_filters( 'newspack_group_subscription_user_is_member', $is_member, $user_id, $subscription );
 	}
@@ -202,7 +202,7 @@ public static function user_is_member( $user_id, $subscription ) {
 	 * @param int  $user_id The user ID.
 	 * @param bool $ids_only If true, return only the subscription IDs instead of the subscription objects.
 	 *
-	 * @return WC_Subscription[]|int[] The group subscriptions or subscription IDs the user is a member of.
+	 * @return \WC_Subscription[]|int[] The group subscriptions or subscription IDs the user is a member of.
 	 */
 	public static function get_group_subscriptions_for_user( $user_id, $ids_only = false ) {
 		if ( ! function_exists( 'wcs_get_subscription' ) ) {
@@ -220,7 +220,7 @@ public static function get_group_subscriptions_for_user( $user_id, $ids_only = f
 		/**
 		 * Filter the group subscriptions a user is a member of.
 		 *
-		 * @param WC_Subscription[]|int[] $subscriptions The group subscriptions or subscription IDs the user is a member of.
+		 * @param \WC_Subscription[]|int[] $subscriptions The group subscriptions or subscription IDs the user is a member of.
 		 * @param int $user_id The user ID.
 		 */
 		return apply_filters( 'newspack_group_subscriptions_for_user', $subscriptions, $user_id );

tests/mocks/wc-mocks.php

@@ -98,6 +98,7 @@ public function get_email() {
 }
 
 $orders_database = [];
+$subscriptions_database = [];
 
 class WC_Order {
 	public $data = [ 'items' => [] ];
@@ -154,6 +155,7 @@ class WC_Subscription {
 	public $data = [];
 	public $meta = [];
 	public $orders = [];
+	public $products = [];
 	public function __construct( $data ) {
 		$this->data = array_merge( $data, $this->data );
 		if ( isset( $data['meta'] ) ) {
@@ -168,12 +170,21 @@ function( $a, $b ) {
 				}
 			);
 		}
+		if ( isset( $data['products'] ) ) {
+			$this->products = $data['products'];
+		}
 	}
 	public function get_id() {
 		return $this->data['id'];
 	}
 	public function get_customer_id() {
-		return $this->data['customer_id'];
+		return $this->data['customer_id'] ?? null;
+	}
+	public function get_user_id() {
+		return $this->data['customer_id'] ?? null;
+	}
+	public function has_product( $product_id ) {
+		return in_array( $product_id, $this->products, true );
 	}
 	public function get_meta( $field_name ) {
 		return isset( $this->meta[ $field_name ] ) ? $this->meta[ $field_name ] : '';
@@ -245,13 +256,40 @@ function wcs_is_subscription( $order ) {
 	return false;
 }
 function wcs_create_subscription( $data = [] ) {
-	return new WC_Subscription( $data );
+	global $subscriptions_database;
+	// Auto-generate an ID if not provided.
+	if ( ! isset( $data['id'] ) ) {
+		$data['id'] = count( $subscriptions_database ) + 1;
+	}
+	$subscription = new WC_Subscription( $data );
+	$subscriptions_database[ $subscription->get_id() ] = $subscription;
+	return $subscription;
+}
+function wcs_get_subscription( $subscription_id ) {
+	global $subscriptions_database;
+	return $subscriptions_database[ $subscription_id ] ?? null;
 }
 function wcs_get_subscriptions_for_order( $order ) {
 	return [];
 }
-function wcs_get_users_subscriptions( $order ) {
-	return [];
+function wcs_get_users_subscriptions( $user_id ) {
+	global $subscriptions_database;
+	$user_subscriptions = [];
+	foreach ( $subscriptions_database as $id => $subscription ) {
+		if ( $subscription->get_customer_id() === $user_id ) {
+			$user_subscriptions[ $id ] = $subscription;
+		}
+	}
+	return $user_subscriptions;
+}
+function wcs_get_canonical_product_id( $item ) {
+	return null;
+}
+function wc_string_to_bool( $string ) {
+	return is_bool( $string ) ? $string : ( 'yes' === strtolower( $string ) || '1' === $string || 'true' === strtolower( $string ) );
+}
+function wc_bool_to_string( $bool ) {
+	return $bool ? 'yes' : 'no';
 }
 function wc_get_orders( $args ) {
 	global $orders_database;