PLUGIN_BUILD::prevent_unauthorized_rest_access() - Code Metrics - Inspection of "Custom taxonomies + bug fixes" - nirjharlo/wp-plugin-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 1931dd...40edde )

by Nirjhar
created 2020-12-20 15:12 UTC
PLUGIN_BUILD::prevent_unauthorized_rest_access() A

↳ Parent: PLUGIN_BUILD
Complexity

Conditions	4
Paths	3
Size

Total Lines	18
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	8
nc	3
nop	1
dl	0
loc	18
rs	10
c	0
b	0
f	0
<?php
if ( ! defined( 'ABSPATH' ) ) exit;

/**
 * Main plugin object to define the plugin
 * Follow: https://codex.wordpress.org/Plugin_API for details
 *
 * @author     Nirjhar Lo
 * @package    wp-plugin-framework
 */
if ( ! class_exists( 'PLUGIN_BUILD' ) ) {

	final class PLUGIN_BUILD {

		/**
		 * @var String
		 */
		protected $version = '1.3';


		/**
		 * Plugin Instance.
		 *
		 * @var PLUGIN_BUILD the PLUGIN Instance
		 */
		protected static $_instance;


		/**
		 * Text domain to be used throughout the plugin
		 *
		 * @var String
		 */
		protected static $text_domain = 'textdomain';


		/**
		 * Minimum PHP version allowed for the plugin
		 *
		 * @var String
		 */
		protected static $php_ver_allowed = '5.3';


		/**
		 * DB tabble used in plugin
		 *
		 * @var String
		 */
		protected static $plugin_table = 'plugin_db_table_name';


		/**
		 * Plugin listing page links, along with Deactivate
		 *
		 * @var Array
		 */
		protected static $plugin_page_links = array(
			array(
				'slug' => '',
				'label' => ''
			) );


		/**
		 * Main Plugin Instance.
		 *
		 * @return PLUGIN_BUILD
		 */
		public static function instance() {

			if ( is_null( self::$_instance ) ) {
				self::$_instance = new self();
				self::$_instance->init();
			}

			return self::$_instance;
		}


		/**
		 * Install plugin setup
		 *
		 * @return Void
		 */
		public function installation() {

			if (class_exists('PLUGIN_INSTALL')) {

				$install = new PLUGIN_INSTALL();
				$install->text_domain = self::$text_domain;
				$install->php_ver_allowed = self::$php_ver_allowed;
				$install->plugin_page_links = self::$plugin_page_links;
				$install->execute();
			}

			//If CPT exists, include taht and flush the rewrite rules
			if ( class_exists( 'PLUGIN_CPT' ) ) new PLUGIN_CPT();
			flush_rewrite_rules();
   flush_rewrite_rules();
		}


		/**
		 * Custom corn class, register it while activation
		 *
		 * @return Void
		 */
		public function cron_activation() {

			if ( class_exists( 'PLUGIN_CRON' ) ) {

				$cron = new PLUGIN_CRON();
				$schedule = $cron->schedule_task(

							array(
							'timestamp' => current_time('timestamp'),
							'timestamp' => /** @scrutinizer ignore-call */ current_time('timestamp'),
							//'schedule' can be 'hourly', 'daily', 'weekly' or anything custom as defined in PLUGIN_CRON
							'recurrence' => 'schedule',
							// Use custom_corn_hook to hook into any cron process, anywhere in the plugin.
							'hook' => 'custom_cron_hook'
						) );
			}

		}


		/**
		 * Install plugin data
		 *
		 * @return Void
		 */
		public function db_install() {

			if ( class_exists( 'PLUGIN_DB' ) ) {

				$db = new PLUGIN_DB();
				$db->table = self::$plugin_table;
				$db->sql = "ID mediumint(9) NOT NULL AUTO_INCREMENT,
							date date NOT NULL,
							UNIQUE KEY ID (ID)";
				$db->build();
			}

			if (get_option( '_plugin_db_exist') == '0' ) {
			if (/** @scrutinizer ignore-call */ get_option( '_plugin_db_exist') == '0' ) {
				add_action( 'admin_notices', array( $this, 'db_error_msg' ) );
    add_action( 'admin_notices', array( $this, 'db_error_msg' ) );
			}

			$options = array(
				array( 'option_name', '__value__' ),
			);
			foreach ( $options as $value ) {
				update_option( $value[0], $value[1] );
    update_option( $value[0], $value[1] );
			}
		}


		/**
		 * Notice of DB
		 *
		 * @return Html
filter:
    dependency_paths: ["lib/*"]
		 */
		public function db_error_msg() { ?>

			<div class="notice notice-error is-dismissible">
				<p><?php _e( 'Database table Not installed correctly.', 'textdomain' ); ?></p>
				<p><?php /** @scrutinizer ignore-call */ _e( 'Database table Not installed correctly.', 'textdomain' ); ?></p>
 			</div>
			<?php
		}


		/**
		 * Uninstall plugin data
		 *
		 * @return Void
		 */
		public function db_uninstall() {

			$table_name = self::$plugin_table;

			global $wpdb;
			$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}$table_name" );

			$options = array(
				'_plugin_db_exist'
			);
			foreach ( $options as $value ) {
				delete_option( $value );
    delete_option( $value );
			}
		}


		/**
		 * CRON callback
		 *
		 * @return Void
		 */
		public function do_cron_job_function() {

			//Do cron function
		}


		/**
		 * Run CRON action
		 *
		 * @return Void
		 */
		public function custom_cron_hook_cb() {

			add_action( 'custom_cron_hook', array( $this, 'do_cron_job_function' ) );
   add_action( 'custom_cron_hook', array( $this, 'do_cron_job_function' ) );
		}


		/**
		 * Uninstall CRON hook
		 *
		 * @return Void
		 */
		public function cron_uninstall() {

			wp_clear_scheduled_hook( 'custom_cron_hook' );
   wp_clear_scheduled_hook( 'custom_cron_hook' );
		}


		/**
		 * Install Custom post types
		 *
		 * @return Void
		 */
		public function cpt() {

			if ( class_exists( 'PLUGIN_CPT' ) ) new PLUGIN_CPT();
		}


		/**
		 * Include scripts
		 *
		 * @return Void
		 */
		public function scripts() {

			if ( class_exists( 'PLUGIN_SCRIPT' ) ) new PLUGIN_SCRIPT();
		}


		/**
		 * Include settings pages
		 *
		 * @return Void
		 */
		public function settings() {

			if ( class_exists( 'PLUGIN_SETTINGS' ) ) new PLUGIN_SETTINGS();
		}


		/**
		 * Include widget classes
		 *
		 * @return Void
		 */
		public function widgets() {

			if ( class_exists( 'PLUGIN_WIDGET' ) ) new PLUGIN_WIDGET();
		}


		/**
		 *Include metabox classes
		 *
		 * @return Void
		 */
		public function metabox() {

			if ( class_exists( 'PLUGIN_METABOX' ) ) new PLUGIN_METABOX();
		}


		/**
		 * Include shortcode classes
		 *
		 * @return Void
		 */
		public function shortcode() {

			if ( class_exists( 'PLUGIN_SHORTCODE' ) ) new PLUGIN_SHORTCODE();
		}


		/**
		 * Instantiate REST API
		 *
		 * @return Void
		 */
		 public function rest_api() {

			 if ( class_exists( 'PLUGIN_CUSTOM_ROUTE' ) ) new PLUGIN_CUSTOM_ROUTE();
		 }


		 /**
 		  * Instantiate REST API
 		  *
 		  * @return Void
 		  */
		 public function prevent_unauthorized_rest_access( $result ) {
 		    // If a previous authentication check was applied,
 		    // pass that result along without modification.
 		    if ( true === $result || is_wp_error( $result ) ) {
 		    if ( true === $result || /** @scrutinizer ignore-call */ is_wp_error( $result ) ) {
 		        return $result;
 		    }

 		    // No authentication has been performed yet.
 		    // Return an error if user is not logged in.
 		    if ( ! is_user_logged_in() ) {
 		    if ( ! /** @scrutinizer ignore-call */ is_user_logged_in() ) {
 		        return new WP_Error(
filter:
    dependency_paths: ["lib/*"]
 		            'rest_not_logged_in',
 		            __( 'You are not currently logged in.' ),
               __( 'You are not currently logged in.' ),
 		            array( 'status' => 401 )
 		        );
 		    }

 		    return $result;
 		}


		/**
		 * Add the functionality files
		 * Available classes: PLUGIN_INSTALL, PLUGIN_DB, PLUGIN_METABOX, PLUGIN_QUERY, PLUGIN_SETTINGS, PLUGIN_SHORTCODE, PLUGIN_WIDGET
		 *
		 * @return Void
		 */
		public function functionality() {

			require_once( 'src/class-install.php' );
			require_once( 'src/class-db.php' );
			require_once( 'src/class-query.php' );
			require_once( 'src/class-settings.php' );
			require_once( 'src/class-widget.php' );
			require_once( 'src/class-metabox.php' );
			require_once( 'src/class-shortcode.php' );
			require_once( 'src/class-cpt.php' );
			require_once( 'src/class-rest.php' );
		}


		/**
		 * Call the dependency files
		 * Available classes: PLUGIN_CORN, PLUGIN_API, PLUGIN_TABLE, PLUGIN_AJAX, PLUGIN_UPLOAD, PLUGIN_SCRIPT
		 *
		 * @return Void
		 */
		public function helpers() {

			require_once( 'lib/class-cron.php' );
			require_once( 'lib/class-api.php' );
			require_once( 'lib/class-table.php' );
			require_once( 'lib/class-ajax.php' );
			require_once( 'lib/class-upload.php' );
			require_once( 'lib/class-script.php' );
		}


		/**
		 * Instantiate the plugin
		 *
		 * @return Void
		 */
		public function init() {

			$this->helpers();
			$this->functionality();

			register_activation_hook( PLUGIN_FILE, array( $this, 'db_install' ) );
   register_activation_hook( PLUGIN_FILE, array( $this, 'db_install' ) );
			register_activation_hook( PLUGIN_FILE, array( $this, 'cron_activation' ) );

			//remove the DB and CORN upon uninstallation
			//using $this won't work here.
			register_uninstall_hook( PLUGIN_FILE, array( 'PLUGIN_BUILD', 'db_uninstall' ) );
   register_uninstall_hook( PLUGIN_FILE, array( 'PLUGIN_BUILD', 'db_uninstall' ) );
			register_uninstall_hook( PLUGIN_FILE, array( 'PLUGIN_BUILD', 'cron_uninstall' ) );

			add_filter( 'rest_authentication_errors', array( $this, 'prevent_unauthorized_rest_access' ) );
   add_filter( 'rest_authentication_errors', array( $this, 'prevent_unauthorized_rest_access' ) );

			add_action( 'init', array( $this, 'installation' ) );
   add_action( 'init', array( $this, 'installation' ) );
			add_action( 'init', array( $this, 'custom_cron_hook_cb' ) );
			add_action( 'init', array( $this, 'cpt' ) );

			$this->scripts();
			$this->widgets();
			$this->metabox();
			$this->shortcode();
			$this->settings();

			//Alternative method: add_action( 'rest_api_init', array($this, 'rest_api') );
			$this->rest_api();
		}
	}
} ?>

nirjharlo / wp-plugin-framework

Push — master ( 1931dd...40edde )

PLUGIN_BUILD::prevent_unauthorized_rest_access() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
