← All changes | includes/helpers.php +137 -53 0.9.1 → 1.1.10 View file →

		@@ -1,21 +1,49 @@
1	1	<?php
2	2	/**
3		- * Desktop Mode helper functions.
	3	+ * OpenStation helper functions.
4	4	*
5		- * @package WPDesktopMode
	5	+ * @package OpenStation
6	6	*/
7	7
8	8	defined( 'ABSPATH' ) || exit;
9	9
10	10	/**
11		- * Checks whether a user has desktop mode enabled.
	11	+ * Filename suffix for built JS/CSS bundles: `.min` in production,
	12	+ * `''` (the unminified dev build) under SCRIPT_DEBUG.
12	13	*
	14	+ * Centralised because the SCRIPT_DEBUG branch needs a guard the old
	15	+ * per-file ternaries didn't have: release zips ship the minified
	16	+ * bundles only (the ~4–5 MB of dev bundles are a source-checkout
	17	+ * artifact — see bin/package.sh), so a production site that happens
	18	+ * to define SCRIPT_DEBUG would otherwise request dev files that
	19	+ * don't exist and 404 every openstation script. Probe one
	20	+ * canonical dev bundle; if it's absent, this is a minified-only
	21	+ * install and `.min` is the only truth available.
	22	+ *
	23	+ * @return string `'.min'` or `''`.
	24	+ */
	25	+function openstation_asset_suffix() {
	26	+ static $suffix = null;
	27	+ if ( null !== $suffix ) {
	28	+ return $suffix;
	29	+ }
	30	+ if ( ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ) {
	31	+ $suffix = '.min';
	32	+ return $suffix;
	33	+ }
	34	+ $suffix = file_exists( OPENSTATION_DIR . 'assets/js/desktop.js' ) ? '' : '.min';
	35	+ return $suffix;
	36	+}
	37	+
	38	+/**
	39	+ * Checks whether a user has OpenStation enabled.
	40	+ *
13	41	* Two gates, both must pass:
14	42	*
15	43	* 1. The user's `desktop_mode_mode` user-meta is `'1'` (the per-user
16	44	* opt-in toggle the admin-bar button writes via the AJAX endpoint).
17		- * 2. The `desktop_mode_mode_enabled` filter returns truthy for that user.
	45	+ * 2. The `openstation_mode_enabled` filter returns truthy for that user.
18	46	*
19	47	* Centralising the filter check here means render-time gates (chromeless
20	48	* detection, payload generation, REST permission callbacks) can rely on
21	49	* a single helper instead of every call site re-running the filter.
		@@ -22,15 +50,13 @@
22	50	* A user whose meta is `'1'` but whose filter denies them is treated as
23	51	* not-enabled everywhere, which is the documented contract of the
24	52	* filter — see docs/examples/gate-by-role.md.
25	53	*
26		- * @since 0.1.0
27		- *
28	54	* @param int $user_id Optional. User ID to check. Defaults to the
29	55	* current user.
30		- * @return bool True if the user has desktop mode active.
	56	+ * @return bool True if the user has OpenStation active.
31	57	*/
32		-function desktop_mode_is_enabled( $user_id = 0 ) {
	58	+function openstation_is_enabled( $user_id = 0 ) {
33	59	$user_id = (int) $user_id;
34	60	if ( $user_id <= 0 ) {
35	61	if ( ! is_user_logged_in() ) {
36	62	return false;
		@@ -42,49 +68,45 @@
42	68	return false;
43	69	}
44	70
45	71	/**
46		- * Filters whether desktop mode is available for this user.
	72	+ * Filters whether OpenStation is available for this user.
47	73	*
48		- * See `docs/hooks-reference.md` (`desktop_mode_mode_enabled`) for the
	74	+ * See `docs/hooks-reference.md` (`openstation_mode_enabled`) for the
49	75	* full contract. Returning `false` here makes the helper return
50	76	* `false` for the user even when their meta is set, which propagates
51	77	* to every render-time gate that consults the helper.
52	78	*
53		- * @since 0.1.0
54		- *
55		- * @param bool $enabled Whether desktop mode is enabled. Default true.
	79	+ * @param bool $enabled Whether OpenStation is enabled. Default true.
56	80	* @param int $user_id The user ID being checked.
57	81	*/
58		- return (bool) apply_filters( 'desktop_mode_mode_enabled', true, $user_id );
	82	+ return (bool) apply_filters( 'openstation_mode_enabled', true, $user_id );
59	83	}
60	84
61	85	/**
62		- * Shared REST permission gate for Desktop Mode's per-user endpoints.
	86	+ * Shared REST permission gate for OpenStation's per-user endpoints.
63	87	*
64	88	* Routes that only ever read or write the *current* user's own Desktop
65	89	* Mode state (OS settings, session, default-window, seen-intros, PWA
66	90	* state, presence) must not be reachable by accounts that haven't
67		- * actually entered Desktop Mode.
	91	+ * actually entered OpenStation.
68	92	*
69	93	* `current_user_can( 'read' )` alone is too loose: every authenticated
70	94	* role — Subscriber included — carries `read`, so the old gate let any
71		- * logged-in user touch these routes without ever enabling Desktop Mode.
72		- * We gate on {@see desktop_mode_is_enabled()} instead (the same opt-in +
73		- * `desktop_mode_mode_enabled` filter the shell itself uses) and return
	95	+ * logged-in user touch these routes without ever enabling OpenStation.
	96	+ * We gate on {@see openstation_is_enabled()} instead (the same opt-in +
	97	+ * `openstation_mode_enabled` filter the shell itself uses) and return
74	98	* the conventional 401/403 split so REST clients can tell "log in" from
75	99	* "not allowed".
76	100	*
77		- * This is the canonical gate; `desktop_mode_presence_rest_permission()`
	101	+ * This is the canonical gate; `openstation_presence_rest_permission()`
78	102	* pioneered the shape and now delegates here.
79	103	*
80		- * @since 0.8.10
81		- *
82	104	* @return true|WP_Error True when allowed; a `rest_forbidden` WP_Error
83		- * (401 when logged out, 403 when desktop mode is
	105	+ * (401 when logged out, 403 when OpenStation is
84	106	* not enabled for the account) otherwise.
85	107	*/
86		-function desktop_mode_rest_require_enabled() {
	108	+function openstation_rest_require_enabled() {
87	109	if ( ! is_user_logged_in() ) {
88	110	return new WP_Error(
89	111	'rest_forbidden',
90	112	__( 'Authentication required.', 'desktop-mode' ),
		@@ -91,12 +113,12 @@
91	113	array( 'status' => 401 )
92	114	);
93	115	}
94	116
95		- if ( ! desktop_mode_is_enabled() ) {
	117	+ if ( ! openstation_is_enabled() ) {
96	118	return new WP_Error(
97	119	'rest_forbidden',
98		- __( 'Desktop mode is not enabled for your account.', 'desktop-mode' ),
	120	+ __( 'OpenStation is not enabled for your account.', 'desktop-mode' ),
99	121	array( 'status' => 403 )
100	122	);
101	123	}
102	124
		@@ -104,18 +126,18 @@
104	126	}
105	127
106	128	// Chromeless / classic admin-bar suppression and the `wp_redirect`
107	129	// flag-preservation filter pair were moved to
108		-// `includes/core/routing.php` in 0.8.1. The functions and the
	130	+// `includes/core/routing.php`. The functions and the
109	131	// add_filter / add_action hookings live there now; this file
110		-// remains the home of `desktop_mode_is_chromeless_request()` and
111		-// `desktop_mode_is_classic_request()` (called from the routing
112		-// helpers at hook-fire time), which is why
113		-// `desktop-mode.php` requires routing.php BEFORE helpers.php.
	132	+// remains the home of `openstation_is_enabled()` (called from the
	133	+// routing helpers at hook-fire time, after every include has
	134	+// loaded), which is why `desktop-mode.php` can safely require
	135	+// routing.php BEFORE helpers.php.
114	136
115	137	/**
116		- * `desktop_mode_is_chromeless_request()` and `desktop_mode_is_classic_request()`
117		- * were moved to `includes/core/routing.php` in 0.8.1 — see that
	138	+ * `openstation_is_chromeless_request()` and `openstation_is_classic_request()`
	139	+ * were moved to `includes/core/routing.php` — see that
118	140	* file for the canonical definitions. The function names didn't
119	141	* change; PHP looks them up by name at call time, so every
120	142	* existing caller (helpers, render, hooks) keeps working.
121	143	*/
		@@ -128,9 +150,9 @@
128	150	* Exposed as a filter so themes/plugins can set a site-wide default
129	151	* without forking the TS build.
130	152	*
131	153	* ```php
132		- * add_filter( 'desktop_mode_default_wallpaper', function () {
	154	+ * add_filter( 'openstation_default_wallpaper', function () {
133	155	* return 'my-plugin/brand';
134	156	* } );
135	157	* ```
136	158	*
		@@ -135,24 +157,20 @@
135	157	* ```
136	158	*
137	159	* The returned string is passed through `sanitize_key()` so a filter
138	160	* that returns an invalid slug degrades to the empty string (and the
139		- * shell falls back to its hard-coded `'dark'` preset).
	161	+ * shell falls back to its hard-coded default preset).
140	162	*
141		- * @since 0.11.0
142		- *
143	163	* @return string Wallpaper id. Empty string if the filter returns
144	164	* an invalid value.
145	165	*/
146		-function desktop_mode_get_default_wallpaper() {
	166	+function openstation_get_default_wallpaper() {
147	167	/**
148	168	* Filters the wallpaper id loaded on first boot / new user.
149	169	*
150		- * @since 0.11.0
151		- *
152	170	* @param string $id Default wallpaper slug.
153	171	*/
154		- $id = apply_filters( 'desktop_mode_default_wallpaper', 'dark' );
	172	+ $id = apply_filters( 'openstation_default_wallpaper', 'galaxy' );
155	173	if ( ! is_string( $id ) ) {
156	174	return '';
157	175	}
158	176	return sanitize_key( $id );
		@@ -158,23 +176,89 @@
158	176	return sanitize_key( $id );
159	177	}
160	178
161	179	/**
162		- * Build a `WP_Error` for a desktop-mode registration failure.
	180	+ * The site's own name, ready to use as a window / icon title.
163	181	*
	182	+ * The desktop shows objects, not the software running it — so the
	183	+ * *root folder* of a site's content is named after the site itself
	184	+ * ("Izzi's Gym"), not after WordPress. That is the breadcrumb root and
	185	+ * the Content Graph's site label; the app that browses it is called WP
	186	+ * Explorer, which is a different string (see
	187	+ * `openstation_my_wordpress_app_title()`). This is the single source
	188	+ * for the site one.
	189	+ *
	190	+ * `get_bloginfo( 'name' )` returns the display-filtered option, which
	191	+ * carries HTML entities (`&amp;`, `&#039;`). Titles land in
	192	+ * `title=` attributes and JS-rendered text nodes, so the entities are
	193	+ * decoded here — leaving them encoded would render a literal
	194	+ * `Ben &amp; Jerry` on the desktop.
	195	+ *
	196	+ * @return string Decoded site title. Falls back to `WordPress` when
	197	+ * the site has no name set.
	198	+ */
	199	+function openstation_site_title() {
	200	+ $title = wp_specialchars_decode( (string) get_bloginfo( 'name' ), ENT_QUOTES );
	201	+ $title = trim( $title );
	202	+
	203	+ if ( '' === $title ) {
	204	+ $title = __( 'WordPress', 'desktop-mode' );
	205	+ }
	206	+
	207	+ /**
	208	+ * Filters the site title used for openstation window and icon
	209	+ * titles — WP Explorer's breadcrumb root, the Content Graph's site
	210	+ * label, and any "Open in <site>" action.
	211	+ *
	212	+ * Return a different string to label the desktop objects after
	213	+ * something other than `blogname` (a brand, a network name, a
	214	+ * per-user workspace label).
	215	+ *
	216	+ * @param string $title Decoded site title, never empty.
	217	+ */
	218	+ $filtered = apply_filters( 'openstation_site_title', $title );
	219	+
	220	+ return is_string( $filtered ) && '' !== trim( $filtered ) ? $filtered : $title;
	221	+}
	222	+
	223	+/**
	224	+ * Decode a rendered title into the plain text the desktop paints with.
	225	+ *
	226	+ * `wptexturize()` encodes the characters titles are full of — `&` as
	227	+ * `&#038;`, an apostrophe as `&#8217;` — and the shell writes titles
	228	+ * into text nodes, where the entity renders as itself. Same reasoning
	229	+ * as {@see openstation_site_title()}, one layer down.
	230	+ *
	231	+ * Decode BEFORE the tag strip, never after: `&lt;script&gt;` decodes
	232	+ * into a real tag, and stripping second is what removes it.
	233	+ *
	234	+ * @param string $rendered A title that has been through a display filter.
	235	+ * @return string Plain text, tag-free.
	236	+ */
	237	+function openstation_plain_text_title( $rendered ) {
	238	+ $decoded = html_entity_decode(
	239	+ (string) $rendered,
	240	+ ENT_QUOTES,
	241	+ get_bloginfo( 'charset' )
	242	+ );
	243	+
	244	+ return trim( wp_strip_all_tags( $decoded ) );
	245	+}
	246	+
	247	+/**
	248	+ * Build a `WP_Error` for a openstation registration failure.
	249	+ *
164	250	* Centralises the error-code vocabulary used by every
165		- * `desktop_mode_register_*()` function so plugin authors see a
	251	+ * `openstation_register_*()` function so plugin authors see a
166	252	* consistent contract. The canonical error-code list lives in
167	253	* `docs/hooks-reference.md`.
168	254	*
169		- * @since 0.11.0
170		- *
171		- * @param string $code Short error slug (e.g. `desktop_mode_missing_title`).
	255	+ * @param string $code Short error slug (e.g. `openstation_missing_title`).
172	256	* @param string $message Human-readable message. Should be translated.
173	257	* @param array $data Optional extra context attached to the error.
174	258	* @return WP_Error
175	259	*/
176		-function desktop_mode_registration_error( $code, $message, $data = array() ) {
	260	+function openstation_registration_error( $code, $message, $data = array() ) {
177	261	return new WP_Error(
178	262	(string) $code,
179	263	(string) $message,
180	264	is_array( $data ) ? $data : array()
		@@ -180,12 +264,12 @@
180	264	is_array( $data ) ? $data : array()
181	265	);
182	266	}
183	267
184		-// `desktop_mode_url_is_same_admin()`,
185		-// `desktop_mode_resolve_admin_target()` and
186		-// `desktop_mode_admin_target_allowlist()` were moved to
187		-// `includes/core/routing.php` in 0.8.1 — see that file for the
	268	+// `openstation_url_is_same_admin()`,
	269	+// `openstation_resolve_admin_target()` and
	270	+// `openstation_admin_target_allowlist()` were moved to
	271	+// `includes/core/routing.php` — see that file for the
188	272	// canonical definitions. Function names didn't change; PHP's
189	273	// runtime resolution finds them across the module split.
190	274
191	275
		@@ -190,9 +274,9 @@
190	274
191	275
192	276	// Dock building, menu / native-windows payload assembly and the
193	277	// script/style handle resolvers were moved to
194		-// `includes/core/payload.php` in 0.8.1. Function names didn't
	278	+// `includes/core/payload.php`. Function names didn't
195	279	// change; existing callers find them via PHP's runtime function
196	280	// resolution. desktop-mode.php loads payload.php right after
197		-// helpers.php so the foundational helpers (desktop_mode_is_enabled
	281	+// helpers.php so the foundational helpers (openstation_is_enabled
198	282	// etc.) are present when payload functions are invoked.