Key_Validation_Notice::show_notification() - Code Metrics - Inspection of "Feature/1248 show notice if key not valid" - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#1249)

by Naveen

created 2021-01-07 04:22 UTC

Key_Validation_Notice::show_notification() A

↳ Parent: Key_Validation_Notice

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	17
rs	9.7
c	0
b	0
f	0

<?php

namespace Wordlift\Admin;

use Wordlift\Cache\Ttl_Cache;

/**
 * @since 3.28.0
 * @author Naveen Muthusamy <[email protected]>
 */
class Key_Validation_Notice {

	const CACHE_KEY = 'is_key_valid';

	const KEY_VALIDATION_NONCE_ACTION = 'wl_key_validation_notice_nonce';

	const KEY_VALIDATION_NONCE_PARAM = '_wl_key_validation_notice_nonce';

	const KEY_VALIDATION_NOTICE_PARAM = 'wl_key_validation_notice';

	const NOTIFICATION_OPTION_KEY = 'wordlift_key_validation_notification_shown';

	/**
	 * @var \Wordlift_Key_Validation_Service
	 */
	private $key_validation_service;

	/**
	 * @var \Wordlift_Configuration_Service
	 */
	private $configuration_service;
	/**
	 * @var Ttl_Cache
	 */
	private $ttl_cache_service;

	/**
	 * Key_Validation_Notice constructor.
	 *
	 * @param \Wordlift_Key_Validation_Service $key_validation_service
	 * @param \Wordlift_Configuration_Service $configuration_service
	 */
	public function __construct( $key_validation_service, $configuration_service ) {

		$this->key_validation_service = $key_validation_service;

		$this->configuration_service = $configuration_service;

		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification', 60 * 60 * 8 );

		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
			$this->display_key_validation_notice();
		}

		$that = $this;
		add_action( 'plugins_loaded', function () use ( $that ) {
			$that->notification_close_handler();
		} );
	}


	public function show_notification() {
		$settings_url = admin_url( 'admin.php?page=wl_configuration_admin_menu' );
		?>
        <div class="error">
            <p>
				<?php echo __( "Your WordLift key is not valid, please update the key in <a href='$settings_url'>WordLift Settings</a> or contact our support at [email protected].", 'wordlift' ); ?>
            </p>
            <p class="submit">

                <a class="button-secondary skip"
                   href="<?php echo esc_url( wp_nonce_url( add_query_arg( self::KEY_VALIDATION_NOTICE_PARAM, self::KEY_VALIDATION_NOTICE_PARAM )
					   , self::KEY_VALIDATION_NONCE_ACTION, self::KEY_VALIDATION_NONCE_PARAM ) ); ?>">
					<?php esc_html_e( 'Close', 'wordlift' ); ?></a>
            </p>
        </div>
		<?php
	}

	private function is_key_valid() {

		$key = $this->configuration_service->get_key();

		// Check cache if the result is present, if not get the results
		// save it and return the data.
		if ( $this->ttl_cache_service->get( self::CACHE_KEY ) !== null ) {
			return $this->ttl_cache_service->get( self::CACHE_KEY );
		}

		$is_valid = $this->key_validation_service->is_key_valid( $key );

		// when the cache is set, clear the notification flag.
		delete_option( self::NOTIFICATION_OPTION_KEY );

		$this->ttl_cache_service->put( self::CACHE_KEY, $is_valid );

		return $is_valid;
	}

	private function display_key_validation_notice() {
		$that = $this;
		add_action( 'admin_notices', function () use ( $that ) {

			$is_notification_shown = get_option( Key_Validation_Notice::NOTIFICATION_OPTION_KEY, false );

			$key = $that->configuration_service->get_key();

			if ( ! $key ) {
				// Dont show warning or make API call, return early.
				return;
			}

			if ( $that->is_key_valid() ) {
				return;
			}

			if ( $is_notification_shown ) {
				return;
			}

			$that->show_notification();

		} );
	}

	public function notification_close_handler() {
		if ( ! isset( $_GET['wl_key_validation_notice'] )
		     || ! isset( $_GET['_wl_key_validation_notice_nonce'] ) ) {
			return false;
		}
		$type  = (string) $_GET['wl_key_validation_notice'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$nonce = (string) $_GET['_wl_key_validation_notice_nonce'];

		if ( wp_verify_nonce( $nonce, self::KEY_VALIDATION_NONCE_ACTION )
		     && current_user_can( 'manage_options' ) ) {
			// close the notification.
			update_option( self::NOTIFICATION_OPTION_KEY, true );
		}
	}

	public static function remove_notification_flag() {
		delete_option( self::NOTIFICATION_OPTION_KEY );
	}

}



