Test Failed
Push — develop ( db5b9c...b55dd4 )
by Paul
17:52
created

EnqueueAdminAssets::isCurrentScreen()   A

Complexity

Conditions 6
Paths 5

Size

Total Lines 20
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 42

Importance

Changes 2
Bugs 1 Features 0
Metric Value
eloc 15
dl 0
loc 20
ccs 0
cts 14
cp 0
rs 9.2222
c 2
b 1
f 0
cc 6
nc 5
nop 0
crap 42
1
<?php
2
3
namespace GeminiLabs\SiteReviews\Commands;
4
5
use GeminiLabs\SiteReviews\Controllers\ListTableColumns\ColumnFilterAssignedPost;
6
use GeminiLabs\SiteReviews\Controllers\ListTableColumns\ColumnFilterAssignedUser;
7
use GeminiLabs\SiteReviews\Controllers\ListTableColumns\ColumnFilterAuthor;
8
use GeminiLabs\SiteReviews\Defaults\PointerDefaults;
9
use GeminiLabs\SiteReviews\Modules\Rating;
10
use GeminiLabs\SiteReviews\Shortcodes\SiteReviewsFormShortcode;
11
use GeminiLabs\SiteReviews\Shortcodes\SiteReviewShortcode;
12
use GeminiLabs\SiteReviews\Shortcodes\SiteReviewsShortcode;
13
use GeminiLabs\SiteReviews\Shortcodes\SiteReviewsSummaryShortcode;
14
15
class EnqueueAdminAssets extends AbstractCommand
16
{
17
    public array $pointers;
18
19
    public function __construct()
20
    {
21
        $this->generatePointers([
22
            [
23
                'content' => _x('You can pin exceptional reviews so that they are always shown first.', 'admin-text', 'site-reviews'),
24
                'id' => 'glsr-pointer-pinned',
25
                'target' => '#misc-pub-pinned',
26
                'title' => _x('Pin Your Reviews', 'admin-text', 'site-reviews'),
27
            ],
28
        ]);
29
    }
30
31
    public function enqueueScripts(): void
32
    {
33
        if (!empty($this->pointers)) {
34
            wp_enqueue_script('wp-pointer');
35
        }
36
        wp_enqueue_script(
37
            glsr()->id.'/admin',
38
            glsr()->url('assets/scripts/'.glsr()->id.'-admin.js'),
39
            $this->getDependencies(),
40
            glsr()->version,
41
            [
42
                'strategy' => 'defer',
43
            ]
44
        );
45
        wp_add_inline_script(glsr()->id.'/admin', $this->inlineScript(), 'before');
46
        wp_add_inline_script(glsr()->id.'/admin', glsr()->filterString('enqueue/admin/inline-script/after', ''));
47
    }
48
49
    public function enqueueStyles(): void
50
    {
51
        if (!empty($this->pointers)) {
52
            wp_enqueue_style('wp-pointer');
53
        }
54
        wp_enqueue_style('wp-color-picker');
55
        wp_enqueue_style(
56
            glsr()->id.'/admin',
57
            glsr()->url('assets/styles/admin/admin.css'),
58
            ['wp-list-reusable-blocks'], // load the :root admin theme colors
59
            glsr()->version
60
        );
61
        wp_add_inline_style(glsr()->id.'/admin', $this->inlineStyles());
62
    }
63
64
    public function handle(): void
65
    {
66
        if (!$this->isCurrentScreen()) {
67
            $this->fail();
68
            return;
69
        }
70
        $this->enqueueStyles();
71
        $this->enqueueScripts();
72
    }
73
74
    public function inlineScript(): string
75
    {
76
        $variables = [
77
            'action' => glsr()->prefix.'admin_action',
78
            'addons' => [],
79
            'addonsurl' => glsr_admin_url('addons'),
80
            'ajaxurl' => admin_url('admin-ajax.php'),
81
            'filters' => [
82
                'assigned_post' => glsr(ColumnFilterAssignedPost::class)->options(),
83
                'assigned_user' => glsr(ColumnFilterAssignedUser::class)->options(),
84
                'author' => glsr(ColumnFilterAuthor::class)->options(),
85
                'post_author' => (object) [
86
                    '' => sprintf('&mdash; %s &mdash;', _x('No Change', 'admin-text', 'site-reviews')),
87
                    0 => _x('No Author', 'admin-text', 'site-reviews'),
88
                ],
89
                'post_author_override' => (object) [
90
                    0 => _x('Author Unknown', 'admin-text', 'site-reviews'),
91
                ],
92
            ],
93
            'maxrating' => Rating::max(),
94
            'minrating' => Rating::min(),
95
            'nameprefix' => glsr()->id,
96
            'nonce' => [
97
                'clear-console' => wp_create_nonce('clear-console'),
98
                'console-level' => wp_create_nonce('console-level'),
99
                'fetch-console' => wp_create_nonce('fetch-console'),
100
                'filter-assigned_post' => wp_create_nonce('filter-assigned_post'),
101
                'filter-assigned_user' => wp_create_nonce('filter-assigned_user'),
102
                'filter-author' => wp_create_nonce('filter-author'),
103
                'mce-shortcode' => wp_create_nonce('mce-shortcode'),
104
                'search-posts' => wp_create_nonce('search-posts'),
105
                'search-strings' => wp_create_nonce('search-strings'),
106
                'search-users' => wp_create_nonce('search-users'),
107
                'sync-reviews' => wp_create_nonce('sync-reviews'),
108
                'toggle-filters' => wp_create_nonce('toggle-filters'),
109
                'toggle-pinned' => wp_create_nonce('toggle-pinned'),
110
                'toggle-status' => wp_create_nonce('toggle-status'),
111
                'toggle-verified' => wp_create_nonce('toggle-verified'),
112
            ],
113
            'pointers' => $this->pointers,
114
            'shortcodes' => [],
115
            'text' => [
116
                'cancel' => _x('Cancel', 'admin-text', 'site-reviews'),
117
                'cancelling' => _x('Cancelling, please wait...', 'admin-text', 'site-reviews'),
118
                'import_error' => sprintf(_x('Your server restricts file uploads to less than %s in size.', 'admin-text', 'site-reviews'), (string) size_format(wp_max_upload_size())),
119
                'rollback_error' => _x('Rollback failed', 'admin-text', 'site-reviews'),
120
                'searching' => _x('Searching...', 'admin-text', 'site-reviews'),
121
            ],
122
            'tinymce' => [
123
                'glsr_shortcode' => glsr()->url('assets/scripts/mce-plugin.js'),
124
            ],
125
        ];
126
        if (user_can_richedit()) {
127
            $variables['shortcodes'] = $this->localizeShortcodes();
128
        }
129
        $variables = glsr()->filterArray('enqueue/admin/localize', $variables);
130
        return $this->buildInlineScript($variables);
131
    }
132
133
    public function inlineStyles(): string
134
    {
135
        return glsr()->filterString('enqueue/admin/inline-styles', '');
136
    }
137
138
    protected function buildInlineScript(array $variables): string
139
    {
140
        $script = 'window.hasOwnProperty("GLSR")||(window.GLSR={});';
141
        foreach ($variables as $key => $value) {
142
            $script .= sprintf('GLSR.%s=%s;', $key, (string) wp_json_encode($value, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
143
        }
144
        $pattern = '/\"([a-zA-Z]+)\"(:[{\[\"])/'; // remove unnecessary quotes surrounding object keys
145
        $optimizedScript = preg_replace($pattern, '$1$2', $script);
146
        return glsr()->filterString('enqueue/admin/inline-script', $optimizedScript, $script, $variables);
147
    }
148
149
    protected function getDependencies(): array
150
    {
151
        $dependencies = glsr()->filterArray('enqueue/admin/dependencies', []);
152
        $dependencies = array_merge($dependencies, [
153
            'jquery', 'jquery-ui-sortable', 'underscore', 'wp-color-picker', 'wp-util',
154
        ]);
155
        return $dependencies;
156
    }
157
158
    protected function generatePointer(array $pointer): array
159
    {
160
        return [
161
            'id' => $pointer['id'],
162
            'options' => [
163
                'content' => "<h3>{$pointer['title']}</h3>".wpautop($pointer['content']),
164
                'position' => $pointer['position'],
165
            ],
166
            'screen' => $pointer['screen'],
167
            'target' => $pointer['target'],
168
        ];
169
    }
170
171
    /**
172
     * @param array[] $args
173
     */
174
    protected function generatePointers(array $args): void
175
    {
176
        $dismissed = get_user_meta(get_current_user_id(), 'dismissed_wp_pointers', true);
177
        $dismissed = explode(',', (string) $dismissed);
178
        $pointers = [];
179
        foreach ($args as $pointer) {
180
            $pointer = glsr(PointerDefaults::class)->restrict($pointer);
181
            if ($pointer['screen'] !== glsr_current_screen()->id) {
182
                continue;
183
            }
184
            if (in_array($pointer['id'], $dismissed)) {
185
                continue;
186
            }
187
            $pointers[] = $this->generatePointer($pointer);
188
        }
189
        $this->pointers = $pointers;
190
    }
191
192
    protected function isCurrentScreen(): bool
193
    {
194
        if (is_customize_preview()) {
195
            return false; // don't load assets in the Customizer preview
196
        }
197
        $screen = glsr_current_screen();
198
        $screenIds = [
199
            'customize',
200
            'dashboard',
201
            'dashboard_page_'.glsr()->id.'-welcome',
202
            'plugins_page_'.glsr()->id,
203
            'site-editor',
204
            'widgets',
205
        ];
206
        if ('admin' === $screen->base && str_starts_with(filter_input(INPUT_GET, 'import'), glsr()->post_type)) {
207
            return true;
208
        }
209
        return str_starts_with($screen->post_type, glsr()->post_type)
210
            || in_array($screen->id, $screenIds)
211
            || 'post' === $screen->base;
212
    }
213
214
    protected function localizeShortcodes(): array
215
    {
216
        $variables = [];
217
        foreach (glsr()->retrieveAs('array', 'mce', []) as $tag => $args) {
218
            if (!empty($args['required'])) {
219
                $variables[$tag] = $args['required'];
220
            }
221
        }
222
        return $variables;
223
    }
224
}
225