X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d3b1ea255664edd2deef17f900a655613d20820d..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-admin/includes/plugin-install.php
diff --git a/wp-admin/includes/plugin-install.php b/wp-admin/includes/plugin-install.php
index bcd9e1b2..0d932c26 100644
--- a/wp-admin/includes/plugin-install.php
+++ b/wp-admin/includes/plugin-install.php
@@ -7,48 +7,201 @@
*/
/**
- * Retrieve plugin installer pages from WordPress Plugins API.
+ * Retrieves plugin installer pages from the WordPress.org Plugins API.
*
* It is possible for a plugin to override the Plugin API result with three
* filters. Assume this is for plugins, which can extend on the Plugin Info to
- * offer more choices. This is very powerful and must be used with care, when
- * overridding the filters.
+ * offer more choices. This is very powerful and must be used with care when
+ * overriding the filters.
*
- * The first filter, 'plugins_api_args', is for the args and gives the action as
- * the second parameter. The hook for 'plugins_api_args' must ensure that an
- * object is returned.
+ * The first filter, {@see 'plugins_api_args'}, is for the args and gives the action
+ * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that
+ * an object is returned.
*
- * The second filter, 'plugins_api', is the result that would be returned.
+ * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
+ * Plugin Install API entirely. If `$action` is 'query_plugins' or 'plugin_information',
+ * an object MUST be passed. If `$action` is 'hot_tags' or 'hot_categories', an array MUST
+ * be passed.
+ *
+ * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the
+ * response object or array, depending on the `$action` type.
+ *
+ * Supported arguments per action:
+ *
+ * | Argument Name | query_plugins | plugin_information | hot_tags | hot_categories |
+ * | -------------------- | :-----------: | :----------------: | :------: | :------------: |
+ * | `$slug` | No | Yes | No | No |
+ * | `$per_page` | Yes | No | No | No |
+ * | `$page` | Yes | No | No | No |
+ * | `$number` | No | No | Yes | Yes |
+ * | `$search` | Yes | No | No | No |
+ * | `$tag` | Yes | No | No | No |
+ * | `$author` | Yes | No | No | No |
+ * | `$user` | Yes | No | No | No |
+ * | `$browse` | Yes | No | No | No |
+ * | `$locale` | Yes | Yes | No | No |
+ * | `$installed_plugins` | Yes | No | No | No |
+ * | `$is_ssl` | Yes | Yes | No | No |
+ * | `$fields` | Yes | Yes | No | No |
*
* @since 2.7.0
*
- * @param string $action
- * @param array|object $args Optional. Arguments to serialize for the Plugin Info API.
- * @return mixed
+ * @param string $action API action to perform: 'query_plugins', 'plugin_information',
+ * 'hot_tags' or 'hot_categories'.
+ * @param array|object $args {
+ * Optional. Array or object of arguments to serialize for the Plugin Info API.
+ *
+ * @type string $slug The plugin slug. Default empty.
+ * @type int $per_page Number of plugins per page. Default 24.
+ * @type int $page Number of current page. Default 1.
+ * @type int $number Number of tags or categories to be queried.
+ * @type string $search A search term. Default empty.
+ * @type string $tag Tag to filter plugins. Default empty.
+ * @type string $author Username of an plugin author to filter plugins. Default empty.
+ * @type string $user Username to query for their favorites. Default empty.
+ * @type string $browse Browse view: 'popular', 'new', 'beta', 'recommended'.
+ * @type string $locale Locale to provide context-sensitive results. Default is the value
+ * of get_locale().
+ * @type string $installed_plugins Installed plugins to provide context-sensitive results.
+ * @type bool $is_ssl Whether links should be returned with https or not. Default false.
+ * @type array $fields {
+ * Array of fields which should or should not be returned.
+ *
+ * @type bool $short_description Whether to return the plugin short description. Default true.
+ * @type bool $description Whether to return the plugin full description. Default false.
+ * @type bool $sections Whether to return the plugin readme sections: description, installation,
+ * FAQ, screenshots, other notes, and changelog. Default false.
+ * @type bool $tested Whether to return the 'Compatible up to' value. Default true.
+ * @type bool $requires Whether to return the required WordPress version. Default true.
+ * @type bool $rating Whether to return the rating in percent and total number of ratings.
+ * Default true.
+ * @type bool $ratings Whether to return the number of rating for each star (1-5). Default true.
+ * @type bool $downloaded Whether to return the download count. Default true.
+ * @type bool $downloadlink Whether to return the download link for the package. Default true.
+ * @type bool $last_updated Whether to return the date of the last update. Default true.
+ * @type bool $added Whether to return the date when the plugin was added to the wordpress.org
+ * repository. Default true.
+ * @type bool $tags Whether to return the assigned tags. Default true.
+ * @type bool $compatibility Whether to return the WordPress compatibility list. Default true.
+ * @type bool $homepage Whether to return the plugin homepage link. Default true.
+ * @type bool $versions Whether to return the list of all available versions. Default false.
+ * @type bool $donate_link Whether to return the donation link. Default true.
+ * @type bool $reviews Whether to return the plugin reviews. Default false.
+ * @type bool $banners Whether to return the banner images links. Default false.
+ * @type bool $icons Whether to return the icon links. Default false.
+ * @type bool $active_installs Whether to return the number of active installs. Default false.
+ * @type bool $group Whether to return the assigned group. Default false.
+ * @type bool $contributors Whether to return the list of contributors. Default false.
+ * }
+ * }
+ * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the
+ * {@link https://developer.wordpress.org/reference/functions/plugins_api/ function reference article}
+ * for more information on the make-up of possible return values depending on the value of `$action`.
*/
-function plugins_api($action, $args = null) {
+function plugins_api( $action, $args = array() ) {
- if( is_array($args) )
- $args = (object)$args;
+ if ( is_array( $args ) ) {
+ $args = (object) $args;
+ }
- if ( !isset($args->per_page) )
+ if ( ! isset( $args->per_page ) ) {
$args->per_page = 24;
+ }
+
+ if ( ! isset( $args->locale ) ) {
+ $args->locale = get_user_locale();
+ }
- $args = apply_filters('plugins_api_args', $args, $action); //NOTE: Ensure that an object is returned via this filter.
- $res = apply_filters('plugins_api', false, $action, $args); //NOTE: Allows a plugin to completely override the builtin WordPress.org API.
+ /**
+ * Filters the WordPress.org Plugin Install API arguments.
+ *
+ * Important: An object MUST be returned to this filter.
+ *
+ * @since 2.7.0
+ *
+ * @param object $args Plugin API arguments.
+ * @param string $action The type of information being requested from the Plugin Install API.
+ */
+ $args = apply_filters( 'plugins_api_args', $args, $action );
+
+ /**
+ * Filters the response for the current WordPress.org Plugin Install API request.
+ *
+ * Passing a non-false value will effectively short-circuit the WordPress.org API request.
+ *
+ * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.
+ * If `$action` is 'hot_tags' or 'hot_categories', an array should be passed.
+ *
+ * @since 2.7.0
+ *
+ * @param false|object|array $result The result object or array. Default false.
+ * @param string $action The type of information being requested from the Plugin Install API.
+ * @param object $args Plugin API arguments.
+ */
+ $res = apply_filters( 'plugins_api', false, $action, $args );
+
+ if ( false === $res ) {
+ $url = $http_url = 'http://api.wordpress.org/plugins/info/1.0/';
+ if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
+ $url = set_url_scheme( $url, 'https' );
+
+ $http_args = array(
+ 'timeout' => 15,
+ 'body' => array(
+ 'action' => $action,
+ 'request' => serialize( $args )
+ )
+ );
+ $request = wp_remote_post( $url, $http_args );
+
+ if ( $ssl && is_wp_error( $request ) ) {
+ trigger_error(
+ sprintf(
+ /* translators: %s: support forums URL */
+ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ),
+ __( 'https://wordpress.org/support/' )
+ ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),
+ headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
+ );
+ $request = wp_remote_post( $http_url, $http_args );
+ }
- if ( ! $res ) {
- $request = wp_remote_post('http://api.wordpress.org/plugins/info/1.0/', array( 'body' => array('action' => $action, 'request' => serialize($args))) );
if ( is_wp_error($request) ) {
- $res = new WP_Error('plugins_api_failed', __('An Unexpected HTTP Error occurred during the API request. Try again'), $request->get_error_message() );
+ $res = new WP_Error( 'plugins_api_failed',
+ sprintf(
+ /* translators: %s: support forums URL */
+ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ),
+ __( 'https://wordpress.org/support/' )
+ ),
+ $request->get_error_message()
+ );
} else {
- $res = unserialize($request['body']);
- if ( ! $res )
- $res = new WP_Error('plugins_api_failed', __('An unknown error occurred'), $request['body']);
+ $res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
+ if ( ! is_object( $res ) && ! is_array( $res ) ) {
+ $res = new WP_Error( 'plugins_api_failed',
+ sprintf(
+ /* translators: %s: support forums URL */
+ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ),
+ __( 'https://wordpress.org/support/' )
+ ),
+ wp_remote_retrieve_body( $request )
+ );
+ }
}
+ } elseif ( !is_wp_error($res) ) {
+ $res->external = true;
}
- return apply_filters('plugins_api_result', $res, $action, $args);
+ /**
+ * Filters the Plugin Install API response results.
+ *
+ * @since 2.7.0
+ *
+ * @param object|WP_Error $res Response object or WP_Error.
+ * @param string $action The type of information being requested from the Plugin Install API.
+ * @param object $args Plugin API arguments.
+ */
+ return apply_filters( 'plugins_api_result', $res, $action, $args );
}
/**
@@ -60,497 +213,499 @@ function plugins_api($action, $args = null) {
* @return array
*/
function install_popular_tags( $args = array() ) {
- if ( ! ($cache = wp_cache_get('popular_tags', 'api')) && ! ($cache = get_option('wporg_popular_tags')) )
- add_option('wporg_popular_tags', array(), '', 'no'); ///No autoload.
-
- if ( $cache && $cache->timeout + 3 * 60 * 60 > time() )
- return $cache->cached;
+ $key = md5(serialize($args));
+ if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
+ return $tags;
$tags = plugins_api('hot_tags', $args);
if ( is_wp_error($tags) )
return $tags;
- $cache = (object) array('timeout' => time(), 'cached' => $tags);
-
- update_option('wporg_popular_tags', $cache);
- wp_cache_set('popular_tags', $cache, 'api');
+ set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
return $tags;
}
-add_action('install_plugins_search', 'install_search', 10, 1);
/**
- * Display search results and display as tag cloud.
- *
* @since 2.7.0
- *
- * @param string $page
*/
-function install_search($page) {
- $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
- $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
-
- $args = array();
-
- switch( $type ){
- case 'tag':
- $args['tag'] = sanitize_title_with_dashes($term);
- break;
- case 'term':
- $args['search'] = $term;
- break;
- case 'author':
- $args['author'] = $term;
- break;
- }
-
- $args['page'] = $page;
-
- $api = plugins_api('query_plugins', $args);
-
- if ( is_wp_error($api) )
- wp_die($api);
-
- add_action('install_plugins_table_header', 'install_search_form');
-
- display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
-
- return;
-}
-
-add_action('install_plugins_dashboard', 'install_dashboard');
function install_dashboard() {
?>
-
WordPress Plugin Directory or upload a plugin in .zip format via this page.') ?>
+ WordPress Plugin Directory or upload a plugin in .zip format by clicking the button at the top of this page.' ), __( 'https://wordpress.org/plugins/' ) ); ?>
-
-
-
+
-
-
+ ';
}
/**
- * Display search form for searching plugins.
+ * Displays a search form for searching plugins.
*
* @since 2.7.0
+ * @since 4.6.0 The `$type_selector` parameter was deprecated.
+ *
+ * @param bool $deprecated Not used.
*/
-function install_search_form(){
- $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
- $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
-
- ?> 'featured', 'page' => $page);
- $api = plugins_api('query_plugins', $args);
- if ( is_wp_error($api) )
- wp_die($api);
- display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
-}
-
-add_action('install_plugins_popular', 'install_popular', 10, 1);
-/**
- * Display popular plugins.
- *
- * @since 2.7.0
- *
- * @param string $page
- */
-function install_popular($page = 1) {
- $args = array('browse' => 'popular', 'page' => $page);
- $api = plugins_api('query_plugins', $args);
- display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
-}
-
-add_action('install_plugins_upload', 'install_plugins_upload', 10, 1);
/**
* Upload from zip
* @since 2.8.0
- *
- * @param string $page
*/
-function install_plugins_upload( $page = 1 ) {
+function install_plugins_upload() {
?>
-
-
-
+ 'updated', 'page' => $page);
- $api = plugins_api('query_plugins', $args);
- display_plugins_table($api->plugins, $api->info['page'], $api->info['pages']);
+function display_plugins_table() {
+ global $wp_list_table;
+
+ switch ( current_filter() ) {
+ case 'install_plugins_favorites' :
+ if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {
+ return;
+ }
+ break;
+ case 'install_plugins_recommended' :
+ echo '' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '
';
+ break;
+ case 'install_plugins_beta' :
+ printf(
+ '' . __( 'You are using a development version of WordPress. These feature plugins are also under development. Learn more.' ) . '
',
+ 'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/'
+ );
+ break;
+ }
+
+ ?>
+
+ array('href' => array(),'title' => array(), 'target' => array()),
- 'abbr' => array('title' => array()),'acronym' => array('title' => array()),
- 'code' => array(), 'pre' => array(), 'em' => array(),'strong' => array(),
- 'ul' => array(), 'ol' => array(), 'li' => array(), 'p' => array(), 'br' => array());
+function install_plugin_install_status($api, $loop = false) {
+ // This function is called recursively, $loop prevents further loops.
+ if ( is_array($api) )
+ $api = (object) $api;
+
+ // Default to a "new" plugin
+ $status = 'install';
+ $url = false;
+ $update_file = false;
+
+ /*
+ * Check to see if this plugin is known to be installed,
+ * and has an update awaiting it.
+ */
+ $update_plugins = get_site_transient('update_plugins');
+ if ( isset( $update_plugins->response ) ) {
+ foreach ( (array)$update_plugins->response as $file => $plugin ) {
+ if ( $plugin->slug === $api->slug ) {
+ $status = 'update_available';
+ $update_file = $file;
+ $version = $plugin->new_version;
+ if ( current_user_can('update_plugins') )
+ $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
+ break;
+ }
+ }
+ }
-?>
-
-
-
-
- add_query_arg('paged', '%#%', $url),
- 'format' => '',
- 'prev_text' => __('«'),
- 'next_text' => __('»'),
- 'total' => $totalpages,
- 'current' => $page
- ));
-
- if ( $page_links )
- echo "\t\t
$page_links
";
-?>
-
-
-
-
- |
- |
- |
- |
- |
-
-
-
-
-
- |
- |
- |
- |
- |
-
-
-
-
- ', __('No plugins match your request.'), ' | ';
-
- foreach( (array) $plugins as $plugin ){
- if ( is_object($plugin) )
- $plugin = (array) $plugin;
-
- $title = wp_kses($plugin['name'], $plugins_allowedtags);
- //Limit description to 400char, and remove any HTML.
- $description = strip_tags($plugin['description']);
- if ( strlen($description) > 400 )
- $description = mb_substr($description, 0, 400) . '…';
- //remove any trailing entities
- $description = preg_replace('/&[^;\s]{0,6}$/', '', $description);
- //strip leading/trailing & multiple consecutive lines
- $description = trim($description);
- $description = preg_replace("|(\r?\n)+|", "\n", $description);
- //\n =>
- $description = nl2br($description);
- $version = wp_kses($plugin['version'], $plugins_allowedtags);
-
- $name = strip_tags($title . ' ' . $version);
-
- $author = $plugin['author'];
- if( ! empty($plugin['author']) )
- $author = ' ' . sprintf( __('By %s'), $author ) . '.';
-
- $author = wp_kses($author, $plugins_allowedtags);
-
- if( isset($plugin['homepage']) )
- $title = '' . $title . '';
-
- $action_links = array();
- $action_links[] = '' . __('Install') . '';
-
- $action_links = apply_filters('plugin_install_action_links', $action_links, $plugin);
- ?>
-
- |
- |
-
-
- |
- |
- |
-
- slug ) ) {
+ $installed_plugin = get_plugins('/' . $api->slug);
+ if ( empty($installed_plugin) ) {
+ if ( current_user_can('install_plugins') )
+ $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
+ } else {
+ $key = array_keys( $installed_plugin );
+ $key = reset( $key ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
+ $update_file = $api->slug . '/' . $key;
+ if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
+ $status = 'latest_installed';
+ } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
+ $status = 'newer_installed';
+ $version = $installed_plugin[ $key ]['Version'];
+ } else {
+ //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
+ if ( ! $loop ) {
+ delete_site_transient('update_plugins');
+ wp_update_plugins();
+ return install_plugin_install_status($api, true);
+ }
+ }
}
- ?>
-
-
-
-
- $page_links
"; ?>
-
-
+ } else {
+ // "install" & no directory with that slug
+ if ( current_user_can('install_plugins') )
+ $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
+ }
+ }
+ if ( isset($_GET['from']) )
+ $url .= '&from=' . urlencode( wp_unslash( $_GET['from'] ) );
- stripslashes( $_REQUEST['plugin'] ) ));
+ if ( empty( $_REQUEST['plugin'] ) ) {
+ return;
+ }
+
+ $api = plugins_api( 'plugin_information', array(
+ 'slug' => wp_unslash( $_REQUEST['plugin'] ),
+ 'is_ssl' => is_ssl(),
+ 'fields' => array(
+ 'banners' => true,
+ 'reviews' => true,
+ 'downloaded' => false,
+ 'active_installs' => true
+ )
+ ) );
+
+ if ( is_wp_error( $api ) ) {
+ wp_die( $api );
+ }
+
+ $plugins_allowedtags = array(
+ 'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ),
+ 'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ),
+ 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
+ 'div' => array( 'class' => array() ), 'span' => array( 'class' => array() ),
+ 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
+ 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
+ 'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() )
+ );
+
+ $plugins_section_titles = array(
+ 'description' => _x( 'Description', 'Plugin installer section title' ),
+ 'installation' => _x( 'Installation', 'Plugin installer section title' ),
+ 'faq' => _x( 'FAQ', 'Plugin installer section title' ),
+ 'screenshots' => _x( 'Screenshots', 'Plugin installer section title' ),
+ 'changelog' => _x( 'Changelog', 'Plugin installer section title' ),
+ 'reviews' => _x( 'Reviews', 'Plugin installer section title' ),
+ 'other_notes' => _x( 'Other Notes', 'Plugin installer section title' )
+ );
+
+ // Sanitize HTML
+ foreach ( (array) $api->sections as $section_name => $content ) {
+ $api->sections[$section_name] = wp_kses( $content, $plugins_allowedtags );
+ }
+
+ foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
+ if ( isset( $api->$key ) ) {
+ $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
+ }
+ }
+
+ $_tab = esc_attr( $tab );
- if ( is_wp_error($api) )
- wp_die($api);
+ $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; // Default to the Description tab, Do not translate, API returns English.
+ if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
+ $section_titles = array_keys( (array) $api->sections );
+ $section = reset( $section_titles );
+ }
- $plugins_allowedtags = array('a' => array('href' => array(), 'title' => array(), 'target' => array()),
- 'abbr' => array('title' => array()), 'acronym' => array('title' => array()),
- 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
- 'div' => array(), 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
- 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
- 'img' => array('src' => array(), 'class' => array(), 'alt' => array()));
- //Sanitize HTML
- foreach ( (array)$api->sections as $section_name => $content )
- $api->sections[$section_name] = wp_kses($content, $plugins_allowedtags);
- foreach ( array('version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug') as $key )
- $api->$key = wp_kses($api->$key, $plugins_allowedtags);
+ iframe_header( __( 'Plugin Install' ) );
- $section = isset($_REQUEST['section']) ? stripslashes( $_REQUEST['section'] ) : 'description'; //Default to the Description tab, Do not translate, API returns English.
- if( empty($section) || ! isset($api->sections[ $section ]) )
- $section = array_shift( $section_titles = array_keys((array)$api->sections) );
+ $_with_banner = '';
- iframe_header( __('Plugin Install') );
- echo " ; ?>)
-