Current File : /home/tradesc/www/relax/wp-content/plugins/google-site-kit/includes/Modules/Sign_In_With_Google.php
<?php
/**
* Class Google\Site_Kit\Modules\Sign_In_With_Google
*
* @package Google\Site_Kit
* @copyright 2024 Google LLC
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @link https://sitekit.withgoogle.com
*/
namespace Google\Site_Kit\Modules;
use Google\Site_Kit\Core\Assets\Script;
use Google\Site_Kit\Core\Conversion_Tracking\Conversion_Event_Providers\WooCommerce;
use Google\Site_Kit\Core\Modules\Module;
use Google\Site_Kit\Core\Modules\Module_With_Assets;
use Google\Site_Kit\Core\Modules\Module_With_Assets_Trait;
use Google\Site_Kit\Core\Modules\Module_With_Deactivation;
use Google\Site_Kit\Core\Modules\Module_With_Debug_Fields;
use Google\Site_Kit\Core\Modules\Module_With_Settings;
use Google\Site_Kit\Core\Modules\Module_With_Settings_Trait;
use Google\Site_Kit\Core\Modules\Module_With_Tag;
use Google\Site_Kit\Core\Modules\Module_With_Tag_Trait;
use Google\Site_Kit\Core\Modules\Tags\Module_Tag_Matchers;
use Google\Site_Kit\Core\Site_Health\Debug_Data;
use Google\Site_Kit\Core\Util\Method_Proxy_Trait;
use Google\Site_Kit\Modules\Sign_In_With_Google\Settings;
use Google\Site_Kit\Modules\Sign_In_With_Google\Tag_Matchers;
use Google\Site_Kit_Dependencies\Google_Client;
use WP_Error;
/**
* Class representing the Sign in With Google module.
*
* @since 1.137.0
* @access private
* @ignore
*/
final class Sign_In_With_Google extends Module implements Module_With_Assets, Module_With_Settings, Module_With_Deactivation, Module_With_Debug_Fields, Module_With_Tag {
use Method_Proxy_Trait;
use Module_With_Assets_Trait;
use Module_With_Settings_Trait;
use Module_With_Tag_Trait;
/**
* Module slug name.
*/
const MODULE_SLUG = 'sign-in-with-google';
/**
* Registers functionality through WordPress hooks.
*
* @since 1.137.0
*/
public function register() {
add_filter( 'wp_login_errors', array( $this, 'handle_google_auth_errors' ) );
add_action( 'login_form_google_auth', array( $this, 'handle_google_auth' ) );
add_action( 'login_form', $this->get_method_proxy( 'render_signin_button' ) );
}
/**
* Intercept the page request to process token ID
* and complete Sign in with Google flow.
*
* @since 1.140.0
*/
public function handle_google_auth() {
$request_method = $this->context->input()->filter( INPUT_SERVER, 'REQUEST_METHOD' );
if ( 'POST' !== $request_method ) {
return;
}
$csrf_cookie = $this->context->input()->filter( INPUT_COOKIE, 'g_csrf_token' );
$csrf_post = $this->context->input()->filter( INPUT_POST, 'g_csrf_token' );
if (
! $csrf_cookie ||
! $csrf_post ||
$csrf_cookie !== $csrf_post
) {
wp_safe_redirect( add_query_arg( 'error', 'google_auth_invalid_g_csrf_token', wp_login_url() ) );
exit;
}
$client_id = $this->get_settings()->get()['clientID'];
$id_token = $this->context->input()->filter( INPUT_POST, 'credential' );
try {
$client = new Google_Client( array( 'client_id' => $client_id ) );
$payload = $client->verifyIdToken( $id_token );
if ( empty( $payload ) ) {
wp_safe_redirect( add_query_arg( 'error', 'google_auth_invalid_request', wp_login_url() ) );
exit;
}
// @TODO implement further flow using $payload in #9339.
} catch ( \Exception $e ) {
wp_safe_redirect( add_query_arg( 'error', 'google_auth_invalid_request', wp_login_url() ) );
exit;
}
}
/**
* Adds custom errors if Google auth flow failed.
*
* @since 1.140.0
*
* @param WP_Error $error WP_Error instance.
* @return WP_Error $error WP_Error instance.
*/
public function handle_google_auth_errors( $error ) {
$error_code = $this->context->input()->filter( INPUT_GET, 'error' );
if ( ! $error_code ) {
return $error;
}
switch ( $error_code ) {
case 'google_auth_invalid_request':
case 'google_auth_invalid_g_csrf_token':
$error->add( 'google_auth', __( 'Sign in with Google failed.', 'google-site-kit' ) );
break;
default:
break;
}
return $error;
}
/**
* Cleans up when the module is deactivated.
*
* @since 1.137.0
*/
public function on_deactivation() {
$this->get_settings()->delete();
}
/**
* Sets up information about the module.
*
* @since 1.137.0
*
* @return array Associative array of module info.
*/
protected function setup_info() {
return array(
'slug' => self::MODULE_SLUG,
'name' => _x( 'Sign in with Google', 'Service name', 'google-site-kit' ),
'description' => __( 'Improve user engagement, trust, and data privacy, while creating a simple, secure, and personalized experience for your visitors', 'google-site-kit' ),
'order' => 10,
'homepage' => __( 'https://developers.google.com/identity/gsi/web/guides/overview', 'google-site-kit' ),
);
}
/**
* Sets up the module's assets to register.
*
* @since 1.137.0
*
* @return Asset[] List of Asset objects.
*/
protected function setup_assets() {
return array(
new Script(
'googlesitekit-modules-sign-in-with-google',
array(
'src' => $this->context->url( 'dist/assets/js/googlesitekit-modules-sign-in-with-google.js' ),
'dependencies' => array(
'googlesitekit-vendor',
'googlesitekit-api',
'googlesitekit-data',
'googlesitekit-modules',
'googlesitekit-datastore-site',
'googlesitekit-datastore-user',
'googlesitekit-components',
),
)
),
);
}
/**
* Sets up the module's settings instance.
*
* @since 1.137.0
*
* @return Settings
*/
protected function setup_settings() {
return new Settings( $this->options );
}
/**
* Checks whether the module is connected.
*
* A module being connected means that all steps required as part of its activation are completed.
*
* @since 1.139.0
*
* @return bool True if module is connected, false otherwise.
*/
public function is_connected() {
$options = $this->get_settings()->get();
if ( empty( $options['clientID'] ) ) {
return false;
}
return parent::is_connected();
}
/**
* Renders the sign in button.
*
* @since 1.139.0
*/
private function render_signin_button() {
$settings = $this->get_settings()->get();
if ( ! $settings['clientID'] ) {
return;
}
$redirect_url = add_query_arg( 'action', 'google_auth', wp_login_url() );
if ( substr( $redirect_url, 0, 5 ) !== 'https' ) {
return;
}
// Render the Sign in with Google button and related inline styles.
?>
<!-- <?php echo esc_html__( 'Sign in with Google button added by Site Kit', 'google-site-kit' ); ?> -->
<?php /* phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript */ ?>
<script src="https://accounts.google.com/gsi/client"></script>
<script>
( () => {
google.accounts.id.initialize({
client_id: '<?php echo esc_js( $settings['clientID'] ); ?>',
login_uri: '<?php echo esc_js( $redirect_url ); ?>',
ux_mode: 'redirect',
});
const parent = document.createElement( 'div' );
document.getElementById( 'login').insertBefore( parent, document.getElementById( 'loginform' ) );
google.accounts.id.renderButton(parent, {
theme: '<?php echo esc_js( $settings['theme'] ); ?>',
text: '<?php echo esc_js( $settings['text'] ); ?>',
shape: '<?php echo esc_js( $settings['shape'] ); ?>'
});
} )();
</script>
<!-- <?php echo esc_html__( 'End Sign in with Google button added by Site Kit', 'google-site-kit' ); ?> -->
<?php
}
/**
* Gets the absolute number of users who have authenticated using Sign in with Google.
*
* @since 1.140.0
*
* @return array
*/
public function get_authenticated_users_count() {
global $wpdb;
$settings = $this->get_settings();
// phpcs:ignore WordPress.DB.DirectDatabaseQuery
return $wpdb->query(
$wpdb->prepare( "SELECT count(id) FROM $wpdb->usermeta WHERE meta_key = %s", self::GOOGLE_USER_ID_OPTION )
);
}
/**
* Gets an array of debug field definitions.
*
* @since 1.140.0
*
* @return array
*/
public function get_debug_fields() {
$settings = $this->get_settings()->get();
// TODO Uncomment and remove fixed value after #9339 is merged.
// $authenticated_user_count = $this->get_authenticated_users_count();.
$authenticated_user_count = 1;
$debug_fields = array(
'sign_in_with_google_client_id' => array(
'label' => __( 'Sign in with Google Client ID', 'google-site-kit' ),
'value' => $settings['clientID'],
'debug' => Debug_Data::redact_debug_value( $settings['clientID'] ),
),
'sign_in_with_google_shape' => array(
'label' => __( 'Sign in with Google Shape', 'google-site-kit' ),
'value' => $this->get_settings()->get_label( 'shape', $settings['shape'] ),
'debug' => $settings['shape'],
),
'sign_in_with_google_text' => array(
'label' => __( 'Sign in with Google Text', 'google-site-kit' ),
'value' => $this->get_settings()->get_label( 'text', $settings['text'] ),
'debug' => $settings['text'],
),
'sign_in_with_google_theme' => array(
'label' => __( 'Sign in with Google Theme', 'google-site-kit' ),
'value' => $this->get_settings()->get_label( 'theme', $settings['theme'] ),
'debug' => $settings['theme'],
),
'sign_in_with_google_use_snippet' => array(
'label' => __( 'Sign in with Google One-tap Enabled', 'google-site-kit' ),
'value' => $settings['oneTapEnabled'] ? __( 'Yes', 'google-site-kit' ) : __( 'No', 'google-site-kit' ),
'debug' => $settings['oneTapEnabled'] ? 'yes' : 'no',
),
'sign_in_with_google_authenticated_user_count' => array(
'label' => __( 'Sign in with Google Number of users who have authenticated using Sign in with Google', 'google-site-kit' ),
'value' => $authenticated_user_count,
'debug' => $authenticated_user_count,
),
);
return $debug_fields;
}
/**
* Implements mandatory interface method.
*
* This module doesn't use the usual tag registration within Site kit
* to place its snippet. However, it does leverage the Tag_Placement functionality
* to check if a tag is successfully placed or not within WordPress's Site Health.
*/
public function register_tag() {
}
/**
* Returns the Module_Tag_Matchers instance.
*
* @since 1.140.0
*
* @return Module_Tag_Matchers Module_Tag_Matchers instance.
*/
public function get_tag_matchers() {
return new Tag_Matchers();
}
/**
* Gets the URL of the page(s) where a tag for the module would be placed.
*
* For all modules like Analytics, Tag Manager, AdSense, Ads, etc. except for
* Sign in with Google, tags can be detected on the home page. SiwG places its
* snippet on the login page and thus, overrides this method.
*
* @since 1.140.0
*
* @return string TRUE if tag is found, FALSE if not.
*/
public function get_content_url() {
$wp_login_url = wp_login_url();
$woo_commerce = new WooCommerce( $this->context );
if ( $woo_commerce->is_active() ) {
$wc_login_page_id = wc_get_page_id( 'myaccount' );
$wc_login_url = get_permalink( $wc_login_page_id );
return array(
'WordPress Login Page' => $wp_login_url,
'WooCommerce Login Page' => $wc_login_url,
);
}
return $wp_login_url;
}
/**
* Checks if the Sign in with Google button, specifically inserted by Site Kit,
* is found in the provided content.
*
* This method overrides the `Module_With_Tag_Trait` implementation since the HTML
* comment inserted for SiwG's button is different to the standard comment inserted
* for other modules' script snippets. This should be improved as speicified in the
* TODO within the trait method.
*
* @since 1.140.0
*
* @param string $content Content to search for the button.
* @return bool TRUE if tag is found, FALSE if not.
*/
public function has_placed_tag_in_content( $content ) {
$search_string = 'Sign in with Google button added by Site Kit';
$search_translatable_string =
__( 'Sign in with Google button added by Site Kit', 'google-site-kit' );
if ( strpos( $content, $search_string ) !== false || strpos( $content, $search_translatable_string ) !== false ) {
return Module_Tag_Matchers::TAG_EXISTS_WITH_COMMENTS;
}
return Module_Tag_Matchers::NO_TAG_FOUND;
}
}
Mini Shell