-
Notifications
You must be signed in to change notification settings - Fork 3
/
functions.php
1617 lines (1364 loc) · 49 KB
/
functions.php
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
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* -----------------------------------------------------------------------------
* Purpose: Public functions for the Update Manager plugin.
* Package: CodePotent\UpdateManager
* Version: 1.0.0
* Author: Code Potent
* Author URI: https://codepotent.com
* -----------------------------------------------------------------------------
* This is free software released under the terms of the General Public License,
* version 2, or later. It is distributed WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Full
* text of the license is available at https://www.gnu.org/licenses/gpl-2.0.txt.
* -----------------------------------------------------------------------------
* Copyright 2019 - Code Potent
* -----------------------------------------------------------------------------
* ____ _ ____ _ _
* / ___|___ __| | ___| _ \ ___ | |_ ___ _ __ | |_
* | | / _ \ / _` |/ _ \ |_) / _ \| __/ _ \ '_ \| __|
* | |__| (_) | (_| | __/ __/ (_) | || __/ | | | |_
* \____\___/ \__,_|\___|_| \___/ \__\___|_| |_|\__|.com
*
* -----------------------------------------------------------------------------
*/
// Declare the namespace.
namespace CodePotent\UpdateManager;
// Prevent direct access.
if (!defined('ABSPATH')) {
die();
}
/**
* Get request.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @return array|string
*/
function get_request() {
// Strip slashes, then tags from request data.
$request = strip_tags_deep(stripslashes_deep($_REQUEST));
// Ensure the raw data can't be used elsewhere.
unset($_REQUEST);
// Endpoint variable not set? Bail.
if (empty($request[ENDPOINT_VARIABLE])) {
return [];
}
// Endpoint invalid? Bail.
if (empty($request['plugin']) && empty($request['theme'])) {
return [];
}
// Type of update being checked for.
$type = (!empty($request['plugin'])) ? 'plugin' : 'theme';
// No requesting URL submitted (ie, RC1)? Get it from user agent instead.
if (empty($request['site_url'])) {
// User agent messed with? Bail.
if (empty($_SERVER['HTTP_USER_AGENT'])) {
return [];
}
// Split the user agent parts.
$user_agent_parts = explode(';', $_SERVER['HTTP_USER_AGENT']);
// Extract url from string: ClassicPress/x.x.x; https://www.the-site.com
$site_url = trim(array_pop($user_agent_parts));
// Still no URL? Bail.
if (empty($site_url) || !filter_var($site_url, FILTER_VALIDATE_URL)) {
return [];
}
// Alrighty, then! Got a URL, clean it up.
$request['site_url'] = esc_url($site_url);
}
// Add a nonce.
$request['nonce'] = wp_create_nonce($type.'_request_'.$request['site_url']);
// Post type to retrieve.
$post_type = ($type==='plugin' ? CPT_FOR_PLUGIN_ENDPOINTS : CPT_FOR_THEME_ENDPOINTS);
// Get the endpoint, if it exists, whether published or pending.
$endpoint = get_posts([
'post_type' => $post_type,
'post_status' => ['pending', 'publish'],
'posts_per_page' => 1,
'meta_key' => 'id',
'meta_value' => esc_attr($request[$type]),
]);
// No data to work with? Bail.
if (is_wp_error($endpoint) || empty($endpoint)) {
return [];
}
// Add the endpoint to the request.
$request['endpoint'] = $endpoint;
// Deprecated as of 2.0.0; allow for filtering the incoming request.
$request = apply_filters(PLUGIN_PREFIX.'_filter_request', $request);
// New in 2.0.0; allow for filtering the incoming request.
$request = apply_filters(PLUGIN_PREFIX.'_filter_'.$type.'_request', $request);
// Return the cleansed request.
return $request;
}
/**
* Get allowed test URLs.
*
* This function retrieves an array of URLs that are allowed to be notified when
* the plugin has an update set to "Pending" status.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param integer $post_id
* @return array
*/
function get_allowed_test_urls($post_id) {
// Get the permissible URLs.
$meta = get_post_meta($post_id, 'test_urls', true);
// Turn the URLs into an array.
$meta = explode("\n", $meta);
// Return the URLs.
return $meta;
}
/**
* Get notification targets.
*
* This function retrieves any notification emails/urls associated to the plugin
* endpoint.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param integer $post_id
* @return array[]
*/
function get_notification_targets($post_id) {
// Get the notification targets.
$meta = get_post_meta($post_id, 'notifications', true);
// Turn the targets into an array.
$targets = explode(',', $meta);
// Initialization.
$notify = [];
// Extract the emails and URLs.
foreach ($targets as $target) {
if (!empty($target = trim($target))) {
if (strpos($target, 'http') === 0) {
$notify['url'][] = $target;
} else {
$notify['email'][] = $target;
}
}
}
// Return the goods.
return $notify;
}
function get_notification_email_subject($header) {
// Default email subject.
$subject = sprintf(
esc_html__('Report: %s v%s', 'codepotent-update-manager'),
$header['name'],
$header['version']);
// Allow users to filter the value.
$subject = apply_filters(PLUGIN_PREFIX.'_notification_email_subject', $subject);
// Ensure sanitization; in case it was filtered.
$subject = sanitize_text_field($subject);
// Return the string.
return $subject;
}
function get_notification_email_body($header) {
// Initialization.
$lines = [];
// Add default text.
$lines[] = sprintf(
esc_html__('We greatly appreciate your help with testing this update for *%s*! Please let us know how it went.', 'codepotent-update-manager'),
$header['name'])."\r\n\r\n";
// Say thanks.
$lines[] = esc_html__('Thanks!', 'codepotent-update-manager')."\r\n\r\n";
// Allow users to filter the email body.
$lines = apply_filters(PLUGIN_PREFIX.'notification_email_body', $lines);
// Glue together the lines.
$body = implode('', $lines);
// Final sanitization; in case it was filtered.
$body = sanitize_textarea_field($body);
// Return the string.
return $body;
}
function get_notification_email_url($email, $subject, $body) {
$args = [];
$args[] = 'subject='.rawurlencode($subject);
$args[] = 'body='.rawurlencode($body);
$mail_url = 'mailto:'.$email.'?';
foreach ($args as $arg) {
$mail_url .= $arg.'&';
}
return $mail_url;
}
/**
* Plugin information endpoint data
*
* This function retrieves the data that is required to fully populate the modal
* update window with header images, tabbed navigation and content, and data for
* populating the sidebar.
*
* @author John Alarcon
*
* @since 2.0.0
*
* @return array|mixed
*/
function component_information($component) {
// Initialize the return variable.
$data = [];
// Get the request.
$request = get_request();
// No requesting URL submitted? Bail.
if (empty($request['site_url'])) {
return $data;
}
// No endpoint passed in? Bail.
if (empty($request['endpoint']) || !is_object($request['endpoint'][0])) {
return $data;
}
// No plugin id submitted? Bail.
if (empty($request['plugin']) && empty($request['theme'])) {
return $data;
}
// Whitelist the component type.
if ($component !== 'plugin') {
$component = 'theme';
}
// Nonce seems suspicious? Bail.
if (!wp_verify_nonce($request['nonce'], $component.'_request_'.$request['site_url'])) {
return $data;
}
// Get the plugin textual data.
$content = get_post_meta($request['endpoint'][0]->ID, $request[$component], true);
// No worthwhile result? Bail.
if (is_wp_error($content) || empty($content)) {
return $data;
}
// Turn the plugin content into usable data.
$data = parse_component_data($request[$component], $request['endpoint'], $request, $content);
// Only whitelisted sites get links to Pending (ie, can test) updates.
if ($request['endpoint'][0]->post_status === 'pending') {
$can_test_updates = get_allowed_test_urls($request['endpoint'][0]->ID);
if (!in_array($request['site_url'], $can_test_updates, true)) {
$data['download_link'] = '';
$data['url'] = '';
}
}
// Return the assembled data to the JSON endpoint.
return apply_filters(PLUGIN_PREFIX.'_'.$component.'_information', $data, $request);
}
/**
* Plugin information endpoint data
*
* This function retrieves the data that is required to fully populate the modal
* update window with header images, tabbed navigation and content, and data for
* populating the sidebar.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @deprecated 2.0.0 Use component_information() function instead.
*
* @return array|mixed
*/
function plugin_information() {
return component_information('plugin');
}
/**
* Query for plugin or theme updates.
*
* @author John Alarcon
*
* @since 2.0.0
*
* @return mixed
*/
function query_components($component) {
// Get the request.
$request = get_request();
// Ensure a valid component type.
if ($component !== 'plugin') {
$component = 'theme';
}
// Data returned in case of any issues.
$nothing = [
'notice' => sprintf(
esc_html__('No %s data available', 'codepotent-update-manager'),
$component)
];
// No requesting URL submitted? Bail.
if (empty($request['site_url'])) {
return $nothing;
}
// No plugin id submitted? Bail.
if (empty($request[$component])) {
return $nothing;
}
// Nonce seems suspicious? Bail.
if (!wp_verify_nonce($request['nonce'], $component.'_request_'.$request['site_url'])) {
return $nothing;
}
// Get plugin identifier; ie, plugin-name/plugin-name.php
$identifier = !empty($request[$component]) ? $request[$component] : false;
// Get plugins' header data passed in from remote server.
$remote_headers = !empty($request[$component.'s']) ? $request[$component.'s'] : [];
// Is the identifier or plugin list unworkable? Bail.
if (!$identifier && empty($remote_headers)) {
return $nothing;
}
// If querying via a URL in the browser, bail.
if (empty($remote_headers[$identifier])) {
return $nothing;
}
// Ensure there's a remote version number present, or bail.
if (empty($remote_version = $remote_headers[$identifier]['Version'])) {
return $nothing;
}
// Surface the endpoint object.
$endpoint = $request['endpoint'];
// Get plugin data string.
$content = get_post_meta($endpoint[0]->ID, $identifier, true);
// No worthwhile result? Bail.
if (is_wp_error($content) || empty($content)) {
return $nothing;
}
// Get latest data for the component.
$latest = parse_component_data($identifier, $endpoint, $request, $content);
// Get latest version number, or bail.
if (empty($latest['version'])) {
return $nothing;
}
// Setup default return; contains empty array; meaning no update.
$data[$identifier] = [];
// Check if remote version is less than latest version.
if (version_compare($remote_version, $latest['version'], '<')) {
if ($component === 'plugin') {
// Remote version was less? Mmmkay, capture any found details.
$data[$identifier] = [
'type' => $component,
'id' => $identifier,
'identifier' => $identifier,
'slug' => dirname($identifier),
'plugin' => $identifier,
'new_version' => isset($latest['version']) ? $latest['version'] : '',
'package' => isset($latest['download_link']) ? $latest['download_link'] : '',
'url' => isset($latest['plugin_uri']) ? $latest['plugin_uri'] : '',
'requires' => isset($latest['requires']) ? $latest['requires'] : '',
'tested' => isset($latest['tested']) ? $latest['tested'] : '',
'requires_php' => isset($latest['requires_php']) ? $latest['requires_php'] : '',
'updated' => isset($latest['updated']) ? $latest['updated'] : '',
'upgrade_notice' => isset($latest['upgrade_notice']) ? $latest['upgrade_notice'] : '',
];
} else if ($component === 'theme') {
// Remote version was less? Mmmkay, capture any found details.
$data[$identifier] = [
'type' => $component,
'id' => $identifier,
'identifier' => $identifier,
'slug' => $identifier,
'theme' => $identifier,
'new_version' => isset($latest['version']) ? $latest['version'] : '',
'package' => isset($latest['download_link']) ? $latest['download_link'] : '',
'url' => isset($latest['theme_uri']) ? $latest['theme_uri'] : '',
'requires' => isset($latest['requires']) ? $latest['requires'] : '',
'tested' => isset($latest['tested']) ? $latest['tested'] : '',
'requires_php' => isset($latest['requires_php']) ? $latest['requires_php'] : '',
'updated' => isset($latest['updated']) ? $latest['updated'] : '',
'upgrade_notice' => isset($latest['upgrade_notice']) ? $latest['upgrade_notice'] : '',
];
}
}
// Only whitelisted sites get Pending (ie, can test) updates.
if ($endpoint[0]->post_status === 'pending') {
$can_test_updates = get_allowed_test_urls($endpoint[0]->ID);
if (!in_array($request['site_url'], $can_test_updates, true)) {
$data[$identifier] = [];
}
}
// Return empty array (no update) or populated array (update data) as JSON.
return apply_filters(PLUGIN_PREFIX.'_query_'.$component.'s', $data, $request);
}
/**
* Query for plugin updates.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @deprecated 2.0.0 Use query_components() function instead.
*
* @return mixed
*/
function query_plugins() {
return query_components('plugin');
}
/**
* Parse readme-style data into usable data.
*
* The decision to describe plugin properties through a readme-style format came
* from several considerations. Speed – many plugin developers already have such
* files available and can then copy and paste more easily. Bloat – consider how
* many inputs it would take to flesh out an interface that could accept all the
* required data.
*
* @author John Alarcon
*
* @since 2.0.0
*
* @param string $identifier
* @param object $nedpoint_post
* @param array $request
* @param string $content
* @return array
*/
function parse_component_data($identifier, $endpoint, $request, $content) {
// Surface the component type.
$component = 'plugin';
if (!strstr($request[ENDPOINT_VARIABLE], 'plugin')) {
$component = 'theme';
}
// Initialize the return variable.
$data = [];
// Read in the content.
$lines = explode("\n", $content);
// Extract the header data.
$header = get_header_data($lines);
// Extract the sectional data.
$sections = get_sections_data($lines);
// And now, for my next trick... markup all the modal sections!
// Get markup for the Description tab.
if (!empty($sections['description'])) {
$sections['description'] = markup_generic_section($sections['description']);
}
// Get markup for the FAQ tab.
if (!empty($sections['faq'])) {
$sections['faq'] = markup_generic_section($sections['faq']);
}
// Get markup for the Installation tab.
if (!empty($sections['installation'])) {
$sections['installation'] = markup_generic_section($sections['installation']);
}
// Get markup for the Screenshots tab.
if (!empty($sections['screenshots']) && !empty($request['screenshot_urls'])) {
$sections['screenshots'] = markup_screenshots($request['screenshot_urls'], $sections['screenshots']);
} else {
unset($sections['screenshots']);
}
// Get markup for the Reviews tab.
if (!empty($sections['reviews'])) {
$reviews_raw = $sections['reviews'];
$sections['reviews'] = markup_reviews($sections['reviews']);
}
// Get markup for the Other Notes tab.
if (!empty($sections['other_notes'])) {
$sections['other_notes'] = markup_generic_section($sections['other_notes']);
}
// Get markup for the Reviews tab.
if (!empty($sections['changelog'])) {
$sections['changelog'] = markup_generic_section($sections['changelog']);
}
// Get markup for the Upgrade Notices; tab and plugin row.
if (!empty($sections['upgrade_notice'])) {
// Plugin row; no markup; string.
$data['upgrade_notice'] = markup_upgrade_notice($sections['upgrade_notice'], true);
// Modal window; markdown array converted to markup string.
$sections['upgrade_notice'] = markup_upgrade_notice($sections['upgrade_notice']);
} else {
// No upgrade notice? No need for a tab.
unset($sections['upgrade_notice']);
}
// If update is being tested, show a cautionary note above every section.
if ($endpoint[0]->post_status === 'pending') {
$test_urls = get_allowed_test_urls($endpoint[0]->ID);
if (in_array($request['site_url'], $test_urls, true)) {
$notice = markup_testing_notice($test_urls, $identifier, $header);
foreach ($sections as $heading=>$content) {
$sections[$heading] = $notice.$content;
}
}
}
// Flag indicating plugin is not hosted via ClassicPress plugin directory.
$data['external'] = true;
// Unique identifier; ie, my-plugin-dir/my-plugin-file.php
$data['identifier'] = $identifier;
// Plugin/theme slug; ie, my-theme-name or my-plugin-name/my-plugin-name.php
if ($component === 'plugin') {
$data['slug'] = dirname($identifier);
} else if ($component === 'theme') {
$data['slug'] = $identifier;
}
// Display name for the plugin.
$data['name'] = !empty($header['name']) ? $header['name'] : '';
// Plugin description.
$data['description'] = !empty($sections['description']) ? $sections['description'] : '';
// Plugin version; ie, 1.2.3
$data['version'] = !empty($header['version']) ? $header['version'] : '';
// Text domain; ie, my-plugin-name
$data['text_domain'] = !empty($header['text_domain']) ? $header['text_domain'] : '';
// Text domain path; ie, /languages
$data['domain_path'] = !empty($header['domain_path']) ? $header['domain_path'] : '';
// Minimum PHP requirement; ie, 5.6, or 7, or 7.2, etc
$data['requires_php'] = !empty($header['requires_php']) ? $header['requires_php'] : '';
// Minimum ClassicPress requirement; ie, 1.1.1
$data['requires'] = !empty($header['requires']) ? $header['requires'] : '';
// Maximum ClassicPress compatibility; ie, 1.1.1
$data['tested'] = !empty($header['tested']) ? $header['tested'] : '';
// Author URL string.
$data['author'] = '';
if (!empty($header['author_uri']) && !empty($header['author'])) {
$data['author'] = '<a href="'.$header['author_uri'].'">'.$header['author'].'</a>';
}
// Author URL.
$data['author_uri'] = !empty($header['author_uri']) ? $header['author_uri'] : '';
// Plugin/theme URI.
if ($component === 'plugin') {
$data['plugin_uri'] = !empty($header['plugin_uri']) ? $header['plugin_uri'] : '';
} else if ($component === 'theme') {
$data['theme_uri'] = !empty($header['theme_uri']) ? $header['theme_uri'] : '';
}
// Download link; ie, https://somesite.com/some-file.zip
$data['download_link'] = !empty($header['download_link']) ? $header['download_link'] : '';
if ($component === 'theme') {
$data['url'] = $data['download_link'];
}
// Donation link; ie, https://pay.me/?now-would-be-nice
$data['donate_link'] = !empty($header['donate_link']) ? $header['donate_link'] : '';
// License; ie, GPL v2
$data['license'] = !empty($header['license']) ? $header['license'] : '';
// License URL; ie, https://somesite.com/licence.html
$data['license_uri'] = !empty($header['license_uri']) ? $header['license_uri'] : '';
// Plugin/theme home page.
if ($component === 'plugin') {
$data['homepage'] = !empty($header['plugin_uri']) ? $header['plugin_uri'] : '';
} else if ($component === 'theme') {
$data['homepage'] = !empty($header['theme_uri']) ? $header['theme_uri'] : '';
}
// Plugin last update date; ie, 2019-12-16 15:02:08
$data['last_updated'] = $endpoint[0]->post_modified;
// Plugin release date; ie, 2019-12-16 15:02:08
$data['added'] = $endpoint[0]->post_date;
// Active installs; filterable since active installs aren't counted.
$data['active_installs'] = apply_filters(PLUGIN_PREFIX.'_'.$identifier.'_active_installs', 0, $identifier);
if (empty($data['active_installs'])) {
unset($data['active_installs']);
}
// Plugin banners and icons.
if ($component === 'plugin') {
// Array of URLs to the banner images for the plugin.
$data['banners'] = get_plugin_banners($request);
// Array of URLs to the icons images for the plugin.
$data['icons'] = get_plugin_icons($endpoint, $identifier);
}
// Compatibility map; is this needed?
$data['compatibility'] = [];
if (!empty($header['requires'])) {
$data['compatibility'] = [
$header['requires'] => true
];
}
// Before capturing sections to the data array; add star rating data.
if (!empty($sections['reviews'])) {
$data['ratings'] = get_ratings($reviews_raw);
$data['num_ratings'] = array_sum($data['ratings']);
$data['rating'] = get_score($data['ratings'], $data['num_ratings']);
}
// Place sections at the end; purely for a more visually aesthetic endpoint.
$data['sections'] = $sections;
// Assignments complete! One final thing left...
// Remove certain fields if URL not whitelisted to receive Pending updates.
$data = prevent_unauthorized_pending_updates($request, $endpoint, $data);
// Finally!
return $data;
}
/**
* Parse readme-style data into usable data.
*
* The decision to describe plugin properties through a readme-style format came
* from several considerations. Speed – many plugin developers already have such
* files available and can then copy and paste more easily. Bloat – consider how
* many inputs it would take to flesh out an interface that could accept all the
* required data.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @deprecated 2.0.0 Use parse_component_data() function instead.
*
* @param string $identifier
* @param object $nedpoint_post
* @param array $request
* @param string $content
* @return array
*/
function parse_plugin_data($identifier, $endpoint, $request, $content) {
return parse_component_data($identifier, $endpoint, $request, $content);
}
/**
* Filter data for Pending updates.
*
* This function ensures that, when an update endpoint is in Pending status, the
* requestors who are whitelisted receive the update data while other requestors
* receive a bit less data – basic info only, without triggering an update. This
* function defaults, resets, or otherwise nullifies a few $data elements, which
* then causes the update to not be found.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param array $request The incoming request.
* @param object $endpoint The endpoint associated with the remote plugin.
* @param array $data The full data provided to the update endpoint.
* @return array The possibly-amended data array.
*/
function prevent_unauthorized_pending_updates($request, $endpoint, $data) {
// No endpoint id? Bail.
if (empty($endpoint[0]->ID)) {
return [];
}
// Endpoint not in Pending status? Return unaltered data.
if ($endpoint[0]->post_status !== 'pending') {
return $data;
}
// Get URLs allowed to have Pending updates.
$test_urls = get_allowed_test_urls($endpoint[0]->ID);
// Requesting URL is whitelisted for Pending updates? Return unaltered data.
if (in_array($request['site_url'], $test_urls, true)) {
return $data;
}
// Alter data to provide info only without update.
$data['version'] = !empty($request['version']) ? $request['version'] : '';
$data['requires_php'] = '';
$data['requires'] = '';
$data['tested'] = '';
$data['download_link'] = '';
$data['last_updated'] = '';
$data['compatibility'] = [];
// Unset the (list-table) upgrade notice and its related (modal window) tab.
unset($data['upgrade_notice'], $data['sections']['upgrade_notice']);
// Return the data only; no update.
return $data;
}
/**
* Get plugin icons.
*
* For the plugin with an available update, check its /images/ directory and see
* if there are any icon files. If any icons are found, they will be are used in
* the list table that shows available updates. Icon files are expected to be in
* png or jpg format. The icons should be named as follows:
*
* Normal Icons: icon-128.{png|jpg}
* Retina Icons: icon-256.{png|jpg}
*
* If the remote plugin has no icon files in its /images/ directory, then a core
* placeholder image is used.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param object $plugin_post
* @param string $plugin_identifer
* @return array
*/
function get_plugin_icons($plugin_post, $identifer) {
// Initialize return variable.
$icons = [];
// Path and URL to the plugin's image directory.
$path = WP_PLUGIN_DIR.'/'.dirname($identifer).'/images';
$url = WP_PLUGIN_URL.'/'.dirname($identifer).'/images';
// Check for an SVG icon.
if (file_exists($path.'/icon.svg')) {
// SVG image can be safely used at all saves.
$icons['default'] = $url.'/icon.svg';
$icons['1x'] = $url.'/icon.svg';
$icons['2x'] = $url.'/icon.svg';
// Got what we need; return early.
return $icons;
}
// Check next for PNG or JPG images.
foreach (['png', 'jpg'] as $ext) {
// Normal icon; set as default for all sizes.
if (file_exists($path.'/icon-128.'.$ext)) {
$icons['default'] = $url.'/icon-128.'.$ext;
$icons['1x'] = $url.'/icon-128.'.$ext;
$icons['2x'] = $url.'/icon-128.'.$ext;
}
// Retina icon; overwrite if found.
if (file_exists($path.'/icon-256.'.$ext)) {
$icons['2x'] = $url.'/icon-256.'.$ext;
}
}
// Return png or jpg icons, if found.
return $icons;
}
/**
* Get plugin banners.
*
* For the plugin with an available update, check its /images/ directory and see
* if there are any banner files. If any icons are found, they will be used in
* the list table that shows available updates. Icon files are expected to be in
* png or jpg format. The icons should be named as follows:
*
* Normal Icons: icon-128.{png|jpg}
* Retina Icons: icon-256.{png|jpg}
*
* If the remote plugin has no icon files in its /images/ directory, then a core
* placeholder image is used.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param object $plugin_post
* @param string $plugin_identifier
* @return array
*/
function get_plugin_banners($request) {
// Initialization.
$banners = [
'default' => '',
'low' => '',
'high' => '',
];
// If banner URLs passed in remotely, return those after a quick cleanse.
if (!empty($request['banner_urls'])) {
$allowed_keys = ['default', 'low', 'high'];
foreach ((array)$request['banner_urls'] as $key=>$banner) {
if (in_array($key, $allowed_keys, true)) {
$banners[$key] = esc_url($banner);
}
}
}
// Return any banner URLs.
return $banners;
}
/**
* Recursive tag removal.
*
* @author John Alarcon
*
* @since 1.0.0
*
* @param array|string $value
* @return array|string String devoid of tags.
*/
function strip_tags_deep($value) {
// Oh, it's an array? Drill down.
if (is_array($value)) {
return array_map(__NAMESPACE__.'\strip_tags_deep', $value);
}
// At last, a string! Strip the tags.
return strip_tags($value);
}
/**
* Get plugin ratings.
*
* This function will eventually gather the actual "stars" received with a given
* rating and translate those values into an array. Since this functionality has
* not been implemented yet, all the ratings are being presumed 5-stars and math
* is done base on that to come up with plugins' score (out of 100).
*
* @author John Alarcon
*
* @since 2.0.0
*
* @param string $opinions
* @return array
*/
function get_ratings($opinions) {
// Default data to start with.
$ratings = [ 5=>0, 4=>0, 3=>0, 2=>0, 1=>0 ];
// Capture counts of ratings.
foreach ($opinions as $line) {
if (!empty($line = trim($line))) {
if (strpos($line, '*') === 0) {
$ratings[strlen($line)] += 1;
}
}
}
// Return the array.
return $ratings;
}
/**
* Get plugin ratings.
*
* This function will eventually gather the actual "stars" received with a given
* rating and translate those values into an array. Since this functionality has
* not been implemented yet, all the ratings are being presumed 5-stars and math
* is done base on that to come up with plugins' score (out of 100).
*
* @author John Alarcon
*
* @since 1.0.0
*
* @deprecated 2.0.0 Use get_ratings() function instead.
*
* @param string $opinions
* @return array
*/
function get_plugin_ratings($opinions) {
return get_ratings($opinions);
}
/**
* Get plugin score.
*
* The function calculates the plugin's user-rated score, up to 100.
*
* @author John Alarcon
*
* @since 2.0.0
*
* @param array $ratings
* @param integer $total
* @return integer
*/
function get_score($ratings, $total) {
// Missing arguments? Bail.
if (empty($ratings) || empty($total)) {
return 0;
}
// Determine the sum of all ratings.
$rating_sum = 0;
for ($i=1; $i<=5; $i++) {
$rating_sum += (int)$ratings[$i] * $i;
}
// Calculate the score.
$score = floor($rating_sum / (int)$total * 20);