db-checkpoint.php

<?php
/**
 * Plugin Name: DB Snapshot
 * Plugin URI:  https://www.binarygary.com/
 * Description: Extends WP-CLI to include a db snapshot for development purposes.
 * Version:     0.2.2
 * Author:      Gary Kovar
 * Author URI:  https://www.binarygary.com/
 * Donate link: https://bethematch.org/
 * License:     GPLv2
 * Text Domain: db-snapshot
 * Domain Path: /languages
 *
 * @link    https://www.binarygary.com/
 *
 * @package DB Snapshot
 */

/**
 * Copyright (c) 2016 Gary Kovar (email : plugins@binarygary.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
 */

if ( defined( 'WP_CLI' ) && WP_CLI ) {

	if ( ! class_exists( 'DB_CheckPoint' ) ) {
		class DB_CheckPoint extends WP_CLI_Command {

			public function check_requirements() {
				$upload_dir = wp_upload_dir();
				if ( ! file_exists( $upload_dir['basedir'] . '/checkpoint-storage' ) ) {
					mkdir( $upload_dir['basedir'] . '/checkpoint-storage' );
				}

				return true;
			}

			/**
			 * Returns the array of configuration setup info for dbsnap command.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @return array
			 *
			 */
			public function get_checkpoint_save_args() {
				return array(
					'shortdesc' => 'Creates a simple checkpoint image of the database.',
					'synopsis'  => array(
						array(
							'type'     => 'positional',
							'name'     => 'name',
							'optional' => true,
							'multiple' => false,
						),
					),
					'when'      => 'after_wp_load',
				);
			}

			/**
			 * Returns the array of configuration setup info for dbsnapback command.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @return array
			 *
			 */
			public function get_checkpoint_restore_args() {
				return array(
					'shortdesc' => 'Restores the checkpoint image of the database.',
					'synopsis'  => array(
						array(
							'type'     => 'positional',
							'name'     => 'name',
							'optional' => true,
							'multiple' => false,
						),
						array(
							'type'     => 'flag',
							'name'     => 'dumplog',
							'optional' => true,
							'default'  => false,
						),
						array(
							'type'     => 'flag',
							'name'     => 'dev',
							'optional' => true,
							'default'  => false,
						),
					),
					'when'      => 'after_wp_load',
				);
			}

			public function get_install_plugin_args() {
				return array(
					'shortdesc' => 'Installs a plugin for 1-click restore from the admin bar..',
					'synopsis'  => array(),
					'when'      => 'after_wp_load',
				);
			}

			/**
			 * Saves a checkpoint of the db.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 */
			public function checkpoint_save( $args ) {

				if ( ! $this->check_requirements() ) {
					exit;
				}

				$snapshot_name = $this->get_snapshot_name( $args );

				$this->maybe_nuke_checkpoints( $snapshot_name );

				$upload_dir = wp_upload_dir();

				$location = $upload_dir['basedir'] . '/checkpoint-storage/' . $snapshot_name . '.' . $this->human_timestamp() . '.sql';
				$args[0]  = $location;

				$db = new DB_Command;
				$db->export( $args, null );

				WP_CLI::success( "Checkpoint Saved!" );
			}

			/**
			 * Restores the most recent checkpoint of the db.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 */
			public function checkpoint_restore( $args, $assoc_args ) {

				if ( ! $this->check_requirements() ) {
					exit;
				}

				// Check if the dev flag is set to true OR site is *.dev, otherwise prompt.
				if  ( ! $this->is_dev() || ( key_exists( 'dev', $assoc_args ) && ! $assoc_args['dev'] ) ) {
					WP_CLI::confirm( "This is a destructive operation, are you sure?" );
				}

				$snapshot_name = $this->get_snapshot_name( $args );

				$upload_dir = wp_upload_dir();

				if ( $restore_file = $this->get_most_recent_file( $snapshot_name ) ) {
					$location = $upload_dir['basedir'] . '/checkpoint-storage/' . $this->get_most_recent_file( $snapshot_name );
				} else {
					WP_CLI::error( 'No checkpoint found associated with ' . $snapshot_name );
				}

				$args[0] = $location;

				$db = new DB_Command;
				$db->reset( $args, null );
				$db->import( $args, null );

				// If the dumplog flag is set, clear the log file.
				if ( key_exists( 'dumplog', $assoc_args ) && $assoc_args['dumplog'] ) {
					$this->dump_log();
				}

				WP_CLI::success( "Checkpoint Restored!" );
			}

			/**
			 * Delete the debug.log.
			 *
			 * @author Gary Kovar
			 *
			 * @since 0.2.2
			 *
			 * @return null
			 */
			public function dump_log() {
				if (file_exists(WP_CONTENT_DIR . '/debug.log' ) ){
					unlink( WP_CONTENT_DIR . '/debug.log' );
				}

				WP_CLI::success( "debug.log removed" );
			}

			/**
			 * Check if this is a .dev site.
			 *
			 * @author Gary Kovar
			 *
			 * @since 0.2.2
			 */
			public function is_dev() {
				if ( '.dev' === substr(get_site_url(),-4)){
					return true;
				}
				return false;
			}

			/**
			 * Get the name of the most recent backup file.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @param $backup_name
			 *
			 * @return bool
			 */
			public function get_most_recent_file( $backup_name ) {

				$upload_dir = wp_upload_dir();
				$backupsdir = scandir( $upload_dir['basedir'] . '/checkpoint-storage/', SCANDIR_SORT_DESCENDING );
				foreach ( $backupsdir as $backup ) {
					if ( strpos( $backup, $backup_name ) === 0 ) {
						return $backup;
					}
				}

				return false;
			}

			/**
			 * Figure out what name to use with this file.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @param $args
			 *
			 * @return string
			 */
			public function get_snapshot_name( $args ) {

				if ( key_exists( 0, $args ) ) {
					return $args[0];
				}

				return sanitize_title( get_option( 'blogname', 'shruggy' ) );
			}

			/**
			 * Check to see if the checkpoint name matches the site name, if so remove any checkpoints of the same name.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @param $checkpoint_name
			 */
			public function maybe_nuke_checkpoints( $checkpoint_name ) {
				$this->nuke_checkpoints( $checkpoint_name );
			}

			/**
			 * Deletes all previous checkpoints under the same name.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @param $checkpoint_name
			 */
			public function nuke_checkpoints( $checkpoint_name ) {
				$upload_dir = wp_upload_dir();
				$backupsdir = scandir( $upload_dir['basedir'] . '/checkpoint-storage/', SCANDIR_SORT_DESCENDING );

				// Make sure we have a list of file before trying to process them.
				if ( is_array( $backupsdir ) ) {
					foreach ( $backupsdir as $backup ) {
						if ( strpos( $backup, $checkpoint_name ) === 0 ) {
							unlink( $upload_dir['basedir'] . '/checkpoint-storage/' . $backup );
						}
					}
				}
			}

			/**
			 * Return a pretty human readable time.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.1.0
			 *
			 * @return false|string
			 */
			public function human_timestamp() {
				return date( "Ymd-Hi", time() );
			}

			public function install_plugin() {
				$args       = array( 'plugin', 'install', 'db-snapshot' );
				$assoc_args = array( 'activate' => 'activate' );
				WP_CLI::run_command( $args, $assoc_args );
			}

		}

		/**
		 * Kick off!
		 *
		 * @return DB_CheckPoint
		 */
		function db_checkpoint() {
			return new DB_CheckPoint;
		}

		$checkpoint = db_checkpoint();

		/**
		 * Add dbsnap as a WP CLI command.
		 */
		WP_CLI::add_command( 'dbsnap', array(
			$checkpoint,
			'checkpoint_save',
		), $checkpoint->get_checkpoint_save_args() );

		/**
		 * Add dbsnapback as a WP CLI command.
		 */
		WP_CLI::add_command( 'dbsnapback', array(
			$checkpoint,
			'checkpoint_restore',
		), $checkpoint->get_checkpoint_restore_args() );

		/**
		 * Add dbsnap plugin as a WP CLI command.
		 */
		WP_CLI::add_command( 'dbsnapplug', array(
			$checkpoint,
			'install_plugin',
		), $checkpoint->get_install_plugin_args() );
	}
}


