mirror of
https://github.com/WordPress/WordPress.git
synced 2024-07-07 12:25:16 +02:00
5b658df402
This is a first pass at requesting FTP and SSH credentials when needed during shiny updates. Styling and some UX improvements are still needed, but we do show the prompt and use the passed data when doing plugin installs and updates for shiny updates. There are also a couple of areas that we could improve code wise such how we create the requestFilesystemCredentials part of the localized _wpUpdatesSettings. Over the past half century, we've split the atom, we've spliced the gene and we've roamed Tranquility Base. We've reached for the stars and never have we been closer to having them in our grasp. That has nothing to do with shiny updates. Props ericlewis, jorbin, and drewapicture for testing Fixes #31528 Built from https://develop.svn.wordpress.org/trunk@31749 git-svn-id: http://core.svn.wordpress.org/trunk@31730 1a063a9b-81f0-0310-95a4-ce76da25c4cd
483 lines
13 KiB
JavaScript
483 lines
13 KiB
JavaScript
window.wp = window.wp || {};
|
|
|
|
(function( $, wp, pagenow ) {
|
|
wp.updates = {};
|
|
|
|
/**
|
|
* User nonce for ajax calls.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var string
|
|
*/
|
|
wp.updates.ajaxNonce = window._wpUpdatesSettings.ajax_nonce;
|
|
|
|
/**
|
|
* Localized strings.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var object
|
|
*/
|
|
wp.updates.l10n = window._wpUpdatesSettings.l10n;
|
|
|
|
/**
|
|
* Whether filesystem credentials need to be requested from the user.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var bool
|
|
*/
|
|
wp.updates.shouldRequestFilesystemCredentials = window._wpUpdatesSettings.requestFilesystemCredentials;
|
|
|
|
/**
|
|
* Filesystem credentials to be packaged along with the request.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var object
|
|
*/
|
|
wp.updates.filesystemCredentials = {
|
|
ftp: {
|
|
host: null,
|
|
username: null,
|
|
password: null,
|
|
connectionType: null
|
|
},
|
|
ssh: {
|
|
publicKey: null,
|
|
privateKey: null
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Flag if we're waiting for an install/update to complete.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var bool
|
|
*/
|
|
wp.updates.updateLock = false;
|
|
|
|
/**
|
|
* Flag if we've done an install or update successfully.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var bool
|
|
*/
|
|
wp.updates.updateDoneSuccessfully = false;
|
|
|
|
/**
|
|
* If the user tries to install/update a plugin while an install/update is
|
|
* already happening, it can be placed in this queue to perform later.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @var array
|
|
*/
|
|
wp.updates.updateQueue = [];
|
|
|
|
/**
|
|
* Decrement update counts throughout the various menus.
|
|
*
|
|
* @since 3.9.0
|
|
*
|
|
* @param {string} updateType
|
|
*/
|
|
wp.updates.decrementCount = function( upgradeType ) {
|
|
var count,
|
|
pluginCount,
|
|
$adminBarUpdateCount = $( '#wp-admin-bar-updates .ab-label' ),
|
|
$dashboardNavMenuUpdateCount = $( 'a[href="update-core.php"] .update-plugins' ),
|
|
$pluginsMenuItem = $( '#menu-plugins' );
|
|
|
|
|
|
count = $adminBarUpdateCount.text();
|
|
count = parseInt( count, 10 ) - 1;
|
|
if ( count < 0 || isNaN( count ) ) {
|
|
return;
|
|
}
|
|
$( '#wp-admin-bar-updates .ab-item' ).removeAttr( 'title' );
|
|
$adminBarUpdateCount.text( count );
|
|
|
|
|
|
$dashboardNavMenuUpdateCount.each( function( index, elem ) {
|
|
elem.className = elem.className.replace( /count-\d+/, 'count-' + count );
|
|
} );
|
|
$dashboardNavMenuUpdateCount.removeAttr( 'title' );
|
|
$dashboardNavMenuUpdateCount.find( '.update-count' ).text( count );
|
|
|
|
if ( 'plugin' === upgradeType ) {
|
|
pluginCount = $pluginsMenuItem.find( '.plugin-count' ).eq(0).text();
|
|
pluginCount = parseInt( pluginCount, 10 ) - 1;
|
|
if ( pluginCount < 0 || isNaN( pluginCount ) ) {
|
|
return;
|
|
}
|
|
$pluginsMenuItem.find( '.plugin-count' ).text( pluginCount );
|
|
$pluginsMenuItem.find( '.update-plugins' ).each( function( index, elem ) {
|
|
elem.className = elem.className.replace( /count-\d+/, 'count-' + pluginCount );
|
|
} );
|
|
|
|
if (pluginCount > 0 ) {
|
|
$( '.subsubsub .upgrade .count' ).text( '(' + pluginCount + ')' );
|
|
} else {
|
|
$( '.subsubsub .upgrade' ).remove();
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Send an Ajax request to the server to update a plugin.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {string} plugin
|
|
* @param {string} slug
|
|
*/
|
|
wp.updates.updatePlugin = function( plugin, slug ) {
|
|
var $message;
|
|
if ( 'plugins' === pagenow || 'plugins-network' === pagenow ) {
|
|
$message = $( '#' + slug ).next().find( '.update-message' );
|
|
} else if ( 'plugin-install' === pagenow ) {
|
|
$message = $( '.plugin-card-' + slug ).find( '.update-now' );
|
|
}
|
|
|
|
$message.addClass( 'updating-message' );
|
|
$message.text( wp.updates.l10n.updating );
|
|
wp.a11y.speak( wp.updates.l10n.updatingMsg );
|
|
|
|
if ( wp.updates.updateLock ) {
|
|
wp.updates.updateQueue.push( {
|
|
type: 'update-plugin',
|
|
data: {
|
|
plugin: plugin,
|
|
slug: slug
|
|
}
|
|
} );
|
|
return;
|
|
}
|
|
|
|
wp.updates.updateLock = true;
|
|
|
|
var data = {
|
|
'_ajax_nonce': wp.updates.ajaxNonce,
|
|
'plugin': plugin,
|
|
'slug': slug,
|
|
username: wp.updates.filesystemCredentials.ftp.username,
|
|
password: wp.updates.filesystemCredentials.ftp.password,
|
|
hostname: wp.updates.filesystemCredentials.ftp.hostname,
|
|
connection_type: wp.updates.filesystemCredentials.ftp.connectionType,
|
|
public_key: wp.updates.filesystemCredentials.ssh.publicKey,
|
|
private_key: wp.updates.filesystemCredentials.ssh.privateKey
|
|
};
|
|
|
|
wp.ajax.post( 'update-plugin', data )
|
|
.done( wp.updates.updateSuccess )
|
|
.fail( wp.updates.updateError )
|
|
.always( wp.updates.updateAlways );
|
|
};
|
|
|
|
/**
|
|
* On a successful plugin update, update the UI with the result.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {object} response
|
|
*/
|
|
wp.updates.updateSuccess = function( response ) {
|
|
var $message;
|
|
if ( 'plugins' === pagenow || 'plugins-network' === pagenow ) {
|
|
$message = $( '#' + response.slug ).next().find( '.update-message' );
|
|
$( '#' + response.slug ).addClass( 'updated' ).removeClass( 'update' );
|
|
$( '#' + response.slug + '-update' ).addClass( 'updated' ).removeClass( 'update' );
|
|
} else if ( 'plugin-install' === pagenow ) {
|
|
$message = $( '.plugin-card-' + response.slug ).find( '.update-now' );
|
|
$message.addClass( 'button-disabled' );
|
|
}
|
|
|
|
$message.removeClass( 'updating-message' ).addClass( 'updated-message' );
|
|
$message.text( wp.updates.l10n.updated );
|
|
wp.a11y.speak( wp.updates.l10n.updatedMsg );
|
|
|
|
wp.updates.decrementCount( 'plugin' );
|
|
|
|
wp.updates.updateDoneSuccessfully = true;
|
|
};
|
|
|
|
/**
|
|
* On a plugin update error, update the UI appropriately.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {object} response
|
|
*/
|
|
wp.updates.updateError = function( response ) {
|
|
var $message;
|
|
wp.updates.updateDoneSuccessfully = false;
|
|
if ( response.errorCode && response.errorCode == 'unable_to_connect_to_filesystem' ) {
|
|
wp.updates.credentialError( response, 'update-plugin' );
|
|
return;
|
|
}
|
|
if ( 'plugins' === pagenow || 'plugins-network' === pagenow ) {
|
|
$message = $( '#' + response.slug ).next().find( '.update-message' );
|
|
} else if ( 'plugin-install' === pagenow ) {
|
|
$message = $( '.plugin-card-' + response.slug ).find( '.update-now' );
|
|
}
|
|
$message.removeClass( 'updating-message' );
|
|
$message.text( wp.updates.l10n.updateFailed );
|
|
wp.a11y.speak( wp.updates.l10n.updateFailed );
|
|
};
|
|
|
|
/**
|
|
* Show an
|
|
*
|
|
* @param {string} message
|
|
* @since 4.2.0
|
|
*/
|
|
wp.updates.showErrorInCredentialsForm = function( message ) {
|
|
var $notificationDialog = $( '.notification-dialog' );
|
|
|
|
// Remove any existing error
|
|
$notificationDialog.find( '.error' ).remove();
|
|
|
|
$notificationDialog.find( 'h3' ).after( '<div class="error">' + message + '</div>' );
|
|
};
|
|
|
|
/**
|
|
* After an update attempt has completed, check the queue.
|
|
*
|
|
* @since 4.2.0
|
|
*/
|
|
wp.updates.updateAlways = function() {
|
|
wp.updates.updateLock = false;
|
|
wp.updates.queueChecker();
|
|
};
|
|
|
|
|
|
/**
|
|
* Send an Ajax request to the server to install a plugin.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {string} slug
|
|
*/
|
|
wp.updates.installPlugin = function( slug ) {
|
|
var $message = $( '.plugin-card-' + slug ).find( '.install-now' );
|
|
|
|
$message.addClass( 'updating-message' );
|
|
$message.text( wp.updates.l10n.installing );
|
|
wp.a11y.speak( wp.updates.l10n.installingMsg );
|
|
|
|
if ( wp.updates.updateLock ) {
|
|
wp.updates.updateQueue.push( {
|
|
type: 'install-plugin',
|
|
data: {
|
|
slug: slug
|
|
}
|
|
} );
|
|
return;
|
|
}
|
|
|
|
wp.updates.updateLock = true;
|
|
|
|
var data = {
|
|
'_ajax_nonce': wp.updates.ajaxNonce,
|
|
'slug': slug,
|
|
'username': wp.updates.filesystemCredentials.ftp.username,
|
|
'password': wp.updates.filesystemCredentials.ftp.password,
|
|
'hostname': wp.updates.filesystemCredentials.ftp.hostname,
|
|
'connection_type': wp.updates.filesystemCredentials.ftp.connectionType,
|
|
'public_key': wp.updates.filesystemCredentials.ssh.publicKey,
|
|
'private_key': wp.updates.filesystemCredentials.ssh.privateKey
|
|
};
|
|
|
|
wp.ajax.post( 'install-plugin', data )
|
|
.done( wp.updates.installSuccess )
|
|
.fail( wp.updates.installError )
|
|
.always( wp.updates.updateAlways );
|
|
};
|
|
|
|
/**
|
|
* On plugin install success, update the UI with the result.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {object} response
|
|
*/
|
|
wp.updates.installSuccess = function( response ) {
|
|
var $message = $( '.plugin-card-' + response.slug ).find( '.install-now' );
|
|
|
|
$message.removeClass( 'updating-message' ).addClass( 'updated-message button-disabled' );
|
|
$message.text( wp.updates.l10n.installed );
|
|
wp.a11y.speak( wp.updates.l10n.installedMsg );
|
|
wp.updates.updateDoneSuccessfully = true;
|
|
};
|
|
|
|
/**
|
|
* On plugin install failure, update the UI appropriately.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @param {object} response
|
|
*/
|
|
wp.updates.installError = function( response ) {
|
|
var $message = $( '.plugin-card-' + response.slug ).find( '.install-now' );
|
|
wp.updates.updateDoneSuccessfully = false;
|
|
if ( response.errorCode && response.errorCode == 'unable_to_connect_to_filesystem' ) {
|
|
wp.updates.credentialError( response, 'update-plugin' );
|
|
return;
|
|
}
|
|
|
|
$message.removeClass( 'updating-message' );
|
|
$message.text( wp.updates.l10n.installNow );
|
|
};
|
|
|
|
/**
|
|
* Events that need to happen when there is a credential error
|
|
*
|
|
* @since 4.2.0
|
|
*/
|
|
wp.updates.credentialError = function( response, type ) {
|
|
wp.updates.updateQueue.push( {
|
|
'type': type,
|
|
'data': {
|
|
// Not cool that we're depending on response for this data.
|
|
// This would feel more whole in a view all tied together.
|
|
plugin: response.plugin,
|
|
slug: response.slug
|
|
}
|
|
} );
|
|
wp.updates.showErrorInCredentialsForm( response.error );
|
|
wp.updates.requestFilesystemCredentials();
|
|
};
|
|
|
|
|
|
/**
|
|
* If an install/update job has been placed in the queue, queueChecker pulls it out and runs it.
|
|
*
|
|
* @since 4.2.0
|
|
*/
|
|
wp.updates.queueChecker = function() {
|
|
if ( wp.updates.updateLock || wp.updates.updateQueue.length <= 0 ) {
|
|
return;
|
|
}
|
|
|
|
var job = wp.updates.updateQueue.shift();
|
|
|
|
switch ( job.type ) {
|
|
case 'update-plugin':
|
|
wp.updates.updatePlugin( job.data.plugin, job.data.slug );
|
|
break;
|
|
case 'install-plugin':
|
|
wp.updates.installPlugin( job.data.slug );
|
|
break;
|
|
default:
|
|
window.console.log( 'Failed to exect queued update job.' );
|
|
window.console.log( job );
|
|
break;
|
|
}
|
|
};
|
|
/**
|
|
* Request the users filesystem credentials if we don't have them already
|
|
*
|
|
* @since 4.2.0
|
|
*/
|
|
wp.updates.requestFilesystemCredentials = function() {
|
|
if ( wp.updates.updateDoneSuccessfully === false ) {
|
|
wp.updates.updateLock = true;
|
|
$('#request-filesystem-credentials-dialog').show();
|
|
}
|
|
};
|
|
|
|
// Bind various click handlers.
|
|
$( document ).ready( function() {
|
|
// File system credentials form submit noop-er / handler.
|
|
$('#request-filesystem-credentials-dialog form').on( 'submit', function() {
|
|
// Persist the credentials input by the user for the duration of the page load.
|
|
wp.updates.filesystemCredentials.ftp.hostname = $('#hostname').val();
|
|
wp.updates.filesystemCredentials.ftp.username = $('#username').val();
|
|
wp.updates.filesystemCredentials.ftp.password = $('#password').val();
|
|
wp.updates.filesystemCredentials.ftp.connectionType = $('input[name="connection_type"]:checked').val();
|
|
wp.updates.filesystemCredentials.ssh.publicKey = $('#public_key').val();
|
|
wp.updates.filesystemCredentials.ssh.privateKey = $('#private_key').val();
|
|
|
|
$('#request-filesystem-credentials-dialog').hide();
|
|
|
|
// Unlock and invoke the queue.
|
|
wp.updates.updateLock = false;
|
|
wp.updates.queueChecker();
|
|
|
|
return false;
|
|
});
|
|
|
|
// Click handler for plugin updates in List Table view.
|
|
$( '.plugin-update-tr .update-link' ).on( 'click', function( e ) {
|
|
e.preventDefault();
|
|
if ( wp.updates.shouldRequestFilesystemCredentials === '1' && ! wp.updates.updateLock ) {
|
|
wp.updates.requestFilesystemCredentials();
|
|
}
|
|
var $row = $( e.target ).parents( '.plugin-update-tr' );
|
|
wp.updates.updatePlugin( $row.data( 'plugin' ), $row.data( 'slug' ) );
|
|
} );
|
|
|
|
$( '#bulk-action-form' ).on( 'submit', function( e ) {
|
|
var $checkbox, plugin, slug;
|
|
|
|
if ( $( '#bulk-action-selector-top' ).val() == 'update-selected' ) {
|
|
e.preventDefault();
|
|
|
|
$( 'input[name="checked[]"]:checked' ).each( function( index, elem ) {
|
|
$checkbox = $( elem );
|
|
plugin = $checkbox.val();
|
|
slug = $checkbox.parents( 'tr' ).prop( 'id' );
|
|
|
|
wp.updates.updatePlugin( plugin, slug );
|
|
|
|
$checkbox.attr( 'checked', false );
|
|
} );
|
|
}
|
|
} );
|
|
|
|
$( '.plugin-card .update-now' ).on( 'click', function( e ) {
|
|
e.preventDefault();
|
|
var $button = $( e.target );
|
|
wp.updates.updatePlugin( $button.data( 'plugin' ), $button.data( 'slug' ) );
|
|
} );
|
|
|
|
$( '.plugin-card .install-now' ).on( 'click', function( e ) {
|
|
e.preventDefault();
|
|
if ( wp.updates.shouldRequestFilesystemCredentials === '1' && ! wp.updates.updateLock ) {
|
|
wp.updates.requestFilesystemCredentials();
|
|
}
|
|
|
|
var $button = $( e.target );
|
|
if ( $button.hasClass( 'button-disabled' ) ) {
|
|
return;
|
|
}
|
|
wp.updates.installPlugin( $button.data( 'slug' ) );
|
|
} );
|
|
} );
|
|
|
|
$( window ).on( 'message', function( e ) {
|
|
var event = e.originalEvent,
|
|
message,
|
|
loc = document.location,
|
|
expectedOrigin = loc.protocol + '//' + loc.hostname;
|
|
|
|
if ( event.origin !== expectedOrigin ) {
|
|
return;
|
|
}
|
|
|
|
message = $.parseJSON( event.data );
|
|
|
|
if ( typeof message.action === 'undefined' || message.action !== 'decrementUpdateCount' ) {
|
|
return;
|
|
}
|
|
|
|
wp.updates.decrementCount( message.upgradeType );
|
|
|
|
} );
|
|
|
|
})( jQuery, window.wp, window.pagenow, window.ajaxurl );
|