@wp-playground/blueprints 0.1.40 → 0.1.42

package/src/lib/steps/apply-wordpress-patches/index.ts

@@ -1,113 +0,0 @@
-import { UniversalPHP } from '@php-wasm/universal';
-import { StepHandler } from '..';
-import { updateFile } from '../common';
-
-export interface ApplyWordPressPatchesStep {
-	step: 'applyWordPressPatches';
-	siteUrl: string;
-	wordpressPath?: string;
-	patchSqlitePlugin?: boolean;
-	addPhpInfo?: boolean;
-	patchSiteUrl?: boolean;
-	disableSiteHealth?: boolean;
-	disableWpNewBlogNotification?: boolean;
-}
-
-export const applyWordPressPatches: StepHandler<
-	ApplyWordPressPatchesStep
-> = async (php, options) => {
-	const patch = new WordPressPatcher(
-		php,
-		options.siteUrl,
-		options.wordpressPath || '/wordpress'
-	);
-
-	if (options.patchSqlitePlugin !== false) {
-		await patch.patchSqlitePlugin();
-	}
-	if (options.addPhpInfo !== false) {
-		await patch.addPhpInfo();
-	}
-	if (options.patchSiteUrl !== false) {
-		await patch.patchSiteUrl();
-	}
-	if (options.disableSiteHealth !== false) {
-		await patch.disableSiteHealth();
-	}
-	if (options.disableWpNewBlogNotification !== false) {
-		await patch.disableWpNewBlogNotification();
-	}
-};
-
-class WordPressPatcher {
-	php: UniversalPHP;
-	scopedSiteUrl: string;
-	wordpressPath: string;
-
-	constructor(
-		php: UniversalPHP,
-		scopedSiteUrl: string,
-		wordpressPath: string
-	) {
-		this.php = php;
-		this.scopedSiteUrl = scopedSiteUrl;
-		this.wordpressPath = wordpressPath;
-	}
-
-	async patchSqlitePlugin() {
-		// Upstream change proposed in https://github.com/WordPress/sqlite-database-integration/pull/28:
-		await updateFile(
-			this.php,
-			`${this.wordpressPath}/wp-content/plugins/sqlite-database-integration/wp-includes/sqlite/class-wp-sqlite-translator.php`,
-			(contents) => {
-				return contents.replace(
-					'if ( false === strtotime( $value ) )',
-					'if ( $value === "0000-00-00 00:00:00" || false === strtotime( $value ) )'
-				);
-			}
-		);
-	}
-
-	async addPhpInfo() {
-		await this.php.writeFile(
-			`${this.wordpressPath}/phpinfo.php`,
-			'<?php phpinfo(); '
-		);
-	}
-
-	async patchSiteUrl() {
-		await updateFile(
-			this.php,
-			`${this.wordpressPath}/wp-config.php`,
-			(contents) =>
-				`<?php
-				if(!defined('WP_HOME')) {
-					define('WP_HOME', "${this.scopedSiteUrl}");
-					define('WP_SITEURL', "${this.scopedSiteUrl}");
-				}
-				?>${contents}`
-		);
-	}
-
-	async disableSiteHealth() {
-		await updateFile(
-			this.php,
-			`${this.wordpressPath}/wp-includes/default-filters.php`,
-			(contents) =>
-				contents.replace(
-					/add_filter[^;]+wp_maybe_grant_site_health_caps[^;]+;/i,
-					''
-				)
-		);
-	}
-
-	async disableWpNewBlogNotification() {
-		await updateFile(
-			this.php,
-			`${this.wordpressPath}/wp-config.php`,
-			// The original version of this function crashes WASM PHP, let's define an empty one instead.
-			(contents) =>
-				`${contents} function wp_new_blog_notification(...$args){} `
-		);
-	}
-}

package/src/lib/steps/apply-wordpress-patches/wp-content/mu-plugins/1-show-admin-credentials-on-wp-login.php

