Completed
Push — feature/widgets/simple-payment... ( 54ee17...cc9835 )
by
unknown
54:43 queued 41:21
created

Jetpack_EU_Cookie_Law_Widget::form()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 15
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 10
nc 1
nop 1
dl 0
loc 15
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
		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__( 'Cookies & Consents Banner', 'jetpack' ) ),
80
				array(
81
					'description' => esc_html__( 'Display a banner for EU Cookie Law and GDPR compliance.', 'jetpack' ),
82
					'customize_selective_refresh' => true,
83
				),
84
				array()
85
			);
86
87 View Code Duplication
			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(
98
				'eu-cookie-law-script',
99
				Jetpack::get_file_url_for_environment(
100
					'_inc/build/widgets/eu-cookie-law/eu-cookie-law.min.js',
101
					'modules/widgets/eu-cookie-law/eu-cookie-law.js'
102
				),
103
				array( 'jquery' ),
104
				'20170404',
105
				true
106
			);
107
		}
108
109
		/**
110
		 * Return an associative array of default values.
111
		 *
112
		 * These values are used in new widgets.
113
		 *
114
		 * @return array Default values for the widget options.
115
		 */
116
		public function defaults() {
117
			return array(
118
				'hide'               => $this->hide_options[0],
119
				'hide-timeout'       => 30,
120
				'text'               => $this->text_options[0],
121
				'customtext'         => '',
122
				'color-scheme'       => $this->color_scheme_options[0],
123
				'policy-url'         => $this->policy_url_options[0],
124
				'default-policy-url' => 'https://automattic.com/cookies/',
125
				'custom-policy-url'  => '',
126
				'policy-link-text'   => esc_html__( 'Cookie Policy', 'jetpack' ),
127
				'button'             => esc_html__( 'Close and accept', 'jetpack' ),
128
				'default-text'       => esc_html__( 'Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.', 'jetpack' ),
129
			);
130
		}
131
132
		/**
133
		 * Front-end display of the widget.
134
		 *
135
		 * @param array $args     Widget arguments.
136
		 * @param array $instance Saved values from database.
137
		 */
138
		public function widget( $args, $instance ) {
139
			$instance = wp_parse_args( $instance, $this->defaults() );
140
			echo $args['before_widget'];
141
			require( dirname( __FILE__ ) . '/eu-cookie-law/widget.php' );
142
			echo $args['after_widget'];
143
			/** This action is already documented in modules/widgets/gravatar-profile.php */
144
			do_action( 'jetpack_stats_extra', 'widget_view', 'eu_cookie_law' );
145
		}
146
147
		/**
148
		 * Back-end widget form.
149
		 *
150
		 * @param array $instance Previously saved values from database.
151
		 */
152
		public function form( $instance ) {
153
			$instance = wp_parse_args( $instance, $this->defaults() );
154
155
			wp_enqueue_script(
156
				'eu-cookie-law-widget-admin',
157
				Jetpack::get_file_url_for_environment(
158
					'_inc/build/widgets/eu-cookie-law/eu-cookie-law-admin.min.js',
159
					'modules/widgets/eu-cookie-law/eu-cookie-law-admin.js'
160
				),
161
				array( 'jquery' ),
162
				20180417
163
			);
164
165
			require( dirname( __FILE__ ) . '/eu-cookie-law/form.php' );
166
		}
167
168
		/**
169
		 * Sanitize widget form values as they are saved.
170
		 *
171
		 * @param  array $new_instance Values just sent to be saved.
172
		 * @param  array $old_instance Previously saved values from database.
173
		 * @return array Updated safe values to be saved.
174
		 */
175
		public function update( $new_instance, $old_instance ) {
176
			$instance = array();
177
			$defaults = $this->defaults();
178
179
			$instance['hide']         = $this->filter_value( $new_instance['hide'], $this->hide_options );
180
			$instance['text']         = $this->filter_value( $new_instance['text'], $this->text_options );
181
			$instance['color-scheme'] = $this->filter_value( $new_instance['color-scheme'], $this->color_scheme_options );
182
			$instance['policy-url']   = $this->filter_value( $new_instance['policy-url'], $this->policy_url_options );
183
184
			if ( isset( $new_instance['hide-timeout'] ) ) {
185
				// Time can be a value between 3 and 1000 seconds.
186
				$instance['hide-timeout'] = min( 1000, max( 3, intval( $new_instance['hide-timeout'] ) ) );
187
			}
188
189
			if ( isset( $new_instance['customtext'] ) ) {
190
				$instance['customtext'] = mb_substr( wp_kses( $new_instance['customtext'], array() ), 0, 4096 );
191
			} else {
192
				$instance['text'] = $this->text_options[0];
193
			}
194
195
			if ( isset( $new_instance['policy-url'] ) ) {
196
				$instance['policy-url'] = 'custom' === $new_instance['policy-url']
197
					? 'custom'
198
					: 'default';
199
			} else {
200
				$instance['policy-url'] = $this->policy_url_options[0];
201
			}
202
203
			if ( 'custom' === $instance['policy-url'] && isset( $new_instance['custom-policy-url'] ) ) {
204
				$instance['custom-policy-url'] = esc_url( $new_instance['custom-policy-url'], array( 'http', 'https' ) );
205
206
				if ( strlen( $instance['custom-policy-url'] ) < 10 ) {
207
					unset( $instance['custom-policy-url'] );
208
					global $wp_customize;
209
					if ( ! isset( $wp_customize ) ) {
210
						$instance['policy-url'] = $this->policy_url_options[0];
211
					}
212
				}
213
			}
214
215
			if ( isset( $new_instance['policy-link-text'] ) ) {
216
				$instance['policy-link-text'] = trim( mb_substr( wp_kses( $new_instance['policy-link-text'], array() ), 0, 100 ) );
217
			}
218
219
			if ( empty( $instance['policy-link-text'] ) || $instance['policy-link-text'] == $defaults['policy-link-text'] ) {
220
				unset( $instance['policy-link-text'] );
221
			}
222
223
			if ( isset( $new_instance['button'] ) ) {
224
				$instance['button'] = trim( mb_substr( wp_kses( $new_instance['button'], array() ), 0, 100 ) );
225
			}
226
227
			if ( empty( $instance['button'] ) || $instance['button'] == $defaults['button'] ) {
228
				unset( $instance['button'] );
229
			}
230
231
			// Show the banner again if a setting has been changed.
232
			setcookie( self::$cookie_name, '', time() - 86400, '/' );
233
234
			return $instance;
235
		}
236
237
		/**
238
		 * Check if the value is allowed and not empty.
239
		 *
240
		 * @param  string $value Value to check.
241
		 * @param  array  $allowed Array of allowed values.
242
		 *
243
		 * @return string $value if pass the check or first value from allowed values.
244
		 */
245
		function filter_value( $value, $allowed = array() ) {
246
			$allowed = (array) $allowed;
247
			if ( empty( $value ) || ( ! empty( $allowed ) && ! in_array( $value, $allowed ) ) ) {
248
				$value = $allowed[0];
249
			}
250
			return $value;
251
		}
252
	}
253
254
	// Register Jetpack_EU_Cookie_Law_Widget widget.
255
	function jetpack_register_eu_cookie_law_widget() {
256
		register_widget( 'Jetpack_EU_Cookie_Law_Widget' );
257
	};
258
259
	add_action( 'widgets_init', 'jetpack_register_eu_cookie_law_widget' );
260
}
261