vite-plugin-php 1.0.10 → 1.0.20

package/README.md

@@ -15,6 +15,11 @@ export default defineConfig({
 });
 ```
 
+Check out the [starter repo](https://github.com/nititech/php-vite-starter) for an easy and convenient start:
+<a href="https://github.com/nititech/php-vite-starter" target="_blank"><img src="https://nititech.de/kosmo-starter-button.png" alt="Starter Repo"></a>
+
+#### ⚡️⚡️⚡️ New feature: URL rewrite!
+
 ## Write some PHP code in your `index.php`
 
 ```php
@@ -40,6 +45,21 @@ The plugin will serve you the processed `index.php` as usual, including all impo
 
 ## Configuration
 
+The configuration takes following properties:
+
+```ts
+type UsePHPConfig = {
+	binary?: string;
+	entry?: string | string[];
+	rewriteUrl?: (requestUrl: URL) => URL | undefined;
+	tempDir?: string;
+	cleanup?: {
+		dev?: boolean;
+		build?: boolean;
+	};
+};
+```
+
 By default the plugin is trying to access the system `php`-binary and load the `index.php` file as the main entry point.
 However you have the possibility to use an other binary or even compile multiple entry-points:
 
@@ -61,7 +81,6 @@ Should you have multiple entry-points, you will be able to access each one accor
 | shop/index.php    | `/shop/` `/shop/index.php`            | `shop/index.php`    |
 | ...               | ...                                   | ...                 |
 
