Completed
Push — branch-4.9-built ( f63861...2af77d )
by
unknown
751:45 queued 732:48
created

Jetpack_EU_Cookie_Law_Widget::widget()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 6
nc 1
nop 2
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Disable direct access/execution to/of the widget code.
5
 */
6
if ( ! defined( 'ABSPATH' ) ) {
7
	exit;
8
}
9
10
if ( ! class_exists( 'Jetpack_EU_Cookie_Law_Widget' ) ) {
11
	/**
12
	 * EU Cookie Law Widget
13
	 *
14
	 * Display the EU Cookie Law banner in the bottom part of the screen.
15
	 */
16
	class Jetpack_EU_Cookie_Law_Widget extends WP_Widget {
17
		/**
18
		 * EU Cookie Law cookie name.
19
		 *
20
		 * @var string
21
		 */
22
		public static $cookie_name = 'eucookielaw';
23
24
		/**
25
		 * EU Cookie Law cookie validity (30 days).
26
		 *
27
		 * @var int
28
		 */
29
		public static $cookie_validity = 2592000;
30
31
		/**
32
		 * Default hide options.
33
		 *
34
		 * @var array
35
		 */
36
		private $hide_options = array(
37
			'button',
38
			'scroll',
39
			'time',
40
		);
41
42
		/**
43
		 * Default text options.
44
		 *
45
		 * @var array
46
		 */
47
		private $text_options = array(
48
			'default',
49
			'custom',
50
		);
51
52
		/**
53
		 * Default color scheme options.
54
		 *
55
		 * @var array
56
		 */
57
		private $color_scheme_options = array(
58
			'default',
59
			'negative',
60
		);
61
62
		/**
63
		 * Default policy URL options.
64
		 *
65
		 * @var array
66
		 */
67
		private $policy_url_options = array(
68
			'default',
69
			'custom',
70
		);
71
72
		/**
73
		 * Constructor.
74
		 */
75 View Code Duplication
		function __construct() {
76
			parent::__construct(
77
				'eu_cookie_law_widget',
78
				/** This filter is documented in modules/widgets/facebook-likebox.php */
79
				apply_filters( 'jetpack_widget_name', esc_html__( 'EU Cookie Law Banner', 'jetpack' ) ),
80
				array(
81
					'description' => esc_html__( 'Display a banner for compliance with the EU Cookie Law.', 'jetpack' ),
82
					'customize_selective_refresh' => true,
83
				),
84
				array()
85
			);
86
87
			if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
88
				add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_frontend_scripts' ) );
89
			}
90
		}
91
92
		/**
93
		 * Enqueue scripts and styles.
94
		 */
95
		function enqueue_frontend_scripts() {
96
			wp_enqueue_style( 'eu-cookie-law-style', plugins_url( 'eu-cookie-law/style.css', __FILE__ ), array(), '20170403' );
97
			wp_enqueue_script( 'eu-cookie-law-script', plugins_url( 'eu-cookie-law/eu-cookie-law.js', __FILE__ ), array( 'jquery' ), '20170404', true );
98
		}
99
100
		/**
101
		 * Return an associative array of default values.
102
		 *
103
		 * These values are used in new widgets.
104
		 *
105
		 * @return array Default values for the widget options.
106
		 */
107
		public function defaults() {
108
			return array(
109
				'hide'               => $this->hide_options[0],
110
				'hide-timeout'       => 30,
111
				'text'               => $this->text_options[0],
112
				'customtext'         => '',
113
				'color-scheme'       => $this->color_scheme_options[0],
114
				'policy-url'         => $this->policy_url_options[0],
115
				'default-policy-url' => 'https://jetpack.com/support/cookies/',
116
				'custom-policy-url'  => '',
117
				'policy-link-text'   => esc_html__( 'Our Cookie Policy', 'jetpack' ),
118
				'button'             => esc_html__( 'Close and accept', 'jetpack' ),
119
				'default-text'       => esc_html__( 'Privacy & Cookies: This site uses cookies.', 'jetpack' ),
120
			);
121
		}
122
123
		/**
124
		 * Front-end display of the widget.
125
		 *
126
		 * @param array $args     Widget arguments.
127
		 * @param array $instance Saved values from database.
128
		 */
129
		public function widget( $args, $instance ) {
130
			$instance = wp_parse_args( $instance, $this->defaults() );
131
			echo $args['before_widget'];
132
			require( dirname( __FILE__ ) . '/eu-cookie-law/widget.php' );
133
			echo $args['after_widget'];
134
			/** This action is already documented in modules/widgets/gravatar-profile.php */
135
			do_action( 'jetpack_stats_extra', 'widget_view', 'eu_cookie_law' );
136
		}
137
138
		/**
139
		 * Back-end widget form.
140
		 *
141
		 * @param array $instance Previously saved values from database.
142
		 */
143
		public function form( $instance ) {
144
			$instance = wp_parse_args( $instance, $this->defaults() );
145
			require( dirname( __FILE__ ) . '/eu-cookie-law/form.php' );
146
		}
147
148
		/**
149
		 * Sanitize widget form values as they are saved.
150
		 *
151
		 * @param  array $new_instance Values just sent to be saved.
152
		 * @param  array $old_instance Previously saved values from database.
153
		 * @return array Updated safe values to be saved.
154
		 */
155
		public function update( $new_instance, $old_instance ) {
156
			$instance = array();
157
			$defaults = $this->defaults();
158
159
			$instance['hide']         = $this->filter_value( $new_instance['hide'], $this->hide_options );
160
			$instance['text']         = $this->filter_value( $new_instance['text'], $this->text_options );
161
			$instance['color-scheme'] = $this->filter_value( $new_instance['color-scheme'], $this->color_scheme_options );
162
			$instance['policy-url']   = $this->filter_value( $new_instance['policy-url'], $this->policy_url_options );
163
164
			if ( isset( $new_instance['hide-timeout'] ) ) {
165
				// Time can be a value between 3 and 1000 seconds.
166
				$instance['hide-timeout'] = min( 1000, max( 3, intval( $new_instance['hide-timeout'] ) ) );
167
			}
168
169
			if ( isset( $new_instance['customtext'] ) ) {
170
				$instance['customtext'] = mb_substr( wp_kses( $new_instance['customtext'], array() ), 0, 4096 );
171
			} else {
172
				$instance['text'] = $this->text_options[0];
173
			}
174
175
			if ( isset( $new_instance['custom-policy-url'] ) ) {
176
				$instance['custom-policy-url'] = esc_url( $new_instance['custom-policy-url'], array( 'http', 'https' ) );
177
178
				if ( strlen( $instance['custom-policy-url'] ) < 10 ) {
179
					unset( $instance['custom-policy-url'] );
180
					$instance['policy-url'] = $this->policy_url_options[0];
181
				}
182
			} else {
183
				$instance['policy-url'] = $this->policy_url_options[0];
184
			}
185
186 View Code Duplication
			if ( isset( $new_instance['policy-link-text'] ) ) {
187
				$instance['policy-link-text'] = trim( mb_substr( wp_kses( $new_instance['policy-link-text'], array() ), 0, 100 ) );
188
			}
189
190
			if ( empty( $instance['policy-link-text'] ) || $instance['policy-link-text'] == $defaults['policy-link-text'] ) {
191
				unset( $instance['policy-link-text'] );
192
			}
193
194 View Code Duplication
			if ( isset( $new_instance['button'] ) ) {
195
				$instance['button'] = trim( mb_substr( wp_kses( $new_instance['button'], array() ), 0, 100 ) );
196
			}
197
198
			if ( empty( $instance['button'] ) || $instance['button'] == $defaults['button'] ) {
199
				unset( $instance['button'] );
200
			}
201
202
			// Show the banner again if a setting has been changed.
203
			setcookie( self::$cookie_name, '', time() - 86400, '/' );
204
205
			return $instance;
206
		}
207
208
		/**
209
		 * Set the EU Cookie Law cookie.
210
		 */
211
		public static function add_consent_cookie() {
212
			if ( ! isset( $_POST['eucookielaw'] ) || 'accept' !== $_POST['eucookielaw'] ) {
213
				return;
214
			}
215
216
			if ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( $_POST['_wpnonce'], 'eucookielaw' ) ) {
217
				return;
218
			}
219
220
			// Cookie is valid for 30 days, so the user will be shown the banner again after 30 days.
221
			setcookie( self::$cookie_name, current_time( 'timestamp' ), time() + self::$cookie_validity, '/' );
222
223
			wp_safe_redirect( $_POST['redirect_url'] );
224
		}
