373 lines
20 KiB
Java
373 lines
20 KiB
Java
package org.openautonomousconnection.protocol;
|
|
|
|
import dev.unlegitdqrk.unlegitlibrary.addon.AddonLoader;
|
|
import dev.unlegitdqrk.unlegitlibrary.file.FileUtils;
|
|
import dev.unlegitdqrk.unlegitlibrary.network.system.utils.ClientAuthMode;
|
|
import dev.unlegitdqrk.unlegitlibrary.utils.Logger;
|
|
import lombok.Getter;
|
|
import org.openautonomousconnection.protocol.annotations.ProtocolInfo;
|
|
import org.openautonomousconnection.protocol.listeners.ClientListener;
|
|
import org.openautonomousconnection.protocol.listeners.CustomServerListener;
|
|
import org.openautonomousconnection.protocol.packets.OACPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.AuthPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.INSQueryPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.INSResponsePacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.WebRequestPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.WebResponsePacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.stream.WebStreamChunkPacket_v1_0_0_B;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.stream.WebStreamEndPacket_v1_0_0_B;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.stream.WebStreamStartPacket_v1_0_0_B;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentApplyRequestPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentApplyResponsePacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentSnapshotEventPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.navigate.WebNavigateAckPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.navigate.WebNavigateRequestPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.resource.WebResourceRequestPacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.resource.WebResourceResponsePacket;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.stream.WebStreamChunkPacket_v1_0_1_B;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.stream.WebStreamEndPacket_v1_0_1_B;
|
|
import org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.stream.WebStreamStartPacket_v1_0_1_B;
|
|
import org.openautonomousconnection.protocol.side.client.ProtocolClient;
|
|
import org.openautonomousconnection.protocol.side.client.ProtocolWebClient;
|
|
import org.openautonomousconnection.protocol.side.ins.ProtocolINSServer;
|
|
import org.openautonomousconnection.protocol.side.server.ProtocolCustomServer;
|
|
import org.openautonomousconnection.protocol.side.web.ProtocolWebServer;
|
|
import org.openautonomousconnection.protocol.versions.ProtocolVersion;
|
|
import org.openautonomousconnection.protocol.versions.v1_0_0.beta.ProtocolWebServer_1_0_0_B;
|
|
|
|
import java.io.File;
|
|
import java.io.IOException;
|
|
import java.util.function.Supplier;
|
|
|
|
/**
|
|
* The main bridge class for the protocol connection.
|
|
* It manages the protocol settings, version, and side instances.
|
|
*/
|
|
public final class ProtocolBridge {
|
|
/**
|
|
* The protocol settings for the current connection
|
|
*/
|
|
@Getter
|
|
private final ProtocolValues protocolValues;
|
|
|
|
/**
|
|
* The protocol version for the current connection
|
|
*/
|
|
@Getter
|
|
private final ProtocolVersion protocolVersion;
|
|
|
|
/**
|
|
* The logger instance for logging events and errors
|
|
*/
|
|
@Getter
|
|
private Logger logger;
|
|
|
|
/**
|
|
* The protocol side instances
|
|
*/
|
|
@Getter
|
|
private ProtocolClient protocolClient;
|
|
|
|
|
|
/**
|
|
* The protocol side instances
|
|
*/
|
|
@Getter
|
|
private ProtocolCustomServer protocolServer;
|
|
|
|
@Getter
|
|
private AddonLoader addonLoader;
|
|
|
|
/**
|
|
* Initialize the ProtocolBridge instance for the client side
|
|
*
|
|
* @param protocolServer The ProtocolCustomServer instance
|
|
* @param protocolValues The ProtocolSettings instance
|
|
* @param protocolVersion The ProtocolVersion instance
|
|
* @param logger The logger
|
|
* @param addonLoader The Addon loader to load custom extensions
|
|
* @throws Exception if an error occurs while initializing the ProtocolBridge
|
|
*/
|
|
public ProtocolBridge(ProtocolCustomServer protocolServer, ProtocolValues protocolValues, ProtocolVersion protocolVersion,
|
|
Logger logger, AddonLoader addonLoader) throws Exception {
|
|
// Assign the parameters to the class fields
|
|
this.protocolServer = protocolServer;
|
|
this.protocolValues = protocolValues;
|
|
this.protocolVersion = protocolVersion;
|
|
this.logger = logger;
|
|
this.addonLoader = addonLoader;
|
|
|
|
if (protocolServer instanceof ProtocolINSServer)
|
|
protocolServer.attachBridge(this, null, false, ClientAuthMode.NONE);
|
|
else
|
|
protocolServer.attachBridge(this, protocolValues.keyPass, protocolValues.ssl, protocolValues.authMode);
|
|
|
|
initializeProtocolVersion();
|
|
downloadLicenses();
|
|
|
|
// Register the appropriate listeners and packets
|
|
registerListeners();
|
|
registerPackets();
|
|
}
|
|
|
|
/**
|
|
* Initialize the ProtocolBridge instance for the client side
|
|
*
|
|
* @param protocolClient The ProtocolClient instance
|
|
* @param protocolValues The ProtocolSettings instance
|
|
* @param protocolVersion The ProtocolVersion instance
|
|
* @param logger The logger
|
|
* @param addonLoader The Addon loader to load custom extensions
|
|
* @throws Exception if an error occurs while initializing the ProtocolBridge
|
|
*/
|
|
@ProtocolInfo(protocolSide = ProtocolVersion.ProtocolSide.CLIENT)
|
|
public ProtocolBridge(ProtocolClient protocolClient, ProtocolValues protocolValues, ProtocolVersion protocolVersion,
|
|
Logger logger, AddonLoader addonLoader) throws Exception {
|
|
// Assign the parameters to the class fields
|
|
this.protocolClient = protocolClient;
|
|
this.protocolValues = protocolValues;
|
|
this.protocolVersion = protocolVersion;
|
|
this.logger = logger;
|
|
this.addonLoader = addonLoader;
|
|
|
|
protocolClient.attachBridge(this);
|
|
initializeProtocolVersion();
|
|
downloadLicenses();
|
|
|
|
|
|
// Register the appropriate listeners and packets
|
|
registerListeners();
|
|
registerPackets();
|
|
}
|
|
|
|
private void downloadLicenses() throws IOException {
|
|
File licensesFolder = new File("licenses");
|
|
|
|
if (!licensesFolder.exists() || !licensesFolder.isDirectory()) {
|
|
if (licensesFolder.exists()) licensesFolder.delete();
|
|
|
|
File output = new File("licenses.zip");
|
|
output.createNewFile();
|
|
FileUtils.downloadFile("https://open-autonomous-connection.org/assets/licenses.zip", output);
|
|
FileUtils.unzip(output, licensesFolder.getParent());
|
|
output.deleteOnExit();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register the appropriate packets
|
|
*
|
|
* <p>Overview of all Packets
|
|
*
|
|
* <table border="2">
|
|
* <tr><th>ID</th><th>Packet</th><th>ProtocolVersion</th></tr>
|
|
*
|
|
* <tr><td>8</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_0.beta.AuthPacket AuthPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>7</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_0.beta.INSQueryPacket INSQueryPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>6</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_0.beta.INSResponsePacket INSResponsePacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>10</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.WebRequestPacket WebRequestPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>9</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_0.beta.web.WebResponsePacket WebResponsePacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>11</td><td>{@link WebStreamStartPacket_v1_0_0_B v1_0_0.beta.web.stream.WebStreamStartPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>13</td><td>{@link WebStreamChunkPacket_v1_0_0_B v1_0_0.beta.web.stream.WebStreamChunkPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
* <tr><td>12</td><td>{@link WebStreamEndPacket_v1_0_0_B v1_0_0.beta.web.stream.WebStreamEndPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_0_BETA PV_1_0_0_BETA}</td></tr>
|
|
*
|
|
* <tr><td>1</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.navigate.WebNavigateRequestPacket WebNavigateRequestPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>2</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.navigate.WebNavigateAckPacket WebNavigateAckPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>3</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.resource.WebResourceRequestPacket WebResourceRequestPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>4</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.resource.WebResourceResponsePacket WebResourceResponsePacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>14</td><td>{@link WebStreamStartPacket_v1_0_1_B v1_0_1.beta.web.impl.stream.WebStreamStartPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>15</td><td>{@link WebStreamChunkPacket_v1_0_1_B v1_0_1.beta.web.impl.stream.WebStreamChunkPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>16</td><td>{@link WebStreamEndPacket_v1_0_1_B v1_0_1.beta.web.impl.stream.WebStreamEndPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>17</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentSnapshotEventPacket WebDocumentSnapshotEventPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>5</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentApplyResponsePacket WebDocumentApplyResponsePacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* <tr><td>18</td><td>{@link org.openautonomousconnection.protocol.packets.v1_0_1.beta.web.impl.document.WebDocumentApplyRequestPacket WebDocumentApplyRequestPacket}</td><td>{@link org.openautonomousconnection.protocol.versions.ProtocolVersion#PV_1_0_1_BETA PV_1_0_1_BETA}</td></tr>
|
|
* </table>
|
|
*
|
|
* @see org.openautonomousconnection.protocol.versions.ProtocolVersion
|
|
*/
|
|
private void registerPackets() {
|
|
// 1.0.0-BETA packets
|
|
registerPacket(AuthPacket::new);
|
|
registerPacket(INSQueryPacket::new);
|
|
registerPacket(() -> new INSResponsePacket(this));
|
|
registerPacket(WebRequestPacket::new);
|
|
registerPacket(WebResponsePacket::new);
|
|
registerPacket(WebStreamStartPacket_v1_0_0_B::new);
|
|
registerPacket(WebStreamChunkPacket_v1_0_0_B::new);
|
|
registerPacket(WebStreamEndPacket_v1_0_0_B::new);
|
|
|
|
// 1.0.1-BETA Packets
|
|
registerPacket(WebDocumentApplyRequestPacket::new);
|
|
registerPacket(WebDocumentApplyResponsePacket::new);
|
|
registerPacket(WebDocumentSnapshotEventPacket::new);
|
|
registerPacket(WebNavigateRequestPacket::new);
|
|
registerPacket(WebNavigateAckPacket::new);
|
|
registerPacket(WebResourceRequestPacket::new);
|
|
registerPacket(WebResourceResponsePacket::new);
|
|
registerPacket(WebStreamStartPacket_v1_0_1_B::new);
|
|
registerPacket(WebStreamChunkPacket_v1_0_1_B::new);
|
|
registerPacket(WebStreamEndPacket_v1_0_1_B::new);
|
|
}
|
|
|
|
private void registerPacket(Supplier<? extends OACPacket> factory) {
|
|
if (isPacketSupported(factory.get())) protocolValues.packetHandler.registerPacket(factory);
|
|
}
|
|
|
|
/**
|
|
* Register the appropriate listeners based on the current side
|
|
*
|
|
* @throws Exception if an error occurs while registering the listeners
|
|
*/
|
|
private void registerListeners() throws Exception {
|
|
// Client Listeners
|
|
if (isRunningAsClient()) {
|
|
protocolValues.eventManager.registerListener(new ClientListener(protocolClient));
|
|
protocolValues.eventManager.unregisterListener(CustomServerListener.class);
|
|
}
|
|
|
|
// Server Listeners
|
|
if (isRunningAsServer()) {
|
|
protocolValues.eventManager.registerListener(new CustomServerListener(protocolServer));
|
|
protocolValues.eventManager.unregisterListener(ClientListener.class);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initialize the protocol version
|
|
* Validate if the protocol version is valid for the current side
|
|
* If not, log an error and exit the application
|
|
*/
|
|
private void initializeProtocolVersion() {
|
|
// Check if the protocol version is valid for the current side
|
|
// If not, log an error and exit the application
|
|
if (!validateProtocolSide()) {
|
|
this.logger.error("Invalid protocol version '" + protocolVersion.toString() + "'!");
|
|
System.exit(1);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if the classic protocol is supported by the current protocol version
|
|
*
|
|
* @return true if the classic protocol is supported, false otherwise
|
|
*/
|
|
public boolean isClassicSupported() {
|
|
boolean yes = false;
|
|
for (ProtocolVersion compatibleVersion : protocolVersion.getCompatibleVersions()) {
|
|
// Check if the compatible version is classic
|
|
yes = compatibleVersion.getProtocolType() == ProtocolVersion.ProtocolType.CLASSIC;
|
|
if (yes) break;
|
|
}
|
|
|
|
// Check if the current protocol version is classic or if it is supported by any of the compatible versions
|
|
return protocolVersion.getProtocolType() == ProtocolVersion.ProtocolType.CLASSIC || yes;
|
|
}
|
|
|
|
/**
|
|
* Check if the target protocol is supported by the current protocol version
|
|
*
|
|
* @param protocol The target protocol to check
|
|
* @return true If the target protocol is supported, false otherwise
|
|
*/
|
|
public boolean isProtocolSupported(ProtocolVersion.Protocol protocol) {
|
|
boolean yes = false;
|
|
|
|
for (ProtocolVersion compatibleVersion : protocolVersion.getCompatibleVersions()) {
|
|
// Check if the compatible version supports the target protocol
|
|
yes = compatibleVersion.getSupportedProtocols().contains(protocol);
|
|
if (yes) break;
|
|
}
|
|
|
|
// Check if the current protocol version supports the target protocol or if it is supported by any of the compatible versions
|
|
return protocolVersion.getSupportedProtocols().contains(protocol) || yes;
|
|
}
|
|
|
|
/**
|
|
* Check if the target packet is supported by the current protocol version
|
|
*
|
|
* @param packet The target packet to check
|
|
* @return true if the target packet is supported, false otherwise
|
|
*/
|
|
public boolean isPacketSupported(OACPacket packet) {
|
|
boolean compatible = false;
|
|
|
|
for (ProtocolVersion compatibleVersion : packet.getCompatibleVersions()) {
|
|
if (!compatible) compatible = isVersionSupported(compatibleVersion);
|
|
}
|
|
|
|
return compatible;
|
|
}
|
|
|
|
/**
|
|
* Check if the target protocol version is supported by the current protocol version
|
|
*
|
|
* @param targetVersion The target protocol version to check
|
|
* @return true if the target protocol version is supported, false otherwise
|
|
*/
|
|
public boolean isVersionSupported(ProtocolVersion targetVersion) {
|
|
// Check if the target protocol version is the same as the current protocol version or if it is in the list of compatible versions
|
|
return protocolVersion == targetVersion || protocolVersion.getCompatibleVersions().contains(targetVersion);
|
|
}
|
|
|
|
/**
|
|
* Validate if the protocol version is valid for the current side
|
|
*
|
|
* @return true if the protocol version is valid for the current side, false otherwise
|
|
*/
|
|
private boolean validateProtocolSide() {
|
|
return
|
|
(isRunningAsClient() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.CLIENT) ||
|
|
(isRunningAsClient() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.CLIENT_WEB) ||
|
|
(isRunningAsClient() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.CLIENT_INS) ||
|
|
(isRunningAsClient() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.ALL) ||
|
|
|
|
(isRunningAsWebServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.WEB) ||
|
|
(isRunningAsWebServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.CLIENT_WEB) ||
|
|
(isRunningAsWebServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.WEB_INS) ||
|
|
(isRunningAsWebServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.ALL) ||
|
|
|
|
(isRunningAsServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.ALL) ||
|
|
|
|
(isRunningAsINSServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.INS) ||
|
|
(isRunningAsINSServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.WEB_INS) ||
|
|
(isRunningAsINSServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.CLIENT_INS) ||
|
|
(isRunningAsINSServer() && protocolVersion.getProtocolSide() == ProtocolVersion.ProtocolSide.ALL);
|
|
}
|
|
|
|
/**
|
|
* Check if the current instance is running as a INS server
|
|
*
|
|
* @return true if the current instance is running as a INS server, false otherwise
|
|
*/
|
|
public boolean isRunningAsINSServer() {
|
|
return isRunningAsServer() && protocolServer instanceof ProtocolINSServer;
|
|
}
|
|
|
|
/**
|
|
* Check if the current instance is running as a client
|
|
*
|
|
* @return true if the current instance is running as a client, false otherwise
|
|
*/
|
|
public boolean isRunningAsClient() {
|
|
return protocolClient != null;
|
|
}
|
|
|
|
/**
|
|
* Check if the current instance is running as a web server
|
|
*
|
|
* @return true if the current instance is running as a web server, false otherwise
|
|
*/
|
|
public boolean isRunningAsWebServer() {
|
|
return isRunningAsServer() && protocolServer instanceof ProtocolWebServer;
|
|
}
|
|
|
|
/**
|
|
* Check if the current instance is running as a custom server
|
|
*
|
|
* @return true if the current instance is running as a custom server, false otherwise
|
|
*/
|
|
public boolean isRunningAsServer() {
|
|
return protocolServer != null;
|
|
}
|
|
}
|