Completed
Push — issues/1649 ( 047424...a7c938 )
by Ravinder
20:58
created

Give_License::plugin_page_notices()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 20
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 11
nc 3
nop 3
dl 0
loc 20
rs 9.4285
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 26 and the first side effect is on line 14.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
/**
3
 * Give License handler
4
 *
5
 * @package     Give
6
 * @subpackage  Admin/License
7
 * @copyright   Copyright (c) 2016, WordImpress
8
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
9
 * @since       1.0
10
 */
11
12
// Exit if accessed directly.
13
if ( ! defined( 'ABSPATH' ) ) {
14
	exit;
15
}
16
17
if ( ! class_exists( 'Give_License' ) ) :
18
19
	/**
20
	 * Give_License Class
21
	 *
22
	 * This class simplifies the process of adding license information to new Give add-ons.
23
	 *
24
	 * @since 1.0
25
	 */
26
	class Give_License {
27
28
		/**
29
		 * File
30
		 *
31
		 * @access private
32
		 * @since  1.0
33
		 *
34
		 * @var    string
35
		 */
36
		private $file;
37
38
		/**
39
		 * License
40
		 *
41
		 * @access private
42
		 * @since  1.0
43
		 *
44
		 * @var    string
45
		 */
46
		private $license;
47
48
		/**
49
		 * Item name
50
		 *
51
		 * @access private
52
		 * @since  1.0
53
		 *
54
		 * @var    string
55
		 */
56
		private $item_name;
57
58
		/**
59
		 * License Information object.
60
		 *
61
		 * @access private
62
		 * @since  1.7
63
		 *
64
		 * @var    object
65
		 */
66
		private $license_data;
67
68
		/**
69
		 * Item shortname
70
		 *
71
		 * @access private
72
		 * @since  1.0
73
		 *
74
		 * @var    string
75
		 */
76
		private $item_shortname;
77
78
		/**
79
		 * Version
80
		 *
81
		 * @access private
82
		 * @since  1.0
83
		 *
84
		 * @var    string
85
		 */
86
		private $version;
87
88
		/**
89
		 * Author
90
		 *
91
		 * @access private
92
		 * @since  1.0
93
		 *
94
		 * @var    string
95
		 */
96
		private $author;
97
98
		/**
99
		 * API URL
100
		 *
101
		 * @access private
102
		 * @since  1.0
103
		 *
104
		 * @var    string
105
		 */
106
		private $api_url = 'https://givewp.com/edd-sl-api/';
107
108
		/**
109
		 * Account URL
110
		 *
111
		 * @access private
112
		 * @since  1.7
113
		 *
114
		 * @var null|string
115
		 */
116
		private $account_url = 'https://givewp.com/my-account/';
117
118
		/**
119
		 * Ccheckout URL
120
		 *
121
		 * @access private
122
		 * @since  1.7
123
		 *
124
		 * @var null|string
125
		 */
126
		private $checkout_url = 'https://givewp.com/checkout/';
127
128
		/**
129
		 * Class Constructor
130
		 *
131
		 * Set up the Give License Class.
132
		 *
133
		 * @access public
134
		 * @since  1.0
135
		 *
136
		 * @param string $_file
137
		 * @param string $_item_name
138
		 * @param string $_version
139
		 * @param string $_author
140
		 * @param string $_optname
141
		 * @param string $_api_url
142
		 * @param string $_checkout_url
143
		 * @param string $_account_url
144
		 */
145
		public function __construct( $_file, $_item_name, $_version, $_author, $_optname = null, $_api_url = null, $_checkout_url = null, $_account_url = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $_optname is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
146
147
			$give_options = give_get_settings();
148
149
			$this->file             = $_file;
150
			$this->item_name        = $_item_name;
151
			$this->item_shortname   = 'give_' . preg_replace( '/[^a-zA-Z0-9_\s]/', '', str_replace( ' ', '_', strtolower( $this->item_name ) ) );
152
			$this->version          = $_version;
153
			$this->license          = isset( $give_options[ $this->item_shortname . '_license_key' ] ) ? trim( $give_options[ $this->item_shortname . '_license_key' ] ) : '';
154
			$this->license_data     = get_option( $this->item_shortname . '_license_active' );
155
			$this->author           = $_author;
156
			$this->api_url          = is_null( $_api_url ) ? $this->api_url : $_api_url;
157
			$this->checkout_url     = is_null( $_checkout_url ) ? $this->checkout_url : $_checkout_url;
158
			$this->account_url      = is_null( $_account_url ) ? $this->account_url : $_account_url;
159
			$this->auto_updater_obj = null;
0 ignored issues
show
Bug introduced by
The property auto_updater_obj does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
160
161
			// Setup hooks
162
			$this->includes();
163
			$this->hooks();
164
			$this->auto_updater();
165
		}
166
167
		/**
168
		 * Includes
169
		 *
170
		 * Include the updater class.
171
		 *
172
		 * @access private
173
		 * @since  1.0
174
		 *
175
		 * @return void
176
		 */
177
		private function includes() {
178
179
			if ( ! class_exists( 'EDD_SL_Plugin_Updater' ) ) {
180
				require_once 'admin/EDD_SL_Plugin_Updater.php';
181
			}
182
		}
183
184
		/**
185
		 * Hooks
186
		 *
187
		 * Setup license hooks.
188
		 *
189
		 * @access private
190
		 * @since  1.0
191
		 *
192
		 * @return void
193
		 */
194
		private function hooks() {
195
196
			// Register settings
197
			add_filter( 'give_settings_licenses', array( $this, 'settings' ), 1 );
198
199
			// Activate license key on settings save
200
			add_action( 'admin_init', array( $this, 'activate_license' ) );
201
202
			// Deactivate license key
203
			add_action( 'admin_init', array( $this, 'deactivate_license' ) );
204
205
			// Updater
206
			add_action( 'admin_init', array( $this, 'auto_updater' ), 0 );
207
			add_action( 'admin_notices', array( $this, 'notices' ) );
208
209
			// Check license weekly.
210
			add_action( 'give_weekly_scheduled_events', array( $this, 'weekly_license_check' ) );
211
			add_action( 'give_validate_license_when_site_migrated', array( $this, 'weekly_license_check' ) );
212
213
			// Check subscription weekly.
214
			add_action( 'give_weekly_scheduled_events', array( $this, 'weekly_subscription_check' ) );
215
			add_action( 'give_validate_license_when_site_migrated', array( $this, 'weekly_subscription_check' ) );
216
217
			// Show addon notice on plugin page.
218
			$plugin_name = end( explode( 'plugins/', $this->file ) );
0 ignored issues
show
Bug introduced by
explode('plugins/', $this->file) cannot be passed to end() as the parameter $array expects a reference.
Loading history...
219
			add_action( "after_plugin_row_{$plugin_name}", array( $this, 'plugin_page_notices' ), - 1, 3 );
220
221
		}
222
223
224
		/**
225
		 * Auto Updater
226
		 *
227
		 * @access private
228
		 * @since  1.0
229
		 *
230
		 * @return void
231
		 */
232
		public function auto_updater() {
233
234
			// Setup the updater
235
			$this->auto_updater_obj = new EDD_SL_Plugin_Updater(
236
				$this->api_url,
237
				$this->file,
238
				array(
239
					'version'   => $this->version,
240
					'license'   => $this->license,
241
					'item_name' => $this->item_name,
242
					'author'    => $this->author,
243
				)
244
			);
245
		}
246
247
		/**
248
		 * License Settings
249
		 *
250
		 * Add license field to settings.
251
		 *
252
		 * @access public
253
		 * @since  1.0
254
		 *
255
		 * @param  array $settings License settings.
256
		 *
257
		 * @return array           License settings.
258
		 */
259
		public function settings( $settings ) {
260
261
			$give_license_settings = array(
262
				array(
263
					'name'    => $this->item_name,
264
					'id'      => $this->item_shortname . '_license_key',
265
					'desc'    => '',
266
					'type'    => 'license_key',
267
					'options' => array(
268
						'license'      => get_option( $this->item_shortname . '_license_active' ),
269
						'shortname'    => $this->item_shortname,
270
						'item_name'    => $this->item_name,
271
						'api_url'      => $this->api_url,
272
						'checkout_url' => $this->checkout_url,
273
						'account_url'  => $this->account_url,
274
					),
275
					'size'    => 'regular',
276
				),
277
			);
278
279
			return array_merge( $settings, $give_license_settings );
280
		}
281
282
		/**
283
		 * License Settings Content
284
		 *
285
		 * Add Some Content to the Licensing Settings.
286
		 *
287
		 * @access public
288
		 * @since  1.0
289
		 *
290
		 * @param  array $settings License settings content.
291
		 *
292
		 * @return array           License settings content.
293
		 */
294
		public function license_settings_content( $settings ) {
295
296
			$give_license_settings = array(
297
				array(
298
					'name' => __( 'Add-on Licenses', 'give' ),
299
					'desc' => '<hr>',
300
					'type' => 'give_title',
301
					'id'   => 'give_title',
302
				),
303
			);
304
305
			return array_merge( $settings, $give_license_settings );
306
		}
307
308
		/**
309
		 * Activate License
310
		 *
311
		 * Activate the license key.
312
		 *
313
		 * @access public
314
		 * @since  1.0
315
		 *
316
		 * @return void
317
		 */
318
		public function activate_license() {
319
			// Bailout: Check if license key set of not.
320
			if ( ! isset( $_POST[ $this->item_shortname . '_license_key' ] ) ) {
321
				return;
322
			}
323
324
			// Security check.
325
			if ( ! wp_verify_nonce( $_REQUEST[ $this->item_shortname . '_license_key-nonce' ], $this->item_shortname . '_license_key-nonce' ) ) {
326
				wp_die( __( 'Nonce verification failed.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) );
327
			}
328
329
			// Check if user have correct permissions.
330
			if ( ! current_user_can( 'manage_give_settings' ) ) {
331
				return;
332
			}
333
334
			// Allow third party addon developers to handle license activation.
335
			if ( $this->__is_third_party_addon() ) {
336
				do_action( 'give_activate_license', $this );
337
338
				return;
339
			}
340
341
			// Delete previous license setting if a empty license key submitted.
342
			if ( empty( $_POST[ $this->item_shortname . '_license_key' ] ) ) {
343
				delete_option( $this->item_shortname . '_license_active' );
344
345
				return;
346
			}
347
348
			// Do not simultaneously activate add-ons if the user want to deactivate a specific add-on.
349
			foreach ( $_POST as $key => $value ) {
350
				if ( false !== strpos( $key, 'license_key_deactivate' ) ) {
351
					// Don't activate a key when deactivating a different key
352
					return;
353
				}
354
			}
355
356
			// Check if plugin previously installed.
357
			if ( $this->is_valid_license() ) {
358
				return;
359
			}
360
361
			// Get license key.
362
			$license = sanitize_text_field( $_POST[ $this->item_shortname . '_license_key' ] );
363
364
			// Bailout.
365
			if ( empty( $license ) ) {
366
				return;
367
			}
368
369
			// Delete previous license key from subscription if previously added.
370
			$this->__remove_license_key_from_subscriptions();
371
372
			// Data to send to the API
373
			$api_params = array(
374
				'edd_action' => 'activate_license', // never change from "edd_" to "give_"!
375
				'license'    => $license,
376
				'item_name'  => urlencode( $this->item_name ),
377
				'url'        => home_url(),
378
			);
379
380
			// Call the API
381
			$response = wp_remote_post(
382
				$this->api_url,
383
				array(
384
					'timeout'   => 15,
385
					'sslverify' => false,
386
					'body'      => $api_params,
387
				)
388
			);
389
390
			// Make sure there are no errors
391
			if ( is_wp_error( $response ) ) {
392
				return;
393
			}
394
395
			// Tell WordPress to look for updates
396
			set_site_transient( 'update_plugins', null );
397
398
			// Decode license data
399
			$license_data = json_decode( wp_remote_retrieve_body( $response ) );
400
			update_option( $this->item_shortname . '_license_active', $license_data );
401
402
			// Check subscription for license key and store this to db (if any).
403
			$this->__single_subscription_check();
404
		}
405
406
		/**
407
		 * Deactivate License
408
		 *
409
		 * Deactivate the license key.
410
		 *
411
		 * @access public
412
		 * @since  1.0
413
		 *
414
		 * @return void
415
		 */
416
		public function deactivate_license() {
417
418
			if ( ! isset( $_POST[ $this->item_shortname . '_license_key' ] ) ) {
419
				return;
420
			}
421
422
			if ( ! wp_verify_nonce( $_REQUEST[ $this->item_shortname . '_license_key-nonce' ], $this->item_shortname . '_license_key-nonce' ) ) {
423
				wp_die( __( 'Nonce verification failed.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) );
424
			}
425
426
			if ( ! current_user_can( 'manage_give_settings' ) ) {
427
				return;
428
			}
429
430
			// Allow third party add-on developers to handle license deactivation.
431
			if ( $this->__is_third_party_addon() ) {
432
				do_action( 'give_deactivate_license', $this );
433
434
				return;
435
			}
436
437
			// Run on deactivate button press
438
			if ( isset( $_POST[ $this->item_shortname . '_license_key_deactivate' ] ) ) {
439
440
				// Data to send to the API
441
				$api_params = array(
442
					'edd_action' => 'deactivate_license', // never change from "edd_" to "give_"!
443
					'license'    => $this->license,
444
					'item_name'  => urlencode( $this->item_name ),
445
					'url'        => home_url(),
446
				);
447
448
				// Call the API
449
				$response = wp_remote_post(
450
					$this->api_url,
451
					array(
452
						'timeout'   => 15,
453
						'sslverify' => false,
454
						'body'      => $api_params,
455
					)
456
				);
457
458
				// Make sure there are no errors
459
				if ( is_wp_error( $response ) ) {
460
					return;
461
				}
462
463
				// Decode the license data
464
				$license_data = json_decode( wp_remote_retrieve_body( $response ) );
465
466
				// Ensure deactivated successfully.
467
				if ( isset( $license_data->success ) ) {
468
469
					// Remove license data.
470
					delete_option( $this->item_shortname . '_license_active' );
471
					give_delete_option( $this->item_shortname . '_license_key' );
472
473
					// Remove license key from subscriptions if exist.
474
					$this->__remove_license_key_from_subscriptions();
475
476
				}
477
			}// End if().
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
478
		}
479
480
		/**
481
		 * Check if license key is valid once per week.
482
		 *
483
		 * @access public
484
		 * @since  1.7
485
		 *
486
		 * @return bool|void
487
		 */
488
		public function weekly_license_check() {
489
490
			if ( ! empty( $_POST['give_settings'] ) ) {
491
				// Don't fire when saving settings
492
				return false;
493
			}
494
495
			if ( empty( $this->license ) ) {
496
				return false;
497
			}
498
499
			// Allow third party add-on developers to handle their license check.
500
			if ( $this->__is_third_party_addon() ) {
501
				do_action( 'give_weekly_license_check', $this );
502
503
				return false;
504
			}
505
506
			// Data to send in our API request.
507
			$api_params = array(
508
				'edd_action' => 'check_license',
509
				'license'    => $this->license,
510
				'item_name'  => urlencode( $this->item_name ),
511
				'url'        => home_url(),
512
			);
513
514
			// Call the API.
515
			$response = wp_remote_post(
516
				$this->api_url,
517
				array(
518
					'timeout'   => 15,
519
					'sslverify' => false,
520
					'body'      => $api_params,
521
				)
522
			);
523
524
			// Make sure the response came back okay.
525
			if ( is_wp_error( $response ) ) {
526
				return false;
527
			}
528
529
			$license_data = json_decode( wp_remote_retrieve_body( $response ) );
530
			update_option( $this->item_shortname . '_license_active', $license_data );
531
		}
532
533
		/**
534
		 * Check subscription validation once per week
535
		 *
536
		 * @access public
537
		 * @since  1.7
538
		 *
539
		 * @return bool|void
540
		 */
541
		public function weekly_subscription_check() {
542
543
			if ( ! empty( $_POST['give_settings'] ) ) {
544
				// Don't fire when saving settings
545
				return false;
546
			}
547
548
			// Remove old subscription data.
549
			if ( absint( get_option( '_give_subscriptions_edit_last', true ) ) < current_time( 'timestamp', 1 ) ) {
550
				delete_option( 'give_subscriptions' );
551
				update_option( '_give_subscriptions_edit_last', strtotime( '+ 1 day', current_time( 'timestamp', 1 ) ) );
552
			}
553
554
			if ( empty( $this->license ) ) {
555
				return false;
556
			}
557
558
			// Allow third party add-on developers to handle their subscription check.
559
			if ( $this->__is_third_party_addon() ) {
560
				do_action( 'give_weekly_subscription_check', $this );
561
562
				return false;
563
			}
564
565
			// Delete subscription notices show blocker.
566
			$this->__remove_license_notices_show_blocker();
567
568
			// Data to send in our API request.
569
			$api_params = array(
570
				// Do not get confused with edd_action check_subscription.
571
				// By default edd software licensing api does not have api to check subscription.
572
				// This is a custom feature to check subscriptions.
573
				'edd_action' => 'check_subscription',
574
				'license'    => $this->license,
575
				'item_name'  => urlencode( $this->item_name ),
576
				'url'        => home_url(),
577
			);
578
579
			// Call the API
580
			$response = wp_remote_post(
581
				$this->api_url,
582
				array(
583
					'timeout'   => 15,
584
					'sslverify' => false,
585
					'body'      => $api_params,
586
				)
587
			);
588
589
			// Make sure the response came back okay.
590
			if ( is_wp_error( $response ) ) {
591
				return false;
592
			}
593
594
			$subscription_data = json_decode( wp_remote_retrieve_body( $response ), true );
595
596
			if ( ! empty( $subscription_data['success'] ) && absint( $subscription_data['success'] ) ) {
597
				$subscriptions = get_option( 'give_subscriptions', array() );
598
599
				// Update subscription data only if subscription does not exist already.
600
				if ( ! array_key_exists( $subscription_data['id'], $subscriptions ) ) {
601
					$subscriptions[ $subscription_data['id'] ]             = $subscription_data;
602
					$subscriptions[ $subscription_data['id'] ]['licenses'] = array();
603
				}
604
605
				// Store licenses for subscription.
606
				if ( ! in_array( $this->license, $subscriptions[ $subscription_data['id'] ]['licenses'] ) ) {
607
					$subscriptions[ $subscription_data['id'] ]['licenses'][] = $this->license;
608
				}
609
610
				update_option( 'give_subscriptions', $subscriptions );
611
			}
612
		}
613
614
		/**
615
		 * Check if license key is part of subscription or not
616
		 *
617
		 * @access private
618
		 * @since  1.7
619
		 *
620
		 * @return bool|void
621
		 */
622
		private function __single_subscription_check() {
623
			// Do not fire if license key is not set.
624
			if ( ! isset( $_POST[ $this->item_shortname . '_license_key' ] ) ) {
625
				return false;
626
			}
627
628
			if ( empty( $this->license ) ) {
629
				return false;
630
			}
631
632
			// Data to send in our API request.
633
			$api_params = array(
634
				// Do not get confused with edd_action check_subscription.
635
				// By default edd software licensing api does not have api to check subscription.
636
				// This is a custom feature to check subscriptions.
637
				'edd_action' => 'check_subscription',
638
				'license'    => $this->license,
639
				'item_name'  => urlencode( $this->item_name ),
640
				'url'        => home_url(),
641
			);
642
643
			// Call the API
644
			$response = wp_remote_post(
645
				$this->api_url,
646
				array(
647
					'timeout'   => 15,
648
					'sslverify' => false,
649
					'body'      => $api_params,
650
				)
651
			);
652
653
			// Make sure the response came back okay.
654
			if ( is_wp_error( $response ) ) {
655
				return false;
656
			}
657
658
			$subscription_data = json_decode( wp_remote_retrieve_body( $response ), true );
659
660
			if ( ! empty( $subscription_data['success'] ) && absint( $subscription_data['success'] ) ) {
661
				$subscriptions = get_option( 'give_subscriptions', array() );
662
663
				// Update subscription data only if subscription does not exist already.
664
				if ( ! array_key_exists( $subscription_data['id'], $subscriptions ) ) {
665
					$subscriptions[ $subscription_data['id'] ]             = $subscription_data;
666
					$subscriptions[ $subscription_data['id'] ]['licenses'] = array();
667
				}
668
669
				// Store licenses for subscription.
670
				if ( ! in_array( $this->license, $subscriptions[ $subscription_data['id'] ]['licenses'] ) ) {
671
					$subscriptions[ $subscription_data['id'] ]['licenses'][] = $this->license;
672
				}
673
674
				update_option( 'give_subscriptions', $subscriptions );
675
			}
676
		}
677
678
		/**
679
		 * Admin notices for errors
680
		 *
681
		 * @access public
682
		 * @since  1.0
683
		 *
684
		 * @return void
685
		 */
686
		public function notices() {
687
688
			if ( ! current_user_can( 'manage_give_settings' ) ) {
689
				return;
690
			}
691
692
			// Do not show licenses notices on license tab.
693
			if ( 'licenses' === give_get_current_setting_tab() ) {
694
				return;
695
			}
696
697
			static $showed_invalid_message;
698
			static $showed_subscriptions_message;
699
			static $addon_license_key_in_subscriptions;
700
701
			// Set default value.
702
			$addon_license_key_in_subscriptions = ! empty( $addon_license_key_in_subscriptions ) ? $addon_license_key_in_subscriptions : array();
703
			$messages                           = array();
704
705
			if (
706
				empty( $this->license )
707
				&& ! $this->__is_notice_dismissed( 'general' )
708
				&& empty( $showed_invalid_message )
709
			) {
710
				$messages['general']    = sprintf(
711
					__( 'You have invalid or expired license keys for one or more Give Add-ons. Please go to the <a href="%s">licenses page</a> to correct this issue.', 'give' ),
712
					admin_url( 'edit.php?post_type=give_forms&page=give-settings&tab=licenses' )
713
				);
714
				$showed_invalid_message = true;
715
716
			}
717
718
			// Get subscriptions.
719
			$subscriptions = get_option( 'give_subscriptions' );
720
721
			// Show subscription messages.
722
			if ( ! empty( $subscriptions ) && ! $showed_subscriptions_message ) {
723
724
				foreach ( $subscriptions as $subscription ) {
725
					// Subscription expires timestamp.
726
					$subscription_expires = strtotime( $subscription['expires'] );
727
728
					// Start showing subscriptions message before one week of renewal date.
729
					if ( strtotime( '- 7 days', $subscription_expires ) > current_time( 'timestamp', 1 ) ) {
730
						continue;
731
					}
732
733
					// Check if subscription message already exist in messages.
734
					if ( array_key_exists( $subscription['id'], $messages ) ) {
735
						continue;
736
					}
737
738
					if ( ( ! $this->__is_notice_dismissed( $subscription['id'] ) && 'active' !== $subscription['status'] ) ) {
739
740
						if ( strtotime( $subscription['expires'] ) < current_time( 'timestamp', 1 ) ) {// Check if license already expired.
741
							$messages[ $subscription['id'] ] = sprintf(
742
								__( 'Your Give add-on license expired for payment <a href="%1$s" target="_blank">#%2$d</a>. <a href="%3$s" target="_blank">Click to renew an existing license</a> or <a href="%4$s">Click here if already renewed</a>.', 'give' ),
743
								urldecode( $subscription['invoice_url'] ),
744
								$subscription['payment_id'],
745
								"{$this->checkout_url}?edd_license_key={$subscription['license_key']}&utm_campaign=admin&utm_source=licenses&utm_medium=expired",
746
								esc_url( add_query_arg( '_give_hide_license_notices_permanently', $subscription['id'], $_SERVER['REQUEST_URI'] ) )
747
							);
748
						} else {
749
							$messages[ $subscription['id'] ] = sprintf(
750
								__( 'Your Give add-on license will expire in %1$s for payment <a href="%2$s" target="_blank">#%3$d</a>. <a href="%4$s" target="_blank">Click to renew an existing license</a> or <a href="%5$s">Click here if already renewed</a>.', 'give' ),
751
								human_time_diff( current_time( 'timestamp', 1 ), strtotime( $subscription['expires'] ) ),
752
								urldecode( $subscription['invoice_url'] ),
753
								$subscription['payment_id'],
754
								"{$this->checkout_url}?edd_license_key={$subscription['license_key']}&utm_campaign=admin&utm_source=licenses&utm_medium=expired",
755
								esc_url( add_query_arg( '_give_hide_license_notices_permanently', $subscription['id'], $_SERVER['REQUEST_URI'] ) )
756
							);
757
						}
758
					}
759
760
					// Stop validation for these license keys.
761
					$addon_license_key_in_subscriptions = array_merge( $addon_license_key_in_subscriptions, $subscription['licenses'] );
762
				}// End foreach().
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
763
				$showed_subscriptions_message = true;
764
			}// End if().
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
765
766
			// Show non subscription addon messages.
767
			if (
768
				! in_array( $this->license, $addon_license_key_in_subscriptions )
769
				&& ! $this->__is_notice_dismissed( 'general' )
770
				&& ! $this->is_valid_license()
771
				&& empty( $showed_invalid_message )
772
			) {
773
774
				$messages['general']    = sprintf(
775
					__( 'You have invalid or expired license keys for one or more Give Add-ons. Please go to the <a href="%s">licenses page</a> to correct this issue.', 'give' ),
776
					admin_url( 'edit.php?post_type=give_forms&page=give-settings&tab=licenses' )
777
				);
778
				$showed_invalid_message = true;
779
780
			}
781
782
			// Print messages.
783
			if ( ! empty( $messages ) ) {
784
				foreach ( $messages as $notice_id => $message ) {
785
786
					echo sprintf(
787
						'<div class="notice notice-error is-dismissible give-license-notice" data-dismiss-notice-shortly="%1$s"><p>%2$s</p></div>',
788
						esc_url( add_query_arg( '_give_hide_license_notices_shortly', $notice_id, $_SERVER['REQUEST_URI'] ) ),
789
						$message
790
					);
791
				}
792
			}
793
		}
794
795
		/**
796
		 * Check if license is valid or not.
797
		 *
798
		 * @access public
799
		 * @since  1.7
800
		 *
801
		 * @return bool
802
		 */
803
		public function is_valid_license() {
804
			if ( apply_filters( 'give_is_valid_license', ( is_object( $this->license_data ) && ! empty( $this->license_data ) && property_exists( $this->license_data, 'license' ) && 'valid' === $this->license_data->license ) ) ) {
805
				return true;
806
			}
807
808
			return false;
809
		}
810
811
		/**
812
		 * Check if license is valid or not.
813
		 *
814
		 * @access private
815
		 * @since  1.7
816
		 *
817
		 * @return bool
818
		 */
819
		private function __is_third_party_addon() {
820
			return ( false === strpos( $this->api_url, 'givewp.com/' ) );
821
		}
822
823
		/**
824
		 * Remove license key from subscription.
825
		 *
826
		 * This function mainly uses when admin user deactivate license key,
827
		 * then we do not need subscription information for that license key.
828
		 *
829
		 * @access private
830
		 * @since  1.7
831
		 *
832
		 * @return void|bool
833
		 */
834
		private function __remove_license_key_from_subscriptions() {
835
			$subscriptions = get_option( 'give_subscriptions', array() );
836
837
			// Bailout.
838
			if ( empty( $this->license ) ) {
839
				return false;
840
			}
841
842
			if ( ! empty( $subscriptions ) ) {
843
				foreach ( $subscriptions as $subscription_id => $subscription ) {
844
					$license_index = array_search( $this->license, $subscription['licenses'] );
845
					if ( false !== $license_index ) {
846
						// Remove license key.
847
						unset( $subscriptions[ $subscription_id ]['licenses'][ $license_index ] );
848
849
						// Rearrange license keys.
850
						$subscriptions[ $subscription_id ]['licenses'] = array_values( $subscriptions[ $subscription_id ]['licenses'] );
851
852
						// Update subscription information.
853
						update_option( 'give_subscriptions', $subscriptions );
854
						break;
855
					}
856
				}
857
			}
858
		}
859
860
		/**
861
		 * Remove license notices show blocker.
862
		 *
863
		 * @access private
864
		 * @since  1.7
865
		 *
866
		 * @return void
867
		 */
868
		private function __remove_license_notices_show_blocker() {
869
			global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
870
871
			// Delete permanent notice blocker.
872
			$wpdb->query(
873
				$wpdb->prepare(
874
					"
875
					DELETE FROM $wpdb->usermeta
876
					WHERE meta_key
877
					LIKE '%%%s%%'
878
					",
879
					'_give_hide_license_notices_permanently'
880
				)
881
			);
882
883
			// Delete short notice blocker.
884
			$wpdb->query(
885
				$wpdb->prepare(
886
					"
887
					DELETE FROM $wpdb->options
888
					WHERE option_name
889
					LIKE '%%%s%%'
890
					",
891
					'__give_hide_license_notices_shortly_'
892
				)
893
			);
894
		}
895
896
		/**
897
		 * Check if notice dismissed by admin user or not.
898
		 *
899
		 * @access private
900
		 * @since  1.7
901
		 *
902
		 * @param  int $notice_id Notice ID.
903
		 *
904
		 * @return bool
905
		 */
906
		private function __is_notice_dismissed( $notice_id ) {
907
			$current_user        = wp_get_current_user();
908
			$is_notice_dismissed = false;
909
910
			// Ge is notice dismissed permanently.
911
			$already_dismiss_notices = ( $already_dismiss_notices = get_user_meta( $current_user->ID, '_give_hide_license_notices_permanently', true ) )
912
				? $already_dismiss_notices
913
				: array();
914
915
			if (
916
				in_array( $notice_id, $already_dismiss_notices )
917
				|| Give_Cache::get( "_give_hide_license_notices_shortly_{$current_user->ID}_{$notice_id}", true )
918
			) {
919
				$is_notice_dismissed = true;
920
			}
921
922
			return $is_notice_dismissed;
923
		}
924
925
926
		/**
927
		 * @param $plugin_file
928
		 * @param $plugin_data
929
		 * @param $status
930
		 *
931
		 * @return bool
0 ignored issues
show
Documentation introduced by
Should the return type not be false|null?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
932
		 */
933
		public function plugin_page_notices( $plugin_file, $plugin_data, $status ) {
0 ignored issues
show
Unused Code introduced by
The parameter $plugin_data is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $status is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
934
			// Bailout.
935
			if ( $this->is_valid_license() ) {
936
				return false;
937
			}
938
939
			// Remove already attached notices.
940
			remove_action( "after_plugin_row_$plugin_file", array(
941
				$this->auto_updater_obj,
942
				'show_update_notification',
943
			) );
944
			remove_action( "after_plugin_row_$plugin_file", 'wp_plugin_update_row' );
945
946
			$update_notice_wrap = '<tr class="plugin-update-tr give-invalid-license active"><td colspan="3" class="plugin-update colspanchange"><div class="notice inline notice-warning notice-alt"><p><span class="dashicons dashicons-info"></span> %s</p></div></td></tr>';
947
			$message            = $this->license_state_message();
948
949
			if ( ! empty( $message['message'] ) ) {
950
				echo sprintf( $update_notice_wrap, $message['message'] );
951
			}
952
		}
953
954
955
		/**
956
		 * Get message related to license state.
957
		 *
958
		 * @since  1.8.7
959
		 * @access public
960
		 * @return array
961
		 */
962
		public function license_state_message() {
963
			$message_data = array();
964
965
			if ( ! $this->is_valid_license() ) {
966
				$message_data['message'] = sprintf(
967
					'Please <a href=""%s">activate your license</a> for updates and support',
968
					esc_url( admin_url( 'edit.php?post_type=give_forms&page=give-settings&tab=licenses' ) )
969
				);
970
			}
971
972
			return $message_data;
973
		}
974
	}
975
976
endif; // end class_exists check
977