plugin-admin-notes.php

<?php
/**
 * Plugin Name: Plugin Admin Notes
 * Plugin URI:  http://webdevstudios.com
 * Description: Adds a column to plugins to allow admins to leave notes as well as turn on auto-update and lock plugins
 * from updating.
 * Version:     0.1.0
 * Author:      WebDevStudios
 * Author URI:  http://webdevstudios.com
 * Donate link:
 * http://webdevstudios.com
 * License:     GPLv2
 * Text Domain: plugin-admin-notes
 * Domain Path: /languages
 *
 * @link    http://webdevstudios.com
 *
 * @package Plugin Admin Notes
 * @version 0.1.0
 */

/**
 * Copyright (c) 2017 WebDevStudios (email : contact@webdevstudios.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 or, at
 * your discretion, any later version, 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
 */

/**
 * Built using generator-plugin-wp
 */


/**
 * Autoloads files with classes when needed
 *
 * @since  0.1.0
 *
 * @param  string $class_name Name of the class being requested.
 *
 * @return void
 */
function wds_plugin_police_autoload_classes( $class_name ) {
	if ( 0 !== strpos( $class_name, 'WDSPP_' ) ) {
		return;
	}

	$filename = strtolower( str_replace(
		'_', '-',
		substr( $class_name, strlen( 'WDSPP_' ) )
	) );

	WDS_Plugin_Police::include_file( 'includes/class-' . $filename );
}

spl_autoload_register( 'wds_plugin_police_autoload_classes' );

/**
 * Main initiation class
 *
 * @since  0.1.0
 */
final class WDS_Plugin_Police {

	/**
	 * Current version
	 *
	 * @var  string
	 * @since  0.1.0
	 */
	const VERSION = '0.1.0';

	/**
	 * URL of plugin directory
	 *
	 * @var string
	 * @since  0.1.0
	 */
	protected $url = '';

	/**
	 * Path of plugin directory
	 *
	 * @var string
	 * @since  0.1.0
	 */
	protected $path = '';

	/**
	 * Plugin basename
	 *
	 * @var string
	 * @since  0.1.0
	 */
	protected $basename = '';

	/**
	 * Detailed activation error messages
	 *
	 * @var array
	 * @since  0.1.0
	 */
	protected $activation_errors = array();

	/**
	 * Singleton instance of plugin
	 *
	 * @var WDS_Plugin_Police
	 * @since  0.1.0
	 */
	protected static $single_instance = null;

	/**
	 * Instance of WDSPP_Add_plugin_row
	 *
	 * @since0.1.0
	 * @var WDSPP_Add_plugin_row
	 */
	protected $add_plugin_row;

	/**
	 * Instance of WDSPP_View
	 *
	 * @since0.1.0
	 * @var WDSPP_View
	 */
	protected $view;

	/**
	 * Instance of WDSPP_Plugin_police
	 *
	 * @since0.1.0
	 * @var WDSPP_Plugin_police
	 */
	protected $plugin_police;

	/**
	 * Instance of WDSPP_Dynamic_form
	 *
	 * @since0.1.0
	 * @var WDSPP_Dynamic_form
	 */
	protected $dynamic_form;

	/**
	 * Creates or returns an instance of this class.
	 *
	 * @since  0.1.0
	 * @return WDS_Plugin_Police A single instance of this class.
	 */
	public static function get_instance() {
		if ( null === self::$single_instance ) {
			self::$single_instance = new self();
		}

		return self::$single_instance;
	}

	/**
	 * Sets up our plugin
	 *
	 * @since  0.1.0
	 */
	protected function __construct() {
		$this->basename = plugin_basename( __FILE__ );
		$this->url      = plugin_dir_url( __FILE__ );
		$this->path     = plugin_dir_path( __FILE__ );
	}

