Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Handles Advanced Ads privacy settings.

[3] Fix | Delete

[4] Fix | Delete

class Advanced_Ads_Privacy {

[5] Fix | Delete

/**

[6] Fix | Delete

* Singleton instance of the plugin

[7] Fix | Delete

[8] Fix | Delete

* @var self

[9] Fix | Delete

[10] Fix | Delete

protected static $instance;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Module options

[14] Fix | Delete

[15] Fix | Delete

* @var null|array

[16] Fix | Delete

[17] Fix | Delete

protected $options;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Option key

[21] Fix | Delete

[22] Fix | Delete

* @const string

[23] Fix | Delete

[24] Fix | Delete

const OPTION_KEY = 'advanced-ads-privacy';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Initialize the module

[28] Fix | Delete

[29] Fix | Delete

private function __construct() {

[30] Fix | Delete

add_filter( 'advanced-ads-can-display', [ $this, 'can_display_by_consent' ], 10, 3 );

[31] Fix | Delete

[32] Fix | Delete

$this->options();

[33] Fix | Delete

[34] Fix | Delete

if ( ! empty( $this->options['enabled'] ) ) {

[35] Fix | Delete

add_filter( 'advanced-ads-activate-advanced-js', '__return_true' );

[36] Fix | Delete

[37] Fix | Delete

if ( $this->options['consent-method'] === 'iab_tcf_20' ) {

[38] Fix | Delete

add_filter( 'advanced-ads-output-final', [ $this, 'final_ad_output' ], 10, 2 );

[39] Fix | Delete

}

[40] Fix | Delete

}

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* If this ad is not image or dummy base64_encode the text.

[45] Fix | Delete

[46] Fix | Delete

* @param string $output The output string.

[47] Fix | Delete

* @param Advanced_Ads_Ad $ad The ad object.

[48] Fix | Delete

[49] Fix | Delete

* @return string

[50] Fix | Delete

[51] Fix | Delete

public function final_ad_output( $output, Advanced_Ads_Ad $ad ) {

[52] Fix | Delete

if (

[53] Fix | Delete

advads_is_amp()

[54] Fix | Delete

// Never encode image, dummy or group ads.

[55] Fix | Delete

|| ! $this->ad_type_needs_consent( $ad->type )

[56] Fix | Delete

// Consent is overridden, and this is not an AdSense ad, don't encode it.

[57] Fix | Delete

|| ( $ad->type !== 'adsense' && isset( $ad->options()['privacy']['ignore-consent'] ) )

[58] Fix | Delete

) {

[59] Fix | Delete

return $output;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

return $this->encode_ad( $output, $ad );

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Encode the ad output.

[67] Fix | Delete

[68] Fix | Delete

* @param string $output The output string.

[69] Fix | Delete

* @param Advanced_Ads_Ad $ad The ad object.

[70] Fix | Delete

[71] Fix | Delete

* @return string

[72] Fix | Delete

[73] Fix | Delete

public function encode_ad( $output, Advanced_Ads_Ad $ad ) {

[74] Fix | Delete

$data_attributes = [

[75] Fix | Delete

'id' => $ad->id,

[76] Fix | Delete

'bid' => get_current_blog_id(),

[77] Fix | Delete

];

[78] Fix | Delete

if ( ! empty( $ad->output['placement_id'] ) ) {

[79] Fix | Delete

$data_attributes['placement'] = $ad->output['placement_id'];

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Filter the data attributes and allow removing/adding attributes.

[84] Fix | Delete

* All attributes will be prefix with `data-` on output.

[85] Fix | Delete

[86] Fix | Delete

* @param array $data_attributes The default data attributes.

[87] Fix | Delete

* @param Advanced_Ads_Ad $ad The current ad.

[88] Fix | Delete

[89] Fix | Delete

$data_attributes = (array) apply_filters( 'advanced-ads-privacy-output-attributes', $data_attributes, $ad );

[90] Fix | Delete

[91] Fix | Delete

// convert the data-attributes array into a string.

[92] Fix | Delete

$attributes_string = '';

[93] Fix | Delete

array_walk( $data_attributes, static function( $value, $key ) use ( &$attributes_string ) {

[94] Fix | Delete

$attributes_string .= sprintf( ' data-%s="%s"', sanitize_key( $key ), esc_attr( $value ) );

[95] Fix | Delete

} );

[96] Fix | Delete

[97] Fix | Delete

return sprintf(

[98] Fix | Delete

'<script type="text/plain" data-tcf="waiting-for-consent"%s>%s</script>',

[99] Fix | Delete

$attributes_string,

[100] Fix | Delete

// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- we need to obfuscate the html (and maybe decode it in JS).

[101] Fix | Delete

base64_encode( $output )

[102] Fix | Delete

);

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Check if the current ad output is encoded.

[107] Fix | Delete

[108] Fix | Delete

* @param string $output The ad output.

[109] Fix | Delete

[110] Fix | Delete

* @return bool

[111] Fix | Delete

[112] Fix | Delete

public function is_ad_output_encoded( $output ) {

[113] Fix | Delete

return (bool) strpos( $output, 'data-tcf="waiting-for-consent"' );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Return an instance of Advanced_Ads_Privacy

[118] Fix | Delete

[119] Fix | Delete

* @return self

[120] Fix | Delete

[121] Fix | Delete

public static function get_instance() {

[122] Fix | Delete

// If the single instance hasn't been set, set it now.

[123] Fix | Delete

if ( null === self::$instance ) {

[124] Fix | Delete

self::$instance = new self();

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

return self::$instance;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Return module options

[132] Fix | Delete

[133] Fix | Delete

* @return array

[134] Fix | Delete

[135] Fix | Delete

public function options() {

[136] Fix | Delete

if ( ! isset( $this->options ) ) {

[137] Fix | Delete

$this->options = get_option( self::OPTION_KEY, [] );

[138] Fix | Delete

if ( isset( $this->options['enabled'] ) && empty( $this->options['consent-method'] ) ) {

[139] Fix | Delete

$this->options['enabled'] = false;

[140] Fix | Delete

}

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

return $this->options;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Check if ad can be displayed based on user's consent.

[148] Fix | Delete

[149] Fix | Delete

* @param bool $can_display Whether to display this ad.

[150] Fix | Delete

* @param Advanced_Ads_Ad $ad The ad object.

[151] Fix | Delete

* @param array $check_options Additional options passed to can_display.

[152] Fix | Delete

[153] Fix | Delete

* @return bool

[154] Fix | Delete

[155] Fix | Delete

public function can_display_by_consent( $can_display, Advanced_Ads_Ad $ad, $check_options ) {

[156] Fix | Delete

// already false, honor this.

[157] Fix | Delete

if ( ! $can_display ) {

[158] Fix | Delete

return $can_display;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

// passive cache busting enabled.

[162] Fix | Delete

if ( $check_options['passive_cache_busting'] ) {

[163] Fix | Delete

return true;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

// privacy module not active, bail early.

[167] Fix | Delete

if ( empty( $this->options['enabled'] ) ) {

[168] Fix | Delete

return true;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

// If consent is overriden for the ad.

[172] Fix | Delete

if ( ! empty( $ad->options()['privacy']['ignore-consent'] ) ) {

[173] Fix | Delete

return true;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

$consent_method = isset( $this->options['consent-method'] ) ? $this->options['consent-method'] : '';

[177] Fix | Delete

[178] Fix | Delete

// If the consent method is set to cookie and the ad type does not need consent.

[179] Fix | Delete

if ( $consent_method === 'custom' && ! $this->ad_type_needs_consent( $ad->type ) ) {

[180] Fix | Delete

return true;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

// If method is iab_tcf_20, always set to true, JS needs to decide whether to display ad or not.

[184] Fix | Delete

if ( $consent_method === 'iab_tcf_20' ) {

[185] Fix | Delete

return true;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

// Either personalized or non-personalized ad will be shown.

[189] Fix | Delete

if ( $ad->type === 'adsense' && ! empty( $this->options()['show-non-personalized-adsense'] ) ) {

[190] Fix | Delete

return true;

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

return $this->get_state() !== 'unknown';

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Check whether this ad_type needs consent.

[198] Fix | Delete

[199] Fix | Delete

* @param string $type The ad type.

[200] Fix | Delete

[201] Fix | Delete

* @return bool

[202] Fix | Delete

[203] Fix | Delete

public function ad_type_needs_consent( $type ) {

[204] Fix | Delete

return ! in_array( $type, [ 'image', 'dummy', 'group' ], true );

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* Check if consent is not needed or was given by the user.

[209] Fix | Delete

[210] Fix | Delete

* @return string

[211] Fix | Delete

* 'not_needed' - consent is not needed.

[212] Fix | Delete

* 'accepted' - consent was given.

[213] Fix | Delete

* 'unknown' - consent was not given yet.

[214] Fix | Delete

[215] Fix | Delete

public function get_state() {

[216] Fix | Delete

static $state;

[217] Fix | Delete

if ( is_null( $state ) ) {

[218] Fix | Delete

$state = $this->parse_state();

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

return $state;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Used by get_state() to parse the state of privacy/consent.

[226] Fix | Delete

[227] Fix | Delete

* @return string

[228] Fix | Delete

* 'not_needed' - consent is not needed.

[229] Fix | Delete

* 'accepted' - consent was given.

[230] Fix | Delete

* 'unknown' - consent was not given yet.

[231] Fix | Delete

[232] Fix | Delete

private function parse_state() {

[233] Fix | Delete

if ( empty( $this->options['enabled'] ) || advads_is_amp() ) {

[234] Fix | Delete

return 'not_needed';

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

$consent_method = isset( $this->options['consent-method'] ) ? $this->options['consent-method'] : '';

[238] Fix | Delete

switch ( $consent_method ) {

[239] Fix | Delete

case 'custom':

[240] Fix | Delete

$name = $this->options['custom-cookie-name'];

[241] Fix | Delete

if ( empty( $name ) ) {

[242] Fix | Delete

return 'not_needed';

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

if ( ! isset( $_COOKIE[ $name ] ) ) {

[246] Fix | Delete

return 'unknown';

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

$value = isset( $this->options['custom-cookie-value'] ) ? $this->options['custom-cookie-value'] : '';

[250] Fix | Delete

if (

[251] Fix | Delete

( $value === '' && $_COOKIE[ $name ] === '' )

[252] Fix | Delete

|| ( $value !== '' && strpos( $_COOKIE[ $name ], $value ) !== false )

[253] Fix | Delete

) {

[254] Fix | Delete

return 'accepted';

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

return 'unknown';

[258] Fix | Delete

case 'iab_tcf_20':

[259] Fix | Delete

default:

[260] Fix | Delete

return 'unknown';

[261] Fix | Delete

}

[262] Fix | Delete

}

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete