<?php

/**

 * WordPress Plugin Install Administration API

 *

 * @package WordPress

 * @subpackage Administration

 */

/**

 * Retrieves plugin installer pages from the WordPress.org Plugins API.

 *

 * It is possible for a plugin to override the Plugin API result with three

 * filters. Assume this is for plugins, which can extend on the Plugin Info to

 * offer more choices. This is very powerful and must be used with care when

 * overriding the filters.

 *

 * The first filter, {@see 'plugins_api_args'}, is for the args and gives the action

 * as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that

 * an object is returned.

 *

 * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org

 * Plugin Installation API entirely. If `$action` is 'query_plugins' or 'plugin_information',

 * an object MUST be passed. If `$action` is 'hot_tags', an array MUST be passed.

 *

 * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the

 * response object or array, depending on the `$action` type.

 *

 * Supported arguments per action:

 *

 * | Argument Name        | query_plugins | plugin_information | hot_tags |

 * | -------------------- | :-----------: | :----------------: | :------: |

 * | `$slug`              | No            |  Yes               | No       |

 * | `$per_page`          | Yes           |  No                | No       |

 * | `$page`              | Yes           |  No                | No       |

 * | `$number`            | No            |  No                | Yes      |

 * | `$search`            | Yes           |  No                | No       |

 * | `$tag`               | Yes           |  No                | No       |

 * | `$author`            | Yes           |  No                | No       |

 * | `$user`              | Yes           |  No                | No       |

 * | `$browse`            | Yes           |  No                | No       |

 * | `$locale`            | Yes           |  Yes               | No       |

 * | `$installed_plugins` | Yes           |  No                | No       |

 * | `$is_ssl`            | Yes           |  Yes               | No       |

 * | `$fields`            | Yes           |  Yes               | No       |

 *

 * @since 2.7.0

 *

 * @param string       $action API action to perform: 'query_plugins', 'plugin_information',

 *                             or 'hot_tags'.

 * @param array|object $args   {

 *     Optional. Array or object of arguments to serialize for the Plugin Info API.

 *

 *     @type string  $slug              The plugin slug. Default empty.

 *     @type int     $per_page          Number of plugins per page. Default 24.

 *     @type int     $page              Number of current page. Default 1.

 *     @type int     $number            Number of tags or categories to be queried.

 *     @type string  $search            A search term. Default empty.

 *     @type string  $tag               Tag to filter plugins. Default empty.

 *     @type string  $author            Username of an plugin author to filter plugins. Default empty.

 *     @type string  $user              Username to query for their favorites. Default empty.

 *     @type string  $browse            Browse view: 'popular', 'new', 'beta', 'recommended'.

 *     @type string  $locale            Locale to provide context-sensitive results. Default is the value

 *                                      of get_locale().

 *     @type string  $installed_plugins Installed plugins to provide context-sensitive results.

 *     @type bool    $is_ssl            Whether links should be returned with https or not. Default false.

 *     @type array   $fields            {

 *         Array of fields which should or should not be returned.

 *

 *         @type bool $short_description Whether to return the plugin short description. Default true.

 *         @type bool $description       Whether to return the plugin full description. Default false.

 *         @type bool $sections          Whether to return the plugin readme sections: description, installation,

 *                                       FAQ, screenshots, other notes, and changelog. Default false.

 *         @type bool $tested            Whether to return the 'Compatible up to' value. Default true.

 *         @type bool $requires          Whether to return the required WordPress version. Default true.

 *         @type bool $requires_php      Whether to return the required PHP version. Default true.

 *         @type bool $rating            Whether to return the rating in percent and total number of ratings.

 *                                       Default true.

 *         @type bool $ratings           Whether to return the number of rating for each star (1-5). Default true.

 *         @type bool $downloaded        Whether to return the download count. Default true.

 *         @type bool $downloadlink      Whether to return the download link for the package. Default true.

 *         @type bool $last_updated      Whether to return the date of the last update. Default true.

 *         @type bool $added             Whether to return the date when the plugin was added to the wordpress.org

 *                                       repository. Default true.

 *         @type bool $tags              Whether to return the assigned tags. Default true.

 *         @type bool $compatibility     Whether to return the WordPress compatibility list. Default true.

 *         @type bool $homepage          Whether to return the plugin homepage link. Default true.

 *         @type bool $versions          Whether to return the list of all available versions. Default false.

 *         @type bool $donate_link       Whether to return the donation link. Default true.

 *         @type bool $reviews           Whether to return the plugin reviews. Default false.

 *         @type bool $banners           Whether to return the banner images links. Default false.

 *         @type bool $icons             Whether to return the icon links. Default false.

 *         @type bool $active_installs   Whether to return the number of active installations. Default false.

 *         @type bool $contributors      Whether to return the list of contributors. Default false.

 *     }

 * }

 * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the

 *         {@link https://developer.wordpress.org/reference/functions/plugins_api/ function reference article}

 *         for more information on the make-up of possible return values depending on the value of `$action`.

 */

