Added Unix Socket Support, JavaPHP now requires Java 17 or above

Author: BreadEaterYT

.idea/misc.xml

@@ -9,7 +9,7 @@ If you have skills in Java you can contribute as much as you want !
 
 ### Get Started
 - Fork the repository
-- Do what you want add or modify
+- Do what you want to add or modify
 - Do a Pull Request
 
 Note: Modifications of Markdown files, LICENSE, or any files that aren't code does not count !

CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+<?php
+$body = file_get_contents("php://input");
+
+echo $body;

CONTRIBUTING.md

@@ -6,12 +6,33 @@
 
     <groupId>fr.breadeater</groupId>
     <artifactId>JavaPHP</artifactId>
-    <version>2.0-RELEASE</version>
+    <version>2.2.1</version>
 
     <properties>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
+    <distributionManagement>
+        <repository>
+            <id>github</id>
+            <name>GitHub Packages</name>
+            <url>https://maven.pkg.github.com/BreadEaterYT/JavaPHP</url>
+        </repository>
+    </distributionManagement>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>17</source>
+                    <target>17</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
 </project>

SECURITY.md

@@ -1,14 +1,25 @@
 package fr.breadeater.javaphp;
 
+import com.sun.net.httpserver.Headers;
+
 import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
-import java.net.Socket;
 import java.nio.ByteBuffer;
