php-wasm-xmlreader 0.1.0

package/8.0.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.0-xmlreader.so', url: new URL('./php8.0-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/8.1.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.1-xmlreader.so', url: new URL('./php8.1-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/8.2.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.2-xmlreader.so', url: new URL('./php8.2-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/8.3.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.3-xmlreader.so', url: new URL('./php8.3-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/8.4.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.4-xmlreader.so', url: new URL('./php8.4-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/8.5.mjs

@@ -0,0 +1,13 @@
+const importMeta = import.meta;
+const url = new URL(importMeta.url ?? 'http://example.com#this-is-an-error-supression-hack');
+const ini = !!(Number(url.searchParams.get('ini') ?? true));
+
+/**
+ * Returns the shared library definitions for this package build.
+ * @returns {Array<object>} Shared library definitions for the current package version.
+ */
+export const getLibs = () => [
+	{name: 'php8.5-xmlreader.so', url: new URL('./php8.5-xmlreader.so', import.meta.url), ini}
+];
+
+export default {getLibs};

package/README.md

@@ -0,0 +1,52 @@
+# php-wasm-xmlreader
+
+`php-wasm-xmlreader` provides the `xmlreader` extension for `php-wasm`.
+
+## Install
+
+```sh
+npm install php-wasm php-wasm-libxml php-wasm-dom php-wasm-xmlreader
+```
+
+## What It Loads
+
+Dynamic builds resolve the active runtime version to `php8.x-xmlreader.so`.
+Load `php-wasm-libxml` and `php-wasm-dom` alongside it when those dependencies are also dynamic.
+
+Shared and static builds may already include some or all of the `libxml`, `dom`, and `xmlreader` pieces in the base runtime. In those modes, callers should only explicitly load the packages whose own `WITH_*` mode is `dynamic`.
+
+## Usage
+
+```js
+import { PhpWeb } from 'php-wasm/PhpWeb.mjs';
+import libxml from 'php-wasm-libxml';
+import dom from 'php-wasm-dom';
+import xmlreader from 'php-wasm-xmlreader';
+
+const php = new PhpWeb({
+  version: '8.4',
+  sharedLibs: [libxml, dom, xmlreader],
+});
+
+await php.run(`<?php var_dump(extension_loaded('xmlreader'));`);
+```
+
+## Custom Builds
+
+Enable `WITH_XMLREADER` in `.php-wasm-rc`.
+Static XMLReader builds also need `WITH_LIBXML=static` and `WITH_DOM=static`.
+Dynamic XMLReader builds require both `libxml` and `dom` to be enabled in the build.
+Shared XMLReader builds require `WITH_LIBXML=shared` and `WITH_DOM=shared`, but the extensions remain built in.
+
+## Build Options
+
+- `WITH_XMLREADER`: defaults to `dynamic`. Allowed values: `0`, `1`, `static`, `dynamic`.
+- `WITH_LIBXML`: `WITH_XMLREADER=static` requires `WITH_LIBXML=static`. Dynamic XMLReader builds require libxml to be enabled in the build.
+- `WITH_DOM`: `WITH_XMLREADER=static` requires `WITH_DOM=static`. Dynamic XMLReader builds require DOM to be enabled in the build.
+
+In mixed-mode builds, follow each dependency's own mode:
+
+- if `WITH_XMLREADER=dynamic`, load `php-wasm-xmlreader`
+- if `WITH_DOM=dynamic`, load `php-wasm-dom`
+- if `WITH_LIBXML=dynamic`, load `php-wasm-libxml`
+- if any of those are `shared` or `static`, do not explicitly load that extension package at runtime

package/index.d.ts

@@ -0,0 +1,13 @@
+export interface SharedLibraryDefinition {
+	name?: string;
+	url: URL | string;
+	ini?: boolean;
+}
+
+export function getLibs(php: { phpVersion: string }): SharedLibraryDefinition[];
+
+declare const xmlreader: {
+	getLibs: typeof getLibs;
+};
+
+export default xmlreader;

package/index.mjs

