-
Notifications
You must be signed in to change notification settings - Fork 80
/
Cdn_AdminNotes.php
286 lines (247 loc) · 11.5 KB
/
Cdn_AdminNotes.php
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
<?php
namespace W3TC;
class Cdn_AdminNotes {
/**
*
*
* @param Config $config
* @return array
*/
public function w3tc_notes( $notes ) {
$config = Dispatcher::config();
$state = Dispatcher::config_state();
$cdn_engine = $config->get_string( 'cdn.engine' );
$page = Util_Request::get_string( 'page' );
if ( !Cdn_Util::is_engine_mirror( $cdn_engine ) ) {
/**
* Show notification after theme change
*/
if ( $state->get_boolean( 'cdn.show_note_theme_changed' ) ) {
$notes['cdn_theme_changed'] = sprintf(
__( 'The active theme has changed, please %s now to ensure proper operation. %s',
'w3-total-cache' ),
Util_Ui::button_popup(
__( 'upload active theme files', 'w3-total-cache' ),
'cdn_export',
'cdn_export_type=theme' ),
Util_Ui::button_hide_note2( array(
'w3tc_default_config_state' => 'y',
'key' => 'cdn.show_note_theme_changed',
'value' => 'false' ) ) );
}
/**
* Show notification after WP upgrade
*/
if ( $state->get_boolean( 'cdn.show_note_wp_upgraded' ) ) {
$notes['cdn_wp_upgraded'] = sprintf(
__( 'Upgraded WordPress? Please %s files now to ensure proper operation. %s',
'w3-total-cache' ),
Util_Ui::button_popup( 'upload wp-includes', 'cdn_export',
'cdn_export_type=includes' ),
Util_Ui::button_hide_note2( array(
'w3tc_default_config_state' => 'y',
'key' => 'cdn.show_note_wp_upgraded',
'value' => 'false' ) ) );
}
/**
* Show notification after CDN enable
*/
if ( $state->get_boolean( 'cdn.show_note_cdn_upload' ) ||
$state->get_boolean( 'cdn.show_note_cdn_reupload' ) ) {
$cdn_upload_buttons = array();
if ( $config->get_boolean( 'cdn.includes.enable' ) ) {
$cdn_upload_buttons[] = Util_Ui::button_popup(
'wp-includes', 'cdn_export', 'cdn_export_type=includes' );
}
if ( $config->get_boolean( 'cdn.theme.enable' ) ) {
$cdn_upload_buttons[] = Util_Ui::button_popup(
'theme files', 'cdn_export', 'cdn_export_type=theme' );
}
if ( $config->get_boolean( 'minify.enabled' ) &&
$config->get_boolean( 'cdn.minify.enable' ) &&
!$config->get_boolean( 'minify.auto' ) ) {
$cdn_upload_buttons[] = Util_Ui::button_popup(
'minify files', 'cdn_export',
'cdn_export_type=minify' );
}
if ( $config->get_boolean( 'cdn.custom.enable' ) ) {
$cdn_upload_buttons[] = Util_Ui::button_popup(
'custom files', 'cdn_export', 'cdn_export_type=custom' );
}
if ( $state->get_boolean( 'cdn.show_note_cdn_upload' ) ) {
$notes[] = sprintf(
__( 'Make sure to %s and upload the %s, files to the <acronym title="Content Delivery Network">CDN</acronym> to ensure proper operation. %s',
'w3-total-cache' ),
Util_Ui::button_popup( 'export the media library',
'cdn_export_library' ),
implode( ', ', $cdn_upload_buttons ),
Util_Ui::button_hide_note2( array(
'w3tc_default_config_state' => 'y',
'key' => 'cdn.show_note_cdn_upload',
'value' => 'false' ) ) );
}
if ( $state->get_boolean( 'cdn.show_note_cdn_reupload' ) ) {
$notes[] = sprintf(
__( 'Settings that affect Browser Cache settings for files hosted by the CDN have been changed. To apply the new settings %s and %s. %s',
'w3-total-cache' ),
Util_Ui::button_popup(
__( 'export the media library', 'w3-total-cache' ),
'cdn_export_library' ),
implode( ', ', $cdn_upload_buttons ),
Util_Ui::button_hide_note2( array(
'w3tc_default_config_state' => 'y',
'key' => 'cdn.show_note_cdn_reupload',
'value' => 'false' ) ) );
}
}
}
/**
* Check CURL extension
*/
if ( !$state->get_boolean( 'cdn.hide_note_no_curl' ) &&
!function_exists( 'curl_init' ) ) {
$notes[] = sprintf(
__( 'The <strong>CURL PHP</strong> extension is not available. Please install it to enable S3 or CloudFront functionality. %s',
'w3-total-cache' ),
Util_Ui::button_hide_note2( array(
'w3tc_default_config_state' => 'y',
'key' => 'cdn.hide_note_no_curl',
'value' => 'true' ) ) );
}
if ( 'maxcdn' === $cdn_engine ) {
$notes[] = sprintf(
// translators: 1: Opening anchor tag with a link to the CDN settings page, 2: closing anchor tag, 3 opening anchor tag to MaxCDN/StackPath migration guide.
__(
'MaxCDN has been replaced with StackPath CDN. As a result your configuration is now invalid and requires reconfiguration to a new %1$sCDN provider%2$s. You can migrate to StackPath using %3$sthis guide%2$s.',
'w3-total-cache'
),
'<a href="' . esc_url( admin_url( 'admin.php?page=w3tc_general#cdn' ) ) . '">',
'</a>',
'<a href="' . esc_url( 'https://support.stackpath.com/hc/en-us/articles/10408946467739-MaxCDN-Migration-to-StackPath-Instructions' ) . '" target="_blank">'
);
}
return $notes;
}
function w3tc_errors( $errors ) {
$c = Dispatcher::config();
$state = Dispatcher::config_state();
$cdn_engine = $c->get_string( 'cdn.engine' );
if ( Cdn_Util::is_engine_push( $cdn_engine ) ) {
/**
* Show notification if upload queue is not empty
*/
try {
if ( !( $error = get_transient( 'w3tc_cdn_error' ) ) &&
!$this->_is_queue_empty() ) {
$errors['cdn_unsuccessful_queue'] = sprintf(
__( 'The %s has unresolved errors. Empty the queue to restore normal operation.',
'w3-total-cache' ),
Util_Ui::button_popup(
__( 'unsuccessful transfer queue', 'w3-total-cache' ), 'cdn_queue' ) );
} elseif ( $error ) {
$errors['cdn_generic'] = $error;
}
} catch ( \Exception $ex ) {
$errors[] = $ex->getMessage();
set_transient( 'w3tc_cdn_error', $ex->getMessage(), 30 );
}
/**
* Check upload settings
*/
$upload_info = Util_Http::upload_info();
if ( !$upload_info ) {
$upload_path = get_option( 'upload_path' );
$upload_path = trim( $upload_path );
if ( empty( $upload_path ) ) {
$upload_path = WP_CONTENT_DIR . '/uploads';
$errors['cdn_uploads_folder_empty'] = sprintf(
__( 'The uploads directory is not available. Default WordPress directories will be created: <strong>%s</strong>.',
'w3-total-cache' ),
$upload_path );
}
if ( !Util_Environment::is_wpmu() ) {
$errors['cdn_uploads_folder_not_found'] = sprintf(
__( 'The uploads path found in the database (%s) is inconsistent with the actual path. Please manually adjust the upload path either in miscellaneous settings or if not using a custom path %s automatically to resolve the issue.',
'w3-total-cache' ),
$upload_path,
Util_Ui::button_link( __( 'update the path', 'w3-total-cache' ),
Util_Ui::url( array(
'w3tc_config_update_upload_path' => 'y' ) ) ) );
}
}
}
/**
* Check CDN settings
*/
$error = '';
switch ( true ) {
case ( $cdn_engine == 'ftp' && !count( $c->get_array( 'cdn.ftp.domain' ) ) ):
$errors['cdn_ftp_empty'] = __( 'A configuration issue prevents <acronym title="Content Delivery Network">CDN</acronym> from working:
The <strong>"Replace default hostname with"</strong>
field cannot be empty. Enter <acronym
title="Content Delivery Network">CDN</acronym>
provider hostname <a href="?page=w3tc_cdn#configuration">here</a>.
<em>(This is the hostname used in order to view objects
in a browser.)</em>', 'w3-total-cache' );
break;
case ( $cdn_engine == 's3' && ( $c->get_string( 'cdn.s3.key' ) == '' || $c->get_string( 'cdn.s3.secret' ) == '' || $c->get_string( 'cdn.s3.bucket' ) == '' ) ):
$error = __( 'The <strong>"Access key", "Secret key" and "Bucket"</strong> fields cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'cf' && ( $c->get_string( 'cdn.cf.key' ) == '' || $c->get_string( 'cdn.cf.secret' ) == '' || $c->get_string( 'cdn.cf.bucket' ) == '' || ( $c->get_string( 'cdn.cf.id' ) == '' && !count( $c->get_array( 'cdn.cf.cname' ) ) ) ) ):
$error = __( 'The <strong>"Access key", "Secret key", "Bucket" and "Replace default hostname with"</strong> fields cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'cf2' && ( $c->get_string( 'cdn.cf2.key' ) == '' || $c->get_string( 'cdn.cf2.secret' ) == '' || ( $c->get_string( 'cdn.cf2.id' ) == '' && !count( $c->get_array( 'cdn.cf2.cname' ) ) ) ) ):
$error = __( 'The <strong>"Access key", "Secret key" and "Replace default hostname with"</strong> fields cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'rscf' && ( $c->get_string( 'cdn.rscf.user' ) == '' || $c->get_string( 'cdn.rscf.key' ) == '' || $c->get_string( 'cdn.rscf.container' ) == '' ) ):
$error = __( 'The <strong>"Username", "API key", "Container" and "Replace default hostname with"</strong> fields cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'azure' && ( $c->get_string( 'cdn.azure.user' ) == '' || $c->get_string( 'cdn.azure.key' ) == '' || $c->get_string( 'cdn.azure.container' ) == '' ) ):
$error = __( 'The <strong>"Account name", "Account key" and "Container"</strong> fields cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'mirror' && !count( $c->get_array( 'cdn.mirror.domain' ) ) ):
$error = __( 'The <strong>"Replace default hostname with"</strong> field cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'cotendo' && !count( $c->get_array( 'cdn.cotendo.domain' ) ) ):
$error = __( 'The <strong>"Replace default hostname with"</strong> field cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'edgecast' && !count( $c->get_array( 'cdn.edgecast.domain' ) ) ):
$error = __( 'The <strong>"Replace default hostname with"</strong> field cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'att' && !count( $c->get_array( 'cdn.att.domain' ) ) ):
$error = __( 'The <strong>"Replace default hostname with"</strong> field cannot be empty.', 'w3-total-cache' );
break;
case ( $cdn_engine == 'akamai' && !count( $c->get_array( 'cdn.akamai.domain' ) ) ):
$error = 'The <strong>"Replace default hostname with"</strong> field cannot be empty.';
break;
}
if ( $error ) {
$errors['cdn_not_configured'] = __( 'A configuration issue prevents <acronym title="Content Delivery Network">CDN</acronym> from working: ', 'w3-total-cache' ) . $error . __( ' <a href="?page=w3tc_cdn#configuration">Specify it here</a>.', 'w3-total-cache' );
}
return $errors;
}
/**
* Returns true if upload queue is empty
*
* @return bool
* @throws Exception
*/
private function _is_queue_empty() {
global $wpdb;
$wpdb->hide_errors();
$sql = sprintf( 'SELECT COUNT(*) FROM %s', $wpdb->base_prefix . W3TC_CDN_TABLE_QUEUE );
$result = $wpdb->get_var( $sql );
if ( ( $error = $wpdb->last_error ) ) {
if ( strpos( $error, "doesn't exist" ) !== false ) {
$url = is_network_admin() ? network_admin_url( 'admin.php?page=w3tc_install' ) : admin_url( 'admin.php?page=w3tc_install' );
throw new \Exception( sprintf(
__( 'Encountered issue with CDN: %s. See %s for instructions of creating correct table.', 'w3-total-cache' ),
$wpdb->last_error,
'<a href="' . $url . '">' . __( 'Install page', 'w3-total-cache' ) . '</a>' ) );
}
else
throw new \Exception( sprintf( __( 'Encountered issue with CDN: %s.', 'w3-total-cache' ), $wpdb->last_error ) );
}
return $result == 0;
}
}