1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<?php
/**
* Nosara Tracks for WooCommerce
*
* @package WooCommerce\Tracks
*/
defined( 'ABSPATH' ) || exit;
/**
* This class adds actions to track usage of WooCommerce.
*/
class WC_Site_Tracking {
/**
* Check if tracking is enabled.
*
* @return bool
*/
public static function is_tracking_enabled() {
/**
* Don't track users if a filter has been applied to turn it off.
* `woocommerce_apply_tracking` will be deprecated. Please use
* `woocommerce_apply_user_tracking` instead.
*
* @since 3.6.0
*/
if ( ! apply_filters( 'woocommerce_apply_user_tracking', true ) || ! apply_filters( 'woocommerce_apply_tracking', true ) ) {
return false;
}
// Check if tracking is actively being opted into.
$is_obw_opting_in = isset( $_POST['wc_tracker_checkbox'] ) && 'yes' === sanitize_text_field( $_POST['wc_tracker_checkbox'] ); // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput
/**
* Don't track users who haven't opted-in to tracking or aren't in
* the process of opting-in.
*/
if ( 'yes' !== get_option( 'woocommerce_allow_tracking' ) && ! $is_obw_opting_in ) {
return false;
}
if ( ! class_exists( 'WC_Tracks' ) ) {
return false;
}
return true;
}
/**
* Register scripts required to record events from javascript.
*/
public static function register_scripts() {
wp_register_script( 'woo-tracks', 'https://stats.wp.com/w.js', array( 'wp-hooks' ), gmdate( 'YW' ), false );
}
/**
* Add scripts required to record events from javascript.
*/
public static function enqueue_scripts() {
wp_enqueue_script( 'woo-tracks' );
}
/**
* Adds the tracking function to the admin footer.
*/
public static function add_tracking_function() {
$user = wp_get_current_user();
$server_details = WC_Tracks::get_server_details();
$blog_details = WC_Tracks::get_blog_details( $user->ID );
$tracks_identity = WC_Tracks_Client::get_identity( $user->ID );
$role_details = WC_Tracks::get_role_details( $user );
$client_tracking_properties = array_merge( $server_details, $blog_details, $role_details );
/**
* Add global tracks event properties.
*
* @since 6.5.0
*/
$filtered_properties = apply_filters( 'woocommerce_tracks_event_properties', $client_tracking_properties, false );
$environment_type = function_exists( 'wp_get_environment_type' ) ? wp_get_environment_type() : 'production';
?>
<!-- WooCommerce Tracks -->
<script type="text/javascript">
window.wcTracks = window.wcTracks || {};
window.wcTracks.isEnabled = <?php echo self::is_tracking_enabled() ? 'true' : 'false'; ?>;
window._tkq = window._tkq || [];
<?php if ( 'anon' !== $tracks_identity['_ut'] ) { ?>
window._tkq.push( [ 'identifyUser', '<?php echo esc_js( $tracks_identity['_ui'] ); ?>' ] );
<?php } ?>
window.wcTracks.validateEvent = function( eventName, props = {} ) {
let isValid = true;
if ( ! <?php echo esc_js( WC_Tracks_Event::EVENT_NAME_REGEX ); ?>.test( eventName ) ) {
if ( <?php echo $environment_type !== 'production' ? 'true' : 'false'; ?> ) {
/* eslint-disable no-console */
console.error(
`A valid event name must be specified. The event name: "${ eventName }" is not valid.`
);
/* eslint-enable no-console */
}
isValid = false;
}
for ( const prop of Object.keys( props ) ) {
if ( ! <?php echo esc_js( WC_Tracks_Event::PROP_NAME_REGEX ); ?>.test( prop ) ) {
if ( <?php echo $environment_type !== 'production' ? 'true' : 'false'; ?> ) {
/* eslint-disable no-console */
console.error(
`A valid prop name must be specified. The property name: "${ prop }" is not valid.`
);
/* eslint-enable no-console */
}
isValid = false;
}
}
return isValid;
}
window.wcTracks.recordEvent = function( name, properties ) {
if ( ! window.wcTracks.isEnabled ) {
return;
}
const eventName = '<?php echo esc_attr( WC_Tracks::PREFIX ); ?>' + name;
let eventProperties = properties || {};
eventProperties = { ...eventProperties, ...<?php echo json_encode( $filtered_properties ); ?> };
if ( window.wp && window.wp.hooks && window.wp.hooks.applyFilters ) {
eventProperties = window.wp.hooks.applyFilters( 'woocommerce_tracks_client_event_properties', eventProperties, eventName );
delete( eventProperties._ui );
delete( eventProperties._ut );
}
if ( ! window.wcTracks.validateEvent( eventName, eventProperties ) ) {
return;
}
window._tkq.push( [ 'recordEvent', eventName, eventProperties ] );
}
</script>
<?php
}
/**
* Adds a function to load tracking scripts and enable them client-side on the fly.
* Note that this function does not update `woocommerce_allow_tracking` in the database
* and will not persist enabled tracking across page loads.
*/
public static function add_enable_tracking_function() {
global $wp_scripts;
if ( ! isset( $wp_scripts->registered['woo-tracks'] ) ) {
return;
}
$woo_tracks_script = $wp_scripts->registered['woo-tracks']->src;
?>
<script type="text/javascript">
window.wcTracks.enable = function( callback ) {
window.wcTracks.isEnabled = true;
var scriptUrl = '<?php echo esc_url( $woo_tracks_script ); ?>';
var existingScript = document.querySelector( `script[src="${ scriptUrl }"]` );
if ( existingScript ) {
return;
}
var script = document.createElement('script');
script.src = scriptUrl;
document.body.append(script);
// Callback after scripts have loaded.
script.onload = function() {
if ( 'function' === typeof callback ) {
callback( true );
}
}
// Callback triggered if the script fails to load.
script.onerror = function() {
if ( 'function' === typeof callback ) {
callback( false );
}
}
}
</script>
<?php
}
/**
* Init tracking.
*/
public static function init() {
// Define window.wcTracks.recordEvent in case it is enabled client-side.
self::register_scripts();
add_filter( 'admin_footer', array( __CLASS__, 'add_tracking_function' ), 24 );
if ( ! self::is_tracking_enabled() ) {
add_filter( 'admin_footer', array( __CLASS__, 'add_enable_tracking_function' ), 24 );
return;
}
self::enqueue_scripts();
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-admin-setup-wizard-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-extensions-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-importer-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-products-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-orders-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-settings-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-status-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-coupons-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-order-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-coupon-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-theme-tracking.php';
include_once WC_ABSPATH . 'includes/tracks/events/class-wc-product-collection-block-tracking.php';
$tracking_classes = array(
'WC_Extensions_Tracking',
'WC_Importer_Tracking',
'WC_Products_Tracking',
'WC_Orders_Tracking',
'WC_Settings_Tracking',
'WC_Status_Tracking',
'WC_Coupons_Tracking',
'WC_Order_Tracking',
'WC_Coupon_Tracking',
'WC_Theme_Tracking',
'WC_Product_Collection_Block_Tracking',
);
foreach ( $tracking_classes as $tracking_class ) {
$tracker_instance = new $tracking_class();
$tracker_init_method = array( $tracker_instance, 'init' );
if ( is_callable( $tracker_init_method ) ) {
call_user_func( $tracker_init_method );
}
}
}
/**
* Sets a cookie for tracking purposes, but only if tracking is enabled/allowed.
*
* @internal
* @since 9.2.0
*
* @param string $cookie_key The key of the cookie.
* @param string $cookie_value The value of the cookie.
* @param int $expire Expiry of the cookie.
* @param bool $secure Whether the cookie should be served only over https.
* @param bool $http_only Whether the cookie is only accessible over HTTP.
*
* @return bool If setting the cookie was attempted (will be false if tracking is not allowed).
*/
public static function set_tracking_cookie( string $cookie_key, string $cookie_value, int $expire = 0, bool $secure = false, bool $http_only = false ): bool {
if ( self::is_tracking_enabled() ) {
wc_setcookie( $cookie_key, $cookie_value, $expire, $secure, $http_only );
return true;
}
return false;
}
}
|