feat: test and README.md

Author: mendrika261

.framework/app.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+
+<!--
+    The app.xml file is used to configure the application.
+    It is loaded by the framework and can be accessed via the Conf class.
+-->
+
+<app>
+    <config id="auth">
+        <session name="profile" />
+        <profiles>
+            <profile name="AUTH_PROFILE_ADMIN" value="admin" />
+            <profile name="AUTH_PROFILE_USER" value="user" />
+        </profiles>
+    </config>
+</app>

.framework/dev_files/etu2024/framework/core/ModelView.java

@@ -12,6 +12,7 @@ public class ModelView {
     HashMap<String, Object> data = new HashMap<>();
     HashMap<String, Object> session = new HashMap<>();
     boolean isJson = false;
+    boolean isRedirect = false;
 
     // Constructor
     public ModelView() {}
@@ -24,7 +25,10 @@ public ModelView(String view) {
     public boolean login(String profile) {
         User.profileExists(profile);
         addSessionItem(Conf.getAuthSessionName(), profile);
-        return isLogged(profile);
+        boolean login = isLogged(profile);
+        if (login)
+            redirect(Conf.getAuthRedirections().get("AUTH_REDIRECT_LOGIN"));
+        return login;
     }
 
     public boolean loginUser() {
@@ -45,21 +49,35 @@ public boolean loginAdmin() {
 
     public boolean logout() {
         removeSessionItem(Conf.getAuthSessionName());
-        return !getSession().containsKey(Conf.getAuthSessionName()) || getSession().get(Conf.getAuthSessionName()) == null;
+        boolean logout = !getSession().containsKey(Conf.getAuthSessionName()) || getSession().get(Conf.getAuthSessionName()) == null;
+        if (logout)
+            redirect(Conf.getAuthRedirections().get("AUTH_REDIRECT_LOGOUT"));
+        return logout;
     }
 
     public boolean isLogged(String profile) {
         return getSession().containsKey(Conf.getAuthSessionName()) && getSession().get(Conf.getAuthSessionName()) != null &&
                 getSession().get(Conf.getAuthSessionName()).equals(profile);
     }
 
+    public boolean isLogged() {
+        return getSession().containsKey(Conf.getAuthSessionName()) && getSession().get(Conf.getAuthSessionName()) != null;
+    }
+
+    public ModelView redirect(String url) {
+        setView(url);
+        setRedirect(true);
+        return this;
+    }
+
     // Getters and setters
     public String getView() {
         return view;
     }
 
     public void setView(String view) {
         this.view = view;
+        setRedirect(false);
     }
 
     public HashMap<String, Object> getData() {
@@ -97,4 +115,12 @@ public boolean isJson() {
     public void setJson(boolean isJson) {
         this.isJson = isJson;
     }
+
+    public boolean isRedirect() {
+        return isRedirect;
+    }
+
+    public void setRedirect(boolean isRedirect) {
+        this.isRedirect = isRedirect;
+    }
 }

.framework/dev_files/etu2024/framework/servlet/FrontServlet.java

@@ -14,6 +14,7 @@
 import jakarta.servlet.*;
 import jakarta.servlet.annotation.MultipartConfig;
 import jakarta.servlet.http.*;
+import org.eclipse.jdt.internal.compiler.codegen.ObjectCache;
 
 import java.io.IOException;
 import java.lang.reflect.Field;
@@ -77,33 +78,29 @@ private void processRequest(HttpServletRequest request, HttpServletResponse resp
             HttpSession session = request.getSession();
             Object profile = session.getAttribute(Conf.getAuthSessionName());
             if(!User.isAuthorized(method, profile)) {
-                response.sendError(403, "FRAMEWORK ERROR - You are not authorized to access this page");
+                response.sendRedirect(getServletContext().getContextPath()+Conf.getAuthRedirections().get("AUTH_REDIRECT_LOGOUT"));
                 return;
             }
 
+            // @RestAPI function directly return JSON
             if(method.isAnnotationPresent(RestAPI.class)) {
                 printJson(method.invoke(object, parameters.toArray()), response);
                 return;
             }
 
-            ModelView modelView = (ModelView) method.invoke(object, parameters.toArray());
+            Object functionReturn = method.invoke(object, parameters.toArray());
+            if(functionReturn == null || functionReturn.getClass() != ModelView.class) {
+                response.sendError(500, "FRAMEWORK ERROR - The method \"" + method.getName() + "\" in the class \"" +
+                        objectClass.getName() + "\" make errors, make sure it return a ModelView object or use @RestAPI" +
+                        " to return all types");
+                return;
+            }
+            ModelView modelView = (ModelView) functionReturn;
 
+            // 4. Set the session attributes if the method or the class is annotated with @Session
             if(method.isAnnotationPresent(Session.class) || objectClass.isAnnotationPresent(Session.class) ||
                 method.isAnnotationPresent(Auth.class)) {
-                // Set session attributes from the modelView to the request
-                for (String key : modelView.getSession().keySet()) {
-                    // If the value is null, remove the attribute from the session
-                    if (modelView.getSession().get(key) == null)
-                        session.removeAttribute(key);
-                    else
-                        session.setAttribute(key, modelView.getSession().get(key));
-                }
-
-                // Set session from the request to the modelView
-                for (Enumeration<String> e = session.getAttributeNames(); e.hasMoreElements(); ) {
-                    String key = e.nextElement();
-                    modelView.addSessionItem(key, session.getAttribute(key));
-                }
+                setSessions(modelView, session);
             } else {
                 if(!modelView.getSession().isEmpty())
                     throw new RuntimeException("FRAMEWORK ERROR - You can't set or get session attributes if the method" +
@@ -121,8 +118,12 @@ private void processRequest(HttpServletRequest request, HttpServletResponse resp
             }
 
             // Forward the request if view is set in the modelView
-            if (modelView.getView() != null)
-                request.getRequestDispatcher(modelView.getView()).forward(request, response);
+            if (modelView.getView() != null) {
+                if (modelView.isRedirect())
+                    response.sendRedirect(getServletContext().getContextPath()+modelView.getView());
+                else
+                    request.getRequestDispatcher(modelView.getView()).forward(request, response);
+            }
 
         } catch (ClassNotFoundException | InvocationTargetException | IllegalAccessException | NoSuchMethodException |
                  InstantiationException e) {
@@ -194,6 +195,26 @@ public Object constructObject(Class<?> objectClass) throws NoSuchMethodException
         return objectClass.getDeclaredConstructor().newInstance();
     }
 
+    // Set session attributes from the modelView to the session and vice versa
+    public void setSessions(ModelView modelView, HttpSession session) {
+        // Set session attributes from the modelView to the request
+        for (String key : modelView.getSession().keySet()) {
+            // If the value is null, remove the attribute from the session
+            if (modelView.getSession().get(key) == null)
+                session.removeAttribute(key);
+            else
+                session.setAttribute(key, modelView.getSession().get(key));
+        }
+
+        // Set session from the request to the modelView
+        for (Enumeration<String> e = session.getAttributeNames(); e.hasMoreElements(); ) {
+            String key = e.nextElement();
+            modelView.addSessionItem(key, session.getAttribute(key));
+        }
+    }
+
+
+
     public void printJson(Object object, HttpServletResponse response) throws IOException {
         response.setContentType("application/json");
         response.setCharacterEncoding("UTF-8");

.framework/dev_files/etu2024/framework/utility/Conf.java

@@ -49,4 +49,22 @@ public static HashMap<String, String> getAuthProfiles() {
             throw new RuntimeException("Profiles for auth not found in app.xml");
         }
     }
+
+    public static HashMap<String, String> getAuthRedirections() {
+        try {
+            Element redirectionsElement = (Element) getDocument().getElementsByTagName("redirections").item(0);
+            NodeList redirectionNodes = redirectionsElement.getElementsByTagName("redirect");
+
+            HashMap<String, String> redirectionsMap = new HashMap<>();
+            for (int i = 0; i < redirectionNodes.getLength(); i++) {
+                Element redirectionElement = (Element) redirectionNodes.item(i);
+                String redirectionName = redirectionElement.getAttribute("name");
+                String redirectionValue = redirectionElement.getAttribute("value");
+                redirectionsMap.put(redirectionName, redirectionValue);
+            }
+            return redirectionsMap;
+        } catch (Exception e) {
+            throw new RuntimeException("Redirections for auth not found in app.xml");
+        }
+    }
 }

.framework/framework.jar

@@ -4,25 +4,42 @@
          xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
          version="5.0">
 
+    <!-- This is the main servlet of the framework -->
     <servlet>
         <servlet-name>FrontServlet</servlet-name>
         <servlet-class>etu2024.framework.servlet.FrontServlet</servlet-class>
         <init-param>
+            <!-- The root package of the project must set here (with framework.sh generally)-->
             <param-name>PACKAGE_ROOT</param-name>
             <param-value>${PROJECT_JAVA_SRC}/</param-value>
         </init-param>
     </servlet>
 
+    <!--
+        All the requests are redirected to the FrontServlet
+        NOTE: For some version of Tomcat, you must add static files into the default servlet
+    -->
     <servlet-mapping>
         <servlet-name>FrontServlet</servlet-name>
         <url-pattern/>
         <url-pattern>/</url-pattern>
     </servlet-mapping>
 
+    <!--
+        Static files are served by the default servlet
+    -->
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.html</url-pattern>
         <url-pattern>*.css</url-pattern>
+        <url-pattern>*.js</url-pattern>
+        <url-pattern>*.png</url-pattern>
+        <url-pattern>*.jpg</url-pattern>
+        <url-pattern>*.jpeg</url-pattern>
+        <url-pattern>*.gif</url-pattern>
+        <url-pattern>*.svg</url-pattern>
+        <url-pattern>*.ico</url-pattern>
+        <url-pattern>*.ttf</url-pattern>
     </servlet-mapping>
 
 </web-app>

.framework/web.xml

@@ -0,0 +1,114 @@
+<div align="center">
+
+# Weby Framework ☕️
+A simple Java Framework for Web Applications 👨‍💻
+
+</div>
+
+## Features 🐣
+DONE
+1. [x] Singleton class
+2. [x] Session
+3. [x] Auth with many profiles
+4. [x] Return Json (via modelView)
+5. [x] Rest API (direct returning object)
+6. [x] File upload or input array
+7. [x] `app.xml` external configuration file
+8. [x] `framework.sh` manager and auto-reload
+
+**TODO**
+10. [ ] Database integration
+11. [ ] Error reporting (404 error page...)
+12. [ ] Log system
+13. [ ] Security improvements
+14. [ ] Full Documentation <br>
+    ... and more
+
+## Requirements 📋
+| Requirements    | Version           |
+|-----------------|-------------------|
+| JDK ☕️          | equal or upper 17 |
+| Tomcat 🐱       | equal or upper 10 |
+| Gson library 📚 | 2.10 (provided ✅) |
+
+## Installation 🚀
+Get the last released version from the [releases page]() 
+- Demo version contains examples of use and some test
+- Production version contains only the framework
+
+### First configuration
+- Open `conf.env` file and set all: jdk, tomcat, information about your project like where the project will be created<br>
+If it is not in your file get it from [here]() and change
+- Then, give permissions for `framework.sh` the script that will help you to manage the framework
+```bash
+sudo chmod +x framework.sh
+```
+- Finally, `init` your repository for a weby project
+```bash
+./framework.sh --init
+```
+
+### Running
+- To run your project you can use the script `framework.sh`, make `framework.sh --help` to see all options
+```bash
+./framework.sh --run
+```
+> The script will compile your project and run it in tomcat with `auto reload` feature enabled,
+for `*.xml` or any configurations changed you might sometimes need to restart tomcat ⚠️
+
+## Usage 🧑‍🍳
+> Let's learn by examples, it is the best (and fastest) way to learn. ℹ️
+
+### Overview
+#### This is a basic controller
+```java
+import etu2024.framework.annotation.Auth;
+import etu2024.framework.core.ModelView;
+...
+@Url(url = "/") // The url where the controller will be called
+public ModelView index() {
+    ModelView modelView = new ModelView(); // A class to manage the view
+
+    modelView.setView("home.jsp"); // The page to render
+    return modelView;
+}
+...
+```
+#### Send data to the view
+```java
+...
+// The class where all process will be done
+ModelView modelView = new ModelView();
+// Add a variable to the view
+modelView.addItem("name", "Weby");
+// The page to render
+modelView.setView("home.jsp");
+...
+```
+#### Get data from the view
+Attributes and parameters are filled automatically
+```java
+public class Customer()
+    private String name;
+    ...
+    public ModelView getCustomer(String id) {
+        ModelView modelView = new ModelView();
+        
+        // Access directly to the variable name and id
+        
+        modelView.setView("home.jsp");
+        return modelView;
+    }
+    ...
+```
+#### Redirection
+```java
+...
+ModelView modelView = new ModelView();
+return modelView.redirect("/home");
+...
+```
+
+#### See full documentation [here]() 📖
+Report bugs [here]() 🐛 and contribute [here]() 🤝
+

README.md

@@ -5,6 +5,11 @@
         <session name="profile" />
         <profiles>
             <profile name="AUTH_PROFILE_ADMIN" value="admin" />
+            <profile name="AUTH_PROFILE_USER" value="user" />
         </profiles>
+        <redirections>
+            <redirect name="AUTH_REDIRECT_LOGIN" value="/" />
+            <redirect name="AUTH_REDIRECT_LOGOUT" value="/login" />
+        </redirections>
     </config>
 </app>

app.xml

@@ -25,7 +25,7 @@ TOMCAT_PORT=8080
 JAVAC=`which javac`
 JAVA=`which java`
 
-# Color configuration
+# Color configuration (DO NOT CHANGE)
 COLOR_RED="\033[0;31m"
 COLOR_GREEN="\033[0;32m"
 COLOR_BLUE="\033[0;34m"