File: /var/www/agighana.org_backup/Tag_Manager.php
<?php
/**
* Class Google\Site_Kit\Modules\Tag_Manager
*
* @package Google\Site_Kit
* @copyright 2021 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 Exception;
use Google\Site_Kit\Context;
use Google\Site_Kit\Core\Assets\Asset;
use Google\Site_Kit\Core\Assets\Script;
use Google\Site_Kit\Core\Authentication\Clients\Google_Site_Kit_Client;
use Google\Site_Kit\Core\Modules\Module;
use Google\Site_Kit\Core\Modules\Module_Settings;
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_Owner;
use Google\Site_Kit\Core\Modules\Module_With_Owner_Trait;
use Google\Site_Kit\Core\Modules\Module_With_Scopes;
use Google\Site_Kit\Core\Modules\Module_With_Scopes_Trait;
use Google\Site_Kit\Core\Modules\Module_With_Service_Entity;
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\Tag_Manager\Tag_Matchers;
use Google\Site_Kit\Core\Modules\Tags\Module_Tag_Matchers;
use Google\Site_Kit\Core\REST_API\Data_Request;
use Google\Site_Kit\Core\REST_API\Exception\Invalid_Datapoint_Exception;
use Google\Site_Kit\Core\Tags\Guards\Tag_Environment_Type_Guard;
use Google\Site_Kit\Core\Tags\Guards\Tag_Verify_Guard;
use Google\Site_Kit\Core\Site_Health\Debug_Data;
use Google\Site_Kit\Core\Util\Method_Proxy_Trait;
use Google\Site_Kit\Core\Util\Sort;
use Google\Site_Kit\Core\Util\URL;
use Google\Site_Kit\Modules\Tag_Manager\AMP_Tag;
use Google\Site_Kit\Modules\Tag_Manager\Settings;
use Google\Site_Kit\Modules\Tag_Manager\Tag_Guard;
use Google\Site_Kit\Modules\Tag_Manager\Web_Tag;
use Google\Site_Kit_Dependencies\Google\Service\TagManager as Google_Service_TagManager;
use Google\Site_Kit_Dependencies\Google\Service\TagManager\Container as Google_Service_TagManager_Container;
use Google\Site_Kit_Dependencies\Psr\Http\Message\RequestInterface;
use WP_Error;
/**
* Class representing the Tag Manager module.
*
* @since 1.0.0
* @access private
* @ignore
*/
final class Tag_Manager extends Module implements Module_With_Scopes, Module_With_Settings, Module_With_Assets, Module_With_Debug_Fields, Module_With_Owner, Module_With_Service_Entity, Module_With_Deactivation, Module_With_Tag {
use Method_Proxy_Trait;
use Module_With_Assets_Trait;
use Module_With_Owner_Trait;
use Module_With_Scopes_Trait;
use Module_With_Settings_Trait;
use Module_With_Tag_Trait;
/**
* Module slug name.
*/
const MODULE_SLUG = 'tagmanager';
/**
* Container usage context for web.
*/
const USAGE_CONTEXT_WEB = 'web';
/**
* Container usage context for AMP.
*/
const USAGE_CONTEXT_AMP = 'amp';
/**
* Map of container usageContext to option key for containerID.
*
* @var array
*/
protected $context_map = array(
self::USAGE_CONTEXT_WEB => 'containerID',
self::USAGE_CONTEXT_AMP => 'ampContainerID',
);
/**
* Registers functionality through WordPress hooks.
*
* @since 1.0.0
*/
public function register() {
$this->register_scopes_hook();
// Tag Manager tag placement logic.
add_action( 'template_redirect', array( $this, 'register_tag' ) );
add_filter(
'googlesitekit_ads_measurement_connection_checks',
function ( $checks ) {
$checks[] = array( $this, 'check_ads_measurement_connection' );
return $checks;
},
30
);
}
/**
* Checks if the Tag Manager module is connected and contains an Ads Conversion Tracking (AWCT) tag.
*
* @since 1.151.0
*
* @return bool Whether or not Ads measurement is connected via this module.
*/
public function check_ads_measurement_connection() {
if ( ! $this->is_connected() ) {
return false;
}
$settings = $this->get_settings()->get();
$live_containers_versions = $this->get_data(
'live-container-version',
array(
'accountID' => $settings['accountID'],
'internalContainerID' => $settings['internalContainerID'],
)
);
if ( empty( $live_containers_versions->tag ) ) {
return false;
}
return in_array(
'awct',
array_column( $live_containers_versions->tag, 'type' ),
true
);
}
/**
* Gets required Google OAuth scopes for the module.
*
* @since 1.0.0
*
* @return array List of Google OAuth scopes.
*/
public function get_scopes() {
return array(
'https://www.googleapis.com/auth/tagmanager.readonly',
);
}
/**
* Checks whether the module is connected.
*
* A module being connected means that all steps required as part of its activation are completed.
*
* @since 1.0.0
*
* @return bool True if module is connected, false otherwise.
*/
public function is_connected() {
$settings = $this->get_settings()->get();
$amp_mode = $this->context->get_amp_mode();
switch ( $amp_mode ) {
case Context::AMP_MODE_PRIMARY:
$container_ids = array( $settings['ampContainerID'] );
break;
case Context::AMP_MODE_SECONDARY:
$container_ids = array( $settings['containerID'], $settings['ampContainerID'] );
break;
default:
$container_ids = array( $settings['containerID'] );
}
$container_id_errors = array_filter(
$container_ids,
function ( $container_id ) {
return ! $container_id;
}
);
if ( ! empty( $container_id_errors ) ) {
return false;
}
return parent::is_connected();
}
/**
* Cleans up when the module is deactivated.
*
* @since 1.0.0
*/
public function on_deactivation() {
$this->get_settings()->delete();
}
/**
* Gets an array of debug field definitions.
*
* @since 1.5.0
*
* @return array
*/
public function get_debug_fields() {
$settings = $this->get_settings()->get();
return array(
'tagmanager_account_id' => array(
'label' => __( 'Tag Manager: Account ID', 'google-site-kit' ),
'value' => $settings['accountID'],
'debug' => Debug_Data::redact_debug_value( $settings['accountID'] ),
),
'tagmanager_container_id' => array(
'label' => __( 'Tag Manager: Container ID', 'google-site-kit' ),
'value' => $settings['containerID'],
'debug' => Debug_Data::redact_debug_value( $settings['containerID'], 7 ),
),
'tagmanager_amp_container_id' => array(
'label' => __( 'Tag Manager: AMP Container ID', 'google-site-kit' ),
'value' => $settings['ampContainerID'],
'debug' => Debug_Data::redact_debug_value( $settings['ampContainerID'], 7 ),
),
'tagmanager_use_snippet' => array(
'label' => __( 'Tag Manager: Snippet placed', 'google-site-kit' ),
'value' => $settings['useSnippet'] ? __( 'Yes', 'google-site-kit' ) : __( 'No', 'google-site-kit' ),
'debug' => $settings['useSnippet'] ? 'yes' : 'no',
),
);
}
/**
* Sanitizes a string to be used for a container name.
*
* @since 1.0.4
*
* @param string $name String to sanitize.
*
* @return string
*/
public static function sanitize_container_name( $name ) {
// Remove any leading or trailing whitespace.
$name = trim( $name );
// Must not start with an underscore.
$name = ltrim( $name, '_' );
// Decode entities for special characters so that they are stripped properly.
$name = wp_specialchars_decode( $name, ENT_QUOTES );
// Convert accents to basic characters to prevent them from being stripped.
$name = remove_accents( $name );
// Strip all non-simple characters.
$name = preg_replace( '/[^a-zA-Z0-9_., -]/', '', $name );
// Collapse multiple whitespaces.
$name = preg_replace( '/\s+/', ' ', $name );
return $name;
}
/**
* Gets map of datapoint to definition data for each.
*
* @since 1.9.0
*
* @return array Map of datapoints to their definitions.
*/
protected function get_datapoint_definitions() {
return array(
'GET:accounts' => array( 'service' => 'tagmanager' ),
'GET:accounts-containers' => array( 'service' => 'tagmanager' ),
'GET:containers' => array( 'service' => 'tagmanager' ),
'POST:create-container' => array(
'service' => 'tagmanager',
'scopes' => array( 'https://www.googleapis.com/auth/tagmanager.edit.containers' ),
'request_scopes_message' => __( 'Additional permissions are required to create a new Tag Manager container on your behalf.', 'google-site-kit' ),
),
'GET:live-container-version' => array( 'service' => 'tagmanager' ),
);
}
/**
* Creates a request object for the given datapoint.
*
* @since 1.0.0
*
* @param Data_Request $data Data request object.
* @return RequestInterface|callable|WP_Error Request object or callable on success, or WP_Error on failure.
*
* @throws Invalid_Datapoint_Exception Thrown if the datapoint does not exist.
*/
protected function create_data_request( Data_Request $data ) {
switch ( "{$data->method}:{$data->datapoint}" ) {
// Intentional fallthrough.
case 'GET:accounts':
case 'GET:accounts-containers':
return $this->get_tagmanager_service()->accounts->listAccounts();
case 'GET:containers':
if ( ! isset( $data['accountID'] ) ) {
/* translators: %s: Missing parameter name */
return new WP_Error( 'missing_required_param', sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'accountID' ), array( 'status' => 400 ) );
}
return $this->get_tagmanager_service()->accounts_containers->listAccountsContainers( "accounts/{$data['accountID']}" );
case 'POST:create-container':
if ( ! isset( $data['accountID'] ) ) {
return new WP_Error(
'missing_required_param',
/* translators: %s: Missing parameter name */
sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'accountID' ),
array( 'status' => 400 )
);
}
$usage_context = $data['usageContext'] ?: array( self::USAGE_CONTEXT_WEB, self::USAGE_CONTEXT_AMP );
if ( empty( $this->context_map[ $usage_context ] ) ) {
return new WP_Error(
'invalid_param',
sprintf(
/* translators: 1: Invalid parameter name, 2: list of valid values */
__( 'Request parameter %1$s is not one of %2$s', 'google-site-kit' ),
'usageContext',
implode( ', ', array_keys( $this->context_map ) )
),
array( 'status' => 400 )
);
}
$account_id = $data['accountID'];
if ( $data['name'] ) {
$container_name = $data['name'];
} else {
// Use site name for container, fallback to domain of reference URL.
$container_name = get_bloginfo( 'name' ) ?: URL::parse( $this->context->get_reference_site_url(), PHP_URL_HOST );
// Prevent naming conflict (Tag Manager does not allow more than one with same name).
if ( self::USAGE_CONTEXT_AMP === $usage_context ) {
$container_name .= ' AMP';
}
}
$container = new Google_Service_TagManager_Container();
$container->setName( self::sanitize_container_name( $container_name ) );
$container->setUsageContext( (array) $usage_context );
return $this->get_tagmanager_service()->accounts_containers->create( "accounts/{$account_id}", $container );
case 'GET:live-container-version':
if ( ! isset( $data['accountID'] ) ) {
return new WP_Error(
'missing_required_param',
/* translators: %s: Missing parameter name */
sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'accountID' ),
array( 'status' => 400 )
);
}
if ( ! isset( $data['internalContainerID'] ) ) {
return new WP_Error(
'missing_required_param',
/* translators: %s: Missing parameter name */
sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'internalContainerID' ),
array( 'status' => 400 )
);
}
return $this->get_tagmanager_service()->accounts_containers_versions->live(
"accounts/{$data['accountID']}/containers/{$data['internalContainerID']}"
);
}
return parent::create_data_request( $data );
}
/**
* Creates GTM Container.
*
* @since 1.0.0
* @param string $account_id The account ID.
* @param string|array $usage_context The container usage context(s).
*
* @return string Container public ID.
* @throws Exception Throws an exception if raised during container creation.
*/
protected function create_container( $account_id, $usage_context = self::USAGE_CONTEXT_WEB ) {
$restore_defer = $this->with_client_defer( false );
// Use site name for container, fallback to domain of reference URL.
$container_name = get_bloginfo( 'name' ) ?: URL::parse( $this->context->get_reference_site_url(), PHP_URL_HOST );
// Prevent naming conflict (Tag Manager does not allow more than one with same name).
if ( self::USAGE_CONTEXT_AMP === $usage_context ) {
$container_name .= ' AMP';
}
$container_name = self::sanitize_container_name( $container_name );
$container = new Google_Service_TagManager_Container();
$container->setName( $container_name );
$container->setUsageContext( (array) $usage_context );
try {
$new_container = $this->get_tagmanager_service()->accounts_containers->create( "accounts/{$account_id}", $container );
} catch ( Exception $exception ) {
$restore_defer();
throw $exception;
}
$restore_defer();
return $new_container->getPublicId();
}
/**
* Parses a response for the given datapoint.
*
* @since 1.0.0
*
* @param Data_Request $data Data request object.
* @param mixed $response Request response.
*
* @return mixed Parsed response data on success, or WP_Error on failure.
*/
protected function parse_data_response( Data_Request $data, $response ) {
switch ( "{$data->method}:{$data->datapoint}" ) {
case 'GET:accounts':
/* @var Google_Service_TagManager_ListAccountsResponse $response List accounts response. */
return Sort::case_insensitive_list_sort(
$response->getAccount(),
'name'
);
case 'GET:accounts-containers':
/* @var Google_Service_TagManager_ListAccountsResponse $response List accounts response. */
$accounts = Sort::case_insensitive_list_sort(
$response->getAccount(),
'name'
);
$response = array(
// TODO: Parse this response to a regular array.
'accounts' => $accounts,
'containers' => array(),
);
if ( 0 === count( $response['accounts'] ) ) {
return $response;
}
if ( $data['accountID'] ) {
$account_id = $data['accountID'];
} else {
$account_id = $response['accounts'][0]->getAccountId();
}
$containers = $this->get_data(
'containers',
array(
'accountID' => $account_id,
'usageContext' => $data['usageContext'] ?: self::USAGE_CONTEXT_WEB,
)
);
if ( is_wp_error( $containers ) ) {
return $response;
}
return array_merge( $response, compact( 'containers' ) );
case 'GET:containers':
/* @var Google_Service_TagManager_ListContainersResponse $response Response object. */
$usage_context = $data['usageContext'] ?: array( self::USAGE_CONTEXT_WEB, self::USAGE_CONTEXT_AMP );
/* @var Google_Service_TagManager_Container[] $containers Filtered containers. */
$containers = array_filter(
(array) $response->getContainer(),
function ( Google_Service_TagManager_Container $container ) use ( $usage_context ) {
return array_intersect( (array) $usage_context, $container->getUsageContext() );
}
);
return Sort::case_insensitive_list_sort(
array_values( $containers ),
'name'
);
}
return parent::parse_data_response( $data, $response );
}
/**
* Gets the configured TagManager service instance.
*
* @since 1.2.0
* @since 1.142.0 Made method public.
*
* @return Google_Service_TagManager instance.
* @throws Exception Thrown if the module did not correctly set up the service.
*/
public function get_tagmanager_service() {
return $this->get_service( 'tagmanager' );
}
/**
* Sets up information about the module.
*
* @since 1.0.0
*
* @return array Associative array of module info.
*/
protected function setup_info() {
return array(
'slug' => self::MODULE_SLUG,
'name' => _x( 'Tag Manager', 'Service name', 'google-site-kit' ),
'description' => __( 'Tag Manager creates an easy to manage way to create tags on your site without updating code', 'google-site-kit' ),
'homepage' => __( 'https://tagmanager.google.com/', 'google-site-kit' ),
);
}
/**
* Sets up the Google services the module should use.
*
* This method is invoked once by {@see Module::get_service()} to lazily set up the services when one is requested
* for the first time.
*
* @since 1.0.0
* @since 1.2.0 Now requires Google_Site_Kit_Client instance.
*
* @param Google_Site_Kit_Client $client Google client instance.
* @return array Google services as $identifier => $service_instance pairs. Every $service_instance must be an
* instance of Google_Service.
*/
protected function setup_services( Google_Site_Kit_Client $client ) {
return array(
'tagmanager' => new Google_Service_TagManager( $client ),
);
}
/**
* Sets up the module's settings instance.
*
* @since 1.2.0
*
* @return Module_Settings
*/
protected function setup_settings() {
return new Settings( $this->options );
}
/**
* Sets up the module's assets to register.
*
* @since 1.11.0
*
* @return Asset[] List of Asset objects.
*/
protected function setup_assets() {
$base_url = $this->context->url( 'dist/assets/' );
$dependencies = array(
'googlesitekit-api',
'googlesitekit-data',
'googlesitekit-datastore-site',
'googlesitekit-modules',
'googlesitekit-vendor',
'googlesitekit-components',
);
$analytics_exists = apply_filters( 'googlesitekit_module_exists', false, 'analytics-4' );
// Note that the Tag Manager bundle will make use of the Analytics bundle if it's available,
// but can also function without it, hence the conditional include of the Analytics bundle here.
if ( $analytics_exists ) {
$dependencies[] = 'googlesitekit-modules-analytics-4';
}
return array(
new Script(
'googlesitekit-modules-tagmanager',
array(
'src' => $base_url . 'js/googlesitekit-modules-tagmanager.js',
'dependencies' => $dependencies,
)
),
);
}
/**
* Registers the Tag Manager tag.
*
* @since 1.24.0
* @since 1.119.0 Made method public.
*/
public function register_tag() {
$is_amp = $this->context->is_amp();
$module_settings = $this->get_settings();
$settings = $module_settings->get();
$tag = $is_amp
? new AMP_Tag( $settings['ampContainerID'], self::MODULE_SLUG )
: new Web_Tag( $settings['containerID'], self::MODULE_SLUG );
if ( ! $tag->is_tag_blocked() ) {
$tag->use_guard( new Tag_Verify_Guard( $this->context->input() ) );
$tag->use_guard( new Tag_Guard( $module_settings, $is_amp ) );
$tag->use_guard( new Tag_Environment_Type_Guard() );
if ( $tag->can_register() ) {
$tag->register();
}
}
}
/**
* Returns the Module_Tag_Matchers instance.
*
* @since 1.119.0
*
* @return Module_Tag_Matchers Module_Tag_Matchers instance.
*/
public function get_tag_matchers() {
return new Tag_Matchers();
}
/**
* Checks if the current user has access to the current configured service entity.
*
* @since 1.77.0
*
* @return boolean|WP_Error
*/
public function check_service_entity_access() {
$is_amp_mode = in_array( $this->context->get_amp_mode(), array( Context::AMP_MODE_PRIMARY, Context::AMP_MODE_SECONDARY ), true );
$settings = $this->get_settings()->get();
$account_id = $settings['accountID'];
$configured_containers = $is_amp_mode ? array( $settings['containerID'], $settings['ampContainerID'] ) : array( $settings['containerID'] );
try {
$containers = $this->get_tagmanager_service()->accounts_containers->listAccountsContainers( "accounts/{$account_id}" );
} catch ( Exception $e ) {
if ( $e->getCode() === 404 ) {
return false;
}
return $this->exception_to_error( $e );
}
$all_containers = array_map(
function ( $container ) {
return $container->getPublicId();
},
$containers->getContainer()
);
return empty( array_diff( $configured_containers, $all_containers ) );
}
}