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         // Allows a plugin to override the WordPress.org API entirely.
  38         // Use the filter 'plugins_api_result' to merely add results.
  39         // Please ensure that a object is returned from the following filters.
  40         $args = apply_filters('plugins_api_args', $args, $action);
  41         $res = apply_filters('plugins_api', false, $action, $args);
  42
  43         if ( false === $res ) {
  44                 $request = wp_remote_post('http://api.wordpress.org/plugins/info/1.0/', array( 'timeout' => 15, 'body' => array('action' => $action, 'request' => serialize($args))) );
  45                 if ( is_wp_error($request) ) {
  46                         $res = new WP_Error('plugins_api_failed', __('An Unexpected HTTP Error occurred during the API request.'), $request->get_error_message() );
  47                 } else {
  48                         $res = unserialize( wp_remote_retrieve_body( $request ) );
  49                         if ( false === $res )
  50                                 $res = new WP_Error('plugins_api_failed', __('An unknown error occurred.'), wp_remote_retrieve_body( $request ) );
  51                 }
  52         } elseif ( !is_wp_error($res) ) {
  53                 $res->external = true;
  54         }
  55
  56         return apply_filters('plugins_api_result', $res, $action, $args);
  57 }
  58
  59 /**
  60  * Retrieve popular WordPress plugin tags.
  61  *
  62  * @since 2.7.0
  63  *
  64  * @param array $args
  65  * @return array
  66  */
  67 function install_popular_tags( $args = array() ) {
  68         $key = md5(serialize($args));
  69         if ( false !== ($tags = get_site_transient('poptags_' . $key) ) )
  70                 return $tags;
  71
  72         $tags = plugins_api('hot_tags', $args);
  73
  74         if ( is_wp_error($tags) )
  75                 return $tags;
  76
  77         set_site_transient('poptags_' . $key, $tags, 10800); // 3 * 60 * 60 = 10800
  78
  79         return $tags;
  80 }
  81
  82 function install_dashboard() {
  83         ?>
  84         <p><?php printf( __( 'Plugins extend and expand the functionality of WordPress. You may automatically install plugins from the <a href="http://wordpress.org/extend/plugins/">WordPress Plugin Directory</a> or upload a plugin in .zip format via <a href="%s">this page</a>.' ), self_admin_url( 'plugin-install.php?tab=upload' ) ); ?></p>
  85
  86         <h4><?php _e('Search') ?></h4>
  87         <p class="install-help"><?php _e('Search for plugins by keyword, author, or tag.') ?></p>
  88         <?php install_search_form(); ?>
  89
  90         <h4><?php _e('Popular tags') ?></h4>
  91         <p class="install-help"><?php _e('You may also browse based on the most popular tags in the Plugin Directory:') ?></p>
  92         <?php
  93
  94         $api_tags = install_popular_tags();
  95
  96         echo '<p class="popular-tags">';
  97         if ( is_wp_error($api_tags) ) {
  98                 echo $api_tags->get_error_message();
  99         } else {
 100                 //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
 101                 $tags = array();
 102                 foreach ( (array)$api_tags as $tag )
 103                         $tags[ $tag['name'] ] = (object) array(
 104                                                                         'link' => esc_url( self_admin_url('plugin-install.php?tab=search&type=tag&s=' . urlencode($tag['name'])) ),
 105                                                                         'name' => $tag['name'],
 106                                                                         'id' => sanitize_title_with_dashes($tag['name']),
 107                                                                         'count' => $tag['count'] );
 108                 echo wp_generate_tag_cloud($tags, array( 'single_text' => __('%s plugin'), 'multiple_text' => __('%s plugins') ) );
 109         }
 110         echo '</p><br class="clear" />';
 111 }
 112 add_action('install_plugins_dashboard', 'install_dashboard');
 113
 114 /**
 115  * Display search form for searching plugins.
 116  *
 117  * @since 2.7.0
 118  */
 119 function install_search_form(){
 120         $type = isset($_REQUEST['type']) ? stripslashes( $_REQUEST['type'] ) : '';
 121         $term = isset($_REQUEST['s']) ? stripslashes( $_REQUEST['s'] ) : '';
 122
 123         ?><form id="search-plugins" method="get" action="">
 124                 <input type="hidden" name="tab" value="search" />
 125                 <select name="type" id="typeselector">
 126                         <option value="term"<?php selected('term', $type) ?>><?php _e('Term'); ?></option>
 127                         <option value="author"<?php selected('author', $type) ?>><?php _e('Author'); ?></option>
 128                         <option value="tag"<?php selected('tag', $type) ?>><?php _ex('Tag', 'Plugin Installer'); ?></option>
 129                 </select>
 130                 <input type="text" name="s" value="<?php echo esc_attr($term) ?>" />
 131                 <label class="screen-reader-text" for="plugin-search-input"><?php _e('Search Plugins'); ?></label>
 132                 <?php submit_button( __( 'Search Plugins' ), 'button', 'plugin-search-input', false ); ?>
 133         </form><?php
 134 }
 135
 136 /**
 137  * Upload from zip
 138  * @since 2.8.0
 139  *
 140  * @param string $page
 141  */
 142 function install_plugins_upload( $page = 1 ) {
 143 ?>
 144         <h4><?php _e('Install a plugin in .zip format') ?></h4>
 145         <p class="install-help"><?php _e('If you have a plugin in a .zip format, you may install it by uploading it here.') ?></p>
 146         <form method="post" enctype="multipart/form-data" action="<?php echo self_admin_url('update.php?action=upload-plugin') ?>">
 147                 <?php wp_nonce_field( 'plugin-upload') ?>
 148                 <label class="screen-reader-text" for="pluginzip"><?php _e('Plugin zip file'); ?></label>
 149                 <input type="file" id="pluginzip" name="pluginzip" />
 150                 <input type="submit" class="button" value="<?php esc_attr_e('Install Now') ?>" />
 151         </form>
 152 <?php
 153 }
 154 add_action('install_plugins_upload', 'install_plugins_upload', 10, 1);
 155
 156 /**
 157  * Display plugin content based on plugin list.
 158  *
 159  * @since 2.7.0
 160  */
 161 function display_plugins_table() {
 162         global $wp_list_table;
 163
 164         $wp_list_table->display();
 165 }
 166 add_action('install_plugins_search', 'display_plugins_table');
 167 add_action('install_plugins_featured', 'display_plugins_table');
 168 add_action('install_plugins_popular', 'display_plugins_table');
 169 add_action('install_plugins_new', 'display_plugins_table');
 170 add_action('install_plugins_updated', 'display_plugins_table');
 171
 172 /**
 173  * Determine the status we can perform on a plugin.
 174  *
 175  * @since 3.0.0
 176  */
 177 function install_plugin_install_status($api, $loop = false) {
 178         // this function is called recursively, $loop prevents further loops.
 179         if ( is_array($api) )
 180                 $api = (object) $api;
 181
 182         //Default to a "new" plugin
 183         $status = 'install';
 184         $url = false;
 185
 186         //Check to see if this plugin is known to be installed, and has an update awaiting it.
 187         $update_plugins = get_site_transient('update_plugins');
 188         if ( is_object( $update_plugins ) ) {
 189                 foreach ( (array)$update_plugins->response as $file => $plugin ) {
 190                         if ( $plugin->slug === $api->slug ) {
 191                                 $status = 'update_available';
 192                                 $update_file = $file;
 193                                 $version = $plugin->new_version;
 194                                 if ( current_user_can('update_plugins') )
 195                                         $url = wp_nonce_url(self_admin_url('update.php?action=upgrade-plugin&plugin=' . $update_file), 'upgrade-plugin_' . $update_file);
 196                                 break;
 197                         }
 198                 }
 199         }
 200
 201         if ( 'install' == $status ) {
 202                 if ( is_dir( WP_PLUGIN_DIR  . '/' . $api->slug ) ) {
 203                         $installed_plugin = get_plugins('/' . $api->slug);
 204                         if ( empty($installed_plugin) ) {
 205                                 if ( current_user_can('install_plugins') )
 206                                         $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
 207                         } else {
 208                                 $key = array_shift( $key = array_keys($installed_plugin) ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
 209                                 if ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '=') ){
 210                                         $status = 'latest_installed';
 211                                 } elseif ( version_compare($api->version, $installed_plugin[ $key ]['Version'], '<') ) {
 212                                         $status = 'newer_installed';
 213                                         $version = $installed_plugin[ $key ]['Version'];
 214                                 } else {
 215                                         //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
 216                                         if ( ! $loop ) {
 217                                                 delete_site_transient('update_plugins');
 218                                                 wp_update_plugins();
 219                                                 return install_plugin_install_status($api, true);
 220                                         }
 221                                 }
 222                         }
 223                 } else {
 224                         // "install" & no directory with that slug
 225                         if ( current_user_can('install_plugins') )
 226                                 $url = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $api->slug), 'install-plugin_' . $api->slug);
 227                 }
 228         }
 229         if ( isset($_GET['from']) )
 230                 $url .= '&amp;from=' . urlencode(stripslashes($_GET['from']));
 231
 232         return compact('status', 'url', 'version');
 233 }
 234
 235 /**
 236  * Display plugin information in dialog box form.
 237  *
 238  * @since 2.7.0
 239  */
 240 function install_plugin_information() {
 241         global $tab;
 242
 243         $api = plugins_api('plugin_information', array('slug' => stripslashes( $_REQUEST['plugin'] ) ));
 244
 245         if ( is_wp_error($api) )
 246                 wp_die($api);
 247
 248         $plugins_allowedtags = array('a' => array('href' => array(), 'title' => array(), 'target' => array()),
 249                                                                 'abbr' => array('title' => array()), 'acronym' => array('title' => array()),
 250                                                                 'code' => array(), 'pre' => array(), 'em' => array(), 'strong' => array(),
 251                                                                 'div' => array(), 'p' => array(), 'ul' => array(), 'ol' => array(), 'li' => array(),
 252                                                                 'h1' => array(), 'h2' => array(), 'h3' => array(), 'h4' => array(), 'h5' => array(), 'h6' => array(),
 253                                                                 'img' => array('src' => array(), 'class' => array(), 'alt' => array()));
 254         //Sanitize HTML
 255         foreach ( (array)$api->sections as $section_name => $content )
 256                 $api->sections[$section_name] = wp_kses($content, $plugins_allowedtags);
 257         foreach ( array( 'version', 'author', 'requires', 'tested', 'homepage', 'downloaded', 'slug' ) as $key ) {
 258                 if ( isset( $api->$key ) )
 259                         $api->$key = wp_kses( $api->$key, $plugins_allowedtags );
 260         }
 261
 262         $section = isset($_REQUEST['section']) ? stripslashes( $_REQUEST['section'] ) : 'description'; //Default to the Description tab, Do not translate, API returns English.
 263         if ( empty($section) || ! isset($api->sections[ $section ]) )
 264                 $section = array_shift( $section_titles = array_keys((array)$api->sections) );
 265
 266         iframe_header( __('Plugin Install') );
 267         echo "<div id='$tab-header'>\n";
 268         echo "<ul id='sidemenu'>\n";
 269         foreach ( (array)$api->sections as $section_name => $content ) {
 270
 271                 $title = $section_name;
 272                 $title = ucwords(str_replace('_', ' ', $title));
 273
 274                 $class = ( $section_name == $section ) ? ' class="current"' : '';
 275                 $href = add_query_arg( array('tab' => $tab, 'section' => $section_name) );
 276                 $href = esc_url($href);
 277                 $san_title = esc_attr(sanitize_title_with_dashes($title));
 278                 echo "\t<li><a name='$san_title' target='' href='$href'$class>$title</a></li>\n";
 279         }
 280         echo "</ul>\n";
 281         echo "</div>\n";
 282         ?>
 283         <div class="alignright fyi">
 284                 <?php if ( ! empty($api->download_link) && ( current_user_can('install_plugins') || current_user_can('update_plugins') ) ) : ?>
 285                 <p class="action-button">
 286                 <?php
 287                 $status = install_plugin_install_status($api);
 288                 switch ( $status['status'] ) {
 289                         case 'install':
 290                                 if ( $status['url'] )
 291                                         echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Now') . '</a>';
 292                                 break;
 293                         case 'update_available':
 294                                 if ( $status['url'] )
 295                                         echo '<a href="' . $status['url'] . '" target="_parent">' . __('Install Update Now') .'</a>';
 296                                 break;
 297                         case 'newer_installed':
 298                                 echo '<a>' . sprintf(__('Newer Version (%s) Installed'), $status['version']) . '</a>';
 299                                 break;
 300                         case 'latest_installed':
 301                                 echo '<a>' . __('Latest Version Installed') . '</a>';
 302                                 break;
 303                 }
 304                 ?>
 305                 </p>
 306                 <?php endif; ?>
 307                 <h2 class="mainheader"><?php /* translators: For Your Information */ _e('FYI') ?></h2>
 308                 <ul>
 309 <?php if ( ! empty($api->version) ) : ?>
 310                         <li><strong><?php _e('Version:') ?></strong> <?php echo $api->version ?></li>
 311 <?php endif; if ( ! empty($api->author) ) : ?>
 312                         <li><strong><?php _e('Author:') ?></strong> <?php echo links_add_target($api->author, '_blank') ?></li>
 313 <?php endif; if ( ! empty($api->last_updated) ) : ?>
 314                         <li><strong><?php _e('Last Updated:') ?></strong> <span title="<?php echo $api->last_updated ?>"><?php
 315                                                         printf( __('%s ago'), human_time_diff(strtotime($api->last_updated)) ) ?></span></li>
 316 <?php endif; if ( ! empty($api->requires) ) : ?>
 317                         <li><strong><?php _e('Requires WordPress Version:') ?></strong> <?php printf(__('%s or higher'), $api->requires) ?></li>
 318 <?php endif; if ( ! empty($api->tested) ) : ?>
 319                         <li><strong><?php _e('Compatible up to:') ?></strong> <?php echo $api->tested ?></li>
 320 <?php endif; if ( ! empty($api->downloaded) ) : ?>
 321                         <li><strong><?php _e('Downloaded:') ?></strong> <?php printf(_n('%s time', '%s times', $api->downloaded), number_format_i18n($api->downloaded)) ?></li>
 322 <?php endif; if ( ! empty($api->slug) && empty($api->external) ) : ?>
 323                         <li><a target="_blank" href="http://wordpress.org/extend/plugins/<?php echo $api->slug ?>/"><?php _e('WordPress.org Plugin Page &#187;') ?></a></li>
 324 <?php endif; if ( ! empty($api->homepage) ) : ?>
 325                         <li><a target="_blank" href="<?php echo $api->homepage ?>"><?php _e('Plugin Homepage  &#187;') ?></a></li>
 326 <?php endif; ?>
 327                 </ul>
 328                 <?php if ( ! empty($api->rating) ) : ?>
 329                 <h2><?php _e('Average Rating') ?></h2>
 330                 <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)); ?>">
 331                         <div class="star star-rating" style="width: <?php echo esc_attr($api->rating) ?>px"></div>
 332                         <div class="star star5"><img src="<?php echo admin_url('images/star.png?v=20110615'); ?>" alt="<?php esc_attr_e('5 stars') ?>" /></div>
 333                         <div class="star star4"><img src="<?php echo admin_url('images/star.png?v=20110615'); ?>" alt="<?php esc_attr_e('4 stars') ?>" /></div>
 334                         <div class="star star3"><img src="<?php echo admin_url('images/star.png?v=20110615'); ?>" alt="<?php esc_attr_e('3 stars') ?>" /></div>
 335                         <div class="star star2"><img src="<?php echo admin_url('images/star.png?v=20110615'); ?>" alt="<?php esc_attr_e('2 stars') ?>" /></div>
 336                         <div class="star star1"><img src="<?php echo admin_url('images/star.png?v=20110615'); ?>" alt="<?php esc_attr_e('1 star') ?>" /></div>
 337                 </div>
 338                 <small><?php printf(_n('(based on %s rating)', '(based on %s ratings)', $api->num_ratings), number_format_i18n($api->num_ratings)); ?></small>
 339                 <?php endif; ?>
 340         </div>
 341         <div id="section-holder" class="wrap">
 342         <?php
 343                 if ( !empty($api->tested) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->tested)), $api->tested, '>') )
 344                         echo '<div class="updated"><p>' . __('<strong>Warning:</strong> This plugin has <strong>not been tested</strong> with your current version of WordPress.') . '</p></div>';
 345
 346                 else if ( !empty($api->requires) && version_compare( substr($GLOBALS['wp_version'], 0, strlen($api->requires)), $api->requires, '<') )
 347                         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>';
 348
 349                 foreach ( (array)$api->sections as $section_name => $content ) {
 350                         $title = $section_name;
 351                         $title[0] = strtoupper($title[0]);
 352                         $title = str_replace('_', ' ', $title);
 353
 354                         $content = links_add_base_url($content, 'http://wordpress.org/extend/plugins/' . $api->slug . '/');
 355                         $content = links_add_target($content, '_blank');
 356
 357                         $san_title = esc_attr(sanitize_title_with_dashes($title));
 358
 359                         $display = ( $section_name == $section ) ? 'block' : 'none';
 360
 361                         echo "\t<div id='section-{$san_title}' class='section' style='display: {$display};'>\n";
 362                         echo "\t\t<h2 class='long-header'>$title</h2>";
 363                         echo $content;
 364                         echo "\t</div>\n";
 365                 }
 366         echo "</div>\n";
 367
 368         iframe_footer();
 369         exit;
 370 }
 371 add_action('install_plugins_pre_plugin-information', 'install_plugin_information');