function plugins_api( $action, $args = array() ) {

	if ( is_array( $args ) ) {

		$args = (object) $args;

	}

	if ( 'query_plugins' === $action ) {

		if ( ! isset( $args->per_page ) ) {

			$args->per_page = 24;

		}

	}

	if ( ! isset( $args->locale ) ) {

		$args->locale = get_user_locale();

	}

	if ( ! isset( $args->wp_version ) ) {

		$args->wp_version = substr( wp_get_wp_version(), 0, 3 ); // x.y

	}

	/**

	 * Filters the WordPress.org Plugin Installation API arguments.

	 *

	 * Important: An object MUST be returned to this filter.

	 *

	 * @since 2.7.0

	 *

	 * @param object $args   Plugin API arguments.

	 * @param string $action The type of information being requested from the Plugin Installation API.

	 */

	$args = apply_filters( 'plugins_api_args', $args, $action );

	/**

	 * Filters the response for the current WordPress.org Plugin Installation API request.

	 *

	 * Returning a non-false value will effectively short-circuit the WordPress.org API request.

	 *

	 * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.

	 * If `$action` is 'hot_tags', an array should be passed.

	 *

	 * @since 2.7.0

	 *

	 * @param false|object|array $result The result object or array. Default false.

	 * @param string             $action The type of information being requested from the Plugin Installation API.

	 * @param object             $args   Plugin API arguments.

	 */

	$res = apply_filters( 'plugins_api', false, $action, $args );

	if ( false === $res ) {

		$url = 'http://api.wordpress.org/plugins/info/1.2/';

		$url = add_query_arg(

			array(

				'action'  => $action,

				'request' => $args,

			),

			$url

		);

		$http_url = $url;

		$ssl      = wp_http_supports( array( 'ssl' ) );

		if ( $ssl ) {

			$url = set_url_scheme( $url, 'https' );

		}

		$http_args = array(

			'timeout'    => 15,

			'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ),

		);

		$request   = wp_remote_get( $url, $http_args );

		if ( $ssl && is_wp_error( $request ) ) {

			if ( ! wp_is_json_request() ) {

				wp_trigger_error(

					__FUNCTION__,

					sprintf(

						/* translators: %s: Support forums URL. */

						__( '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="%s">support forums</a>.' ),

						__( 'https://wordpress.org/support/forums/' )

					) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),

					headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE

				);

			}

			$request = wp_remote_get( $http_url, $http_args );

		}

		if ( is_wp_error( $request ) ) {

			$res = new WP_Error(

				'plugins_api_failed',

				sprintf(

					/* translators: %s: Support forums URL. */

					__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),

					__( 'https://wordpress.org/support/forums/' )

				),

				$request->get_error_message()

			);

		} else {

			$res = json_decode( wp_remote_retrieve_body( $request ), true );

			if ( is_array( $res ) ) {

				// Object casting is required in order to match the info/1.0 format.

				$res = (object) $res;

			} elseif ( null === $res ) {

				$res = new WP_Error(

					'plugins_api_failed',

					sprintf(

						/* translators: %s: Support forums URL. */

						__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),

						__( 'https://wordpress.org/support/forums/' )

					),

					wp_remote_retrieve_body( $request )

				);

			}

			if ( isset( $res->error ) ) {

				$res = new WP_Error( 'plugins_api_failed', $res->error );

			}

		}

	} elseif ( ! is_wp_error( $res ) ) {

		$res->external = true;

	}

	/**

	 * Filters the Plugin Installation API response results.

	 *

	 * @since 2.7.0

	 *

	 * @param object|WP_Error $res    Response object or WP_Error.

	 * @param string          $action The type of information being requested from the Plugin Installation API.

	 * @param object          $args   Plugin API arguments.

	 */

	return apply_filters( 'plugins_api_result', $res, $action, $args );

}