1			<?php
2
3			namespace Wordlift\Admin;
4
5			use Wordlift\Cache\Ttl_Cache;
6
7			/**
8			* @since 3.28.0
9			* @author Naveen Muthusamy <[email protected]>
10			*/
11			class Key_Validation_Notice {
12
13			const CACHE_KEY = 'is_key_valid';
14
15			const KEY_VALIDATION_NONCE_ACTION = 'wl_key_validation_notice_nonce';
16
17			const KEY_VALIDATION_NONCE_PARAM = '_wl_key_validation_notice_nonce';
18
19			const KEY_VALIDATION_NOTICE_PARAM = 'wl_key_validation_notice';
20
21			const NOTIFICATION_OPTION_KEY = 'wordlift_key_validation_notification_shown';
22
23			/**
24			* @var \Wordlift_Key_Validation_Service
25			*/
26			private $key_validation_service;
27
28			/**
29			* @var \Wordlift_Configuration_Service
30			*/
31			private $configuration_service;
32			/**
33			* @var Ttl_Cache
34			*/
35			private $ttl_cache_service;
36
37			/**
38			* Key_Validation_Notice constructor.
39			*
40			* @param \Wordlift_Key_Validation_Service $key_validation_service
41			* @param \Wordlift_Configuration_Service $configuration_service
42			*/
43			public function __construct( $key_validation_service, $configuration_service ) {
44
45			$this->key_validation_service = $key_validation_service;
46
47			$this->configuration_service = $configuration_service;
48
49			$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification', 60 * 60 * 8 );
50
51			if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
52			$this->display_key_validation_notice();
53			}
54
55			$that = $this;
56			add_action( 'plugins_loaded', function () use ( $that ) {
57			$that->notification_close_handler();
58			} );
59			}
60
61
62			public function show_notification() {
63			$settings_url = admin_url( 'admin.php?page=wl_configuration_admin_menu' );
64			?>
65			<div class="error">
66			<p>
67			<?php echo __( "Your WordLift key is not valid, please update the key in <a href='$settings_url'>WordLift Settings</a> or contact our support at [email protected].", 'wordlift' ); ?>
68			</p>
69			<p class="submit">
70
71			<a class="button-secondary skip"
72			href="<?php echo esc_url( wp_nonce_url( add_query_arg( self::KEY_VALIDATION_NOTICE_PARAM, self::KEY_VALIDATION_NOTICE_PARAM )
73			, self::KEY_VALIDATION_NONCE_ACTION, self::KEY_VALIDATION_NONCE_PARAM ) ); ?>">
74			<?php esc_html_e( 'Close', 'wordlift' ); ?></a>
75			</p>
76			</div>
77			<?php
78			}
79
80			private function is_key_valid() {
81
82			$key = $this->configuration_service->get_key();
83
84			// Check cache if the result is present, if not get the results
85			// save it and return the data.
86			if ( $this->ttl_cache_service->get( self::CACHE_KEY ) !== null ) {
87			return $this->ttl_cache_service->get( self::CACHE_KEY );
88			}
89
90			$is_valid = $this->key_validation_service->is_key_valid( $key );
91
92			// when the cache is set, clear the notification flag.
93			delete_option( self::NOTIFICATION_OPTION_KEY );
94
95			$this->ttl_cache_service->put( self::CACHE_KEY, $is_valid );
96
97			return $is_valid;
98			}
99
100			private function display_key_validation_notice() {
101			$that = $this;
102			add_action( 'admin_notices', function () use ( $that ) {
103
104			$is_notification_shown = get_option( Key_Validation_Notice::NOTIFICATION_OPTION_KEY, false );
105
106			$key = $that->configuration_service->get_key();
107
108			if ( ! $key ) {
109			// Dont show warning or make API call, return early.
110			return;
111			}
112
113			if ( $that->is_key_valid() ) {
114			return;
115			}
116
117			if ( $is_notification_shown ) {
118			return;
119			}
120
121			$that->show_notification();
122
123			} );
124			}
125
126			public function notification_close_handler() {
127			if ( ! isset( $_GET['wl_key_validation_notice'] )
128			\|\| ! isset( $_GET['_wl_key_validation_notice_nonce'] ) ) {
129			return false;
130			}
131			$type = (string) $_GET['wl_key_validation_notice'];
			0 ignored issues – show Unused Code introduced 2021-01-06 12:18 UTC by Report Bug Copy Issue Report `$type` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
132			$nonce = (string) $_GET['_wl_key_validation_notice_nonce'];
133
134			if ( wp_verify_nonce( $nonce, self::KEY_VALIDATION_NONCE_ACTION )
135			&& current_user_can( 'manage_options' ) ) {
136			// close the notification.
137			update_option( self::NOTIFICATION_OPTION_KEY, true );
138			}
139			}
140
141			public static function remove_notification_flag() {
142			delete_option( self::NOTIFICATION_OPTION_KEY );
143			}
144
145			}
146
147

insideout10 / wordlift-plugin

Pull Request — develop (#1249)

Key_Validation_Notice::show_notification() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like