@@ -1,15 +0,0 @@
-<?php
-/**
- * Add a notice to wp-login.php offering the username and password.
- */
-
-add_action(
-	'login_message',
-	function() {
-		return <<<EOT
-<div class="message info">
-	<strong>username:</strong> <code>admin</code><br /><strong>password</strong>: <code>password</code>
-</div>
-EOT;
-	}
-);

package/src/lib/steps/client-methods.ts

@@ -1,121 +0,0 @@
-import { PHPRunOptions, PHPRequest } from '@php-wasm/universal';
-import { StepHandler } from '.';
-import { fileToUint8Array } from './common';
-
-export interface RunPHPStep {
-	step: 'runPHP';
-	code: string;
-}
-
-export const runPHP: StepHandler<RunPHPStep> = async (playground, { code }) => {
-	return await playground.run({ code });
-};
-
-export interface RunPHPWithOptionsStep {
-	step: 'runPHPWithOptions';
-	options: PHPRunOptions;
-}
-
-export const runPHPWithOptions: StepHandler<RunPHPWithOptionsStep> = async (
-	playground,
-	{ options }
-) => {
-	return await playground.run(options);
-};
-
-export interface SetPhpIniEntryStep {
-	step: 'setPhpIniEntry';
-	key: string;
-	value: string;
-}
-
-export const setPhpIniEntry: StepHandler<SetPhpIniEntryStep> = async (
-	playground,
-	{ key, value }
-) => {
-	await playground.setPhpIniEntry(key, value);
-};
-
-export interface RequestStep {
-	step: 'request';
-	request: PHPRequest;
-}
-
-export const request: StepHandler<RequestStep> = async (
-	playground,
-	{ request }
-) => {
-	return await playground.request(request);
-};
-
-export interface CpStep {
-	step: 'cp';
-	fromPath: string;
-	toPath: string;
-}
-
-export const cp: StepHandler<CpStep> = async (
-	playground,
-	{ fromPath, toPath }
-) => {
-	await playground.writeFile(
-		toPath,
-		await playground.readFileAsBuffer(fromPath)
-	);
-};
-
-export interface MvStep {
-	step: 'mv';
-	fromPath: string;
-	toPath: string;
-}
-
-export const mv: StepHandler<MvStep> = async (
-	playground,
-	{ fromPath, toPath }
-) => {
-	await playground.mv(fromPath, toPath);
-};
-
-export interface MkdirStep {
-	step: 'mkdir';
-	path: string;
-}
-
-export const mkdir: StepHandler<MkdirStep> = async (playground, { path }) => {
-	await playground.mkdir(path);
-};
-
-export interface RmStep {
-	step: 'rm';
-	path: string;
-}
-
-export const rm: StepHandler<RmStep> = async (playground, { path }) => {
-	await playground.unlink(path);
-};
-
-export interface RmdirStep {
-	step: 'rmdir';
-	path: string;
-}
-
-export const rmdir: StepHandler<RmdirStep> = async (playground, { path }) => {
-	await playground.rmdir(path);
-};
-
-export interface WriteFileStep<ResourceType> {
-	step: 'writeFile';
-	path: string;
-	data: ResourceType | string | Uint8Array;
-}
-
-export const writeFile: StepHandler<WriteFileStep<File>> = async (
-	playground,
-	{ path, data }
-) => {
-	if (data instanceof File) {
-		data = await fileToUint8Array(data);
-	}
-	await playground.writeFile(path, data);
-};

package/src/lib/steps/common.ts

@@ -1,30 +0,0 @@
-import type { PHPResponse, UniversalPHP } from '@php-wasm/universal';
-
-export function asDOM(response: PHPResponse) {
-	return new DOMParser().parseFromString(response.text, 'text/html')!;
-}
-
-export function zipNameToHumanName(zipName: string) {
-	const mixedCaseName = zipName.split('.').shift()!.replace('-', ' ');
-	return (
-		mixedCaseName.charAt(0).toUpperCase() +
-		mixedCaseName.slice(1).toLowerCase()
-	);
-}
-
-type PatchFileCallback = (contents: string) => string | Uint8Array;
-export async function updateFile(
-	php: UniversalPHP,
-	path: string,
-	callback: PatchFileCallback
-) {
-	let contents = '';
-	if (await php.fileExists(path)) {
-		contents = await php.readFileAsText(path);
-	}
-	await php.writeFile(path, callback(contents));
-}
-
-export async function fileToUint8Array(file: File) {
-	return new Uint8Array(await file.arrayBuffer());
-}

package/src/lib/steps/define-site-url.ts

@@ -1,25 +0,0 @@
-import { StepHandler } from '.';
-import { defineWpConfigConsts } from './define-wp-config-consts';
-
-export interface DefineSiteUrlStep {
-	step: 'defineSiteUrl';
-	siteUrl: string;
-}
-
-/**
- * Sets site URL of the WordPress installation.
- *
- * @param playground The playground client.
- * @param siteUrl
- */
-export const defineSiteUrl: StepHandler<DefineSiteUrlStep> = async (
-	playground,
-	{ siteUrl }
-) => {
-	return await defineWpConfigConsts(playground, {
-		consts: {
-			WP_HOME: siteUrl,
-			WP_SITEURL: siteUrl,
-		},
-	});
-};

package/src/lib/steps/define-wp-config-consts.ts

@@ -1,45 +0,0 @@
-import { StepHandler } from '.';
-import { updateFile } from './common';
-
-export interface DefineWpConfigConstsStep {
-	step: 'defineWpConfigConsts';
-	consts: Record<string, unknown>;
-}
-
-/**
- * Sets site URL of the WordPress installation.
- *
- * @param playground The playground client.
- * @param wpConfigConst
- */
-export const defineWpConfigConsts: StepHandler<
-	DefineWpConfigConstsStep
-> = async (playground, { consts }) => {
-	const documentRoot = await playground.documentRoot;
-	await updateFile(
-		playground,
-		`${documentRoot}/playground-consts.json`,
-		(contents) =>
-			JSON.stringify({
-				...JSON.parse(contents || '{}'),
-				...consts,
-			})
-	);
-	await updateFile(
-		playground,
-		`${documentRoot}/wp-config.php`,
-		(contents) => {
-			if (!contents.includes('playground-consts.json')) {
-				return `<?php
-	$consts = json_decode(file_get_contents('./playground-consts.json'), true);
-	foreach ($consts as $const => $value) {
-		if (!defined($const)) {
-			define($const, $value);
-		}
-	}
-?>${contents}`;
-			}
-			return contents;
-		}
-	);
-};

package/src/lib/steps/import-export.ts

