Plugin - Code Metrics - Inspection of "Add the beginnings of a dedicated page for extensi..." - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#909)

by Paul

created 2016-03-11 12:51 UTC

Plugin B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	451
Duplicated Lines	2 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes	11
Bugs	0	Features	0

Metric	Value
wmc	50
c	11
b	0
f	0
lcom	2
cbo	6
dl	9
loc	451
rs	8.6206

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	get_instance()	0	8	2
A	plugins_loaded()	0	18	2
A	maybe_self_deactivate()	9	17	2
C	constants()	0	28	8
A	hooks()	0	17	1
B	scripts()	0	32	4
A	text_domain()	0	18	1
A	upgrade()	0	8	2
A	init()	0	5	1
A	generate_key()	0	20	4
A	load_first()	0	19	2
A	schedule_hook_run()	0	16	3
A	styles()	0	15	3
B	load_intercom_script()	0	33	5
B	display_feature_message()	0	30	4
B	includes()	0	66	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Plugin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Plugin, and based on these observations, apply Extract Interface, too.

<?php

namespace HM\BackUpWordPress;

/**
 * Class Plugin
 */
final class Plugin {
	const PLUGIN_VERSION = '3.5';

	/**
	 * @var Plugin The singleton instance.
	 */
	private static $instance;

	/**
	 * Instantiates a new Plugin object.
	 */
	private function __construct() {
		add_action( 'plugins_loaded', array( $this, 'plugins_loaded' ) );

		$hide_notice = get_site_option( 'hmbkp_hide_info_notice', false );

		if ( ! $hide_notice ) {
			add_action( 'admin_notices', array( $this, 'display_feature_message' ) );
			add_action( 'network_admin_notices', array( $this, 'display_feature_message' ) );
		}

	}

	/**
	 * Insures we always return the same object.
	 *
	 * @return Plugin
	 */
	public static function get_instance() {

		if ( ! ( self::$instance instanceof Plugin ) ) {
			self::$instance = new Plugin();
		}

		return self::$instance;
	}

	/**
	 * Initialize the plugin.
	 */
	public function plugins_loaded() {

		if ( true !== $this->maybe_self_deactivate() ) {

			$this->constants();

			$this->includes();

			$this->hooks();

			$this->text_domain();

			// If we get here, then BWP is loaded
			do_action( 'backupwordpress_loaded' );

		}

	}

	/**
	 * Check plugin requirements.
	 *
	 * @return bool True is fails requirements. False otherwise.
	 */
	public function maybe_self_deactivate() {

		require_once( HMBKP_PLUGIN_PATH . 'classes/class-setup.php' );

		if ( false === \HMBKP_Setup::meets_requirements() ) {


			add_action( 'admin_init', array( '\HMBKP_Setup', 'self_deactivate' ) );

			add_action( 'all_admin_notices', array( '\HMBKP_Setup', 'display_admin_notices' ) );

			return true;

		}

		return false;

	}

	/**
	 * Define all the constants.
	 */
	public function constants() {

		if ( ! defined( 'HMBKP_PLUGIN_SLUG' ) ) {
			define( 'HMBKP_PLUGIN_SLUG', dirname( HMBKP_BASENAME ) );
		}

		if ( ! defined( 'HMBKP_PLUGIN_URL' ) ) {
			define( 'HMBKP_PLUGIN_URL', plugin_dir_url( HMBKP_BASENAME ) );
		}

		if ( ! defined( 'HMBKP_PLUGIN_LANG_DIR' ) ) {
			define( 'HMBKP_PLUGIN_LANG_DIR', apply_filters( 'hmbkp_filter_lang_dir', HMBKP_PLUGIN_SLUG . '/languages/' ) );
		}

		if ( ! defined( 'HMBKP_ADMIN_URL' ) ) {
			$page = is_multisite() ? network_admin_url( 'settings.php' ) : admin_url( 'tools.php' );
			define( 'HMBKP_ADMIN_URL', add_query_arg( 'page', HMBKP_PLUGIN_SLUG, $page ) );
		}

		if ( ! defined( 'HMBKP_ADMIN_PAGE' ) ) {
			$prefix = is_multisite() ? 'settings_page_' : 'tools_page_';

			define( 'HMBKP_ADMIN_PAGE', $prefix . HMBKP_PLUGIN_SLUG );
		}

		define( 'HMBKP_SECURE_KEY', $this->generate_key() );

	}

