Merge pull request #51 from kasparsd/feature/restructure

Restructure and refactor. Props @szepeviktor @markoheijnen

include/admin.php

@@ -0,0 +1,62 @@
+<?php
+
+class Minit_Admin {
+
+	protected $plugin;
+
+
+	public function __construct( $plugin ) {
+
+		$this->plugin = $plugin;
+
+	}
+
+
+	public function init() {
+
+		// Add a Purge Cache link to the plugin list
+		// @todo Enable this for multisite somehow
+		add_filter( 'plugin_action_links_' . plugin_basename( $this->plugin->plugin_file ), array( $this, 'plugin_action_link_cache_bump' ) );
+
+		// Maybe purge minit cache
+		add_action( 'admin_init', array( $this, 'cache_bump' ) );
+
+	}
+
+
+	function plugin_action_link_cache_bump( $links ) {
+
+		$links[] = sprintf(
+				'<a href="%s">%s</a>',
+				wp_nonce_url( add_query_arg( 'purge_minit', true ), 'purge_minit' ),
+				__( 'Purge cache', 'minit' )
+			);
+
+		return $links;
+
+	}
+
+
+	function cache_bump() {
+
+		if ( ! isset( $_GET['purge_minit'] ) || ! check_admin_referer( 'purge_minit' ) )
+			return;
+
+		$this->plugin->cache_bump();
+
+		add_action( 'admin_notices', array( $this, 'cache_bump_notice' ) );
+
+	}
+
+
+	function cache_bump_notice() {
+
+		printf(
+			'<div class="updated"><p>%s</p></div>',
+			__( 'Success: Minit cache purged.', 'minit' )
+		);
+
+	}
+
+
+}

include/helpers.php

@@ -0,0 +1,64 @@
+<?php
+
+// Prepend the filename of the file being included
+add_filter( 'minit-item-css', 'minit_comment_combined', 15, 3 );
+add_filter( 'minit-item-js', 'minit_comment_combined', 15, 3 );
+
+function minit_comment_combined( $content, $object, $handle ) {
+
+	if ( ! $content )
+		return $content;
+
+	return sprintf(
+			"\n\n/* Minit: %s */\n",
+			$object->registered[ $handle ]->src
+		) . $content;
+
+}
+
+
+// Add table of contents at the top of the Minit file
+add_filter( 'minit-content-css', 'minit_add_toc', 100, 2 );
+add_filter( 'minit-content-js', 'minit_add_toc', 100, 2 );
+
+function minit_add_toc( $content, $items ) {
+
+	if ( ! $content || empty( $items ) )
+		return $content;
+
+	$toc = array();
+
+	foreach ( $items as $handle => $item_content )
+		$toc[] = sprintf( ' - %s', $handle );
+
+	return sprintf( "/* Contents:\n%s\n*/", implode( "\n", $toc ) ) . $content;
+
+}
+
+
+// Make sure that all Minit files are served from the correct protocol
+add_filter( 'minit-url-css', 'minit_maybe_ssl_url' );
+add_filter( 'minit-url-js', 'minit_maybe_ssl_url' );
+
+function minit_maybe_ssl_url( $url ) {
+
+	if ( is_ssl() )
+		return str_replace( 'http://', 'https://', $url );
+
+	return $url;
+
+}
+
+
+// Exclude handles that are known to cause problems
+add_filter( 'minit-exclude-js', 'minit_exclude_defaults' );
+
+function minit_exclude_defaults( $handles ) {
+
+	$exclude = array(
+		'this-is-a-handle-of-a-script-you-want-to-exclude',
+	);
+
+	return array_merge( $exclude, $handles );
+
+}

include/minit-assets.php