@@ -1,225 +0,0 @@
-import { PHPResponse, UniversalPHP } from '@php-wasm/universal';
-import { phpVars } from '@php-wasm/util';
-import { StepHandler } from '.';
-
-// @ts-ignore
-import migrationsPHPCode from './migration';
-
-/**
- * Full site export support:
- */
-
-/**
- * Export the current site as a zip file.
- *
- * @param playground Playground client.
- */
-export async function zipEntireSite(playground: UniversalPHP) {
-	const zipName = `wordpress-playground.zip`;
-	const zipPath = `/${zipName}`;
-
-	const js = phpVars({
-		zipPath,
-		documentRoot: await playground.documentRoot,
-	});
-	await phpMigration(
-		playground,
-		`zipDir(${js.documentRoot}, ${js.zipPath});`
-	);
-
-	const fileBuffer = await playground.readFileAsBuffer(zipPath);
-	playground.unlink(zipPath);
-
-	return new File([fileBuffer], zipName);
-}
-
-export interface ReplaceSiteStep<ResourceType> {
-	step: 'replaceSite';
-	fullSiteZip: ResourceType;
-}
-
-/**
- * Replace the current site with the contents of a full site zip file.
- *
- * @param playground Playground client.
- * @param fullSiteZip Zipped WordPress site.
- */
-export const replaceSite: StepHandler<ReplaceSiteStep<File>> = async (
-	playground,
-	{ fullSiteZip }
-) => {
-	const zipPath = '/import.zip';
-	await playground.writeFile(
-		zipPath,
-		new Uint8Array(await fullSiteZip.arrayBuffer())
-	);
-
-	const absoluteUrl = await playground.absoluteUrl;
-	const documentRoot = await playground.documentRoot;
-
-	await playground.rmdir(documentRoot);
-	await unzip(playground, { zipPath, extractToPath: '/' });
-
-	const js = phpVars({ absoluteUrl });
-	await updateFile(
-		playground,
-		`${documentRoot}/wp-config.php`,
-		(contents) =>
-			`<?php
-			if(!defined('WP_HOME')) {
-				define('WP_HOME', ${js.absoluteUrl});
-				define('WP_SITEURL', ${js.absoluteUrl});
-			}
-			?>${contents}`
-	);
-};
-
-export interface UnzipStep {
-	step: 'unzip';
-	zipPath: string;
-	extractToPath: string;
-}
-
-/**
- * Unzip a zip file.
- *
- * @param playground Playground client.
- * @param zipPath The zip file to unzip.
- * @param extractTo The directory to extract the zip file to.
- */
-export const unzip: StepHandler<UnzipStep> = async (
-	playground,
-	{ zipPath, extractToPath }
-) => {
-	const js = phpVars({
-		zipPath,
-		extractToPath,
-	});
-	await phpMigration(
-		playground,
-		`unzip(${js.zipPath}, ${js.extractToPath});`
-	);
-};
-
-/**
- * WXR and WXZ files support:
- */
-
-/**
- * Exports the WordPress database as a WXR file using
- * the core WordPress export tool.
- *
- * @param playground Playground client
- * @returns WXR file
- */
-export async function exportWXR(playground: UniversalPHP) {
-	const databaseExportResponse = await playground.request({
-		url: '/wp-admin/export.php?download=true&content=all',
-	});
-	return new File([databaseExportResponse.bytes], 'export.xml');
-}
-
-/**
- * Exports the WordPress database as a WXZ file using
- * the export-wxz plugin from https://github.com/akirk/export-wxz.
- *
- * @param playground Playground client
- * @returns WXZ file
- */
-export async function exportWXZ(playground: UniversalPHP) {
-	const databaseExportResponse = await playground.request({
-		url: '/wp-admin/export.php?download=true&content=all&export_wxz=1',
-	});
-	return new File([databaseExportResponse.bytes], 'export.wxz');
-}
-
-export interface ImportFileStep<ResourceType> {
-	step: 'importFile';
-	file: ResourceType;
-}
-
-/**
- * Uploads a file to the WordPress importer and returns the response.
- * Supports both WXR and WXZ files.
- *
- * @see https://github.com/WordPress/wordpress-importer/compare/master...akirk:wordpress-importer:import-wxz.patch
- * @param playground Playground client.
- * @param file The file to import.
- */
-export const importFile: StepHandler<ImportFileStep<File>> = async (
-	playground,
-	{ file }
-) => {
-	const importerPageOneResponse = await playground.request({
-		url: '/wp-admin/admin.php?import=wordpress',
-	});
-
-	const firstUrlAction = DOM(importerPageOneResponse)
-		.getElementById('import-upload-form')
-		?.getAttribute('action');
-
-	const stepOneResponse = await playground.request({
-		url: `/wp-admin/${firstUrlAction}`,
-		method: 'POST',
-		files: { import: file },
-	});
-
-	// Map authors of imported posts to existing users
-	const importForm = DOM(stepOneResponse).querySelector(
-		'#wpbody-content form'
-	) as HTMLFormElement;
-
-	if (!importForm) {
-		console.log(stepOneResponse.text);
-		throw new Error(
-			'Could not find an importer form in response. See the response text above for details.'
-		);
-	}
-
-	const data = getFormData(importForm);
-	data['fetch_attachments'] = '1';
-	for (const key in data) {
-		if (key.startsWith('user_map[')) {
-			const newKey = 'user_new[' + key.slice(9, -1) + ']';
-			data[newKey] = '1'; // Hardcoded admin ID for now
-		}
-	}
-
-	await playground.request({
-		url: importForm.action,
-		method: 'POST',
-		formData: data,
-	});
-};
-
-function DOM(response: PHPResponse) {
-	return new DOMParser().parseFromString(response.text, 'text/html');
-}
-
-function getFormData(form: HTMLFormElement): Record<string, unknown> {
-	return Object.fromEntries((new FormData(form) as any).entries());
-}
-
-async function updateFile(
-	playground: UniversalPHP,
-	path: string,
-	callback: (contents: string) => string
-) {
-	await playground.writeFile(
-		path,
-		callback(await playground.readFileAsText(path))
-	);
-}
-
-async function phpMigration(playground: UniversalPHP, code: string) {
-	const result = await playground.run({
-		code: migrationsPHPCode + code,
-	});
-	if (result.exitCode !== 0) {
-		console.log(migrationsPHPCode + code);
-		console.log(code + '');
-		console.log(result.errors);
-		throw result.errors;
-	}
-	return result;
-}

