Adding JavaPHP v1.0.0 source code

Author: BreadEaterYT

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BreadEater
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+## JavaPHP
+
+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
+
+### Features
+- PHP file execution in java
+- Customizable error handling
+
+### How to use
+Simply import it to your file and do like this:
+```java
+import java.io.File;
+import java.util.HashMap;
+import java.util.Map;
+
+public class Main {
+    public static void main(String[] args) throws Throwable {
+        PHPJava phpjava = new PHPJava(false); // Determines if PHP errors should be ignored
+        Map<String, String> env = new HashMap<>(); // Stores PHP global variables (e.g REQUEST_METHOD, etc...)
+
+        env.put("REQUEST_METHOD", "GET");
+        
+        // Defines a lambda function that will be called each time an error occurs
+        phpjava.setErrorCallback((error) -> System.out.println("ERROR: " + error));
+        
+        phpjava.setPHPVars(env); // Gives the global variables to the PHP file
+        phpjava.run(new File("./test.php").getAbsolutePath()); // Runs the PHP file
+
+        // Prints the result (HTML code if used with a webserver)
+        System.out.println(phpjava.getResult());
+    }
+}
+```
+
+### Installation
+Simply download the .jar / .java file from the repository Releases and import it in your project
+
+To import the .java file, simply drag it into your project folder.<br>
+To import the .jar file, simply use Maven / Gradle and add new dependency to your configuration that points to the .jar file
+
+### 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
+
+### License
+
+This project is licensed under the MIT license, see [LICENSE](./LICENSE) for more infos.

pom.xml

@@ -6,21 +6,13 @@
 
     <groupId>fr.breadeater</groupId>
     <artifactId>JavaPHP</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>1.0-ALPHA</version>
 
     <properties>
         <maven.compiler.source>21</maven.compiler.source>
         <maven.compiler.target>21</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
-    <dependencies>
-        <dependency>
-            <groupId>org.jetbrains</groupId>
-            <artifactId>annotations</artifactId>
-            <version>26.0.1</version>
-            <scope>compile</scope>
-        </dependency>
-    </dependencies>
 
     <build>
         <plugins>

src/main/java/fr/breadeater/Main.java

@@ -1,7 +1,5 @@
 package fr.breadeater;
 
-import org.jetbrains.annotations.TestOnly;
-
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
@@ -10,17 +8,20 @@
  * The Main class is used to test the library
  */
 
-@TestOnly
-public class Main extends PHPJava {
+public class Main {
     public static void main(String[] args) throws Throwable {
-        PHPJava phpjava = new PHPJava(true);
+        /*
+        PHPJava phpjava = new PHPJava(false);
         Map<String, String> env = new HashMap<>();
 
         env.put("REQUEST_METHOD", "GET");
 
+        phpjava.setErrorCallback((error) -> System.out.println("ERROR: " + error));
+
         phpjava.setPHPVars(env);
         phpjava.run(new File("./test.php").getAbsolutePath());
 
         System.out.println(phpjava.getResult());
+        */
     }
 }

src/main/java/fr/breadeater/PHPJava.java

@@ -3,6 +3,7 @@
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
 import java.util.Map;
+import java.util.function.Consumer;
 
 public class PHPJava {
     private final String PHP_BIN_PATH;
@@ -11,6 +12,8 @@ public class PHPJava {
     private Map<String, String> env_vars;
     private String response = null;
 
+    private Consumer<String> ERR_CALLBACK;
+
     /**
      * Creates a PHPJava instance
      * @param php_bin_path PHP binary file path (e.g /usr/bin/php)
@@ -67,12 +70,11 @@ public void run(String php_filepath) throws Throwable {
         } catch (Throwable error){
             String err = error.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);
         }
 
         assert process != null;
+
         try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))){
             StringBuilder resBuilder = new StringBuilder();
             String line;
@@ -91,13 +93,19 @@ public void run(String php_filepath) throws Throwable {
             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);
             }
         }
     }
 
+    /**
+     * Sets the function that will be called to handle the error instead of printing it into the console
+     * @param cb The function to be executed on error
+     */
+    public void setErrorCallback(Consumer<String> cb){
+        this.ERR_CALLBACK = cb;
+    }
+
     /**
      * Gets the result of the executed PHP file
      * @return The result of the PHP file, returns null if no results
@@ -107,10 +115,15 @@ public String getResult(){
     }
 
     /**
-     * Error event listener, outputs error with System.err by default, it needs to be overridden
+     * Error event listener, outputs error with System.err by default, to set custom error handler, use {@link #setErrorCallback}
      * @param error The error
      */
-    public void onError(String error){
-        System.err.println(error);
+    private void onError(String error){
+        if (this.ERR_CALLBACK == null) {
+            System.err.println(error);
+            return;
+        }
+
+        this.ERR_CALLBACK.accept(error);
     }
 }