advanced-ads / modules / privacy / classes / plugin.php

plugin.php in Advanced Ads – Ad Manager & AdSense 1.9, at modules/privacy/classes/plugin.php

161 lines 3.7 KB

Raw Download Zip

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