	/**
	 * Attach other plugin classes to the base plugin class.
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function plugin_classes() {
		// Attach other plugin classes to the base plugin class.
		$this->view          = new WDSPP_View( $this );
		$this->plugin_police = new WDSPP_Plugin_police( $this );
		$this->dynamic_form  = new WDSPP_Dynamic_form( $this );
	} // END OF PLUGIN CLASSES FUNCTION

	/**
	 * Add hooks and filters
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function hooks() {
		// Priority needs to be:
		// < 10 for CPT_Core,
		// < 5 for Taxonomy_Core,
		// 0 Widgets because widgets_init runs at init priority 1.
		add_action( 'plugins_loaded', array( $this, 'init' ), 1 );
		add_action( 'admin_enqueue_scripts', array( $this, 'eq_scripts' ), 10, 1 );
	}

	/**
	 * EQ the script.
	 *
	 * @since 0.1.0
	 */
	public function eq_scripts( $page ) {
		// Make sure we aren't loading in all admin screens.
		if ( 'plugins.php' !== $page ) {
			return;
		}

		wp_enqueue_script( 'pluginnotes', $this->url . 'assets/js/plugin-notes.js', array( 'jquery' ), '0.1.0' );
		// Localize our strings.
		$l10n = array( 'loading_message' => __( 'Loading&hellip;', 'plugin-admin-notes' ) );
		wp_localize_script( 'pluginnotes', 'AdminNotes', $l10n );
		wp_enqueue_script( 'pluginnotes_emojipicker', $this->url . 'assets/js/jquery.emojipicker.js', array( 'jquery' ), '0.1.0' );
		wp_enqueue_script( 'pluginnotes_emojis', $this->url . 'assets/js/jquery.emojis.js', array( 'jquery' ), '0.1.0' );

		wp_enqueue_style( 'pluginnotes_emojipicker_styles', $this->url . 'assets/css/jquery.emojipicker.css' );
		wp_enqueue_style( 'pluginnotes_emojis_styles', $this->url . 'assets/css/jquery.emojipicker.a.css' );
		wp_enqueue_style( 'pluginnotes_fontawesome', $this->url . 'assets/css/font-awesome.min.css' );
		wp_enqueue_style( 'pluginnotes_css', $this->url . 'assets/css/plugin-admin-notes.css' );
	}

	/**
	 * Activate the plugin
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function _activate() {
		// Make sure any rewrite functionality has been loaded.
		flush_rewrite_rules();
	}

	/**
	 * Deactivate the plugin
	 * Uninstall routines should be in uninstall.php
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function _deactivate() {
	}

	/**
	 * Init hooks
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function init() {
		// bail early if requirements aren't met
		if ( ! $this->check_requirements() ) {
			return;
		}

		// load translated strings for plugin
		load_plugin_textdomain( 'wds-plugin-police', false, dirname( $this->basename ) . '/languages/' );

		// initialize plugin classes
		$this->plugin_classes();

		if ( ! defined( 'DOING_AJAX' ) && file_exists( $this->path . 'pluginnotes.log' ) ) {
			file_put_contents( $this->path . 'pluginnotes.log', '' );
		}

		if ( 'WP_UNINSTALL_PLUGIN' && isset( $_POST['action'] ) && 'delete-plugin' == $_POST['action'] ) {
			error_log( print_r( $_POST, 1 ) );
			$this->view->remove_plugin( $_POST['slug'] );
		}

	}

	/**
	 * Check if the plugin meets requirements and
	 * disable it if they are not present.
	 *
	 * @since  0.1.0
	 * @return boolean result of meets_requirements
	 */
	public function check_requirements() {
		// bail early if pluginmeets requirements
		if ( $this->meets_requirements() ) {
			return true;
		}

		// Add a dashboard notice.
		add_action( 'all_admin_notices', array( $this, 'requirements_not_met_notice' ) );

		// Deactivate our plugin.
		add_action( 'admin_init', array( $this, 'deactivate_me' ) );

		return false;
	}

	/**
	 * Deactivates this plugin, hook this function on admin_init.
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function deactivate_me() {
		// We do a check for deactivate_plugins before calling it, to protect
		// any developers from accidentally calling it too early and breaking things.
		if ( function_exists( 'deactivate_plugins' ) ) {
			deactivate_plugins( $this->basename );
		}
	}

	/**
	 * Check that all plugin requirements are met
	 *
	 * @since  0.1.0
	 * @return boolean True if requirements are met.
	 */
	public function meets_requirements() {
		// Do checks for required classes / functions
		// function_exists('') & class_exists('').
		// We have met all requirements.
		// Add detailed messages to $this->activation_errors array
		return true;
	}

