<?php

/**

 * WordPress Plugin Administration API

 *

 * @package WordPress

 * @subpackage Administration

 */

/**

 * Parse the plugin contents to retrieve plugin's metadata.

 *

 * The metadata of the plugin's data searches for the following in the plugin's

 * header. All plugin data must be on its own line. For plugin description, it

 * must not have any newlines or only parts of the description will be displayed

 * and the same goes for the plugin data. The below is formatted for printing.

 *

 * <code>

 * /*

 * Plugin Name: Name of Plugin

 * Plugin URI: Link to plugin information

 * Description: Plugin Description

 * Author: Plugin author's name

 * Author URI: Link to the author's web site

 * Version: Must be set in the plugin for WordPress 2.3+

 * Text Domain: Optional. Unique identifier, should be same as the one used in

 *		plugin_text_domain()

 * Domain Path: Optional. Only useful if the translations are located in a

 *		folder above the plugin's base path. For example, if .mo files are

 *		located in the locale folder then Domain Path will be "/locale/" and

 *		must have the first slash. Defaults to the base folder the plugin is

 *		located in.

 * Network: Optional. Specify "Network: true" to require that a plugin is activated

 *		across all sites in an installation. This will prevent a plugin from being

 *		activated on a single site when Multisite is enabled.

 *  * / # Remove the space to close comment

 * </code>

 *

 * Plugin data returned array contains the following:

 *		'Name' - Name of the plugin, must be unique.

 *		'Title' - Title of the plugin and the link to the plugin's web site.

 *		'Description' - Description of what the plugin does and/or notes

 *		from the author.

 *		'Author' - The author's name

 *		'AuthorURI' - The authors web site address.

 *		'Version' - The plugin version number.

 *		'PluginURI' - Plugin web site address.

 *		'TextDomain' - Plugin's text domain for localization.

 *		'DomainPath' - Plugin's relative directory path to .mo files.

 *		'Network' - Boolean. Whether the plugin can only be activated network wide.

 *

 * Some users have issues with opening large files and manipulating the contents

 * for want is usually the first 1kiB or 2kiB. This function stops pulling in

 * the plugin contents when it has all of the required plugin data.

 *

 * The first 8kiB of the file will be pulled in and if the plugin data is not

 * within that first 8kiB, then the plugin author should correct their plugin

 * and move the plugin data headers to the top.

 *

 * The plugin file is assumed to have permissions to allow for scripts to read

 * the file. This is not checked however and the file is only opened for

 * reading.

 *

 * @link http://trac.wordpress.org/ticket/5651 Previous Optimizations.

 * @link http://trac.wordpress.org/ticket/7372 Further and better Optimizations.

 * @since 1.5.0

 *

 * @param string $plugin_file Path to the plugin file

 * @param bool $markup Optional. If the returned data should have HTML markup applied. Defaults to true.

 * @param bool $translate Optional. If the returned data should be translated. Defaults to true.

 * @return array See above for description.

 */

function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {

	$default_headers = array(

		'Name' => 'Plugin Name',

		'PluginURI' => 'Plugin URI',

		'Version' => 'Version',

		'Description' => 'Description',

		'Author' => 'Author',

		'AuthorURI' => 'Author URI',

		'TextDomain' => 'Text Domain',

		'DomainPath' => 'Domain Path',

		'Network' => 'Network',

		// Site Wide Only is deprecated in favor of Network.

		'_sitewide' => 'Site Wide Only',

	);

	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );

	// Site Wide Only is the old header for Network

	if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {

		_deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The <code>%1$s</code> plugin header is deprecated. Use <code>%2$s</code> instead.' ), 'Site Wide Only: true', 'Network: true' ) );

		$plugin_data['Network'] = $plugin_data['_sitewide'];

	}

	$plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );

	unset( $plugin_data['_sitewide'] );

	if ( $markup || $translate ) {

		$plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );

	} else {

		$plugin_data['Title']      = $plugin_data['Name'];

		$plugin_data['AuthorName'] = $plugin_data['Author'];

	}

	return $plugin_data;

}

/**

 * Sanitizes plugin data, optionally adds markup, optionally translates.

 *

 * @since 2.7.0

 * @access private

 * @see get_plugin_data()

 */