@@ -0,0 +1,24 @@
+import xmlreader8_5 from './8.5.mjs';
+import xmlreader8_4 from './8.4.mjs';
+import xmlreader8_3 from './8.3.mjs';
+import xmlreader8_2 from './8.2.mjs';
+import xmlreader8_1 from './8.1.mjs';
+import xmlreader8_0 from './8.0.mjs';
+
+const versionTable = {
+	'8.5': xmlreader8_5,
+	'8.4': xmlreader8_4,
+	'8.3': xmlreader8_3,
+	'8.2': xmlreader8_2,
+	'8.1': xmlreader8_1,
+	'8.0': xmlreader8_0
+};
+
+/**
+ * Returns the shared library definitions for the active PHP version.
+ * @param {object} php PHP runtime wrapper used to select the versioned package build.
+ * @returns {Array<object>} Shared library definitions for the active PHP version.
+ */
+export const getLibs = php => versionTable[php.phpVersion].getLibs();
+
+export default {getLibs};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "php-wasm-xmlreader",
+  "description": "xmlreader for php-wasm.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/seanmorris/php-wasm.git"
+  },
+  "author": "Sean Morris <php-wasm@seanmorr.is>",
+  "version": "0.1.0",
+  "main": "index.mjs",
+  "types": "index.d.ts",
+  "files": [
+    "*.mjs",
+    "index.d.ts",
+    "test/basic.mjs",
+    "README.md",
+    "static.mak",
+    "*.so"
+  ]
+}

package/static.mak

