desktop-mode / desktop-mode.php

desktop-mode.php in OpenStation: Desktop Windows, Dock & Virtual Desktops for WP Admin 0.9.8, at desktop-mode.php

281 lines 13.2 KB

Raw Download Zip

1	<?php
2	/**
3	* Plugin Name: Desktop Mode
4	* Plugin URI: https://github.com/WordPress/desktop-mode
5	* Description: Renders the WordPress admin as a desktop OS. Admin screens become draggable, resizable, minimizable windows floating on a desktop with a dock. Purely opt-in per user.
6	* Version: 0.9.8
7	* Requires at least: 6.0
8	* Requires PHP: 7.4
9	* Author: Daniel López Sánchez
10	* Author URI: https://github.com/allterraindeveloper
11	* License: GPLv2 or later
12	* License URI: https://www.gnu.org/licenses/gpl-2.0.html
13	* Text Domain: desktop-mode
14	*
15	* @package WPDesktopMode
16	*/
17
18	defined( 'ABSPATH' ) \|\| exit;
19
20	define( 'DESKTOP_MODE_VERSION', '0.9.8' );
21	define( 'DESKTOP_MODE_FILE', __FILE__ );
22	define( 'DESKTOP_MODE_DIR', plugin_dir_path( __FILE__ ) );
23	define( 'DESKTOP_MODE_URL', plugin_dir_url( __FILE__ ) );
24
25	/**
26	* Whether the current request needs the admin-rendering modules.
27	*
28	* Most of the plugin must load on every request — feature modules
29	* register REST routes, record content mutations that can originate
30	* on the frontend (comment submission, WooCommerce orders, plugin-
31	* driven post saves), and expose `desktop_mode_register_*()` APIs
32	* that third-party plugins call from their own `init` hooks in any
33	* context. But the admin rendering layer (shell markup, asset
34	* enqueues, the chromeless bridge, admin notices, migrations, the
35	* `wp_ajax_*` save handler) only ever fires on hooks that don't
36	* exist outside wp-admin — so a pure frontend page view can skip
37	* parsing and wiring ~6,500 lines of it.
38	*
39	* Anything ambiguous loads everything: admin (including admin-ajax,
40	* where Heartbeat lands), REST (sniffed early — `REST_REQUEST` isn't
41	* defined until `parse_request`), cron, WP-CLI, and the PHPUnit
42	* environment (the test bootstrap loads the plugin outside admin
43	* context but exercises the render layer directly).
44	*
45	* @return bool True to load the admin-rendering modules.
46	*/
47	function desktop_mode_request_needs_admin_modules() {
48	$needs = is_admin()
49	\|\| wp_doing_cron()
50	\|\| ( defined( 'WP_CLI' ) && WP_CLI )
51	\|\| ( defined( 'WP_TESTS_DOMAIN' ) )
52	\|\| ( defined( 'REST_REQUEST' ) && REST_REQUEST );
53
54	if ( ! $needs ) {
55	// Early REST sniff. False positives just load a little more
56	// code (safe direction); plain-permalink REST is covered by
57	// the `rest_route` query var.
58	$rest_prefix = function_exists( 'rest_get_url_prefix' ) ? rest_get_url_prefix() : 'wp-json';
59	$request_uri = isset( $_SERVER['REQUEST_URI'] ) ? (string) $_SERVER['REQUEST_URI'] : '';
60	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- request-shape sniff only, no data is read.
61	if ( ( '' !== $rest_prefix && false !== strpos( $request_uri, '/' . $rest_prefix ) ) \|\| isset( $_GET['rest_route'] ) ) {
62	$needs = true;
63	}
64	}
65
66	/**
67	* Filter whether the admin-rendering modules load on this request.
68	*
69	* Escape hatch for unusual setups — e.g. a frontend integration
70	* that internally dispatches `desktop-mode/v1` REST routes via
71	* `rest_do_request()` outside a sniffable REST request can force
72	* the full load by returning true.
73	*
74	* @param bool $needs Whether the current request loads the
75	* admin-rendering module set.
76	*/
77	return (bool) apply_filters( 'desktop_mode_load_admin_modules', $needs );
78	}
79
80	// Foundation primitives — must load before anything that consumes them.
81	require_once DESKTOP_MODE_DIR . 'includes/core/registry-factory.php';
82
83	// Routing helpers register filters at file-load time but call
84	// chromeless / classic detection helpers (still in helpers.php)
85	// at hook-fire time — both files load before any hook fires, so
86	// the order is strict-but-flexible. Routing first because it is
87	// the smaller, more isolated piece.
88	require_once DESKTOP_MODE_DIR . 'includes/core/routing.php';
89
90	require_once DESKTOP_MODE_DIR . 'includes/helpers.php';
91
92	// Dock + payload assembly. Loaded right after helpers.php so the
93	// foundational `desktop_mode_is_enabled()` etc. exist by the time
94	// any payload function is invoked at hook-fire time.
95	require_once DESKTOP_MODE_DIR . 'includes/core/payload.php';
96	require_once DESKTOP_MODE_DIR . 'includes/assets.php';
97	require_once DESKTOP_MODE_DIR . 'includes/admin-bar.php';
98	require_once DESKTOP_MODE_DIR . 'includes/session.php';
99	require_once DESKTOP_MODE_DIR . 'includes/presence.php';
100	require_once DESKTOP_MODE_DIR . 'includes/nonce-refresh.php';
101	require_once DESKTOP_MODE_DIR . 'includes/sticky-notes/heartbeat.php';
102	require_once DESKTOP_MODE_DIR . 'includes/os-settings.php';
103	require_once DESKTOP_MODE_DIR . 'includes/seen-intros.php';
104	require_once DESKTOP_MODE_DIR . 'includes/portal.php';
105	require_once DESKTOP_MODE_DIR . 'includes/default-window.php';
106	require_once DESKTOP_MODE_DIR . 'includes/themes-tabs.php';
107	require_once DESKTOP_MODE_DIR . 'includes/media-query.php';
108	require_once DESKTOP_MODE_DIR . 'includes/accents.php';
109	require_once DESKTOP_MODE_DIR . 'includes/toast-types.php';
110	require_once DESKTOP_MODE_DIR . 'includes/registries/native-windows.php';
111	require_once DESKTOP_MODE_DIR . 'includes/registries/window-tabs.php';
112	require_once DESKTOP_MODE_DIR . 'includes/registries/icons.php';
113	require_once DESKTOP_MODE_DIR . 'includes/registries/wallpapers.php';
114	require_once DESKTOP_MODE_DIR . 'includes/registries/widgets.php';
115	require_once DESKTOP_MODE_DIR . 'includes/components.php';
116	require_once DESKTOP_MODE_DIR . 'includes/commands.php';
117	require_once DESKTOP_MODE_DIR . 'includes/settings-tabs.php';
118	require_once DESKTOP_MODE_DIR . 'includes/dock-rail-renderer.php';
119	require_once DESKTOP_MODE_DIR . 'includes/title-bar-buttons.php';
120	require_once DESKTOP_MODE_DIR . 'includes/unfocus-effects.php';
121	require_once DESKTOP_MODE_DIR . 'includes/window-links.php';
122	require_once DESKTOP_MODE_DIR . 'includes/window-chrome.php';
123	require_once DESKTOP_MODE_DIR . 'includes/window-notices.php';
124	require_once DESKTOP_MODE_DIR . 'includes/wallpapers.php';
125	require_once DESKTOP_MODE_DIR . 'includes/widgets/heartbeat.php';
126	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-comments.php';
127	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-post-stats.php';
128	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-site-views.php';
129	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-jazz-quote.php';
130	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-starter.php';
131	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-notes.php';
132	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-drafts.php';
133	require_once DESKTOP_MODE_DIR . 'includes/widgets/widget-focus-timer.php';
134	require_once DESKTOP_MODE_DIR . 'includes/extended-options.php';
135	require_once DESKTOP_MODE_DIR . 'includes/oauth-relay.php';
136	require_once DESKTOP_MODE_DIR . 'includes/ai-copilot/bootstrap.php';
137	// Content-changes must load before the recycle bin — the bin's
138	// changelog delegates into the generic recorder.
139	require_once DESKTOP_MODE_DIR . 'includes/content-changes.php';
140	require_once DESKTOP_MODE_DIR . 'includes/recycle-bin/bootstrap.php';
141	require_once DESKTOP_MODE_DIR . 'includes/desktop-files/bootstrap.php';
142	require_once DESKTOP_MODE_DIR . 'includes/desktop-themes/bootstrap.php';
143	require_once DESKTOP_MODE_DIR . 'includes/notes/bootstrap.php';
144	require_once DESKTOP_MODE_DIR . 'includes/posts-window/bootstrap.php';
145	require_once DESKTOP_MODE_DIR . 'includes/pages-window/bootstrap.php';
146	require_once DESKTOP_MODE_DIR . 'includes/users-window/bootstrap.php';
147	require_once DESKTOP_MODE_DIR . 'includes/user-edit-window/bootstrap.php';
148	require_once DESKTOP_MODE_DIR . 'includes/plugins-window/bootstrap.php';
149	require_once DESKTOP_MODE_DIR . 'includes/comments-window/bootstrap.php';
150	require_once DESKTOP_MODE_DIR . 'includes/my-wordpress/bootstrap.php';
151	require_once DESKTOP_MODE_DIR . 'includes/content-graph/bootstrap.php';
152	require_once DESKTOP_MODE_DIR . 'includes/living-tree/bootstrap.php';
153	require_once DESKTOP_MODE_DIR . 'includes/games/bootstrap.php';
154	require_once DESKTOP_MODE_DIR . 'includes/agents/bootstrap.php';
155	require_once DESKTOP_MODE_DIR . 'includes/pwa.php';
156	require_once DESKTOP_MODE_DIR . 'includes/compat/divi.php';
157
158	// Admin-rendering modules — every hook these register (`admin_init`,
159	// `admin_enqueue_scripts`, `in_admin_header`, `admin_head`,
160	// `admin_footer`, `admin_body_class`, `wp_ajax_*`) only fires inside
161	// wp-admin, so pure frontend page views skip them entirely. REST,
162	// cron, WP-CLI, admin-ajax, and the PHPUnit environment all load
163	// them (see desktop_mode_request_needs_admin_modules()). Relative
164	// order preserved from the historical unconditional list.
165	if ( desktop_mode_request_needs_admin_modules() ) {
166	require_once DESKTOP_MODE_DIR . 'includes/ajax.php';
167	// One-time data migrations. After os-settings.php so the meta-key
168	// constant and save/sanitize helpers the migrations call already exist.
169	require_once DESKTOP_MODE_DIR . 'includes/migrations.php';
170	require_once DESKTOP_MODE_DIR . 'includes/welcome-dialog.php';
171	require_once DESKTOP_MODE_DIR . 'includes/update-notice.php';
172	require_once DESKTOP_MODE_DIR . 'includes/core-notices.php';
173	require_once DESKTOP_MODE_DIR . 'includes/plugin-notices.php';
174	require_once DESKTOP_MODE_DIR . 'includes/render.php';
175	require_once DESKTOP_MODE_DIR . 'includes/devtools.php';
176	}
177
178	/**
179	* Cascade-deactivate plugins that declare `Requires Plugins: desktop-mode`
180	* when Desktop Mode itself is being deactivated.
181	*
182	* Without this, a third-party plugin like `wp-desktop-messages` keeps
183	* its `init` hook armed after Desktop Mode is turned off — the next
184	* admin page load fires `init`, the hook calls
185	* `desktop_mode_register_window()`, and the request fatals because the
186	* function lives in the plugin we just deactivated. The user lands on
187	* a white screen instead of the classic admin we redirected them to.
188	*
189	* WordPress's plugin dependency feature (6.5+) blocks ACTIVATION of a
190	* plugin whose declared `Requires Plugins` aren't all active, but it
191	* does NOT auto-deactivate dependents when their requirement is
192	* deactivated through any path — the user is expected to do that
193	* themselves. The classic plugins.php list shows a warning; the REST
194	* controller (`PUT /wp/v2/plugins/desktop-mode/desktop-mode`) we route
195	* through has no such gate. So we cascade ourselves.
196	*
197	* Timing: `deactivate_plugins()` writes `active_plugins` to the DB
198	* AFTER its hook loop finishes. If we call `deactivate_plugins()`
199	* from inside our `register_deactivation_hook` callback, our nested
200	* write-back is overwritten the moment the outer call runs its own
201	* `update_option`. So we register the cascade to fire on
202	* `shutdown` — by then the outer `deactivate_plugins` has finished
203	* and our write-back sticks.
204	*
205	* Matching uses `WP_Plugin_Dependencies::get_dependents()` keyed on
206	* our own directory slug (`dirname( plugin_basename( __FILE__ ) )`),
207	* which is the same string the dependent's `Requires Plugins` header
208	* resolves against. The filter below lets sites widen or narrow the
209	* cascade — e.g. add a plugin that wraps `desktop_mode_*` calls in
210	* `function_exists` guards and shouldn't be torn down with us.
211	*
212	* Silent deactivation (`$silent = true`) skips the dependent
213	* plugins' own deactivation hooks. Those callbacks routinely call
214	* `desktop_mode_*` helpers expecting Desktop Mode to be wired up;
215	* firing them mid-cascade can trigger the same fatal we're trying
216	* to prevent. Skipping them is the safer default.
217	*/
218	function desktop_mode_cascade_deactivate_dependents() {
219	// Defer to `shutdown` so we run AFTER the outer
220	// `deactivate_plugins()` has flushed its own option update.
221	// Inline cascade gets clobbered by the outer's write-back.
222	add_action( 'shutdown', 'desktop_mode_do_cascade_deactivate', 0 );
223	}
224	register_deactivation_hook( DESKTOP_MODE_FILE, 'desktop_mode_cascade_deactivate_dependents' );
225
226	/**
227	* The deferred cascade body — runs on `shutdown` after the
228	* outer `deactivate_plugins()` has persisted its update.
229	*
230	* Split out from the `register_deactivation_hook` callback because
231	* that callback must register, not execute, the cascade. See
232	* {@see desktop_mode_cascade_deactivate_dependents} for the timing
233	* rationale.
234	*/
235	function desktop_mode_do_cascade_deactivate() {
236	if ( ! class_exists( 'WP_Plugin_Dependencies' ) ) {
237	// Pre-6.5 — no native dependency tracking. Sites running an
238	// old Core won't have dependents declared via the header
239	// either; nothing to cascade.
240	return;
241	}
242
243	WP_Plugin_Dependencies::initialize();
244
245	$slug = dirname( plugin_basename( DESKTOP_MODE_FILE ) );
246	if ( '' === $slug \|\| '.' === $slug ) {
247	return;
248	}
249
250	$dependents = (array) WP_Plugin_Dependencies::get_dependents( $slug );
251
252	/**
253	* Filter the list of plugin files to cascade-deactivate when
254	* Desktop Mode is deactivated. Defaults to every plugin whose
255	* `Requires Plugins` header lists our directory slug.
256	*
257	* @param string[] $dependents Plugin files (e.g. "foo/foo.php").
258	* @param string $slug Desktop Mode's directory slug.
259	*/
260	$dependents = (array) apply_filters(
261	'desktop_mode_cascade_deactivate_dependents',
262	$dependents,
263	$slug
264	);
265
266	if ( empty( $dependents ) ) {
267	return;
268	}
269
270	$active = (array) get_option( 'active_plugins', array() );
271	$targets = array_values( array_intersect( $active, $dependents ) );
272	if ( empty( $targets ) ) {
273	return;
274	}
275
276	if ( ! function_exists( 'deactivate_plugins' ) ) {
277	require_once ABSPATH . 'wp-admin/includes/plugin.php';
278	}
279	deactivate_plugins( $targets, true );
280	}
281