	/**
	 * Adds a notice to the dashboard if the plugin requirements are not met
	 *
	 * @since  0.1.0
	 * @return void
	 */
	public function requirements_not_met_notice() {
		// compile default message
		$default_message = sprintf(
			__( 'WDS Plugin Police is missing requirements and has been <a href="%s">deactivated</a>. Please make sure all requirements are available.', 'wds-plugin-police' ),
			admin_url( 'plugins.php' )
		);

		// default details to null
		$details = null;

		// add details if any exist
		if ( ! empty( $this->activation_errors ) && is_array( $this->activation_errors ) ) {
			$details = '<small>' . implode( '</small><br /><small>', $this->activation_errors ) . '</small>';
		}

		// output errors
		?>
		<div id="message" class="error">
			<p><?php echo $default_message; ?></p>
			<?php echo $details; ?>
		</div>
		<?php
	}

	/**
	 * Magic getter for our object.
	 *
	 * @since  0.1.0
	 *
	 * @param string $field Field to get.
	 *
	 * @throws Exception Throws an exception if the field is invalid.
	 * @return mixed
	 */
	public function __get( $field ) {
		switch ( $field ) {
			case 'version':
				return self::VERSION;
			case 'basename':
			case 'url':
			case 'path':
			case 'view':
			case 'plugin_police':
			case 'dynamic_form':
				return $this->$field;
			default:
				throw new Exception( 'Invalid ' . __CLASS__ . ' property: ' . $field );
		}
	}

	/**
	 * Include a file from the includes directory
	 *
	 * @since  0.1.0
	 *
	 * @param  string $filename Name of the file to be included.
	 *
	 * @return bool   Result of include call.
	 */
	public static function include_file( $filename ) {
		$file = self::dir( $filename . '.php' );
		if ( file_exists( $file ) ) {
			return include_once( $file );
		}

		return false;
	}

	/**
	 * This plugin's directory
	 *
	 * @since  0.1.0
	 *
	 * @param  string $path (optional) appended path.
	 *
	 * @return string       Directory and path
	 */
	public static function dir( $path = '' ) {
		static $dir;
		$dir = $dir ? $dir : trailingslashit( dirname( __FILE__ ) );

		return $dir . $path;
	}

	/**
	 * This plugin's url
	 *
	 * @since  0.1.0
	 *
	 * @param  string $path (optional) appended path.
	 *
	 * @return string       URL and path
	 */
	public static function url( $path = '' ) {
		static $url;
		$url = $url ? $url : trailingslashit( plugin_dir_url( __FILE__ ) );

		return $url . $path;
	}
}

/**
 * Grab the WDS_Plugin_Police object and return it.
 * Wrapper for WDS_Plugin_Police::get_instance()
 *
 * @since  0.1.0
 * @return WDS_Plugin_Police  Singleton instance of plugin class.
 */
function wds_plugin_police() {
	return WDS_Plugin_Police::get_instance();
}

// Kick it off.
add_action( 'plugins_loaded', array( wds_plugin_police(), 'hooks' ), 0 );

register_activation_hook( __FILE__, array( wds_plugin_police(), '_activate' ) );
register_deactivation_hook( __FILE__, array( wds_plugin_police(), '_deactivate' ) );

/**
 * Deletes the plugin data.
 *
 * @since 0.1.0
 */
function uninstall_wds_plugin_admin_notes() {

	global $wpdb;

	$ids = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_type='wdspp-plugin-police'" );

	foreach ( $ids as $post ) {
		wp_delete_post( $post, true );
	}

	delete_option( 'wds_plugin_lock_updates' );
	delete_option( 'wds_plugin_updates_auto_updates' );
}

register_uninstall_hook( __FILE__, 'uninstall_wds_plugin_admin_notes' );