Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Analytics class

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Controls the basic analytics methods for Popup Maker

[13] Fix | Delete

[14] Fix | Delete

class PUM_Analytics {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Initializes analytics endpoints and data

[18] Fix | Delete

[19] Fix | Delete

public static function init() {

[20] Fix | Delete

if ( ! self::analytics_enabled() ) {

[21] Fix | Delete

return;

[22] Fix | Delete

}

[23] Fix | Delete

[24] Fix | Delete

add_action( 'rest_api_init', [ __CLASS__, 'register_endpoints' ] );

[25] Fix | Delete

add_action( 'wp_ajax_pum_analytics', [ __CLASS__, 'ajax_request' ] );

[26] Fix | Delete

add_action( 'wp_ajax_nopriv_pum_analytics', [ __CLASS__, 'ajax_request' ] );

[27] Fix | Delete

add_filter( 'pum_vars', [ __CLASS__, 'pum_vars' ] );

[28] Fix | Delete

}

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Checks whether analytics is enabled.

[32] Fix | Delete

[33] Fix | Delete

* @return bool

[34] Fix | Delete

[35] Fix | Delete

public static function analytics_enabled() {

[36] Fix | Delete

$disabled = pum_get_option( 'disable_analytics' ) || popmake_get_option( 'disable_popup_open_tracking' );

[37] Fix | Delete

[38] Fix | Delete

return (bool) apply_filters( 'pum_analytics_enabled', ! $disabled );

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Get a list of key pairs for each event type.

[43] Fix | Delete

* Internally used only for meta keys.

[44] Fix | Delete

[45] Fix | Delete

* Example returns [[open,opened],[conversion,conversion]].

[46] Fix | Delete

[47] Fix | Delete

* Usage examples:

[48] Fix | Delete

* - popup_open_count, popup_last_opened

[49] Fix | Delete

* - popup_conversion_count, popup_last_conversion

[50] Fix | Delete

[51] Fix | Delete

* @param string $event Event key.

[52] Fix | Delete

[53] Fix | Delete

* @return mixed

[54] Fix | Delete

[55] Fix | Delete

public static function event_keys( $event ) {

[56] Fix | Delete

$keys = [ $event, rtrim( $event, 'e' ) . 'ed' ];

[57] Fix | Delete

[58] Fix | Delete

if ( 'conversion' === $event ) {

[59] Fix | Delete

$keys[1] = 'conversion';

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

return apply_filters( 'pum_analytics_event_keys', $keys, $event );

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Returns an array of valid event types.

[67] Fix | Delete

[68] Fix | Delete

* @return string[]

[69] Fix | Delete

[70] Fix | Delete

public static function valid_events() {

[71] Fix | Delete

return apply_filters( 'pum_analytics_valid_events', [ 'open', 'conversion' ] );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Track an event.

[76] Fix | Delete

[77] Fix | Delete

* This is called by various methods including the ajax & rest api requests.

[78] Fix | Delete

[79] Fix | Delete

* Can be used externally such as after purchase tracking.

[80] Fix | Delete

[81] Fix | Delete

* @param array $args

[82] Fix | Delete

[83] Fix | Delete

public static function track( $args = [] ) {

[84] Fix | Delete

if ( empty( $args['pid'] ) || $args['pid'] <= 0 ) {

[85] Fix | Delete

return;

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

// $uuid = isset( $_COOKIE['__pum'] ) ? sanitize_text_field( $_COOKIE['__pum'] ) : false;

[89] Fix | Delete

// $session = $uuid && isset( $_COOKIE[ $uuid ] ) ? PUM_Utils_Array::safe_json_decode( $_COOKIE[ $uuid ] ) : false;

[90] Fix | Delete

[91] Fix | Delete

$event = sanitize_text_field( $args['event'] );

[92] Fix | Delete

[93] Fix | Delete

$popup = pum_get_popup( $args['pid'] );

[94] Fix | Delete

[95] Fix | Delete

if ( ! pum_is_popup( $popup ) || ! in_array( $event, self::valid_events(), true ) ) {

[96] Fix | Delete

return;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

$popup->increase_event_count( $event );

[100] Fix | Delete

[101] Fix | Delete

if ( has_action( 'pum_analytics_' . $event ) ) {

[102] Fix | Delete

do_action( 'pum_analytics_' . $event, $popup->ID, $args );

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

do_action( 'pum_analytics_event', $args );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Process ajax requests.

[110] Fix | Delete

[111] Fix | Delete

* Only used when WP-JSON Restful API is not available.

[112] Fix | Delete

[113] Fix | Delete

public static function ajax_request() {

[114] Fix | Delete

[115] Fix | Delete

$args = wp_parse_args(

[116] Fix | Delete

$_REQUEST,

[117] Fix | Delete

[

[118] Fix | Delete

'event' => null,

[119] Fix | Delete

'pid' => null,

[120] Fix | Delete

'method' => null,

[121] Fix | Delete

]

[122] Fix | Delete

);

[123] Fix | Delete

[124] Fix | Delete

self::track( $args );

[125] Fix | Delete

[126] Fix | Delete

switch ( $args['method'] ) {

[127] Fix | Delete

case 'image':

[128] Fix | Delete

self::serve_pixel();

[129] Fix | Delete

break;

[130] Fix | Delete

[131] Fix | Delete

case 'json':

[132] Fix | Delete

self::serve_json();

[133] Fix | Delete

break;

[134] Fix | Delete

[135] Fix | Delete

default:

[136] Fix | Delete

self::serve_no_content();

[137] Fix | Delete

break;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* @param WP_REST_Request $request

[144] Fix | Delete

[145] Fix | Delete

* @return WP_Error|mixed

[146] Fix | Delete

[147] Fix | Delete

public static function analytics_endpoint( WP_REST_Request $request ) {

[148] Fix | Delete

$args = $request->get_params();

[149] Fix | Delete

[150] Fix | Delete

if ( ! $args || empty( $args['pid'] ) ) {

[151] Fix | Delete

return new WP_Error( 'missing_params', __( 'Missing Parameters.' ), [ 'status' => 404 ] );

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

self::track( $args );

[155] Fix | Delete

[156] Fix | Delete

self::serve_no_content();

[157] Fix | Delete

[158] Fix | Delete

return true;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* @param $param

[163] Fix | Delete

[164] Fix | Delete

* @return bool

[165] Fix | Delete

[166] Fix | Delete

public static function endpoint_absint( $param ) {

[167] Fix | Delete

return is_numeric( $param );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Registers the analytics endpoints

[172] Fix | Delete

[173] Fix | Delete

public static function register_endpoints() {

[174] Fix | Delete

register_rest_route(

[175] Fix | Delete

self::get_analytics_namespace(),

[176] Fix | Delete

self::get_analytics_route(),

[177] Fix | Delete

apply_filters(

[178] Fix | Delete

'pum_analytics_rest_route_args',

[179] Fix | Delete

[

[180] Fix | Delete

'methods' => 'GET',

[181] Fix | Delete

'callback' => [ __CLASS__, 'analytics_endpoint' ],

[182] Fix | Delete

'permission_callback' => '__return_true',

[183] Fix | Delete

'args' => [

[184] Fix | Delete

'event' => [

[185] Fix | Delete

'required' => true,

[186] Fix | Delete

'description' => __( 'Event Type', 'popup-maker' ),

[187] Fix | Delete

'type' => 'string',

[188] Fix | Delete

[189] Fix | Delete

'pid' => [

[190] Fix | Delete

'required' => true,

[191] Fix | Delete

'description' => __( 'Popup ID', 'popup-maker' ),

[192] Fix | Delete

'type' => 'integer',

[193] Fix | Delete

'validation_callback' => [ __CLASS__, 'endpoint_absint' ],

[194] Fix | Delete

'sanitize_callback' => 'absint',

[195] Fix | Delete

[196] Fix | Delete

[197] Fix | Delete

]

[198] Fix | Delete

)

[199] Fix | Delete

);

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Adds our analytics endpoint to pum_vars

[204] Fix | Delete

[205] Fix | Delete

* @param array $vars The current pum_vars.

[206] Fix | Delete

* @return array The updates pum_vars

[207] Fix | Delete

[208] Fix | Delete

public static function pum_vars( $vars = [] ) {

[209] Fix | Delete

$vars['analytics_route'] = self::get_analytics_route();

[210] Fix | Delete

if ( function_exists( 'rest_url' ) ) {

[211] Fix | Delete

$vars['analytics_api'] = esc_url_raw( rest_url( self::get_analytics_namespace() ) );

[212] Fix | Delete

} else {

[213] Fix | Delete

$vars['analytics_api'] = false;

[214] Fix | Delete

}

[215] Fix | Delete

return $vars;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Gets the analytics namespace

[220] Fix | Delete

[221] Fix | Delete

* If bypass adblockers is enabled, will return random or custom string. If not, returns 'pum/v1'.

[222] Fix | Delete

[223] Fix | Delete

* @return string The analytics namespce

[224] Fix | Delete

* @since 1.13.0

[225] Fix | Delete

[226] Fix | Delete

public static function get_analytics_namespace() {

[227] Fix | Delete

$version = 1;

[228] Fix | Delete

$namespace = self::customize_endpoint_value( 'pum' );

[229] Fix | Delete

return "$namespace/v$version";

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Gets the analytics route

[234] Fix | Delete

[235] Fix | Delete

* If bypass adblockers is enabled, will return random or custom string. If not, returns 'analytics'.

[236] Fix | Delete

[237] Fix | Delete

* @return string The analytics route

[238] Fix | Delete

* @since 1.13.0

[239] Fix | Delete

[240] Fix | Delete

public static function get_analytics_route() {

[241] Fix | Delete

$route = 'analytics';

[242] Fix | Delete

return self::customize_endpoint_value( $route );

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Customizes the endpoint value given to it

[247] Fix | Delete

[248] Fix | Delete

* If bypass adblockers is enabled, will return random or custom string. If not, returns the value given to it.

[249] Fix | Delete

[250] Fix | Delete

* @param string $value The value to, potentially, customize.

[251] Fix | Delete

* @return string

[252] Fix | Delete

* @since 1.13.0

[253] Fix | Delete

[254] Fix | Delete

public static function customize_endpoint_value( $value = '' ) {

[255] Fix | Delete

$bypass_adblockers = pum_get_option( 'bypass_adblockers', false );

[256] Fix | Delete

if ( true === $bypass_adblockers || 1 === intval( $bypass_adblockers ) ) {

[257] Fix | Delete

switch ( pum_get_option( 'adblock_bypass_url_method', 'random' ) ) {

[258] Fix | Delete

case 'custom':

[259] Fix | Delete

$value = preg_replace( '/[^a-z0-9]+/', '-', pum_get_option( 'adblock_bypass_custom_filename', $value ) );

[260] Fix | Delete

break;

[261] Fix | Delete

case 'random':

[262] Fix | Delete

default:

[263] Fix | Delete

$site_url = get_site_url();

[264] Fix | Delete

$value = md5( $site_url . $value );

[265] Fix | Delete

break;

[266] Fix | Delete

}

[267] Fix | Delete

}

[268] Fix | Delete

return $value;

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

/**

[272] Fix | Delete

* Creates and returns a 1x1 tracking gif to the browser.

[273] Fix | Delete

[274] Fix | Delete

public static function serve_pixel() {

[275] Fix | Delete

$gif = self::get_file( Popup_Maker::$DIR . 'assets/images/beacon.gif' );

[276] Fix | Delete

header( 'Content-Type: image/gif' );

[277] Fix | Delete

header( 'Content-Length: ' . strlen( $gif ) );

[278] Fix | Delete

exit( $gif );

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

/**

[282] Fix | Delete

* @param $path

[283] Fix | Delete

[284] Fix | Delete

* @return bool|string

[285] Fix | Delete

[286] Fix | Delete

public static function get_file( $path ) {

[287] Fix | Delete

[288] Fix | Delete

if ( function_exists( 'realpath' ) ) {

[289] Fix | Delete

$path = realpath( $path );

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

if ( ! $path || ! @is_file( $path ) ) {

[293] Fix | Delete

return '';

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

return @file_get_contents( $path );

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

/**

[300] Fix | Delete

* Returns a 204 no content header.

[301] Fix | Delete

[302] Fix | Delete

public static function serve_no_content() {

[303] Fix | Delete

header( 'HTTP/1.0 204 No Content' );

[304] Fix | Delete

header( 'Content-Type: image/gif' );

[305] Fix | Delete

header( 'Content-Length: 0' );

[306] Fix | Delete

exit;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* Serves a proper json response.

[311] Fix | Delete

[312] Fix | Delete

* @param mixed $data

[313] Fix | Delete

[314] Fix | Delete

public static function serve_json( $data = 0 ) {

[315] Fix | Delete

header( 'Content-Type: application/json' );

[316] Fix | Delete

echo PUM_Utils_Array::safe_json_encode( $data );

[317] Fix | Delete

exit;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete