|
9
|
1 |
/** |
|
|
2 |
* Interactions used by the Site Health modules in WordPress. |
|
|
3 |
* |
|
|
4 |
* @output wp-admin/js/site-health.js |
|
|
5 |
*/ |
|
|
6 |
|
|
|
7 |
/* global ajaxurl, ClipboardJS, SiteHealth, wp */ |
|
|
8 |
|
|
|
9 |
jQuery( document ).ready( function( $ ) { |
|
|
10 |
|
|
|
11 |
var __ = wp.i18n.__, |
|
|
12 |
_n = wp.i18n._n, |
|
16
|
13 |
sprintf = wp.i18n.sprintf, |
|
|
14 |
data, |
|
|
15 |
clipboard = new ClipboardJS( '.site-health-copy-buttons .copy-button' ), |
|
|
16 |
isDebugTab = $( '.health-check-body.health-check-debug-tab' ).length, |
|
|
17 |
pathsSizesSection = $( '#health-check-accordion-block-wp-paths-sizes' ), |
|
|
18 |
successTimeout; |
|
9
|
19 |
|
|
|
20 |
// Debug information copy section. |
|
|
21 |
clipboard.on( 'success', function( e ) { |
|
16
|
22 |
var triggerElement = $( e.trigger ), |
|
|
23 |
successElement = $( '.success', triggerElement.closest( 'div' ) ); |
|
|
24 |
|
|
|
25 |
// Clear the selection and move focus back to the trigger. |
|
|
26 |
e.clearSelection(); |
|
|
27 |
// Handle ClipboardJS focus bug, see https://github.com/zenorocha/clipboard.js/issues/680 |
|
|
28 |
triggerElement.focus(); |
|
|
29 |
|
|
|
30 |
// Show success visual feedback. |
|
|
31 |
clearTimeout( successTimeout ); |
|
|
32 |
successElement.removeClass( 'hidden' ); |
|
9
|
33 |
|
|
16
|
34 |
// Hide success visual feedback after 3 seconds since last success. |
|
|
35 |
successTimeout = setTimeout( function() { |
|
|
36 |
successElement.addClass( 'hidden' ); |
|
|
37 |
// Remove the visually hidden textarea so that it isn't perceived by assistive technologies. |
|
|
38 |
if ( clipboard.clipboardAction.fakeElem && clipboard.clipboardAction.removeFake ) { |
|
|
39 |
clipboard.clipboardAction.removeFake(); |
|
|
40 |
} |
|
|
41 |
}, 3000 ); |
|
|
42 |
|
|
|
43 |
// Handle success audible feedback. |
|
|
44 |
wp.a11y.speak( __( 'Site information has been copied to your clipboard.' ) ); |
|
9
|
45 |
} ); |
|
|
46 |
|
|
|
47 |
// Accordion handling in various areas. |
|
|
48 |
$( '.health-check-accordion' ).on( 'click', '.health-check-accordion-trigger', function() { |
|
|
49 |
var isExpanded = ( 'true' === $( this ).attr( 'aria-expanded' ) ); |
|
|
50 |
|
|
|
51 |
if ( isExpanded ) { |
|
|
52 |
$( this ).attr( 'aria-expanded', 'false' ); |
|
|
53 |
$( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', true ); |
|
|
54 |
} else { |
|
|
55 |
$( this ).attr( 'aria-expanded', 'true' ); |
|
|
56 |
$( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', false ); |
|
|
57 |
} |
|
|
58 |
} ); |
|
|
59 |
|
|
|
60 |
// Site Health test handling. |
|
|
61 |
|
|
|
62 |
$( '.site-health-view-passed' ).on( 'click', function() { |
|
|
63 |
var goodIssuesWrapper = $( '#health-check-issues-good' ); |
|
|
64 |
|
|
|
65 |
goodIssuesWrapper.toggleClass( 'hidden' ); |
|
|
66 |
$( this ).attr( 'aria-expanded', ! goodIssuesWrapper.hasClass( 'hidden' ) ); |
|
|
67 |
} ); |
|
|
68 |
|
|
|
69 |
/** |
|
16
|
70 |
* Appends a new issue to the issue list. |
|
9
|
71 |
* |
|
|
72 |
* @since 5.2.0 |
|
|
73 |
* |
|
|
74 |
* @param {Object} issue The issue data. |
|
|
75 |
*/ |
|
16
|
76 |
function appendIssue( issue ) { |
|
9
|
77 |
var template = wp.template( 'health-check-issue' ), |
|
|
78 |
issueWrapper = $( '#health-check-issues-' + issue.status ), |
|
|
79 |
heading, |
|
|
80 |
count; |
|
16
|
81 |
|
|
9
|
82 |
SiteHealth.site_status.issues[ issue.status ]++; |
|
|
83 |
|
|
|
84 |
count = SiteHealth.site_status.issues[ issue.status ]; |
|
|
85 |
|
|
|
86 |
if ( 'critical' === issue.status ) { |
|
16
|
87 |
heading = sprintf( |
|
|
88 |
_n( '%s critical issue', '%s critical issues', count ), |
|
|
89 |
'<span class="issue-count">' + count + '</span>' |
|
|
90 |
); |
|
9
|
91 |
} else if ( 'recommended' === issue.status ) { |
|
16
|
92 |
heading = sprintf( |
|
|
93 |
_n( '%s recommended improvement', '%s recommended improvements', count ), |
|
|
94 |
'<span class="issue-count">' + count + '</span>' |
|
|
95 |
); |
|
9
|
96 |
} else if ( 'good' === issue.status ) { |
|
16
|
97 |
heading = sprintf( |
|
|
98 |
_n( '%s item with no issues detected', '%s items with no issues detected', count ), |
|
|
99 |
'<span class="issue-count">' + count + '</span>' |
|
|
100 |
); |
|
9
|
101 |
} |
|
|
102 |
|
|
|
103 |
if ( heading ) { |
|
|
104 |
$( '.site-health-issue-count-title', issueWrapper ).html( heading ); |
|
|
105 |
} |
|
|
106 |
|
|
|
107 |
$( '.issues', '#health-check-issues-' + issue.status ).append( template( issue ) ); |
|
|
108 |
} |
|
|
109 |
|
|
|
110 |
/** |
|
16
|
111 |
* Updates site health status indicator as asynchronous tests are run and returned. |
|
9
|
112 |
* |
|
|
113 |
* @since 5.2.0 |
|
|
114 |
*/ |
|
16
|
115 |
function recalculateProgression() { |
|
9
|
116 |
var r, c, pct; |
|
|
117 |
var $progress = $( '.site-health-progress' ); |
|
16
|
118 |
var $wrapper = $progress.closest( '.site-health-progress-wrapper' ); |
|
|
119 |
var $progressLabel = $( '.site-health-progress-label', $wrapper ); |
|
9
|
120 |
var $circle = $( '.site-health-progress svg #bar' ); |
|
16
|
121 |
var totalTests = parseInt( SiteHealth.site_status.issues.good, 0 ) + |
|
|
122 |
parseInt( SiteHealth.site_status.issues.recommended, 0 ) + |
|
|
123 |
( parseInt( SiteHealth.site_status.issues.critical, 0 ) * 1.5 ); |
|
|
124 |
var failedTests = ( parseInt( SiteHealth.site_status.issues.recommended, 0 ) * 0.5 ) + |
|
|
125 |
( parseInt( SiteHealth.site_status.issues.critical, 0 ) * 1.5 ); |
|
9
|
126 |
var val = 100 - Math.ceil( ( failedTests / totalTests ) * 100 ); |
|
|
127 |
|
|
|
128 |
if ( 0 === totalTests ) { |
|
|
129 |
$progress.addClass( 'hidden' ); |
|
|
130 |
return; |
|
|
131 |
} |
|
|
132 |
|
|
16
|
133 |
$wrapper.removeClass( 'loading' ); |
|
9
|
134 |
|
|
|
135 |
r = $circle.attr( 'r' ); |
|
|
136 |
c = Math.PI * ( r * 2 ); |
|
|
137 |
|
|
|
138 |
if ( 0 > val ) { |
|
|
139 |
val = 0; |
|
|
140 |
} |
|
|
141 |
if ( 100 < val ) { |
|
|
142 |
val = 100; |
|
|
143 |
} |
|
|
144 |
|
|
|
145 |
pct = ( ( 100 - val ) / 100 ) * c; |
|
|
146 |
|
|
|
147 |
$circle.css( { strokeDashoffset: pct } ); |
|
|
148 |
|
|
|
149 |
if ( 1 > parseInt( SiteHealth.site_status.issues.critical, 0 ) ) { |
|
|
150 |
$( '#health-check-issues-critical' ).addClass( 'hidden' ); |
|
|
151 |
} |
|
|
152 |
|
|
|
153 |
if ( 1 > parseInt( SiteHealth.site_status.issues.recommended, 0 ) ) { |
|
|
154 |
$( '#health-check-issues-recommended' ).addClass( 'hidden' ); |
|
|
155 |
} |
|
|
156 |
|
|
16
|
157 |
if ( 80 <= val && 0 === parseInt( SiteHealth.site_status.issues.critical, 0 ) ) { |
|
|
158 |
$wrapper.addClass( 'green' ).removeClass( 'orange' ); |
|
9
|
159 |
|
|
16
|
160 |
$progressLabel.text( __( 'Good' ) ); |
|
|
161 |
wp.a11y.speak( __( 'All site health tests have finished running. Your site is looking good, and the results are now available on the page.' ) ); |
|
|
162 |
} else { |
|
|
163 |
$wrapper.addClass( 'orange' ).removeClass( 'green' ); |
|
|
164 |
|
|
|
165 |
$progressLabel.text( __( 'Should be improved' ) ); |
|
|
166 |
wp.a11y.speak( __( 'All site health tests have finished running. There are items that should be addressed, and the results are now available on the page.' ) ); |
|
9
|
167 |
} |
|
|
168 |
|
|
|
169 |
if ( ! isDebugTab ) { |
|
|
170 |
$.post( |
|
|
171 |
ajaxurl, |
|
|
172 |
{ |
|
|
173 |
'action': 'health-check-site-status-result', |
|
|
174 |
'_wpnonce': SiteHealth.nonce.site_status_result, |
|
|
175 |
'counts': SiteHealth.site_status.issues |
|
|
176 |
} |
|
|
177 |
); |
|
|
178 |
|
|
16
|
179 |
if ( 100 === val ) { |
|
|
180 |
$( '.site-status-all-clear' ).removeClass( 'hide' ); |
|
|
181 |
$( '.site-status-has-issues' ).addClass( 'hide' ); |
|
|
182 |
} |
|
9
|
183 |
} |
|
|
184 |
} |
|
|
185 |
|
|
|
186 |
/** |
|
16
|
187 |
* Queues the next asynchronous test when we're ready to run it. |
|
9
|
188 |
* |
|
|
189 |
* @since 5.2.0 |
|
|
190 |
*/ |
|
|
191 |
function maybeRunNextAsyncTest() { |
|
|
192 |
var doCalculation = true; |
|
|
193 |
|
|
|
194 |
if ( 1 <= SiteHealth.site_status.async.length ) { |
|
|
195 |
$.each( SiteHealth.site_status.async, function() { |
|
|
196 |
var data = { |
|
|
197 |
'action': 'health-check-' + this.test.replace( '_', '-' ), |
|
|
198 |
'_wpnonce': SiteHealth.nonce.site_status |
|
|
199 |
}; |
|
|
200 |
|
|
|
201 |
if ( this.completed ) { |
|
|
202 |
return true; |
|
|
203 |
} |
|
|
204 |
|
|
|
205 |
doCalculation = false; |
|
|
206 |
|
|
|
207 |
this.completed = true; |
|
|
208 |
|
|
|
209 |
$.post( |
|
|
210 |
ajaxurl, |
|
|
211 |
data, |
|
|
212 |
function( response ) { |
|
16
|
213 |
/** This filter is documented in wp-admin/includes/class-wp-site-health.php */ |
|
|
214 |
appendIssue( wp.hooks.applyFilters( 'site_status_test_result', response.data ) ); |
|
9
|
215 |
maybeRunNextAsyncTest(); |
|
|
216 |
} |
|
|
217 |
); |
|
|
218 |
|
|
|
219 |
return false; |
|
|
220 |
} ); |
|
|
221 |
} |
|
|
222 |
|
|
|
223 |
if ( doCalculation ) { |
|
16
|
224 |
recalculateProgression(); |
|
9
|
225 |
} |
|
|
226 |
} |
|
|
227 |
|
|
|
228 |
if ( 'undefined' !== typeof SiteHealth && ! isDebugTab ) { |
|
|
229 |
if ( 0 === SiteHealth.site_status.direct.length && 0 === SiteHealth.site_status.async.length ) { |
|
16
|
230 |
recalculateProgression(); |
|
9
|
231 |
} else { |
|
|
232 |
SiteHealth.site_status.issues = { |
|
|
233 |
'good': 0, |
|
|
234 |
'recommended': 0, |
|
|
235 |
'critical': 0 |
|
|
236 |
}; |
|
|
237 |
} |
|
|
238 |
|
|
|
239 |
if ( 0 < SiteHealth.site_status.direct.length ) { |
|
|
240 |
$.each( SiteHealth.site_status.direct, function() { |
|
16
|
241 |
appendIssue( this ); |
|
9
|
242 |
} ); |
|
|
243 |
} |
|
|
244 |
|
|
|
245 |
if ( 0 < SiteHealth.site_status.async.length ) { |
|
|
246 |
data = { |
|
|
247 |
'action': 'health-check-' + SiteHealth.site_status.async[0].test.replace( '_', '-' ), |
|
|
248 |
'_wpnonce': SiteHealth.nonce.site_status |
|
|
249 |
}; |
|
|
250 |
|
|
|
251 |
SiteHealth.site_status.async[0].completed = true; |
|
|
252 |
|
|
|
253 |
$.post( |
|
|
254 |
ajaxurl, |
|
|
255 |
data, |
|
|
256 |
function( response ) { |
|
16
|
257 |
appendIssue( response.data ); |
|
9
|
258 |
maybeRunNextAsyncTest(); |
|
|
259 |
} |
|
|
260 |
); |
|
|
261 |
} else { |
|
16
|
262 |
recalculateProgression(); |
|
9
|
263 |
} |
|
|
264 |
} |
|
|
265 |
|
|
|
266 |
function getDirectorySizes() { |
|
|
267 |
var data = { |
|
|
268 |
action: 'health-check-get-sizes', |
|
|
269 |
_wpnonce: SiteHealth.nonce.site_status_result |
|
|
270 |
}; |
|
|
271 |
|
|
|
272 |
var timestamp = ( new Date().getTime() ); |
|
|
273 |
|
|
|
274 |
// After 3 seconds announce that we're still waiting for directory sizes. |
|
|
275 |
var timeout = window.setTimeout( function() { |
|
|
276 |
wp.a11y.speak( __( 'Please wait...' ) ); |
|
|
277 |
}, 3000 ); |
|
|
278 |
|
|
|
279 |
$.post( { |
|
|
280 |
type: 'POST', |
|
|
281 |
url: ajaxurl, |
|
|
282 |
data: data, |
|
|
283 |
dataType: 'json' |
|
|
284 |
} ).done( function( response ) { |
|
|
285 |
updateDirSizes( response.data || {} ); |
|
|
286 |
} ).always( function() { |
|
|
287 |
var delay = ( new Date().getTime() ) - timestamp; |
|
|
288 |
|
|
|
289 |
$( '.health-check-wp-paths-sizes.spinner' ).css( 'visibility', 'hidden' ); |
|
16
|
290 |
recalculateProgression(); |
|
9
|
291 |
|
|
|
292 |
if ( delay > 3000 ) { |
|
16
|
293 |
/* |
|
|
294 |
* We have announced that we're waiting. |
|
|
295 |
* Announce that we're ready after giving at least 3 seconds |
|
|
296 |
* for the first announcement to be read out, or the two may collide. |
|
|
297 |
*/ |
|
9
|
298 |
if ( delay > 6000 ) { |
|
|
299 |
delay = 0; |
|
|
300 |
} else { |
|
|
301 |
delay = 6500 - delay; |
|
|
302 |
} |
|
|
303 |
|
|
|
304 |
window.setTimeout( function() { |
|
|
305 |
wp.a11y.speak( __( 'All site health tests have finished running.' ) ); |
|
|
306 |
}, delay ); |
|
|
307 |
} else { |
|
|
308 |
// Cancel the announcement. |
|
|
309 |
window.clearTimeout( timeout ); |
|
|
310 |
} |
|
|
311 |
|
|
|
312 |
$( document ).trigger( 'site-health-info-dirsizes-done' ); |
|
|
313 |
} ); |
|
|
314 |
} |
|
|
315 |
|
|
|
316 |
function updateDirSizes( data ) { |
|
|
317 |
var copyButton = $( 'button.button.copy-button' ); |
|
16
|
318 |
var clipboardText = copyButton.attr( 'data-clipboard-text' ); |
|
9
|
319 |
|
|
|
320 |
$.each( data, function( name, value ) { |
|
|
321 |
var text = value.debug || value.size; |
|
|
322 |
|
|
|
323 |
if ( typeof text !== 'undefined' ) { |
|
16
|
324 |
clipboardText = clipboardText.replace( name + ': loading...', name + ': ' + text ); |
|
9
|
325 |
} |
|
|
326 |
} ); |
|
|
327 |
|
|
16
|
328 |
copyButton.attr( 'data-clipboard-text', clipboardText ); |
|
9
|
329 |
|
|
|
330 |
pathsSizesSection.find( 'td[class]' ).each( function( i, element ) { |
|
|
331 |
var td = $( element ); |
|
|
332 |
var name = td.attr( 'class' ); |
|
|
333 |
|
|
|
334 |
if ( data.hasOwnProperty( name ) && data[ name ].size ) { |
|
|
335 |
td.text( data[ name ].size ); |
|
|
336 |
} |
|
|
337 |
} ); |
|
|
338 |
} |
|
|
339 |
|
|
|
340 |
if ( isDebugTab ) { |
|
|
341 |
if ( pathsSizesSection.length ) { |
|
|
342 |
getDirectorySizes(); |
|
|
343 |
} else { |
|
16
|
344 |
recalculateProgression(); |
|
9
|
345 |
} |
|
|
346 |
} |
|
|
347 |
} ); |