| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 1 | package de.ids_mannheim.korap.server; |
| 2 | |
| 3 | import java.io.File; |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 4 | import java.io.FileInputStream; |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 5 | import java.io.FileOutputStream; |
| 6 | import java.io.IOException; |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 7 | import java.io.InputStream; |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 8 | import java.io.OutputStreamWriter; |
| 9 | import java.nio.charset.StandardCharsets; |
| 10 | import java.security.NoSuchAlgorithmException; |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 11 | import java.util.Properties; |
| margaretha | 0ddaed6 | 2021-01-21 17:10:33 +0100 | [diff] [blame] | 12 | import java.util.Scanner; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 13 | |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 14 | import org.apache.logging.log4j.LogManager; |
| 15 | import org.apache.logging.log4j.Logger; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 16 | import org.eclipse.jetty.server.Connector; |
| margaretha | 7920aab | 2021-10-01 15:31:20 +0200 | [diff] [blame] | 17 | import org.eclipse.jetty.server.HttpConnectionFactory; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 18 | import org.eclipse.jetty.server.Server; |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 19 | import org.eclipse.jetty.server.ServerConnector; |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 20 | import org.eclipse.jetty.server.handler.HandlerList; |
| 21 | import org.eclipse.jetty.server.handler.ShutdownHandler; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 22 | import org.eclipse.jetty.servlet.ServletContextHandler; |
| 23 | import org.eclipse.jetty.servlet.ServletHolder; |
| abcpro1 | 87984e3 | 2022-11-07 17:16:25 +0000 | [diff] [blame] | 24 | import org.glassfish.jersey.server.ServerProperties; |
| abcpro1 | d912a2c | 2022-11-07 17:10:50 +0000 | [diff] [blame] | 25 | import org.glassfish.jersey.servlet.ServletContainer; |
| margaretha | eaa8fb6 | 2023-04-24 09:19:46 +0200 | [diff] [blame] | 26 | import org.springframework.web.context.ContextLoaderListener; |
| margaretha | fbf7cfd | 2023-11-27 12:22:39 +0100 | [diff] [blame] | 27 | import org.springframework.web.context.support.XmlWebApplicationContext; |
| margaretha | ade7d4a | 2017-07-20 19:53:35 +0200 | [diff] [blame] | 28 | |
| margaretha | ade7d4a | 2017-07-20 19:53:35 +0200 | [diff] [blame] | 29 | import de.ids_mannheim.korap.config.KustvaktConfiguration; |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 30 | import de.ids_mannheim.korap.encryption.RandomCodeGenerator; |
| 31 | import de.ids_mannheim.korap.exceptions.KustvaktException; |
| margaretha | ade7d4a | 2017-07-20 19:53:35 +0200 | [diff] [blame] | 32 | import lombok.Getter; |
| 33 | import lombok.Setter; |
| 34 | |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 35 | /** |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 36 | * @author hanl, margaretha |
| 37 | * |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 38 | */ |
| Michael Hanl | ada713a | 2016-06-03 17:46:57 +0200 | [diff] [blame] | 39 | public abstract class KustvaktBaseServer { |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 40 | |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 41 | private Logger log = LogManager.getLogger(KustvaktBaseServer.class); |
| 42 | |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 43 | protected static KustvaktConfiguration config; |
| margaretha | af3cb44 | 2023-04-25 09:05:21 +0200 | [diff] [blame] | 44 | protected static String springConfig = "default-config.xml"; |
| margaretha | 7f0a4d4 | 2018-02-20 19:16:44 +0100 | [diff] [blame] | 45 | |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 46 | protected static String rootPackages; |
| margaretha | ade7d4a | 2017-07-20 19:53:35 +0200 | [diff] [blame] | 47 | protected static KustvaktArgs kargs; |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 48 | |
| margaretha | 74a1f9e | 2019-04-25 16:11:49 +0200 | [diff] [blame] | 49 | public KustvaktBaseServer () { |
| margaretha | fbf7cfd | 2023-11-27 12:22:39 +0100 | [diff] [blame] | 50 | rootPackages = "de.ids_mannheim.korap.core.web;" |
| 51 | + "de.ids_mannheim.korap.web;" |
| 52 | // + "com.fasterxml.jackson.jaxrs.json;" |
| 53 | ; |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 54 | |
| margaretha | c9d2941 | 2023-04-28 12:40:34 +0200 | [diff] [blame] | 55 | File d = new File(KustvaktConfiguration.DATA_FOLDER); |
| 56 | if (!d.exists()) { |
| 57 | d.mkdir(); |
| 58 | } |
| margaretha | 74a1f9e | 2019-04-25 16:11:49 +0200 | [diff] [blame] | 59 | } |
| Michael Hanl | c0ed00f | 2016-06-23 14:33:10 +0200 | [diff] [blame] | 60 | |
| Michael Hanl | 8abaf9e | 2016-05-23 16:46:35 +0200 | [diff] [blame] | 61 | protected KustvaktArgs readAttributes (String[] args) { |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 62 | KustvaktArgs kargs = new KustvaktArgs(); |
| 63 | for (int i = 0; i < args.length; i++) { |
| 64 | switch ((args[i])) { |
| margaretha | ac3c471 | 2018-03-08 15:55:54 +0100 | [diff] [blame] | 65 | case "--spring-config": |
| 66 | kargs.setSpringConfig(args[i + 1]); |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 67 | break; |
| 68 | case "--port": |
| 69 | kargs.setPort(Integer.valueOf(args[i + 1])); |
| 70 | break; |
| Michael Hanl | f21773f | 2015-10-16 23:02:31 +0200 | [diff] [blame] | 71 | case "--help": |
| 72 | StringBuffer b = new StringBuffer(); |
| 73 | |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 74 | b.append("Parameter description: \n").append( |
| 75 | "--spring-config <Spring XML configuration>\n") |
| margaretha | ac3c471 | 2018-03-08 15:55:54 +0100 | [diff] [blame] | 76 | .append("--port <Server port number>\n") |
| Michael Hanl | f21773f | 2015-10-16 23:02:31 +0200 | [diff] [blame] | 77 | .append("--help : This help menu\n"); |
| 78 | System.out.println(b.toString()); |
| 79 | System.out.println(); |
| Akron | 38eb444 | 2018-02-20 16:48:46 +0100 | [diff] [blame] | 80 | return (KustvaktArgs) null; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 81 | } |
| 82 | } |
| 83 | return kargs; |
| 84 | } |
| 85 | |
| margaretha | d77ee71 | 2024-03-22 12:35:30 +0100 | [diff] [blame] | 86 | protected void loadProperties (String path, String defaultPath) throws IOException { |
| 87 | File f = new File(path); |
| 88 | Properties properties = new Properties(); |
| 89 | |
| 90 | InputStream in = null; |
| 91 | if (!f.exists()) { |
| 92 | log.info("Loading kustvakt configuration from "+defaultPath); |
| 93 | in = KustvaktServer.class.getClassLoader() |
| 94 | .getResourceAsStream(defaultPath); |
| 95 | } |
| 96 | else { |
| 97 | log.info("Loading kustvakt configuration from "+path); |
| 98 | in = new FileInputStream(f); |
| 99 | } |
| 100 | |
| 101 | properties.load(in); |
| 102 | in.close(); |
| 103 | |
| 104 | config = new KustvaktConfiguration(); |
| 105 | config.loadBasicProperties(properties); |
| 106 | } |
| 107 | |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 108 | protected void start () |
| 109 | throws KustvaktException, IOException, NoSuchAlgorithmException { |
| margaretha | 7f0a4d4 | 2018-02-20 19:16:44 +0100 | [diff] [blame] | 110 | |
| 111 | if (kargs.port == -1) { |
| margaretha | ade7d4a | 2017-07-20 19:53:35 +0200 | [diff] [blame] | 112 | kargs.setPort(config.getPort()); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 113 | } |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 114 | |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 115 | String adminToken = ""; |
| margaretha | da1571c | 2024-04-15 13:21:32 +0200 | [diff] [blame^] | 116 | File f = new File("data/adminToken"); |
| margaretha | 3d55b00 | 2019-03-19 12:00:44 +0100 | [diff] [blame] | 117 | if (!f.exists()) { |
| 118 | RandomCodeGenerator random = new RandomCodeGenerator(); |
| 119 | adminToken = random.createRandomCode(config); |
| margaretha | da1571c | 2024-04-15 13:21:32 +0200 | [diff] [blame^] | 120 | FileOutputStream fos = new FileOutputStream(f); |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 121 | OutputStreamWriter writer = new OutputStreamWriter(fos, |
| 122 | StandardCharsets.UTF_8.name()); |
| margaretha | 3d55b00 | 2019-03-19 12:00:44 +0100 | [diff] [blame] | 123 | writer.append("token="); |
| 124 | writer.append(adminToken); |
| 125 | writer.flush(); |
| 126 | writer.close(); |
| 127 | } |
| 128 | else { |
| margaretha | 0ddaed6 | 2021-01-21 17:10:33 +0100 | [diff] [blame] | 129 | Scanner scanner = new Scanner(f); |
| 130 | adminToken = scanner.nextLine().substring(6); |
| 131 | scanner.close(); |
| margaretha | 3d55b00 | 2019-03-19 12:00:44 +0100 | [diff] [blame] | 132 | } |
| 133 | |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 134 | Server server = new Server(); |
| margaretha | 7f0a4d4 | 2018-02-20 19:16:44 +0100 | [diff] [blame] | 135 | |
| margaretha | fbf7cfd | 2023-11-27 12:22:39 +0100 | [diff] [blame] | 136 | String configLocation = "classpath:" + springConfig; |
| 137 | if (kargs.getSpringConfig() != null) { |
| 138 | configLocation = "file:" + kargs.getSpringConfig(); |
| 139 | } |
| 140 | XmlWebApplicationContext context = new XmlWebApplicationContext(); |
| 141 | context.setConfigLocation(configLocation); |
| 142 | |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 143 | ServletContextHandler contextHandler = new ServletContextHandler( |
| 144 | ServletContextHandler.NO_SESSIONS); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 145 | contextHandler.setContextPath("/"); |
| margaretha | fbf7cfd | 2023-11-27 12:22:39 +0100 | [diff] [blame] | 146 | contextHandler.addEventListener(new ContextLoaderListener(context)); |
| margaretha | 3d55b00 | 2019-03-19 12:00:44 +0100 | [diff] [blame] | 147 | contextHandler.setInitParameter("adminToken", adminToken); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 148 | |
| margaretha | fbf7cfd | 2023-11-27 12:22:39 +0100 | [diff] [blame] | 149 | ServletHolder servletHolder = new ServletHolder( |
| 150 | new ServletContainer()); |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 151 | servletHolder.setInitParameter(ServerProperties.PROVIDER_PACKAGES, |
| 152 | rootPackages); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 153 | servletHolder.setInitOrder(1); |
| margaretha | ea68a0a | 2017-09-21 03:09:49 +0200 | [diff] [blame] | 154 | contextHandler.addServlet(servletHolder, config.getBaseURL()); |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 155 | |
| 156 | ServerConnector connector = new ServerConnector(server); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 157 | connector.setPort(kargs.port); |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 158 | connector.setIdleTimeout(60000); |
| margaretha | 7920aab | 2021-10-01 15:31:20 +0200 | [diff] [blame] | 159 | connector.getConnectionFactory(HttpConnectionFactory.class) |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 160 | .getHttpConfiguration().setRequestHeaderSize(64000); |
| margaretha | 7f0a4d4 | 2018-02-20 19:16:44 +0100 | [diff] [blame] | 161 | |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 162 | ShutdownHandler shutdownHandler = new ShutdownHandler(adminToken, true, |
| margaretha | 396e46b | 2023-11-17 21:27:52 +0100 | [diff] [blame] | 163 | false); |
| margaretha | 339fd2e | 2018-11-13 12:14:53 +0100 | [diff] [blame] | 164 | |
| 165 | HandlerList handlers = new HandlerList(); |
| 166 | handlers.addHandler(shutdownHandler); |
| 167 | handlers.addHandler(contextHandler); |
| 168 | |
| 169 | server.setHandler(handlers); |
| margaretha | 7f0a4d4 | 2018-02-20 19:16:44 +0100 | [diff] [blame] | 170 | |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 171 | server.setConnectors(new Connector[] { connector }); |
| 172 | try { |
| 173 | server.start(); |
| 174 | server.join(); |
| 175 | } |
| 176 | catch (Exception e) { |
| 177 | System.out.println("Server could not be started!"); |
| 178 | System.out.println(e.getMessage()); |
| margaretha | 58e1863 | 2018-02-15 13:04:42 +0100 | [diff] [blame] | 179 | e.printStackTrace(); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 180 | System.exit(-1); |
| margaretha | 543f200 | 2017-07-14 00:27:15 +0200 | [diff] [blame] | 181 | } |
| 182 | } |
| margaretha | 35e1ca2 | 2023-11-16 22:00:01 +0100 | [diff] [blame] | 183 | |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 184 | @Setter |
| 185 | public static class KustvaktArgs { |
| 186 | |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 187 | @Getter |
| margaretha | ac3c471 | 2018-03-08 15:55:54 +0100 | [diff] [blame] | 188 | private String springConfig; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 189 | private int port; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 190 | |
| Michael Hanl | 8abaf9e | 2016-05-23 16:46:35 +0200 | [diff] [blame] | 191 | public KustvaktArgs () { |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 192 | this.port = -1; |
| margaretha | ac3c471 | 2018-03-08 15:55:54 +0100 | [diff] [blame] | 193 | this.springConfig = null; |
| Michael Hanl | 72c7b83 | 2015-09-03 08:42:15 +0200 | [diff] [blame] | 194 | } |
| Michael Hanl | c444602 | 2016-02-12 18:03:17 +0100 | [diff] [blame] | 195 | } |
| Akron | 38eb444 | 2018-02-20 16:48:46 +0100 | [diff] [blame] | 196 | } |