	/**
	 * Load all BackUpWordPress functions.
	 */
	protected function includes() {

		require_once( HMBKP_PLUGIN_PATH . 'vendor/autoload.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/class-notices.php' );

		// Load the admin menu
		require_once( HMBKP_PLUGIN_PATH . 'admin/menu.php' );
		require_once( HMBKP_PLUGIN_PATH . 'admin/actions.php' );

		// Load Backdrop if necessary.
		if ( ! class_exists( 'HM_Backdrop_Task' ) ) {
			require_once( HMBKP_PLUGIN_PATH . 'backdrop/hm-backdrop.php' );
		}

		require_once( HMBKP_PLUGIN_PATH . 'classes/class-requirements.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-requirement.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/class-path.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-excludes.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-site-size.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-utilities.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-status.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database-mysqldump.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database-imysqldump.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip-archive.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup.php' );

		// Load the backup scheduling classes
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-scheduled-backup.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-schedules.php' );

		// Load the core functions
		require_once( HMBKP_PLUGIN_PATH . 'functions/core.php' );
		require_once( HMBKP_PLUGIN_PATH . 'functions/interface.php' );

		// Load the services
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-services.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-service.php' );

		// Load the email service
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-email-service.php' );

		// Load the webhook services
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-webhook-service.php' );
		require_once( HMBKP_PLUGIN_PATH . 'classes/class-wpremote-webhook-service.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/deprecated.php' );

		require_once( HMBKP_PLUGIN_PATH . 'classes/class-extensions.php' );

		// Load the wp cli command
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
			include( HMBKP_PLUGIN_PATH . 'classes/class-backupwordpress-wp-cli-command.php' );
		}

	}

	/**
	 * Hook into WordPress page lifecycle and execute BackUpWordPress functions.
	 */
	public function hooks() {

		add_action( 'activated_plugin', array( $this, 'load_first' ) );

		add_action( 'admin_init', array( $this, 'upgrade' ) );

		add_action( 'admin_init', array( $this, 'init' ) );

		add_action( 'hmbkp_schedule_hook', array( $this, 'schedule_hook_run' ) );

		add_action( 'admin_enqueue_scripts', array( $this, 'scripts' ) );

		add_action( 'admin_footer-' . HMBKP_ADMIN_PAGE, array( $this, 'load_intercom_script' ) );

		add_action( 'admin_enqueue_scripts', array( $this, 'styles' ) );

	}

	/**
	 * Load the Javascript in the admin.
	 *
	 * @param $hook The name of the admin page hook.
	 */
	public function scripts( $hook ) {

		if ( HMBKP_ADMIN_PAGE !== $hook ) {
			return;
		}

		$js_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.min.js';

		// TODO shuold this also support WP_SCRIPT_DEBUG
		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
			$js_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.js';
		}

		wp_enqueue_script( 'hmbkp', $js_file, array( 'heartbeat' ), sanitize_key( self::PLUGIN_VERSION ) );

		wp_localize_script(
			'hmbkp',
			'hmbkp',
			array(
				'page_slug'                => HMBKP_PLUGIN_SLUG,
				'nonce'                    => wp_create_nonce( 'hmbkp_nonce' ),
				'hmbkp_run_schedule_nonce' => wp_create_nonce( 'hmbkp_run_schedule' ),
				'update'                   => __( 'Update', 'backupwordpress' ),
				'cancel'                   => __( 'Cancel', 'backupwordpress' ),
				'delete_schedule'          => __( 'Are you sure you want to delete this schedule? All of its backups will also be deleted.', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
				'delete_backup'            => __( 'Are you sure you want to delete this backup?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
				'remove_exclude_rule'      => __( 'Are you sure you want to remove this exclude rule?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
				'remove_old_backups'       => __( 'Reducing the number of backups that are stored on this server will cause some of your existing backups to be deleted. Are you sure that\'s what you want?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n"
			)
		);

	}

	/**
	 * Loads the plugin text domain for translation.
	 * This setup allows a user to just drop his custom translation files into the WordPress language directory
	 * Files will need to be in a subdirectory with the name of the textdomain 'backupwordpress'
	 */
	public function text_domain() {

		// Set unique textdomain string
		$textdomain = 'backupwordpress';

		// The 'plugin_locale' filter is also used by default in load_plugin_textdomain()
		$locale = apply_filters( 'plugin_locale', get_locale(), $textdomain );

		// Set filter for WordPress languages directory
		$hmbkp_wp_lang_dir = apply_filters( 'hmbkp_do_filter_wp_lang_dir', trailingslashit( WP_LANG_DIR ) . trailingslashit( $textdomain ) . $textdomain . '-' . $locale . '.mo' );

		// Translations: First, look in WordPress' "languages" folder = custom & update-secure!
		load_textdomain( $textdomain, $hmbkp_wp_lang_dir );

		// Translations: Secondly, look in plugin's "languages" folder = default
		load_plugin_textdomain( $textdomain, false, HMBKP_PLUGIN_LANG_DIR );

	}

	/**
	 * Determine if we need to run an upgrade routine.
	 */
	public function upgrade() {

		// Fire the update action
		if ( self::PLUGIN_VERSION != get_option( 'hmbkp_plugin_version' ) ) {
			update();
		}

	}

	/**
	 * Runs on every admin page load
	 */
	public function init() {

		// If we have multiple paths for some reason then clean them up
		Path::get_instance()->merge_existing_paths();
	}

	/**
	 * Generate a unique key.
	 *
	 * @return string
	 */
	protected function generate_key() {

		$check = apply_filters( "hmbkp_generate_key", null );
		if ( null !== $check )
			return $check;

		$key = array( ABSPATH, time() );
		$constants = array( 'AUTH_KEY', 'SECURE_AUTH_KEY', 'LOGGED_IN_KEY', 'NONCE_KEY', 'AUTH_SALT', 'SECURE_AUTH_SALT', 'LOGGED_IN_SALT', 'NONCE_SALT', 'SECRET_KEY' );

		foreach ( $constants as $constant ) {
			if ( defined( $constant ) ) {
				$key[] = constant( $constant );
			}
		}

		shuffle( $key );

		return md5( serialize( $key ) );

	}

	/**
	 * Ensure BackUpWordPress is loaded before add-ons, changes the order of the serialized values in the DB field.
	 */
	public function load_first() {

		$active_plugins = get_option( 'active_plugins' );

		$plugin_path = plugin_basename( __FILE__ );

		$key = array_search( $plugin_path, $active_plugins );

		if ( $key > 0 ) {

			array_splice( $active_plugins, $key, 1 );

			array_unshift( $active_plugins, $plugin_path );

			update_option( 'active_plugins', $active_plugins );

		}

	}

	/**
	 * Function to run when the schedule cron fires.
	 *
	 * @param $schedule_id
	 */
	public function schedule_hook_run( $schedule_id ) {

		if ( ! is_backup_possible() ) {
			return;
		}

		$schedules = Schedules::get_instance();
		$schedule  = $schedules->get_schedule( $schedule_id );

		if ( ! $schedule ) {
			return;
		}

		$schedule->run();

	}

	/**
	 * Enqueue the plugin styles.
	 *
	 * @param $hook
	 */
	public function styles( $hook ) {

		if ( HMBKP_ADMIN_PAGE !== $hook ) {
			return;
		}

		$css_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.min.css';

		if ( WP_DEBUG ) {
			$css_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.css';
		}

		wp_enqueue_style( 'backupwordpress', $css_file, false, sanitize_key( self::PLUGIN_VERSION ) );

	}

	/**
	 * Load Intercom and send across user information and server info. Only loaded if the user has opted in.
	 *
	 * @param $hook
	 */
	public function load_intercom_script() {

		if ( ! get_option( 'hmbkp_enable_support' ) ) {
			return;
		}

		$info = array();

		foreach ( Requirements::get_requirement_groups() as $group ) {
			foreach ( Requirements::get_requirements( $group ) as $requirement ) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$info[ $requirement->name() ] = $requirement->result();
			}
		}

		foreach ( Services::get_services() as $file => $service ) {
			array_merge( $info, call_user_func( array( $service, 'intercom_data' ) ) );
		}

		$current_user = wp_get_current_user();

		$info['user_hash']  = hash_hmac( 'sha256', $current_user->user_email, 'fcUEt7Vi4ym5PXdcr2UNpGdgZTEvxX9NJl8YBTxK' );
		$info['email']      = $current_user->user_email;
		$info['created_at'] = strtotime( $current_user->user_registered );
		$info['app_id']     = '7f1l4qyq';
		$info['name']       = $current_user->display_name;
		$info['widget']     = array( 'activator' => '#intercom' ); ?>

		<script id="IntercomSettingsScriptTag">
			window.intercomSettings = <?php echo json_encode( $info ); ?>;
		</script>
		<script>!function(){function e(){var a=c.createElement("script");a.type="text/javascript",a.async=!0,a.src="https://static.intercomcdn.com/intercom.v1.js";var b=c.getElementsByTagName("script")[0];b.parentNode.insertBefore(a,b)}var a=window,b=a.Intercom;if("function"==typeof b)b("reattach_activator"),b("update",intercomSettings);else{var c=document,d=function(){d.c(arguments)};d.q=[],d.c=function(a){d.q.push(a)},a.Intercom=d,a.attachEvent?a.attachEvent("onload",e):a.addEventListener("load",e,!1)}}();</script>

	<?php }

	public function display_feature_message() {

		$current_screen = get_current_screen();

		if ( ! isset( $current_screen ) ) {
			return;
		}

		$page = is_multisite() ? HMBKP_ADMIN_PAGE . '-network' : HMBKP_ADMIN_PAGE;
		if ( $current_screen->id !== $page ) {
			return;
		}

		/* translators: %1$s and %2$s expand to anchor tags linking to the new extensions page. */
		$info_message = sprintf(
			__( 'Thanks for updating BackUpWordPress, why not check out %1$sour extensions?%2$s', 'backupwordpress' ),
			'<a href="' . get_settings_url( HMBKP_PLUGIN_SLUG . '_extensions' ) . '">',
			'</a>'
		);
		?>

		<div id="hmbkp-info-message" class="updated notice is-dismissible">

			<p><?php echo $info_message; ?></p>

			<button type="button" class="notice-dismiss"><span class="screen-reader-text"><?php esc_html_e( 'Dismiss this notice.', 'backupwordpress' ); ?></span></button>

		</div>

	<?php }

}

if ( is_multisite() && ! is_main_site() ) {
	return;
}

Plugin::get_instance();


1		<?php
2
3		namespace HM\BackUpWordPress;
4
5		/**
6		* Class Plugin
7		*/
8		final class Plugin {
9		const PLUGIN_VERSION = '3.5';
10
11		/**
12		* @var Plugin The singleton instance.
13		*/
14		private static $instance;
15
16		/**
17		* Instantiates a new Plugin object.
18		*/
19		private function __construct() {
20		add_action( 'plugins_loaded', array( $this, 'plugins_loaded' ) );
21
22		$hide_notice = get_site_option( 'hmbkp_hide_info_notice', false );
23
24		if ( ! $hide_notice ) {
25		add_action( 'admin_notices', array( $this, 'display_feature_message' ) );
26		add_action( 'network_admin_notices', array( $this, 'display_feature_message' ) );
27		}
28
29		}
30
31		/**
32		* Insures we always return the same object.
33		*
34		* @return Plugin
35		*/
36		public static function get_instance() {
37
38		if ( ! ( self::$instance instanceof Plugin ) ) {
39		self::$instance = new Plugin();
40		}
41
42		return self::$instance;
43		}
44
45		/**
46		* Initialize the plugin.
47		*/
48		public function plugins_loaded() {
49
50		if ( true !== $this->maybe_self_deactivate() ) {
51
52		$this->constants();
53
54		$this->includes();
55
56		$this->hooks();
57
58		$this->text_domain();
59
60		// If we get here, then BWP is loaded
61		do_action( 'backupwordpress_loaded' );
62
63		}
64
65		}
66
67		/**
68		* Check plugin requirements.
69		*
70		* @return bool True is fails requirements. False otherwise.
71		*/
72		public function maybe_self_deactivate() {
73
74		require_once( HMBKP_PLUGIN_PATH . 'classes/class-setup.php' );
75
76	View Code Duplication	if ( false === \HMBKP_Setup::meets_requirements() ) {
		1 ignored issue – show Duplication introduced 2016-02-11 10:48 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
77
78		add_action( 'admin_init', array( '\HMBKP_Setup', 'self_deactivate' ) );
79
80		add_action( 'all_admin_notices', array( '\HMBKP_Setup', 'display_admin_notices' ) );
81
82		return true;
83
84		}
85
86		return false;
87
88		}
89
90		/**
91		* Define all the constants.
92		*/
93		public function constants() {
94
95		if ( ! defined( 'HMBKP_PLUGIN_SLUG' ) ) {
96		define( 'HMBKP_PLUGIN_SLUG', dirname( HMBKP_BASENAME ) );
97		}
98
99		if ( ! defined( 'HMBKP_PLUGIN_URL' ) ) {
100		define( 'HMBKP_PLUGIN_URL', plugin_dir_url( HMBKP_BASENAME ) );
101		}
102
103		if ( ! defined( 'HMBKP_PLUGIN_LANG_DIR' ) ) {
104		define( 'HMBKP_PLUGIN_LANG_DIR', apply_filters( 'hmbkp_filter_lang_dir', HMBKP_PLUGIN_SLUG . '/languages/' ) );
105		}
106
107		if ( ! defined( 'HMBKP_ADMIN_URL' ) ) {
108		$page = is_multisite() ? network_admin_url( 'settings.php' ) : admin_url( 'tools.php' );
109		define( 'HMBKP_ADMIN_URL', add_query_arg( 'page', HMBKP_PLUGIN_SLUG, $page ) );
110		}
111
112		if ( ! defined( 'HMBKP_ADMIN_PAGE' ) ) {
113		$prefix = is_multisite() ? 'settings_page_' : 'tools_page_';
114
115		define( 'HMBKP_ADMIN_PAGE', $prefix . HMBKP_PLUGIN_SLUG );
116		}
117
118		define( 'HMBKP_SECURE_KEY', $this->generate_key() );
119
120		}
121
122		/**
123		* Load all BackUpWordPress functions.
124		*/
125		protected function includes() {
126
127		require_once( HMBKP_PLUGIN_PATH . 'vendor/autoload.php' );
128
129		require_once( HMBKP_PLUGIN_PATH . 'classes/class-notices.php' );
130
131		// Load the admin menu
132		require_once( HMBKP_PLUGIN_PATH . 'admin/menu.php' );
133		require_once( HMBKP_PLUGIN_PATH . 'admin/actions.php' );
134
135		// Load Backdrop if necessary.
136		if ( ! class_exists( 'HM_Backdrop_Task' ) ) {
137		require_once( HMBKP_PLUGIN_PATH . 'backdrop/hm-backdrop.php' );
138		}
139
140		require_once( HMBKP_PLUGIN_PATH . 'classes/class-requirements.php' );
141		require_once( HMBKP_PLUGIN_PATH . 'classes/class-requirement.php' );
142
143		require_once( HMBKP_PLUGIN_PATH . 'classes/class-path.php' );
144		require_once( HMBKP_PLUGIN_PATH . 'classes/class-excludes.php' );
145		require_once( HMBKP_PLUGIN_PATH . 'classes/class-site-size.php' );
146
147		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-utilities.php' );
148		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-status.php' );
149
150		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine.php' );
151
152		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database.php' );
153		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database-mysqldump.php' );
154		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-database-imysqldump.php' );
155
156		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file.php' );
157		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip.php' );
158		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip-archive.php' );
159
160		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup.php' );
161
162		// Load the backup scheduling classes
163		require_once( HMBKP_PLUGIN_PATH . 'classes/class-scheduled-backup.php' );
164		require_once( HMBKP_PLUGIN_PATH . 'classes/class-schedules.php' );
165
166		// Load the core functions
167		require_once( HMBKP_PLUGIN_PATH . 'functions/core.php' );
168		require_once( HMBKP_PLUGIN_PATH . 'functions/interface.php' );
169
170		// Load the services
171		require_once( HMBKP_PLUGIN_PATH . 'classes/class-services.php' );
172		require_once( HMBKP_PLUGIN_PATH . 'classes/class-service.php' );
173
174		// Load the email service
175		require_once( HMBKP_PLUGIN_PATH . 'classes/class-email-service.php' );
176
177		// Load the webhook services
178		require_once( HMBKP_PLUGIN_PATH . 'classes/class-webhook-service.php' );
179		require_once( HMBKP_PLUGIN_PATH . 'classes/class-wpremote-webhook-service.php' );
180
181		require_once( HMBKP_PLUGIN_PATH . 'classes/deprecated.php' );
182
183		require_once( HMBKP_PLUGIN_PATH . 'classes/class-extensions.php' );
184
185		// Load the wp cli command
186		if ( defined( 'WP_CLI' ) && WP_CLI ) {
187		include( HMBKP_PLUGIN_PATH . 'classes/class-backupwordpress-wp-cli-command.php' );
188		}
189
190		}
191
192		/**
193		* Hook into WordPress page lifecycle and execute BackUpWordPress functions.
194		*/
195		public function hooks() {
196
197		add_action( 'activated_plugin', array( $this, 'load_first' ) );
198
199		add_action( 'admin_init', array( $this, 'upgrade' ) );
200
201		add_action( 'admin_init', array( $this, 'init' ) );
202
203		add_action( 'hmbkp_schedule_hook', array( $this, 'schedule_hook_run' ) );
204
205		add_action( 'admin_enqueue_scripts', array( $this, 'scripts' ) );
206
207		add_action( 'admin_footer-' . HMBKP_ADMIN_PAGE, array( $this, 'load_intercom_script' ) );
208
209		add_action( 'admin_enqueue_scripts', array( $this, 'styles' ) );
210
211		}
212
213		/**
214		* Load the Javascript in the admin.
215		*
216		* @param $hook The name of the admin page hook.
217		*/
218		public function scripts( $hook ) {
219
220		if ( HMBKP_ADMIN_PAGE !== $hook ) {
221		return;
222		}
223
224		$js_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.min.js';
225
226		// TODO shuold this also support WP_SCRIPT_DEBUG
227		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
228		$js_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.js';
229		}
230
231		wp_enqueue_script( 'hmbkp', $js_file, array( 'heartbeat' ), sanitize_key( self::PLUGIN_VERSION ) );
232
233		wp_localize_script(
234		'hmbkp',
235		'hmbkp',
236		array(
237		'page_slug' => HMBKP_PLUGIN_SLUG,
238		'nonce' => wp_create_nonce( 'hmbkp_nonce' ),
239		'hmbkp_run_schedule_nonce' => wp_create_nonce( 'hmbkp_run_schedule' ),
240		'update' => __( 'Update', 'backupwordpress' ),
241		'cancel' => __( 'Cancel', 'backupwordpress' ),
242		'delete_schedule' => __( 'Are you sure you want to delete this schedule? All of its backups will also be deleted.', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
243		'delete_backup' => __( 'Are you sure you want to delete this backup?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
244		'remove_exclude_rule' => __( 'Are you sure you want to remove this exclude rule?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n",
245		'remove_old_backups' => __( 'Reducing the number of backups that are stored on this server will cause some of your existing backups to be deleted. Are you sure that\'s what you want?', 'backupwordpress' ) . "\n\n" . __( '\'Cancel\' to go back, \'OK\' to delete.', 'backupwordpress' ) . "\n"
246		)
247		);
248
249		}
250
251		/**
252		* Loads the plugin text domain for translation.
253		* This setup allows a user to just drop his custom translation files into the WordPress language directory
254		* Files will need to be in a subdirectory with the name of the textdomain 'backupwordpress'
255		*/
256		public function text_domain() {
257
258		// Set unique textdomain string
259		$textdomain = 'backupwordpress';
260
261		// The 'plugin_locale' filter is also used by default in load_plugin_textdomain()
262		$locale = apply_filters( 'plugin_locale', get_locale(), $textdomain );
263
264		// Set filter for WordPress languages directory
265		$hmbkp_wp_lang_dir = apply_filters( 'hmbkp_do_filter_wp_lang_dir', trailingslashit( WP_LANG_DIR ) . trailingslashit( $textdomain ) . $textdomain . '-' . $locale . '.mo' );
266
267		// Translations: First, look in WordPress' "languages" folder = custom & update-secure!
268		load_textdomain( $textdomain, $hmbkp_wp_lang_dir );
269
270		// Translations: Secondly, look in plugin's "languages" folder = default
271		load_plugin_textdomain( $textdomain, false, HMBKP_PLUGIN_LANG_DIR );
272
273		}
274
275		/**
276		* Determine if we need to run an upgrade routine.
277		*/
278		public function upgrade() {
279
280		// Fire the update action
281		if ( self::PLUGIN_VERSION != get_option( 'hmbkp_plugin_version' ) ) {
282		update();
283		}
284
285		}
286
287		/**
288		* Runs on every admin page load
289		*/
290		public function init() {
291
292		// If we have multiple paths for some reason then clean them up
293		Path::get_instance()->merge_existing_paths();
294		}
295
296		/**
297		* Generate a unique key.
298		*
299		* @return string
300		*/
301		protected function generate_key() {
302
303		$check = apply_filters( "hmbkp_generate_key", null );
304		if ( null !== $check )
305		return $check;
306
307		$key = array( ABSPATH, time() );
308		$constants = array( 'AUTH_KEY', 'SECURE_AUTH_KEY', 'LOGGED_IN_KEY', 'NONCE_KEY', 'AUTH_SALT', 'SECURE_AUTH_SALT', 'LOGGED_IN_SALT', 'NONCE_SALT', 'SECRET_KEY' );
309
310		foreach ( $constants as $constant ) {
311		if ( defined( $constant ) ) {
312		$key[] = constant( $constant );
313		}
314		}
315
316		shuffle( $key );
317
318		return md5( serialize( $key ) );
319
320		}
321
322		/**
323		* Ensure BackUpWordPress is loaded before add-ons, changes the order of the serialized values in the DB field.
324		*/
325		public function load_first() {
326
327		$active_plugins = get_option( 'active_plugins' );
328
329		$plugin_path = plugin_basename( __FILE__ );
330
331		$key = array_search( $plugin_path, $active_plugins );
332
333		if ( $key > 0 ) {
334
335		array_splice( $active_plugins, $key, 1 );
336
337		array_unshift( $active_plugins, $plugin_path );
338
339		update_option( 'active_plugins', $active_plugins );
340
341		}
342
343		}
344
345		/**
346		* Function to run when the schedule cron fires.
347		*
348		* @param $schedule_id
349		*/
350		public function schedule_hook_run( $schedule_id ) {
351
352		if ( ! is_backup_possible() ) {
353		return;
354		}
355
356		$schedules = Schedules::get_instance();
357		$schedule = $schedules->get_schedule( $schedule_id );
358
359		if ( ! $schedule ) {
360		return;
361		}
362
363		$schedule->run();
364
365		}
366
367		/**
368		* Enqueue the plugin styles.
369		*
370		* @param $hook
371		*/
372		public function styles( $hook ) {
373
374		if ( HMBKP_ADMIN_PAGE !== $hook ) {
375		return;
376		}
377
378		$css_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.min.css';
379
380		if ( WP_DEBUG ) {
381		$css_file = HMBKP_PLUGIN_URL . 'assets/hmbkp.css';
382		}
383
384		wp_enqueue_style( 'backupwordpress', $css_file, false, sanitize_key( self::PLUGIN_VERSION ) );
385
386		}
387
388		/**
389		* Load Intercom and send across user information and server info. Only loaded if the user has opted in.
390		*
391		* @param $hook
392		*/
393		public function load_intercom_script() {
394
395		if ( ! get_option( 'hmbkp_enable_support' ) ) {
396		return;
397		}
398
399		$info = array();
400
401		foreach ( Requirements::get_requirement_groups() as $group ) {
402		foreach ( Requirements::get_requirements( $group ) as $requirement ) {
		0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report `$group` is of type `integer\|string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
403		$info[ $requirement->name() ] = $requirement->result();
404		}
405		}
406
407		foreach ( Services::get_services() as $file => $service ) {
408		array_merge( $info, call_user_func( array( $service, 'intercom_data' ) ) );
409		}
410
411		$current_user = wp_get_current_user();
412
413		$info['user_hash'] = hash_hmac( 'sha256', $current_user->user_email, 'fcUEt7Vi4ym5PXdcr2UNpGdgZTEvxX9NJl8YBTxK' );
414		$info['email'] = $current_user->user_email;
415		$info['created_at'] = strtotime( $current_user->user_registered );
416		$info['app_id'] = '7f1l4qyq';
417		$info['name'] = $current_user->display_name;
418		$info['widget'] = array( 'activator' => '#intercom' ); ?>
419
420		<script id="IntercomSettingsScriptTag">
421		window.intercomSettings = <?php echo json_encode( $info ); ?>;
422		</script>
423		<script>!function(){function e(){var a=c.createElement("script");a.type="text/javascript",a.async=!0,a.src="https://static.intercomcdn.com/intercom.v1.js";var b=c.getElementsByTagName("script")[0];b.parentNode.insertBefore(a,b)}var a=window,b=a.Intercom;if("function"==typeof b)b("reattach_activator"),b("update",intercomSettings);else{var c=document,d=function(){d.c(arguments)};d.q=[],d.c=function(a){d.q.push(a)},a.Intercom=d,a.attachEvent?a.attachEvent("onload",e):a.addEventListener("load",e,!1)}}();</script>
424
425		<?php }
426
427		public function display_feature_message() {
428
429		$current_screen = get_current_screen();
430
431		if ( ! isset( $current_screen ) ) {
432		return;
433		}
434
435		$page = is_multisite() ? HMBKP_ADMIN_PAGE . '-network' : HMBKP_ADMIN_PAGE;
436		if ( $current_screen->id !== $page ) {
437		return;
438		}
439
440		/* translators: %1$s and %2$s expand to anchor tags linking to the new extensions page. */
441		$info_message = sprintf(
442		__( 'Thanks for updating BackUpWordPress, why not check out %1$sour extensions?%2$s', 'backupwordpress' ),
443		'<a href="' . get_settings_url( HMBKP_PLUGIN_SLUG . '_extensions' ) . '">',
444		'</a>'
445		);
446		?>
447
448		<div id="hmbkp-info-message" class="updated notice is-dismissible">
449
450		<p><?php echo $info_message; ?></p>
451
452		<button type="button" class="notice-dismiss"><span class="screen-reader-text"><?php esc_html_e( 'Dismiss this notice.', 'backupwordpress' ); ?></span></button>
453
454		</div>
455
456		<?php }
457
458		}
459
460		if ( is_multisite() && ! is_main_site() ) {
461		return;
462		}
463
464		Plugin::get_instance();
465

humanmade / backupwordpress

GitHub Access Token became invalid