Compare commits

...

2 Commits

Author SHA1 Message Date
85d16ebfc7 setting web root via configuration
All checks were successful
continuous-integration/drone/push Build is passing
2024-12-23 15:23:24 +01:00
8a85bca1ef move configuration init into baseservlet 2024-12-23 15:14:17 +01:00
11 changed files with 56 additions and 59 deletions

View File

@ -9,6 +9,7 @@ this environment variables are preset in docker image:
* `MAVOR_TEMP_DIR`: path to a readable and writeable directory to temporarily store files
this environemnt variables are required to be set in docker container:
* `MAVOR_WEB_ROOT`: Base URL of how the client access the web page
* `MAVOR_OPENID_CLIENT_ID`: OpenID Client ID
* `MAVOR_OPENID_CLIENT_SECRET`: OpenID Client Secret - not yet providing docker secrets
* `MAVOR_OPENID_REDIRECT_URL`: OpenID Redirect URL - where to redirect after authentication
@ -20,6 +21,7 @@ this environemnt variables are required to be set in docker container:
## Development
To avoid setting environment variables during devleopment, create `src/main/resources/development.properties` with content like:
```
MAVOR_WEB_ROOT=http://localhost:8080/mavor
MAVOR_MAVEN_EXECUTABLE=/usr/bin/mvn
MAVOR_TEMP_DIR=/home/damage/Temp
MAVOR_OPENID_CLIENT_ID=foo

View File

@ -3,18 +3,18 @@ package de.devloop.mavor;
import java.io.IOException;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
public class AuthenticatedServlet extends HttpServlet {
public class AuthenticatedServlet extends BaseServlet {
protected Session session;
@Override
protected final void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
super.doGet(req, resp);
session = new Session(req.getSession(true));
if (!session.isAuthenticated()) {
resp.sendRedirect("/mavor/authenticate");
resp.sendRedirect(configuration.getWebRoot() + "/authenticate");
} else {
doAuthenticatedGet(req, resp);
}
@ -22,9 +22,10 @@ public class AuthenticatedServlet extends HttpServlet {
@Override
protected final void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
super.doPost(req, resp);
session = new Session(req.getSession(true));
if (!session.isAuthenticated()) {
resp.sendRedirect("/mavor/authenticate");
resp.sendRedirect(configuration.getWebRoot() + "/authenticate");
} else {
doAuthenticatedPost(req, resp);
}

View File

@ -0,0 +1,31 @@
package de.devloop.mavor;
import java.io.IOException;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
public class BaseServlet extends HttpServlet {
protected Configuration configuration;
@Override
public void init() throws ServletException {
try {
configuration = new Configuration();
} catch (IOException e) {
throw new ServletException("Configuration Error", e);
}
}
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
req.setAttribute("WEB_ROOT", configuration.getWebRoot());
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
req.setAttribute("WEB_ROOT", configuration.getWebRoot());
}
}

View File

@ -9,6 +9,8 @@ public class Configuration {
private static final String DEVELOPMENT_PROPERTIES = "development.properties";
private static final String ENV_WEB_ROOT = "MAVOR_WEB_ROOT";
private static final String ENV_MAVEN_EXECUTABLE = "MAVOR_MAVEN_EXECUTABLE";
private static final String ENV_TEMP_DIR = "MAVOR_TEMP_DIR";
@ -20,6 +22,7 @@ public class Configuration {
private static final String ENV_OPENID_USERINFO_URL = "MAVOR_OPENID_USERINFO_URL";
private static final String ENV_OPENID_LOGOUT_URL = "MAVOR_OPENID_LOGOUT_URL";
private String webRoot;
private String mavenExecutable;
private String tempDir;
private String openIdClientId;
@ -43,6 +46,7 @@ public class Configuration {
}
private void initByProperties(Properties properties) {
webRoot = getNullSafeProperty(properties, ENV_WEB_ROOT);
mavenExecutable = getNullSafeProperty(properties, ENV_MAVEN_EXECUTABLE);
tempDir = getNullSafeProperty(properties, ENV_TEMP_DIR);
openIdClientId = getNullSafeProperty(properties, ENV_OPENID_CLIENT_ID);
@ -58,6 +62,10 @@ public class Configuration {
return Objects.requireNonNull(properties.getProperty(key));
}
public String getWebRoot() {
return webRoot;
}
public String getMavenExecutable() {
return mavenExecutable;
}

View File

@ -2,7 +2,7 @@ package de.devloop.mavor.servlet;
import java.io.IOException;
import de.devloop.mavor.Configuration;
import de.devloop.mavor.BaseServlet;
import de.devloop.mavor.Session;
import de.devloop.openid.AuthenticationUrl;
import de.devloop.openid.OpenID;
@ -12,12 +12,11 @@ import de.devloop.openid.Token;
import de.devloop.openid.UserInfo;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
@WebServlet("/authenticate")
public class Authentication extends HttpServlet {
public class Authentication extends BaseServlet {
private static final String PARAMETER_STATE = "state";
private static final String PARAMETER_CODE = "code";
@ -27,12 +26,7 @@ public class Authentication extends HttpServlet {
@Override
public void init() throws ServletException {
Configuration configuration;
try {
configuration = new Configuration();
} catch (IOException e) {
throw new ServletException("Configuration Error", e);
}
super.init();
openIdConfiguration = new OpenIdConfiguration();
openIdConfiguration.setAuthUrl(configuration.getOpenIdAuthUrl());
@ -63,7 +57,7 @@ public class Authentication extends HttpServlet {
session.setOAuthToken(token.getAccessToken());
session.setUsername(userInfo.getEmail());
resp.sendRedirect("/mavor/");
resp.sendRedirect(configuration.getWebRoot());
} else {
throw new ServletException("OpenID state mismatch!");
}

View File

@ -18,7 +18,6 @@ import java.util.zip.ZipOutputStream;
import de.devloop.mavor.Artifact;
import de.devloop.mavor.AuthenticatedServlet;
import de.devloop.mavor.Configuration;
import jakarta.servlet.RequestDispatcher;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
@ -35,17 +34,6 @@ public class DownloadJars extends AuthenticatedServlet {
private static final String PARAMETER_POM = "pom";
private static final String PARAMETER_TYPE = "type";
private Configuration configuration;
@Override
public void init() throws ServletException {
try {
configuration = new Configuration();
} catch (IOException e) {
throw new ServletException("Configuration Error", e);
}
}
@Override
protected void doAuthenticatedPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doAuthenticatedGet(req, resp);

View File

@ -5,7 +5,6 @@ import java.io.FileInputStream;
import java.io.IOException;
import de.devloop.mavor.AuthenticatedServlet;
import de.devloop.mavor.Configuration;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
@ -16,17 +15,6 @@ public class DownloadZip extends AuthenticatedServlet {
private static final String PARAMETER_FILENAME = "file";
private Configuration configuration;
@Override
public void init() throws ServletException {
try {
configuration = new Configuration();
} catch (IOException e) {
throw new ServletException("Configuration Error", e);
}
}
@Override
protected void doAuthenticatedGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
File tempDir = new File(configuration.getTempDir());
@ -46,7 +34,7 @@ public class DownloadZip extends AuthenticatedServlet {
throw new ServletException("-.-");
}
} else {
Main.redirectToMe(resp);
resp.sendRedirect(configuration.getWebRoot());
}
}
}

View File

@ -3,7 +3,6 @@ package de.devloop.mavor.servlet;
import java.io.IOException;
import de.devloop.mavor.AuthenticatedServlet;
import de.devloop.mavor.Configuration;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
@ -12,16 +11,6 @@ import jakarta.servlet.http.HttpSession;
@WebServlet("/logout")
public class Logout extends AuthenticatedServlet {
private Configuration configuration;
@Override
public void init() throws ServletException {
try {
configuration = new Configuration();
} catch (IOException e) {
throw new ServletException("Configuration Error", e);
}
}
@Override
protected void doAuthenticatedGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

View File

@ -19,8 +19,4 @@ public class Main extends AuthenticatedServlet {
view.forward(req, resp);
}
public static void redirectToMe(HttpServletResponse resp) throws IOException {
resp.sendRedirect("/mavor");
}
}

View File

@ -2,8 +2,8 @@
<%@ page isELIgnored="false" %>
<html>
<body style="background-color:black; color:white">
Download dependencies (Link only works once!): <a href="/mavor/download/zip?file=${zipFilename}">${zipFilename}</a><br/>
<a href="/mavor/logout">logout</a> | <a href="/mavor">back</a><br/>
Download dependencies (Link only works once!): <a href="${WEB_ROOT}/download/zip?file=${zipFilename}">${zipFilename}</a><br/>
<a href="${WEB_ROOT}/logout">logout</a> | <a href="${WEB_ROOT}">back</a><br/>
Maven Output:<br/>
<pre>${stdout}</pre>
</body>

View File

@ -3,7 +3,7 @@
<html>
<body style="background-color:black; color:white">
<h2>Hello ${username}</h2>
<form method="get" action="/mavor/download/jars">
<form method="get" action="${WEB_ROOT}/download/jars">
<input type="hidden" name="type" value="artifact"/>
Repository: <input type="text" name="repository" value="https://source.devloop.de/api/packages/damage/maven/" /><br/>
Group ID: <input type="text" name="groupId" value="org.apache.activemq"/><br/>
@ -11,11 +11,11 @@
Version: <input type="text" name="version" value="2.39.0"/><br/>
<input type="submit"/>
</form>
<form method="post" action="/mavor/download/jars">
<form method="post" action="${WEB_ROOT}/download/jars">
<input type="hidden" name="type" value="pom"/>
POM: <textarea name="pom" cols="80" rows="20"></textarea><br/>
<input type="submit"/>
</form>
<a href="/mavor/logout">logout</a>
<a href="${WEB_ROOT}/logout">logout</a>
</body>
</html>