plugin.php
164 lines
| 1 | <?php |
| 2 | class Advanced_Ads_Privacy |
| 3 | { |
| 4 | /** |
| 5 | * Singleton instance of the plugin |
| 6 | * |
| 7 | * @var Advanced_Ads_Privacy |
| 8 | */ |
| 9 | protected static $instance; |
| 10 | |
| 11 | /** |
| 12 | * module options |
| 13 | * |
| 14 | * @var array (if loaded) |
| 15 | */ |
| 16 | protected $options; |
| 17 | |
| 18 | /** |
| 19 | * option key |
| 20 | * |
| 21 | * @const array |
| 22 | */ |
| 23 | const OPTION_KEY = 'advanced-ads-privacy'; |
| 24 | |
| 25 | /** |
| 26 | * Initialize the module |
| 27 | */ |
| 28 | private function __construct() { |
| 29 | $options = $this->options(); |
| 30 | |
| 31 | add_filter( 'advanced-ads-can-display', array( $this, 'can_display_by_consent' ), 10, 3 ); |
| 32 | |
| 33 | if ( ! empty( $options['enabled'] ) ) { |
| 34 | add_filter( 'advanced-ads-activate-advanced-js', '__return_true' ); |
| 35 | } |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Return an instance of Advanced_Ads_Privacy |
| 40 | * |
| 41 | * @return Advanced_Ads_Privacy |
| 42 | */ |
| 43 | public static function get_instance() { |
| 44 | // If the single instance hasn't been set, set it now. |
| 45 | if ( null === self::$instance ) |
| 46 | { |
| 47 | self::$instance = new self; |
| 48 | } |
| 49 | |
| 50 | return self::$instance; |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Return module options |
| 55 | * |
| 56 | * @return array $options |
| 57 | */ |
| 58 | public function options() { |
| 59 | if ( ! isset( $this->options ) ) { |
| 60 | $this->options = get_option( self::OPTION_KEY, array() ); |
| 61 | } |
| 62 | return $this->options; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Check if ad can be displayed based on user's consent. |
| 67 | * |
| 68 | * @return bool |
| 69 | */ |
| 70 | public function can_display_by_consent( $can_display, Advanced_Ads_Ad $ad, $check_options ) { |
| 71 | if ( ! $can_display ) { |
| 72 | return $can_display; |
| 73 | } |
| 74 | |
| 75 | if ( $check_options['passive_cache_busting'] ) { |
| 76 | return true; |
| 77 | } |
| 78 | |
| 79 | $ad_options = $ad->options(); |
| 80 | // If consent is not needed for the ad. |
| 81 | if ( ! empty( $ad_options['privacy']['ignore-consent'] ) ) { |
| 82 | return true; |
| 83 | } |
| 84 | |
| 85 | $privacy_options = $this->options(); |
| 86 | if ( $ad->type === 'adsense' ) { |
| 87 | if ( ! empty( $privacy_options['show-non-personalized-adsense'] ) ) { |
| 88 | // Either personalized or non-personalized ad will be shown. |
| 89 | return true; |
| 90 | } |
| 91 | } |
| 92 | |
| 93 | $state = $this->get_state(); |
| 94 | return ( $state === 'accepted' || $state === 'not_needed' ); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Check if consent is not needed or was given by the user. |
| 99 | * |
| 100 | * @return str |
| 101 | * 'not_needed' - consent is not needed. |
| 102 | * 'accepted' - consent was given. |
| 103 | * 'unknown' - consent was not given yet. |
| 104 | */ |
| 105 | public function get_state() { |
| 106 | if ( empty ( $this->options['enabled'] ) ) { |
| 107 | return 'not_needed'; |
| 108 | } |
| 109 | |
| 110 | $consent_method = isset( $this->options['consent-method'] ) ? $this->options['consent-method'] : 0; |
| 111 | switch ( $consent_method ) { |
| 112 | case '0': |
| 113 | return 'not_needed'; |
| 114 | break; |
| 115 | case 'custom': |
| 116 | if ( ! isset( $this->options['custom-cookie-name'] ) || ! isset( $this->options['custom-cookie-value'] ) ) { |
| 117 | return 'not_needed'; |
| 118 | } |
| 119 | $name = $this->options['custom-cookie-name']; |
| 120 | $value = $this->options['custom-cookie-value']; |
| 121 | if ( ! isset( $_COOKIE[ $name ] ) ) { |
| 122 | return 'unknown'; |
| 123 | } |
| 124 | |
| 125 | if ( ( $value === '' && $_COOKIE[ $name ] === '' ) |
| 126 | || ($value !== '' && strpos( $_COOKIE[ $name ], $value ) !== false ) ) { |
| 127 | return 'accepted'; |
| 128 | } |
| 129 | return 'unknown'; |
| 130 | break; |
| 131 | default: |
| 132 | return isset( $_COOKIE[ $consent_method ] ) ? 'accepted' : 'unknown'; |
| 133 | break; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Get consent methods. |
| 139 | * |
| 140 | * @return arr |
| 141 | */ |
| 142 | public function get_consent_methods() { |
| 143 | $methods = array( |
| 144 | '0' => __( 'Show all ads even without consent.', 'advanced-ads' ), |
| 145 | 'custom' => __( 'Cookie', 'advanced-ads' ), |
| 146 | ); |
| 147 | /* |
| 148 | // https://wordpress.org/plugins/cookie-notice/ |
| 149 | if ( class_exists( 'Cookie_Notice' ) ) { |
| 150 | $methods['cookie_notice_accepted'] = 'Cookie Notice by dFactory'; |
| 151 | } |
| 152 | // https://wordpress.org/plugins/uk-cookie-consent/ |
| 153 | if ( defined( 'CTCC_PLUGIN_URL' ) ) { |
| 154 | $methods['catAccCookies'] = 'Cookie Consent'; |
| 155 | } |
| 156 | // https://wordpress.org/plugins/cookie-law-info/ |
| 157 | if ( defined( 'CLI_PLUGIN_DEVELOPMENT_MODE' ) ) { |
| 158 | $methods['viewed_cookie_policy'] = 'GDPR Cookie Consent'; |
| 159 | } |
| 160 | */ |
| 161 | return $methods; |
| 162 | } |
| 163 | } |
| 164 |