PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.3
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.3
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
jetpack / _inc / lib / admin-pages / class-akismet-admin-chrome.php

class-akismet-admin-chrome.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.3, at _inc/lib/admin-pages/class-akismet-admin-chrome.php

364 lines 17.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Renders the unified Jetpack admin header and footer chrome on Akismet's admin pages.
4 *
5 * Akismet (5.7+) exposes two action hooks in its admin views:
6 * - `akismet_header`: when an action is registered, it REPLACES Akismet's default masthead.
7 * - `akismet_footer`: rendered at the bottom of every admin view; empty by default.
8 *
9 * This integration consumes those hooks from the Jetpack plugin so that Akismet's pages
10 * share the same branded header bar, standardized footer AND contained layout as the rest
11 * of the unified Jetpack admin (the `@wordpress/admin-ui` page header + `JetpackFooter` look
12 * used by My Jetpack, Protect, Social, etc.): a fixed header, an internally-scrolling middle
13 * and a footer pinned to the bottom of the viewport.
14 *
15 * The markup mirrors the admin-ui page header and `.jetpack-footer` component, and the
16 * styling is a small self-contained stylesheet (no external CSS, no JS, no build step) that
17 * reproduces the measured computed styles of those components plus the
18 * `jetpack-admin-page-layout` mixin, adapted to Akismet's markup
19 * (`#wpbody-content > #akismet-plugin-container > header / .akismet-lower / footer`). This
20 * keeps the integration resilient to the CSS-Module class hashing used by the real React
21 * components.
22 *
23 * NOTE: This class does not modify the Akismet plugin in any way. It only registers
24 * callbacks on Akismet's own action hooks.
25 *
26 * @package automattic/jetpack
27 */
28
29 use Automattic\Jetpack\Plugin\Footer_Links;
30 use Automattic\Jetpack\Redirect;
31 use Automattic\Jetpack\Status;
32 use Automattic\Jetpack\Status\Host;
33
34 if ( ! defined( 'ABSPATH' ) ) {
35 exit( 0 );
36 }
37
38 /**
39 * Wires the unified Jetpack header, footer and contained layout onto Akismet's admin pages.
40 */
41 class Akismet_Admin_Chrome {
42
43 /**
44 * The green Jetpack logo mark, sized via the `height` attribute by callers.
45 *
46 * @param int $height Pixel height of the logo.
47 * @return string SVG markup.
48 */
49 private function jetpack_logo( $height ) {
50 return '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" height="' . (int) $height . '" class="jp-akismet-logo" aria-hidden="true"><path fill="#069e08" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16s16-7.2,16-16S24.8,0,16,0z M15,19H7l8-16V19z M17,29V13h8L17,29z"></path></svg>';
51 }
52
53 /**
54 * The Akismet logo mark — the green rounded square with the white "A", taken from
55 * Akismet's own `akismet-refresh-logo.svg`. Sized via the `height` attribute by callers.
56 *
57 * @param int $height Pixel height of the logo.
58 * @return string SVG markup.
59 */
60 private function akismet_logo( $height ) {
61 return '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 44 44" height="' . (int) $height . '" class="jp-akismet-mark" aria-hidden="true"><rect width="44" height="44" fill="#357B49" rx="6"/><path fill="#fff" fill-rule="evenodd" d="m29.746 28.31-6.392-16.797c-.152-.397-.305-.672-.789-.675-.673 0-1.408.611-1.746 1.316l-7.378 16.154c-.072.16-.143.311-.214.454-.5.995-1.045 1.546-2.357 1.626a.399.399 0 0 0-.16.033l-.01.004a.399.399 0 0 0-.23.392v.01c0 .054.01.106.03.155l.004.01a.416.416 0 0 0 .394.252h6.212a.417.417 0 0 0 .307-.12.416.416 0 0 0 .124-.305.398.398 0 0 0-.105-.302.399.399 0 0 0-.294-.127c-.757 0-2.197-.062-2.197-1.164.02-.318.103-.63.245-.916l1.399-3.152c.52-1.163 1.654-1.163 2.572-1.163h5.843c.023 0 .044 0 .062.003.13.014.16.081.214.242l1.534 4.07a2.857 2.857 0 0 1 .216 1.04c0 .054-.003.104-.01.153-.09.726-.831.887-1.49.887a.4.4 0 0 0-.294.127l-.007.008-.007.008a.401.401 0 0 0-.092.286v.01c0 .054.01.106.03.155l.005.01a.42.42 0 0 0 .395.252h7.011a.413.413 0 0 0 .279-.13.412.412 0 0 0 .11-.297.387.387 0 0 0-.09-.294.388.388 0 0 0-.277-.135c-1.448-.122-2.295-.643-2.847-2.08Zm-11.985-5.844 2.847-6.304c.361-.728.659-1.486.889-2.265 0-.06.03-.092.06-.092s.061.032.061.091c.02.122.045.247.073.374.197.888.584 1.878.914 2.723l.176.453 1.684 4.529a.927.927 0 0 1 .092.4.473.473 0 0 1-.009.094c-.041.202-.228.272-.602.272h-6.063c-.122 0-.184-.03-.184-.092a.36.36 0 0 1 .062-.183Zm17.107-.721c0 .786-.446 1.231-1.25 1.231-.806 0-1.125-.409-1.125-1.034 0-.786.465-1.231 1.25-1.231.785 0 1.125.427 1.125 1.034ZM9.629 23.002c.803 0 1.25-.447 1.25-1.231 0-.607-.343-1.036-1.128-1.036-.785 0-1.25.447-1.25 1.231 0 .625.325 1.036 1.128 1.036Z" clip-rule="evenodd"/></svg>';
62 }
63
64 /**
65 * Register the hooks that drive the chrome.
66 *
67 * Safe to call unconditionally: the header/footer callbacks are only ever fired by
68 * Akismet's own admin views, and the inline stylesheet is printed alongside the header.
69 *
70 * Idempotent: this can be wired from more than one place depending on the platform —
71 * `Jetpack_Admin` on Atomic/self-hosted, and `Akismet_Admin_WPCOM` on WordPress.com
72 * Simple sites (the two run under different load orders). The static guard ensures the
73 * `akismet_header` / `akismet_footer` callbacks are only ever registered once, so the
74 * chrome can never render twice regardless of how many call sites fire.
75 */
76 public function init_hooks() {
77 static $registered = false;
78 if ( $registered ) {
79 return;
80 }
81 $registered = true;
82
83 add_action( 'akismet_header', array( $this, 'render_header' ) );
84 add_action( 'akismet_footer', array( $this, 'render_footer' ) );
85 }
86
87 /**
88 * The self-contained stylesheet reproducing the admin-ui page header + `.jetpack-footer`
89 * computed styles. Printed once, alongside the header.
90 */
91 private function print_styles() {
92 static $printed = false;
93 if ( $printed ) {
94 return;
95 }
96 $printed = true;
97 ?>
98 <style id="jp-akismet-chrome-css">
99 /* ── Header (admin-ui page header look) ── */
100 .jp-akismet-header {
101 display: flex;
102 align-items: center;
103 box-sizing: border-box;
104 min-height: 72px;
105 padding: 16px 24px;
106 background: #fff;
107 /* `box-shadow` (not `border-bottom`) so the hairline never adds to the
108 box and nudges the logo/title off the admin-ui header's vertical center. */
109 box-shadow: inset 0 -1px 0 #e4e4e4;
110 }
111 .jp-akismet-header__title {
112 display: flex;
113 align-items: center;
114 gap: 8px;
115 text-decoration: none;
116 }
117 /* Keep the ring to keyboard focus. Scoped to the container to outrank
118 wp-admin's `a:focus` and Akismet's `#akismet-plugin-container
119 a:focus-visible`, which both beat a bare class selector. */
120 #akismet-plugin-container .jp-akismet-header__title:focus:not( :focus-visible ) {
121 box-shadow: none;
122 outline: none;
123 }
124 #akismet-plugin-container .jp-akismet-header__title:focus-visible {
125 border-radius: 2px;
126 box-shadow: 0 0 0 2px #2271b1;
127 outline: 2px solid transparent;
128 }
129 /* 24×24 visual slot centering the 20px logo, matching My Jetpack/Boost. */
130 .jp-akismet-header__visual {
131 display: flex;
132 align-items: center;
133 justify-content: center;
134 flex-shrink: 0;
135 width: 24px;
136 height: 24px;
137 }
138 .jp-akismet-header__title h1 {
139 margin: 0;
140 padding: 0;
141 font-size: 15px;
142 font-weight: 500;
143 line-height: 20px;
144 color: #1e1e1e;
145 }
146 /* ── Footer (.jetpack-footer look) ── */
147 .jp-akismet-footer {
148 display: flex;
149 align-items: center;
150 flex-wrap: wrap;
151 gap: 24px;
152 box-sizing: border-box;
153 padding: 20px 24px;
154 border-top: 1px solid #e4e4e4;
155 background: #fff;
156 color: #1e1e1e;
157 font-size: 13px;
158 }
159 .jp-akismet-footer__logo {
160 display: flex;
161 align-items: center;
162 gap: 8px;
163 font-weight: 500;
164 }
165 .jp-akismet-footer__menu {
166 display: flex;
167 gap: 16px;
168 }
169 /* `#akismet-plugin-container a` is green in Akismet's own CSS; this scoped
170 selector outranks it so the footer links read as neutral grey (#707070,
171 matching My Jetpack's footer links). */
172 #akismet-plugin-container .jp-akismet-footer__menu a {
173 color: #707070;
174 text-decoration: none;
175 }
176 #akismet-plugin-container .jp-akismet-footer__menu a:hover {
177 color: #1e1e1e;
178 text-decoration: underline;
179 }
180 .jp-akismet-footer__a8c {
181 margin-inline-start: auto;
182 display: inline-flex;
183 align-items: center;
184 }
185 /* Mobile: the byline drops its right-push and wraps to its own full-width
186 row, left-aligned — matching how JetpackFooter stacks on other pages. */
187 @media (max-width: 782px) {
188 .jp-akismet-footer__a8c {
189 margin-inline-start: 0;
190 flex-basis: 100%;
191 }
192 }
193 .jp-akismet-footer__a8c svg path {
194 fill: #707070;
195 }
196
197 /* ── Hello Dolly ──
198 The `.jetpack-admin-page #dolly` treatment (right-aligned, italic,
199 WPDS colors) ships in the jetpack-components / My Jetpack admin CSS,
200 which doesn't load on Akismet's page — so without this, Dolly's lyric
201 falls back to left-aligned here. Re-declare it so Dolly lands top-right
202 exactly like every other unified Jetpack admin page. */
203 .jetpack-admin-page #dolly {
204 float: none;
205 text-align: end;
206 background: var(--wpds-color-background-surface-neutral-strong, #fff);
207 font-style: italic;
208 color: var(--wpds-color-foreground-content-neutral-weak, #87a6bc);
209 border-bottom: none;
210 }
211 @media (max-width: 659px) {
212 .jetpack-admin-page #dolly {
213 display: none;
214 }
215 }
216
217 /* ── Contained layout: fixed header, scrolling middle, pinned footer ──
218 Mirrors the jetpack-admin-page-layout mixin, adapted to Akismet's
219 markup (#wpbody-content > #akismet-plugin-container > header/.akismet-lower/footer).
220 Scoped to both menu locations: jetpack_page_… and settings_page_…
221
222 Logical properties throughout, like the mixin, so it flips under RTL. */
223 body[class*="_page_akismet-key-config"] #wpcontent {
224 padding-inline-start: 0;
225 }
226 body[class*="_page_akismet-key-config"] #wpfooter {
227 display: none;
228 }
229 /* `#screen-meta-links` (the Screen Options / Help tabs container) is always
230 emitted by core's admin header even when empty, and core gives it
231 `margin: 0 10px 20px 0`. On wp.com Simple sites its contents are hidden
232 but the element — and its 20px bottom margin — remain, reserving a blank
233 slot at the very top of the page above the Jetpack header. The
234 `jetpack-admin-page-layout` mixin hides it for the same reason; do it here
235 too. Left UNSCOPED (not under `_page_akismet-key-config`) on purpose: the
236 inline stylesheet is only ever printed on Akismet admin views, and Simple
237 renders its stats UI under a different slug (`dashboard_page_akismet-stats`),
238 so an unscoped rule covers every page this chrome appears on. */
239 #screen-meta-links {
240 display: none;
241 }
242 body[class*="_page_akismet-key-config"] #wpbody-content {
243 box-sizing: border-box;
244 position: fixed;
245 top: var(--wp-admin-bar-height, 32px);
246 inset-inline-start: 160px;
247 inset-inline-end: 0;
248 bottom: 0;
249 width: auto;
250 padding-bottom: 0;
251 overflow: hidden;
252 display: flex;
253 flex-direction: column;
254 }
255 body[class*="_page_akismet-key-config"].folded #wpbody-content {
256 inset-inline-start: 36px;
257 }
258 @media (max-width: 960px) {
259 body[class*="_page_akismet-key-config"].auto-fold #wpbody-content {
260 inset-inline-start: 36px;
261 }
262 }
263 @media (min-width: 961px) {
264 body[class*="_page_akismet-key-config"].is-nav-unification:not(.folded) #wpbody-content {
265 inset-inline-start: 272px;
266 }
267 }
268 body[class*="_page_akismet-key-config"] #akismet-plugin-container {
269 flex: 1 1 auto;
270 min-height: 0;
271 min-width: 0;
272 display: flex;
273 flex-direction: column;
274 /* Drop Akismet's 1px container border: it insets the whole column by 1px,
275 pushing the header logo/title off the admin-ui alignment grid. */
276 border: 0;
277 }
278 body[class*="_page_akismet-key-config"] .jp-akismet-header {
279 flex-shrink: 0;
280 }
281 /* The scrollable middle. Target the generic child between header and
282 footer (not `.akismet-lower` specifically) so the config, start AND
283 stats (bare iframe) views all get a full-width scroll surface. The
284 `#wpbody-content` id keeps these rules ahead of Akismet's own
285 `.akismet-lower { width: 720px }`. */
286 body[class*="_page_akismet-key-config"] #wpbody-content > #akismet-plugin-container > :not(.jp-akismet-header):not(.jp-akismet-footer) {
287 flex: 1 1 auto;
288 min-height: 0;
289 min-width: 0;
290 width: auto;
291 max-width: none;
292 margin: 0;
293 overflow: auto;
294 }
295 /* Move the readable-width restriction onto the content blocks so the
296 scroll surface itself spans the full width (scrolling works wherever
297 the pointer is), while the cards stay a comfortable column, left-
298 aligned with the header. 45rem ≈ Akismet's original 720px column. */
299 body[class*="_page_akismet-key-config"] .akismet-lower > * {
300 box-sizing: border-box;
301 max-width: 45rem;
302 margin-inline: auto;
303 }
304 body[class*="_page_akismet-key-config"] .jp-akismet-footer {
305 flex-shrink: 0;
306 }
307 @media (max-width: 782px) {
308 body[class*="_page_akismet-key-config"] #wpbody-content,
309 body[class*="_page_akismet-key-config"].folded #wpbody-content,
310 body[class*="_page_akismet-key-config"].auto-fold #wpbody-content {
311 top: var(--wp-admin-bar-height, 46px);
312 inset-inline-start: 0;
313 }
314 }
315 </style>
316 <?php
317 }
318
319 /**
320 * Render the admin-ui-style header (Akismet logo + title) that replaces Akismet's default masthead.
321 */
322 public function render_header() {
323 $this->print_styles();
324 ?>
325 <header class="jp-akismet-header">
326 <a class="jp-akismet-header__title" href="<?php echo esc_url( admin_url( 'admin.php?page=akismet-key-config' ) ); ?>">
327 <span class="jp-akismet-header__visual" aria-hidden="true"><?php echo $this->akismet_logo( 20 ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- static SVG. ?></span>
328 <h1><?php esc_html_e( 'Akismet Anti-spam', 'jetpack' ); ?></h1>
329 </a>
330 </header>
331 <?php
332 }
333
334 /**
335 * Render the unified Jetpack footer (`.jetpack-footer` look) at the bottom of the page.
336 */
337 public function render_footer() {
338 // Match wrap_ui(): link the byline to the local About page when Jetpack isn't connectable,
339 // otherwise to the external jetpack.com redirect.
340 $connectable = ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode();
341 $a8c_url = ! $connectable
342 ? admin_url( 'admin.php?page=jetpack_about' )
343 : Redirect::get_url( 'jetpack' );
344 ?>
345 <footer class="jp-akismet-footer jetpack-footer" aria-label="<?php esc_attr_e( 'Jetpack', 'jetpack' ); ?>" role="contentinfo">
346 <div class="jp-akismet-footer__logo">
347 <?php echo $this->jetpack_logo( 16 ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- static SVG. ?>
348 <span><?php esc_html_e( 'Jetpack', 'jetpack' ); ?></span>
349 </div>
350 <?php if ( ! ( new Host() )->is_wpcom_platform() ) : ?>
351 <?php $products_section = Footer_Links::get_my_jetpack_products_section(); ?>
352 <nav class="jp-akismet-footer__menu">
353 <a href="<?php echo esc_url( admin_url( 'admin.php?page=my-jetpack#/' . $products_section['slug'] ) ); ?>"><?php echo esc_html( $products_section['label'] ); ?></a>
354 <a href="<?php echo esc_url( admin_url( 'admin.php?page=my-jetpack#/help' ) ); ?>"><?php echo esc_html_x( 'Help', 'Navigation item', 'jetpack' ); ?></a>
355 </nav>
356 <?php endif; ?>
357 <a class="jp-akismet-footer__a8c" href="<?php echo esc_url( $a8c_url ); ?>" aria-label="<?php esc_attr_e( 'An Automattic Airline', 'jetpack' ); ?>">
358 <svg role="img" x="0" y="0" viewBox="0 0 935 38.2" height="7" aria-hidden="true"><path d="M317.1 38.2c-12.6 0-20.7-9.1-20.7-18.5v-1.2c0-9.6 8.2-18.5 20.7-18.5 12.6 0 20.8 8.9 20.8 18.5v1.2C337.9 29.1 329.7 38.2 317.1 38.2zM331.2 18.6c0-6.9-5-13-14.1-13s-14 6.1-14 13v0.9c0 6.9 5 13.1 14 13.1s14.1-6.2 14.1-13.1V18.6zM175 36.8l-4.7-8.8h-20.9l-4.5 8.8h-7L157 1.3h5.5L182 36.8H175zM159.7 8.2L152 23.1h15.7L159.7 8.2zM212.4 38.2c-12.7 0-18.7-6.9-18.7-16.2V1.3h6.6v20.9c0 6.6 4.3 10.5 12.5 10.5 8.4 0 11.9-3.9 11.9-10.5V1.3h6.7V22C231.4 30.8 225.8 38.2 212.4 38.2zM268.6 6.8v30h-6.7v-30h-15.5V1.3h37.7v5.5H268.6zM397.3 36.8V8.7l-1.8 3.1 -14.9 25h-3.3l-14.7-25 -1.8-3.1v28.1h-6.5V1.3h9.2l14 24.4 1.7 3 1.7-3 13.9-24.4h9.1v35.5H397.3zM454.4 36.8l-4.7-8.8h-20.9l-4.5 8.8h-7l19.2-35.5h5.5l19.5 35.5H454.4zM439.1 8.2l-7.7 14.9h15.7L439.1 8.2zM488.4 6.8v30h-6.7v-30h-15.5V1.3h37.7v5.5H488.4zM537.3 6.8v30h-6.7v-30h-15.5V1.3h37.7v5.5H537.3zM569.3 36.8V4.6c2.7 0 3.7-1.4 3.7-3.4h2.8v35.5L569.3 36.8 569.3 36.8zM628 11.3c-3.2-2.9-7.9-5.7-14.2-5.7 -9.5 0-14.8 6.5-14.8 13.3v0.7c0 6.7 5.4 13 15.3 13 5.9 0 10.8-2.8 13.9-5.7l4 4.2c-3.9 3.8-10.5 7.1-18.3 7.1 -13.4 0-21.6-8.7-21.6-18.3v-1.2c0-9.6 8.9-18.7 21.9-18.7 7.5 0 14.3 3.1 18 7.1L628 11.3zM321.5 12.4c1.2 0.8 1.5 2.4 0.8 3.6l-6.1 9.4c-0.8 1.2-2.4 1.6-3.6 0.8l0 0c-1.2-0.8-1.5-2.4-0.8-3.6l6.1-9.4C318.7 11.9 320.3 11.6 321.5 12.4L321.5 12.4z"></path><path d="M37.5 36.7l-4.7-8.9H11.7l-4.6 8.9H0L19.4 0.8H25l19.7 35.9H37.5zM22 7.8l-7.8 15.1h15.9L22 7.8zM82.8 36.7l-23.3-24 -2.3-2.5v26.6h-6.7v-36H57l22.6 24 2.3 2.6V0.8h6.7v35.9H82.8z"></path><path d="M719.9 37l-4.8-8.9H694l-4.6 8.9h-7.1l19.5-36h5.6l19.8 36H719.9zM704.4 8l-7.8 15.1h15.9L704.4 8zM733 37V1h6.8v36H733zM781 37c-1.8 0-2.6-2.5-2.9-5.8l-0.2-3.7c-0.2-3.6-1.7-5.1-8.4-5.1h-12.8V37H750V1h19.6c10.8 0 15.7 4.3 15.7 9.9 0 3.9-2 7.7-9 9 7 0.5 8.5 3.7 8.6 7.9l0.1 3c0.1 2.5 0.5 4.3 2.2 6.1V37H781zM778.5 11.8c0-2.6-2.1-5.1-7.9-5.1h-13.8v10.8h14.4c5 0 7.3-2.4 7.3-5.2V11.8zM794.8 37V1h6.8v30.4h28.2V37H794.8zM836.7 37V1h6.8v36H836.7zM886.2 37l-23.4-24.1 -2.3-2.5V37h-6.8V1h6.5l22.7 24.1 2.3 2.6V1h6.8v36H886.2zM902.3 37V1H935v5.6h-26v9.2h20v5.5h-20v10.1h26V37H902.3z"></path></svg>
359 </a>
360 </footer>
361 <?php
362 }
363 }
364