<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Telemetry class

[2] Fix | Delete

*

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

* @copyright Copyright (c) 2023, Code Atlantic LLC

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

// Exit if accessed directly.

[9] Fix | Delete

exit;

[10] Fix | Delete

}

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Our telemetry class.

[14] Fix | Delete

*

[15] Fix | Delete

* Handles sending usage data back to our servers for those who have opted into our telemetry.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.11.0

[18] Fix | Delete

*/

[19] Fix | Delete

class PUM_Telemetry {

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Initialization method

[23] Fix | Delete

*/

[24] Fix | Delete

public static function init() {

[25] Fix | Delete

add_action( 'pum_daily_scheduled_events', [ __CLASS__, 'track_check' ] );

[26] Fix | Delete

if ( is_admin() && current_user_can( 'manage_options' ) ) {

[27] Fix | Delete

add_filter( 'pum_alert_list', [ __CLASS__, 'optin_alert' ] );

[28] Fix | Delete

add_action( 'pum_alert_dismissed', [ __CLASS__, 'optin_alert_check' ], 10, 2 );

[29] Fix | Delete

}

[30] Fix | Delete

}

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Prepares and sends data, if it is time to do so

[34] Fix | Delete

*

[35] Fix | Delete

* @since 1.11.0

[36] Fix | Delete

*/

[37] Fix | Delete

public static function track_check() {

[38] Fix | Delete

if ( self::is_time_to_send() ) {

[39] Fix | Delete

$data = self::setup_data();

[40] Fix | Delete

self::send_data( $data );

[41] Fix | Delete

set_transient( 'pum_tracking_last_send', true, 6 * DAY_IN_SECONDS );

[42] Fix | Delete

}

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Prepares telemetry data to be sent

[47] Fix | Delete

*

[48] Fix | Delete

* @return array

[49] Fix | Delete

* @since 1.11.0

[50] Fix | Delete

*/

[51] Fix | Delete

public static function setup_data() {

[52] Fix | Delete

global $wpdb;

[53] Fix | Delete

[54] Fix | Delete

// Retrieve current theme info.

[55] Fix | Delete

$theme_data = wp_get_theme();

[56] Fix | Delete

$theme = $theme_data->Name . ' ' . $theme_data->Version;

[57] Fix | Delete

[58] Fix | Delete

// Retrieve current plugin information.

[59] Fix | Delete

if ( ! function_exists( 'get_plugins' ) ) {

[60] Fix | Delete

include ABSPATH . '/wp-admin/includes/plugin.php';

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

$plugins = array_keys( get_plugins() );

[64] Fix | Delete

$active_plugins = get_option( 'active_plugins', [] );

[65] Fix | Delete

[66] Fix | Delete

foreach ( $plugins as $key => $plugin ) {

[67] Fix | Delete

if ( in_array( $plugin, $active_plugins ) ) {

[68] Fix | Delete

// Remove active plugins from list so we can show active and inactive separately.

[69] Fix | Delete

unset( $plugins[ $key ] );

[70] Fix | Delete

}

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

$popups = 0;

[74] Fix | Delete

foreach ( wp_count_posts( 'popup' ) as $status ) {

[75] Fix | Delete

$popups += $status;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

$popup_themes = 0;

[79] Fix | Delete

foreach ( wp_count_posts( 'popup_theme' ) as $status ) {

[80] Fix | Delete

$popup_themes += $status;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

// Aggregates important settings across all popups.

[84] Fix | Delete

$all_popups = pum_get_all_popups();

[85] Fix | Delete

$triggers = [];

[86] Fix | Delete

$cookies = [];

[87] Fix | Delete

$conditions = [];

[88] Fix | Delete

$location = [];

[89] Fix | Delete

$sizes = [];

[90] Fix | Delete

$sounds = [];

[91] Fix | Delete

[92] Fix | Delete

// Cycle through each popup.

[93] Fix | Delete

foreach ( $all_popups as $popup ) {

[94] Fix | Delete

$settings = PUM_Admin_Popups::parse_values( $popup->get_settings() );

[95] Fix | Delete

[96] Fix | Delete

// Cycle through each trigger to count the number of unique triggers.

[97] Fix | Delete

foreach ( $settings['triggers'] as $trigger ) {

[98] Fix | Delete

if ( isset( $triggers[ $trigger['type'] ] ) ) {

[99] Fix | Delete

$triggers[ $trigger['type'] ] += 1;

[100] Fix | Delete

} else {

[101] Fix | Delete

$triggers[ $trigger['type'] ] = 1;

[102] Fix | Delete

}

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

// Cycle through each cookie to count the number of unique cookie.

[106] Fix | Delete

foreach ( $settings['cookies'] as $cookie ) {

[107] Fix | Delete

if ( isset( $cookies[ $cookie['event'] ] ) ) {

[108] Fix | Delete

$cookies[ $cookie['event'] ] += 1;

[109] Fix | Delete

} else {

[110] Fix | Delete

$cookies[ $cookie['event'] ] = 1;

[111] Fix | Delete

}

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

// Cycle through each condition to count the number of unique condition.

[115] Fix | Delete

foreach ( $settings['conditions'] as $condition ) {

[116] Fix | Delete

foreach ( $condition as $target ) {

[117] Fix | Delete

if ( isset( $conditions[ $target['target'] ] ) ) {

[118] Fix | Delete

$conditions[ $target['target'] ] += 1;

[119] Fix | Delete

} else {

[120] Fix | Delete

$conditions[ $target['target'] ] = 1;

[121] Fix | Delete

}

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

// Add locations setting.

[126] Fix | Delete

if ( isset( $location[ $settings['location'] ] ) ) {

[127] Fix | Delete

$location[ $settings['location'] ] += 1;

[128] Fix | Delete

} else {

[129] Fix | Delete

$location[ $settings['location'] ] = 1;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

// Add size setting.

[133] Fix | Delete

if ( isset( $sizes[ $settings['size'] ] ) ) {

[134] Fix | Delete

$sizes[ $settings['size'] ] += 1;

[135] Fix | Delete

} else {

[136] Fix | Delete

$sizes[ $settings['size'] ] = 1;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

// Add opening sound setting.

[140] Fix | Delete

if ( isset( $sounds[ $settings['open_sound'] ] ) ) {

[141] Fix | Delete

$sounds[ $settings['open_sound'] ] += 1;

[142] Fix | Delete

} else {

[143] Fix | Delete

$sounds[ $settings['open_sound'] ] = 1;

[144] Fix | Delete

}

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

return [

[148] Fix | Delete

// UID.

[149] Fix | Delete

'uid' => self::get_uuid(),

[150] Fix | Delete

[151] Fix | Delete

// Language Info.

[152] Fix | Delete

'language' => get_bloginfo( 'language' ),

[153] Fix | Delete

'charset' => get_bloginfo( 'charset' ),

[154] Fix | Delete

[155] Fix | Delete

// Server Info.

[156] Fix | Delete

'php_version' => phpversion(),

[157] Fix | Delete

'mysql_version' => $wpdb->db_version(),

[158] Fix | Delete

'is_localhost' => self::is_localhost(),

[159] Fix | Delete

[160] Fix | Delete

// WP Install Info.

[161] Fix | Delete

'url' => get_site_url(),

[162] Fix | Delete

'version' => Popup_Maker::$VER,

[163] Fix | Delete

'wp_version' => get_bloginfo( 'version' ),

[164] Fix | Delete

'theme' => $theme,

[165] Fix | Delete

'active_plugins' => $active_plugins,

[166] Fix | Delete

'inactive_plugins' => array_values( $plugins ),

[167] Fix | Delete

[168] Fix | Delete

// Popup Metrics.

[169] Fix | Delete

'popups' => $popups,

[170] Fix | Delete

'popup_themes' => $popup_themes,

[171] Fix | Delete

'open_count' => get_option( 'pum_total_open_count', 0 ),

[172] Fix | Delete

[173] Fix | Delete

// Popup Maker Settings.

[174] Fix | Delete

'block_editor_enabled' => pum_get_option( 'gutenberg_support_enabled' ),

[175] Fix | Delete

'bypass_ad_blockers' => pum_get_option( 'bypass_adblockers' ),

[176] Fix | Delete

'disable_taxonomies' => pum_get_option( 'disable_popup_category_tag' ),

[177] Fix | Delete

'disable_asset_cache' => pum_get_option( 'disable_asset_caching' ),

[178] Fix | Delete

'disable_open_tracking' => pum_get_option( 'disable_popup_open_tracking' ),

[179] Fix | Delete

'default_email_provider' => pum_get_option( 'newsletter_default_provider', 'none' ),

[180] Fix | Delete

[181] Fix | Delete

// Aggregate Popup Settings.

[182] Fix | Delete

'triggers' => $triggers,

[183] Fix | Delete

'cookies' => $cookies,

[184] Fix | Delete

'conditions' => $conditions,

[185] Fix | Delete

'locations' => $location,

[186] Fix | Delete

'sizes' => $sizes,

[187] Fix | Delete

'sounds' => $sounds,

[188] Fix | Delete

];

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Sends check_in data

[193] Fix | Delete

*

[194] Fix | Delete

* @param array $data Telemetry data to send.

[195] Fix | Delete

* @since 1.11.0

[196] Fix | Delete

*/

[197] Fix | Delete

public static function send_data( $data = [] ) {

[198] Fix | Delete

self::api_call( 'check_in', $data );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Makes HTTP request to our API endpoint

[203] Fix | Delete

*

[204] Fix | Delete

* @param string $action The specific endpoint in our API.

[205] Fix | Delete

* @param array $data Any data to send in the body.

[206] Fix | Delete

* @return array|bool False if WP Error. Otherwise, array response from wp_remote_post.

[207] Fix | Delete

* @since 1.11.0

[208] Fix | Delete

*/

[209] Fix | Delete

public static function api_call( $action = '', $data = [] ) {

[210] Fix | Delete

$response = wp_remote_post(

[211] Fix | Delete

'https://api.wppopupmaker.com/wp-json/pmapi/v2/' . $action,

[212] Fix | Delete

[

[213] Fix | Delete

'method' => 'POST',

[214] Fix | Delete

'timeout' => 20,

[215] Fix | Delete

'redirection' => 5,

[216] Fix | Delete

'httpversion' => '1.1',

[217] Fix | Delete

'blocking' => false,

[218] Fix | Delete

'body' => $data,

[219] Fix | Delete

'user-agent' => 'POPMAKE/' . Popup_Maker::$VER . '; ' . get_site_url(),

[220] Fix | Delete

]

[221] Fix | Delete

);

[222] Fix | Delete

[223] Fix | Delete

if ( is_wp_error( $response ) ) {

[224] Fix | Delete

$error_message = $response->get_error_message();

[225] Fix | Delete

pum_log_message( sprintf( 'Cannot send telemetry data. Error received was: %s', esc_html( $error_message ) ) );

[226] Fix | Delete

return false;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

return $response;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Adds admin notice if we haven't asked before.

[234] Fix | Delete

*

[235] Fix | Delete

* @param array $alerts The alerts currently in the alert system.

[236] Fix | Delete

* @return array Alerts for the alert system.

[237] Fix | Delete

* @since 1.11.0

[238] Fix | Delete

*/

[239] Fix | Delete

public static function optin_alert( $alerts ) {

[240] Fix | Delete

if ( ! self::should_show_alert() ) {

[241] Fix | Delete

return $alerts;

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

$alerts[] = [

[245] Fix | Delete

'code' => 'pum_telemetry_notice',

[246] Fix | Delete

'type' => 'info',

[247] Fix | Delete

'message' => esc_html__( "We are constantly improving Popup Maker but that's difficult to do if we don't know how it's being used. Please allow data sharing so that we can receive a little information on how it is used. You can change this setting at any time on our Settings page. No user data is sent to our servers. No sensitive data is tracked.", 'popup-maker' ),

[248] Fix | Delete

'priority' => 10,

[249] Fix | Delete

'dismissible' => true,

[250] Fix | Delete

'global' => false,

[251] Fix | Delete

'actions' => [

[252] Fix | Delete

[

[253] Fix | Delete

'primary' => true,

[254] Fix | Delete

'type' => 'action',

[255] Fix | Delete

'action' => 'pum_optin_check_allow',

[256] Fix | Delete

'text' => __( 'Allow', 'popup-maker' ),

[257] Fix | Delete

],

[258] Fix | Delete

[

[259] Fix | Delete

'primary' => false,

[260] Fix | Delete

'type' => 'action',

[261] Fix | Delete

'action' => 'dismiss',

[262] Fix | Delete

'text' => __( 'Do not allow', 'popup-maker' ),

[263] Fix | Delete

],

[264] Fix | Delete

[

[265] Fix | Delete

'primary' => false,

[266] Fix | Delete

'type' => 'link',

[267] Fix | Delete

'action' => '',

[268] Fix | Delete

'href' => 'https://docs.wppopupmaker.com/article/528-the-data-the-popup-maker-plugin-collects',

[269] Fix | Delete

'text' => __( 'Learn more', 'popup-maker' ),

[270] Fix | Delete

],

[271] Fix | Delete

],

[272] Fix | Delete

];

[273] Fix | Delete

return $alerts;

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Checks if any options have been clicked from admin notices.

[278] Fix | Delete

*

[279] Fix | Delete

* @param string $code The code for the alert.

[280] Fix | Delete

* @param string $action Action taken on the alert.

[281] Fix | Delete

*

[282] Fix | Delete

* @since 1.11.0

[283] Fix | Delete

*/

[284] Fix | Delete

public static function optin_alert_check( $code, $action ) {

[285] Fix | Delete

if ( 'pum_telemetry_notice' === $code ) {

[286] Fix | Delete

if ( 'pum_optin_check_allow' === $action ) {

[287] Fix | Delete

pum_update_option( 'telemetry', true );

[288] Fix | Delete

}

[289] Fix | Delete

}

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Whether or not we should show optin alert

[294] Fix | Delete

*

[295] Fix | Delete

* @since 1.11.0

[296] Fix | Delete

* @return bool True if alert should be shown

[297] Fix | Delete

*/

[298] Fix | Delete

public static function should_show_alert() {

[299] Fix | Delete

return false === self::has_opted_in() && current_user_can( 'manage_options' ) && strtotime( self::get_installed_on() . ' +15 minutes' ) < time();

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Determines if it is time to send telemetry data.

[304] Fix | Delete

*

[305] Fix | Delete

* @return bool True if it is time.

[306] Fix | Delete

* @since 1.11.0

[307] Fix | Delete

*/

[308] Fix | Delete

public static function is_time_to_send() {

[309] Fix | Delete

[310] Fix | Delete

// Only send if admin has opted in.

[311] Fix | Delete

if ( ! self::has_opted_in() ) {

[312] Fix | Delete

return false;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

// Send a maximum of once per week.

[316] Fix | Delete

if ( get_transient( 'pum_tracking_last_send' ) ) {

[317] Fix | Delete

return false;

[318] Fix | Delete

}

[319] Fix | Delete

return true;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

/**

[323] Fix | Delete

* Wrapper to check if site has opted into telemetry

[324] Fix | Delete

*

[325] Fix | Delete

* @return bool True if has opted into telemetry

[326] Fix | Delete

* @since 1.11.0

[327] Fix | Delete

*/

[328] Fix | Delete

public static function has_opted_in() {

[329] Fix | Delete

return false !== pum_get_option( 'telemetry', false );

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* Get the datetime string for when PM was installed.

[334] Fix | Delete

*

[335] Fix | Delete

* @return string

[336] Fix | Delete

* @since 1.13.0

[337] Fix | Delete

*/

[338] Fix | Delete

public static function get_installed_on() {

[339] Fix | Delete

$installed_on = get_option( 'pum_installed_on', false );

[340] Fix | Delete

if ( ! $installed_on ) {

[341] Fix | Delete

$installed_on = current_time( 'mysql' );

[342] Fix | Delete

}

[343] Fix | Delete

return $installed_on;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Determines if the site is in a local environment

[348] Fix | Delete

*

[349] Fix | Delete

* @return bool True for local

[350] Fix | Delete

* @since 1.11.0

[351] Fix | Delete

*/

[352] Fix | Delete

public static function is_localhost() {

[353] Fix | Delete

$url = network_site_url( '/' );

[354] Fix | Delete

return stristr( $url, 'dev' ) !== false || stristr( $url, 'localhost' ) !== false || stristr( $url, ':8888' ) !== false;

[355] Fix | Delete

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

/**

[359] Fix | Delete

* Generates a new UUID for this site.

[360] Fix | Delete

*

[361] Fix | Delete

* @return string

[362] Fix | Delete

* @since 1.11.0

[363] Fix | Delete

*/

[364] Fix | Delete

public static function add_uuid() {

[365] Fix | Delete

$uuid = wp_generate_uuid4();

[366] Fix | Delete

update_option( 'pum_site_uuid', $uuid );

[367] Fix | Delete

return $uuid;

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

/**

[371] Fix | Delete

* Retrieves the site UUID

[372] Fix | Delete

*

[373] Fix | Delete

* @return string

[374] Fix | Delete

* @since 1.11.0

[375] Fix | Delete

*/

[376] Fix | Delete

public static function get_uuid() {

[377] Fix | Delete

$uuid = get_option( 'pum_site_uuid', false );

[378] Fix | Delete

if ( false === $uuid || ! wp_is_uuid( $uuid ) ) {

[379] Fix | Delete

$uuid = self::add_uuid();

[380] Fix | Delete

}

[381] Fix | Delete

return $uuid;

[382] Fix | Delete

}

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete