Xcloner::set_locale() - Code Metrics - Inspection of "error reporting fi" - ovidiul/XCloner-Wordpress - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 4a99fb...868d9e )

by Liuta
created 2019-01-31 11:10 UTC
Xcloner::set_locale() A

↳ Parent: Xcloner
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	5
rs	10
<?php
/**
 * XCloner - Backup and Restore backup plugin for Wordpress
 *
 * class-xcloner.php
 * @author Liuta Ovidiu <[email protected]>
 *
 *        This program is free software; you can redistribute it and/or modify
 *        it under the terms of the GNU General Public License as published by
 *        the Free Software Foundation; either version 2 of the License, or
 *        (at your option) any later version.
 *
 *        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 Street, Fifth Floor, Boston,
 *        MA 02110-1301, USA.
 *
 * @link https://github.com/ovidiul/XCloner-Wordpress
 *
 * @modified 7/31/18 3:29 PM
 *
 */

/**
 * The core plugin class.
 *
 * This is used to define internationalization, admin-specific hooks, and
 * public-facing site hooks.
 *
 * Also maintains the unique identifier of this plugin as well as the current
 * version of the plugin.
 *
 * @since      1.0.0
 * @package    Xcloner
 * @subpackage Xcloner/includes
 * @author     Liuta Ovidiu <[email protected]>
 * @link       http://www.thinkovi.com
 */
class Xcloner {

	/**
	 * The loader that's responsible for maintaining and registering all hooks that power
	 * the plugin.
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      Xcloner_Loader    $loader    Maintains and registers all hooks for the plugin.
	 */
	protected $loader;

	/**
	 * The unique identifier of this plugin.
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $plugin_name    The string used to uniquely identify this plugin.
	 */
	protected $plugin_name;

	protected $plugin_admin;

	/**
	 * The current version of the plugin.
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $version    The current version of the plugin.
	 */
	protected $version;

	private $xcloner_settings;
	private $xcloner_logger;
	private $xcloner_sanitization;
	private $xcloner_requirements;
	private $xcloner_filesystem;
	private $archive_system;
	private $xcloner_database;
	private $xcloner_scheduler;
	private $xcloner_remote_storage;
	private $xcloner_file_transfer;
	private $xcloner_encryption;

	/**
	 * Define the core functionality of the plugin.
	 *
	 * Set the plugin name and the plugin version that can be used throughout the plugin.
	 * Load the dependencies, define the locale, and set the hooks for the admin area and
	 * the public-facing side of the site.
	 *
	 * @since    1.0.0
	 */
	public function init()
	{
		register_shutdown_function(array($this, 'exception_handler'));

		$this->plugin_name = 'xcloner';
		$this->version = '4.0.4';

		$this->load_dependencies();
		$this->set_locale();
		$this->define_admin_hooks();
		$this->define_public_hooks();

		$this->define_admin_menu();
		$this->define_plugin_settings();

		$this->define_ajax_hooks();
		$this->define_cron_hooks();

	}

    /**
     * Retrieve the version number of the plugin.
     *
     * @since     1.0.0
     * @return    string    The version number of the plugin.
     */
    /*public function get_version() {
        return $this->version;
    }

    public function get_xcloner_settings()
	{
		return $this->xcloner_settings;
	}

	public function get_xcloner_filesystem()
	{
		return $this->xcloner_filesystem;
	}

	public function get_xcloner_logger()
	{
		return $this->xcloner_logger;
	}

	public function get_xcloner_sanitization()
	{
		return $this->xcloner_sanitization;
	}

	public function get_xcloner_requirements()
	{
		return $this->xcloner_requirements;
	}

	public function get_archive_system()
	{
		return $this->archive_system;
	}

	public function get_xcloner_database()
	{
		return $this->xcloner_database;
	}

	public function get_xcloner_scheduler()
	{
		return $this->xcloner_scheduler;
	}

	public function get_xcloner_remote_storage()
	{
		return $this->xcloner_remote_storage;
	}

	public function get_xcloner_file_transfer()
	{
		return $this->xcloner_file_transfer;
	}

	public function get_xcloner_encryption()
	{
		return $this->xcloner_encryption;
	}*/

    public function __call($property, $args) {

        $property = str_replace("get_", "", $property);

        if(property_exists($this, $property)){
            return $this->$property;
        }
    }

	public function check_dependencies() {

		$backup_storage_path = realpath(__DIR__.DS."..".DS."..".DS."..").DS."backups".DS;

		define("XCLONER_STORAGE_PATH", realpath($backup_storage_path));

		if (!is_dir($backup_storage_path))
		{
			if (!@mkdir($backup_storage_path))
			{
				$status = "error";
				$message = sprintf(__("Unable to create the Backup Storage Location Folder %s . Please fix this before starting the backup process."), $backup_storage_path);
				$this->trigger_message($message, $status, $backup_storage_path);
				return;
			}
		}
		if (!is_writable($backup_storage_path))
		{
			$status = "error";
			$message = sprintf(__("Unable to write to the Backup Storage Location Folder %s . Please fix this before starting the backup process."), $backup_storage_path);
			$this->trigger_message($message, $status, $backup_storage_path);

			return;
		}

	}

	public function trigger_message($message, $status = "error", $message_param1 = "", $message_param2 = "", $message_param3 = "")
	{
			$message = sprintf(__($message), $message_param1, $message_param2, $message_param3);
			add_action('xcloner_admin_notices', array($this, "trigger_message_notice"), 10, 2);
			do_action('xcloner_admin_notices', $message, $status);
	}

	public function trigger_message_notice($message, $status = "success")
	{
		?>
		<div class="notice notice-<?php echo $status?> is-dismissible">
	        <p><?php _e($message, 'xcloner-backup-and-restore'); ?></p>
	    </div>
		<?php
	}

	/**
	 * Load the required dependencies for this plugin.
	 *
	 * Include the following files that make up the plugin:
	 *
	 * - Xcloner_Loader. Orchestrates the hooks of the plugin.
	 * - Xcloner_i18n. Defines internationalization functionality.
	 * - Xcloner_Admin. Defines all hooks for the admin area.
	 * - Xcloner_Public. Defines all hooks for the public side of the site.
	 *
	 * Create an instance of the loader which will be used to register the hooks
	 * with WordPress.
	 *
	 * @since    1.0.0
	 * @access   private
	 */
	private function load_dependencies() {

		/**
		 * The class responsible for orchestrating the actions and filters of the
		 * core plugin.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-loader.php';

		/**
		 * The class responsible for defining internationalization functionality
		 * of the plugin.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-i18n.php';

		/**
		 * The class responsible for defining all actions that occur in the admin area.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'admin/class-xcloner-admin.php';

		/**
		 * The class responsible for debugging XCloner.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-logger.php';

		/**
		 * The class responsible for defining the admin settings area.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-settings.php';

		/**
		 * The class responsible for defining the Remote Storage settings area.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-remote-storage.php';

		/**
		 * The class responsible for implementing the database backup methods.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-database.php';

		/**
		 * The class responsible for sanitization of users input.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-sanitization.php';

		/**
		 * The class responsible for XCloner system requirements validation.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-requirements.php';

		/**
		 * The class responsible for XCloner backup archive creation.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-archive.php';

		/**
		 * The class responsible for XCloner API requests.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-api.php';

		/**
		 * The class responsible for the XCloner File System methods.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-file-system.php';

		/**
		 * The class responsible for the XCloner File Transfer methods.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-file-transfer.php';

		/**
		 * The class responsible for the XCloner Scheduler methods.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-scheduler.php';

		/**
		 * The class responsible for the XCloner Encryption methods.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'includes/class-xcloner-encryption.php';

		/**
		 * The class responsible for defining all actions that occur in the public-facing
		 * side of the site.
		 */
		require_once plugin_dir_path(dirname(__FILE__)).'public/class-xcloner-public.php';

		$this->loader = new Xcloner_Loader($this);

	}

	/**
	 * Define the locale for this plugin for internationalization.
	 *
	 * Uses the Xcloner_i18n class in order to set the domain and to register the hook
	 * with WordPress.
	 *
	 * @since    1.0.0
	 * @access   private
	 */
	private function set_locale() {

		$plugin_i18n = new Xcloner_i18n();

		$this->loader->add_action('plugins_loaded', $plugin_i18n, 'load_plugin_textdomain');

		//wp_localize_script( 'ajax-script', 'my_ajax_object',
		//   array( 'ajax_url' => admin_url( 'admin-ajax.php' ) ) );

	}

	/**
	 * Register all of the hooks related to the admin area functionality
	 * of the plugin.
	 *
	 * @since    1.0.0
	 * @access   private
	 */
	private function define_admin_hooks() {

		$plugin_admin = new Xcloner_Admin($this);
		$this->plugin_admin = $plugin_admin;

		$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_styles');
		$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_scripts');

		add_action('backup_archive_finished', array($this, 'do_action_after_backup_finished'), 10, 2);
	}

	/**
	 * Register the Admin Sidebar menu
	 *
	 * @access    private
	 *
	 */
	private function define_admin_menu() {

		add_action('admin_menu', array($this->loader, 'xcloner_backup_add_admin_menu'));

	}

	private function define_plugin_settings() {
		/**
		 * register wporg_settings_init to the admin_init action hook
		 */

		$this->xcloner_settings = new XCloner_Settings($this);

		if (defined('DOING_CRON') || isset($_POST['hash'])) {

			if (defined('DOING_CRON') || $_POST['hash'] == "generate_hash") {
				$this->xcloner_settings->generate_new_hash();
			} else {
				$this->xcloner_settings->set_hash($_POST['hash']);
			}
		}

		if (defined('DOING_CRON') || !isset($_POST['hash']))
		{
			add_action('shutdown', function() {
				$this->xcloner_filesystem = new Xcloner_File_System($this);
				$this->xcloner_filesystem->remove_tmp_filesystem();
			});
		}

		$this->xcloner_sanitization 	= new Xcloner_Sanitization();
		$this->xcloner_requirements 	= new Xcloner_Requirements($this);

		add_action('admin_init', array($this->xcloner_settings, 'settings_init'));

		//adding links to the Manage Plugins Wordpress page for XCloner
		add_filter('plugin_action_links', array($this, 'add_plugin_action_links'), 10, 2);



	}

	/*
	 * @method static $this get_xcloner_logger()
	 * @method static $this get_xcloner_settings()
	 * type = core|plugin|theme|translation
	 */
	public function pre_auto_update($type, $item, $context)
	{
		if (!$type)
		{
			return false;
		}

		$exclude_files = array();
		$regex = "";
		$data = "";

		$this->get_xcloner_logger()->info(sprintf("Doing automatic backup before %s upgrade, pre_auto_update hook.", $type));

		$content_dir = str_replace(ABSPATH, "", WP_CONTENT_DIR);
		$plugins_dir 	= str_replace(ABSPATH, "", WP_PLUGIN_DIR);
		$langs_dir 		= $content_dir.DS."languages";
		$themes_dir 		= $content_dir.DS."themes";

		switch ($type) {
			case 'core':
				$exclude_files = array(
									"^(?!(wp-admin|wp-includes|(?!.*\/.*.php)))(.*)$",
								);
				break;
			case 'plugin':

				$dir_array = explode(DS, $plugins_dir);

				foreach ($dir_array as $dir)
				{
					$data .= "\/".$dir;
					$regex .= $data."$|";
				}

				$regex .= "\/".implode("\/", $dir_array);

				$exclude_files = array(
									"^(?!(".$regex."))(.*)$",
								);
				break;
			case 'theme':

				$dir_array = explode(DS, $themes_dir);

				foreach ($dir_array as $dir)
				{
					$data .= "\/".$dir;
					$regex .= $data."$|";
				}

				$regex .= "\/".implode("\/", $dir_array);

				$exclude_files = array(
									"^(?!(".$regex."))(.*)$",
								);
				break;
			case 'translation':

				$dir_array = explode(DS, $langs_dir);

				foreach ($dir_array as $dir)
				{
					$data .= "\/".$dir;
					$regex .= $data."$|";
				}

				$regex .= "\/".implode("\/", $dir_array);

				$exclude_files = array(
									"^(?!(".$regex."))(.*)$",
								);
				break;
		}

		$schedule = array();

		$schedule['id'] = 0;
		$schedule['name'] = "pre_auto_update";
		$schedule['recurrence'] = "single";
		$schedule['excluded_files'] = json_encode($exclude_files);
		$schedule['table_params'] = json_encode(array("#" => array($this->get_xcloner_settings()->get_db_database())));

		$schedule['backup_params'] = new stdClass();
		$schedule['backup_params']->email_notification = get_option('admin_email');
		$schedule['backup_params']->backup_name = "backup_pre_auto_update_".$type."_[domain]-[time]-sql";

		try {
			$this->xcloner_scheduler->xcloner_scheduler_callback(0, $schedule);
		}catch (Exception $e) {
			$this->get_xcloner_logger()->error($e->getMessage());
		}

	}

	/**
	 * Register all of the hooks related to the public-facing functionality
	 * of the plugin.
	 *
	 * @since    1.0.0
	 * @access   private
	 */
	private function define_public_hooks() {

		$plugin_public = new Xcloner_Public($this);

		$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_styles');
		$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_scripts');

	}

	public function exception_handler() {

		$logger = new XCloner_Logger($this, "php_system");
		$error = error_get_last();

		if ($error['type'] and $error['type'] === E_ERROR and $logger)
		{
			$logger->error($this->friendly_error_type($error['type']).": ".var_export($error, true));
		}elseif ($error['type'] and $logger)
        {
            $logger->debug($this->friendly_error_type($error['type']).": ".var_export($error, true));
        }

	}

	public function friendly_error_type($type) {
		static $levels = null;
		if ($levels === null) {
			$levels = [];
			foreach (get_defined_constants() as $key=>$value) {
				if (strpos($key, 'E_') !== 0) {continue; }
					$levels[$value] = $key; //substr($key,2);
			}
		}
		return (isset($levels[$type]) ? $levels[$type] : "Error #{$type}");
	}

    /**
     * @method get_xcloner_settings()
     * @throws Exception
     */
	private function define_ajax_hooks()
	{
		//adding the pre-update hook

		if (is_admin() || defined('DOING_CRON'))
		{
			$this->xcloner_logger = new XCloner_Logger($this, "xcloner_api");
			$this->xcloner_filesystem = new Xcloner_File_System($this);

			//$this->xcloner_filesystem->set_diff_timestamp_start (strtotime("-15 days"));

			$this->archive_system = new Xcloner_Archive($this);
			$this->xcloner_database = new Xcloner_Database($this);
			$this->xcloner_scheduler = new Xcloner_Scheduler($this);
			$this->xcloner_remote_storage = new Xcloner_Remote_Storage($this);
			$this->xcloner_file_transfer 	= new Xcloner_File_Transfer($this);
			$this->xcloner_encryption    	= new Xcloner_Encryption($this);

			$xcloner_api = new Xcloner_Api($this);

			add_action('wp_ajax_get_database_tables_action', array($xcloner_api, 'get_database_tables_action'));
			add_action('wp_ajax_get_file_system_action', array($xcloner_api, 'get_file_system_action'));
			add_action('wp_ajax_scan_filesystem', array($xcloner_api, 'scan_filesystem'));
			add_action('wp_ajax_backup_database', array($xcloner_api, 'backup_database'));
			add_action('wp_ajax_backup_files', array($xcloner_api, 'backup_files'));
			add_action('wp_ajax_save_schedule', array($xcloner_api, 'save_schedule'));
			add_action('wp_ajax_get_schedule_by_id', array($xcloner_api, 'get_schedule_by_id'));
			add_action('wp_ajax_get_scheduler_list', array($xcloner_api, 'get_scheduler_list'));
			add_action('wp_ajax_delete_schedule_by_id', array($xcloner_api, 'delete_schedule_by_id'));
			add_action('wp_ajax_delete_backup_by_name', array($xcloner_api, 'delete_backup_by_name'));
			add_action('wp_ajax_download_backup_by_name', array($xcloner_api, 'download_backup_by_name'));
			add_action('wp_ajax_remote_storage_save_status', array($xcloner_api, 'remote_storage_save_status'));
			add_action('wp_ajax_upload_backup_to_remote', array($xcloner_api, 'upload_backup_to_remote'));
			add_action('wp_ajax_list_backup_files', array($xcloner_api, 'list_backup_files'));
			add_action('wp_ajax_restore_upload_backup', array($xcloner_api, 'restore_upload_backup'));
			add_action('wp_ajax_download_restore_script', array($xcloner_api, 'download_restore_script'));
			add_action('wp_ajax_copy_backup_remote_to_local', array($xcloner_api, 'copy_backup_remote_to_local'));
			add_action('wp_ajax_restore_backup', array($xcloner_api, 'restore_backup'));
			add_action('wp_ajax_backup_encryption', array($xcloner_api, 'backup_encryption'));
			add_action('wp_ajax_backup_decryption', array($xcloner_api, 'backup_decryption'));
			add_action('wp_ajax_get_manage_backups_list', array($xcloner_api, 'get_manage_backups_list'));
			add_action('admin_notices', array($this, 'xcloner_error_admin_notices'));

		}

		//Do a pre-update backup of targeted files
		if ($this->get_xcloner_settings()->get_xcloner_option('xcloner_enable_pre_update_backup'))
		{
			add_action("pre_auto_update", array($this, "pre_auto_update"), 1, 3);
		}
	}