@@ -0,0 +1,260 @@
+<?php
+
+abstract class Minit_Assets {
+
+	public $queue = array();
+	public $done = array();
+	public $handler;
+	public $extension;
+	public $revision;
+	public $using_object_cache;
+
+
+	function __construct( $handler, $extension = null, $revision = null ) {
+
+		$this->handler = $handler;
+
+		if ( empty( $extension ) )
+			$extension = get_class( $handler );
+
+		$this->extension = $extension;
+		$this->revision = $revision;
+		$this->using_object_cache = wp_using_ext_object_cache();
+
+	}
+
+
+	abstract function init();
+
+
+	/**
+	 * Register queued assets for Minit processing.
+	 *
+	 * @param  array $todo List of handles queued for the current request
+	 *
+	 * @return array       List of handles queued (unchanged)
+	 */
+	function register( $todo ) {
+
+		if ( empty( $todo ) )
+			return $todo;
+
+		// Queue all of them for Minit
+		$this->queue = array_merge( $this->queue, $todo );
+
+		return array();
+
+	}
+
+
+	/**
+	 * The brains of Minit. Loops through all queued scripts and combines them into a single blob.
+	 *
+	 * @return string|boolean URL of the Minited file or `false` when queue empty or error.
+	 */
+	function minit() {
+
+		$done = array();
+
+		if ( empty( $this->queue ) )
+			return false;
+
+		// Allow others to exclude handles from Minit
+		$exclude = (array) apply_filters( 'minit-exclude-' . $this->extension, array() );
+
+		// Build a cache key
+		$ver = array(
+			'revision-' . $this->revision,
+			'is_ssl-' . is_ssl(), // Use different cache key for SSL and non-SSL
+			'minit_cache_ver-' . get_option( 'minit_cache_ver' ), // Use a global cache version key to purge cache
+		);
+
+		// Include individual scripts versions in the cache key
+		foreach ( $this->queue as $handle )
+			$ver[] = sprintf( '%s-%s', $handle, $this->handler->registered[ $handle ]->ver );
+
+		$cache_ver = md5( 'minit-' . implode( '-', $ver ) );
+
+		// Try to get queue from cache
+		$cache = $this->get_cache( 'minit-' . $cache_ver );
+
+		if ( ! empty( $cache ) && isset( $cache['url'] ) ) {
+			$this->mark_done( $cache['done'] );
+
+			return $cache['url'];
+		}
+
+		foreach ( $this->queue as $handle ) {
+
+			if ( in_array( $handle, $exclude ) )
+				continue;
+
+			// Ignore pseudo packages such as jquery which return src as empty string
+			if ( empty( $this->handler->registered[ $handle ]->src ) )
+				$done[ $handle ] = null;
+
+			// Get the relative URL of the asset
+			$src = $this->get_asset_relative_path( $handle );
+
+			// Skip if the file is not hosted locally
+			if ( empty( $src ) || ! file_exists( ABSPATH . $src ) )
+				continue;
+
+			$item = $this->minit_item( file_get_contents( ABSPATH . $src ), $handle, $src );
+
+			$item = apply_filters(
+				'minit-item-' . $this->extension,
+				$item,
+				$this->handler,
+				$handle
+			);
+
+			if ( false !== $item )
+				$done[ $handle ] = $item;
+
+		}
+
+		if ( empty( $done ) )
+			return false;
+
+		$this->mark_done( array_keys( $done ) );
+
+		$wp_upload_dir = wp_upload_dir();
+
+		// Try to create the folder for cache
+		if ( ! is_dir( $wp_upload_dir['basedir'] . '/minit' ) )
+			if ( ! mkdir( $wp_upload_dir['basedir'] . '/minit' ) )
+				return false;
+
+		$combined_file_path = sprintf( '%s/minit/%s.%s', $wp_upload_dir['basedir'], $cache_ver, $this->extension );
+		$combined_file_url = sprintf( '%s/minit/%s.%s', $wp_upload_dir['baseurl'], $cache_ver, $this->extension );
+
+		// Allow other plugins to do something with the resulting URL
+		$combined_file_url = apply_filters( 'minit-url-' . $this->extension, $combined_file_url, $done );
+
+		// Allow other plugins to minify and obfuscate
+		$done_imploded = apply_filters( 'minit-content-' . $this->extension, implode( "\n\n", $done ), $done );
+
+		// Store the combined file on the filesystem
+		if ( ! file_exists( $combined_file_path ) )
+			if ( ! file_put_contents( $combined_file_path, $done_imploded ) )
+				return false;
+
+		// Cache this set of scripts, by default for 24 hours
+		$cache_ttl = apply_filters( 'minit-cache-expiration', 24 * 60 * 60 );
+		$cache_ttl = apply_filters( 'minit-cache-expiration-' . $this->extension, $cache_ttl );
+
+		$result = array(
+			'done' => array_keys( $done ),
+			'url' => $combined_file_url,
+			'file' => $combined_file_path,
+		);
+
+		$this->set_cache( 'minit-' . $cache_ver, $result, $cache_ttl );
+
+		return $combined_file_url;
+
+	}
+
+
+	abstract function process( $todo );
+
+
+	/**
+	 * Process the contents of each file.
+	 *
+	 * @param  string $source Asset source
+	 * @param  string $handle Asset handle
+	 * @param  string $src    Relative URL of the asset
+	 *
+	 * @return string         Asset source
+	 */
+	function minit_item( $source, $handle, $src ) {
+
+		return $source;
+
+	}
+
+
+	/**
+	 * Mark these handles as processed by Minit. Note that `done` doesn't mean
+	 * that the resulting script has been printed to the page.
+	 *
+	 * @param array $handles List of asset handles
+	 *
+	 * @return void
+	 */
+	protected function mark_done( $handles ) {
+
+		// Mark these as done since we'll take care of them
+		$this->handler->done = array_merge( $this->handler->done, $handles );
+
+		// Remove processed items from the queue
+		$this->queue = array_diff( $this->queue, $handles );
+
+		// Mark them as processed by Minit
+		$this->done = array_merge( $this->done, $handles );
+
+	}
+
+
+	/**
+	 * Return asset URL relative to the `base_url`.
+	 *
+	 * @param string $handle Asset handle
+	 *
+	 * @return string|boolean Asset URL relative to the base URL or `false` if not found
+	 */
+	protected function get_asset_relative_path( $handle ) {
+
+		if ( ! isset( $this->handler->registered[ $handle ] ) )
+			return false;
+
+		$item_url = $this->handler->registered[ $handle ]->src;
+
+		if ( empty( $item_url ) )
+			return false;
+
+		// Remove protocol reference from the local base URL
+		$base_url = preg_replace( '/^(https?:)/i', '', $this->handler->base_url );
+
+		// Check if this is a local asset which we can include
+		$src_parts = explode( $base_url, $item_url );
+
+		if ( empty( $src_parts ) )
+			return false;
+
+		// Get the trailing part of the local URL
+		$maybe_relative = array_pop( $src_parts );
+
+		if ( file_exists( ABSPATH . $maybe_relative ) )
+			return $maybe_relative;
+
+		return false;
+
+	}
+
+
+	public function get_cache( $key ) {
+
+		if ( $this->using_object_cache ) {
+			return wp_cache_get( $key, 'minit' );
+		} else {
+			return get_transient( $key );
+		}
+
+	}
+
+
+	public function set_cache( $key, $value, $ttl = 3600 ) {
+
+		if ( $this->using_object_cache ) {
+			return wp_cache_set( $key, $value, 'minit', $ttl );
+		} else {
+			return set_transient( $key, $value, $ttl );
+		}
+
+	}
+
+
+}