plugin-dirs.php

<?php
! defined( 'ABSPATH' ) AND exit();
/*
Plugin Name:  Additional Plugin Directories
Plugin URI:   http://github.com/chrisguitarguy
Description:  A framework to allow adding additional plugin directories to WordPress
Version:      1.1
Author:       Christopher Davis
Contributors: Franz Josef Kaiser, Julien Chaumond
Author URI:   http://christopherdavis.me
License:      MIT
*/



// Avoid loading twice
if ( ! class_exists( 'dmb_bootstrap' ) )
{
	add_action( 'plugins_loaded', array( 'CD_APD_Bootstrap', 'init' ), 5 );

/**
 * Bootstrap for delayed Meta Boxes
 * 
 * @author     Franz Josef Kaiser, Christopher Davis
 * @license    MIT
 * @copyright  © Franz Josef Kaiser, Christopher Davis 2011-2012
 * 
 * @package    WordPress
 * @subpackage Additional Plugin Directories: Bootstrap
 */
class CD_APD_Bootstrap
{
	/**
	 * Instance
	 * 
	 * @access protected
	 * @var object
	 */
	static protected $instance;


	/**
	 * The files that need to get included
	 * 
	 * @since     0.8
	 * @access    public
	 * @static
	 * @var array string Class Name w/o prefix (Hint: Naming convention!) Use the value to define if need to hook the class.
	 */
	static public $includes = array(
		 'api'   => false
		,'core'  => false
		,'admin' => true
	);


	/**
	 * Used for update notices
	 * Fetches the readme file from the official plugin repo trunk.
	 * Adds to the "in_plugin_update_message-$file" hook
	 * 
	 * @var (string)
	 */
	public $remote_changelog = 'https://raw.github.com/chrisguitarguy/WP-Plugin-Directories/master/changelog.html';


	/**
	 * Creates a new static instance
	 * 
	 * @since  0.8
	 * @static
	 * @return void
	 */
	static public function init()
	{
		null === self :: $instance AND self :: $instance = new self;
		return self :: $instance;
	}


	/**
	 * Constructor
	 * 
	 * @since  0.8
	 * @access public
	 * @return void
	 */
	public function __construct()
	{
		// Localize
		load_theme_textdomain( 'cd_apd_textdomain', plugin_dir_path( __FILE__ )."lang" );

		// Load at the end of /wp-admin/admin.php
		foreach ( self :: $includes as $inc => $init )
		{
			// Load file: trailingslashed by core
			# Tested: calling plugin_dir_path() directly saves 1/2 time 
			# instead of saving the plugin_dir_path() in a $var and recalling here
			require_once plugin_dir_path( __FILE__ )."inc/{$inc}.php";

			if ( ! $init )
				continue;

			// Build class name
			$class = "CD_APD_".ucwords( $inc );

			class_exists( $class ) AND add_action( 'plugins_loaded', array( $class, 'instance' ) );
		}

		if ( ! is_admin() )
			return;

		// Updates from GitHub
		// $ git submodule add git://github.com/franz-josef-kaiser/WordPress-GitHub-Plugin-Updater inc/updater
		add_action( 'init', array( $this, 'update_from_github' ), 0 );
	}


	/**
	 * 
	 * @since 1.0
	 * 
	 * @return void
	 */
	public function update_from_github()
	{
		global $wp_version;

		// Load the updater
		include_once plugin_dir_path( __FILE__ ).'inc/updater/updater.php';

		// Fix this strange WP bug(?)
		add_action( 'http_request_args', array( $this, 'update_request_args' ), 0, 2 );

		$host	= 'github.com';
		$http	= 'https://';
		$name	= 'chrisguitarguy';
		$repo	= 'WP-Plugin-Directories';
		new wp_github_updater( array(
			 'slug'               => plugin_basename( __FILE__ )
			,'proper_folder_name' => dirname( plugin_basename(__FILE__) )
			,'api_url'            => "{$http}api.{$host}/repos/{$name}/{$repo}"
			,'raw_url'            => "{$http}raw.{$host}/{$name}/{$repo}/master"
			,'github_url'         => "{$http}{$host}/{$name}/{$repo}"
			,'zip_url'            => "{$http}{$host}/{$name}/{$repo}/zipball/master"
			,'sslverify'          => true
			,'requires'           => $wp_version
			,'tested'             => $wp_version
			,'readme_file'        => 'readme.md'
			,'description'        => array( 
				'changelog' => $this->update_message()
			 )
		) );
	}


	/**
	 * Callback to set the SSL verification for HTTP requests to GitHub to false
	 * 
	 * @since  1.0
	 * @param  array  $args
	 * @param  string $url
	 * @return array  $args
	 */
	public function update_request_args( $args, $url )
	{
		// Only needed once - this saves us checking the $url
		remove_filter( current_filter(), __FUNCTION__ );

		return array_merge( $args, array(
			'sslverify' => false
		) );
	}


	/**
	 * Displays an update message for plugin list screens.
	 * Shows only the version updates from the current until the newest version
	 * 
	 * @uses WordPress HTTP API
	 * @uses $allowed_html and $allowed_protocolls inside `install_plugin_information()`
	 * 
	 * @since  0.9
	 * @return string The actual Output message
	 */
	public function update_message()
	{
		// Get `changelog.txt` from GitHub via WP HTTP API
		$remote_data = wp_remote_get( 
			 $this->remote_changelog
			,false 
		);

		// Die silently
		$response = wp_remote_retrieve_response_code( $remote_data );

		if ( is_wp_error( $remote_data ) )
			return _e( 'No changelog could get fetched.', 'cd_apd_textdomain' );

		if ( 404 === $response )
			return $remote_data['response']['message']; 

		return sprintf( 
			 "<p style='font-weight:normal;'>%s</p>"
			,wp_remote_retrieve_body( $remote_data )
		);
	}
} // END Class CD_APD_Bootstrap

} // endif;