wp-butler.php

<?php
/*
Plugin Name: WP Butler
Plugin URI:  http://wpbutler.com
Description: WP Butler brings you what you need in the Wordpress Admin. An autocomplete menu to let you jump to all the common tasks you may need to perform, just hit <code>shift+alt+b</code>!
Version:     2.1
Author:      Japh
Author URI:  http://japh.com.au
License:     GPL2


 Copyright 2013  Japh  (email : wordpress@japh.com.au)

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2, as 
 published by the Free Software Foundation.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

/**
 * WP Butler
 * 
 * WP Butler brings you what you need in the Wordpress Admin. An autocomplete
 * menu to let you jump to all the common tasks you may need to perform, just
 * hit `shift+alt+b`!
 * 
 * @author Japh <wordpress@japh.com.au>
 * @version 2.1
 * @package WP-Butler
 * @license http://opensource.org/licenses/gpl-2.0.php GPL2
 */

// Check to see if the class already exists!
if ( ! class_exists( 'Japh_Butler' ) ) {

	/**
	 * WP Butler class
	 * 
	 * @package WP-Butler
	 * @version 2.1
	 * @since 1.2
	 */

	class Japh_Butler {

		/**
		 * Version number for WP Butler
		 * 
		 * This is for internal reference, should it be needed.
		 * 
		 * @since 1.2
		 */
		public $version = '2.1';
		/**
		 * Array of available post types
		 * @since 1.4
		 */
		public $post_types = array();
		/**
		 * Array of available taxonomies
		 * @since 1.5
		 */
		public $taxonomies = array();

		/**
		 * Constructor method for WP Butler
		 * 
		 * @since 1.2
		 */
		function __construct() {

			if ( ! is_admin() )
				return NULL;

			load_plugin_textdomain( 'wp-butler', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );

			$this->post_types = get_post_types( array( 'show_in_nav_menus' => true ), 'objects', 'and' );
			$this->taxonomies = get_taxonomies( array( 'show_in_nav_menus' => true ), 'objects', 'and' );

			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue' ) );
			add_action( 'admin_footer', array( $this, 'footer' ) );
			add_action( 'wp_ajax_wp_butler_actions', array( $this, 'actions' ) );
			add_action( 'admin_bar_menu', array( $this, 'enhance_admin_bar' ), 9999 );

		}

		/**
		 * Footer HTML output
		 * 
		 * This is the HTML for the WP Butler dialog.
		 * 
		 * @since 1.2
		 */
		function footer() {
			echo '<div id="wp-butler-dialog" title="' . __( "What would you like to do?", "wp-butler" ) . '">';
			echo '	<p>';
			echo '		<form id="wp-butler-form"><input type="text" placeholder="' . __( "Just start typing", "wp-butler" ) . '..." id="wp-butler-field"><input type="hidden" id="wp-butler-nonce" name="wp-butler-nonce" value="' . wp_create_nonce( 'wp_butler_nonce' ) . '" /><input type="hidden" id="wp-butler-context" name="wp-butler-context" value="' . ( is_network_admin() ? 'network' : 'site' ) . '" /></form>';
			echo '	</p>';
			echo '</div>';
		}

		/**
		 * Enqueue scripts and styles
		 * 
		 * Properly enqueuing all scripts and styles needed by WP Butler.
		 * 
		 * @since 1.2
		 */
		function enqueue() {
			// Enqueue styles
			if ( 'classic' == get_user_option( 'admin_color') ) {
				wp_register_style(
					'butler-jquery-ui-css',
					plugin_dir_url( __FILE__ ) . 'jquery-ui-css/jquery-ui-classic.css',
					array(),
					FALSE,
					'screen'
				);
			}
			else {
				wp_register_style(
					'butler-jquery-ui-css',
					plugin_dir_url( __FILE__ ) . 'jquery-ui-css/jquery-ui-fresh.css',
					array(),
					FALSE,
					'screen'
				);
			}
			wp_register_style(
				'wpbutler',
				plugins_url( 'wpbutler.css', __FILE__ ),
				array( 'butler-jquery-ui-css' ),
				FALSE,
				'screen'
			);
			wp_enqueue_style( 'wpbutler' );
			
			// Enqueue scripts
			wp_register_script(
				'keystroke',
				plugins_url( 'keystroke/jquery.keystroke.min.js', __FILE__ ),#
				array( 'jquery' ),
				'0d77ac267da80cbe0e0ca8e6fe8b5b2bb8ee1bac',
				TRUE
			);
			wp_register_script(
				'wpbutler',
				plugins_url( 'wpbutler.js', __FILE__ ),
				array( 'jquery-ui-autocomplete', 'jquery-ui-dialog', 'keystroke' ),
				$this->version,
				TRUE
			);
			wp_enqueue_script( 'wpbutler' );
		}

		/**
		 * Generic action methods
		 * 
		 * @since 1.4
		 * 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function generate_generic_actions( $actions ) {
			array_push( $actions, array( "label" => __( "Dashboard" ), "url" => "index.php" ) );
			array_push( $actions, array( "label" => __( "Home" ), "url" => "index.php" ) );
			if ( current_user_can( 'update_core' ) ) {
				array_push( $actions, array( "label" => __( "WordPress Updates" ), "url" => "update-core.php" ) );
			}
			if ( current_user_can( 'switch_themes' ) ) {
				array_push( $actions, array( "label" => __( "Manage Themes" ), "url" => "themes.php" ) );
			}
			if ( current_user_can( 'install_themes' ) ) {
				array_push( $actions, array( "label" => __( "Install Themes" ), "url" => "theme-install.php" ) );
			}
			if ( current_user_can( 'activate_plugins' ) ) {
				array_push( $actions, array( "label" => __( "Plugins" ), "url" => "plugins.php" ) );
				array_push( $actions, array( "label" => __( "Update Plugins" ), "url" => "plugins.php" ) );
			}
			if ( current_user_can( 'edit_plugins' ) ) {
				array_push( $actions, array( "label" => __( "Edit Plugins" ), "url" => "plugin-editor.php" ) );
			}
			if ( current_user_can( 'install_plugins' ) ) {
				array_push( $actions, array( "label" => __( "Install Plugins" ), "url" => "plugin-install.php" ) );
			}
			if ( current_user_can( 'list_users' ) ) {
				array_push( $actions, array( "label" => __( "All Users" ), "url" => "users.php" ) );
			}
			if ( current_user_can( 'create_users' ) ) {
				array_push( $actions, array( "label" => __( "Add New User" ), "url" => "user-new.php" ) );
			}
			array_push( $actions, array( "label" => __( "Profile" ), "url" => "profile.php" ) );

			return $actions;
		}

		/**
		 * Single Site action methods
		 * 
		 * @since 1.4
		 * 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function generate_site_actions( $actions ) {
			if ( current_user_can( 'upload_files' ) ) {
				array_push( $actions, array( "label" => __( "Media Library" ), "url" => "upload.php" ) );
				array_push( $actions, array( "label" => __( "Upload New Media" ), "url" => "media-new.php" ) );
			}
			if ( current_user_can( 'moderate_comments' ) ) {
				array_push( $actions, array( "label" => __( "Comments" ), "url" => "edit-comments.php" ) );
			}
			if ( current_user_can( 'edit_theme_options' ) ) {
				array_push( $actions, array( "label" => __( "Widgets" ), "url" => "widgets.php" ) );
				array_push( $actions, array( "label" => __( "Menus" ), "url" => "nav-menus.php" ) );
				array_push( $actions, array( "label" => __( "Create Menu" ), "url" => "nav-menus.php" ) );
			}
			if ( current_user_can( 'manage_options' ) ) {
				array_push( $actions, array( "label" => __( "General Settings" ), "url" => "options-general.php" ) );
				array_push( $actions, array( "label" => __( "Writing Settings" ), "url" => "options-writing.php" ) );
				array_push( $actions, array( "label" => __( "Reading Settings" ), "url" => "options-reading.php" ) );
				array_push( $actions, array( "label" => __( "Discussion Settings" ), "url" => "options-discussion.php" ) );
				array_push( $actions, array( "label" => __( "Media Settings" ), "url" => "options-media.php" ) );
				array_push( $actions, array( "label" => __( "Permalink Settings" ), "url" => "options-permalink.php" ) );
			}
			array_push( $actions, array( "label" => __( "Tools" ), "url" => "tools.php" ) );
			if ( current_user_can( 'import' ) ) {
				array_push( $actions, array( "label" => __( "Import" ), "url" => "import.php" ) );
			}

			// check for multisite install
			if ( is_multisite() ) {
				array_push( $actions, array( "label" => __( "Network Admin Dashboard" ), "url" => "network/index.php" ) );
			}
			
			return $actions;
		}

		/**
		 * Multisite action methods
		 * 
		 * @since 1.4
		 * 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function generate_multisite_actions( $actions ) {
			if ( current_user_can( 'manage_sites' ) ) {
				array_push( $actions, array( "label" => __( "All Sites" ), "url" => "sites.php" ) );
				array_push( $actions, array( "label" => __( "Add New Site" ), "url" => "site-new.php" ) );
			}
			if ( current_user_can( 'manage_network_options' ) ) {
				array_push( $actions, array( "label" => __( "Network Settings" ), "url" => "settings.php" ) );
			}
			if ( current_user_can( 'manage_network' ) ) {
				array_push( $actions, array( "label" => __( "Network Setup" ), "url" => "setup.php" ) );
				array_push( $actions, array( "label" => __( "Update Network" ), "url" => "upgrade.php" ) );
			}
			
			return $actions;
		}

		/**
		 * Post Type action methods
		 * 
		 * @since 1.5
		 * 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function generate_post_type_actions( $actions ) {
			foreach ( $this->post_types as $post_type => $post_type_object ) {
				$name = ucfirst( $post_type_object->labels->name );
				$singular_name = ucfirst( $post_type_object->labels->singular_name );
				$new_url = 'post-new.php?post_type=' . $post_type;
				$edit_url = 'edit.php?post_type=' . $post_type;

				if ( current_user_can( 'edit_posts' ) ) {
					array_push( $actions, array( "label" => $singular_name . " -> " . __( "Add" ), "url" => $new_url ) );
					array_push( $actions, array( "label" => $name . " -> " . __( "Edit" ), "url" => $edit_url ) );
					array_push( $actions, array( "label" => $name . " -> " . __( "View" ), "url" => $edit_url ) );
				}
			}

			return $actions;
		}

		/**
		 * Taxonomy action methods
		 * 
		 * @since 1.5
		 * 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function generate_taxonomy_actions( $actions ) {
			foreach ( $this->taxonomies as $taxonomy => $taxonomy_object ) {
				$name = ucfirst( $taxonomy_object->labels->name );
				$singular_name = ucfirst( $taxonomy_object->labels->singular_name );
				$edit_url = 'edit-tags.php?taxonomy=' . $taxonomy . '&post_type=' . $taxonomy_object->object_type[0];
				$new_url = $edit_url;

				if ( current_user_can( 'manage_categories' ) ) {
					array_push( $actions, array( "label" => $singular_name . " -> " . __( "Add" ), "url" => $new_url ) );
					array_push( $actions, array( "label" => $name . " -> " . __( "Edit" ), "url" => $edit_url ) );
					array_push( $actions, array( "label" => $name . " -> " . __( "View" ), "url" => $edit_url ) );
				}
			}

			return $actions;
		}

		/**
		 * Keyword methods
		 * 
		 * @since 1.7
		 * 
		 * @param String $term Term for search keyword
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function search_keyword( $term, $actions ) {
			$term_words = explode( ' ', $_REQUEST['term'] );
			$keyword = array_shift( $term_words );

			$keyword_synonyms = array( 'search', 'find', 'edit', 'view' );

			if ( ! in_array( $keyword, $keyword_synonyms ) ) {
				return array( $term, $actions );
			}

			if ( array_key_exists( $term_words[0], $this->post_types ) ) {
				$search_post_type = array_shift( $term_words );
			}
			else {
				$search_post_type = 'any';
			}

			$term = implode( ' ', $term_words );
			$params = array(
				's' => $term,
				'posts_per_page' => 10,
				'post_type' => $search_post_type,
			);
			$search = new WP_Query( $params );

			$actions = array();

			while ( $search->have_posts() ) :
				$search->next_post();
				if ( $keyword == 'view' ) {
					array_push( $actions, array( "label" => get_the_title( $search->post->ID ), "url" => get_permalink( $search->post->ID ) ) );
				}
				else {
					array_push( $actions, array( "label" => get_the_title( $search->post->ID ), "url" => get_edit_post_link( $search->post->ID, 'raw' ) ) );
				}
			endwhile;

			return array( $term, $actions );
		}

		/**
		 * Keyword for activating plugins
		 * 
		 * @since 1.8
		 * 
		 * @param String $term Term for plugin activation keyword
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function activate_plugin_keyword( $term, $actions ) {
			$term_words = explode( ' ', $_REQUEST['term'] );
			$keyword = array_shift( $term_words );

			$keyword_synonyms = array( 'activate', 'deactivate' );

			if ( ! in_array( $keyword, $keyword_synonyms ) ) {
				return array( $term, $actions );
			}

			$term = implode( ' ', $term_words );

			$plugins = get_plugins();
			$plugin_matches = array();

			$actions = array();

			foreach ( $plugins as $plugin_file => $plugin ) {
				if ( $keyword == 'deactivate' ) {
					if ( preg_match( '/' . $term . '/i', $plugin['Title'] ) && is_plugin_active( $plugin_file ) ) {
						array_push ( $actions, array(
							'label' => html_entity_decode( "{$plugin['Title']} v{$plugin['Version']}", ENT_QUOTES, get_option( 'blog_charset' ) ),
							'url' => add_query_arg( '_wpnonce', wp_create_nonce( 'deactivate-plugin_' . $plugin_file ), "plugins.php?action=deactivate&plugin={$plugin_file}" )
						) );
					}
				}
				else {
					if ( preg_match( '/' . $term . '/i', $plugin['Title'] ) && ! is_plugin_active( $plugin_file ) ) {
						array_push ( $actions, array(
							'label' => html_entity_decode( "{$plugin['Title']} v{$plugin['Version']}", ENT_QUOTES, get_option( 'blog_charset' ) ),
							'url' => add_query_arg( '_wpnonce', wp_create_nonce( 'activate-plugin_' . $plugin_file ), "plugins.php?action=activate&plugin={$plugin_file}" )
						) );
					}
				}
			}

			return array( $term, $actions );
		}

		/**
		 * Keyword for searching users
		 * 
		 * @since 1.8
		 *
		 * @param String $term Term for user search keyword 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function user_search_keyword( $term, $actions ) {
			$term_words = explode( ' ', $_REQUEST['term'] );
			$keyword = array_shift( $term_words );

			$keyword_synonyms = array( 'user' );

			if ( ! in_array( $keyword, $keyword_synonyms ) ) {
				return array( $term, $actions );
			}

			$term = implode( ' ', $term_words );
			$params = array(
				'search' => $term,
				'number' => 10,
			);

			$users = array();

			if ( is_multisite() ) {

				$blogs = get_blogs_of_user( get_current_user_id() );

				foreach ( $blogs as $blog ) {
					$params['blog_id'] = $blog->userblog_id;
					$blog_users = get_users( $params );

					foreach ( $blog_users as $user ) {
						if ( ! in_array( $user, $users ) ) {
							$users[] = $user;
						}
					}

				}

			}
			else {
				$users = get_users( $params );
			}

			$actions = array();

			foreach ( $users as $user ) {
				array_push( $actions, array( "label" => $user->display_name, "url" => 'user-edit.php?user_id=' . $user->ID ) );
			}

			return array( $term, $actions );
		}

		/**
		 * Keyword for switching sites
		 * 
		 * @since 2.0
		 *
		 * @param String $term Term for site switching keyword 
		 * @param Array $actions Array of current actions for WP Butler
		 */
		function site_switch_keyword( $term, $actions ) {
			global $current_site;
			$term_words = explode( ' ', $_REQUEST['term'] );
			$keyword = array_shift( $term_words );

			$keyword_synonyms = array( 'switch' );

			if ( ! in_array( $keyword, $keyword_synonyms ) ) {
				return array( $term, $actions );
			}

			$term = implode( ' ', $term_words );

			$blogs = get_blogs_of_user( get_current_user_id() );

			$actions = array();

			foreach ( $blogs as $blog ) {
				if ( preg_match( '/' . $term . '/i', $blog->blogname ) && ! empty( $current_site ) ) {
					array_push( $actions, array( "label" => $blog->blogname, "url" => get_admin_url( $blog->userblog_id ) ) );
				}
			}

			return array( $term, $actions );
		}

		/**
		 * Actions
		 * 
		 * Build actions and AJAX callback
		 * 
		 * @since 1.2
		 */
		function actions() {
			require_once( ABSPATH . '/wp-includes/l10n.php' );

			$return = array();
			$term = $_REQUEST['term'];
			$nonce = $_REQUEST['_nonce'];
			$context = $_REQUEST['_context'];

			$term_words = explode( ' ', $term );
			$keyword = $term_words[0];

			if ( is_admin() && wp_verify_nonce( $nonce, 'wp_butler_nonce' ) ) {

				$butler_actions = array();

				switch ( $keyword ) {
					default:
						$butler_actions = $this->generate_generic_actions( $butler_actions );
						if ( is_network_admin() || $context == 'network' ) {
							$butler_actions = $this->generate_multisite_actions( $butler_actions );
						}
						else {
							$butler_actions = $this->generate_site_actions( $butler_actions );
						}
						$butler_actions = $this->generate_post_type_actions( $butler_actions );
						$butler_actions = $this->generate_taxonomy_actions( $butler_actions );

						$butler_actions = apply_filters( 'wp_butler_ajax_actions', $butler_actions );

						list( $term, $butler_actions ) = $this->search_keyword( $term, $butler_actions );
						list( $term, $butler_actions ) = $this->user_search_keyword( $term, $butler_actions );
						list( $term, $butler_actions ) = $this->activate_plugin_keyword( $term, $butler_actions );
						list( $term, $butler_actions ) = $this->site_switch_keyword( $term, $butler_actions );

						list( $term, $butler_actions ) = apply_filters( 'wp_butler_ajax_keyword_actions', array( $term, $butler_actions ) );

						if ( ! empty( $butler_actions ) ) {
							$random_action_url = $butler_actions[mt_rand( 0, count( $butler_actions ) - 1 )]['url'];
							array_push( $butler_actions, array( "label" => __( "Surprise me!", "wp-butler" ), "url" => $random_action_url ) );
						}
				}

				foreach ( $butler_actions as $value ) {
					if ( preg_match( '/' . $term . '/i', $value['label'] ) ) {
						$return[] = array(
							'label' => html_entity_decode( $value['label'], ENT_QUOTES, get_option( 'blog_charset' ) ),
							'url' => $value['url']
						);
					}
				}
			}

			wp_die( json_encode( $return ) );
		}

		/**
		 * Enhance the admin bar
		 *
		 * @param  Array $wp_admin_bar Instance of WP_Admin_Bar
		 * @return void
		 * @author bueltge
		 * @since  1.9
		 */
		public function enhance_admin_bar( $wp_admin_bar ) {
			global $wp_admin_bar;

			if ( ! is_super_admin() || ! is_admin_bar_showing() )
				return NULL;

			$classes = apply_filters( 'wp_butler_admin_bar_classes', array() );
			$classes = implode( ' ', $classes );

			$args = array(
				'id'        => 'wp-butler',
				'parent'    => 'top-secondary',
				'secondary' => FALSE,
				'title'     => apply_filters( 'wp_butler_admin_bar_title', __( 'WP Butler', 'wp-butler' ) ),
				'meta'      => array( 'class' => $classes )
			);

			$wp_admin_bar->add_node( $args );
		}

	}

}

/**
 * Execute WP Butler
 * 
 * This function ensures we execute WP Butler at the appropriate time.
 * 
 * @package WP-Butler
 * @since 1.2
 */
function execute_wp_butler() {
	$japh_butler = new Japh_Butler();
}
add_action( 'admin_init', 'execute_wp_butler' );