@@ -0,0 +1,47 @@
+#!/usr/bin/env make
+
+DOCKER_RUN_IN_EXT_XMLREADER =${DOCKER_ENV} -e NOCONFIGURE=1 -e EMCC_CFLAGS='-fPIC -flto -O${SUB_OPTIMIZE}' -w /src/third_party/php${PHP_VERSION}-xmlreader/ emscripten-builder
+
+WITH_XMLREADER?=dynamic
+
+ifeq ($(filter ${WITH_XMLREADER},0 1 static dynamic),)
+$(error WITH_XMLREADER MUST BE 0, 1, static, OR dynamic. WITH_XMLREADER: '${WITH_XMLREADER}' PLEASE CHECK YOUR SETTINGS FILE: $(abspath ${ENV_FILE}))
+endif
+
+ifeq (${WITH_XMLREADER},1)
+WITH_XMLREADER=dynamic
+endif
+
+ifeq (${WITH_XMLREADER},static)
+ifeq ($(filter ${WITH_LIBXML},static),)
+$(error WITH_XMLREADER=static REQUIRES WITH_LIBXML=static. WITH_LIBXML: '${WITH_LIBXML}' WITH_XMLREADER: '${WITH_XMLREADER}' PLEASE CHECK YOUR SETTINGS FILE: $(abspath ${ENV_FILE}))
+endif
+ifeq ($(filter ${WITH_DOM},static),)
+$(error WITH_XMLREADER=static REQUIRES WITH_DOM=static. WITH_DOM: '${WITH_DOM}' WITH_XMLREADER: '${WITH_XMLREADER}' PLEASE CHECK YOUR SETTINGS FILE: $(abspath ${ENV_FILE}))
+endif
+CONFIGURE_FLAGS+= --enable-xmlreader
+TEST_LIST+=$(shell ls packages/xmlreader/test/*.mjs)
+endif
+
+ifeq (${WITH_XMLREADER},dynamic)
+ifeq ($(filter ${WITH_LIBXML},1 static shared dynamic),)
+$(error WITH_XMLREADER=dynamic REQUIRES WITH_LIBXML=[static|shared|dynamic]. WITH_LIBXML: '${WITH_LIBXML}' WITH_XMLREADER: '${WITH_XMLREADER}' PLEASE CHECK YOUR SETTINGS FILE: $(abspath ${ENV_FILE}))
+endif
+ifeq ($(filter ${WITH_DOM},1 static shared dynamic),)
+$(error WITH_XMLREADER=dynamic REQUIRES WITH_DOM=[static|shared|dynamic]. WITH_DOM: '${WITH_DOM}' WITH_XMLREADER: '${WITH_XMLREADER}' PLEASE CHECK YOUR SETTINGS FILE: $(abspath ${ENV_FILE}))
+endif
+TEST_LIST+=$(shell ls packages/xmlreader/test/*.mjs)
+EXTRA_MODULES+= packages/xmlreader/php${PHP_VERSION}-xmlreader.so
+endif
+
+third_party/php${PHP_VERSION}-xmlreader/config.m4: third_party/php${PHP_VERSION}-src/patched
+	${DOCKER_RUN} cp -Lprf /src/third_party/php${PHP_VERSION}-src/ext/xmlreader /src/third_party/php${PHP_VERSION}-xmlreader
+
+packages/xmlreader/php${PHP_VERSION}-xmlreader.so: ${PHPIZE} third_party/php${PHP_VERSION}-xmlreader/config.m4
+	${DOCKER_RUN_IN_EXT_XMLREADER} chmod +x /src/third_party/php${PHP_VERSION}-src/scripts/phpize;
+	${DOCKER_RUN_IN_EXT_XMLREADER} /src/third_party/php${PHP_VERSION}-src/scripts/phpize;
+	${DOCKER_RUN_IN_EXT_XMLREADER} emconfigure ./configure PKG_CONFIG_PATH=${PKG_CONFIG_PATH} --prefix='/src/lib/php${PHP_VERSION}' --with-php-config=/src/lib/php${PHP_VERSION}/bin/php-config;
+	${DOCKER_RUN_IN_EXT_XMLREADER} sed -i 's#-shared#-static#g' Makefile;
+	${DOCKER_RUN_IN_EXT_XMLREADER} sed -i 's#-export-dynamic##g' Makefile;
+	${DOCKER_RUN_IN_EXT_XMLREADER} emmake make -j${CPU_COUNT} EXTRA_INCLUDES='-I/src/third_party/php${PHP_VERSION}-src';
+	${DOCKER_RUN_IN_EXT_XMLREADER} emcc -shared -o /src/$@ -fPIC -flto -sSIDE_MODULE=1 -O${SUB_OPTIMIZE} -Wl,--whole-archive .libs/xmlreader.a /src/packages/libxml/libxml2.so

package/test/basic.mjs

@@ -0,0 +1,61 @@
+import { test } from 'node:test';
+import { strict as assert } from 'node:assert';
+import { PhpNode } from '../../../test/lib/PhpNode.mjs';
+import { env } from 'node:process';
+
+import libxml from 'php-wasm-libxml';
+import dom from 'php-wasm-dom';
+import xmlreader from 'php-wasm-xmlreader';
+
+const phpVersion = process.env.PHP_VERSION ?? '8.4';
+const isDynamic = flag => env[flag] === 'dynamic';
+
+const stringSharedLibs = [
+	isDynamic('WITH_LIBXML') && { url: './packages/libxml/libxml2.so', ini: false },
+	isDynamic('WITH_DOM') && `./packages/dom/php${phpVersion}-dom.so`,
+	isDynamic('WITH_XMLREADER') && `./packages/xmlreader/php${phpVersion}-xmlreader.so`
+].filter(Boolean);
+
+const moduleSharedLibs = [
+	isDynamic('WITH_LIBXML') && libxml,
+	isDynamic('WITH_DOM') && dom,
+	isDynamic('WITH_XMLREADER') && xmlreader
+].filter(Boolean);
+
+test('XMLReader Extension is enabled. (loaded via strings)', async () => {
+	const php = stringSharedLibs.length
+		? new PhpNode({ sharedLibs: stringSharedLibs })
+		: new PhpNode();
+
+	let stdOut = '', stdErr = '';
+
+	php.addEventListener('output', event => event.detail.forEach(line => void (stdOut += line)));
+	php.addEventListener('error', event => event.detail.forEach(line => void (stdErr += line)));
+
+	await php.binary;
+
+	const exitCode = await php.run(`<?php var_dump(extension_loaded('xmlreader'));`);
+
+	assert.equal(exitCode, 0);
+	assert.equal(stdOut, `bool(true)\n`);
+	assert.equal(stdErr, '');
+});
+
+test('XMLReader Extension is enabled. (loaded via module)', async () => {
+	const php = moduleSharedLibs.length
+		? new PhpNode({ sharedLibs: moduleSharedLibs })
+		: new PhpNode();
+
+	let stdOut = '', stdErr = '';
+
+	php.addEventListener('output', event => event.detail.forEach(line => void (stdOut += line)));
+	php.addEventListener('error', event => event.detail.forEach(line => void (stdErr += line)));
+
+	await php.binary;
+
+	const exitCode = await php.run(`<?php var_dump(extension_loaded('xmlreader'));`);
+
+	assert.equal(exitCode, 0);
+	assert.equal(stdOut, `bool(true)\n`);
+	assert.equal(stdErr, '');
+});