+import java.nio.channels.SocketChannel;
 import java.nio.charset.StandardCharsets;
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 class FastCGIUtils {
-    public static byte[] buildRecord(Status type, int requestId, byte[] content){
+    /**
+     * Builds record and returns it
+     * @param type The record type
+     * @param requestId The request ID
+     * @param content The content
+     * @return The built record
+     */
+    static byte[] buildRecord(Status type, int requestId, byte[] content){
         int length = content.length;
         int padding = (8 - (length % 8)) % 8;
 
@@ -29,7 +40,13 @@ public static byte[] buildRecord(Status type, int requestId, byte[] content){
         return buffer.array();
     }
 
-    public static byte[] encodeLength(int length){
+
+    /**
+     * Encodes byte array length to be sent to FastCGI server
+     * @param length The length to be encoded.
+     * @return A byte array containing the encoded length
+     */
+    static byte[] encodeLength(int length){
         if (length < 128) return new byte[]{ (byte) length };
 
         return new byte[]{
@@ -40,33 +57,63 @@ public static byte[] encodeLength(int length){
         };
     }
 
-    public static byte[] buildParams(boolean empty, int requestId, Map<String, String> params) throws Exception {
+
+    /**
+     * Build params and sends them to FastCGI server
+     * @param empty Should it sends Empty Params
+     * @param requestId
+     * @param params
+     * @return
+     * @throws Exception
+     */
+    static byte[] buildParams(boolean empty, int requestId, Map<String, String> params) throws Exception {
         if (empty) return buildRecord(Status.FCGI_PARAMS, requestId, new byte[0]);
 
         ByteArrayOutputStream out = new ByteArrayOutputStream();
 
         for (Map.Entry<String, String> entry : params.entrySet()){
-            byte[] key = entry.getKey().getBytes(StandardCharsets.UTF_8);
-            byte[] value = entry.getValue().getBytes(StandardCharsets.UTF_8);
+            String key = entry.getKey();
+            String value = entry.getValue();
 
-            out.write(encodeLength(key.length));
-            out.write(encodeLength(value.length));
-            out.write(key);
-            out.write(value);
+            if (value == null) continue;
+
+            out.write(encodeLength(key.getBytes(StandardCharsets.UTF_8).length));
+            out.write(encodeLength(value.getBytes(StandardCharsets.UTF_8).length));
+            out.write(key.getBytes(StandardCharsets.UTF_8));
+            out.write(value.getBytes(StandardCharsets.UTF_8));
         }
 
         return buildRecord(Status.FCGI_PARAMS, requestId, out.toByteArray());
     }
 
-    public static byte[] buildStdin(int requestId, byte[] body){
+
+    /**
+     * Builds stdin containing a byte array and returns it
+     * @param requestId The request ID
+     * @param body
+     * @return The built stdin
+     */
+    static byte[] buildStdin(int requestId, byte[] body){
         return buildRecord(Status.FCGI_STDIN, requestId, body);
     }
 
-    public static byte[] buildEmptyStdin(int requestId){
+
+    /**
+     * Builds a empty stdin and returns it
+     * @param requestId The request ID
+     * @return The built stdin
+     */
+    static byte[] buildEmptyStdin(int requestId){
         return buildRecord(Status.FCGI_STDIN, requestId, new byte[0]);
     }
 
-    public static byte[] buildRequest(int requestId){
+
+    /**
+     * Builds request and returns it
+     * @param requestId The request ID
+     * @return The request
+     */
+    static byte[] buildRequest(int requestId){
         byte[] body = new byte[8];
 
         body[0] = 0;
@@ -76,10 +123,17 @@ public static byte[] buildRequest(int requestId){
         return buildRecord(Status.FCGI_BEGIN_REQUEST, requestId, body);
     }
 
-    public static String parseFastCGIRequest(Socket client, InputStream in) throws Exception {
+
+    /**
+     * Parses the FastCGI response and return its body
+     * @param client The client socket
+     * @param in The input stream of the client
+     * @return The body of the response
+     */
+    static String parseFastCGIRequest(SocketChannel client, InputStream in) throws Exception {
         String result = null;
 
-        while (!client.isClosed()){
+        while (client.isOpen()){
             int version = in.read();
             int type = in.read();
             int requestIdHigh = in.read();
@@ -112,4 +166,59 @@ public static String parseFastCGIRequest(Socket client, InputStream in) throws E
 
         return result;
     }
+
+
+    /**
+     * Sets all FastCGI params and returns a Map containing all the params
+     * @param runOptions The JavaPHP options to run a PHP file
+     * @param request An Http Request instance containing request method, request headers, etc...
+     * @return The Map containing all the params
+     */
+    static Map<String, String> setFastCGIParams(JavaPHP.Options runOptions, Request request) {
+        Map<String, String> fastCGIheaders = new HashMap<>();
+        Headers reqHeaders = request.getRequestHeaders();
+        String httpsEnabled = "off";
+
+        String[] splittedURI = request.getRequestPath().split("\\?", 2);
+
+        if (splittedURI.length == 2) fastCGIheaders.put("QUERY_STRING", splittedURI[1]);
+        if (request.isHttps()) httpsEnabled = "on";
+
+        fastCGIheaders.put("SCRIPT_FILENAME", runOptions.PHP_FILEPATH);
+        fastCGIheaders.put("GATEWAY_INTERFACE", "CGI/1.1");
+        fastCGIheaders.put("SERVER_PROTOCOL", request.getRequestHttpVersion());
+        fastCGIheaders.put("REQUEST_METHOD", request.getRequestMethod());
+        fastCGIheaders.put("SCRIPT_NAME", splittedURI[0]);
+        fastCGIheaders.put("REQUEST_URI", request.getRequestPath());
+        fastCGIheaders.put("DOCUMENT_ROOT", runOptions.PHP_DOC_ROOT);
+        fastCGIheaders.put("SERVER_SOFTWARE", runOptions.PHP_SERVERSOFTWARE);
+        fastCGIheaders.put("REMOTE_ADDR", request.getRequestAddress().getHostName());
+        fastCGIheaders.put("REMOTE_PORT", Integer.toString(request.getRequestAddress().getPort()));
+        fastCGIheaders.put("SERVER_ADDR", runOptions.PHP_SERVERADDR);
+        fastCGIheaders.put("SERVER_PORT", Integer.toString(runOptions.PHP_SERVERPORT));
+        fastCGIheaders.put("HTTPS", httpsEnabled);
+
+        for (Map.Entry<String, List<String>> entry : reqHeaders.entrySet()){
+            String key = entry.getKey();
+            String value = entry.getValue().get(0);
+
+            if (key.equals("Content-Length")) continue;
+
+            if (key.equals("Content-Type")){
+                fastCGIheaders.put("CONTENT_TYPE", value);
+                continue;
+            }
+
+            if (request.getRequestBody() != null){
+                int reqBodyLength = request.getRequestBody().getBytes().length;
+
+                fastCGIheaders.put("CONTENT_LENGTH", Integer.toString(reqBodyLength));
+                continue;
+            }
+
+            fastCGIheaders.put("HTTP_" + key.replaceAll("-", "_").toUpperCase(), value);
+        }
+
+        return fastCGIheaders;
+    }
 }