Skip to content

Prevent dynamic data from being output on cached pages #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Prevent dynamic data from being output on cached pages #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
define( 'GTM_SERVER_SIDE_ADMIN_GROUP_GENERAL', 'gtm-server-side-admin-group-general' );
define( 'GTM_SERVER_SIDE_ADMIN_GROUP_DATA_LAYER', 'gtm-server-side-admin-group-data-layer' );
define( 'GTM_SERVER_SIDE_ADMIN_GROUP_WEBHOOKS', 'gtm-server-side-admin-group-webhooks' );
define( 'GTM_SENSITIVE_DATA_NOTICE', '<!-- DO NOT CACHE -->' );

// Autoload plugin classes.
spl_autoload_register(
Expand Down
4 changes: 2 additions & 2 deletions includes/class-gtm-server-side-admin-settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ function() {
' . checked( GTM_Server_Side_Helpers::get_option( GTM_SERVER_SIDE_FIELD_DATA_LAYER_ECOMMERCE ), 'yes', false ) . '
value="yes">';
echo '<br>';
esc_html_e( 'This option only works with Woocommerce shops. Adds basic events and their data: Login, SignUp, ViewItem, AddToCart, BeginCheckout, Purchase.', 'gtm-server-side' );
esc_html_e( 'This option only works with Woocommerce shops. Adds basic events and their data: Login, SignUp, ViewItem, AddToCart, BeginCheckout, Purchase. On cached websites ensure to implement gtm_server_side_is_page_cached filter.', 'gtm-server-side' );
},
GTM_SERVER_SIDE_ADMIN_SLUG,
GTM_SERVER_SIDE_ADMIN_GROUP_DATA_LAYER
Expand All @@ -295,7 +295,7 @@ function() {
' . checked( GTM_Server_Side_Helpers::get_option( GTM_SERVER_SIDE_FIELD_DATA_LAYER_USER_DATA ), 'yes', false ) . '
value="yes">';
echo '<br>';
esc_html_e( 'All events for authorised users will have their personal details (name, surname, email, etc.) available. Their billing details will be available on the purchase event.', 'gtm-server-side' );
esc_html_e( 'All events for authorised users on uncached pages, will have their personal details (name, surname, email, etc.) available. Their billing details will be available on the purchase event. Page is marked as cached using `gtm_server_side_is_page_cached` filter.', 'gtm-server-side' );
},
GTM_SERVER_SIDE_ADMIN_SLUG,
GTM_SERVER_SIDE_ADMIN_GROUP_DATA_LAYER
Expand Down
7 changes: 6 additions & 1 deletion includes/class-gtm-server-side-event-begincheckout.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ public function init() {
* @return void
*/
public function wp_footer() {
if ( ! GTM_Server_Side_Helpers::can_output_sensitive_data() ) {
return;
}

if ( ! is_checkout() ) {
return;
}
Expand All @@ -55,9 +59,10 @@ public function wp_footer() {
),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
}
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<script type="text/javascript">
dataLayer.push( { ecommerce: null } );
Expand Down
9 changes: 7 additions & 2 deletions includes/class-gtm-server-side-event-login.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ public function wp_login() {
* @return void
*/
public function wp_footer() {
if ( ! GTM_Server_Side_Helpers::can_output_sensitive_data() ) {
return;
}

if ( ! GTM_Server_Side_Helpers::exists_session( self::CHECK_NAME, GTM_SERVER_SIDE_FIELD_VALUE_YES ) ) {
return;
}
Expand All @@ -60,10 +64,11 @@ public function wp_footer() {
'event' => GTM_Server_Side_Helpers::get_data_layer_event_name( 'login' ),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
}
?>
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<script type="text/javascript">
dataLayer.push( { ecommerce: null } );
dataLayer.push(<?php echo GTM_Server_Side_Helpers::array_to_json( $data_layer ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>);
Expand Down
7 changes: 6 additions & 1 deletion includes/class-gtm-server-side-event-purchase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ public function woocommerce_new_order( $order_id ) {
* @return void
*/
public function wp_footer() {
if ( ! GTM_Server_Side_Helpers::can_output_sensitive_data() ) {
return;
}

/* phpcs:ignore
if ( ! is_wc_endpoint_url( 'order-received' ) ) {
return;
Expand Down Expand Up @@ -97,10 +101,11 @@ public function wp_footer() {
),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_order_user_data( $order );
$data_layer['user_data']['new_customer'] = GTM_Server_Side_WC_Helpers::instance()->is_new_customer( $order->get_customer_id() ) ? 'true' : 'false';
}
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<script type="text/javascript">
dataLayer.push( { ecommerce: null } );
Expand Down
7 changes: 6 additions & 1 deletion includes/class-gtm-server-side-event-register.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ public function user_register() {
* @return void
*/
public function wp_footer() {
if ( ! GTM_Server_Side_Helpers::can_output_sensitive_data() ) {
return;
}

if ( ! GTM_Server_Side_Helpers::exists_session( self::CHECK_NAME, GTM_SERVER_SIDE_FIELD_VALUE_YES ) ) {
return;
}
Expand All @@ -60,9 +64,10 @@ public function wp_footer() {
'event' => GTM_Server_Side_Helpers::get_data_layer_event_name( 'sign_up' ),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
}
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<script type="text/javascript">
dataLayer.push( { ecommerce: null } );
Expand Down
6 changes: 5 additions & 1 deletion includes/class-gtm-server-side-event-viewcart.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ public function init() {
* @return void
*/
public function wp_footer() {
if ( ! GTM_Server_Side_Helpers::can_output_sensitive_data() ) {
return;
}
if ( ! is_cart() ) {
return;
}
Expand All @@ -56,9 +59,10 @@ public function wp_footer() {
),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
}
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<script type="text/javascript">
dataLayer.push( { ecommerce: null } );
Expand Down
3 changes: 2 additions & 1 deletion includes/class-gtm-server-side-event-viewitem.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ public function wp_footer() {
),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
?>
<script type="text/javascript">
Expand Down
3 changes: 2 additions & 1 deletion includes/class-gtm-server-side-event-viewitemlist.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ public function wp_footer() {
),
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$data_layer['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
?>
<script type="text/javascript">
Expand Down
3 changes: 2 additions & 1 deletion includes/class-gtm-server-side-frontend-assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ public function wp_enqueue_scripts() {
'DATA_LAYER_CUSTOM_EVENT_NAME' => GTM_SERVER_SIDE_DATA_LAYER_CUSTOM_EVENT_NAME,
);

if ( GTM_Server_Side_WC_Helpers::instance()->is_enable_user_data() ) {
if ( GTM_Server_Side_WC_Helpers::instance()->should_output_user_data() ) {
$scripts['user_data'] = GTM_Server_Side_WC_Helpers::instance()->get_data_layer_user_data();
echo GTM_SENSITIVE_DATA_NOTICE; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}

wp_localize_script( 'gtm-server-side', 'varGtmServerSide', $scripts );
Expand Down
29 changes: 29 additions & 0 deletions includes/class-gtm-server-side-helpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ class GTM_Server_Side_Helpers {
*/
private static $is_stape_analytics_support;

/**
* Cache detection result.
*
* @var bool|null
*/
private static $is_page_cached;

/**
* Get attr option.
*
Expand Down Expand Up @@ -620,4 +627,26 @@ public static function get_cache_field( $key, $callback ) {
public static function delete_cache_field( $key ) {
delete_transient( $key . '__generated' );
}

/**
* Check if the current page is cached.
*
* @return bool
*/
public static function is_page_cached() {
if ( null === static::$is_page_cached ) {
static::$is_page_cached = apply_filters( 'gtm_server_side_is_page_cached', false );
}

return static::$is_page_cached;
}

/**
* Check if sensitive data can be output (not on cached pages).
*
* @return bool
*/
public static function can_output_sensitive_data() {
return ! static::is_page_cached();
}
}
9 changes: 9 additions & 0 deletions includes/class-gtm-server-side-wc-helpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,15 @@ public function is_enable_user_data() {
return function_exists( 'WC' ) && ( WC()->customer instanceof WC_Customer ) && GTM_Server_Side_Helpers::is_enable_data_layer_user_data();
}

/**
* Check if user data can be output (considering cache protection).
*
* @return bool
*/
public function should_output_user_data() {
return $this->is_enable_user_data() && GTM_Server_Side_Helpers::can_output_sensitive_data();
}

/**
* Return formatted price
*
Expand Down