package/src/lib/steps/index.ts

@@ -1,67 +0,0 @@
-import { ProgressTracker } from '@php-wasm/progress';
-import { UniversalPHP } from '@php-wasm/universal';
-import { FileReference } from '../resources';
-import { ActivatePluginStep } from './activate-plugin';
-import { ApplyWordPressPatchesStep } from './apply-wordpress-patches';
-import { DefineSiteUrlStep } from './define-site-url';
-import { ImportFileStep, ReplaceSiteStep, UnzipStep } from './import-export';
-import { InstallPluginStep } from './install-plugin';
-import { InstallThemeStep } from './install-theme';
-import { LoginStep } from './login';
-import { RunWpInstallationWizardStep } from './run-wp-installation-wizard';
-import { SetSiteOptionsStep, UpdateUserMetaStep } from './site-data';
-import {
-	RmStep,
-	CpStep,
-	MkdirStep,
-	RmdirStep,
-	MvStep,
-	SetPhpIniEntryStep,
-	RunPHPStep,
-	RunPHPWithOptionsStep,
-	RequestStep,
-	WriteFileStep,
-} from './client-methods';
-import { DefineWpConfigConstsStep } from './define-wp-config-consts';
-
-export type Step = GenericStep<FileReference>;
-export type StepDefinition = Step & {
-	progress?: {
-		weight?: number;
-		caption?: string;
-	};
-};
-
-export type GenericStep<Resource> =
-	| ActivatePluginStep
-	| ApplyWordPressPatchesStep
-	| CpStep
-	| DefineWpConfigConstsStep
-	| DefineSiteUrlStep
-	| ImportFileStep<Resource>
-	| InstallPluginStep<Resource>
-	| InstallThemeStep<Resource>
-	| LoginStep
-	| MkdirStep
-	| MvStep
-	| RequestStep
-	| ReplaceSiteStep<Resource>
-	| RmStep
-	| RmdirStep
-	| RunPHPStep
-	| RunPHPWithOptionsStep
-	| RunWpInstallationWizardStep
-	| SetPhpIniEntryStep
-	| SetSiteOptionsStep
-	| UnzipStep
-	| UpdateUserMetaStep
-	| WriteFileStep<Resource>;
-
-export type StepHandler<S extends GenericStep<File>> = (
-	php: UniversalPHP,
-	args: Omit<S, 'step'>,
-	progressArgs?: {
-		tracker: ProgressTracker;
-		initialCaption?: string;
-	}
-) => any;