PluginProbe
Boxzilla – WordPress Popup Builder / 3.2.4
Boxzilla – WordPress Popup Builder v3.2.4
3.4.11 3.4.10 3.4.9 3.4.3 3.4.4 3.4.5 3.4.6 3.4.7 3.4.8 trunk 3.0 3.0.1 3.0.2 3.0.3 3.1 3.1.1 3.1.10 3.1.11 3.1.12 3.1.13 3.1.14 3.1.15 3.1.16 3.1.17 3.1.18 All 72 releases
← All changes | src/class-loader.php +332 -351 trunk3.2.4 View file →
@@ -1,351 +1,332 @@
1 -<?php
2 -
3 -namespace Boxzilla;
4 -
5 -if (! defined('ABSPATH')) {
6 - exit;
7 -}
8 -
9 -class BoxLoader
10 -{
11 - /**
12 - * @var Plugin
13 - */
14 - private $plugin;
15 -
16 - /**
17 - * @var array
18 - */
19 - private $box_ids_to_load = [];
20 -
21 - /**
22 - * @var array
23 - */
24 - protected $options;
25 -
26 - /**
27 - * Constructor
28 - *
29 - * @param Plugin $plugin
30 - * @param array $options
31 - */
32 - public function __construct(Plugin $plugin, array $options)
33 - {
34 - $this->plugin = $plugin;
35 - $this->options = $options;
36 - }
37 -
38 - /**
39 - * Initializes the plugin, runs on `wp` hook.
40 - */
41 - public function init()
42 - {
43 - $this->box_ids_to_load = $this->filter_boxes();
44 -
45 - // Only add other hooks if necessary
46 - add_action('wp_head', [$this, 'print_preload_js'], 10, 0);
47 - if (count($this->box_ids_to_load) > 0) {
48 - add_action('wp_footer', [ $this, 'print_boxes_content' ], 1);
49 - add_action('wp_enqueue_scripts', [ $this, 'load_assets' ], 90);
50 - }
51 - }
52 -
53 - /**
54 - * Prints the preload API so that the Boxzilla JS API can be used before Boxzilla itself is loaded
55 - * This allows us to defer the Boxzilla script itself.
56 - */
57 - public function print_preload_js(): void
58 - {
59 - echo '<script>';
60 - include BOXZILLA_DIR . '/assets/js/preload.js';
61 - echo '</script>';
62 - }
63 -
64 - /**
65 - * Get global rules for all boxes
66 - *
67 - * @return array
68 - */
69 - protected function get_filter_rules(): array
70 - {
71 - $rules = get_option('boxzilla_rules', []);
72 - return is_array($rules) ? $rules : [];
73 - }
74 -
75 -
76 - /**
77 - * Match a string against an array of patterns, glob-style.
78 - *
79 - * @param string $string
80 - * @param array $patterns
81 - * @param bool $contains
82 - * @return bool
83 - */
84 - protected function match_patterns($string, array $patterns, $contains = false)
85 - {
86 - $string = strtolower($string);
87 -
88 - foreach ($patterns as $pattern) {
89 - $pattern = rtrim($pattern, '/');
90 - $pattern = strtolower($pattern);
91 -
92 - if ($contains) {
93 - // contains means we should do a simple occurrence check
94 - // does not support wildcards
95 - $match = strpos($string, $pattern) !== false;
96 - } elseif (function_exists('fnmatch')) {
97 - $match = fnmatch($pattern, $string);
98 - } else {
99 - $match = ( $pattern === $string );
100 - }
101 -
102 - if ($match) {
103 - return true;
104 - }
105 - }
106 -
107 - return false;
108 - }
109 -
110 - /**
111 - * @return string
112 - */
113 - protected function get_request_url()
114 - {
115 - return rtrim(wp_unslash($_SERVER['REQUEST_URI'] ?? ''), '/');
116 - }
117 -
118 - /**
119 - * Check if this rule passes (conditional matches expected value)
120 - *
121 - * @param string $condition
122 - * @param string $value
123 - * @param boolean $qualifier
124 - *
125 - * @return bool
126 - */
127 - protected function match_rule($condition, $value, $qualifier = true)
128 - {
129 - $matched = false;
130 -
131 - // cast value to array & trim whitespace or excess comma's
132 - $values = array_map('trim', explode(',', rtrim(trim($value), ',')));
133 -
134 - switch ($condition) {
135 - case 'everywhere':
136 - $matched = true;
137 - break;
138 -
139 - case 'is_url':
140 - $url = $this->get_request_url();
141 - $matched = $this->match_patterns($url, $values, $qualifier === 'contains' || $qualifier === 'not_contains');
142 - break;
143 -
144 - case 'is_referer':
145 - if (! empty($_SERVER['HTTP_REFERER'])) {
146 - $referer = wp_unslash($_SERVER['HTTP_REFERER']);
147 - $matched = $this->match_patterns($referer, $values, $qualifier === 'contains' || $qualifier === 'not_contains');
148 - }
149 - break;
150 -
151 - case 'is_post_type':
152 - $post_type = (string) get_post_type();
153 - $matched = in_array($post_type, $values, true);
154 - break;
155 -
156 - case 'is_single':
157 - case 'is_post':
158 - // convert to empty string if array with just empty string in it
159 - $value = ( $values === [ '' ] ) ? '' : $values;
160 - $matched = is_single($value);
161 - break;
162 -
163 - case 'is_post_in_category':
164 - $matched = is_singular() && has_category($values);
165 - break;
166 -
167 - case 'is_page':
168 - $matched = is_page($values);
169 - break;
170 -
171 - case 'is_post_with_tag':
172 - $matched = is_singular() && has_tag($values);
173 - break;
174 -
175 - case 'is_user_logged_in':
176 - $matched = is_user_logged_in();
177 - break;
178 - }
179 -
180 - /**
181 - * Filters whether a given box rule matches the condition and expected value.
182 - *
183 - * The dynamic portion of the hook, `$condition`, refers to the condition being matched.
184 - *
185 - * @param boolean $matched
186 - * @param array $values
187 - */
188 - $matched = apply_filters('boxzilla_box_rule_matches_' . $condition, $matched, $values);
189 -
190 - // if qualifier is set to false, we need to reverse this value here.
191 - if (! $qualifier || $qualifier === 'not_contains') {
192 - $matched = ! $matched;
193 - }
194 -
195 - return $matched;
196 - }
197 -
198 - /**
199 - * Checks which boxes should be loaded for this request.
200 - *
201 - * @return array
202 - */
203 - private function filter_boxes()
204 - {
205 - $box_ids_to_load = [];
206 - $rules = $this->get_filter_rules();
207 -
208 - foreach ($rules as $box_id => $box_rules) {
209 - $matched = false;
210 - $comparision = isset($box_rules['comparision']) ? $box_rules['comparision'] : 'any';
211 -
212 - // loop through all rules for all boxes
213 - foreach ($box_rules as $rule) {
214 - // skip faulty values (and comparision rule)
215 - if (! is_array($rule) || empty($rule['condition'])) {
216 - continue;
217 - }
218 -
219 - $qualifier = isset($rule['qualifier']) ? $rule['qualifier'] : true;
220 - $matched = $this->match_rule($rule['condition'], $rule['value'], $qualifier);
221 -
222 - // break out of loop if we've already matched
223 - if ($comparision === 'any' && $matched) {
224 - break;
225 - }
226 -
227 - // no need to continue if this rule didn't match
228 - if ($comparision === 'all' && ! $matched) {
229 - break;
230 - }
231 - }
232 -
233 - // value of $matched at this point determines whether box should be loaded
234 - $load_box = $matched;
235 -
236 - /**
237 - * Filters whether a box should be loaded into the page HTML.
238 - *
239 - * The dynamic portion of the hook, `$box_id`, refers to the ID of the box. Return true if you want to output the box.
240 - *
241 - * @param boolean $load_box
242 - */
243 - $load_box = apply_filters('boxzilla_load_box_' . $box_id, $load_box);
244 -
245 - /**
246 - * Filters whether a box should be loaded into the page HTML.
247 - *
248 - * @param boolean $load_box
249 - * @param int $box_id
250 - */
251 - $load_box = apply_filters('boxzilla_load_box', $load_box, $box_id);
252 -
253 - // if matched, box should be loaded on this page
254 - if ($load_box) {
255 - $box_ids_to_load[] = $box_id;
256 - }
257 - }
258 -
259 - /**
260 - * Filters which boxes should be loaded on this page, expects an array of post ID's.
261 - *
262 - * @param array $box_ids_to_load
263 - */
264 - return apply_filters('boxzilla_load_boxes', $box_ids_to_load);
265 - }
266 -
267 - /**
268 - * Load plugin styles
269 - */
270 - public function load_assets()
271 - {
272 - wp_enqueue_style('boxzilla', $this->plugin->url('/assets/css/styles.css'), [], $this->plugin->version());
273 - wp_enqueue_script('boxzilla', $this->plugin->url('/assets/js/script.js'), [], $this->plugin->version(), [
274 - 'strategy' => 'defer',
275 - ]);
276 -
277 - // create boxzilla_Global_Options object
278 - $plugin_options = $this->options;
279 - $boxes = $this->get_matched_boxes();
280 -
281 - $data = [
282 - 'testMode' => (bool) $plugin_options['test_mode'],
283 - 'boxes' => (array) array_map(
284 - function (Box $box) {
285 - return $box->get_client_options();
286 - },
287 - $boxes
288 - ),
289 - ];
290 - wp_add_inline_script('boxzilla', 'var boxzilla_options = ' . wp_json_encode($data) . ';', 'before');
291 - do_action('boxzilla_load_assets', $this);
292 - }
293 -
294 - public function print_boxes_content()
295 - {
296 - $boxes = $this->get_matched_boxes();
297 - if (empty($boxes)) {
298 - return;
299 - }
300 -
301 - echo '<div style="display: none;">';
302 - foreach ($boxes as $box) {
303 - printf('<div id="boxzilla-box-%d-content">%s</div>', absint($box->ID), $box->get_content()); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
304 - }
305 - echo '</div>';
306 - }
307 -
308 - /**
309 - * Get an array of Box objects. These are the boxes that will be loaded for the current request.
310 - *
311 - * @return Box[]
312 - */
313 - public function get_matched_boxes()
314 - {
315 - static $boxes;
316 -
317 - if ($boxes === null) {
318 - if (count($this->box_ids_to_load) === 0) {
319 - return [];
320 - }
321 -
322 - // query Box posts
323 - $q = new \WP_Query();
324 - $posts = $q->query(
325 - [
326 - 'post_type' => 'boxzilla-box',
327 - 'post_status' => 'publish',
328 - 'post__in' => $this->box_ids_to_load,
329 - 'posts_per_page' => count($this->box_ids_to_load),
330 - 'ignore_sticky_posts' => true,
331 - 'no_found_rows' => true,
332 - ]
333 - );
334 -
335 - // create `Box` instances out of \WP_Post instances
336 - $boxes = [];
337 - foreach ($posts as $key => $post) {
338 - $box = new Box($post);
339 -
340 - // skip boxes without any content
341 - if ($box->get_content() === '') {
342 - continue;
343 - }
344 -
345 - $boxes[ $key ] = $box;
346 - }
347 - }
348 -
349 - return $boxes;
350 - }
351 -}
1 +<?php
2 +
3 +namespace Boxzilla;
4 +
5 +class BoxLoader {
6 +
7 + /**
8 + * @var Plugin
9 + */
10 + private $plugin;
11 +
12 + /**
13 + * @var array
14 + */
15 + private $box_ids_to_load = array();
16 +
17 + /**
18 + * @var array
19 + */
20 + protected $options;
21 +
22 + /**
23 + * Constructor
24 + *
25 + * @param Plugin $plugin
26 + * @param array $options
27 + */
28 + public function __construct( Plugin $plugin, array $options ) {
29 + $this->plugin = $plugin;
30 + $this->options = $options;
31 + }
32 +
33 + /**
34 + * Initializes the plugin, runs on `wp` hook.
35 + */
36 + public function init() {
37 +
38 + $this->box_ids_to_load = $this->filter_boxes();
39 +
40 + // Only add other hooks if necessary
41 + if( count( $this->box_ids_to_load ) > 0 ) {
42 + add_action( 'wp_footer', array( $this, 'print_boxes_content' ), 1 );
43 + add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ), 90 );
44 + }
45 + }
46 +
47 + /**
48 + * Get global rules for all boxes
49 + *
50 + * @return array
51 + */
52 + protected function get_filter_rules() {
53 + $rules = get_option( 'boxzilla_rules', array() );
54 +
55 + if( ! is_array( $rules ) ) {
56 + return array();
57 + }
58 +
59 + return $rules;
60 + }
61 +
62 +
63 + /**
64 + * Match a string against an array of patterns, glob-style.
65 + *
66 + * @param string $string
67 + * @param array $patterns
68 + *
69 + * @return boolean
70 + */
71 + protected function match_patterns( $string, $patterns, $contains = false ) {
72 + $string = strtolower( $string );
73 +
74 + foreach( $patterns as $pattern ) {
75 + $pattern = rtrim( $pattern, '/' );
76 + $pattern = strtolower( $pattern );
77 +
78 + // contains means we should do a simple occurence check
79 + // does not support wildcards
80 + if( $contains ) {
81 + return strpos( $string, $pattern ) !== false;
82 + }
83 +
84 + if( function_exists( 'fnmatch' ) ) {
85 + $match = fnmatch( $pattern, $string );
86 + } else {
87 + $match = ( $pattern === $string );
88 + }
89 +
90 + if( $match ) {
91 + return true;
92 + }
93 + }
94 +
95 + return false;
96 + }
97 +
98 + /**
99 + * @return string
100 + */
101 + protected function get_request_url() {
102 + // strip trailing slashes
103 + $request_uri = rtrim( $_SERVER['REQUEST_URI'], '/' );
104 + return $request_uri;
105 + }
106 +
107 + /**
108 + * Check if this rule passes (conditional matches expected value)
109 + *
110 + * @param string $condition
111 + * @param string $value
112 + * @param boolean $qualifier
113 + *
114 + * @return bool
115 + */
116 + protected function match_rule( $condition, $value, $qualifier = true ) {
117 +
118 + $matched = false;
119 +
120 + // cast value to array & trim whitespace or excess comma's
121 + $value = array_map( 'trim', explode( ',', rtrim( trim( $value ), ',' ) ) );
122 +
123 + switch ( $condition ) {
124 + case 'everywhere';
125 + $matched = true;
126 + break;
127 +
128 + case 'is_url':
129 + $url = $this->get_request_url();
130 + $matched = $this->match_patterns( $url, $value, $qualifier === 'contains' );
131 + break;
132 +
133 + case 'is_referer':
134 + if( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
135 + $referer = $_SERVER['HTTP_REFERER'];
136 + $matched = $this->match_patterns( $referer, $value, $qualifier === 'contains' );
137 + }
138 + break;
139 +
140 + case 'is_post_type':
141 + $post_type = (string) get_post_type();
142 + $matched = in_array( $post_type, (array) $value );
143 + break;
144 +
145 + case 'is_single':
146 + case 'is_post':
147 + // convert to empty string if array with just empty string in it
148 + $value = ( $value === array( '' ) ) ? '' : $value;
149 + $matched = is_single( $value );
150 + break;
151 +
152 + case 'is_post_in_category':
153 + $matched = is_singular( 'post' ) && has_category( $value );
154 + break;
155 +
156 +
157 + case 'is_page':
158 + $matched = is_page( $value );
159 + break;
160 +
161 + case 'is_post_with_tag':
162 + $matched = is_singular( 'post' ) && has_tag( $value );
163 + break;
164 +
165 + case 'is_user_logged_in':
166 + $matched = is_user_logged_in();
167 + break;
168 + }
169 +
170 + /**
171 + * Filters whether a given box rule matches the condition and expected value.
172 + *
173 + * The dynamic portion of the hook, `$condition`, refers to the condition being matched.
174 + *
175 + * @param boolean $matched
176 + * @param array $value
177 + */
178 + $matched = apply_filters( 'boxzilla_box_rule_matches_' . $condition, $matched, $value );
179 +
180 + // if qualifier is set to false, we need to reverse this value here.
181 + if( ! $qualifier ) {
182 + $matched = ! $matched;
183 + }
184 +
185 + return $matched;
186 + }
187 +
188 + /**
189 + * Checks which boxes should be loaded for this request.
190 + *
191 + * @return array
192 + */
193 + private function filter_boxes() {
194 +
195 + $box_ids_to_load = array();
196 + $rules = $this->get_filter_rules();
197 +
198 + foreach( $rules as $box_id => $box_rules ) {
199 +
200 + $matched = false;
201 + $comparision = isset( $box_rules['comparision'] ) ? $box_rules['comparision'] : 'any';
202 +
203 + // loop through all rules for all boxes
204 + foreach ( $box_rules as $rule ) {
205 +
206 + // skip faulty values (and comparision rule)
207 + if( empty( $rule['condition'] ) ) {
208 + continue;
209 + }
210 +
211 + $qualifier = isset( $rule['qualifier'] ) ? $rule['qualifier'] : true;
212 + $matched = $this->match_rule( $rule['condition'], $rule['value'], $qualifier );
213 +
214 + // break out of loop if we've already matched
215 + if( $comparision === 'any' && $matched ) {
216 + break;
217 + }
218 +
219 + // no need to continue if this rule didn't match
220 + if( $comparision === 'all' && ! $matched ) {
221 + break;
222 + }
223 + }
224 +
225 + // value of $matched at this point determines whether box should be loaded
226 + $load_box = $matched;
227 +
228 + /**
229 + * Filters whether a box should be loaded into the page HTML.
230 + *
231 + * The dynamic portion of the hook, `$box_id`, refers to the ID of the box. Return true if you want to output the box.
232 + *
233 + * @param boolean $load_box
234 + */
235 + $load_box = apply_filters( 'boxzilla_load_box_' . $box_id, $load_box );
236 +
237 + /**
238 + * Filters whether a box should be loaded into the page HTML.
239 + *
240 + * @param boolean $load_box
241 + * @param int $box_id
242 + */
243 + $load_box = apply_filters( 'boxzilla_load_box', $load_box, $box_id );
244 +
245 + // if matched, box should be loaded on this page
246 + if ( $load_box ) {
247 + $box_ids_to_load[] = $box_id;
248 + }
249 +
250 + }
251 +
252 + return $box_ids_to_load;
253 + }
254 +
255 + /**
256 + * Load plugin styles
257 + */
258 + public function load_assets() {
259 + $pre_suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
260 + wp_enqueue_script('boxzilla', $this->plugin->url('/assets/js/script' . $pre_suffix . '.js' ), array(), $this->plugin->version(), true );
261 +
262 + // create boxzilla_Global_Options object
263 + $plugin_options = $this->options;
264 + $boxes = $this->get_matched_boxes();
265 +
266 + $data = array(
267 + 'testMode' => (bool) $plugin_options['test_mode'],
268 + 'boxes' => array_map( function(Box $box) { return $box->get_client_options(); }, $boxes ),
269 + );
270 +
271 + wp_localize_script( 'boxzilla', 'boxzilla_options', $data );
272 +
273 + do_action( 'boxzilla_load_assets', $this );
274 + }
275 +
276 + public function print_boxes_content() {
277 + $boxes = $this->get_matched_boxes();
278 + if( empty( $boxes ) ) {
279 + return;
280 + }
281 +
282 + echo '<div style="display: none;">';
283 + foreach( $boxes as $box ) {
284 + echo sprintf( '<div id="boxzilla-box-%d-content">', $box->ID ) . $box->get_content() . '</div>';
285 + }
286 + echo '</div>';
287 + }
288 +
289 + /**
290 + * Get an array of Box objects. These are the boxes that will be loaded for the current request.
291 + *
292 + * @return Box[]
293 + */
294 + public function get_matched_boxes() {
295 + static $boxes;
296 +
297 + if( is_null( $boxes ) ) {
298 +
299 + if( count( $this->box_ids_to_load ) === 0 ) {
300 + $boxes = array();
301 + return $boxes;
302 + }
303 +
304 + // query Box posts
305 + $posts = get_posts(
306 + array(
307 + 'post_type' => 'boxzilla-box',
308 + 'post_status' => 'publish',
309 + 'post__in' => $this->box_ids_to_load,
310 + 'numberposts' => -1
311 + )
312 + );
313 +
314 + // create `Box` instances out of \WP_Post instances
315 + $boxes = array();
316 + foreach ( $posts as $key => $post ) {
317 + // skip posts with no content
318 + $post_content = trim( strip_tags( nl2br( $post->post_content ) ) );
319 + if( empty( $post_content ) ) {
320 + continue;
321 + }
322 +
323 + $boxes[ $key ] = new Box( $post );
324 + }
325 + }
326 +
327 + return $boxes;
328 + }
329 +
330 +}
331 +
332 +