function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {

	// Translate fields

	if ( $translate ) {

		if ( $textdomain = $plugin_data['TextDomain'] ) {

			if ( $plugin_data['DomainPath'] )

				load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );

			else

				load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );

		} elseif ( in_array( basename( $plugin_file ), array( 'hello.php', 'akismet.php' ) ) ) {

			$textdomain = 'default';

		}

		if ( $textdomain ) {

			foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field )

				$plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );

		}

	}

	// Sanitize fields

	$allowed_tags = $allowed_tags_in_links = array(

		'abbr'    => array( 'title' => true ),

		'acronym' => array( 'title' => true ),

		'code'    => true,

		'em'      => true,

		'strong'  => true,

	);

	$allowed_tags['a'] = array( 'href' => true, 'title' => true );

	// Name is marked up inside <a> tags. Don't allow these.

	// Author is too, but some plugins have used <a> here (omitting Author URI).

	$plugin_data['Name']        = wp_kses( $plugin_data['Name'],        $allowed_tags_in_links );

	$plugin_data['Author']      = wp_kses( $plugin_data['Author'],      $allowed_tags );

	$plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );

	$plugin_data['Version']     = wp_kses( $plugin_data['Version'],     $allowed_tags );

	$plugin_data['PluginURI']   = esc_url( $plugin_data['PluginURI'] );

	$plugin_data['AuthorURI']   = esc_url( $plugin_data['AuthorURI'] );

	$plugin_data['Title']      = $plugin_data['Name'];

	$plugin_data['AuthorName'] = $plugin_data['Author'];

	// Apply markup

	if ( $markup ) {

		if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )

			$plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';

		if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )

			$plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '" title="' . esc_attr__( 'Visit author homepage' ) . '">' . $plugin_data['Author'] . '</a>';

		$plugin_data['Description'] = wptexturize( $plugin_data['Description'] );

		if ( $plugin_data['Author'] )

			$plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';

	}

	return $plugin_data;

}

/**

 * Get a list of a plugin's files.

 *

 * @since 2.8.0

 *

 * @param string $plugin Plugin ID

 * @return array List of files relative to the plugin root.

 */

function get_plugin_files($plugin) {

	$plugin_file = WP_PLUGIN_DIR . '/' . $plugin;

	$dir = dirname($plugin_file);

	$plugin_files = array($plugin);

	if ( is_dir($dir) && $dir != WP_PLUGIN_DIR ) {

		$plugins_dir = @ opendir( $dir );

		if ( $plugins_dir ) {

			while (($file = readdir( $plugins_dir ) ) !== false ) {

				if ( substr($file, 0, 1) == '.' )

					continue;

				if ( is_dir( $dir . '/' . $file ) ) {

					$plugins_subdir = @ opendir( $dir . '/' . $file );

					if ( $plugins_subdir ) {

						while (($subfile = readdir( $plugins_subdir ) ) !== false ) {

							if ( substr($subfile, 0, 1) == '.' )

								continue;

							$plugin_files[] = plugin_basename("$dir/$file/$subfile");

						}

						@closedir( $plugins_subdir );

					}

				} else {

					if ( plugin_basename("$dir/$file") != $plugin )

						$plugin_files[] = plugin_basename("$dir/$file");

				}

			}

			@closedir( $plugins_dir );

		}

	}

	return $plugin_files;

}

/**

 * Check the plugins directory and retrieve all plugin files with plugin data.

 *

 * WordPress only supports plugin files in the base plugins directory

 * (wp-content/plugins) and in one directory above the plugins directory

 * (wp-content/plugins/my-plugin). The file it looks for has the plugin data and

 * must be found in those two locations. It is recommended that do keep your

 * plugin files in directories.

 *

 * The file with the plugin data is the file that will be included and therefore

 * needs to have the main execution for the plugin. This does not mean

 * everything must be contained in the file and it is recommended that the file

 * be split for maintainability. Keep everything in one file for extreme

 * optimization purposes.

 *

 * @since 1.5.0

 *

 * @param string $plugin_folder Optional. Relative path to single plugin folder.

 * @return array Key is the plugin file path and the value is an array of the plugin data.

 */