/**

 * Retrieves popular WordPress plugin tags.

 *

 * @since 2.7.0

 *

 * @param array $args

 * @return array|WP_Error

 */

function install_popular_tags( $args = array() ) {

	$key  = md5( serialize( $args ) );

	$tags = get_site_transient( 'poptags_' . $key );

	if ( false !== $tags ) {

		return $tags;

	}

	$tags = plugins_api( 'hot_tags', $args );

	if ( is_wp_error( $tags ) ) {

		return $tags;

	}

	set_site_transient( 'poptags_' . $key, $tags, 3 * HOUR_IN_SECONDS );

	return $tags;

}

/**

 * Displays the Featured tab of Add Plugins screen.

 *

 * @since 2.7.0

 */

function install_dashboard() {

	display_plugins_table();

	?>

	<div class="plugins-popular-tags-wrapper">

	<h2><?php _e( 'Popular tags' ); ?></h2>

	<p><?php _e( 'You may also browse based on the most popular tags in the Plugin Directory:' ); ?></p>

	<?php

	$api_tags = install_popular_tags();

	echo '<p class="popular-tags">';

	if ( is_wp_error( $api_tags ) ) {

		echo $api_tags->get_error_message();

	} else {

		// Set up the tags in a way which can be interpreted by wp_generate_tag_cloud().

		$tags = array();

		foreach ( (array) $api_tags as $tag ) {

			$url                  = self_admin_url( 'plugin-install.php?tab=search&type=tag&s=' . urlencode( $tag['name'] ) );

			$data                 = array(

				'link'  => esc_url( $url ),

				'name'  => $tag['name'],

				'slug'  => $tag['slug'],

				'id'    => sanitize_title_with_dashes( $tag['name'] ),

				'count' => $tag['count'],

			);

			$tags[ $tag['name'] ] = (object) $data;

		}

		echo wp_generate_tag_cloud(

			$tags,

			array(

				/* translators: %s: Number of plugins. */

				'single_text'   => __( '%s plugin' ),

				/* translators: %s: Number of plugins. */

				'multiple_text' => __( '%s plugins' ),

			)

		);

	}

	echo '</p><br class="clear" /></div>';

}

/**

 * Displays a search form for searching plugins.

 *

 * @since 2.7.0

 * @since 4.6.0 The `$type_selector` parameter was deprecated.

 *

 * @param bool $deprecated Not used.

 */

function install_search_form( $deprecated = true ) {

	$type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';

	$term = isset( $_REQUEST['s'] ) ? urldecode( wp_unslash( $_REQUEST['s'] ) ) : '';

	?>

	<form class="search-form search-plugins" method="get">

		<input type="hidden" name="tab" value="search" />

		<label for="search-plugins"><?php _e( 'Search Plugins' ); ?></label>

		<input type="search" name="s" id="search-plugins" value="<?php echo esc_attr( $term ); ?>" class="wp-filter-search" />

		<label class="screen-reader-text" for="typeselector">

			<?php

			/* translators: Hidden accessibility text. */

			_e( 'Search plugins by:' );

			?>

		</label>

		<select name="type" id="typeselector">

			<option value="term"<?php selected( 'term', $type ); ?>><?php _e( 'Keyword' ); ?></option>

			<option value="author"<?php selected( 'author', $type ); ?>><?php _e( 'Author' ); ?></option>

			<option value="tag"<?php selected( 'tag', $type ); ?>><?php _ex( 'Tag', 'Plugin Installer' ); ?></option>

		</select>

		<?php submit_button( __( 'Search Plugins' ), 'hide-if-js', false, false, array( 'id' => 'search-submit' ) ); ?>

	</form>

	<?php

}

