class-ld-addons-updater.php
35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
<?php
/**
* Handles WordPress logic for Addon updates
*
* @since 2.5.4
*
* @package LearnDash\Add-on
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* BitBucket API
*/
require_once LEARNDASH_LMS_PLUGIN_DIR . 'includes/class-ld-bitbucket-api.php';
if ( ! class_exists( 'LearnDash_Addon_Updater' ) ) {
/**
* Class for handling the LearnDash Add-on updates.
*/
class LearnDash_Addon_Updater {
/**
* Static instance variable to ensure
* only one instance of class is used.
*
* @since 1.0.0
*
* @var object $instance.
*/
protected static $instance = null;
/**
* Holds the in process data. This is read in from the $option_key.
*
* @var array $data;
*/
private $data = null;
/**
* Holds reference to BitBucket API object. This is how the updatero class
* retrieves the repositories and add-on updates.
*
* @var object $pp_api
*/
private $bb_api = null;
/**
* This is the wp_options key used to store the $data related to
* the repositories and status.
*
* @var string $options_key
*/
private $options_key = 'learndash-repositories';
/**
* Hold temporary status when installing an add-on.
*
* @var boolean $_doing_install_upgrade_slug
*/
private $_doing_install_upgrade_slug = false;
/**
* Setting for the number of minutes to cache repo check. This
* is to prevent too frequent checks again BitBucket servers.
*
* @var integer $repo_cache_time_limit value in minutes.
*/
private $repo_cache_time_limit = 5;
/**
* Setting for the number of minutes to cache readme check. This
* is to prevent too frequent checks again BitBucket servers.
*
* @var integer $readme_cache_time_limit value in minutes.
*/
private $readme_cache_time_limit = 8;
/**
* LearnDash_Addon_Updater constructor.
*/
public function __construct() {
$this->load_repositories_options();
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'pre_set_site_transient_update_plugins' ) );
add_filter( 'site_transient_update_plugins', array( $this, 'pre_set_site_transient_update_plugins' ) );
add_filter( 'plugins_api', array( $this, 'plugins_api_filter' ), 50, 3 );
add_filter( 'upgrader_pre_download', array( $this, 'upgrader_pre_download_filter' ), 10, 3 );
add_filter( 'upgrader_source_selection', array( $this, 'upgrader_source_selection_filter' ), 10, 3 );
add_action( 'upgrader_process_complete', array( $this, 'upgrader_process_complete_action' ), 10, 2 );
add_filter( 'update_plugin_complete_actions', array( $this, 'update_plugin_complete_actions' ) );
add_filter( 'install_plugin_complete_actions', array( $this, 'install_plugin_complete_actions' ), 10, 3 );
add_action( 'admin_notices', array( $this, 'admin_notice_upgrade_notice' ) );
}
/**
* Get or create instance object of class.
*
* @since 1.0.0
*/
final public static function get_instance() {
if ( ! isset( static::$instance ) ) {
static::$instance = new self();
}
return static::$instance;
}
/**
* Called when the add-on plugin is upgraded. From the page the user is shown links at the
* bottom of the page to return to the plugin page or the WordPress updates page. If the user started
* as the LearnDash Add-ons page we will add the 'ld-return-addons' query string parameter. This is
* used to return the user.
*
* @since 2.5.5
*
* @param array $update_actions Array.
*/
public function update_plugin_complete_actions( $update_actions = array() ) {
if ( ( isset( $_GET['ld-return-addons'] ) ) && ( ! empty( $_GET['ld-return-addons'] ) ) ) {
// If we have the 'ld-return-addons' element this means we need to go back there only.
$return_url = esc_attr( $_GET['ld-return-addons'] );
// we clear out the actions because we only want to show our own.
$update_actions = array();
$update_actions['ld-addons-page'] = '<a href="' . $return_url . '" target="_parent">' . esc_html__( 'Return to LearnDash Add-ons Page', 'learndash' ) . '</a>';
}
return $update_actions;
}
/**
* Called when the add-on plugin is installed. From the page the user is shown links at the
* bottom of the page to return to the plugin page or the WordPress updates page. If the user started
* as the LearnDash Add-ons page we will add the 'ld-return-addons' query string parameter. This is
* used to return the user.
*
* @param array $install_actions Array.
* @param object $api Object.
* @param string $plugin_file String.
*
* @return array
*
* @since 2.5.5
*/
public function install_plugin_complete_actions( $install_actions, $api, $plugin_file = '' ) {
if ( ( isset( $_GET['ld-return-addons'] ) ) && ( ! empty( $_GET['ld-return-addons'] ) ) ) {
// If we have the 'ld-return-addons' element this means we need to go back there only.
$return_url = esc_attr( $_GET['ld-return-addons'] );
// we clear out the actions because we only want to show our own.
$install_actions = array();
if ( ! empty( $plugin_file ) ) {
$plugin_slug = dirname( $plugin_file );
if ( ! empty( $plugin_slug ) ) {
$plugin_readme_file = $this->bb_api->get_addon_directory() . '/' . $plugin_slug . '_readme.txt';
if ( ( ! empty( $plugin_readme_file ) ) && ( file_exists( $plugin_readme_file ) ) ) {
// Update the installed plugin readme.txt.
$plugin_dir = trailingslashit( WP_PLUGIN_DIR ) . $plugin_slug;
if ( ( file_exists( $plugin_dir ) ) && ( is_writable( $plugin_dir ) ) ) {
$copy_ret = @copy( $plugin_readme_file, $plugin_dir . '/readme.txt' );
}
}
}
$install_actions['activate_plugin'] = '<a class="button button-primary" href="' . wp_nonce_url( 'plugins.php?action=activate&plugin=' . urlencode( $plugin_file ), 'activate-plugin_' . $plugin_file ) . '" target="_parent">' . __( 'Activate Plugin', 'learndash' ) . '</a>';
}
$install_actions['ld-addons-page'] = '<a href="' . $return_url . '" target="_parent">' . esc_html__( 'Return to LearnDash Add-ons Page', 'learndash' ) . '</a>';
}
return $install_actions;
}
/**
* Support for admin notice header for "Upgrade Notice Admin" header
* from readme.txt.
*
* @since 3.1.4
*/
public function admin_notice_upgrade_notice() {
static $notices_shown = array();
$current_screen_id = get_current_screen()->id;
if ( 'admin_page_learndash_lms_addons' === $current_screen_id ) {
return;
}
if ( ( isset( $this->data['updates'] ) ) && ( ! empty( $this->data['updates'] ) ) ) {
foreach ( $this->data['updates'] as $plugin_update ) {
if ( isset( $notices_shown[ $plugin_update->slug ] ) ) {
continue;
}
if ( ( isset( $this->data['plugins'][ $plugin_update->slug ]['upgrade_notice_admin']['content_formatted'] ) ) && ( ! empty( $this->data['plugins'][ $plugin_update->slug ]['upgrade_notice_admin']['content_formatted'] ) ) ) {
/**
* Filters whether to show the upgrade notice in admin banner.
*
* By default this will show on all pages.
*
* @since 3.1.4
*
* @param boolean $show_notice Whether to show the update notice.
* @param string $plugin_slug The slug of the plugin.
*/
if ( apply_filters( 'learndash_upgrade_notice_admin_show', true, $plugin_update->slug ) ) {
$notices_shown[ $plugin_update->slug ] = $plugin_update->slug;
?><div class="notice notice-error notice-alt is-dismissible ld-plugin-update-notice">
<?php
echo wp_kses_post( $this->data['plugins'][ $plugin_update->slug ]['upgrade_notice_admin']['content_formatted'] );
?>
</div>
<?php
}
}
}
}
}
/**
* This is called from the plugin listing page. This hook lets of add supplemental information
* to the plugin row. Like the Upgrade Notice.
*
* @since 2.5.5
*
* @param object $current_plugin_metadata Current meta data.
* @param object $new_plugin_metadata New meta data.
*/
public function show_upgrade_notification( $current_plugin_metadata, $new_plugin_metadata ) {
static $notice_slugs = array();
$plugin_slug = '';
if ( isset( $current_plugin_metadata['slug'] ) ) {
$plugin_slug = esc_attr( $current_plugin_metadata['slug'] );
}
if ( ( ! empty( $plugin_slug ) ) && ( ! in_array( $plugin_slug, $notice_slugs ) ) ) {
if ( ( isset( $this->data['updates'] ) ) && ( ! empty( $this->data['updates'] ) ) ) {
foreach ( $this->data['updates'] as $update_plugin ) {
if ( $update_plugin->slug !== $plugin_slug ) {
continue;
}
if ( ( isset( $this->data['plugins'][ $plugin_slug ]['upgrade_notice']['content_formatted'] ) ) && ( ! empty( $this->data['plugins'][ $plugin_slug ]['upgrade_notice']['content_formatted'] ) ) ) {
$notice_slugs[ $plugin_slug ] = $plugin_slug;
$plugin_readme_update_notice = str_replace( array( '<p>', '</p>' ), array( '', '<br />' ), $this->data['plugins'][ $plugin_slug ]['upgrade_notice']['content_formatted'] );
echo '<p class="ld-plugin-update-notice">' . wp_kses_post( $plugin_readme_update_notice );
}
}
}
}
}
/**
* PluginAPI Filter.
*
* @param array $data Array.
* @param string $action String.
* @param null $args Null.
*
* @return array|mixed|object
*/
public function plugins_api_filter( $data, $action = '', $args = null ) {
if ( ( 'plugin_information' !== $action ) || ( is_null( $args ) ) || ( ! isset( $args->slug ) ) ) {
return $data;
}
$this->get_addon_plugins();
if ( isset( $this->data['plugins'][ $args->slug ] ) ) {
$data = json_decode( wp_json_encode( $this->data['plugins'][ $args->slug ] ), false );
if ( ( property_exists( $data, 'sections' ) ) && ( is_object( $data->sections ) ) ) {
$data->sections = (array) $data->sections;
}
if ( ( property_exists( $data, 'banners' ) ) && ( is_object( $data->banners ) ) ) {
$data->banners = (array) $data->banners;
}
// We already have the obj but we update the BB download URL just in case.
$data->download_link = $this->bb_api->get_bitbucket_repository_download_url( $data->slug );
$data->download_link = $this->bb_api->setup_url_params( $data->download_link );
}
return $data;
}
/**
* Upgrader Pre-Download filter.
*
* @param string $action String.
* @param string $download_url String.
* @param object $updater updater instance.
*
* @return mixed
*/
public function upgrader_pre_download_filter( $action, $download_url, $updater ) {
$this->load_repositories_options();
$repo_download_base_url = $this->bb_api->get_download_base_url();
if ( ( ! empty( $repo_download_base_url ) ) && ( strncasecmp( $repo_download_base_url, $download_url, strlen( $repo_download_base_url ) ) === 0 ) ) {
$plugin_url = str_replace( trailingslashit( $this->bb_api->get_download_base_url() ), '', $download_url );
$plugin_url_parts = explode( '/', $plugin_url );
if ( isset( $this->data['plugins'][ $plugin_url_parts[0] ] ) ) {
$this->_doing_install_upgrade_slug = $plugin_url_parts[0];
add_filter( 'upgrader_source_selection', array( $this, 'upgrader_source_selection_filter' ), 10, 3 );
}
} else {
$this->_doing_install_upgrade_slug = false;
remove_filter( 'upgrader_source_selection', array( $this, 'upgrader_source_selection_filter' ), 10, 3 );
}
return $action;
}
/**
* Upgrader Source Selection Filter.
*
* @param object $source instance.
* @param object $remote_source instance.
* @param object $upgrader nstance of WP_Upgrader_Skin.
*
* @return string|\WP_Error
*/
public function upgrader_source_selection_filter( $source, $remote_source, $upgrader ) {
global $wp_filesystem;
// Basic sanity checks.
if ( ! isset( $source, $remote_source, $upgrader, $upgrader->skin, $wp_filesystem ) ) {
return $source;
}
if ( ! empty( $this->_doing_install_upgrade_slug ) ) {
// Rename the source to match the existing directory.
$corrected_source = trailingslashit( $remote_source ) . $this->_doing_install_upgrade_slug . '/';
if ( $source !== $corrected_source ) {
$upgrader->skin->feedback(
sprintf(
'Renaming %s to %s…',
'<span class="code">' . basename( $source ) . '</span>',
'<span class="code">' . $this->_doing_install_upgrade_slug . '</span>'
)
);
if ( $wp_filesystem->move( $source, $corrected_source, true ) ) {
$upgrader->skin->feedback( esc_html__( 'Directory successfully renamed.', 'learndash' ) );
return $corrected_source;
} else {
return new WP_Error(
'learndash-failed',
__( 'Unable to rename the update to match the existing directory.', 'learndash' )
);
}
}
}
return $source;
}
/**
* Upgrader Process Complete Action.
*
* @param object $upgrader Upgrader instance.
* @param array $args Array.
*
* @return mixed
*/
public function upgrader_process_complete_action( $upgrader, $args = array() ) {
if ( ( isset( $args['plugins'] ) ) && ( ! empty( $args['plugins'] ) ) ) {
$all_plugins = get_plugins();
$wp_installed_languages = get_available_languages();
if ( ! in_array( 'en_US', $wp_installed_languages ) ) {
$wp_installed_languages = array_merge( array( 'en_US' ), $wp_installed_languages );
}
if ( ! empty( $wp_installed_languages ) ) {
foreach ( $args['plugins'] as $plugin_full_slug ) {
$plugin_dir = dirname( $plugin_full_slug );
// A little hack. For LD core and ProPanel we don't use the real slug internally.
if ( 'learndash-propanel' === $plugin_dir ) {
$plugin_dir = 'learndash-propanel-readme';
} elseif ( 'sfwd-lms' === $plugin_dir ) {
$plugin_dir = 'learndash-core-readme';
}
if ( ( isset( $this->data['repositories'][ $plugin_dir ] ) ) && ( isset( $all_plugins[ $plugin_full_slug ] ) ) ) {
if ( ( isset( $all_plugins[ $plugin_full_slug ]['TextDomain'] ) ) && ( ! empty( $all_plugins[ $plugin_full_slug ]['TextDomain'] ) ) ) {
$plugin_text_domain = $all_plugins[ $plugin_full_slug ]['TextDomain'];
LearnDash_Translations::get_available_translations( $plugin_text_domain );
$update_messages = array();
foreach ( $wp_installed_languages as $locale ) {
$reply = LearnDash_Translations::install_translation( $plugin_text_domain, $locale );
if ( ( isset( $reply['translation_set'] ) ) && ( ! empty( $reply['translation_set'] ) ) ) {
$update_messages[ $locale ] = '<h2>' . sprintf(
// translators: placeholders: Translation Name, Translation Locale.
esc_html_x(
'Updating translations for %1$s (%2$s)...',
'placeholders: Translation Name, Translation Locale',
'learndash'
),
$reply['translation_set']['english_name'],
$reply['translation_set']['wp_locale']
) . '</h2>';
}
}
if ( ! empty( $update_messages ) ) {
$update_mess_name = sprintf(
// translators: placeholder: plugin title.
esc_html_x( '%s: Translations', 'placeholder: plugin title', 'learndash' ),
$all_plugins[ $plugin_full_slug ]['Title']
);
$upgrader->skin->feedback( $update_mess_name );
foreach ( $update_messages as $update_message ) {
$upgrader->skin->feedback( $update_message );
}
}
}
}
}
}
}
$this->load_repositories_options();
$this->get_addon_plugins();
return $upgrader;
}
/**
* Intercept WordPress updater data.
*
* @param array $_transient_data Updae transient data.
*
* return array.
*/
public function pre_set_site_transient_update_plugins( $_transient_data ) {
global $pagenow;
if ( ! is_object( $_transient_data ) ) {
$_transient_data = new stdClass();
}
if ( ( 'plugins.php' == $pagenow ) && ( is_multisite() ) ) {
return $_transient_data;
}
$this->load_repositories_options();
if ( ! empty( $this->data['updates'] ) ) {
foreach ( $this->data['updates'] as $plugin_wp_slug => $plugin_update_obj ) {
remove_action( 'in_plugin_update_message-' . $plugin_wp_slug, array( $this, 'show_upgrade_notification' ), 10, 2 );
}
}
$this->generate_plugin_updates();
if ( ! empty( $this->data['updates'] ) ) {
foreach ( $this->data['updates'] as $plugin_wp_slug => $plugin_update_obj ) {
if ( ! isset( $_transient_data->response[ $plugin_wp_slug ] ) ) {
// We already have the obj but we update the BB download URL just in case.
$plugin_update_obj->package = $this->bb_api->get_bitbucket_repository_download_url( $plugin_update_obj->slug );
$plugin_update_obj->package = $this->bb_api->setup_url_params( $plugin_update_obj->package );
$_transient_data->response[ $plugin_wp_slug ] = $plugin_update_obj;
}
add_action( 'in_plugin_update_message-' . $plugin_wp_slug, array( $this, 'show_upgrade_notification' ), 10, 2 );
}
}
return $_transient_data;
}
/**
* Function to reset repo data.
*
* @since 2.5.9
*/
public function reset_repo() {
delete_option( $this->options_key );
}
/**
* Load Respository options.
*/
public function load_repositories_options() {
if ( is_null( $this->data ) ) {
$this->data = get_option( $this->options_key, array() );
if ( ! is_array( $this->data ) ) {
$this->data = array();
}
if ( empty( $this->data ) ) {
$this->data['last_check'] = 0;
$this->data['repositories'] = array();
$this->data['plugins'] = array();
$this->data['tags'] = array();
}
}
if ( isset( $_GET['repo_reset'] ) ) {
// $this->reset_repo();
$this->data['repo_reset'] = 1;
$this->update_repositories_options();
$admin_url = remove_query_arg( 'repo_reset' );
if ( ! empty( $admin_url ) ) {
learndash_safe_redirect( $admin_url );
}
}
if ( is_null( $this->bb_api ) ) {
$this->bb_api = new LearnDash_BitBucket_API();
}
// Alternate option to define the following in wp-config.php but it MUST be greater then 5 (minutes).
if ( ( defined( 'LEARNDASH_REPO_CACHE_TIME_LIMIT' ) ) && ( LEARNDASH_REPO_CACHE_TIME_LIMIT > 5 ) ) {
$this->repo_cache_time_limit = LEARNDASH_REPO_CACHE_TIME_LIMIT;
}
if ( ( defined( 'LEARNDASH_README_CACHE_TIME_LIMIT' ) ) && ( LEARNDASH_README_CACHE_TIME_LIMIT > 5 ) ) {
$this->readme_cache_time_limit = LEARNDASH_README_CACHE_TIME_LIMIT;
}
}
/**
* Update repositories options.
*/
public function update_repositories_options() {
return update_option( $this->options_key, $this->data, false );
}
/**
* Get Add-on Plugins
*
* @param boolean $override_cache Flag to ignore cache timeout.
*/
public function get_addon_plugins( $override_cache = false ) {
$this->load_repositories_options();
$time_current = time();
$time_diff = $time_current - $this->data['last_check'];
$time_cache = $this->repo_cache_time_limit * MINUTE_IN_SECONDS;
if ( ( ! $override_cache ) && ( isset( $this->data['repo_reset'] ) ) && ( $this->data['repo_reset'] ) ) {
$override_cache = true;
$this->data['repo_reset'] = 0;
$this->update_repositories_options();
}
if ( ( 1 == $override_cache ) || ( empty( $this->data['last_check'] ) ) || ( $time_diff > $time_cache ) ) {
$repositories = $this->bb_api->get_bitbucket_repositories( $override_cache );
if ( ! empty( $repositories ) ) {
// Update our last check timestamp for later caching.
$this->data['last_check'] = time();
foreach ( $repositories as $bb_slug => $bb_repo ) {
if ( ( ! isset( $this->data['repositories'][ $bb_slug ] ) ) || ( strtotime( $bb_repo->updated_on ) > strtotime( $this->data['repositories'][ $bb_slug ]->updated_on ) ) ) {
$this->data['repositories'][ $bb_slug ] = $bb_repo;
$this->update_plugin_readme( $bb_slug, true );
}
}
}
} else {
foreach ( $this->data['repositories'] as $bb_slug => $bb_repo ) {
if ( ( ! isset( $this->data['plugins'][ $bb_slug ] ) ) || ( strtotime( $bb_repo->updated_on ) > strtotime( $this->data['plugins'][ $bb_slug ]['last_updated'] ) ) ) {
$this->update_plugin_readme( $bb_slug, true );
}
}
}
$this->order_plugins();
$this->generate_plugin_updates();
// Then commit the changes to wp_options.
$this->update_repositories_options();
return $this->data['plugins'];
}
/**
* Order plugins by last update timestamp.
*
* @param string $order_field How to order the plugins.
*/
public function order_plugins( $order_field = 'updated_on' ) {
// Before we return we reorder the items to sort by last change date.
if ( ( isset( $this->data['repositories'] ) ) && ( ! empty( $this->data['repositories'] ) ) && ( isset( $this->data['plugins'] ) ) && ( ! empty( $this->data['plugins'] ) ) ) {
$repos_updated_on = array();
foreach ( $this->data['repositories'] as $repo_slug => $repo ) {
if ( ( is_object( $repo ) ) && ( property_exists( $repo, 'updated_on' ) ) ) {
$update_on_timestamp = strtotime( $repo->updated_on );
$repos_updated_on[ $update_on_timestamp . '-' . $repo_slug ] = $repo_slug;
}
}
krsort( $repos_updated_on );
$repos_data_sorted = array();
foreach ( $repos_updated_on as $repo_slug ) {
$repos_data_sorted[ $repo_slug ] = $this->data['repositories'][ $repo_slug ];
}
$this->data['repositories'] = $repos_data_sorted;
$plugins_data_sorted = array();
foreach ( $repos_updated_on as $repo_slug ) {
if ( isset( $this->data['plugins'][ $repo_slug ] ) ) {
$plugins_data_sorted[ $repo_slug ] = $this->data['plugins'][ $repo_slug ];
}
}
$this->data['plugins'] = $plugins_data_sorted;
}
}
/**
* Update plugin readme. Retrieves update via BB API.
*
* @param string $plugin_slug Slug of plugin to update.
* @param boolean $override_cache Flag to ignore cache.
*/
public function update_plugin_readme( $plugin_slug = '', $override_cache = false ) {
if ( ! empty( $plugin_slug ) ) {
/**
* Option to override cache via URL parameter.
*
* @since 3.1.4
*/
if ( isset( $_GET['ld_debug'] ) ) {
$override_cache = true;
}
if ( ( isset( $this->data['repositories'][ $plugin_slug ] ) ) && ( ! empty( $this->data['repositories'][ $plugin_slug ] ) ) ) {
$bb_repo = $this->data['repositories'][ $plugin_slug ];
if ( isset( $this->data['plugins'][ $plugin_slug ] ) ) {
$plugin_item = $this->data['plugins'][ $plugin_slug ];
if ( true !== $override_cache ) {
if ( ( isset( $plugin_item['last_check'] ) ) && ( ( $plugin_item['last_check'] - time() ) < ( $this->readme_cache_time_limit * MINUTE_IN_SECONDS ) ) ) {
return $plugin_item;
}
}
}
$plugin_readme = $this->bb_api->get_bitbucket_repository_readme( $plugin_slug );
if ( ( ! empty( $plugin_readme ) ) && ( is_array( $plugin_readme ) ) ) {
$plugin_readme['last_check'] = time();
$plugin_readme['external'] = true;
if ( ( property_exists( $bb_repo, 'slug' ) ) && ( ! empty( $bb_repo->slug ) ) ) {
$plugin_readme['bb_slug'] = $bb_repo->slug;
}
if ( ! isset( $plugin_readme['slug'] ) ) {
if ( ( property_exists( $bb_repo, 'slug' ) ) && ( ! empty( $bb_repo->slug ) ) ) {
$plugin_readme['slug'] = $bb_repo->slug;
}
}
if ( ( ! isset( $plugin_readme['plugin_uri'] ) ) || ( empty( $plugin_readme['plugin_uri'] ) ) ) {
if ( ( property_exists( $bb_repo, 'website' ) ) && ( ! empty( $bb_repo->website ) ) ) {
$plugin_readme['plugin_uri'] = esc_url( $bb_repo->website );
}
}
if ( ( ! isset( $plugin_readme['homepage'] ) ) || ( empty( $plugin_readme['homepage'] ) ) ) {
if ( ( isset( $plugin_readme['plugin_uri'] ) ) && ( ! empty( $plugin_readme['plugin_uri'] ) ) ) {
$plugin_readme['homepage'] = $plugin_readme['plugin_uri'];
}
}
if ( ( ! isset( $plugin_readme['last_updated'] ) ) || ( empty( $plugin_readme['last_updated'] ) ) ) {
if ( ( property_exists( $bb_repo, 'updated_on' ) ) && ( ! empty( $bb_repo->updated_on ) ) ) {
$plugin_readme['last_updated'] = $bb_repo->updated_on;
}
}
$readme_array = $this->convert_readme( $plugin_readme );
if ( ( ! empty( $readme_array ) ) && ( is_array( $readme_array ) ) ) {
if ( ! isset( $readme_array['show-add-on'] ) ) {
if ( ( 'learndash-core-readme' === $plugin_slug ) || ( 'learndash-propanel-readme' === $plugin_slug ) ) {
$readme_array['show-add-on'] = 'no';
}
}
$this->data['plugins'][ $plugin_slug ] = $readme_array;
return $readme_array;
}
}
}
}
}
/**
* Generate plugin updates.
*/
public function generate_plugin_updates() {
$this->data['updates'] = array();
$all_plugins = get_plugins();
// Then from the 'plugins' node. This lets us remove items we didn't retrieve from 'repositories'.
if ( ! empty( $this->data['plugins'] ) ) {
foreach ( $this->data['plugins'] as $plugin_slug => &$plugin_readme ) {
if ( ( 'learndash-core-readme' === $plugin_slug ) || ( 'learndash-propanel-readme' === $plugin_slug ) ) {
continue;
}
if ( ( ! isset( $plugin_readme['bb_slug'] ) ) || ( empty( $plugin_readme['bb_slug'] ) ) || ( ! isset( $this->data['repositories'][ $plugin_readme['bb_slug'] ] ) ) ) {
unset( $this->data['plugins'][ $plugin_slug ] );
} else {
$plugin_found = false;
foreach ( $all_plugins as $all_plugin_slug => $all_plugin_data ) {
if ( strncasecmp( $plugin_readme['slug'] . '/', $all_plugin_slug, strlen( $plugin_readme['slug'] . '/' ) ) === 0 ) {
$plugin_found = true;
$plugin_readme['wp_slug'] = $all_plugin_slug;
$plugin_readme['plugin_status'] = array();
$plugin_readme['plugin_status']['status'] = 'latest_installed';
$plugin_readme['plugin_status']['url'] = false;
$plugin_readme['plugin_status']['version'] = false;
$plugin_readme['plugin_status']['file'] = $all_plugin_slug;
if ( version_compare( $plugin_readme['version'], $all_plugin_data['Version'], '>' ) ) {
$plugin_readme['plugin_status']['status'] = 'update_available';
$plugin_readme['plugin_status']['version'] = $plugin_readme['version'];
$plugin_readme['plugin_status']['file'] = $all_plugin_slug;
if ( current_user_can( 'update_plugins' ) ) {
$plugin_readme['plugin_status']['url'] = wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' . $all_plugin_slug ), 'upgrade-plugin_' . $all_plugin_slug );
$plugin_readme['plugin_status']['url'] = add_query_arg(
'ld-return-addons',
$_SERVER['REQUEST_URI'],
$plugin_readme['plugin_status']['url']
);
}
$obj = new stdClass();
$obj->slug = $plugin_readme['slug'];
$obj->plugin = $all_plugin_slug;
$obj->new_version = $plugin_readme['version'];
$obj->package = $this->bb_api->get_bitbucket_repository_download_url( $plugin_readme['slug'] );
$obj->package = $this->bb_api->setup_url_params( $obj->package );
if ( ( isset( $plugin_readme['plugin_uri'] ) ) && ( ! empty( $plugin_readme['plugin_uri'] ) ) ) {
$obj->url = $plugin_readme['plugin_uri'];
}
if ( ( isset( $plugin_readme['tested'] ) ) && ( ! empty( $plugin_readme['tested'] ) ) ) {
$obj->tested = $plugin_readme['tested'];
}
if ( ( isset( $plugin_readme['icons'] ) ) && ( ! empty( $plugin_readme['icons'] ) ) ) {
$obj->icons = $plugin_readme['icons'];
}
if ( ( isset( $plugin_readme['banners'] ) ) && ( ! empty( $plugin_readme['banners'] ) ) ) {
$obj->banners = $plugin_readme['banners'];
}
if ( ( isset( $plugin_readme['upgrade_notice']['content'] ) ) && ( ! empty( $plugin_readme['upgrade_notice']['content'] ) ) ) {
$upgrade_notice = '';
foreach ( $plugin_readme['upgrade_notice']['content'] as $upgrade_notice_version => $upgrade_notice_message ) {
if ( version_compare( $upgrade_notice_version, $all_plugin_data['Version'], '>' ) ) {
$upgrade_notice_message = str_replace( array( "\r\n", "\n", "\r" ), '', $upgrade_notice_message );
$upgrade_notice_message = str_replace( '</p><p>', '<br /><br />', $upgrade_notice_message );
$upgrade_notice_message = str_replace( '<p>', '', $upgrade_notice_message );
$upgrade_notice_message = str_replace( '</p>', '', $upgrade_notice_message );
$upgrade_notice .= '<p><span class="version">' . $upgrade_notice_version . '</span>: ' . $upgrade_notice_message . '</p>';
}
}
if ( ! empty( $upgrade_notice ) ) {
$this->data['plugins'][ $plugin_slug ]['upgrade_notice']['content_formatted'] = $upgrade_notice;
}
}
if ( ( isset( $plugin_readme['upgrade_notice_admin']['content'] ) ) && ( ! empty( $plugin_readme['upgrade_notice_admin']['content'] ) ) ) {
$upgrade_notice = '';
foreach ( $plugin_readme['upgrade_notice_admin']['content'] as $upgrade_notice_version => $upgrade_notice_message ) {
if ( version_compare( $upgrade_notice_version, $all_plugin_data['Version'], '>' ) ) {
$upgrade_notice_message = str_replace( array( '<h4>', '</h4>' ), array( '<p class="header">', '</p>' ), $upgrade_notice_message );
$upgrade_notice .= $upgrade_notice_message;
}
}
if ( ! empty( $upgrade_notice ) ) {
$this->data['plugins'][ $plugin_slug ]['upgrade_notice_admin']['content_formatted'] = $upgrade_notice_message;
}
}
$this->data['updates'][ $all_plugin_slug ] = $obj;
break;
}
}
}
// We didn't find out plugin in the installed. So mark it to install.
if ( false === $plugin_found ) {
$plugin_readme['plugin_status'] = array();
$plugin_readme['plugin_status']['status'] = 'install';
$plugin_readme['plugin_status']['version'] = $plugin_readme['version'];
$plugin_readme['plugin_status']['file'] = false;
if ( current_user_can( 'install_plugins' ) ) {
$plugin_readme['plugin_status']['url'] = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $plugin_slug ), 'install-plugin_' . $plugin_slug );
$plugin_readme['plugin_status']['url'] = add_query_arg( 'ld-return-addons', $_SERVER['REQUEST_URI'], $plugin_readme['plugin_status']['url'] );
}
}
}
}
}
}
/**
* Add Readme Tags.
*
* @param array $readme_array Readme Array.
*/
public function add_readme_tags( $readme_array = array() ) {
if ( ( isset( $readme_array['tags'] ) ) && ( ! empty( $readme_array['tags'] ) ) ) {
foreach ( $readme_array['tags'] as $tag ) {
$tag = trim( $tag );
if ( ! empty( $tag ) ) {
if ( ! empty( $this->data['tags'][ $tag ] ) ) {
$this->data['tags'][ $tag ] = array();
}
$this->data['tags'][ $tag ][] = $readme_array['slug'];
}
}
}
}
/**
* Convert Readme
*
* @param array $readme Readme array of elements.
*/
public function convert_readme( $readme = array() ) {
if ( ( ! isset( $readme['author'] ) ) || ( empty( $readme['author'] ) ) ) {
$readme['author'] = 'LearnDash';
}
if ( ( ! isset( $readme['version'] ) ) || ( empty( $readme['version'] ) ) ) {
if ( ( isset( $readme['stable_tag'] ) ) && ( ! empty( $readme['stable_tag'] ) ) ) {
$readme['version'] = $readme['stable_tag'];
} else {
$readme['version'] = '0.0';
}
}
if ( ( isset( $readme['author_uri'] ) ) && ( ! empty( $readme['author_uri'] ) ) ) {
if ( ( isset( $readme['author'] ) ) && ( ! empty( $readme['author'] ) ) ) {
$readme['author'] = '<a href="' . $readme['author_uri'] . '">' . $readme['author'] . '</a>';
}
}
if ( ( ! isset( $readme['requires_at_least'] ) ) || ( empty( $readme['requires'] ) ) ) {
if ( ( isset( $readme['requires_at_least'] ) ) && ( ! empty( $readme['requires_at_least'] ) ) ) {
$readme['requires'] = $readme['requires_at_least'];
}
}
if ( ( ! isset( $readme['tested'] ) ) || ( empty( $readme['tested'] ) ) ) {
if ( ( isset( $readme['tested_up_to'] ) ) && ( ! empty( $readme['tested_up_to'] ) ) ) {
$readme['tested'] = $readme['tested_up_to'];
}
}
if ( ( ! isset( $readme['short_description'] ) ) || ( empty( $readme['short_description'] ) ) ) {
if ( ( isset( $readme['description']['content_raw'] ) ) && ( ! empty( $readme['description']['content_raw'] ) ) ) {
$readme['short_description'] = $readme['description']['content_raw'];
}
}
if ( ! isset( $readme['icons'] ) ) {
$readme['icons'] = array();
if ( file_exists( LEARNDASH_LMS_PLUGIN_DIR . 'assets/images-add-ons/' . $readme['slug'] . '_256x256.jpg' ) ) {
$readme['icons']['1x'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_256x256.jpg';
$readme['icons']['2x'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_256x256.jpg';
$readme['icons']['default'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_256x256.jpg';
} elseif ( file_exists( LEARNDASH_LMS_PLUGIN_DIR . 'assets/images-add-ons/learndash-default_256x256.jpg' ) ) {
$readme['icons']['1x'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_256x256.jpg';
$readme['icons']['2x'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_256x256.jpg';
$readme['icons']['default'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_256x256.jpg';
}
}
if ( ! isset( $readme['banners'] ) ) {
$readme['banners'] = array();
if ( file_exists( LEARNDASH_LMS_PLUGIN_DIR . 'assets/images-add-ons/' . $readme['slug'] . '_banner.jpg' ) ) {
$readme['banners']['low'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_banner.jpg';
$readme['banners']['high'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_banner.jpg';
$readme['banners']['default'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/' . $readme['slug'] . '_banner.jpg';
} elseif ( file_exists( LEARNDASH_LMS_PLUGIN_DIR . 'assets/images-add-ons/learndash-default_banner.jpg' ) ) {
$readme['banners']['low'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_banner.jpg';
$readme['banners']['high'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_banner.jpg';
$readme['banners']['default'] = LEARNDASH_LMS_PLUGIN_URL . 'assets/images-add-ons/learndash-default_banner.jpg';
}
}
return $readme;
}
/**
* Get plugin information
*
* @param string $plugin_slug Slug of plugin.
*/
public function get_plugin_information( $plugin_slug = '' ) {
if ( ! empty( $plugin_slug ) ) {
$this->load_repositories_options();
return $this->update_plugin_readme( $plugin_slug );
}
}
// End of functions.
}
}
add_action(
'learndash_admin_init',
function() {
LearnDash_Addon_Updater::get_instance();
}
);