PageRenderTime 41ms CodeModel.GetById 9ms RepoModel.GetById 1ms app.codeStats 0ms

/wp-admin/includes/plugin-install.php

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