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