From edda4703318e90829de18304c19221475200c76b Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Wed, 29 Mar 2023 17:49:23 +0530 Subject: [PATCH 01/24] Add `isAccessibleForFree` property in Yoast SEO for Article schema --- includes/class-initializer.php | 1 + includes/class-yoastseo.php | 46 ++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 includes/class-yoastseo.php diff --git a/includes/class-initializer.php b/includes/class-initializer.php index ac88639..586442e 100644 --- a/includes/class-initializer.php +++ b/includes/class-initializer.php @@ -17,6 +17,7 @@ class Initializer { */ public static function init() { WooCommerce::init(); + YoastSEO::init(); } } diff --git a/includes/class-yoastseo.php b/includes/class-yoastseo.php new file mode 100644 index 0000000..20d2193 --- /dev/null +++ b/includes/class-yoastseo.php @@ -0,0 +1,46 @@ + Date: Wed, 29 Mar 2023 18:33:16 +0530 Subject: [PATCH 02/24] Fix `isAccessibleForFree` assignment --- includes/class-yoastseo.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/class-yoastseo.php b/includes/class-yoastseo.php index 20d2193..ec8c009 100644 --- a/includes/class-yoastseo.php +++ b/includes/class-yoastseo.php @@ -37,7 +37,7 @@ public static function update_wpseo_schema_article( $data ) { // if WooCommerce Membership plugin is installed and active. if ( function_exists( 'wc_memberships_is_post_content_restricted' ) ) { // Add 'isAccessibleForFree' schema for compatibility with Google Extended Access. - $data['isAccessibleForFree'] = wc_memberships_is_post_content_restricted(); + $data['isAccessibleForFree'] = ! wc_memberships_is_post_content_restricted(); } return $data; From ac6b8cce41202b1d3d82690274a407d6978846ac Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:21:17 +0530 Subject: [PATCH 03/24] =?UTF-8?q?=E2=9C=A8=20Add=20Extended=20Access=20fun?= =?UTF-8?q?ctionality?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/newspack-swg.js | 166 ++++++++++++++++ .../class-extendedaccess-rest-endpoint.php | 186 ++++++++++++++++++ includes/class-google-extendedaccess.php | 121 ++++++++++++ includes/class-initializer.php | 12 +- includes/class-yoastseo.php | 46 ----- newspack-extended-access.php | 2 +- 6 files changed, 484 insertions(+), 49 deletions(-) create mode 100644 assets/newspack-swg.js create mode 100644 includes/class-extendedaccess-rest-endpoint.php create mode 100644 includes/class-google-extendedaccess.php delete mode 100644 includes/class-yoastseo.php diff --git a/assets/newspack-swg.js b/assets/newspack-swg.js new file mode 100644 index 0000000..8a93b31 --- /dev/null +++ b/assets/newspack-swg.js @@ -0,0 +1,166 @@ +/** + * Newspack SwG Library. + * + * Initializes GAA and defines required callbacks to + * register/login to site via SwG, check post status + * and unlock article. + * + * @link https://www.newspack.com + * @file This files defines SwG required methods and callback for Newspack specific functionality. + * @author Newspack + * @since 0.21 + */ + +/** + * Parses JWT token and converts into equivalent JSON object. + * + * @param {string} token JWT Token to be parse. + * @returns {Object} Parsed JWT as JSON Object. + */ +function parseJwt(token) { + var base64Url = token.split('.')[1]; + var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/'); + var jsonPayload = decodeURIComponent(window.atob(base64).split('').map(function (c) { + return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2); + }).join('')); + + return JSON.parse(jsonPayload); +} + +/** + * Initializes GaaMetering for SwG. + */ +function InitGaaMetering() { + + /** + * Variables + */ + const allowedReferrers = AuthSettings.allowedReferrers ; // ['extended-access-dev.newspackstaging.com', 'newspackstaging.com'] + + /** + * Login Existing User Promise callback handler. + */ + handleLoginPromise = new Promise(() => { + GaaMetering.getLoginPromise().then(() => { + console.log('handleLoginPromise', 'Redirecting to login URL'); + // Capture full URL, including URL parameters, to redirect the user to after login + const redirectUri = encodeURIComponent(window.location.href); + // Redirect to a login page for existing users to login. + window.location = `${window.location.protocol}//${window.location.hostname}/my-account?redirect_to=${redirectUri}`; + }); + }); + + /** + * Register New User Promise callback handler. + */ + registerUserPromise = new Promise((resolve) => { + // Get the information for the user who has just registered. + GaaMetering.getGaaUserPromise().then((gaaUser) => { + // Send that information to your Registration endpoint to register the user and + // return the userState for the newly registered user. + + const gaaUserDecoded = parseJwt(gaaUser.credential); + + fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/google`, + { + method: 'POST', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': AuthSettings.nonce + }, + body: gaaUser.credential + }) + .then(response => response.json()) + .then(userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + resolve(userState); + }); + }); + }); + + /** + * Check whether publisher has provided access to the User or not. + */ + publisherEntitlementPromise = new Promise((resolve) => { + /* Do not grant user, show Google Intervention Dialog. */ + resolve({ granted: false }); + + /* Grant user, do not show Google Intervention Dialog. */ + // resolve({granted: true, grantReason: 'METERING'}); + + /* Do not grant user, show Google Extended Access Dialog. */ + // resolve({ id: 'MTAzMjk1OTEyMjMwNDQ4NjQxMzQz', registrationTimestamp: 1680773672, granted: false }); + }); + + /** + * Check whether publisher has provided access to the User or not. + */ + getUserState = new Promise((resolve) => { + + fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/status`, + { + method: 'GET', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': AuthSettings.nonce + }, + }) + .then(response => response.json()) + .then(userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + resolve(userState); + }); + }); + + /** + * Fires when Extended Access grants permission. + */ + unlockArticle = () => { + console.log('unlockArticle callback'); + if (window.localStorage) { + if (!localStorage.getItem('unlocked')) { + localStorage['unlocked'] = true; + window.location.reload(); + } + } + } + + /** + * Display custom paywall instead of Google Intervention Dialog. + */ + showPaywall = () => { + console.log('showPaywall callback'); + } + + /** + * Handles SwG Entitlement callback. + */ + handleSwGEntitlement = () => { + console.log('handleSwGEntitlement callback'); + } + + /** + * Initialize GAA for Extended Access. + */ + GaaMetering.init({ + googleApiClientId: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com', + userState: getUserState, + allowedReferrers: allowedReferrers, + handleLoginPromise: handleLoginPromise, + registerUserPromise: registerUserPromise, + publisherEntitlementPromise: getUserState, + unlockArticle: unlockArticle, + showPaywall: showPaywall, + handleSwGEntitlement: handleSwGEntitlement + }); +} diff --git a/includes/class-extendedaccess-rest-endpoint.php b/includes/class-extendedaccess-rest-endpoint.php new file mode 100644 index 0000000..eb1859f --- /dev/null +++ b/includes/class-extendedaccess-rest-endpoint.php @@ -0,0 +1,186 @@ + \WP_REST_Server::READABLE, + 'callback' => array( __CLASS__, 'api_login_status' ), + ) + ); + + \register_rest_route( + 'newspack-extended-access/v1', + '/login/google', + array( + 'methods' => \WP_REST_Server::CREATABLE, + 'callback' => array( __CLASS__, 'api_google_login_register' ), + ) + ); + } + + /** + * Handles Google Extended Access registration route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_google_login_register( $request ) { + // Decode JWT. + $token = json_decode( base64_decode( str_replace( '_', '/', str_replace( '-', '+', explode( '.', $request->get_body() )[1] ) ) ) ); + + // Get Google Email. + $email = $token->email; + + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + self::assign_user_plan( $email ); + } else { + \add_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + $result = Newspack\Reader_Activation::register_reader( $email, '', true, array() ); + self::assign_user_plan( $email ); + \remove_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + // At this point the user will be logged in. + } + if ( is_wp_error( $result ) ) { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + } + + return \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'registrationTimestamp' => time(), + 'subscriptionTimestamp' => time(), + 'granted' => true, + 'grantReason' => 'SUBSCRIBER', + ) + ); + } + + /** + * Assign an existing user 'premium-membership' when registered. + * + * @param string $email EmailId of the new registered user. + */ + public static function assign_user_plan( $email ) { + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + // Log the user in. + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + + $user_id = $existing_user->ID; + $membership_plan = wc_memberships_get_membership_plan( 'premium-membership' ); + $is_active_member = wc_memberships_is_user_member( $user_id, $membership_plan->id, false ); + $existing_membership = wc_memberships_get_user_membership( $user_id, $membership_plan->id ); + $plans = wc_memberships_get_membership_plans(); + + if ( ! $is_active_member && empty( $existing_membership ) && 0 !== $user_id ) { + $args = array( + // Enter the ID (post ID) of the plan to grant at registration. + 'plan_id' => $membership_plan->id, + 'user_id' => $user_id, + ); + $new_membership = wc_memberships_create_user_membership( $args ); + } + } + } + + /** + * Handles Google Extended Access login status route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_login_status( $request ) { + $logged_in_user = \wp_get_current_user(); + + if ( $logged_in_user ) { + $email = $logged_in_user->user_email; + + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + // Log the user in. + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + + if ( is_wp_error( $result ) ) { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + } + } else { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + } + + return \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'registrationTimestamp' => time(), + 'subscriptionTimestamp' => time(), + 'granted' => true, + 'grantReason' => 'SUBSCRIBER', + ) + ); + } else { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => 'no-logged-in-user', + ) + ); + } + } + + + /** + * Enables registering through SWG even if it is disabled. + * + * @param boolean $is_enabled Existing value of newspack_reader_activation_enabled option. + * @return boolean Returns always true for SWG. + */ + public static function bypass_newspack_reader_activation_enabled( $is_enabled ) { + return true; + } +} diff --git a/includes/class-google-extendedaccess.php b/includes/class-google-extendedaccess.php new file mode 100644 index 0000000..9862083 --- /dev/null +++ b/includes/class-google-extendedaccess.php @@ -0,0 +1,121 @@ + 'https://schema.org', + '@type' => 'Article', + 'isAccessibleForFree' => ! wc_memberships_is_post_content_restricted(), + 'isPartOf' => array( + '@type' => array( 'CreativeWork', 'Product' ), + 'name' => get_bloginfo( 'name' ), + 'productID' => ( isset( $_SERVER['SERVER_NAME'] ) ? filter_var( $_SERVER['SERVER_NAME'], FILTER_SANITIZE_URL ) : '' ) . ':showcase', + ), + 'publisher' => array( + '@type' => 'Organization', + 'name' => get_bloginfo( 'name' ), + ), + ); + + $ld_json = wp_json_encode( $ld_json, $flags ); + $ld_json = \str_replace( "\n", \PHP_EOL . "\t", $ld_json ); + ?> + + wp_create_nonce( 'wp_rest' ), + 'allowedReferrers' => $allowed_referrers, + ) + ); + + // Google Extended Access Scripts. + wp_print_script_tag( + array( + 'id' => 'google-account-gsi-client', + 'async' => true, + 'src' => esc_url( 'https://accounts.google.com/gsi/client' ), + 'defer' => true, + ) + ); + + wp_print_script_tag( + array( + 'id' => 'google-news-swg', + 'async' => true, + 'subscriptions-control' => 'manual', + 'src' => esc_url( 'https://news.google.com/swg/js/v1/swg.js' ), + ) + ); + + wp_print_script_tag( + array( + 'id' => 'google-news-swg-gaa', + 'async' => true, + 'src' => esc_url( 'https://news.google.com/swg/js/v1/swg-gaa.js' ), + 'onload' => 'InitGaaMetering()', + ) + ); + } + } + +} diff --git a/includes/class-initializer.php b/includes/class-initializer.php index 586442e..e00e81c 100644 --- a/includes/class-initializer.php +++ b/includes/class-initializer.php @@ -7,6 +7,8 @@ namespace Newspack_Extended_Access; +use Newspack; + /** * Class to handle the plugin initialization */ @@ -16,8 +18,14 @@ class Initializer { * Runs the initialization. */ public static function init() { - WooCommerce::init(); - YoastSEO::init(); + // TODO (@AnuragVasanwala): Please remove try...catch. It is only enabled for testing purpose. + try { + WooCommerce::init(); + ExtendedAccess_REST_Endpoint::init(); + Google_ExtendedAccess::init(); + } catch ( \Error $er ) { + echo esc_html( $er ); + } } } diff --git a/includes/class-yoastseo.php b/includes/class-yoastseo.php deleted file mode 100644 index ec8c009..0000000 --- a/includes/class-yoastseo.php +++ /dev/null @@ -1,46 +0,0 @@ - Date: Sun, 16 Apr 2023 19:30:58 +0530 Subject: [PATCH 04/24] =?UTF-8?q?=F0=9F=8F=97=20ServerSide=20script=20to?= =?UTF-8?q?=20bypass=20paywall=20restriction?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- includes/class-single-post-subscription.php | 50 +++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 includes/class-single-post-subscription.php diff --git a/includes/class-single-post-subscription.php b/includes/class-single-post-subscription.php new file mode 100644 index 0000000..ef2e320 --- /dev/null +++ b/includes/class-single-post-subscription.php @@ -0,0 +1,50 @@ +get_restrictions_instance()->get_posts_restrictions_instance(); + remove_action( 'wp', [ $membership_instance, 'handle_restriction_modes' ] ) ; + remove_filter( 'the_posts', [ $membership_instance, 'exclude_restricted_content_comments' ], 999, 2 ); + remove_filter( 'pre_get_comments', [ $membership_instance, 'exclude_restricted_comments' ], 999 ); + remove_filter( 'get_previous_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); + remove_filter( 'get_next_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); + remove_filter( 'posts_clauses', [ $membership_instance, 'handle_posts_clauses' ], 999, 2 ); + remove_filter( 'get_terms_args', [ $membership_instance, 'handle_get_terms_args' ], 999, 2 ); + remove_filter( 'terms_clauses', [ $membership_instance, 'handle_terms_clauses' ], 999 ); + } + } +} From 485747bf15e19c6cb917c5079cdb9908c4163ddd Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Sun, 16 Apr 2023 19:35:36 +0530 Subject: [PATCH 05/24] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Add=20`Single=5FPost?= =?UTF-8?q?=5FSubscription`=20to=20plugin=20`init`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- includes/class-initializer.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-initializer.php b/includes/class-initializer.php index e00e81c..8484b6a 100644 --- a/includes/class-initializer.php +++ b/includes/class-initializer.php @@ -23,6 +23,7 @@ public static function init() { WooCommerce::init(); ExtendedAccess_REST_Endpoint::init(); Google_ExtendedAccess::init(); + Single_Post_Subscription::init(); } catch ( \Error $er ) { echo esc_html( $er ); } From e48a4f717092b6d619595348c14b2625a7102063 Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Sun, 16 Apr 2023 21:23:45 +0530 Subject: [PATCH 06/24] =?UTF-8?q?=E2=9C=A8=20Add=20`Extended=20Access`=20s?= =?UTF-8?q?ubmenu=20option=20page=20inside=20`WooCommerce`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update php and js scripts to use fields defined by option page. --- assets/newspack-swg.js | 2 +- .../class-extendedaccess-rest-endpoint.php | 5 +- includes/class-google-extendedaccess.php | 5 +- includes/class-initializer.php | 2 + includes/class-option-page.php | 164 ++++++++++++++++++ includes/class-single-post-subscription.php | 17 +- 6 files changed, 183 insertions(+), 12 deletions(-) create mode 100644 includes/class-option-page.php diff --git a/assets/newspack-swg.js b/assets/newspack-swg.js index 8a93b31..67d8276 100644 --- a/assets/newspack-swg.js +++ b/assets/newspack-swg.js @@ -153,7 +153,7 @@ function InitGaaMetering() { * Initialize GAA for Extended Access. */ GaaMetering.init({ - googleApiClientId: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com', + googleApiClientId: AuthSettings.googleClientId, // For Newspack Staging Site: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com' userState: getUserState, allowedReferrers: allowedReferrers, handleLoginPromise: handleLoginPromise, diff --git a/includes/class-extendedaccess-rest-endpoint.php b/includes/class-extendedaccess-rest-endpoint.php index eb1859f..30ea58d 100644 --- a/includes/class-extendedaccess-rest-endpoint.php +++ b/includes/class-extendedaccess-rest-endpoint.php @@ -96,6 +96,7 @@ public static function api_google_login_register( $request ) { * @param string $email EmailId of the new registered user. */ public static function assign_user_plan( $email ) { + $newspack_extended_access_options = get_option( 'newspack_extended_access_configuration' ); $existing_user = \get_user_by( 'email', $email ); if ( $existing_user ) { @@ -103,7 +104,7 @@ public static function assign_user_plan( $email ) { $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); $user_id = $existing_user->ID; - $membership_plan = wc_memberships_get_membership_plan( 'premium-membership' ); + $membership_plan = wc_memberships_get_membership_plan( $newspack_extended_access_options['default_subscription'] ); $is_active_member = wc_memberships_is_user_member( $user_id, $membership_plan->id, false ); $existing_membership = wc_memberships_get_user_membership( $user_id, $membership_plan->id ); $plans = wc_memberships_get_membership_plans(); @@ -149,7 +150,7 @@ public static function api_login_status( $request ) { return \rest_ensure_response( array( 'granted' => false, - 'reason' => $result, + 'reason' => 'not-existing-user', ) ); } diff --git a/includes/class-google-extendedaccess.php b/includes/class-google-extendedaccess.php index 9862083..ec1db43 100644 --- a/includes/class-google-extendedaccess.php +++ b/includes/class-google-extendedaccess.php @@ -70,6 +70,8 @@ public static function add_extended_access_ld_json() { public static function enqueue_script() { // Add scripts only for `post` type. if ( get_post_type() === 'post' ) { // Add slug in condition. + $newspack_extended_access_options = get_option( 'newspack_extended_access_configuration' ); + // Newspack Extended Access Script. wp_register_script( 'newspack-swg', '/wp-content/plugins/newspack-extended-access/assets/newspack-swg.js', array(), '0.21', false ); wp_enqueue_script( 'newspack-swg' ); @@ -83,8 +85,9 @@ public static function enqueue_script() { 'newspack-swg', 'AuthSettings', array( - 'nonce' => wp_create_nonce( 'wp_rest' ), 'allowedReferrers' => $allowed_referrers, + 'googleClientId' => $newspack_extended_access_options['google_client_id'], + 'nonce' => wp_create_nonce( 'wp_rest' ), ) ); diff --git a/includes/class-initializer.php b/includes/class-initializer.php index e00e81c..18156ab 100644 --- a/includes/class-initializer.php +++ b/includes/class-initializer.php @@ -23,6 +23,8 @@ public static function init() { WooCommerce::init(); ExtendedAccess_REST_Endpoint::init(); Google_ExtendedAccess::init(); + Single_Post_Subscription::init(); + Option_Page::init(); } catch ( \Error $er ) { echo esc_html( $er ); } diff --git a/includes/class-option-page.php b/includes/class-option-page.php new file mode 100644 index 0000000..f310a79 --- /dev/null +++ b/includes/class-option-page.php @@ -0,0 +1,164 @@ + + +
+

Newspack Extended Access

+

Sample description.

+ + +
+ +
+
+ ', + isset( self::$newspack_extended_access_options['google_client_id'] ) ? esc_attr( self::$newspack_extended_access_options['google_client_id'] ) : '' + ); + } + + /** + * Renders membership plan selection box. + */ + public static function default_subscription_callback() { + if ( function_exists( 'wc_memberships_get_membership_plans' ) ) { + $plans = wc_memberships_get_membership_plans(); + ?> + + + + get_restrictions_instance()->get_posts_restrictions_instance(); - remove_action( 'wp', [ $membership_instance, 'handle_restriction_modes' ] ) ; - remove_filter( 'the_posts', [ $membership_instance, 'exclude_restricted_content_comments' ], 999, 2 ); + remove_action( 'wp', [ $membership_instance, 'handle_restriction_modes' ] ); + remove_filter( 'the_posts', [ $membership_instance, 'exclude_restricted_content_comments' ], 999, 2 ); remove_filter( 'pre_get_comments', [ $membership_instance, 'exclude_restricted_comments' ], 999 ); remove_filter( 'get_previous_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); - remove_filter( 'get_next_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); - remove_filter( 'posts_clauses', [ $membership_instance, 'handle_posts_clauses' ], 999, 2 ); + remove_filter( 'get_next_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); + remove_filter( 'posts_clauses', [ $membership_instance, 'handle_posts_clauses' ], 999, 2 ); remove_filter( 'get_terms_args', [ $membership_instance, 'handle_get_terms_args' ], 999, 2 ); - remove_filter( 'terms_clauses', [ $membership_instance, 'handle_terms_clauses' ], 999 ); + remove_filter( 'terms_clauses', [ $membership_instance, 'handle_terms_clauses' ], 999 ); } } } From 7fa81a7fbd539597c88b3beb4150112ba1df0be2 Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Tue, 25 Apr 2023 16:29:03 +0530 Subject: [PATCH 07/24] =?UTF-8?q?=E2=9C=A8=20Add=20single-post=20subscript?= =?UTF-8?q?ion=20feature=20based=20on=20cookie?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/js/newspack-swg.js | 199 +++++++++++++ assets/newspack-swg.js | 166 ----------- includes/class-dependencychecker.php | 84 ++++++ .../class-extendedaccess-rest-endpoint.php | 186 ------------ includes/class-google-extendedaccess.php | 20 +- includes/class-initializer.php | 63 +++- includes/class-rest-endpoint.php | 277 ++++++++++++++++++ includes/class-single-post-subscription.php | 48 +-- includes/class-woocommerce.php | 4 +- ...ass-wc-settings-memberships-option-tab.php | 95 ++++++ newspack-extended-access.php | 6 +- 11 files changed, 758 insertions(+), 390 deletions(-) create mode 100644 assets/js/newspack-swg.js delete mode 100644 assets/newspack-swg.js create mode 100644 includes/class-dependencychecker.php delete mode 100644 includes/class-extendedaccess-rest-endpoint.php create mode 100644 includes/class-rest-endpoint.php create mode 100644 includes/woocommerce/memberships/settings/class-wc-settings-memberships-option-tab.php diff --git a/assets/js/newspack-swg.js b/assets/js/newspack-swg.js new file mode 100644 index 0000000..893acf2 --- /dev/null +++ b/assets/js/newspack-swg.js @@ -0,0 +1,199 @@ +/** + * Newspack SwG Library. + * + * Initializes GAA and defines required callbacks to + * register / login to site via SwG, check post status + * and unlock article. + * + * @link https://www.newspack.com + * @file This files defines SwG required methods and callback for Newspack specific functionality. + * @author Newspack + * @since 1.0 + * / + +/** + * Holds logged-in user email for few REST Endpoints. + */ +let loggedInUserEmail = ""; + +/** + * Parses JWT token and converts into equivalent JSON object. + * + * @param {string} token JWT Token to be parse. + * @returns {Object} Parsed JWT as JSON Object. + */ +function parseJwt(token) { + var base64Url = token.split('.')[1]; + var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/'); + var jsonPayload = decodeURIComponent( + window.atob(base64).split('').map( + function (c) { + return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2); + } + ).join('') + ); + + return JSON.parse(jsonPayload); +} + +/** + * Initializes GaaMetering for SwG. + */ +function initGaaMetering() { + + /** + * Referrers to be allowed. + */ + const allowedReferrers = authenticationSettings.allowedReferrers; + + /** + * Login Existing User Promise callback handler. + */ + handleLoginPromise = new Promise( + () => { + GaaMetering.getLoginPromise().then( + () => { + // Capture full URL, including URL parameters, to redirect the user to after login + const redirectUri = encodeURIComponent(window.location.href); + // Redirect to a login page for existing users to login. + window.location = `${window.location.protocol}//${window.location.hostname}/my-account?redirect_to=${redirectUri}`; + } + ); + } + ); + + /** + * Register New User Promise callback handler. + */ + registerUserPromise = new Promise( + (resolve) => { + // Get the information for the user who has just registered. + GaaMetering.getGaaUserPromise().then( + (gaaUser) => { + // Send that information to your Registration endpoint to register the user and + // return the userState for the newly registered user. + + const gaaUserDecoded = parseJwt(gaaUser.credential); + loggedInUserEmail = gaaUserDecoded.email; + fetch( + `${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/google`, + { + cache: 'no-store', + method: 'POST', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': authenticationSettings.nonce, + 'X-WP-Post-ID': authenticationSettings.postID + }, + body: gaaUser.credential + } + ) + .then(response => response.json()) + .then( + userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + resolve(userState); + } + ); + } + ); + } + ); + + /** + * Check whether publisher has provided access to the User or not. + */ + publisherEntitlementPromise = new Promise( + (resolve) => { + resolve({ granted: false }); + } + ); + + /** + * Check whether publisher has provided access to the User or not. + */ + getUserState = new Promise( + (resolve) => { + fetch( + `${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/status`, + { + cache: 'no-store', + method: 'GET', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': authenticationSettings.nonce, + 'X-WP-Post-ID': authenticationSettings.postID + }, + } + ) + .then(response => response.json()) + .then( + userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + loggedInUserEmail = userState.email; + resolve(userState); + } + ); + } + ); + + /** + * Fires when Extended Access grants permission. + */ + unlockArticle = () => { + if (window.localStorage) { + if (!localStorage.getItem('unlocked')) { + localStorage['unlocked'] = true; + window.location.reload(); + } + } + } + + /** + * Display custom paywall instead of Google Intervention Dialog. + */ + showPaywall = () => { + fetch( + `${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/subscription/register?`, + { + cache: 'no-store', + method: 'GET', + headers: { + 'X-WP-Post-ID': authenticationSettings.postID, + 'X-WP-User-Email': loggedInUserEmail + } + } + ) + .then(response => { + if (response.status == 200) { + window.location.reload(); + } + }); + } + + /** + * Initialize GAA for Extended Access. + */ + GaaMetering.init( + { + googleApiClientId: authenticationSettings.googleClientApiID, + userState: getUserState, + allowedReferrers: allowedReferrers, + handleLoginPromise: handleLoginPromise, + registerUserPromise: registerUserPromise, + publisherEntitlementPromise: getUserState, + unlockArticle: unlockArticle, + showPaywall: showPaywall, + } + ); +} diff --git a/assets/newspack-swg.js b/assets/newspack-swg.js deleted file mode 100644 index 8a93b31..0000000 --- a/assets/newspack-swg.js +++ /dev/null @@ -1,166 +0,0 @@ -/** - * Newspack SwG Library. - * - * Initializes GAA and defines required callbacks to - * register/login to site via SwG, check post status - * and unlock article. - * - * @link https://www.newspack.com - * @file This files defines SwG required methods and callback for Newspack specific functionality. - * @author Newspack - * @since 0.21 - */ - -/** - * Parses JWT token and converts into equivalent JSON object. - * - * @param {string} token JWT Token to be parse. - * @returns {Object} Parsed JWT as JSON Object. - */ -function parseJwt(token) { - var base64Url = token.split('.')[1]; - var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/'); - var jsonPayload = decodeURIComponent(window.atob(base64).split('').map(function (c) { - return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2); - }).join('')); - - return JSON.parse(jsonPayload); -} - -/** - * Initializes GaaMetering for SwG. - */ -function InitGaaMetering() { - - /** - * Variables - */ - const allowedReferrers = AuthSettings.allowedReferrers ; // ['extended-access-dev.newspackstaging.com', 'newspackstaging.com'] - - /** - * Login Existing User Promise callback handler. - */ - handleLoginPromise = new Promise(() => { - GaaMetering.getLoginPromise().then(() => { - console.log('handleLoginPromise', 'Redirecting to login URL'); - // Capture full URL, including URL parameters, to redirect the user to after login - const redirectUri = encodeURIComponent(window.location.href); - // Redirect to a login page for existing users to login. - window.location = `${window.location.protocol}//${window.location.hostname}/my-account?redirect_to=${redirectUri}`; - }); - }); - - /** - * Register New User Promise callback handler. - */ - registerUserPromise = new Promise((resolve) => { - // Get the information for the user who has just registered. - GaaMetering.getGaaUserPromise().then((gaaUser) => { - // Send that information to your Registration endpoint to register the user and - // return the userState for the newly registered user. - - const gaaUserDecoded = parseJwt(gaaUser.credential); - - fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/google`, - { - method: 'POST', - headers: { - 'Content-type': 'text/plain', - 'X-WP-Nonce': AuthSettings.nonce - }, - body: gaaUser.credential - }) - .then(response => response.json()) - .then(userState => { - // Refresh page only when it is not already unlocked - if (window.localStorage) { - if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { - localStorage.removeItem('unlocked'); - } - } - resolve(userState); - }); - }); - }); - - /** - * Check whether publisher has provided access to the User or not. - */ - publisherEntitlementPromise = new Promise((resolve) => { - /* Do not grant user, show Google Intervention Dialog. */ - resolve({ granted: false }); - - /* Grant user, do not show Google Intervention Dialog. */ - // resolve({granted: true, grantReason: 'METERING'}); - - /* Do not grant user, show Google Extended Access Dialog. */ - // resolve({ id: 'MTAzMjk1OTEyMjMwNDQ4NjQxMzQz', registrationTimestamp: 1680773672, granted: false }); - }); - - /** - * Check whether publisher has provided access to the User or not. - */ - getUserState = new Promise((resolve) => { - - fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/status`, - { - method: 'GET', - headers: { - 'Content-type': 'text/plain', - 'X-WP-Nonce': AuthSettings.nonce - }, - }) - .then(response => response.json()) - .then(userState => { - // Refresh page only when it is not already unlocked - if (window.localStorage) { - if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { - localStorage.removeItem('unlocked'); - } - } - resolve(userState); - }); - }); - - /** - * Fires when Extended Access grants permission. - */ - unlockArticle = () => { - console.log('unlockArticle callback'); - if (window.localStorage) { - if (!localStorage.getItem('unlocked')) { - localStorage['unlocked'] = true; - window.location.reload(); - } - } - } - - /** - * Display custom paywall instead of Google Intervention Dialog. - */ - showPaywall = () => { - console.log('showPaywall callback'); - } - - /** - * Handles SwG Entitlement callback. - */ - handleSwGEntitlement = () => { - console.log('handleSwGEntitlement callback'); - } - - /** - * Initialize GAA for Extended Access. - */ - GaaMetering.init({ - googleApiClientId: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com', - userState: getUserState, - allowedReferrers: allowedReferrers, - handleLoginPromise: handleLoginPromise, - registerUserPromise: registerUserPromise, - publisherEntitlementPromise: getUserState, - unlockArticle: unlockArticle, - showPaywall: showPaywall, - handleSwGEntitlement: handleSwGEntitlement - }); -} diff --git a/includes/class-dependencychecker.php b/includes/class-dependencychecker.php new file mode 100644 index 0000000..709d7d7 --- /dev/null +++ b/includes/class-dependencychecker.php @@ -0,0 +1,84 @@ + \WP_REST_Server::READABLE, - 'callback' => array( __CLASS__, 'api_login_status' ), - ) - ); - - \register_rest_route( - 'newspack-extended-access/v1', - '/login/google', - array( - 'methods' => \WP_REST_Server::CREATABLE, - 'callback' => array( __CLASS__, 'api_google_login_register' ), - ) - ); - } - - /** - * Handles Google Extended Access registration route. - * - * @param \WP_REST_Request $request Request object. - * @return mixed Returns Extended Access userState object. - */ - public static function api_google_login_register( $request ) { - // Decode JWT. - $token = json_decode( base64_decode( str_replace( '_', '/', str_replace( '-', '+', explode( '.', $request->get_body() )[1] ) ) ) ); - - // Get Google Email. - $email = $token->email; - - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - self::assign_user_plan( $email ); - } else { - \add_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); - $result = Newspack\Reader_Activation::register_reader( $email, '', true, array() ); - self::assign_user_plan( $email ); - \remove_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); - // At this point the user will be logged in. - } - if ( is_wp_error( $result ) ) { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => $result, - ) - ); - } - - return \rest_ensure_response( - array( - 'id' => base64_encode( $token->sub ), - 'registrationTimestamp' => time(), - 'subscriptionTimestamp' => time(), - 'granted' => true, - 'grantReason' => 'SUBSCRIBER', - ) - ); - } - - /** - * Assign an existing user 'premium-membership' when registered. - * - * @param string $email EmailId of the new registered user. - */ - public static function assign_user_plan( $email ) { - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - // Log the user in. - $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); - - $user_id = $existing_user->ID; - $membership_plan = wc_memberships_get_membership_plan( 'premium-membership' ); - $is_active_member = wc_memberships_is_user_member( $user_id, $membership_plan->id, false ); - $existing_membership = wc_memberships_get_user_membership( $user_id, $membership_plan->id ); - $plans = wc_memberships_get_membership_plans(); - - if ( ! $is_active_member && empty( $existing_membership ) && 0 !== $user_id ) { - $args = array( - // Enter the ID (post ID) of the plan to grant at registration. - 'plan_id' => $membership_plan->id, - 'user_id' => $user_id, - ); - $new_membership = wc_memberships_create_user_membership( $args ); - } - } - } - - /** - * Handles Google Extended Access login status route. - * - * @param \WP_REST_Request $request Request object. - * @return mixed Returns Extended Access userState object. - */ - public static function api_login_status( $request ) { - $logged_in_user = \wp_get_current_user(); - - if ( $logged_in_user ) { - $email = $logged_in_user->user_email; - - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - // Log the user in. - $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); - - if ( is_wp_error( $result ) ) { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => $result, - ) - ); - } - } else { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => $result, - ) - ); - } - - return \rest_ensure_response( - array( - 'id' => base64_encode( $token->sub ), - 'registrationTimestamp' => time(), - 'subscriptionTimestamp' => time(), - 'granted' => true, - 'grantReason' => 'SUBSCRIBER', - ) - ); - } else { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => 'no-logged-in-user', - ) - ); - } - } - - - /** - * Enables registering through SWG even if it is disabled. - * - * @param boolean $is_enabled Existing value of newspack_reader_activation_enabled option. - * @return boolean Returns always true for SWG. - */ - public static function bypass_newspack_reader_activation_enabled( $is_enabled ) { - return true; - } -} diff --git a/includes/class-google-extendedaccess.php b/includes/class-google-extendedaccess.php index 9862083..b71c630 100644 --- a/includes/class-google-extendedaccess.php +++ b/includes/class-google-extendedaccess.php @@ -3,10 +3,10 @@ * Registers required scripts for SwG implementation * specific to Newspack functionality. * - * @package newspack-extended-access + * @package Newspack\Extended_Access */ -namespace Newspack_Extended_Access; +namespace Newspack\Extended_Access; use Newspack; @@ -30,8 +30,7 @@ public static function init() { * Embeds required LD+JSON schema for Google Extended Access. */ public static function add_extended_access_ld_json() { - // 'wc_memberships_is_post_content_restricted()' function will only available - // if WooCommerce Membership plugin is installed and active. + // 'wc_memberships_is_post_content_restricted()' function will only available if WooCommerce Membership plugin is installed and active. if ( function_exists( 'wc_memberships_is_post_content_restricted' ) ) { // Add 'isAccessibleForFree' schema for compatibility with Google Extended Access. $flags = ( JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ); @@ -71,7 +70,7 @@ public static function enqueue_script() { // Add scripts only for `post` type. if ( get_post_type() === 'post' ) { // Add slug in condition. // Newspack Extended Access Script. - wp_register_script( 'newspack-swg', '/wp-content/plugins/newspack-extended-access/assets/newspack-swg.js', array(), '0.21', false ); + wp_register_script( 'newspack-swg', '/wp-content/plugins/newspack-extended-access/assets/js/newspack-swg.js', array(), '1.0', false ); wp_enqueue_script( 'newspack-swg' ); $sanitized_server_name = isset( $_SERVER['SERVER_NAME'] ) ? filter_var( $_SERVER['SERVER_NAME'], FILTER_SANITIZE_URL ) : ''; @@ -81,10 +80,13 @@ public static function enqueue_script() { // Nonce for REST API. wp_localize_script( 'newspack-swg', - 'AuthSettings', + 'authenticationSettings', array( - 'nonce' => wp_create_nonce( 'wp_rest' ), - 'allowedReferrers' => $allowed_referrers, + 'nonce' => wp_create_nonce( 'wp_rest' ), + 'allowedReferrers' => $allowed_referrers, + // TODO (@AnuragVasanwala): Parameter 'postID' should be remove before deploying to production. + 'postID' => \get_the_ID(), + 'googleClientApiID' => get_option( 'newspack_extended_access__google_client_api_id', '' ), ) ); @@ -112,7 +114,7 @@ public static function enqueue_script() { 'id' => 'google-news-swg-gaa', 'async' => true, 'src' => esc_url( 'https://news.google.com/swg/js/v1/swg-gaa.js' ), - 'onload' => 'InitGaaMetering()', + 'onload' => 'initGaaMetering()', ) ); } diff --git a/includes/class-initializer.php b/includes/class-initializer.php index 8484b6a..423e25b 100644 --- a/includes/class-initializer.php +++ b/includes/class-initializer.php @@ -2,31 +2,80 @@ /** * Newspack Extended Access plugin initialization. * - * @package newspack-extended-access + * @package Newspack\Extended_Access */ -namespace Newspack_Extended_Access; - -use Newspack; +namespace Newspack\Extended_Access; /** * Class to handle the plugin initialization */ class Initializer { + /** + * Stores notice description, if any. + * + * @var string + */ + public static $plugin_notice = ''; + /** * Runs the initialization. */ public static function init() { // TODO (@AnuragVasanwala): Please remove try...catch. It is only enabled for testing purpose. try { + /** Initialize non-dependency classes. */ WooCommerce::init(); - ExtendedAccess_REST_Endpoint::init(); - Google_ExtendedAccess::init(); - Single_Post_Subscription::init(); + WC_Settings_Memberships_Option_Tab::init(); + + /** Initialize classes only when all dependencies are met. */ + if ( self::has_valid_dependencies() ) { + REST_Endpoint::init(); + Google_ExtendedAccess::init(); + Single_Post_Subscription::init(); + } else { + self::show_admin_notice__error(); + } } catch ( \Error $er ) { echo esc_html( $er ); } } + + /** + * Check and displays plugin specific notices when required. + * + * @return bool Return false on error. + */ + public static function has_valid_dependencies() { + if ( ! DependencyChecker::is_wc_memberships_installed() || ! DependencyChecker::is_wc_memberships_active() || ! DependencyChecker::is_valid_google_client_api_id() ) { + return false; + } + return true; + } + + /** + * Displays admin notice summarizing error. + */ + public static function show_admin_notice__error() { + $plugin_notice = ''; + if ( ! DependencyChecker::is_wc_memberships_installed() ) { + $plugin_notice = 'Newspack Extended Access plugin requires WooCommerce Memberships to be installed, active and configured.'; + } elseif ( ! DependencyChecker::is_wc_memberships_active() ) { + $plugin_notice = 'Newspack Extended Access plugin requires WooCommerce Memberships to be active. Open Plugins Page.'; + } elseif ( ! DependencyChecker::is_valid_google_client_api_id() ) { + $plugin_notice = 'Newspack Extended Access plugin requires Google Client API ID to be configured. Please check your Google Client API ID into Newspack Extended Access Settings.'; + } + ?> +
+

+ +

+
+ \WP_REST_Server::READABLE, + 'callback' => array( __CLASS__, 'api_login_status' ), + ) + ); + + \register_rest_route( + 'newspack-extended-access/v1', + '/login/google', + array( + 'methods' => \WP_REST_Server::CREATABLE, + 'callback' => array( __CLASS__, 'api_google_login_register' ), + ) + ); + + \register_rest_route( + 'newspack-extended-access/v1', + '/subscription/register', + array( + 'methods' => \WP_REST_Server::READABLE, + 'callback' => array( __CLASS__, 'api_register_subscription' ), + ) + ); + } + + /** + * Handles Google Extended Access registration route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_register_subscription( $request ) { + try { + // TODO (@AnuragVasanwala): Remove getting post-id and user-id from headers. + $post_id = $request->get_header( 'X-WP-Post-ID' ); + $existing_user = \get_user_by( 'email', $request->get_header( 'X-WP-User-Email' ) ); + + if ( $existing_user ) { + $user_id = $existing_user->ID; + + if ( isset( $post_id ) ) { + // Cookie name, Made from post-id and user-id. + $cookie_name = 'newspack_' . md5( $post_id . $user_id ); + // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized + $domain = ( isset( $_SERVER['HTTP_HOST'] ) && 'localhost' != $_SERVER['HTTP_HOST'] ) ? $_SERVER['HTTP_HOST'] : false; + setcookie( $cookie_name, 'true', time() + 31556926, '/', $domain, is_ssl(), false ); + return rest_ensure_response( array( 'data' => 'ok' ) ); + } + } + return rest_ensure_response( array( 'data' => 'NO_USER_OR_POST' ) ); + } catch ( \Error $er ) { + return rest_ensure_response( array( 'data' => $er ) ); + } + } + + /** + * Handles Google Extended Access registration route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_google_login_register( $request ) { + + // Decode JWT. + $token = json_decode( base64_decode( str_replace( '_', '/', str_replace( '-', '+', explode( '.', $request->get_body() )[1] ) ) ) ); + + // Get Google Email. + $email = $token->email; + + $existing_user = \get_user_by( 'email', $email ); + + $granted = false; + + $post_id = $request->get_header( 'X-WP-Post-ID' ); + $user_id = false; + + if ( $existing_user ) { + $user_id = $existing_user->ID; + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + if ( is_wp_error( $result ) ) { + if ( in_array( [ 'administrator', 'editor' ], (array) $existing_user->roles ) ) { + // Do not grand user with role either 'Admin' or 'Editor' to login via SwG. + $user_id = -1; + } + } else { + update_user_meta( $existing_user->ID, 'extended_access_sub', $token->sub ); + } + } else { + \add_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + $result = Newspack\Reader_Activation::register_reader( $email, '', true, array() ); + + if ( is_numeric( $result ) ) { + $user_id = $result; + } else { + $user_id = $result->ID; + } + $current_reader = Newspack\Reader_Activation::set_current_reader( $user_id ); + + add_user_meta( $result, 'extended_access_sub', $token->sub ); + + remove_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + + // At this point the user will be logged in. + } + + // Example cookie name, Made from post id and user id. + $cookie_name = 'newspack_' . md5( $post_id . $user_id ); + + if ( isset( $_COOKIE[ $cookie_name ] ) ) { + $granted = true; + $response = \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'postId' => $post_id, + 'registrationTimestamp' => strtotime( $existing_user->user_registered ), + 'granted' => $granted, + 'grantReason' => 'METERING', + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } else { + $granted = false; + $response = \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'postId' => $post_id, + 'registrationTimestamp' => strtotime( $existing_user->user_registered ), + 'granted' => $granted, + 'grantReason' => 'METERING', + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + } + + /** + * Handles Google Extended Access login status route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_login_status( $request ) { + $logged_in_user = \wp_get_current_user(); + + if ( $logged_in_user ) { + $email = $logged_in_user->user_email; + + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + // Log the user in. + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + + if ( is_wp_error( $result ) ) { + $response = \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + } else { + $response = \rest_ensure_response( + array( + 'granted' => false, + 'reason' => 'USER_DOES_NOT_EXISTS', + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + + $granted = false; + $post_id = $request->get_header( 'X-WP-Post-ID' ); + $user_id = $logged_in_user->ID; + + // Cookie name, Made from post id and user id. + $cookie_name = 'newspack_' . md5( $post_id . $user_id ); + + $jwt_sub = get_user_meta( $user_id, 'extended_access_sub', true ); + + // Checks if cookie is set, grants access only if cookie is set. + if ( $jwt_sub ) { + if ( isset( $_COOKIE[ $cookie_name ] ) ) { + $granted = true; + + $response = \rest_ensure_response( + array( + 'id' => base64_encode( $jwt_sub ), + 'email' => $email, + 'registrationTimestamp' => strtotime( $logged_in_user->user_registered ), + 'granted' => $granted, + 'grantReason' => 'METERING', + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } else { + $response = \rest_ensure_response( + array( + 'id' => base64_encode( $jwt_sub ), + 'email' => $email, + 'registrationTimestamp' => strtotime( $logged_in_user->user_registered ), + 'granted' => $granted, + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + } else { + $response = \rest_ensure_response( + array( + 'granted' => false, + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + } else { + $response = \rest_ensure_response( + array( + 'granted' => false, + 'reason' => 'NO_LOGGEND_IN_USER', + ) + ); + $response->set_headers( [ 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ) ] ); + return $response; + } + } + + + /** + * Enables registering through SWG even if it is disabled. + * + * @param boolean $is_enabled Existing value of newspack_reader_activation_enabled option. + * @return boolean Returns always true for SWG. + */ + public static function bypass_newspack_reader_activation_enabled( $is_enabled ) { + return true; + } +} diff --git a/includes/class-single-post-subscription.php b/includes/class-single-post-subscription.php index ef2e320..b5c870d 100644 --- a/includes/class-single-post-subscription.php +++ b/includes/class-single-post-subscription.php @@ -3,10 +3,10 @@ * Registers required scripts for SwG implementation * specific to Newspack functionality. * - * @package newspack-extended-access + * @package Newspack\Extended_Access */ -namespace Newspack_Extended_Access; +namespace Newspack\Extended_Access; /** * Defines functionality to bypass paywall restriction for single post for single user. @@ -17,13 +17,14 @@ class Single_Post_Subscription { * Set up hooks and filters. */ public static function init() { - /* Hook function before Restriction class function hook, + /* + * Hook function before Restriction class function hook, * it removes actions added by woocommerce membership to * restrict access to post content. */ - add_action( 'wp', [ __CLASS__, 'remove_pay_restriction' ], 9 ); + add_action( 'wp', array( __CLASS__, 'remove_pay_restriction' ), 9 ); } - + /** * Removes actions added by woocommerce membership to restrict access to post content. */ @@ -31,20 +32,33 @@ public static function remove_pay_restriction() { $post_id = get_the_ID(); $user_id = get_current_user_id(); - // Example cookie name, Made from post id and user id + // Example cookie name, Made from post id and user id. $cookie_name = 'newspack_' . md5( $post_id . $user_id ); - + + // Get membership instance. + $membership_instance = wc_memberships()->get_restrictions_instance()->get_posts_restrictions_instance(); + // Checks if cookie is set, grants access only if cookie is set. - if ( isset( $_COOKIE[ $cookie_name ]) ) { - $membership_instance = wc_memberships()->get_restrictions_instance()->get_posts_restrictions_instance(); - remove_action( 'wp', [ $membership_instance, 'handle_restriction_modes' ] ) ; - remove_filter( 'the_posts', [ $membership_instance, 'exclude_restricted_content_comments' ], 999, 2 ); - remove_filter( 'pre_get_comments', [ $membership_instance, 'exclude_restricted_comments' ], 999 ); - remove_filter( 'get_previous_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); - remove_filter( 'get_next_post_where', [ $membership_instance, 'exclude_restricted_adjacent_posts' ], 1, 5 ); - remove_filter( 'posts_clauses', [ $membership_instance, 'handle_posts_clauses' ], 999, 2 ); - remove_filter( 'get_terms_args', [ $membership_instance, 'handle_get_terms_args' ], 999, 2 ); - remove_filter( 'terms_clauses', [ $membership_instance, 'handle_terms_clauses' ], 999 ); + if ( isset( $_COOKIE[ $cookie_name ] ) ) { + // Remove restriction for the post ($post_id) for user ($user_id). + remove_action( 'wp', array( $membership_instance, 'handle_restriction_modes' ) ); + remove_filter( 'the_posts', array( $membership_instance, 'exclude_restricted_content_comments' ), 999, 2 ); + remove_filter( 'pre_get_comments', array( $membership_instance, 'exclude_restricted_comments' ), 999 ); + remove_filter( 'get_previous_post_where', array( $membership_instance, 'exclude_restricted_adjacent_posts' ), 1, 5 ); + remove_filter( 'get_next_post_where', array( $membership_instance, 'exclude_restricted_adjacent_posts' ), 1, 5 ); + remove_filter( 'posts_clauses', array( $membership_instance, 'handle_posts_clauses' ), 999, 2 ); + remove_filter( 'get_terms_args', array( $membership_instance, 'handle_get_terms_args' ), 999, 2 ); + remove_filter( 'terms_clauses', array( $membership_instance, 'handle_terms_clauses' ), 999 ); + } elseif ( ! has_filter( 'wp', array( $membership_instance, 'handle_restriction_modes' ) ) ) { + // Add restriction for the user ($user_id) if they are not present for the post($post_id). + add_action( 'wp', array( $membership_instance, 'handle_restriction_modes' ) ); + add_filter( 'the_posts', array( $membership_instance, 'exclude_restricted_content_comments' ), 999, 2 ); + add_filter( 'pre_get_comments', array( $membership_instance, 'exclude_restricted_comments' ), 999 ); + add_filter( 'get_previous_post_where', array( $membership_instance, 'exclude_restricted_adjacent_posts' ), 1, 5 ); + add_filter( 'get_next_post_where', array( $membership_instance, 'exclude_restricted_adjacent_posts' ), 1, 5 ); + add_filter( 'posts_clauses', array( $membership_instance, 'handle_posts_clauses' ), 999, 2 ); + add_filter( 'get_terms_args', array( $membership_instance, 'handle_get_terms_args' ), 999, 2 ); + add_filter( 'terms_clauses', array( $membership_instance, 'handle_terms_clauses' ), 999 ); } } } diff --git a/includes/class-woocommerce.php b/includes/class-woocommerce.php index b7ee4bf..0cd4953 100644 --- a/includes/class-woocommerce.php +++ b/includes/class-woocommerce.php @@ -2,10 +2,10 @@ /** * Adjustments and special handling related to WooCommerce. * - * @package newspack-extended-access + * @package Newspack\Extended_Access */ -namespace Newspack_Extended_Access; +namespace Newspack\Extended_Access; /** * Adjustments and special handling related to WooCommerce. diff --git a/includes/woocommerce/memberships/settings/class-wc-settings-memberships-option-tab.php b/includes/woocommerce/memberships/settings/class-wc-settings-memberships-option-tab.php new file mode 100644 index 0000000..5a9ee76 --- /dev/null +++ b/includes/woocommerce/memberships/settings/class-wc-settings-memberships-option-tab.php @@ -0,0 +1,95 @@ + Memberships' page. + */ +class WC_Settings_Memberships_Option_Tab { + + /** + * Set up hooks and filters. + */ + public static function init() { + + try { + // Adds a new option tab to WooCommerce 'Settings -> Memberships' page. + add_filter( 'woocommerce_get_sections_memberships', array( __CLASS__, 'woocommerce_get_sections_memberships__add_option_tab' ) ); + add_filter( 'woocommerce_get_settings_memberships', array( __CLASS__, 'woocommerce_get_settings_memberships__add_option_tab' ), 10, 2 ); + } catch ( \Error $er ) { + echo esc_html( $er ); + } + + } + + /** + * Add tab for this plugin's options page into WooCommerce 'Settings -> Memberships'. + * + * @param array $sections Array of the plugin sections. + * @return array Returns updated sections. + */ + public static function woocommerce_get_sections_memberships__add_option_tab( $sections ) { + // Add 'Newspack Extended Access' to existing sections. + $sections['newspack-extended-access'] = __( 'Newspack Extended Access', 'newspack-extended-access' ); + + return $sections; + } + + /** + * Add this plugin's options page into WooCommerce 'Settings -> Memberships'. + * + * @param array $settings Array of the plugin settings. + * @param string $current_section the current section being output. + * @return array Returns updated options. + */ + public static function woocommerce_get_settings_memberships__add_option_tab( $settings, $current_section ) { + // Add this plugin's option only for 'newspack-extended-access' key. + if ( 'newspack-extended-access' === $current_section ) { + + // Prepare server protocol and domain name. + // phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotValidated -- Already validated. + $protocol = ( ! empty( $_SERVER['HTTPS'] ) && 'off' !== $_SERVER['HTTPS'] || 443 == $_SERVER['SERVER_PORT'] ) ? 'https://' : 'http://'; + $sanitized_server_name = isset( $_SERVER['SERVER_NAME'] ) ? filter_var( $_SERVER['SERVER_NAME'], FILTER_SANITIZE_URL ) : ''; + $server_url_obj = wp_parse_url( $sanitized_server_name ); + $allowed_referrers = $protocol . array( ( array_key_exists( 'host', $server_url_obj ) && ! is_null( $server_url_obj['host'] ) ) ? $server_url_obj['host'] : $sanitized_server_name )[0]; + + // Prepare title and input-box description. + $title_desc = '

An integration for utilizing Google Extended Access.

'; + $input_desc = '

Refer Google Developer Documents to setup and configure your Google Client API ID.

Make sure to add your domain ' . $allowed_referrers . ' to Authorized JavaScript origins.'; + + // Override existing settings with out 'Newspack Extended Access' tab. + $settings = array( + + array( + 'name' => __( 'Newspack Extended Access', 'newspack-extended-access' ), + 'type' => 'title', + 'desc' => $title_desc, + ), + + array( + 'type' => 'textarea', + 'id' => 'newspack_extended_access__google_client_api_id', + 'name' => __( 'Google Client API ID', 'newspack-extended-access' ), + 'desc' => $input_desc, + 'default' => '', + ), + + array( + 'type' => 'sectionend', + ), + + ); + + } + + return $settings; + } +} diff --git a/newspack-extended-access.php b/newspack-extended-access.php index 77e6667..58ba542 100644 --- a/newspack-extended-access.php +++ b/newspack-extended-access.php @@ -6,9 +6,9 @@ * Author: Automattic * Text Domain: newspack-extended-access * Domain Path: /languages - * Version: 0.22 + * Version: 1.0 * - * @package newspack-extended-access + * @package Newspack\Extended_Access */ defined( 'ABSPATH' ) || exit; @@ -19,4 +19,4 @@ require_once 'vendor/autoload.php'; -Newspack_Extended_Access\Initializer::init(); +Newspack\Extended_Access\Initializer::init(); From 84a9439610ecc23c7a95fb857f0d201c8ca779f2 Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Tue, 25 Apr 2023 16:35:45 +0530 Subject: [PATCH 08/24] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Resolve=20merge=20co?= =?UTF-8?q?nflict?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/newspack-swg.js | 166 ++++++++++++++++ .../class-extendedaccess-rest-endpoint.php | 187 ++++++++++++++++++ 2 files changed, 353 insertions(+) create mode 100644 assets/newspack-swg.js create mode 100644 includes/class-extendedaccess-rest-endpoint.php diff --git a/assets/newspack-swg.js b/assets/newspack-swg.js new file mode 100644 index 0000000..67d8276 --- /dev/null +++ b/assets/newspack-swg.js @@ -0,0 +1,166 @@ +/** + * Newspack SwG Library. + * + * Initializes GAA and defines required callbacks to + * register/login to site via SwG, check post status + * and unlock article. + * + * @link https://www.newspack.com + * @file This files defines SwG required methods and callback for Newspack specific functionality. + * @author Newspack + * @since 0.21 + */ + +/** + * Parses JWT token and converts into equivalent JSON object. + * + * @param {string} token JWT Token to be parse. + * @returns {Object} Parsed JWT as JSON Object. + */ +function parseJwt(token) { + var base64Url = token.split('.')[1]; + var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/'); + var jsonPayload = decodeURIComponent(window.atob(base64).split('').map(function (c) { + return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2); + }).join('')); + + return JSON.parse(jsonPayload); +} + +/** + * Initializes GaaMetering for SwG. + */ +function InitGaaMetering() { + + /** + * Variables + */ + const allowedReferrers = AuthSettings.allowedReferrers ; // ['extended-access-dev.newspackstaging.com', 'newspackstaging.com'] + + /** + * Login Existing User Promise callback handler. + */ + handleLoginPromise = new Promise(() => { + GaaMetering.getLoginPromise().then(() => { + console.log('handleLoginPromise', 'Redirecting to login URL'); + // Capture full URL, including URL parameters, to redirect the user to after login + const redirectUri = encodeURIComponent(window.location.href); + // Redirect to a login page for existing users to login. + window.location = `${window.location.protocol}//${window.location.hostname}/my-account?redirect_to=${redirectUri}`; + }); + }); + + /** + * Register New User Promise callback handler. + */ + registerUserPromise = new Promise((resolve) => { + // Get the information for the user who has just registered. + GaaMetering.getGaaUserPromise().then((gaaUser) => { + // Send that information to your Registration endpoint to register the user and + // return the userState for the newly registered user. + + const gaaUserDecoded = parseJwt(gaaUser.credential); + + fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/google`, + { + method: 'POST', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': AuthSettings.nonce + }, + body: gaaUser.credential + }) + .then(response => response.json()) + .then(userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + resolve(userState); + }); + }); + }); + + /** + * Check whether publisher has provided access to the User or not. + */ + publisherEntitlementPromise = new Promise((resolve) => { + /* Do not grant user, show Google Intervention Dialog. */ + resolve({ granted: false }); + + /* Grant user, do not show Google Intervention Dialog. */ + // resolve({granted: true, grantReason: 'METERING'}); + + /* Do not grant user, show Google Extended Access Dialog. */ + // resolve({ id: 'MTAzMjk1OTEyMjMwNDQ4NjQxMzQz', registrationTimestamp: 1680773672, granted: false }); + }); + + /** + * Check whether publisher has provided access to the User or not. + */ + getUserState = new Promise((resolve) => { + + fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/status`, + { + method: 'GET', + headers: { + 'Content-type': 'text/plain', + 'X-WP-Nonce': AuthSettings.nonce + }, + }) + .then(response => response.json()) + .then(userState => { + // Refresh page only when it is not already unlocked + if (window.localStorage) { + if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { + localStorage.removeItem('unlocked'); + } + } + resolve(userState); + }); + }); + + /** + * Fires when Extended Access grants permission. + */ + unlockArticle = () => { + console.log('unlockArticle callback'); + if (window.localStorage) { + if (!localStorage.getItem('unlocked')) { + localStorage['unlocked'] = true; + window.location.reload(); + } + } + } + + /** + * Display custom paywall instead of Google Intervention Dialog. + */ + showPaywall = () => { + console.log('showPaywall callback'); + } + + /** + * Handles SwG Entitlement callback. + */ + handleSwGEntitlement = () => { + console.log('handleSwGEntitlement callback'); + } + + /** + * Initialize GAA for Extended Access. + */ + GaaMetering.init({ + googleApiClientId: AuthSettings.googleClientId, // For Newspack Staging Site: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com' + userState: getUserState, + allowedReferrers: allowedReferrers, + handleLoginPromise: handleLoginPromise, + registerUserPromise: registerUserPromise, + publisherEntitlementPromise: getUserState, + unlockArticle: unlockArticle, + showPaywall: showPaywall, + handleSwGEntitlement: handleSwGEntitlement + }); +} diff --git a/includes/class-extendedaccess-rest-endpoint.php b/includes/class-extendedaccess-rest-endpoint.php new file mode 100644 index 0000000..30ea58d --- /dev/null +++ b/includes/class-extendedaccess-rest-endpoint.php @@ -0,0 +1,187 @@ + \WP_REST_Server::READABLE, + 'callback' => array( __CLASS__, 'api_login_status' ), + ) + ); + + \register_rest_route( + 'newspack-extended-access/v1', + '/login/google', + array( + 'methods' => \WP_REST_Server::CREATABLE, + 'callback' => array( __CLASS__, 'api_google_login_register' ), + ) + ); + } + + /** + * Handles Google Extended Access registration route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_google_login_register( $request ) { + // Decode JWT. + $token = json_decode( base64_decode( str_replace( '_', '/', str_replace( '-', '+', explode( '.', $request->get_body() )[1] ) ) ) ); + + // Get Google Email. + $email = $token->email; + + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + self::assign_user_plan( $email ); + } else { + \add_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + $result = Newspack\Reader_Activation::register_reader( $email, '', true, array() ); + self::assign_user_plan( $email ); + \remove_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); + // At this point the user will be logged in. + } + if ( is_wp_error( $result ) ) { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + } + + return \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'registrationTimestamp' => time(), + 'subscriptionTimestamp' => time(), + 'granted' => true, + 'grantReason' => 'SUBSCRIBER', + ) + ); + } + + /** + * Assign an existing user 'premium-membership' when registered. + * + * @param string $email EmailId of the new registered user. + */ + public static function assign_user_plan( $email ) { + $newspack_extended_access_options = get_option( 'newspack_extended_access_configuration' ); + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + // Log the user in. + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + + $user_id = $existing_user->ID; + $membership_plan = wc_memberships_get_membership_plan( $newspack_extended_access_options['default_subscription'] ); + $is_active_member = wc_memberships_is_user_member( $user_id, $membership_plan->id, false ); + $existing_membership = wc_memberships_get_user_membership( $user_id, $membership_plan->id ); + $plans = wc_memberships_get_membership_plans(); + + if ( ! $is_active_member && empty( $existing_membership ) && 0 !== $user_id ) { + $args = array( + // Enter the ID (post ID) of the plan to grant at registration. + 'plan_id' => $membership_plan->id, + 'user_id' => $user_id, + ); + $new_membership = wc_memberships_create_user_membership( $args ); + } + } + } + + /** + * Handles Google Extended Access login status route. + * + * @param \WP_REST_Request $request Request object. + * @return mixed Returns Extended Access userState object. + */ + public static function api_login_status( $request ) { + $logged_in_user = \wp_get_current_user(); + + if ( $logged_in_user ) { + $email = $logged_in_user->user_email; + + $existing_user = \get_user_by( 'email', $email ); + + if ( $existing_user ) { + // Log the user in. + $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); + + if ( is_wp_error( $result ) ) { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => $result, + ) + ); + } + } else { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => 'not-existing-user', + ) + ); + } + + return \rest_ensure_response( + array( + 'id' => base64_encode( $token->sub ), + 'registrationTimestamp' => time(), + 'subscriptionTimestamp' => time(), + 'granted' => true, + 'grantReason' => 'SUBSCRIBER', + ) + ); + } else { + return \rest_ensure_response( + array( + 'granted' => false, + 'reason' => 'no-logged-in-user', + ) + ); + } + } + + + /** + * Enables registering through SWG even if it is disabled. + * + * @param boolean $is_enabled Existing value of newspack_reader_activation_enabled option. + * @return boolean Returns always true for SWG. + */ + public static function bypass_newspack_reader_activation_enabled( $is_enabled ) { + return true; + } +} From 5e87bef6d2011fb6c405333278532f63e40928d3 Mon Sep 17 00:00:00 2001 From: Anurag Vasanwala <75766877+AnuragVasanwala@users.noreply.github.com> Date: Tue, 25 Apr 2023 16:50:18 +0530 Subject: [PATCH 09/24] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Minor=20Refactoring?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/newspack-swg.js | 166 ---------------- .../class-extendedaccess-rest-endpoint.php | 187 ------------------ includes/class-google-extendedaccess.php | 4 +- includes/class-initializer.php | 2 +- includes/class-rest-endpoint.php | 47 ++--- 5 files changed, 28 insertions(+), 378 deletions(-) delete mode 100644 assets/newspack-swg.js delete mode 100644 includes/class-extendedaccess-rest-endpoint.php diff --git a/assets/newspack-swg.js b/assets/newspack-swg.js deleted file mode 100644 index 67d8276..0000000 --- a/assets/newspack-swg.js +++ /dev/null @@ -1,166 +0,0 @@ -/** - * Newspack SwG Library. - * - * Initializes GAA and defines required callbacks to - * register/login to site via SwG, check post status - * and unlock article. - * - * @link https://www.newspack.com - * @file This files defines SwG required methods and callback for Newspack specific functionality. - * @author Newspack - * @since 0.21 - */ - -/** - * Parses JWT token and converts into equivalent JSON object. - * - * @param {string} token JWT Token to be parse. - * @returns {Object} Parsed JWT as JSON Object. - */ -function parseJwt(token) { - var base64Url = token.split('.')[1]; - var base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/'); - var jsonPayload = decodeURIComponent(window.atob(base64).split('').map(function (c) { - return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2); - }).join('')); - - return JSON.parse(jsonPayload); -} - -/** - * Initializes GaaMetering for SwG. - */ -function InitGaaMetering() { - - /** - * Variables - */ - const allowedReferrers = AuthSettings.allowedReferrers ; // ['extended-access-dev.newspackstaging.com', 'newspackstaging.com'] - - /** - * Login Existing User Promise callback handler. - */ - handleLoginPromise = new Promise(() => { - GaaMetering.getLoginPromise().then(() => { - console.log('handleLoginPromise', 'Redirecting to login URL'); - // Capture full URL, including URL parameters, to redirect the user to after login - const redirectUri = encodeURIComponent(window.location.href); - // Redirect to a login page for existing users to login. - window.location = `${window.location.protocol}//${window.location.hostname}/my-account?redirect_to=${redirectUri}`; - }); - }); - - /** - * Register New User Promise callback handler. - */ - registerUserPromise = new Promise((resolve) => { - // Get the information for the user who has just registered. - GaaMetering.getGaaUserPromise().then((gaaUser) => { - // Send that information to your Registration endpoint to register the user and - // return the userState for the newly registered user. - - const gaaUserDecoded = parseJwt(gaaUser.credential); - - fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/google`, - { - method: 'POST', - headers: { - 'Content-type': 'text/plain', - 'X-WP-Nonce': AuthSettings.nonce - }, - body: gaaUser.credential - }) - .then(response => response.json()) - .then(userState => { - // Refresh page only when it is not already unlocked - if (window.localStorage) { - if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { - localStorage.removeItem('unlocked'); - } - } - resolve(userState); - }); - }); - }); - - /** - * Check whether publisher has provided access to the User or not. - */ - publisherEntitlementPromise = new Promise((resolve) => { - /* Do not grant user, show Google Intervention Dialog. */ - resolve({ granted: false }); - - /* Grant user, do not show Google Intervention Dialog. */ - // resolve({granted: true, grantReason: 'METERING'}); - - /* Do not grant user, show Google Extended Access Dialog. */ - // resolve({ id: 'MTAzMjk1OTEyMjMwNDQ4NjQxMzQz', registrationTimestamp: 1680773672, granted: false }); - }); - - /** - * Check whether publisher has provided access to the User or not. - */ - getUserState = new Promise((resolve) => { - - fetch(`${window.location.protocol}//${window.location.hostname}/wp-json/newspack-extended-access/v1/login/status`, - { - method: 'GET', - headers: { - 'Content-type': 'text/plain', - 'X-WP-Nonce': AuthSettings.nonce - }, - }) - .then(response => response.json()) - .then(userState => { - // Refresh page only when it is not already unlocked - if (window.localStorage) { - if (localStorage.getItem('unlocked') && localStorage['unlocked'] === "true" && userState.granted === false) { - localStorage.removeItem('unlocked'); - } - } - resolve(userState); - }); - }); - - /** - * Fires when Extended Access grants permission. - */ - unlockArticle = () => { - console.log('unlockArticle callback'); - if (window.localStorage) { - if (!localStorage.getItem('unlocked')) { - localStorage['unlocked'] = true; - window.location.reload(); - } - } - } - - /** - * Display custom paywall instead of Google Intervention Dialog. - */ - showPaywall = () => { - console.log('showPaywall callback'); - } - - /** - * Handles SwG Entitlement callback. - */ - handleSwGEntitlement = () => { - console.log('handleSwGEntitlement callback'); - } - - /** - * Initialize GAA for Extended Access. - */ - GaaMetering.init({ - googleApiClientId: AuthSettings.googleClientId, // For Newspack Staging Site: '224001690291-52f6af34qi6b7ug7h6r0vf8tdudlmhi3.apps.googleusercontent.com' - userState: getUserState, - allowedReferrers: allowedReferrers, - handleLoginPromise: handleLoginPromise, - registerUserPromise: registerUserPromise, - publisherEntitlementPromise: getUserState, - unlockArticle: unlockArticle, - showPaywall: showPaywall, - handleSwGEntitlement: handleSwGEntitlement - }); -} diff --git a/includes/class-extendedaccess-rest-endpoint.php b/includes/class-extendedaccess-rest-endpoint.php deleted file mode 100644 index 30ea58d..0000000 --- a/includes/class-extendedaccess-rest-endpoint.php +++ /dev/null @@ -1,187 +0,0 @@ - \WP_REST_Server::READABLE, - 'callback' => array( __CLASS__, 'api_login_status' ), - ) - ); - - \register_rest_route( - 'newspack-extended-access/v1', - '/login/google', - array( - 'methods' => \WP_REST_Server::CREATABLE, - 'callback' => array( __CLASS__, 'api_google_login_register' ), - ) - ); - } - - /** - * Handles Google Extended Access registration route. - * - * @param \WP_REST_Request $request Request object. - * @return mixed Returns Extended Access userState object. - */ - public static function api_google_login_register( $request ) { - // Decode JWT. - $token = json_decode( base64_decode( str_replace( '_', '/', str_replace( '-', '+', explode( '.', $request->get_body() )[1] ) ) ) ); - - // Get Google Email. - $email = $token->email; - - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - self::assign_user_plan( $email ); - } else { - \add_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); - $result = Newspack\Reader_Activation::register_reader( $email, '', true, array() ); - self::assign_user_plan( $email ); - \remove_filter( 'newspack_reader_activation_enabled', array( __CLASS__, 'bypass_newspack_reader_activation_enabled' ) ); - // At this point the user will be logged in. - } - if ( is_wp_error( $result ) ) { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => $result, - ) - ); - } - - return \rest_ensure_response( - array( - 'id' => base64_encode( $token->sub ), - 'registrationTimestamp' => time(), - 'subscriptionTimestamp' => time(), - 'granted' => true, - 'grantReason' => 'SUBSCRIBER', - ) - ); - } - - /** - * Assign an existing user 'premium-membership' when registered. - * - * @param string $email EmailId of the new registered user. - */ - public static function assign_user_plan( $email ) { - $newspack_extended_access_options = get_option( 'newspack_extended_access_configuration' ); - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - // Log the user in. - $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); - - $user_id = $existing_user->ID; - $membership_plan = wc_memberships_get_membership_plan( $newspack_extended_access_options['default_subscription'] ); - $is_active_member = wc_memberships_is_user_member( $user_id, $membership_plan->id, false ); - $existing_membership = wc_memberships_get_user_membership( $user_id, $membership_plan->id ); - $plans = wc_memberships_get_membership_plans(); - - if ( ! $is_active_member && empty( $existing_membership ) && 0 !== $user_id ) { - $args = array( - // Enter the ID (post ID) of the plan to grant at registration. - 'plan_id' => $membership_plan->id, - 'user_id' => $user_id, - ); - $new_membership = wc_memberships_create_user_membership( $args ); - } - } - } - - /** - * Handles Google Extended Access login status route. - * - * @param \WP_REST_Request $request Request object. - * @return mixed Returns Extended Access userState object. - */ - public static function api_login_status( $request ) { - $logged_in_user = \wp_get_current_user(); - - if ( $logged_in_user ) { - $email = $logged_in_user->user_email; - - $existing_user = \get_user_by( 'email', $email ); - - if ( $existing_user ) { - // Log the user in. - $result = Newspack\Reader_Activation::set_current_reader( $existing_user->ID ); - - if ( is_wp_error( $result ) ) { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => $result, - ) - ); - } - } else { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => 'not-existing-user', - ) - ); - } - - return \rest_ensure_response( - array( - 'id' => base64_encode( $token->sub ), - 'registrationTimestamp' => time(), - 'subscriptionTimestamp' => time(), - 'granted' => true, - 'grantReason' => 'SUBSCRIBER', - ) - ); - } else { - return \rest_ensure_response( - array( - 'granted' => false, - 'reason' => 'no-logged-in-user', - ) - ); - } - } - - - /** - * Enables registering through SWG even if it is disabled. - * - * @param boolean $is_enabled Existing value of newspack_reader_activation_enabled option. - * @return boolean Returns always true for SWG. - */ - public static function bypass_newspack_reader_activation_enabled( $is_enabled ) { - return true; - } -} diff --git a/includes/class-google-extendedaccess.php b/includes/class-google-extendedaccess.php index caae2db..7937d2d 100644 --- a/includes/class-google-extendedaccess.php +++ b/includes/class-google-extendedaccess.php @@ -51,7 +51,7 @@ public static function add_extended_access_ld_json() { ); $ld_json = wp_json_encode( $ld_json, $flags ); - $ld_json = \str_replace( "\n", \PHP_EOL . "\t", $ld_json ); + $ld_json = str_replace( "\n", PHP_EOL . "\t", $ld_json ); ?>