Added functions for PHP code execution via PHP CLI '-r' argument & Code optimisation

Author: BreadEaterYT

.idea/misc.xml

@@ -2,15 +2,16 @@
 
 JavaPHP is a lightweight Java library that permits to execute PHP code into Java so instead of using Java servlets,
 you can just use PHP and execute it as a part of your existing Java code, does not rely on any dependencies, its fully standalone,
-and you can use it in a compiled .jar file or in a simple .java file without having to compile it
+and you can use it in a compiled .jar file or in a simple .java file without having to compile it.
 
-Fun fact: this library was made in like 1 day because i had no other ideas and i was bored so yeah, now this library exists.
+It can be used with Webservers (NanoHTTPD, Java socket, etc...) or as a part of your Java app.
 
 ### Features
-- PHP file execution in java
+- PHP file / code execution in java
 - Customizable error handling
 
-There are not alot of features because i keep it very simple, why would i do a lot of features since its focused only on the purpose of executing PHP in Java.
+### Planned features
+- PHP file / code execution over TCP/IP using PHP-CGI
 
 ### How to use
 Simply import it to your file and do like this:
@@ -20,8 +21,6 @@ import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
 
-import fr.breadeater.JavaPHP;
-
 public class Main {
     public static void main(String[] args) throws Throwable {
         JavaPHP javaphp = new JavaPHP(false);
@@ -33,8 +32,10 @@ public class Main {
 
         javaphp.setPHPVars(env);
         javaphp.run(new File("./test.php").getAbsolutePath());
+        javaphp.runWithCli("echo 'Hello World !';");
 
         System.out.println(javaphp.getResult());
+        System.out.println(javaphp.getInlineResult());
     }
 }
 ```
@@ -44,15 +45,12 @@ Simply download the .jar / .java file from the repository Releases and import it
 For Maven or Gradle, add it to your local repository.
 
 ### Contribution
-You can contribute as much as you want, the conditions: 
-- know Java.
-- use Java JDK 21 or later.
-- keep it standalone (means no external dependencies).
-- provide least a minimum amount of documentation to the modifications you're doing.
-- Make your modifications clean for readability.
-
-### Contact
-You can contact me via [mail](mailto:contact@breadeater.fr) or send message in the discussions of the repository
+You can contribute as much as you want, contributors will be listed in the README.
+
+NOTE: Only modifications in the Java code counts as contribution.
+
+### Contributors
+(No contributors yet)
 
 ### License
 This project is licensed under the MIT license, see [LICENSE](./LICENSE) for more infos.

README.md

@@ -21,7 +21,7 @@
                 <configuration>
                     <archive>
                         <manifest>
-                            <mainClass>fr.breadeater.JavaPHP</mainClass>
+                            <mainClass>fr.breadeater.Main</mainClass>
                         </manifest>
                     </archive>
                     <descriptorRefs>

pom.xml

@@ -2,16 +2,19 @@
 
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
+import java.util.Arrays;
 import java.util.Map;
 import java.util.function.Consumer;
 
 public class JavaPHP {
-    private Consumer<String> ERR_CALLBACK;
-
+    // Private immutable variables
     private final String PHP_BIN_PATH;
     private final boolean NO_PHP_WARN;
 
+    // Private variables
+    private Consumer<String> ERR_CALLBACK;
     private Map<String, String> env_vars;
+    private String inlineResponse = null;
     private String response = null;
 
     /**
@@ -75,29 +78,43 @@ public void run(String php_filepath) throws Throwable {
             if (!this.NO_PHP_WARN && (err.contains("PHP Warning:") || err.contains("PHP Startup:"))) onError(err);
         }
 
-        assert process != null;
+        if (process == null){
+            onError(new Throwable("Error while executing PHP file at " + php_filepath));
+            return;
+        }
 
-        try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))){
-            StringBuilder resBuilder = new StringBuilder();
-            String line;
+        this.response = processOutputHandler(process);
+    }
 
-            while ((line = reader.readLine()) != null) resBuilder.append(line).append("\n");
+    /**
+     * Runs PHP code using PHP CLI '-r' argument
+     * The result can be retrieved with {@link #getInlineResult} function.
+     *
+     * @param php_code The PHP Code
+     */
+    public void runWithCli(String php_code) throws Throwable {
+        ProcessBuilder processBuilder = new ProcessBuilder(this.PHP_BIN_PATH, "-r", php_code);
+        Process process = null;
 
-            this.response = resBuilder.toString();
+        if (this.env_vars != null){
+            Map<String, String> environment = processBuilder.environment();
+            environment.putAll(this.env_vars);
         }
 
-        try (BufferedReader errorReader = new BufferedReader(new InputStreamReader(process.getErrorStream()))){
-            StringBuilder errorBuilder = new StringBuilder();
-            String line;
-
-            while ((line = errorReader.readLine()) != null) errorBuilder.append(line).append("\n");
+        try {
+            process = processBuilder.start();
+        } catch (Throwable error){
+            String err = error.getMessage();
 
-            if (!errorBuilder.toString().isEmpty()){
-                String err = new Throwable(errorBuilder.toString()).getMessage();
+            if (!this.NO_PHP_WARN && (err.contains("PHP Warning:") || err.contains("PHP Startup:"))) onError(err);
+        }
 
-                if (!this.NO_PHP_WARN && (err.contains("PHP Warning:") || err.contains("PHP Startup:"))) onError(err);
-            }
+        if (process == null){
+            onError(new Throwable("Error while executing PHP code"));
+            return;
         }
+
+        this.inlineResponse = processOutputHandler(process);
     }
 
     /**
@@ -110,14 +127,22 @@ public void setErrorCallback(Consumer<String> cb){
 
     /**
      * Gets the result of the executed PHP file
-     * @return The result of the PHP file, returns null if no results
+     * @return The result, returns null if no results
      */
     public String getResult(){
         return this.response;
     }
 
     /**
-     * Error event listener, outputs error with System.err by default, to set custom error handler, use {@link #setErrorCallback}
+     * Gets the result of the inline PHP code
+     * @return The result, returns null if no results
+     */
+    public String getInlineResult(){
+        return this.inlineResponse;
+    }
+
+    /**
+     * Error event listener, outputs error with 'System.err' by default, to set custom error handler, use {@link #setErrorCallback}
      * @param error The error
      */
     private void onError(String error){
@@ -128,4 +153,53 @@ private void onError(String error){
 
         this.ERR_CALLBACK.accept(error);
     }
+
+    /**
+     * Error event listener, outputs error with 'System.err' by default, to set custom error handler, use {@link #setErrorCallback}
+     * @param error The error
+     */
+    private void onError(Throwable error){
+        String err = Arrays.toString(error.getStackTrace());
+
+        if (this.ERR_CALLBACK == null){
+            System.err.println(err);
+            return;
+        }
+
+        this.ERR_CALLBACK.accept(err);
+    }
+
+    /**
+     * Handles the Output of a process and manage errors
+     *
+     * @param process The process
+     * @return The Output of the process
+     */
+    private String processOutputHandler(Process process) throws Throwable {
+        String res;
+
+        try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))){
+            StringBuilder resBuilder = new StringBuilder();
+            String line;
+
+            while ((line = reader.readLine()) != null) resBuilder.append(line).append("\n");
+
+            res = resBuilder.toString();
+        }
+
+        try (BufferedReader errorReader = new BufferedReader(new InputStreamReader(process.getErrorStream()))){
+            StringBuilder errorBuilder = new StringBuilder();
+            String line;
+
+            while ((line = errorReader.readLine()) != null) errorBuilder.append(line).append("\n");
+
+            if (!errorBuilder.toString().isEmpty()){
+                String err = new Throwable(errorBuilder.toString()).getMessage();
+
+                if (!this.NO_PHP_WARN && (err.contains("PHP Warning:") || err.contains("PHP Startup:"))) onError(err);
+            }
+        }
+
+        return res;
+    }
 }

src/main/java/fr/breadeater/JavaPHP.java

@@ -19,7 +19,9 @@ public static void main(String[] args) throws Throwable {
 
         javaphp.setPHPVars(env);
         javaphp.run(new File("./test.php").getAbsolutePath());
+        javaphp.runWithCli("echo 'Hello World !';");
 
         System.out.println(javaphp.getResult());
+        System.out.println(javaphp.getInlineResult());
     }
 }