if ( ! defined( 'WP_CLI' ) ) {
	if ( ! class_exists( 'DB_CheckPoint_Plugin' ) ) {
		class DB_CheckPoint_Plugin {

			/**
			 * The return from wp_upload_dir();
			 *
			 * @var string
			 */
			private $upload_dir;

			/**
			 * Initiate the class and set some of the regular variables.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function init() {
				$this->upload_dir = wp_upload_dir();
				$this->hooks();
			}

			/**
			 * Hook to add functions to WP
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function hooks() {
				$this->does_upload_folder_exist();

				if ( $this->should_show_dbsnapback_in_admin_menu() ) {
					add_action( 'admin_bar_menu', array( $this, 'toolbar_dbsnapback' ), 999 );
					add_action( 'admin_bar_menu', array( $this, 'add_dbsnapback_child_nodes' ), 999 );
				} else {
					add_action( 'admin_bar_menu', array( $this, 'toolbar_dbsnap' ), 999 );
				}

				if ( key_exists( 'snpackback_restore', $_GET ) ) {
					if ( current_user_can( 'manage_options' ) ) {
						add_action( 'init', array( $this, 'restore' ) );
					}
				}

				if ( key_exists( 'create_snap', $_GET ) ) {
					if ( current_user_can( 'manage_options' ) ) {
						add_action( 'init', array( $this, 'backup' ) );
					}
				}
			}

			/**
			 * Check if the upload folder exists and if not create it.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function does_upload_folder_exist() {
				if ( ! file_exists( $this->upload_dir['basedir'] . '/checkpoint-storage' ) ) {
					mkdir( $this->upload_dir['basedir'] . '/checkpoint-storage' );
				}
			}

			/**
			 * Check and see if we should show the admin bar by counting how many files are in the backup dir.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 *
			 * @return bool
			 */
			public function should_show_dbsnapback_in_admin_menu() {

				// If we count more than 2 files (. , ..) then we have some backups.
				if ( count( scandir( $this->upload_dir['basedir'] . '/checkpoint-storage' ) ) > 2 ) {
					return true;
				}

				return false;
			}

			/**
			 * Get the list of snaps and add a node for each.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 *
			 */
			public function add_dbsnapback_child_nodes( $wp_admin_bar ) {
				$files = $this->get_snaps();

				foreach ( $files as $file ) {

					$args = array(
						'id'     => $file[0],
						'title'  => $file[0],
						'href'   => '?snpackback_restore=' . $file[0] . '.' . $file[1] . '.sql',
						'parent' => 'dbsnapback',
						'meta'   => array(
							'class' => 'dbsnapback',
						),
					);
					$wp_admin_bar->add_node( $args );
				}
			}

			/**
			 * Get the existing snaps.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function get_snaps() {
				$backupsdir = scandir( $this->upload_dir['basedir'] . '/checkpoint-storage/', SCANDIR_SORT_DESCENDING );
				foreach ( $backupsdir as $backup ) {
					$file_exploded = explode( '.', $backup );
					if ( $file_exploded[0] != '' ) {
						$list[] = $file_exploded;
					}
				}

				return $list;
			}

			/**
			 * Add restore link to toolbar.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function toolbar_dbsnapback( $wp_admin_bar ) {
				$args = array(
					'id'    => 'dbsnapback',
					'title' => 'DBSnapBack',
					'href'  => '#',
					'meta'  => array(
						'class' => 'dbsnapback',
					),
				);
				$wp_admin_bar->add_node( $args );
			}

			/**
			 * Add snapshot link to toolbar.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function toolbar_dbsnap( $wp_admin_bar ) {
				$args = array(
					'id'    => 'dbsnap',
					'title' => 'DBSnap',
					'href'  => '?create_snap',
					'meta'  => array(
						'class' => 'dbsnap',
					),
				);
				$wp_admin_bar->add_node( $args );
			}

			public function backup() {
				$command = 'wp dbsnap';
				exec( $command );
			}

			/**
			 * Restores the selected snapshot.
			 *
			 * @author Gary Kovar
			 *
			 * @since  0.2.0
			 */
			public function restore() {
				$filename = $_GET['snpackback_restore'];
				$command  = 'wp db import ' . $this->upload_dir['basedir'] . '/checkpoint-storage/' . $filename;
				exec( $command );
			}

		}

		/**
		 * Kick Off!
		 *
		 * @return DB_CheckPoint_Plugin
		 */
		function db_checkpoint_plugin() {
			return new DB_CheckPoint_Plugin();
		}

		add_action( 'plugins_loaded', array( db_checkpoint_plugin(), 'init' ) );
	}
}