function get_plugins($plugin_folder = '') {

	if ( ! $cache_plugins = wp_cache_get('plugins', 'plugins') )

		$cache_plugins = array();

	if ( isset($cache_plugins[ $plugin_folder ]) )

		return $cache_plugins[ $plugin_folder ];

	$wp_plugins = array ();

	$plugin_root = WP_PLUGIN_DIR;

	if ( !empty($plugin_folder) )

		$plugin_root .= $plugin_folder;

	// Files in wp-content/plugins directory

	$plugins_dir = @ opendir( $plugin_root);

	$plugin_files = array();

	if ( $plugins_dir ) {

		while (($file = readdir( $plugins_dir ) ) !== false ) {

			if ( substr($file, 0, 1) == '.' )

				continue;

			if ( is_dir( $plugin_root.'/'.$file ) ) {

				$plugins_subdir = @ opendir( $plugin_root.'/'.$file );

				if ( $plugins_subdir ) {

					while (($subfile = readdir( $plugins_subdir ) ) !== false ) {

						if ( substr($subfile, 0, 1) == '.' )

							continue;

						if ( substr($subfile, -4) == '.php' )

							$plugin_files[] = "$file/$subfile";

					}

					closedir( $plugins_subdir );

				}

			} else {

				if ( substr($file, -4) == '.php' )

					$plugin_files[] = $file;

			}

		}

		closedir( $plugins_dir );

	}

	if ( empty($plugin_files) )

		return $wp_plugins;

	foreach ( $plugin_files as $plugin_file ) {

		if ( !is_readable( "$plugin_root/$plugin_file" ) )

			continue;

		$plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.

		if ( empty ( $plugin_data['Name'] ) )

			continue;

		$wp_plugins[plugin_basename( $plugin_file )] = $plugin_data;

	}

	uasort( $wp_plugins, '_sort_uname_callback' );

	$cache_plugins[ $plugin_folder ] = $wp_plugins;

	wp_cache_set('plugins', $cache_plugins, 'plugins');

	return $wp_plugins;

}

/**

 * Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.

 *

 * WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins).

 *

 * @since 3.0.0

 * @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.

 */

function get_mu_plugins() {

	$wp_plugins = array();

	// Files in wp-content/mu-plugins directory

	$plugin_files = array();

	if ( ! is_dir( WPMU_PLUGIN_DIR ) )

		return $wp_plugins;

	if ( $plugins_dir = @ opendir( WPMU_PLUGIN_DIR ) ) {

		while ( ( $file = readdir( $plugins_dir ) ) !== false ) {

			if ( substr( $file, -4 ) == '.php' )

				$plugin_files[] = $file;

		}

	} else {

		return $wp_plugins;

	}

	@closedir( $plugins_dir );

	if ( empty($plugin_files) )

		return $wp_plugins;

	foreach ( $plugin_files as $plugin_file ) {

		if ( !is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) )

			continue;

		$plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.

		if ( empty ( $plugin_data['Name'] ) )

			$plugin_data['Name'] = $plugin_file;

		$wp_plugins[ $plugin_file ] = $plugin_data;

	}

	if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php') <= 30 ) // silence is golden

		unset( $wp_plugins['index.php'] );

	uasort( $wp_plugins, '_sort_uname_callback' );

	return $wp_plugins;

}

/**

 * Callback to sort array by a 'Name' key.

 *

 * @since 3.1.0

 * @access private

 */

function _sort_uname_callback( $a, $b ) {

	return strnatcasecmp( $a['Name'], $b['Name'] );

}

/**

 * Check the wp-content directory and retrieve all drop-ins with any plugin data.

 *

 * @since 3.0.0

 * @return array Key is the file path and the value is an array of the plugin data.

 */

function get_dropins() {

	$dropins = array();

	$plugin_files = array();

	$_dropins = _get_dropins();

	// These exist in the wp-content directory

	if ( $plugins_dir = @ opendir( WP_CONTENT_DIR ) ) {

		while ( ( $file = readdir( $plugins_dir ) ) !== false ) {

			if ( isset( $_dropins[ $file ] ) )

				$plugin_files[] = $file;

		}

	} else {

		return $dropins;

	}

	@closedir( $plugins_dir );

	if ( empty($plugin_files) )

		return $dropins;

	foreach ( $plugin_files as $plugin_file ) {

		if ( !is_readable( WP_CONTENT_DIR . "/$plugin_file" ) )

			continue;

		$plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.

		if ( empty( $plugin_data['Name'] ) )

			$plugin_data['Name'] = $plugin_file;

		$dropins[ $plugin_file ] = $plugin_data;

	}

	uksort( $dropins, 'strnatcasecmp' );

	return $dropins;

}

/**

 * Returns drop-ins that WordPress uses.

 *

 * Includes Multisite drop-ins only when is_multisite()

 *

 * @since 3.0.0

 * @return array Key is file name. The value is an array, with the first value the

 *	purpose of the drop-in and the second value the name of the constant that must be

 *	true for the drop-in to be used, or true if no constant is required.

 */

function _get_dropins() {

	$dropins = array(