vite-plugin-php 0.9.1 → 1.0.1

package/README.md

@@ -15,6 +15,11 @@ export default defineConfig({
 });
 ```
 
+#### ⚠️ Attention!
+
+Since version `^1.0.0` the plugin uses PHP's dev-server to compute PHP code and to provide all usual server variables and features.\
+If you encounter a bug, use the prior `0.9.1` version of the plugin!
+
 ## Write some PHP code in your `index.php`
 
 ```php

package/dist/index.cjs

@@ -1,27 +1,13 @@
 'use strict';
 
-const child_process = require('child_process');
 const fs = require('fs');
 const path = require('path');
+const http = require('http');
+const child_process = require('child_process');
 
-function runPHP(input, args = {}) {
-  const params = [runPHP.binary];
-  Object.entries(args).forEach(([optionName, value]) => {
-    if (optionName === "define") {
-      Object.entries(value).forEach(([k, v]) => {
-        params.push(`--${optionName} ${k}=${v}`);
-      });
-    } else {
-      const name = optionName.replaceAll("_", "-");
-      params.push(`--${name} ${value}`);
-    }
-  });
-  let i = input;
-  i = i.replaceAll("'", `'"'"'`);
-  i = `echo '${i}' | ` + params.join(" ");
-  return child_process.execSync(i).toString();
-}
-runPHP.binary = "php";
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const http__default = /*#__PURE__*/_interopDefaultCompat(http);
 
 function makeID() {
   return Date.now().toString(36) + Math.random() * 100;
@@ -32,14 +18,9 @@ function writeFile(file, data) {
   fs.writeFileSync(file, data);
 }
 
-const codeTokens = /* @__PURE__ */ new Map();
 function escapePHP(inputFile, outputFile) {
-  const fileId = path.resolve(outputFile);
   const input = fs.readFileSync(inputFile).toString();
-  if (!codeTokens.has(fileId)) {
-    codeTokens.set(fileId, /* @__PURE__ */ new Map());
-  }
-  const fileTokens = codeTokens.get(fileId);
+  const codeTokens = {};
   const isJS = inputFile.includes(".js") || inputFile.includes(".ts");
   const isML = inputFile.includes(".php") || inputFile.includes(".htm");
   const out = input.replaceAll(/<\?(?:php|).+?\?>/gi, (match) => {
@@ -49,45 +30,103 @@ function escapePHP(inputFile, outputFile) {
     } else if (isML) {
       token = `<!--${token}-->`;
     }
-    fileTokens.set(token, match);
+    codeTokens[token] = match;
     return token;
   });
+  writeFile(outputFile + ".json", JSON.stringify(codeTokens));
   writeFile(outputFile, out);
 }
 function unescapePHP(file) {
-  const fileId = path.resolve(file);
   const input = fs.readFileSync(file).toString();
-  const fileTokens = codeTokens.get(fileId);
   let out = input;
-  if (fileTokens) {
-    fileTokens.forEach((code, token) => {
+  const tokensFile = file + ".json";
+  if (fs.existsSync(tokensFile)) {
+    const codeTokens = JSON.parse(fs.readFileSync(tokensFile).toString());
+    Object.entries(codeTokens).forEach(([token, code]) => {
       out = out.replace(token, (match) => {
-        return code;
+        return `${code}`;
       });
     });
   }
   return out;
 }
 
+function start(root) {
+  if (!globalThis.php?.pid) {
+    globalThis.php = child_process.spawn(phpServer.binary, [
+      "-S",
+      "localhost:" + phpServer.port,
+      "-t",
+      root,
+      path.resolve(__dirname + "/router.php")
+    ]).once("spawn", () => {
+      console.log(
+        `PHP development server started (PID: ${globalThis.php?.pid})`
+      );
+    }).on("error", (error) => {
+      console.error("PHP dev-server error: " + error.message);
+    }).on("close", (code) => {
+      console.log(`PHP development server stopped (Code: ${code})`);
+    });
+  }
+}
+function stop() {
+  if (globalThis.php) {
+    globalThis.php.stdin?.end();
+    globalThis.php.stdout?.destroy();
+    globalThis.php.stderr?.destroy();
+    if (globalThis.php.kill()) {
+      console.log("PHP development server killed");
+    } else {
+      console.error("Attention! Failed to kill PHP development server!");
+    }
+  }
+}
+const phpServer = {
+  binary: "php",
+  port: 65535,
+  start,
+  stop
+};
+
 function usePHP(cfg = {}) {
   const {
     binary = "php",
     entry = "index.php",
-    args,
-    tempDir = ".php-tmp"
+    tempDir = ".php-tmp",
+    cleanup = {}
   } = cfg;
-  runPHP.binary = binary;
+  const { dev: devCleanup = true } = cleanup;
+  phpServer.binary = binary;
   let config = void 0;
+  let viteServer = void 0;
   const entries = Array.isArray(entry) ? entry : [entry];
   function escapeFile(file) {
     const tempFile = `${tempDir}/${file}.html`;
     escapePHP(file, tempFile);
     return tempFile;
   }
-  function cleanUp(dir = "") {
+  function cleanupTemp(dir = "") {
     const parentDir = dir ? dir + "/" : dir;
     fs.rmSync(parentDir + tempDir, { recursive: true, force: true });
   }
+  function onExit() {
+    if (config?.command === "serve") {
+      phpServer.stop();
+      devCleanup && cleanupTemp();
+    }
+    process.exit();
+  }
+  [
+    "exit",
+    "SIGINT",
+    "SIGUSR1",
+    "SIGUSR2",
+    "uncaughtException",
+    "SIGTERM"
+  ].forEach((eventType) => {
+    process.on(eventType, onExit.bind(null));
+  });
   return [
     {
       name: "prepare-php",
@@ -116,30 +155,53 @@ function usePHP(cfg = {}) {
       apply: "serve",
       enforce: "pre",
       configureServer(server) {
+        viteServer = server;
+        phpServer.start(viteServer?.config.root);
         server.middlewares.use(async (req, res, next) => {
-          if (req.url) {
-            const url = new URL(req.url, "http://localhost");
-            let requestUrl = url.pathname;
-            if (requestUrl.endsWith("/")) {
-              requestUrl += "index.php";
-            }
-            requestUrl = requestUrl.substring(1);
-            const entry2 = entries.find((file) => {
-              return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
-            });
-            if (entry2) {
-              let tempFile = `${tempDir}/`;
-              tempFile += entry2 + ".html";
-              if (fs.existsSync(path.resolve(tempFile))) {
-                const code = unescapePHP(tempFile);
-                const out = await server.transformIndexHtml(
-                  requestUrl || "/",
-                  runPHP(code, args)
-                );
-                res.end(out);
-                return;
+          try {
+            if (req.url) {
+              const url = new URL(
+                req.url,
+                "http://localhost:" + phpServer.port
+              );
+              let requestUrl = url.pathname;
+              if (requestUrl.endsWith("/")) {
+                requestUrl += "index.php";
+              }
+              requestUrl = requestUrl.substring(1);
+              const entry2 = entries.find((file) => {
+                return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+              });
+              if (entry2) {
+                const tempFile = `${tempDir}/${entry2}.html`;
+                if (fs.existsSync(path.resolve(tempFile))) {
+                  url.pathname = tempFile;
+                  const phpResult = await new Promise(
+                    (resolve2, reject) => {
+                      http__default.request(
+                        url.toString(),
+                        {
+                          method: req.method,
+                          headers: req.headers
+                        },
+                        (msg) => {
+                          msg.on("data", resolve2);
+                        }
+                      ).on("error", reject).end();
+                    }
+                  );
+                  let out = phpResult.toString();
+                  out = await server.transformIndexHtml(
+                    requestUrl || "/",
+                    out
+                  );
+                  res.end(out);
+                  return;
+                }
               }
             }
+          } catch (error) {
+            console.error(`Error: ${error}`);
           }
           next();
         });
@@ -155,9 +217,6 @@ function usePHP(cfg = {}) {
             path: "*"
           });
         }
-      },
-      buildEnd(error) {
-        cleanUp();
       }
     },
     {
@@ -174,7 +233,7 @@ function usePHP(cfg = {}) {
           const code = unescapePHP(`${tempDir}/${file}.html`);
           writeFile(`${distDir}/${file}`, code);
         });
-        cleanUp(distDir);
+        cleanupTemp(distDir);
       }
     }
   ];

package/dist/index.d.ts

@@ -1,23 +1,13 @@
 import { Plugin } from 'vite';
 
-type PHP_CLI_Args = {
-    no_chdir?: boolean;
-    no_header?: boolean;
-    php_ini?: string;
-    no_php_ini?: boolean;
-    define?: Record<string, string>;
-    profile_info?: boolean;
-    process_begin?: string;
-    process_code?: string;
-    process_file?: string;
-    process_end?: string;
-};
-
 type UsePHPConfig = {
     binary?: string;
     entry?: string | string[];
-    args?: PHP_CLI_Args;
     tempDir?: string;
+    cleanup?: {
+        dev?: boolean;
+        build?: boolean;
+    };
 };
 declare function usePHP(cfg?: UsePHPConfig): Plugin[];
 

package/dist/index.mjs

@@ -1,25 +1,7 @@
-import { execSync } from 'child_process';
 import { mkdirSync, writeFileSync, readFileSync, existsSync, rmSync } from 'fs';
 import { dirname, resolve } from 'path';
-
-function runPHP(input, args = {}) {
-  const params = [runPHP.binary];
-  Object.entries(args).forEach(([optionName, value]) => {
-    if (optionName === "define") {
-      Object.entries(value).forEach(([k, v]) => {
-        params.push(`--${optionName} ${k}=${v}`);
-      });
-    } else {
-      const name = optionName.replaceAll("_", "-");
-      params.push(`--${name} ${value}`);
-    }
-  });
-  let i = input;
-  i = i.replaceAll("'", `'"'"'`);
-  i = `echo '${i}' | ` + params.join(" ");
-  return execSync(i).toString();
-}
-runPHP.binary = "php";
+import http from 'http';
+import { spawn } from 'child_process';
 
 function makeID() {
   return Date.now().toString(36) + Math.random() * 100;
@@ -30,14 +12,9 @@ function writeFile(file, data) {
   writeFileSync(file, data);
 }
 
-const codeTokens = /* @__PURE__ */ new Map();
 function escapePHP(inputFile, outputFile) {
-  const fileId = resolve(outputFile);
   const input = readFileSync(inputFile).toString();
-  if (!codeTokens.has(fileId)) {
-    codeTokens.set(fileId, /* @__PURE__ */ new Map());
-  }
-  const fileTokens = codeTokens.get(fileId);
+  const codeTokens = {};
   const isJS = inputFile.includes(".js") || inputFile.includes(".ts");
   const isML = inputFile.includes(".php") || inputFile.includes(".htm");
   const out = input.replaceAll(/<\?(?:php|).+?\?>/gi, (match) => {
@@ -47,45 +24,103 @@ function escapePHP(inputFile, outputFile) {
     } else if (isML) {
       token = `<!--${token}-->`;
     }
-    fileTokens.set(token, match);
+    codeTokens[token] = match;
     return token;
   });
+  writeFile(outputFile + ".json", JSON.stringify(codeTokens));
   writeFile(outputFile, out);
 }
 function unescapePHP(file) {
-  const fileId = resolve(file);
   const input = readFileSync(file).toString();
-  const fileTokens = codeTokens.get(fileId);
   let out = input;
-  if (fileTokens) {
-    fileTokens.forEach((code, token) => {
+  const tokensFile = file + ".json";
+  if (existsSync(tokensFile)) {
+    const codeTokens = JSON.parse(readFileSync(tokensFile).toString());
+    Object.entries(codeTokens).forEach(([token, code]) => {
       out = out.replace(token, (match) => {
-        return code;
+        return `${code}`;
       });
     });
   }
   return out;
 }
 
+function start(root) {
+  if (!globalThis.php?.pid) {
+    globalThis.php = spawn(phpServer.binary, [
+      "-S",
+      "localhost:" + phpServer.port,
+      "-t",
+      root,
+      resolve(__dirname + "/router.php")
+    ]).once("spawn", () => {
+      console.log(
+        `PHP development server started (PID: ${globalThis.php?.pid})`
+      );
+    }).on("error", (error) => {
+      console.error("PHP dev-server error: " + error.message);
+    }).on("close", (code) => {
+      console.log(`PHP development server stopped (Code: ${code})`);
+    });
+  }
+}
+function stop() {
+  if (globalThis.php) {
+    globalThis.php.stdin?.end();
+    globalThis.php.stdout?.destroy();
+    globalThis.php.stderr?.destroy();
+    if (globalThis.php.kill()) {
+      console.log("PHP development server killed");
+    } else {
+      console.error("Attention! Failed to kill PHP development server!");
+    }
+  }
+}
+const phpServer = {
+  binary: "php",
+  port: 65535,
+  start,
+  stop
+};
+
 function usePHP(cfg = {}) {
   const {
     binary = "php",
     entry = "index.php",
-    args,
-    tempDir = ".php-tmp"
+    tempDir = ".php-tmp",
+    cleanup = {}
   } = cfg;
-  runPHP.binary = binary;
+  const { dev: devCleanup = true } = cleanup;
+  phpServer.binary = binary;
   let config = void 0;
+  let viteServer = void 0;
   const entries = Array.isArray(entry) ? entry : [entry];
   function escapeFile(file) {
     const tempFile = `${tempDir}/${file}.html`;
     escapePHP(file, tempFile);
     return tempFile;
   }
-  function cleanUp(dir = "") {
+  function cleanupTemp(dir = "") {
     const parentDir = dir ? dir + "/" : dir;
     rmSync(parentDir + tempDir, { recursive: true, force: true });
   }
+  function onExit() {
+    if (config?.command === "serve") {
+      phpServer.stop();
+      devCleanup && cleanupTemp();
+    }
+    process.exit();
+  }
+  [
+    "exit",
+    "SIGINT",
+    "SIGUSR1",
+    "SIGUSR2",
+    "uncaughtException",
+    "SIGTERM"
+  ].forEach((eventType) => {
+    process.on(eventType, onExit.bind(null));
+  });
   return [
     {
       name: "prepare-php",
@@ -114,30 +149,53 @@ function usePHP(cfg = {}) {
       apply: "serve",
       enforce: "pre",
       configureServer(server) {
+        viteServer = server;
+        phpServer.start(viteServer?.config.root);
         server.middlewares.use(async (req, res, next) => {
-          if (req.url) {
-            const url = new URL(req.url, "http://localhost");
-            let requestUrl = url.pathname;
-            if (requestUrl.endsWith("/")) {
-              requestUrl += "index.php";
-            }
-            requestUrl = requestUrl.substring(1);
-            const entry2 = entries.find((file) => {
-              return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
-            });
-            if (entry2) {
-              let tempFile = `${tempDir}/`;
-              tempFile += entry2 + ".html";
-              if (existsSync(resolve(tempFile))) {
-                const code = unescapePHP(tempFile);
-                const out = await server.transformIndexHtml(
-                  requestUrl || "/",
-                  runPHP(code, args)
-                );
-                res.end(out);
-                return;
+          try {
+            if (req.url) {
+              const url = new URL(
+                req.url,
+                "http://localhost:" + phpServer.port
+              );
+              let requestUrl = url.pathname;
+              if (requestUrl.endsWith("/")) {
+                requestUrl += "index.php";
+              }
+              requestUrl = requestUrl.substring(1);
+              const entry2 = entries.find((file) => {
+                return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+              });
+              if (entry2) {
+                const tempFile = `${tempDir}/${entry2}.html`;
+                if (existsSync(resolve(tempFile))) {
+                  url.pathname = tempFile;
+                  const phpResult = await new Promise(
+                    (resolve2, reject) => {
+                      http.request(
+                        url.toString(),
+                        {
+                          method: req.method,
+                          headers: req.headers
+                        },
+                        (msg) => {
+                          msg.on("data", resolve2);
+                        }
+                      ).on("error", reject).end();
+                    }
+                  );
+                  let out = phpResult.toString();
+                  out = await server.transformIndexHtml(
+                    requestUrl || "/",
+                    out
+                  );
+                  res.end(out);
+                  return;
+                }
               }
             }
+          } catch (error) {
+            console.error(`Error: ${error}`);
           }
           next();
         });
@@ -153,9 +211,6 @@ function usePHP(cfg = {}) {
             path: "*"
           });
         }
-      },
-      buildEnd(error) {
-        cleanUp();
       }
     },
     {
@@ -172,7 +227,7 @@ function usePHP(cfg = {}) {
           const code = unescapePHP(`${tempDir}/${file}.html`);
           writeFile(`${distDir}/${file}`, code);
         });
-        cleanUp(distDir);
+        cleanupTemp(distDir);
       }
     }
   ];

package/dist/router.php

@@ -0,0 +1,15 @@
+<?php
+$sourceFile = $_SERVER['SCRIPT_FILENAME'];
+
+$source = file_get_contents($sourceFile);
+$codeTokens = json_decode(file_get_contents("$sourceFile.json"), true);
+
+$source = str_replace(
+	array_keys($codeTokens),
+	array_values($codeTokens),
+	$source,
+);
+
+die((function ($__SOURCE) {
+	eval("?>$__SOURCE<?php");
+})($source));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vite-plugin-php",
-	"version": "0.9.1",
+	"version": "1.0.1",
 	"description": "Precompile PHP-files with the speed of Vite",
 	"keywords": [
 		"vite",