1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
<?php /** * Class FileReflection. * * @package AmpProject\AmpWP */
namespace AmpProject\AmpWP\DevTools;
use AmpProject\AmpWP\Infrastructure\Registerable; use AmpProject\AmpWP\Infrastructure\Service; use AmpProject\AmpWP\PluginRegistry;
/** * Reflect on a file to deduce its type of source (plugin, theme, core). * * @package AmpProject\AmpWP * @since 2.0.2 * @internal */ final class FileReflection implements Service, Registerable {
// Fields to include in the source array. const SOURCE_FILE = 'file'; const SOURCE_NAME = 'name'; const SOURCE_TYPE = 'type';
// Source types. const TYPE_CORE = 'core'; const TYPE_MU_PLUGIN = 'mu-plugin'; const TYPE_THEME = 'theme'; const TYPE_PLUGIN = 'plugin';
// Regular expression patterns to use. const SLUG_PATTERN = '(?<slug>[^/]+)'; const FILE_PATTERN = '(?<file>.*$)'; const SLASHED_FILE_PATTERN = '(/(?<file>.*$))?'; const CORE_FILE_PATTERN = '(?<slug>wp-admin|wp-includes)/(?<file>.*$)';
/** * Plugin registry instance to use. * * @var PluginRegistry */ private $plugin_registry;
/** * Plugin file pattern to use. * * Used as cache to not recreate the pattern with each file lookup. * * @var string */ private $plugin_file_pattern;
/** * Parent theme pattern to use. * * Used as cache to not recreate the pattern with each file lookup. * * @var string|null */ private $parent_theme_pattern;
/** * Child theme pattern to use. * * Used as cache to not recreate the pattern with each file lookup. * * @var string|null */ private $child_theme_pattern;
/** * Must-use plugin file pattern to use. * * Used as cache to not recreate the pattern with each file lookup. * * @var string */ private $mu_plugin_file_pattern;
/** * WordPress Core file pattern to use. * * Used as cache to not recreate the pattern with each file lookup. * * @var string */ private $core_file_pattern;
/** * Template directory. * * Used as cache to avoid running a filtered getter with each file lookup. * * @var string|null */ private $template_directory;
/** * Template slug. * * Used as cache to avoid running a filtered getter with each file lookup. * * @var string|null */ private $template_slug;
/** * Stylesheet directory. * * Used as cache to avoid running a filtered getter with each file lookup. * * @var string|null */ private $stylesheet_directory;
/** * Stylesheet slug. * * Used as cache to avoid running a filtered getter with each file lookup. * * @var string|null */ private $stylesheet_slug;
/** * FileReflection constructor. * * @param PluginRegistry $plugin_registry Plugin registry to use. */ public function __construct( PluginRegistry $plugin_registry ) { $this->plugin_registry = $plugin_registry; }
/** * Register the service. * * @return void */ public function register() { add_action( 'setup_theme', [ $this, 'reset_theme_variables' ], ~PHP_INT_MAX ); }
/** * Reset the cached theme variables. * * This is needed in case a plugin has dynamically changed the theme. */ public function reset_theme_variables() { $this->template_directory = null; $this->template_slug = null; $this->parent_theme_pattern = null; $this->stylesheet_directory = null; $this->stylesheet_slug = null; $this->child_theme_pattern = null; }
/** * Identify the type, name, and relative path for a file. * * @param string $file File. * @return array { * @type string $type Source type (core, plugin, mu-plugin, or theme). Not set if no match. * @type string $name Source name. Not set if no match. * @type string $file Relative file path based on the type. Not set if no match. * } */ public function get_file_source( $file ) { static $recursion_protection = false;
if ( $recursion_protection ) { return []; }
$recursion_protection = true;
$matches = [];
if ( $this->is_parent_theme_file( $file, $matches ) ) { $recursion_protection = false; return $this->get_file_source_array( self::TYPE_THEME, $this->get_template_slug(), $matches['file'] ); }
if ( $this->is_child_theme_file( $file, $matches ) ) { $recursion_protection = false; return $this->get_file_source_array( self::TYPE_THEME, $this->get_stylesheet_slug(), $matches['file'] ); }
if ( $this->is_plugin_file( $file, $matches ) ) { $recursion_protection = false; return $this->get_file_source_array( self::TYPE_PLUGIN, $matches['slug'], isset( $matches['file'] ) ? $matches['file'] : $matches['slug'] ); }
if ( $this->is_mu_plugin_file( $file, $matches ) ) { $recursion_protection = false; return $this->get_file_source_array( self::TYPE_MU_PLUGIN, $matches['slug'], isset( $matches['file'] ) ? $matches['file'] : $matches['slug'] ); }
if ( $this->is_core_file( $file, $matches ) ) { $recursion_protection = false; return $this->get_file_source_array( self::TYPE_CORE, $matches['slug'], $matches['file'] ); }
$recursion_protection = false; return []; }
/** * Get the template directory. * * @return string Template directory. */ private function get_template_directory() { if ( null === $this->template_directory ) { $this->template_directory = wp_normalize_path( get_template_directory() ); }
return $this->template_directory; }
/** * Get the template slug. * * @return string Template slug. */ private function get_template_slug() { if ( null === $this->template_slug ) { $this->template_slug = get_template(); }
return $this->template_slug; }
/** * Get the stylesheet directory. * * @return string Stylesheet directory. */ private function get_stylesheet_directory() { if ( null === $this->stylesheet_directory ) { $this->stylesheet_directory = wp_normalize_path( get_stylesheet_directory() ); }
return $this->stylesheet_directory; }
/** * Get the stylesheet slug. * * @return string Stylesheet slug. */ private function get_stylesheet_slug() { if ( null === $this->stylesheet_slug ) { $this->stylesheet_slug = get_stylesheet(); }
return $this->stylesheet_slug; }
/** * Check whether the given file belongs to a plugin. * * @param string $file File to check. * @param array $matches Associative array of matches, passed by reference. * @return false|int Number of found matches, or false if an error occurred. */ private function is_plugin_file( $file, &$matches ) { if ( null === $this->plugin_file_pattern ) { $this->plugin_file_pattern = sprintf( ':%s%s%s:s', preg_quote( trailingslashit( wp_normalize_path( $this->plugin_registry->get_plugin_dir() ) ), ':' ), self::SLUG_PATTERN, self::SLASHED_FILE_PATTERN ); }
return preg_match( $this->plugin_file_pattern, $file, $matches ); }
/** * Check whether the given file belongs to a parent theme. * * @param string $file File to check. * @param array $matches Associative array of matches, passed by reference. * @return false|int Number of found matches, or false if an error occurred. */ private function is_parent_theme_file( $file, &$matches ) { $template_directory = $this->get_template_directory();
if ( empty( $template_directory ) ) { return false; }
if ( null === $this->parent_theme_pattern ) { $this->parent_theme_pattern = sprintf( ':%s%s:s', preg_quote( trailingslashit( $template_directory ), ':' ), self::FILE_PATTERN ); }
return preg_match( $this->parent_theme_pattern, $file, $matches ); }
/** * Check whether the given file belongs to a child theme. * * @param string $file File to check. * @param array $matches Associative array of matches, passed by reference. * @return false|int Number of found matches, or false if an error occurred. */ private function is_child_theme_file( $file, &$matches ) { $stylesheet_directory = $this->get_stylesheet_directory();
if ( empty( $stylesheet_directory ) ) { return false; }
if ( null === $this->child_theme_pattern ) { $this->child_theme_pattern = sprintf( ':%s%s:s', preg_quote( trailingslashit( $stylesheet_directory ), ':' ), self::FILE_PATTERN ); }
return preg_match( $this->child_theme_pattern, $file, $matches ); }
/** * Check whether the given file belongs to a must-use plugin. * * @param string $file File to check. * @param array $matches Associative array of matches, passed by reference. * @return false|int Number of found matches, or false if an error occurred. */ private function is_mu_plugin_file( $file, &$matches ) { if ( null === $this->mu_plugin_file_pattern ) { $this->mu_plugin_file_pattern = sprintf( ':%s%s%s:s', preg_quote( trailingslashit( wp_normalize_path( WPMU_PLUGIN_DIR ) ), ':' ), self::SLUG_PATTERN, self::SLASHED_FILE_PATTERN ); }
return preg_match( $this->mu_plugin_file_pattern, $file, $matches ); }
/** * Check whether the given file belongs to WordPress Core. * * @param string $file File to check. * @param array $matches Associative array of matches, passed by reference. * @return false|int Number of found matches, or false if an error occurred. */ private function is_core_file( $file, &$matches ) { if ( null === $this->core_file_pattern ) { $this->core_file_pattern = sprintf( ':%s%s:s', preg_quote( trailingslashit( wp_normalize_path( ABSPATH ) ), ':' ), self::CORE_FILE_PATTERN ); }
return preg_match( $this->core_file_pattern, $file, $matches ); }
/** * Get a new file source array. * * @param string $type Type of the file source. * @param string $name Name of the file source. * @param string $file File reference for the file source. * * @return string[] File source array. */ private function get_file_source_array( $type, $name, $file ) { return [ self::SOURCE_TYPE => $type, self::SOURCE_NAME => $name, self::SOURCE_FILE => $file, ]; } }
|