-**⚡️ New feature:** Wildcard selectors!\
 Since version 1.0.6 you can specify wildcard entry points:
 
 ```js
@@ -79,6 +98,29 @@ usePHP({
 
 These entries will also render according to the routing table above.
 
+##### Rewrite urls
+
+If you are using some sort of Apaches _mod_rewrite_ magic or nginx rewrite rules you can simulate them with the newly added in `rewriteUrl` property.
+The rewriteUrl function has one parameter - the requested URL given as URL object - and return either a modified URL object or undefined:
+
+```js
+usePHP({
+	entry: ['index.php', 'partials/**/*.php'],
+	rewriteUrl(requestUrl) {
+		if (['.js', '.css'].some((s) => requestUrl.pathname.includes(s))) {
+			return;
+		}
+
+		requestUrl.search = '_request_=' + requestUrl.pathname;
+		requestUrl.pathname = 'index.php';
+
+		return requestUrl;
+	},
+});
+```
+
+⚠️ **Attention:** If using the rewriteUrl property you will need to exclude (_return undefined_) assets like CSS, JavaScript, Images, etc.. on your own!
+
 ## Known issues
 
 Vite won't be able to process PHP-computed styles, scripts or images:
@@ -94,6 +136,27 @@ If you encounter any other bugs or need some other features feel free to open an
 Love open source? Enjoying my project?\
 Your support can keep the momentum going! Consider a donation to fuel the creation of more innovative open source software.
 
-| via Ko-Fi                                                                         | Buy me a coffee                                                                                                                                                 | via PayPal                                                                                                                                                             |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Y8Y2ALMG) | <a href="https://www.buymeacoffee.com/donnikitos" target="_blank"><img src="https://nititech.de/donate-buymeacoffee.png" alt="Buy Me A Coffee" width="174"></a> | <a href="https://www.paypal.com/donate/?hosted_button_id=EPXZPRTR7JHDW" target="_blank"><img src="https://nititech.de/donate-paypal.png" alt="PayPal" width="174"></a> |
+<table>
+	<tr>
+		<td>
+			via Ko-Fi
+		</td>
+		<td>
+			Buy me a coffee
+		</td>
+		<td>
+			via PayPal
+		</td>
+	</tr>
+	<tr>
+		<td>
+			<a href="https://ko-fi.com/Y8Y2ALMG" target="_blank"><img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Ko-Fi" width="174"></a>
+		</td>
+		<td>
+			<a href="https://www.buymeacoffee.com/donnikitos" target="_blank"><img src="https://nititech.de/donate-buymeacoffee.png" alt="Buy Me A Coffee" width="174"></a>
+		</td>
+		<td>
+			<a href="https://www.paypal.com/donate/?hosted_button_id=EPXZPRTR7JHDW" target="_blank"><img src="https://nititech.de/donate-paypal.png" alt="PayPal" width="174"></a>
+		</td>
+	</tr>
+</table>

package/dist/index.cjs

@@ -4,6 +4,7 @@ const require$$0 = require('fs');
 const require$$0$1 = require('path');
 const http = require('http');
 const child_process = require('child_process');
+const url = require('url');
 const require$$0$2 = require('os');
 const require$$0$3 = require('util');
 const require$$0$4 = require('stream');
@@ -70,7 +71,7 @@ function start(root) {
       "localhost:" + phpServer.port,
       "-t",
       root,
-      decodeURI(routerFileUrl.pathname)
+      url.fileURLToPath(routerFileUrl)
     ]).once("spawn", () => {
       console.log(
         `PHP development server started (PID: ${globalThis.php?.pid})`
@@ -103,6 +104,10 @@ const phpServer = {
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
 var tasks = {};
 
 var utils$k = {};
@@ -6818,10 +6823,14 @@ function assertPatternsInput(input) {
 }
 var out = FastGlob;
 
+const fastGlob = /*@__PURE__*/getDefaultExportFromCjs(out);
+
+const internalParam = "__314159265359__";
 function usePHP(cfg = {}) {
   const {
     binary = "php",
     entry = "index.php",
+    rewriteUrl = (requestUrl) => requestUrl,
     tempDir = ".php-tmp",
     cleanup = {}
   } = cfg;
@@ -6866,7 +6875,7 @@ function usePHP(cfg = {}) {
           writeFile(gitIgnoreFile, "*\n**/*.php.html");
         }
         entries = entries.flatMap(
-          (entry2) => out.globSync(entry2, {
+          (entry2) => fastGlob.globSync(entry2, {
             dot: true,
             onlyFiles: true,
             unique: true,
@@ -6894,23 +6903,39 @@ function usePHP(cfg = {}) {
         phpServer.start(viteServer?.config.root);
         server.middlewares.use(async (req, res, next) => {
           try {
-            if (req.url) {
-              const url = new URL(
-                req.url,
-                "http://localhost:" + phpServer.port
-              );
-              let requestUrl = url.pathname;
-              if (requestUrl.endsWith("/")) {
-                requestUrl += "index.php";
+            if (req.url && !["/@vite", "/@fs"].some(
+              (path) => req.url.startsWith(path)
+            )) {
+              const url = new URL(req.url, "http://localhost");
+              if (config?.server.port) {
+                url.port = config.server.port.toString();
               }
-              requestUrl = requestUrl.substring(1);
+              const requestUrl = url.pathname;
+              if (url.pathname.endsWith("/")) {
+                url.pathname += "index.php";
+              }
+              const routedUrl = rewriteUrl(url);
+              if (routedUrl) {
+                url.pathname = routedUrl.pathname;
+                url.search = routedUrl.search;
+                url.hash = routedUrl.hash;
+              }
+              const entryPathname = url.pathname.substring(1);
               const entry2 = entries.find((file) => {
-                return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+                return file === entryPathname || file.substring(0, file.lastIndexOf(".")) === entryPathname;
               });
               if (entry2) {
                 const tempFile = `${tempDir}/${entry2}.html`;
                 if (require$$0.existsSync(require$$0$1.resolve(tempFile))) {
                   url.pathname = tempFile;
+                  url.port = phpServer.port.toString();
+                  url.searchParams.set(
+                    internalParam,
+                    new URLSearchParams({
+                      REQUEST_URI: requestUrl,
+                      PHP_SELF: "/" + entry2
+                    }).toString()
+                  );
                   const phpResult = await new Promise(
                     (resolve2, reject) => {
                       const chunks = [];
@@ -6937,7 +6962,7 @@ function usePHP(cfg = {}) {
                   );
                   let out = phpResult.toString();
                   out = await server.transformIndexHtml(
-                    requestUrl || "/",
+                    entryPathname || "/",
                     out
                   );
                   res.end(out);

package/dist/index.d.cts

@@ -3,6 +3,7 @@ import { Plugin } from 'vite';
 type UsePHPConfig = {
     binary?: string;
     entry?: string | string[];
+    rewriteUrl?: (requestUrl: URL) => URL | undefined;
     tempDir?: string;
     cleanup?: {
         dev?: boolean;

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import { Plugin } from 'vite';
 type UsePHPConfig = {
     binary?: string;
     entry?: string | string[];
+    rewriteUrl?: (requestUrl: URL) => URL | undefined;
     tempDir?: string;
     cleanup?: {
         dev?: boolean;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { Plugin } from 'vite';
 type UsePHPConfig = {
     binary?: string;
     entry?: string | string[];
+    rewriteUrl?: (requestUrl: URL) => URL | undefined;
     tempDir?: string;
     cleanup?: {
         dev?: boolean;

package/dist/index.mjs

@@ -2,6 +2,7 @@ import require$$0$4, { mkdirSync, writeFileSync, readFileSync, existsSync, rmSyn
 import require$$0$1, { dirname, resolve } from 'path';
 import http from 'http';
 import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
 import require$$0 from 'os';
 import require$$0$2 from 'util';
 import require$$0$3 from 'stream';
@@ -57,7 +58,7 @@ function start(root) {
       "localhost:" + phpServer.port,
       "-t",
       root,
-      decodeURI(routerFileUrl.pathname)
+      fileURLToPath(routerFileUrl)
     ]).once("spawn", () => {
       console.log(
         `PHP development server started (PID: ${globalThis.php?.pid})`
@@ -90,6 +91,10 @@ const phpServer = {
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
 var tasks = {};
 
 var utils$k = {};
@@ -6805,10 +6810,14 @@ function assertPatternsInput(input) {
 }
 var out = FastGlob;
 
+const fastGlob = /*@__PURE__*/getDefaultExportFromCjs(out);
+
+const internalParam = "__314159265359__";
 function usePHP(cfg = {}) {
   const {
     binary = "php",
     entry = "index.php",
+    rewriteUrl = (requestUrl) => requestUrl,
     tempDir = ".php-tmp",
     cleanup = {}
   } = cfg;
@@ -6853,7 +6862,7 @@ function usePHP(cfg = {}) {
           writeFile(gitIgnoreFile, "*\n**/*.php.html");
         }
         entries = entries.flatMap(
-          (entry2) => out.globSync(entry2, {
+          (entry2) => fastGlob.globSync(entry2, {
             dot: true,
             onlyFiles: true,
             unique: true,
@@ -6881,23 +6890,39 @@ function usePHP(cfg = {}) {
         phpServer.start(viteServer?.config.root);
         server.middlewares.use(async (req, res, next) => {
           try {
-            if (req.url) {
-              const url = new URL(
-                req.url,
-                "http://localhost:" + phpServer.port
-              );
-              let requestUrl = url.pathname;
-              if (requestUrl.endsWith("/")) {
-                requestUrl += "index.php";
+            if (req.url && !["/@vite", "/@fs"].some(
+              (path) => req.url.startsWith(path)
+            )) {
+              const url = new URL(req.url, "http://localhost");
+              if (config?.server.port) {
+                url.port = config.server.port.toString();
               }
-              requestUrl = requestUrl.substring(1);
+              const requestUrl = url.pathname;
+              if (url.pathname.endsWith("/")) {
+                url.pathname += "index.php";
+              }
+              const routedUrl = rewriteUrl(url);
+              if (routedUrl) {
+                url.pathname = routedUrl.pathname;
+                url.search = routedUrl.search;
+                url.hash = routedUrl.hash;
+              }
+              const entryPathname = url.pathname.substring(1);
               const entry2 = entries.find((file) => {
-                return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+                return file === entryPathname || file.substring(0, file.lastIndexOf(".")) === entryPathname;
               });
               if (entry2) {
                 const tempFile = `${tempDir}/${entry2}.html`;
                 if (existsSync(resolve(tempFile))) {
                   url.pathname = tempFile;
+                  url.port = phpServer.port.toString();
+                  url.searchParams.set(
+                    internalParam,
+                    new URLSearchParams({
+                      REQUEST_URI: requestUrl,
+                      PHP_SELF: "/" + entry2
+                    }).toString()
+                  );
                   const phpResult = await new Promise(
                     (resolve2, reject) => {
                       const chunks = [];
@@ -6924,7 +6949,7 @@ function usePHP(cfg = {}) {
                   );
                   let out = phpResult.toString();
                   out = await server.transformIndexHtml(
-                    requestUrl || "/",
+                    entryPathname || "/",
                     out
                   );
                   res.end(out);

package/dist/router.php

@@ -1,6 +1,18 @@
 <?php
 $sourceFile = $_SERVER['SCRIPT_FILENAME'];
 
+$internal_param = '__314159265359__';
+parse_str($_GET[$internal_param], $internal_vars);
+
+foreach ($internal_vars as $key => $value) {
+	$_SERVER[$key] = $value;
+}
+unset($_GET[$internal_param]);
+
+$_SERVER['SCRIPT_NAME'] = $_SERVER['PHP_SELF'];
+$_SERVER['SCRIPT_FILENAME'] = $_SERVER['DOCUMENT_ROOT'] . $_SERVER['SCRIPT_NAME'];
+$_SERVER['QUERY_STRING'] = http_build_query($_GET);
+
 $source = file_get_contents($sourceFile);
 $codeTokens = json_decode(file_get_contents("$sourceFile.json"), true);
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vite-plugin-php",
-	"version": "1.0.10",
-	"description": "Precompile PHP-files with the speed of Vite",
+	"version": "1.0.20",
+	"description": "Process PHP-files with the speed and tools of Vite",
 	"keywords": [
 		"vite",
 		"vite-plugin",
@@ -12,7 +12,10 @@
 		"php",
 		"php-loader",
 		"php-compiler",
-		"loader"
+		"loader",
+		"url rewrite",
+		"url router",
+		"mod_rewrite"
 	],
 	"author": "Nikita 'donnikitos' Nitichevski <me@donnikitos.com> (https://donnikitos.com/)",
 	"license": "MIT",
@@ -51,10 +54,10 @@
 	},
 	"dependencies": {},
 	"devDependencies": {
-		"@types/node": "^20.11.5",
+		"@types/node": "^20.12.7",
 		"fast-glob": "^3.3.2",
-		"typescript": "^5.3.3",
+		"typescript": "^5.4.5",
 		"unbuild": "^2.0.0",
-		"vite": "^5.1.3"
+		"vite": "^5.2.8"
 	}
 }