wp-admin/includes/plugin-install.php

   1 <?php
   2 /**
   3  * WordPress Plugin Install Administration API
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * Retrieve plugin installer pages from WordPress Plugins API.
  11  *
  12  * It is possible for a plugin to override the Plugin API result with three
  13  * filters. Assume this is for plugins, which can extend on the Plugin Info to
  14  * offer more choices. This is very powerful and must be used with care, when
  15  * overriding the filters.
  16  *
  17  * The first filter, 'plugins_api_args', is for the args and gives the action as
  18  * the second parameter. The hook for 'plugins_api_args' must ensure that an
  19  * object is returned.
  20  *
  21  * The second filter, 'plugins_api', is the result that would be returned.
  22  *
  23  * @since 2.7.0
  24  *
  25  * @param string $action
  26  * @param array|object $args Optional. Arguments to serialize for the Plugin Info API.
  27  * @return object plugins_api response object on success, WP_Error on failure.
  28  */
  29 function plugins_api($action, $args = null) {
  30
  31         if ( is_array($args) )
  32                 $args = (object)$args;
  33
  34         if ( !isset($args->per_page) )
  35                 $args->per_page = 24;
  36
  37         /**
  38          * Override the Plugin Install API arguments.
  39          *
  40          * Please ensure that an object is returned.
  41          *
  42          * @since 2.7.0
  43          *
  44          * @param object $args   Plugin API arguments.
  45          * @param string $action The type of information being requested from the Plugin Install API.
  46          */
  47         $args = apply_filters( 'plugins_api_args', $args, $action );
  48
  49         /**
  50          * Allows a plugin to override the WordPress.org Plugin Install API entirely.
  51          *
  52          * Please ensure that an object is returned.
  53          *
  54          * @since 2.7.0
  55          *
  56          * @param bool|object $result The result object. Default false.
  57          * @param string      $action The type of information being requested from the Plugin Install API.
  58          * @param object      $args   Plugin API arguments.
  59          */
  60         $res = apply_filters( 'plugins_api', false, $action, $args );
  61
  62         if ( false === $res ) {
  63                 $url = $http_url = 'http://api.wordpress.org/plugins/info/1.0/';
  64                 if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
  65                         $url = set_url_scheme( $url, 'https' );
  66
  67                 $args = array(
  68                         'timeout' => 15,
  69                         'body' => array(
  70                                 'action' => $action,
  71                                 'request' => serialize( $args )
  72                         )
  73                 );
  74                 $request = wp_remote_post( $url, $args );
  75
  76                 if ( $ssl && is_wp_error( $request ) ) {
  77                         trigger_error( __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ) . ' ' . __( '(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 );
  78                         $request = wp_remote_post( $http_url, $args );
  79                 }
  80
  81                 if ( is_wp_error($request) ) {
  82                         $res = new WP_Error('plugins_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ), $request->get_error_message() );
  83                 } else {
  84                         $res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
  85                         if ( ! is_object( $res ) && ! is_array( $res ) )
  86                                 $res = new WP_Error('plugins_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ), wp_remote_retrieve_body( $request ) );
  87                 }
  88         } elseif ( !is_wp_error($res) ) {
  89                 $res->external = true;
  90         }
  91
  92         /**
  93          * Filter the Plugin Install API response results.
  94          *
  95          * @since 2.7.0
  96          *
  97          * @param object|WP_Error $res    Response object or WP_Error.
  98          * @param string          $action The type of information being requested from the Plugin Install API.
  99          * @param object          $args   Plugin API arguments.
 100          */
 101         return apply_filters( 'plugins_api_result', $res, $action, $args );
 102 }
 103
 104 /**
 105  * Retrieve popular WordPress plugin tags.
 106  *
 107  * @since 2.7.0
 108  *
 109  * @param array $args
 110  * @return array
 111  */
 112 function install_popular_tags( $args = array() ) {
 113         $key = md5(serialize($args));
 114         if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
 115                 return $tags;
 116
 117         $tags = plugins_api('hot_tags', $args);
 118
 119         if ( is_wp_error($tags) )
 120                 return $tags;
 121
 122         set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );
 123
 124         return $tags;
 125 }
 126
 127 function install_dashboard() {
 128         ?>
 129         <p><?php printf( __( 'Plugins extend and expand the functionality of WordPress. You may automatically install plugins from the <a href="%1$s">WordPress Plugin Directory</a> or upload a plugin in .zip format via <a href="%2$s">this page</a>.' ), 'https://wordpress.org/plugins/', self_admin_url( 'plugin-install.php?tab=upload' ) ); ?></p>
 130
 131         <h4><?php _e('Search') ?></h4>
 132         <?php install_search_form( false ); ?>
 133
 134         <h4><?php _e('Popular tags') ?></h4>
 135         <p class="install-help"><?php _e('You may also browse based on the most popular tags in the Plugin Directory:') ?></p>
 136         <?php
 137
 138         $api_tags = install_popular_tags();
 139
 140         echo '<p class="popular-tags">';
 141         if ( is_wp_error($api_tags) ) {
 142                 echo $api_tags->get_error_message();
 143         } else {
 144                 //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
 145                 $tags = array();
 146                 foreach ( (array)$api_tags as $tag )
 147                         $tags[ $tag['name'] ] = (object) array(
 148                                                                         'link' => esc_url( self_admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
 149                                                                         'name' => $tag['name'],
 150                                                                         'id' => sanitize_title_with_dashes($tag['name']),
 151                                                                         'count' => $tag['count'] );
 152                 echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) );
 153         }
 154         echo '</p><br class="clear" />';
 155 }
 156 add_action('install_plugins_dashboard', 'install_dashboard');
 157
 158 /**
 159  * Display search form for searching plugins.
 160  *
 161  * @since 2.7.0
 162  */
 163 function install_search_form( $type_selector = true ) {
 164         $type = isset($_REQUEST['type']) ? wp_unslash( $_REQUEST['type'] ) : 'term';
 165         $term = isset($_REQUEST['s']) ? wp_unslash( $_REQUEST['s'] ) : '';
 166
 167         ?><form id="search-plugins" method="get" action="">
 168                 <input type="hidden" name="tab" value="search" />
 169                 <?php if ( $type_selector ) : ?>
 170                 <select name="type" id="typeselector">
 171                         <option value="term"<?php selected('term', $type) ?>><?php _e('Keyword'); ?></option>
 172                         <option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option>
 173                         <option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option>
 174                 </select>
 175                 <?php endif; ?>
 176                 <input type="search" name="s" value="<?php echo esc_attr($term) ?>" autofocus="autofocus" />
 177                 <label class="screen-reader-text" for="plugin-search-input"><?php _e('Search Plugins'); ?></label>
 178                 <?php submit_button( __( 'Search Plugins' ), 'button', 'plugin-search-input', false ); ?>
 179         </form><?php
 180 }
 181
 182 /**
 183  * Upload from zip
 184  * @since 2.8.0
 185  *
 186  * @param string $page
 187  */
 188 function install_plugins_upload( $page = 1 ) {
 189 ?>
 190         <h4><?php _e('Install a plugin in .zip format'); ?></h4>
 191         <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.'); ?></p>
 192         <form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo self_admin_url('update.php?action=upload-plugin'); ?>">
 193                 <?php wp_nonce_field( 'plugin-upload'); ?>
 194                 <label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label>
 195                 <input type="file" id="pluginzip" name="pluginzip" />
 196                 <?php submit_button( __( 'Install Now' ), 'button', 'install-plugin-submit', false ); ?>
 197         </form>
 198 <?php
 199 }
 200 add_action('install_plugins_upload', 'install_plugins_upload', 10, 1);
 201
 202 /**
 203  * Show a username form for the favorites page
 204  * @since 3.5.0
 205  *
 206  */
 207 function install_plugins_favorites_form() {
 208         $user = ! empty( $_GET['user'] ) ? wp_unslash( $_GET['user'] ) : get_user_option( 'wporg_favorites' );
 209         ?>
 210         <p class="install-help"><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>
 211         <form method="get" action="">
 212                 <input type="hidden" name="tab" value="favorites" />
 213                 <p>
 214                         <label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>
 215                         <input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />
 216                         <input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />
 217                 </p>
 218         </form>
 219         <?php
 220 }
 221
 222 /**
 223  * Display plugin content based on plugin list.
 224  *
 225  * @since 2.7.0
 226  */
 227 function display_plugins_table() {
 228         global $wp_list_table;
 229
 230         if ( current_filter() == 'install_plugins_favorites' && empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) )
 231                         return;
 232
 233         $wp_list_table->display();
 234 }
 235 add_action( 'install_plugins_search',    'display_plugins_table' );
 236 add_action( 'install_plugins_featured',  'display_plugins_table' );
 237 add_action( 'install_plugins_popular',   'display_plugins_table' );
 238 add_action( 'install_plugins_new',       'display_plugins_table' );
 239 add_action( 'install_plugins_favorites', 'display_plugins_table' );
 240
 241 /**
 242  * Determine the status we can perform on a plugin.
 243  *
 244  * @since 3.0.0
 245  */
 246 function install_plugin_install_status($api, $loop = false) {
 247         // this function is called recursively, $loop prevents further loops.
 248         if ( is_array($api) )
 249                 $api = (object) $api;
 250
 251         //Default to a "new" plugin
 252         $status = 'install';
 253         $url = false;
 254
 255         //Check to see if this plugin is known to be installed, and has an update awaiting it.
 256         $update_plugins = get_site_transient('update_plugins');
 257         if ( isset( $update_plugins->response ) ) {
 258                 foreach ( (array)$update_plugins->response as $file => $plugin ) {
 259                         if ( $plugin->slug === $api->slug ) {
 260                                 $status = 'update_available';
 261                                 $update_file = $file;
 262                                 $version = $plugin->new_version;
 263                                 if ( current_user_can('update_plugins') )
 264                                         $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
 265                                 break;
 266                         }
 267                 }
 268         }
 269
 270         if ( 'install' == $status ) {
 271                 if ( is_dir( WP_PLUGIN_DIR . '/' . $api->slug ) ) {
 272                         $installed_plugin = get_plugins('/' . $api->slug);
 273                         if ( empty($installed_plugin) ) {
 274                                 if ( current_user_can('install_plugins') )
 275                                         $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
 276                         } else {
 277                                 $key = array_keys( $installed_plugin );
 278                                 $key = array_shift( $key ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
 279                                 if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
 280                                         $status = 'latest_installed';
 281                                 } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
 282                                         $status = 'newer_installed';
 283                                         $version = $installed_plugin[ $key ]['Version'];
 284                                 } else {
 285                                         //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
 286                                         if ( ! $loop ) {
 287                                                 delete_site_transient('update_plugins');
 288                                                 wp_update_plugins();
 289                                                 return install_plugin_install_status($api, true);
 290                                         }
 291                                 }
 292                         }
 293                 } else {
 294                         // "install" & no directory with that slug
 295                         if ( current_user_can('install_plugins') )
 296                                 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
 297                 }
 298         }
 299         if ( isset($_GET['from']) )
 300                 $url .= '&amp;from=' . urlencode( wp_unslash( $_GET['from'] ) );
 301
 302         return compact('status', 'url', 'version');
 303 }
 304
 305 /**
 306  * Display plugin information in dialog box form.
 307  *
 308  * @since 2.7.0
 309  */
 310 function install_plugin_information() {
 311         global $tab;
 312
 313         $api = plugins_api( 'plugin_information', array( 'slug' => wp_unslash( $_REQUEST['plugin'] ), 'is_ssl' => is_ssl() ) );
 314
 315         if ( is_wp_error( $api ) )
 316                 wp_die( $api );
 317
 318         $plugins_allowedtags = array(
 319                 'a' => array( 'href' => array(), 'title' => array(), 'target' => array() ),
 320                 'abbr' => array( 'title' => array() ), 'acronym' => array( 'title' => array() ),
 321                 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
 322                 'div' => array(), 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
 323                 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
 324                 'img' => array( 'src' => array(), 'class' => array(), 'alt' => array() )
 325         );
 326
 327         $plugins_section_titles = array(
 328                 'description'  => _x('Description',  'Plugin installer section title'),
 329                 'installation' => _x('Installation', 'Plugin installer section title'),
 330                 'faq'          => _x('FAQ',          'Plugin installer section title'),
 331                 'screenshots'  => _x('Screenshots',  'Plugin installer section title'),
 332                 'changelog'    => _x('Changelog',    'Plugin installer section title'),
 333                 'other_notes'  => _x('Other Notes',  'Plugin installer section title')
 334         );
 335
 336         //Sanitize HTML
 337         foreach ( (array)$api->sections as $section_name => $content ) {
 338                 $api->sections[$section_name] = wp_kses($content, $plugins_allowedtags);
 339         }
 340
 341         foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
 342                 if ( isset( $api->$key ) )
 343                         $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
 344         }
 345
 346         $_tab = esc_attr( $tab );
 347
 348         $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; //Default to the Description tab, Do not translate, API returns English.
 349         if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
 350                 $section_titles = array_keys( (array) $api->sections );
 351                 $section = array_shift( $section_titles );
 352         }
 353
 354         iframe_header( __('Plugin Install') );
 355
 356         echo "<div id='{$_tab}-title'>{$api->name}</div>";
 357         echo "<div id='{$_tab}-tabs'>\n";
 358
 359         foreach ( (array)$api->sections as $section_name => $content ) {
 360
 361                 if ( isset( $plugins_section_titles[ $section_name ] ) )
 362                         $title = $plugins_section_titles[ $section_name ];
 363                 else
 364                         $title = ucwords( str_replace( '_', ' ', $section_name ) );
 365
 366                 $class = ( $section_name == $section ) ? ' class="current"' : '';
 367                 $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
 368                 $href = esc_url( $href );
 369                 $san_section = esc_attr( $section_name );
 370                 echo "\t<a name='$san_section' href='$href' $class>$title</a>\n";
 371         }
 372
 373         echo "</div>\n";
 374
 375         ?>
 376         <div id="<?php echo $_tab; ?>-content">
 377         <div class="fyi">
 378                 <ul>
 379 <?php if ( ! empty( $api->version ) ) : ?>
 380                         <li><strong><?php _e('Version:') ?></strong> <?php echo $api->version ?></li>
 381 <?php endif; if ( ! empty( $api->author ) ) : ?>
 382                         <li><strong><?php _e('Author:') ?></strong> <?php echo links_add_target($api->author, '_blank') ?></li>
 383 <?php endif; if ( ! empty( $api->last_updated ) ) : ?>
 384                         <li><strong><?php _e('Last Updated:') ?></strong> <span title="<?php echo $api->last_updated ?>"><?php
 385                                                         printf( __('%s ago'), human_time_diff(strtotime($api->last_updated)) ) ?></span></li>
 386 <?php endif; if ( ! empty( $api->requires ) ) : ?>
 387                         <li><strong><?php _e('Requires WordPress Version:') ?></strong> <?php printf(__('%s or higher'), $api->requires) ?></li>
 388 <?php endif; if ( ! empty( $api->tested ) ) : ?>
 389                         <li><strong><?php _e('Compatible up to:') ?></strong> <?php echo $api->tested ?></li>
 390 <?php endif; if ( ! empty( $api->downloaded ) ) : ?>
 391                         <li><strong><?php _e('Downloaded:') ?></strong> <?php printf(_n('%s time', '%s times', $api->downloaded), number_format_i18n($api->downloaded)) ?></li>
 392 <?php endif; if ( ! empty( $api->slug ) && empty( $api->external ) ) : ?>
 393                         <li><a target="_blank" href="https://wordpress.org/plugins/<?php echo $api->slug ?>/"><?php _e('WordPress.org Plugin Page &#187;') ?></a></li>
 394 <?php endif; if ( ! empty( $api->homepage ) ) : ?>
 395                         <li><a target="_blank" href="<?php echo $api->homepage ?>"><?php _e('Plugin Homepage &#187;') ?></a></li>
 396 <?php endif; ?>
 397                 </ul>
 398                 <?php if ( ! empty( $api->rating ) ) : ?>
 399                 <h3><?php _e('Average Rating') ?></h3>
 400                 <?php wp_star_rating( array( 'rating' => $api->rating, 'type' => 'percent', 'number' => $api->num_ratings ) ); ?>
 401                 <small><?php printf( _n('(based on %s rating)', '(based on %s ratings)', $api->num_ratings), number_format_i18n($api->num_ratings) ); ?></small>
 402                 <?php endif; ?>
 403         </div>
 404         <div id="section-holder" class="wrap">
 405         <?php
 406                 if ( ! empty( $api->tested ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->tested ) ), $api->tested, '>' ) )
 407                         echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>';
 408
 409                 else if ( ! empty( $api->requires ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->requires ) ), $api->requires, '<' ) )
 410                         echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been marked as compatible</strong> with your version of WordPress.') . '</p></div>';
 411
 412                 foreach ( (array)$api->sections as $section_name => $content ) {
 413
 414                         if ( isset( $plugins_section_titles[ $section_name ] ) )
 415                                 $title = $plugins_section_titles[ $section_name ];
 416                         else
 417                                 $title = ucwords( str_replace( '_', ' ', $section_name ) );
 418
 419                         $content = links_add_base_url( $content, 'https://wordpress.org/plugins/' . $api->slug . '/' );
 420                         $content = links_add_target( $content, '_blank' );
 421
 422                         $san_section = esc_attr( $section_name );
 423
 424                         $display = ( $section_name == $section ) ? 'block' : 'none';
 425
 426                         echo "\t<div id='section-{$san_section}' class='section' style='display: {$display};'>\n";
 427                         echo $content;
 428                         echo "\t</div>\n";
 429                 }
 430         echo "</div>\n";
 431         echo "</div>\n";
 432         echo "<div id='$tab-footer'>\n";
 433         if ( ! empty( $api->download_link ) && ( current_user_can('install_plugins') || current_user_can('update_plugins') ) ) {
 434                 $status = install_plugin_install_status($api);
 435                 switch ( $status['status'] ) {
 436                         case 'install':
 437                                 if ( $status['url'] )
 438                                         echo '<a class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __('Install Now') . '</a>';
 439                                 break;
 440                         case 'update_available':
 441                                 if ( $status['url'] )
 442                                         echo '<a class="button button-primary right" href="' . $status['url'] . '" target="_parent">' . __('Install Update Now') .'</a>';
 443                                 break;
 444                         case 'newer_installed':
 445                                 echo '<a class="button button-primary right disabled">' . sprintf(__('Newer Version (%s) Installed'), $status['version']) . '</a>';
 446                                 break;
 447                         case 'latest_installed':
 448                                 echo '<a class="button button-primary right disabled">' . __('Latest Version Installed') . '</a>';
 449                                 break;
 450                 }
 451         }
 452         echo "</div>\n";
 453
 454         iframe_footer();
 455         exit;
 456 }
 457 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');