Util_Rule.php
10.4 KB
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
<?php
namespace W3TC;
class Util_Rule {
/*
* Returns URI from filename/dirname
* Used for rules mainly since is not usable for regular URI,
* because wordpress adds blogname to uri making it uncompatible with
* directory structure
*
* @return string
*/
static public function filename_to_uri( $filename ) {
$url = Util_Environment::filename_to_url( $filename );
$parsed = parse_url( $url );
$uri = isset( $parsed['path'] ) ? ltrim( $parsed['path'], DIRECTORY_SEPARATOR ) : '';
$uri = '/' . $uri;
return $uri;
}
/**
* Check if WP permalink directives exists
*
* @return boolean
*/
static public function is_permalink_rules() {
if ( ( Util_Environment::is_apache() || Util_Environment::is_litespeed() ) && !Util_Environment::is_wpmu() ) {
$path = Util_Rule::get_pgcache_rules_core_path();
return ( $data = @file_get_contents( $path ) ) &&
strstr( $data, W3TC_MARKER_BEGIN_WORDPRESS ) !== false;
}
return true;
}
/**
* Removes empty elements
*/
static public function array_trim( &$a ) {
for ( $n = count( $a ) - 1; $n >= 0; $n-- ) {
if ( empty( $a[$n] ) )
array_splice( $a, $n, 1 );
}
}
/**
* Returns nginx rules path
*
* @return string
*/
static public function get_nginx_rules_path() {
$config = Dispatcher::config();
$path = $config->get_string( 'config.path' );
if ( !$path ) {
$path = Util_Environment::site_path() . 'nginx.conf';
}
return $path;
}
/**
* Returns path of pagecache core rules file
*
* @return string
*/
static public function get_pgcache_rules_core_path() {
switch ( true ) {
case Util_Environment::is_apache():
case Util_Environment::is_litespeed():
return Util_Environment::site_path() . '.htaccess';
case Util_Environment::is_nginx():
return Util_Rule::get_nginx_rules_path();
}
return false;
}
/**
* Returns path of browsercache cache rules file
*
* @return string
*/
static public function get_browsercache_rules_cache_path() {
return Util_Rule::get_pgcache_rules_core_path();
}
/**
* Returns path of browsercache no404wp rules file
*
* @return string
*/
static public function get_browsercache_rules_no404wp_path() {
return Util_Rule::get_pgcache_rules_core_path();
}
/**
* Returns path of minify rules file
*
* @return string
*/
static public function get_minify_rules_core_path() {
switch ( true ) {
case Util_Environment::is_apache():
case Util_Environment::is_litespeed():
return W3TC_CACHE_MINIFY_DIR . DIRECTORY_SEPARATOR . '.htaccess';
case Util_Environment::is_nginx():
return Util_Rule::get_nginx_rules_path();
}
return false;
}
/**
* Returns path of minify rules file
*
* @return string
*/
static public function get_minify_rules_cache_path() {
switch ( true ) {
case Util_Environment::is_apache():
case Util_Environment::is_litespeed():
return W3TC_CACHE_MINIFY_DIR . DIRECTORY_SEPARATOR . '.htaccess';
case Util_Environment::is_nginx():
return Util_Rule::get_nginx_rules_path();
}
return false;
}
/**
* Returns path of CDN rules file
*
* @return string
*/
static public function get_cdn_rules_path() {
switch ( true ) {
case Util_Environment::is_apache():
case Util_Environment::is_litespeed():
return '.htaccess';
case Util_Environment::is_nginx():
return 'nginx.conf';
}
return false;
}
static public function get_new_relic_rules_core_path() {
return Util_Rule::get_pgcache_rules_core_path();
}
/**
* Returns true if we can modify rules
*
* @param string $path
* @return boolean
*/
static public function can_modify_rules( $path ) {
if ( Util_Environment::is_wpmu() ) {
if ( Util_Environment::is_apache() || Util_Environment::is_litespeed() || Util_Environment::is_nginx() ) {
switch ( $path ) {
case Util_Rule::get_pgcache_rules_cache_path():
case Util_Rule::get_minify_rules_core_path():
case Util_Rule::get_minify_rules_cache_path():
return true;
}
}
return false;
}
return true;
}
/**
* Trim rules
*
* @param string $rules
* @return string
*/
static public function trim_rules( $rules ) {
$rules = trim( $rules );
if ( $rules != '' ) {
$rules .= "\n";
}
return $rules;
}
/**
* Cleanup rewrite rules
*
* @param string $rules
* @return string
*/
static public function clean_rules( $rules ) {
$rules = preg_replace( '~[\r\n]+~', "\n", $rules );
$rules = preg_replace( '~^\s+~m', '', $rules );
$rules = Util_Rule::trim_rules( $rules );
return $rules;
}
/**
* Erases text from start to end
*
* @param string $rules
* @param string $start
* @param string $end
* @return string
*/
static public function erase_rules( $rules, $start, $end ) {
$r = '~' . Util_Environment::preg_quote( $start ) . "\n.*?" . Util_Environment::preg_quote( $end ) . "\n*~s";
$rules = preg_replace( $r, '', $rules );
$rules = Util_Rule::trim_rules( $rules );
return $rules;
}
/**
* Check if rules exist
*
* @param string $rules
* @param string $start
* @param string $end
* @return int
*/
static public function has_rules( $rules, $start, $end ) {
return preg_match( '~' . Util_Environment::preg_quote( $start ) . "\n.*?" . Util_Environment::preg_quote( $end ) . "\n*~s", $rules );
}
/**
*
*
* @param Util_Environment_Exceptions $exs
* @param string $path
* @param string $rules
* @param string $start
* @param string $end
* @param array $order
*/
static public function add_rules( $exs, $path, $rules, $start, $end, $order ) {
if ( empty( $path ) )
return;
$data = @file_get_contents( $path );
if ( $data === false )
$data = '';
$rules_missing = !empty( $rules ) && ( strstr( Util_Rule::clean_rules( $data ), Util_Rule::clean_rules( $rules ) ) === false );
if ( !$rules_missing )
return;
$replace_start = strpos( $data, $start );
$replace_end = strpos( $data, $end );
if ( $replace_start !== false && $replace_end !== false && $replace_start < $replace_end ) {
$replace_length = $replace_end - $replace_start + strlen( $end ) + 1;
} else {
$replace_start = false;
$replace_length = 0;
$search = $order;
foreach ( $search as $string => $length ) {
$replace_start = strpos( $data, $string );
if ( $replace_start !== false ) {
$replace_start += $length;
break;
}
}
}
if ( $replace_start !== false ) {
$data = Util_Rule::trim_rules( substr_replace( $data, $rules, $replace_start, $replace_length ) );
} else {
$data = Util_Rule::trim_rules( $data . $rules );
}
if ( strpos( $path, W3TC_CACHE_DIR ) === false || Util_Environment::is_nginx() ) {
try {
Util_WpFile::write_to_file( $path, $data );
} catch ( Util_WpFile_FilesystemOperationException $ex ) {
if ( $replace_start !== false )
$exs->push( new Util_WpFile_FilesystemModifyException(
$ex->getMessage(), $ex->credentials_form(),
sprintf( __( 'Edit file <strong>%s
</strong> and replace all lines between and including <strong>%s</strong> and
<strong>%s</strong> markers with:', 'w3-total-caceh' ), $path, $start, $end ), $path, $rules ) );
else
$exs->push( new Util_WpFile_FilesystemModifyException(
$ex->getMessage(), $ex->credentials_form(),
sprintf( __( 'Edit file <strong>%s</strong> and add the following rules
above the WordPress directives:', 'w3-total-cache' ),
$path ), $path, $rules ) );
return;
}
} else {
if ( !@file_exists( dirname( $path ) ) ) {
Util_File::mkdir_from( dirname( $path ), W3TC_CACHE_DIR );
}
if ( !@file_put_contents( $path, $data ) ) {
try {
Util_WpFile::delete_folder( dirname( $path ), '',
$_SERVER['REQUEST_URI'] );
} catch ( Util_WpFile_FilesystemOperationException $ex ) {
$exs->push( $ex );
return;
}
}
}
Util_Rule::after_rules_modified();
}
/**
* Called when rules are modified, sets notification
*/
static public function after_rules_modified() {
if ( Util_Environment::is_nginx() ) {
$state = Dispatcher::config_state_master();
$state->set( 'common.show_note.nginx_restart_required', true );
$state->save();
}
}
/**
* Remove rules
*/
static public function remove_rules( $exs, $path, $start, $end ) {
if ( !file_exists( $path ) )
return;
$data = @file_get_contents( $path );
if ( $data === false )
return;
if ( strstr( $data, $start ) === false )
return;
$data = Util_Rule::erase_rules( $data, $start,
$end );
try {
Util_WpFile::write_to_file( $path, $data );
} catch ( Util_WpFile_FilesystemOperationException $ex ) {
$exs->push( new Util_WpFile_FilesystemModifyException(
$ex->getMessage(), $ex->credentials_form(),
sprintf( __( 'Edit file <strong>%s</strong> and remove all lines between and including <strong>%s</strong>
and <strong>%s</strong> markers.', 'w3-total-cache' ), $path, $start, $end ), $path ) );
}
}
/**
* Returns path of pgcache cache rules file
* Moved to separate file to not load rule.php for each disk enhanced request
*
* @return string
*/
static public function get_pgcache_rules_cache_path() {
switch ( true ) {
case Util_Environment::is_apache():
case Util_Environment::is_litespeed():
if ( Util_Environment::is_wpmu() ) {
$url = get_home_url();
$match = null;
if ( preg_match( '~http(s)?://(.+?)(/)?$~', $url, $match ) ) {
$home_path = $match[2];
return W3TC_CACHE_PAGE_ENHANCED_DIR . DIRECTORY_SEPARATOR .
$home_path . DIRECTORY_SEPARATOR . '.htaccess';
}
}
return W3TC_CACHE_PAGE_ENHANCED_DIR . DIRECTORY_SEPARATOR . '.htaccess';
case Util_Environment::is_nginx():
return Util_Rule::get_nginx_rules_path();
}
return false;
}
/**
* Returns true if we can check rules
*
* @return bool
*/
static public function can_check_rules() {
return Util_Environment::is_apache() || Util_Environment::is_litespeed() || Util_Environment::is_nginx();
}
/**
* Support for GoDaddy servers configuration which uses
* SUBDOMAIN_DOCUMENT_ROOT variable
*/
static public function apache_docroot_variable() {
if ( isset( $_SERVER['SUBDOMAIN_DOCUMENT_ROOT'] ) &&
$_SERVER['SUBDOMAIN_DOCUMENT_ROOT'] != $_SERVER['DOCUMENT_ROOT'] )
return '%{ENV:SUBDOMAIN_DOCUMENT_ROOT}';
elseif ( isset( $_SERVER['PHP_DOCUMENT_ROOT'] ) &&
$_SERVER['PHP_DOCUMENT_ROOT'] != $_SERVER['DOCUMENT_ROOT'] )
return '%{ENV:PHP_DOCUMENT_ROOT}';
else
return '%{DOCUMENT_ROOT}';
}
}