225
226
		/**
227
		 * Check if the value is allowed and not empty.
228
		 *
229
		 * @param  string $value Value to check.
230
		 * @param  array  $allowed Array of allowed values.
231
		 *
232
		 * @return string $value if pass the check or first value from allowed values.
233
		 */
234 View Code Duplication
		function filter_value( $value, $allowed = array() ) {
235
			$allowed = (array) $allowed;
236
			if ( empty( $value ) || ( ! empty( $allowed ) && ! in_array( $value, $allowed ) ) ) {
237
				$value = $allowed[0];
238
			}
239
			return $value;
240
		}
241
	}
242
243
	// Register Jetpack_EU_Cookie_Law_Widget widget.
244
	function jetpack_register_eu_cookie_law_widget() {
245
		register_widget( 'Jetpack_EU_Cookie_Law_Widget' );
246
	};
247
248
  // Only load the widget if we're inside the admin or the user has not given their consent to accept cookies.
249
	if ( is_admin() || empty( $_COOKIE[ Jetpack_EU_Cookie_Law_Widget::$cookie_name ] ) ) {
250
		add_action( 'widgets_init', 'jetpack_register_eu_cookie_law_widget' );
251
		add_action( 'init', array( 'Jetpack_EU_Cookie_Law_Widget', 'add_consent_cookie' ) );
252
	}
253
}
254