Blueprints: Add enableMultisite step

packages/docs/site/docs/13-contributing/02-code.md

@@ -29,3 +29,17 @@ Be sure to also review the following resources:
 -   [Packages and projects](./04-packages-and-projects.md)
 -   [Vision and Philosophy](https://github.com/WordPress/wordpress-playground/issues/472)
 -   [Roadmap](https://github.com/WordPress/wordpress-playground/issues/525)
+
+## HTTPS setup
+
+Some Playground features, like multisite, require a local test domain running via HTTPS.
+
+One way to get it set up is with [Laravel Valet](https://laravel.com/docs/10.x/valet).
+
+Once your Valet is installed, run:
+
+```bash
+valet proxy playground.test http://localhost:5400 --secure
+```
+
+Your dev server is now available via https://playground.test.

packages/php-wasm/universal/src/lib/base-php.ts

@@ -477,7 +477,7 @@ export abstract class BasePHP implements IsomorphicLocalPHP {
 		}
 	}
 
-	defineConstant(key: string, value: string | number | null) {
+	defineConstant(key: string, value: string | boolean | number | null) {
 		let consts = {};
 		try {
 			consts = JSON.parse(

packages/php-wasm/universal/src/lib/php-request-handler.ts

@@ -178,6 +178,7 @@ export class PHPRequestHandler implements RequestHandler {
 		 */
 		const release = await this.#semaphore.acquire();
 		try {
+			this.php.addServerGlobalEntry('REMOTE_ADDR', '127.0.0.1');
 			this.php.addServerGlobalEntry('DOCUMENT_ROOT', this.#DOCROOT);
 			this.php.addServerGlobalEntry(
 				'HTTPS',
@@ -236,7 +237,18 @@ export class PHPRequestHandler implements RequestHandler {
 
 			let scriptPath;
 			try {
-				scriptPath = this.#resolvePHPFilePath(requestedUrl.pathname);
+				// Support URL rewriting
+				let requestedPath = requestedUrl.pathname;
+				if (request.headers?.['x-rewrite-url']) {
+					try {
+						requestedPath = new URL(
+							request.headers['x-rewrite-url']
+						).pathname;
+					} catch (error) {
+						// Ignore
+					}
+				}
+				scriptPath = this.#resolvePHPFilePath(requestedPath);
 			} catch (error) {
 				return new PHPResponse(
 					404,
@@ -291,10 +303,7 @@ export class PHPRequestHandler implements RequestHandler {
 		if (this.php.fileExists(resolvedFsPath)) {
 			return resolvedFsPath;
 		}
-		if (!this.php.fileExists(`${this.#DOCROOT}/index.php`)) {
-			throw new Error(`File not found: ${resolvedFsPath}`);
-		}
-		return `${this.#DOCROOT}/index.php`;
+		throw new Error(`File not found: ${resolvedFsPath}`);
 	}
 }
 

packages/php-wasm/web/src/lib/register-service-worker.ts

@@ -17,7 +17,16 @@ export async function registerServiceWorker<
 >(phpApi: Client, scope: string, scriptUrl: string) {
 	const sw = navigator.serviceWorker;
 	if (!sw) {
-		throw new Error('Service workers are not supported in this browser.');
+		if (location.protocol === 'https:') {
+			throw new Error(
+				'Service workers are not supported in this browser.'
+			);
+		} else {
+			throw new Error(
+				'WordPress Playground requires service workers which are only supported ' +
+					'on HTTPS sites. This site does not use HTTPS, please retry on one that does. '
+			);
+		}
 	}
 
 	console.debug(`[window][sw] Registering a Service Worker`);

packages/php-wasm/web/src/lib/web-php-endpoint.ts

@@ -179,7 +179,7 @@ export class WebPHPEndpoint implements IsomorphicLocalPHP {
 	}
 
 	/** @inheritDoc @php-wasm/web!WebPHP.defineConstant */
-	defineConstant(key: string, value: string | number | null): void {
+	defineConstant(key: string, value: string | boolean | number | null): void {
 		_private.get(this)!.php.defineConstant(key, value);
 	}
 

packages/playground/blueprints/public/blueprint-schema.json

@@ -515,6 +515,29 @@
 					},
 					"required": ["siteUrl", "step"]
 				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"progress": {
+							"type": "object",
+							"properties": {
+								"weight": {
+									"type": "number"
+								},
+								"caption": {
+									"type": "string"
+								}
+							},
+							"additionalProperties": false
+						},
+						"step": {
+							"type": "string",
+							"const": "enableMultisite"
+						}
+					},
+					"required": ["step"]
+				},
 				{
 					"type": "object",
 					"additionalProperties": false,

packages/playground/blueprints/src/lib/steps/enable-multisite.ts

@@ -0,0 +1,141 @@
+import { phpVar } from '@php-wasm/util';
+import { StepHandler } from '.';
+import { defineWpConfigConsts } from './define-wp-config-consts';
+import { login } from './login';
+import { request } from './request';
+import { setSiteOptions } from './site-data';
+
+/**
+ * @inheritDoc enableMultisite
+ * @hasRunnableExample
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "enableMultisite",
+ * }
+ * </code>
+ */
+export interface EnableMultisiteStep {
+	step: 'enableMultisite';
+}
+
+/**
+ * Defines constants in a wp-config.php file.
+ *
+ * This step can be called multiple times, and the constants will be merged.
+ *
+ * @param playground The playground client.
+ * @param enableMultisite
+ */
+export const enableMultisite: StepHandler<EnableMultisiteStep> = async (
+	playground
+) => {
+	// Ensure we're logged in
+	await login(playground, {});
+
+	await defineWpConfigConsts(playground, {
+		consts: {
+			WP_ALLOW_MULTISITE: 1,
+		},
+	});
+
+	const url = new URL(await playground.absoluteUrl);
+	const sitePath = url.pathname.replace(/\/$/, '') + '/';
+	const siteUrl = `${url.protocol}//${url.host}${sitePath}`;
+	await setSiteOptions(playground, {
+		options: {
+			siteurl: siteUrl,
+			home: siteUrl,
+		},
+	});
+
+	const docroot = await playground.documentRoot;
+
+	// Deactivate all the plugins as required by the multisite installation.
+	await playground.run({
+		code: `<?php
+define( 'WP_ADMIN', true );
+require_once(${phpVar(docroot)} . "/wp-load.php");
+require_once(${phpVar(docroot)} . "/wp-admin/includes/plugin.php");
+$plugins = glob(${phpVar(docroot)} . "/wp-content/plugins/*");
+foreach($plugins as $plugin_path) {
+	if (!is_dir($plugin_path)) {
+		deactivate_plugins($plugin_path);
+		continue;
+	}
+	// Find plugin entry file
+	foreach ( ( glob( $plugin_path . '/*.php' ) ?: array() ) as $file ) {
+		$info = get_plugin_data( $file, false, false );
+		var_dump($file);
+		if ( ! empty( $info['Name'] ) ) {
+			deactivate_plugins( $file );
+			break;
+		}
+	}
+}
+`,
+	});
+
+	// Extract nonce for multisite form submission
+	const networkForm = await request(playground, {
+		request: {
+			url: '/wp-admin/network.php',
+		},
+	});
+	const nonce = networkForm.text.match(
+		/name="_wpnonce"\s+value="([^"]+)"/
+	)?.[1];
+
+	// @TODO: Extract nonce using wp_create_nonce() instead
+	//        of an HTTP request.
+	//        Unfortunately, the code snippet below does not
+	//        yield a nonce that WordPress would accept:
+	/*
+    const nonce = (await playground.run({
+	  	code: `<?php
+	  	require '/wordpress/wp-load.php';
+	  	wp_set_current_user(1);
+	  	echo wp_create_nonce('install-network-1');
+	  	`,
+    })).text;
+    */
+
+	await request(playground, {
+		request: {
+			url: '/wp-admin/network.php',
+			method: 'POST',
+			headers: {
+				'Content-Type': 'application/x-www-form-urlencoded',
+			},
+			body: jsonToUrlEncoded({
+				_wpnonce: nonce,
+				_wp_http_referer: sitePath + 'wp-admin/network.php',
+				sitename: 'My WordPress Website Sites',
+				email: '[email protected]',
+				submit: 'Install',
+			}),
+		},
+	});
+
+	await defineWpConfigConsts(playground, {
+		consts: {
+			MULTISITE: true,
+			SUBDOMAIN_INSTALL: false,
+			SITE_ID_CURRENT_SITE: 1,
+			BLOG_ID_CURRENT_SITE: 1,
+			DOMAIN_CURRENT_SITE: url.hostname,
+			PATH_CURRENT_SITE: sitePath,
+		},
+	});
+	await login(playground, {});
+};
+
+function jsonToUrlEncoded(json: Record<string, string>) {
+	return Object.keys(json)
+		.map(
+			(key) =>
+				encodeURIComponent(key) + '=' + encodeURIComponent(json[key])
+		)
+		.join('&');
+}

packages/playground/blueprints/src/lib/steps/handlers.ts

@@ -6,6 +6,7 @@ export { runPHPWithOptions } from './run-php-with-options';
 export { runSql } from './run-sql';
 export { setPhpIniEntry } from './set-php-ini-entry';
 export { request } from './request';
+export { enableMultisite } from './enable-multisite';
 export { cp } from './cp';
 export { mv } from './mv';
 export { rm } from './rm';

packages/playground/blueprints/src/lib/steps/index.ts

@@ -28,6 +28,7 @@ import { ActivateThemeStep } from './activate-theme';
 import { UnzipStep } from './unzip';
 import { ImportWordPressFilesStep } from './import-wordpress-files';
 import { ImportFileStep } from './import-file';
+import { EnableMultisiteStep } from './enable-multisite';
 
 export type Step = GenericStep<FileReference>;
 export type StepDefinition = Step & {
@@ -50,6 +51,7 @@ export type GenericStep<Resource> =
 	| CpStep
 	| DefineWpConfigConstsStep
 	| DefineSiteUrlStep
+	| EnableMultisiteStep
 	| ImportFileStep<Resource>
 	| ImportWordPressFilesStep<Resource>
 	| InstallPluginStep<Resource>
@@ -77,6 +79,7 @@ export type {
 	CpStep,
 	DefineWpConfigConstsStep,
 	DefineSiteUrlStep,
+	EnableMultisiteStep,
 	ImportFileStep,
 	ImportWordPressFilesStep,
 	InstallPluginStep,

packages/playground/blueprints/src/lib/steps/run-sql.ts

@@ -75,6 +75,8 @@ export const runSql: StepHandler<RunSqlStep<File>> = async (
 		}
 	`,
 	});
+	console.log(runPhp.text);
+	console.log(runPhp.errors);
 
 	await rm(playground, { path: sqlFilename });
 

packages/playground/client/src/index.ts

@@ -96,7 +96,6 @@ export async function startPlaygroundWeb({
 		progressTracker
 	);
 	await runBlueprintSteps(compiled, playground);
-	progressTracker.finish();
 
 	return playground;
 }