/**

 * Displays a form to upload plugins from zip files.

 *

 * @since 2.8.0

 */

function install_plugins_upload() {

	?>

<div class="upload-plugin">

	<p class="install-help"><?php _e( 'If you have a plugin in a .zip format, you may install or update it by uploading it here.' ); ?></p>

	<form method="post" enctype="multipart/form-data" class="wp-upload-form" action="<?php echo esc_url( self_admin_url( 'update.php?action=upload-plugin' ) ); ?>">

		<?php wp_nonce_field( 'plugin-upload' ); ?>

		<label class="screen-reader-text" for="pluginzip">

			<?php

			/* translators: Hidden accessibility text. */

			_e( 'Plugin zip file' );

			?>

		</label>

		<input type="file" id="pluginzip" name="pluginzip" accept=".zip" />

		<?php submit_button( _x( 'Install Now', 'plugin' ), '', 'install-plugin-submit', false ); ?>

	</form>

</div>

	<?php

}

/**

 * Shows a username form for the favorites page.

 *

 * @since 3.5.0

 */

function install_plugins_favorites_form() {

	$user   = get_user_option( 'wporg_favorites' );

	$action = 'save_wporg_username_' . get_current_user_id();

	?>

	<p><?php _e( 'If you have marked plugins as favorites on WordPress.org, you can browse them here.' ); ?></p>

	<form method="get">

		<input type="hidden" name="tab" value="favorites" />

		<p>

			<label for="user"><?php _e( 'Your WordPress.org username:' ); ?></label>

			<input type="search" id="user" name="user" value="<?php echo esc_attr( $user ); ?>" />

			<input type="submit" class="button" value="<?php esc_attr_e( 'Get Favorites' ); ?>" />

			<input type="hidden" id="wporg-username-nonce" name="_wpnonce" value="<?php echo esc_attr( wp_create_nonce( $action ) ); ?>" />

		</p>

	</form>

	<?php

}

/**

 * Displays plugin content based on plugin list.

 *

 * @since 2.7.0

 *

 * @global WP_List_Table $wp_list_table

 */

function display_plugins_table() {

	global $wp_list_table;

	switch ( current_filter() ) {

		case 'install_plugins_beta':

			printf(

				/* translators: %s: URL to "Features as Plugins" page. */

				'<p>' . __( 'You are using a development version of WordPress. These feature plugins are also under development. <a href="%s">Learn more</a>.' ) . '</p>',

				'https://make.wordpress.org/core/handbook/about/release-cycle/features-as-plugins/'

			);

			break;

		case 'install_plugins_featured':

			printf(

				/* translators: %s: https://wordpress.org/plugins/ */

				'<p>' . __( 'Plugins extend and expand the functionality of WordPress. You may install plugins in the <a href="%s">WordPress Plugin Directory</a> right from here, or upload a plugin in .zip format by clicking the button at the top of this page.' ) . '</p>',

				__( 'https://wordpress.org/plugins/' )

			);

			break;

		case 'install_plugins_recommended':

			echo '<p>' . __( 'These suggestions are based on the plugins you and other users have installed.' ) . '</p>';

			break;

		case 'install_plugins_favorites':

			if ( empty( $_GET['user'] ) && ! get_user_option( 'wporg_favorites' ) ) {

				return;

			}

			break;

	}

	?>

	<form id="plugin-filter" method="post">