	public function add_plugin_action_links($links, $file) {
		if ($file == plugin_basename(dirname(dirname(__FILE__)).'/xcloner.php'))
		{
			$links[] = '<a href="admin.php?page=xcloner_settings_page">'.__('Settings', 'xcloner-backup-and-restore').'</a>';
			$links[] = '<a href="admin.php?page=xcloner_generate_backups_page">'.__('Generate Backup', 'xcloner-backup-and-restore').'</a>';
		}

		return $links;
	}

	public function xcloner_error_admin_notices() {
			settings_errors('xcloner_error_message');
		}

    /**
     * @method get_xcloner_scheduler()
     */
	public function define_cron_hooks()
	{
		//registering new schedule intervals
		add_filter('cron_schedules', array($this, 'add_new_intervals'));


		$xcloner_scheduler = $this->get_xcloner_scheduler();
		$xcloner_scheduler->update_wp_cron_hooks();

	}

	/**
	 * @param $schedules
	 * @return mixed
	 */
	public function add_new_intervals($schedules)
	{
		//weekly scheduler interval
		$schedules['weekly'] = array(
			'interval' => 604800,
			'display' => __('Once Weekly', 'xcloner-backup-and-restore')
		);

		//monthly scheduler interval
		$schedules['monthly'] = array(
			'interval' => 2635200,
			'display' => __('Once Monthly', 'xcloner-backup-and-restore')
		);

		//monthly scheduler interval
		$schedules['twicedaily'] = array(
			'interval' => 43200,
			'display' => __('Twice Daily', 'xcloner-backup-and-restore')
		);

		return $schedules;
	}


	/**
	 * Run the loader to execute all of the hooks with WordPress.
	 *
	 * @since    1.0.0
	 */
	public function run() {
		$this->loader->run();
	}

	/**
	 * The name of the plugin used to uniquely identify it within the context of
	 * WordPress and to define internationalization functionality.
	 *
	 * @since     1.0.0
	 * @return    string    The name of the plugin.
	 */
	public function get_plugin_name() {
		return $this->plugin_name;
	}

	/**
	 * The reference to the class that orchestrates the hooks with the plugin.
	 *
	 * @since     1.0.0
	 * @return    Xcloner_Loader    Orchestrates the hooks of the plugin.
	 */
	public function get_loader() {
		return $this->loader;
	}

	public function xcloner_display()
	{
		// check user capabilities
		if (!current_user_can('manage_options')) {
			return;
		}

		$page = sanitize_key($_GET['page']);

		if ($page)
		{
			$this->display($page);
		}

	}

	public function display($page)
	{
		$plugin_admin = new Xcloner_Admin($this);
		$this->plugin_admin = $plugin_admin;

		call_user_func_array(array($this->plugin_admin, $page), array());
	}
}

ovidiul / XCloner-Wordpress

GitHub Access Token became invalid

Push — master ( 4a99fb...868d9e )

Xcloner::set_locale() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
