class-abstract-page.php
29.4 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
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
<?php
/**
* Abstract class for Smush view: Abstract_Page
*
* @package Smush\App
*/
namespace Smush\App;
use Smush\Core\Helper;
use Smush\Core\Settings;
use WP_Smush;
use WPMUDEV_Dashboard;
if ( ! defined( 'WPINC' ) ) {
die;
}
/**
* Class Abstract_Page
*/
abstract class Abstract_Page {
/**
* Page slug.
*
* @var string
*/
private $slug;
/**
* Page ID.
*
* @var false|string
*/
private $page_id;
/**
* Meta boxes array.
*
* @var array
*/
protected $meta_boxes = array();
/**
* Modals to render.
*
* @since 3.8.3
*
* @var array
*/
protected $modals = array();
/**
* Submenu tabs.
*
* @var array
*/
protected $tabs = array();
/**
* Settings instance for faster access.
*
* @since 3.0
*
* @var Settings
*/
protected $settings;
/**
* Link to upgrade.
*
* @var string $upgrade_url
*/
protected $upgrade_url = 'https://wpmudev.com/project/wp-smush-pro/';
/**
* Abstract_Page constructor.
*
* @param string $slug Page slug.
* @param string $title Page title.
* @param bool $parent Does a page have a parent (will be added as a sub menu).
* @param bool $nextgen Is that a NextGen subpage.
*/
public function __construct( $slug, $title, $parent = false, $nextgen = false ) {
$this->slug = $slug;
$this->settings = Settings::get_instance();
if ( ! $parent ) {
$this->page_id = add_menu_page(
$title,
$title,
'manage_options',
$this->slug,
null,
$this->get_menu_icon()
);
} else {
$this->page_id = add_submenu_page(
$parent,
$title,
$title,
$nextgen ? 'NextGEN Manage gallery' : 'manage_options',
$this->slug,
array( $this, 'render' )
);
}
// No need to load these action on parent pages, as they are just placeholders for sub pages.
if ( $parent ) {
add_filter( 'load-' . $this->page_id, array( $this, 'on_load' ) );
add_action( 'load-' . $this->page_id, array( $this, 'register_meta_boxes' ) );
add_filter( 'load-' . $this->page_id, array( $this, 'add_action_hooks' ) );
}
}
/**
* Common hooks for all screens
*
* @since 2.9.0
*/
public function add_action_hooks() {
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
// Notices.
add_action( 'admin_notices', array( $this, 'smush_deactivated' ) );
add_action( 'network_admin_notices', array( $this, 'smush_deactivated' ) );
add_action( 'wp_smush_header_notices', array( $this, 'settings_updated' ) );
// Check for any stored API message and show it.
add_action( 'wp_smush_header_notices', array( $this, 'show_api_message' ) );
add_action( 'admin_notices', array( $this, 'smush_dash_required' ) );
add_action( 'network_admin_notices', array( $this, 'smush_dash_required' ) );
add_action( 'wp_smush_render_setting_row', array( $this, 'render_row' ), 10, 4 );
add_filter( 'admin_body_class', array( $this, 'smush_body_classes' ) );
// Filter query args to remove from the URL.
add_filter( 'removable_query_args', array( $this, 'add_removable_query_args' ) );
}
/**
* Enqueue scripts.
*
* @since 3.8.8
*
* @param string $hook Hook from where the call is made.
*/
public function enqueue_scripts( $hook ) {}
/**
* Return the admin menu slug
*
* @return string
*/
public function get_slug() {
return $this->slug;
}
/**
* Load an admin view.
*
* @param string $name View name = file name.
* @param array $args Arguments.
* @param string $dir Directory for the views. Default: views.
*/
public function view( $name, $args = array(), $dir = 'views' ) {
$file = WP_SMUSH_DIR . "app/{$dir}/{$name}.php";
$content = '';
if ( is_file( $file ) ) {
ob_start();
if ( isset( $args['id'] ) ) {
$args['orig_id'] = $args['id'];
$args['id'] = str_replace( '/', '-', $args['id'] );
}
extract( $args );
include $file;
$content = ob_get_clean();
}
// Everything escaped in all template files.
echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Display an admin notice about plugin deactivation.
*/
public function smush_deactivated() {
// Display only in backend for administrators.
if ( ! is_admin() || ! is_super_admin() || ! get_site_option( 'smush_deactivated' ) ) {
return;
}
?>
<div class="updated">
<p>
<?php esc_html_e( 'Smush Free was deactivated. You have Smush Pro active!', 'wp-smushit' ); ?>
</p>
</div>
<?php
delete_site_option( 'smush_deactivated' );
}
/**
* Show notice when Smush Pro is installed only with a key.
*/
public function smush_dash_required() {
if ( WP_Smush::is_pro() || ! is_super_admin() || ( class_exists( 'WPMUDEV_Dashboard' ) && WPMUDEV_Dashboard::$api->has_key() ) ) {
return;
}
// Do not show on free versions of the plugin.
if ( false !== strpos( WP_SMUSH_DIR, 'wp-smushit' ) ) {
return;
}
$function = is_multisite() ? 'network_admin_url' : 'admin_url';
$url = wp_nonce_url(
$function( 'update.php?action=install-plugin&plugin=install_wpmudev_dash' ),
'install-plugin_install_wpmudev_dash'
);
?>
<div class="notice smush-notice">
<div class="smush-notice-logo">
<img
src="<?php echo esc_url( WP_SMUSH_URL . 'app/assets/images/incsub-logo.png' ); ?>"
srcset="<?php echo esc_url( WP_SMUSH_URL . 'app/assets/images/incsub-logo@2x.png' ); ?> 2x"
alt="<?php esc_html_e( 'Smush CDN', 'wp-smushit' ); ?>"
>
</div>
<div class="smush-notice-message">
<?php esc_html_e( 'Smush Pro requires the WPMU DEV Dashboard plugin to unlock pro features. Please make sure you have installed, activated and logged into the Dashboard.', 'wp-smushit' ); ?>
</div>
<div class="smush-notice-cta">
<?php if ( class_exists( 'WPMUDEV_Dashboard' ) && ! WPMUDEV_Dashboard::$api->has_key() ) : ?>
<a href="<?php echo esc_url( network_admin_url( 'admin.php?page=wpmudev' ) ); ?>" class="smush-notice-act button-primary" target="_blank">
<?php esc_html_e( 'Log In', 'wp-smushit' ); ?>
</a>
<?php else : ?>
<a href="<?php echo esc_url( $url ); ?>" class="smush-notice-act button-primary">
<?php esc_html_e( 'Install Plugin', 'wp-smushit' ); ?>
</a>
<?php endif; ?>
</div>
</div>
<?php
}
/**
* Add Share UI Class.
*
* @param string $classes Classes string.
*
* @return string
*/
public function smush_body_classes( $classes ) {
// Exit if function doesn't exists.
if ( ! function_exists( 'get_current_screen' ) ) {
return $classes;
}
// If not on plugin page.
if ( ! in_array( get_current_screen()->id, Admin::$plugin_pages, true ) && false === strpos( get_current_screen()->id, 'page_smush' ) ) {
return $classes;
}
// Remove old wpmud class from body of smush page to avoid style conflict.
$classes = str_replace( 'wpmud ', '', $classes );
$classes .= ' ' . WP_SHARED_UI_VERSION;
return $classes;
}
/**
* Filters the query args to remove from the URL.
*
* @since 3.8.0
*
* @param array $args Removable query args.
* @return array
*/
public function add_removable_query_args( $args ) {
$args[] = 'notice';
return $args;
}
/**
* Allows to register meta boxes for the page.
*
* @since 2.9.0
*/
public function register_meta_boxes() {}
/**
* Add meta box.
*
* @param string $id Meta box ID.
* @param string $title Meta box title.
* @param callable $callback Callback for meta box content.
* @param callable $callback_header Callback for meta box header.
* @param callable $callback_footer Callback for meta box footer.
* @param string $context Meta box context.
* @param array $args Arguments.
*/
public function add_meta_box( $id, $title, $callback = null, $callback_header = null, $callback_footer = null, $context = 'main', $args = array() ) {
$default_args = array(
'box_class' => 'sui-box',
'box_header_class' => 'sui-box-header',
'box_content_class' => 'sui-box-body',
'box_footer_class' => 'sui-box-footer',
);
$args = wp_parse_args( $args, $default_args );
if ( ! isset( $this->meta_boxes[ $this->slug ] ) ) {
$this->meta_boxes[ $this->slug ] = array();
}
if ( ! isset( $this->meta_boxes[ $this->slug ][ $context ] ) ) {
$this->meta_boxes[ $this->slug ][ $context ] = array();
}
if ( ! isset( $this->meta_boxes[ $this->slug ][ $context ] ) ) {
$this->meta_boxes[ $this->slug ][ $context ] = array();
}
$meta_box = array(
'id' => $id,
'title' => $title,
'callback' => $callback,
'callback_header' => $callback_header,
'callback_footer' => $callback_footer,
'args' => $args,
);
if ( $meta_box ) {
$this->meta_boxes[ $this->slug ][ $context ][ $id ] = $meta_box;
}
}
/**
* Render the page
*/
public function render() {
// Shared UI wrapper with accessible color option.
$classes = $this->settings->get( 'accessible_colors' ) ? 'sui-wrap sui-color-accessible' : 'sui-wrap';
echo '<div class="' . esc_attr( $classes ) . ' wrap-' . esc_attr( $this->slug ) . '">';
$this->render_page_header();
$this->render_modals();
$this->render_inner_content();
// Nonce field.
wp_nonce_field( 'save_wp_smush_options', 'wp_smush_options_nonce', '' );
// Close shared ui wrapper.
echo '</div>';
}
/**
* Renders all the modals to be used in the page.
*
* @since 3.7.0
*/
private function render_modals() {
$this->prepare_modals();
// Render all modals.
foreach ( $this->modals as $modal_file => $args ) {
$this->view( $modal_file, $args, 'modals' );
}
}
private function prepare_modals() {
$this->prepare_onboarding_modal();
$this->prepare_upgrade_modal();
}
/**
* Onboarding Modal (show onload).
*
* List bulk smush features, and the related settings.
*
* => Expect to show it for the fresh installation.
* And we will show it when users can access bulk smush page.
* 1. Show it on single site.
* 2. For MU site, it depends on Sub-site Controls:
* 2.1. IF disable bulk smush page for sub-sites
* => Only show it on network side.
* 2.2. IF enable bulk smush page for sub-sites:
* - Show it for sub-sites.
* - Now we do not show it for network side since we do not show bulk smush page there.
* TODO: Maybe show it when we support bulk smush page on network side, @see: SMUSH-369
*/
private function prepare_onboarding_modal() {
$skip_quick_setup = ! empty( get_option( 'skip-smush-setup' ) );
if (
$skip_quick_setup
|| $this->has_onload_modal()
|| ! $this->settings->has_bulk_smush_page()
) {
return;
}
$this->modals['onboarding'] = array(
'cta_url' => Helper::get_recheck_images_link(),
);
}
private function has_onload_modal( $modal = false ) {
if (
empty( $this->modals )
|| ( $modal && ! isset( $this->modals[ $modal ] ) )
) {
return false;
}
$onload_modals = array(
'onboarding',
'updated',
);
$rendered_onload_modals = array_intersect( $onload_modals, array_keys( $this->modals ) );
return ! empty( $rendered_onload_modals );
}
/**
* Upgrade/New Feature modal (show onload).
*
* Show it when users can access bulk smush page, and network admin.
*/
private function prepare_upgrade_modal() {
$whitelabel_hide_doc_link = apply_filters( 'wpmudev_branding_hide_doc_link', false );
$hide_upgrade_modal = empty( get_site_option( 'wp-smush-show_upgrade_modal' ) );
$is_on_subsite_screen = ! is_network_admin();
if (
$this->has_onload_modal()
|| $hide_upgrade_modal
|| $whitelabel_hide_doc_link
|| ( $is_on_subsite_screen && ! $this->settings->has_bulk_smush_page() )
) {
$should_ignore_upgrade_modal = $whitelabel_hide_doc_link || $this->has_onload_modal( 'onboarding' );
if ( $should_ignore_upgrade_modal ) {
delete_site_option( 'wp-smush-show_upgrade_modal' );
}
return;
}
$this->modals['updated'] = array(
'cta_url' => Helper::get_recheck_images_link(),
);
}
/**
* Get the current screen tab
*
* @return string
*/
public function get_current_tab() {
$tabs = $this->get_tabs();
$view = filter_input( INPUT_GET, 'view', FILTER_SANITIZE_SPECIAL_CHARS );
if ( $view && array_key_exists( $view, $tabs ) ) {
return $view;
}
if ( empty( $tabs ) ) {
return false;
}
reset( $tabs );
return key( $tabs );
}
/**
* Display tabs navigation
*/
public function show_tabs() {
$this->view(
'tabs',
array(
'tabs' => $this->get_tabs(),
)
);
}
/**
* Get a tab URL
*
* @param string $tab Tab ID.
*
* @return string
*/
public function get_tab_url( $tab ) {
$tabs = $this->get_tabs();
if ( ! isset( $tabs[ $tab ] ) ) {
return '';
}
if ( is_multisite() && is_network_admin() ) {
return network_admin_url( 'admin.php?page=' . $this->slug . '&view=' . $tab );
} else {
return admin_url( 'admin.php?page=' . $this->slug . '&view=' . $tab );
}
}
/**
* Get the list of tabs for this screen
*
* @return array
*/
protected function get_tabs() {
return apply_filters( 'wp_smush_admin_page_tabs_' . $this->slug, $this->tabs );
}
/**
* Render inner content.
*/
protected function render_inner_content() {
$this->view( 'smush-page' );
}
/**
* Render meta box.
*
* @param string $context Meta box context. Default: main.
*/
protected function do_meta_boxes( $context = 'main' ) {
if ( empty( $this->meta_boxes[ $this->slug ][ $context ] ) ) {
return;
}
do_action_ref_array( 'wp_smush_admin_do_meta_boxes_' . $this->slug, array( &$this ) );
foreach ( $this->meta_boxes[ $this->slug ][ $context ] as $id => $box ) {
$args = array(
'title' => $box['title'],
'id' => $id,
'callback' => $box['callback'],
'callback_header' => $box['callback_header'],
'callback_footer' => $box['callback_footer'],
'args' => $box['args'],
);
$this->view( 'meta-box', $args );
}
}
/**
* Check if there is any meta box for a given context.
*
* @param string $context Meta box context.
*
* @return bool
*/
protected function has_meta_boxes( $context ) {
return ! empty( $this->meta_boxes[ $this->slug ][ $context ] );
}
/**
* Check if view exists.
*
* @param string $name View name = file name.
*
* @return bool
*/
protected function view_exists( $name ) {
$file = WP_SMUSH_DIR . "app/views/$name.php";
return is_file( $file );
}
/**
* Smush icon svg image
*
* @return string
*/
private function get_menu_icon() {
ob_start();
?>
<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M10 2C11.5823 2 13.129 2.46921 14.4446 3.34826C15.7601 4.22731 16.7855 5.47672 17.391 6.93853C17.9965 8.40034 18.155 10.0089 17.8463 11.5607C17.762 11.9845 17.6439 12.3988 17.494 12.8C17.498 12.7002 17.5 12.6002 17.5 12.5C17.5 10.5109 16.7098 8.60324 15.3033 7.19672C13.8968 5.7902 11.9891 5.00001 10 5.00001C8.51664 5.00001 7.06659 5.43987 5.83323 6.26398C4.59986 7.08809 3.63856 8.25944 3.0709 9.62989C2.65354 10.6375 2.46275 11.7195 2.506 12.8C2.1731 11.909 2.00001 10.961 2.00001 9.99999C2.00001 7.87826 2.84286 5.84343 4.34315 4.34314C5.84344 2.84285 7.87827 2 10 2ZM13.8268 19.2388C12.6157 19.7405 11.3239 19.9966 10.0256 20H10.0152C10.005 20 9.99483 20 9.98464 20H9.97449C9.33106 19.9983 8.68626 19.9346 8.04911 19.8078C6.1093 19.422 4.32746 18.4696 2.92893 17.0711C1.53041 15.6726 0.578002 13.8907 0.192151 11.9509C-0.193701 10.0111 0.00433534 8.00041 0.761211 6.17315C1.51809 4.34589 2.79982 2.78411 4.44431 1.6853C6.0888 0.586488 8.02219 0 10 0C12.6522 0 15.1957 1.05359 17.0711 2.92895C18.9464 4.80432 20 7.34783 20 9.99999C20 11.9778 19.4135 13.9112 18.3147 15.5557C17.2159 17.2002 15.6541 18.4819 13.8268 19.2388ZM10.0139 18H9.98611C9.59872 17.9982 9.21338 17.9214 8.85196 17.7717C8.30378 17.5446 7.83523 17.1601 7.50559 16.6667C7.17594 16.1734 7 15.5933 7 15C7 14.2043 7.31606 13.4413 7.87866 12.8787C8.44127 12.3161 9.20435 12 10 12C10.5933 12 11.1734 12.176 11.6667 12.5056C12.1601 12.8353 12.5446 13.3038 12.7716 13.852C12.9987 14.4002 13.0581 15.0033 12.9424 15.5853C12.8266 16.1672 12.5409 16.7018 12.1213 17.1213C11.7017 17.5409 11.1672 17.8266 10.5853 17.9424C10.3962 17.98 10.2049 17.9991 10.0139 18ZM14.996 14.8C14.9459 13.5466 14.426 12.3549 13.5355 11.4645C12.5978 10.5268 11.3261 10 10 10C9.01109 10 8.04439 10.2932 7.22214 10.8427C6.3999 11.3921 5.75903 12.173 5.38059 13.0866C5.15387 13.6339 5.02745 14.2142 5.004 14.8C4.67336 14.0818 4.50001 13.2975 4.50001 12.5C4.50265 11.0421 5.08296 9.64471 6.11384 8.61383C7.14471 7.58296 8.54212 7.00265 10 7.00001C11.0878 7.00001 12.1512 7.3226 13.0556 7.92695C13.9601 8.53129 14.665 9.39027 15.0813 10.3953C15.4976 11.4003 15.6065 12.5061 15.3943 13.573C15.3097 13.9984 15.1755 14.41 14.996 14.8Z" fill="#F0F6FC"/>
</svg>
<?php
$svg = ob_get_clean();
return 'data:image/svg+xml;base64,' . base64_encode( $svg );
}
/**
* Get the documentation url.
*
* @since 3.8.6
*
* @return string
*/
public function get_doc_url() {
$doc = 'https://wpmudev.com/docs/wpmu-dev-plugins/smush/';
if ( ! WP_Smush::is_pro() ) {
$doc = 'https://wpmudev.com/docs/wpmu-dev-plugins/smush/?utm_source=smush&utm_medium=plugin&utm_campaign=smush_pluginlist_docs';
}
switch ( $this->get_slug() ) {
case 'smush-bulk':
$doc .= '#bulk-smush';
break;
case 'smush-directory':
$doc .= '#directory-smush';
break;
case 'smush-lazy-load':
$doc .= '#lazy-loading';
break;
case 'smush-cdn':
$doc .= '#cdn';
break;
case 'smush-webp':
$doc .= '#local-webp';
break;
case 'smush-integrations':
$doc .= '#integrations';
break;
case 'smush-tools':
$doc .= '#tools';
break;
case 'smush-settings':
$doc .= '#settings';
break;
}
return $doc;
}
/**
* Prints out the page header for bulk smush page.
*
* @return void
*/
public function render_page_header() {
$current_screen = get_current_screen();
?>
<div class="sui-header">
<h1 class="sui-header-title"><?php echo esc_html( get_admin_page_title() ); ?></h1>
<div class="sui-actions-right">
<?php
if (
! is_network_admin() &&
( 'smush-bulk' === $this->get_slug() || in_array( $this->page_id, array( 'nextgen-gallery_page_wp-smush-nextgen-bulk', 'gallery_page_wp-smush-nextgen-bulk' ), true ) )
) :
?>
<?php
$data_type = in_array( $current_screen->id, array( 'nextgen-gallery_page_wp-smush-nextgen-bulk', 'gallery_page_wp-smush-nextgen-bulk' ), true ) ? 'nextgen' : 'media';
$button_class_names = array(
'sui-button',
'wp-smush-scan'
);
if ( 'media' === $data_type ) {
$button_class_names[] = 'wp-smush-background-scan';
}
?>
<button class="<?php echo esc_attr( join( ' ', $button_class_names ) );?>" data-tooltip="<?php esc_attr_e( 'Lets you check if any images can be further optimized. Useful after changing settings.', 'wp-smushit' ); ?>" data-type="<?php echo esc_attr( $data_type ); ?>">
<span class="sui-loading-text wp-smush-default-text">
<i class="sui-icon-update" aria-hidden="true"></i>
<span class="wp-smush-inner-text"><?php esc_html_e( 'Re-Check Images', 'wp-smushit' ); ?></span>
</span>
<span class="sui-hidden wp-smush-completed-text">
<i class="sui-icon-check-tick" aria-hidden="true"></i>
<?php esc_html_e( 'Check Complete', 'wp-smushit' ); ?>
</span>
<i class="sui-icon-loader sui-loading" aria-hidden="true"></i>
</button>
<?php endif; ?>
<?php if ( ! apply_filters( 'wpmudev_branding_hide_doc_link', false ) ) : ?>
<a href="<?php echo esc_url( $this->get_doc_url() ); ?>" class="sui-button sui-button-ghost" target="_blank">
<i class="sui-icon-academy" aria-hidden="true"></i> <?php esc_html_e( 'Documentation', 'wp-smushit' ); ?>
</a>
<?php endif; ?>
</div>
</div>
<div class="sui-floating-notices">
<div role="alert" id="wp-smush-ajax-notice" class="sui-notice" aria-live="assertive"></div>
<?php do_action( 'wp_smush_header_notices', $this->get_current_tab() ); ?>
</div>
<?php
}
/**
* Display a stored API message.
*/
public function show_api_message() {
// Do not show message for any other users.
if ( ! is_network_admin() && ! is_super_admin() ) {
return;
}
$api_message = get_site_option( 'wp-smush-api_message', array() );
$api_message = current( $api_message );
// Return if the API message is not set or user dismissed it earlier.
if ( empty( $api_message ) || ! is_array( $api_message ) || 'show' !== $api_message['status'] ) {
return;
}
$message = empty( $api_message['message'] ) ? '' : $api_message['message'];
$message_type = ! empty( $api_message['type'] ) ? $api_message['type'] : 'info';
$type_class = 'warning' === $message_type ? 'sui-notice-warning' : 'sui-notice-info';
?>
<div class="sui-notice <?php echo esc_attr( $type_class ); ?>" id="wp-smush-api-message">
<div class="sui-notice-content">
<div class="sui-notice-message">
<i class="sui-notice-icon sui-icon-info" aria-hidden="true"></i>
<p><?php echo wp_kses_post( $message ); ?></p>
</div>
<div class="sui-notice-actions">
<button class="sui-button-icon">
<i class="sui-icon-check" aria-hidden="true"></i>
<span class="sui-screen-reader-text"><?php esc_html_e( 'Dismiss', 'wp-smushit' ); ?></span>
</button>
</div>
</div>
</div>
<?php
}
/**
* Displays a admin notice for settings update.
*
* @TODO: Refactor. This is a weird way to check for settings update.
*/
public function settings_updated() {
// Check if network-wide settings are enabled, do not show settings updated message.
if ( is_multisite() && ! is_network_admin() && ! Settings::can_access( 'bulk' ) ) {
return;
}
// Show settings saved message.
if ( ! get_option( 'wp-smush-settings_updated' ) ) {
return;
}
$core = WP_Smush::get_instance()->core();
// Default message.
$message = esc_html__( 'Your settings have been updated!', 'wp-smushit' );
// Notice class.
$message_class = 'success';
if ( 'smush-cdn' === $this->get_slug() ) {
$cdn = $this->settings->get_setting( 'wp-smush-cdn_status' );
if ( isset( $cdn->cdn_enabling ) && $cdn->cdn_enabling ) {
$message = esc_html__( 'Your settings have been saved and changes are now propagating to the CDN. Changes can take up to 30 minutes to take effect but your images will continue to be served in the meantime, please be patient.', 'wp-smushit' );
}
}
// Additional message if we got work to do!
$resmush_count = is_array( $core->resmush_ids ) && count( $core->resmush_ids ) > 0;
$smush_count = is_array( $core->remaining_count ) && $core->remaining_count > 0;
if ( $smush_count || $resmush_count ) {
$message_class = 'warning';
// Show link to bulk smush tab from other tabs.
$bulk_smush_link = 'smush-bulk' === $this->get_slug() ? '<a href="#" class="wp-smush-trigger-bulk">' : '<a href="' . $this->get_page_url() . '">';
/* translators: %1$s - <a>, %2$s - </a> */
$message .= ' ' . sprintf( esc_html__( 'You have images that need smushing. %1$sBulk smush now!%2$s', 'wp-smushit' ), $bulk_smush_link, '</a>' );
}
?>
<script>
document.addEventListener("DOMContentLoaded", function() {
window.SUI.openNotice(
'wp-smush-ajax-notice',
'<p><?php echo wp_kses_post( $message ); ?></p>',
{
type: '<?php echo esc_attr( $message_class ); ?>',
icon: 'info',
}
);
});
</script>
<?php
// Remove the option.
$this->settings->delete_setting( 'wp-smush-settings_updated' );
}
/**
* Check if the page should be rendered.
*
* @since 3.2.2
* @since 3.8.0 Added $tab parameter.
*
* @param string $page Page to check for.
*
* @return bool
*/
public static function should_render( $page = '' ) {
// Render all pages on single site installs.
if ( ! is_multisite() ) {
return true;
}
if ( empty( $page ) ) {
return false;
}
$access = get_site_option( 'wp-smush-networkwide' );
if ( ! $access || in_array( $page, array( 'directory', 'webp', 'configs' ), true ) ) {
return is_network_admin();
}
if ( '1' === $access ) {
return ! is_network_admin();
}
if ( is_array( $access ) ) {
if ( is_network_admin() && ! in_array( $page, $access, true ) ) {
return true;
}
if ( ! is_network_admin() && in_array( $page, $access, true ) ) {
return true;
}
}
return false;
}
/**
* Return this menu page URL
*
* @since 3.5.0
*
* @return string
*/
public function get_page_url() {
if ( is_multisite() && is_network_admin() ) {
global $_parent_pages;
if ( isset( $_parent_pages[ $this->slug ] ) ) {
$parent_slug = $_parent_pages[ $this->slug ];
if ( $parent_slug && ! isset( $_parent_pages[ $parent_slug ] ) ) {
$url = network_admin_url( add_query_arg( 'page', $this->slug, $parent_slug ) );
} else {
$url = network_admin_url( 'admin.php?page=' . $this->slug );
}
} else {
$url = '';
}
return esc_url( $url );
} else {
return menu_page_url( $this->slug, false );
}
}
/**
* Get a page URL.
*
* @param string $page Page slug.
*
* @return string
*/
public function get_url( $page = '' ) {
if ( ! $page ) {
$page = $this->get_slug();
}
return Helper::get_page_url( $page );
}
/**
* Render setting row.
*
* @param string $name Setting name.
* @param bool $value Setting value.
* @param bool $disable Disable row/option.
* @param bool $upsell Is the row an upsell.
*/
public function render_row( $name, $value, $disable = false, $upsell = false ) {
$this->view( 'settings-row', compact( 'name', 'value', 'disable', 'upsell' ) );
}
/**
* Enqueue scripts.
* Used by the Tutorials and Dashboard pages.
*/
protected function enqueue_tutorials_scripts() {
wp_enqueue_script(
'smush-tutorials',
WP_SMUSH_URL . 'app/assets/js/smush-tutorials.min.js',
array( 'wp-i18n' ),
WP_SMUSH_VERSION,
true
);
$strings = array(
'tutorials' => esc_html__( 'Tutorials', 'wp-smushit' ),
'tutorials_link' => 'https://wpmudev.com/blog/tutorials/tutorial-category/smush-pro/',
'tutorials_strings' => array(
array(
'loading' => esc_html__( 'Loading tutorials...', 'wp-smushit' ),
'min_read' => esc_html__( 'min read', 'wp-smushit' ),
'read_article' => esc_html__( 'Read article', 'wp-smushit' ),
),
),
);
wp_localize_script( 'smush-tutorials', 'smush_tutorials', $strings );
}
/**
* Enqueue the scripts for configs.
* Used in the Settings and Dashboard pages.
*
* @since 3.9.0
*/
protected function enqueue_configs_scripts() {
// Configs are only used on single installs and on the network admin on MU.
if ( is_multisite() && ! is_network_admin() ) {
return;
}
wp_enqueue_script(
'smush-react-configs',
WP_SMUSH_URL . 'app/assets/js/smush-react-configs.min.js',
array( 'wp-i18n', 'smush-sui' ),
WP_SMUSH_VERSION,
true
);
wp_add_inline_script(
'smush-react-configs',
'wp.i18n.setLocaleData( ' . wp_json_encode( $this->get_locale_data() ) . ', "wp-smushit" );',
'before'
);
// Configs.
wp_localize_script(
'smush-react-configs',
'smushReact',
array(
'hideBranding' => apply_filters( 'wpmudev_branding_hide_branding', false ),
'isPro' => WP_Smush::is_pro(),
'links' => array(
'configsPage' => network_admin_url( 'admin.php?page=smush-settings&view=configs' ),
'accordionImg' => WP_SMUSH_URL . 'app/assets/images/smush-config-icon@2x.png',
'hubConfigs' => 'https://wpmudev.com/hub2/configs/my-configs',
'hubWelcome' => 'https://wpmudev.com/hub-welcome/?utm_source=smush&utm_medium=plugin&utm_campaign=smush_hub_config',
'freeNoticeHub' => 'https://wpmudev.com/hub-welcome/?utm_source=smush&utm_medium=plugin&utm_campaign=smush_hub_config',
),
'requestsData' => array(
'root' => esc_url_raw( rest_url( 'wp-smush/v1/preset_configs' ) ),
'nonce' => wp_create_nonce( 'wp_rest' ),
'apiKey' => Helper::get_wpmudev_apikey(),
'hubBaseURL' => defined( 'WPMUDEV_CUSTOM_API_SERVER' ) && WPMUDEV_CUSTOM_API_SERVER ? trailingslashit( WPMUDEV_CUSTOM_API_SERVER ) . 'api/hub/v1/package-configs' : null,
// Hard-coding these because the Free version doesn't have the WDP ID header in wp-smushit.php.
'pluginData' => array(
'name' => 'Smush' . ( WP_Smush::is_pro() ? ' Pro' : '' ),
'id' => '912164',
),
'pluginRequests' => array(
'nonce' => wp_create_nonce( 'smush_handle_config' ),
'uploadAction' => 'smush_upload_config',
'createAction' => 'smush_save_config',
'applyAction' => 'smush_apply_config',
),
),
)
);
}
/**
* Gets the translated strings for javascript translations.
*
* @since 3.8.5
* @since 3.9.0 Moved from Smush\App\Admin to here.
*
* @return array
*/
protected function get_locale_data() {
$translations = get_translations_for_domain( 'wp-smushit' );
$locale = array(
'' => array(
'domain' => 'wp-smushit',
'lang' => get_user_locale(),
),
);
if ( ! empty( $translations->headers['Plural-Forms'] ) ) {
$locale['']['plural_forms'] = $translations->headers['Plural-Forms'];
}
foreach ( $translations->entries as $msgid => $entry ) {
$locale[ $msgid ] = $entry->translations;
}
return $locale;
}
protected function get_utm_link( $args = array() ) {
$default = array(
'utm_source' => 'smush',
'utm_medium' => 'plugin',
);
$args = wp_parse_args( $args, $default );
return add_query_arg( $args, $this->upgrade_url );
}
}