fixes

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java

@@ -20,7 +20,6 @@
 import java.util.List;
 
 import org.apache.cloudstack.api.APICommand;
-import org.apache.cloudstack.api.ApiArgValidator;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseListCmd;

client/conf/server.properties.in

@@ -67,3 +67,10 @@ extensions.deployment.mode=@EXTENSIONSDEPLOYMENTMODE@
 # `downloadrepository` key value from the metadata file in template URLs. If not specified, the original template URL
 # will be used for download.
 # system.vm.templates.download.repository=http://download.cloudstack.org/systemvm/
+
+# WebSocket server enable/disable flag used by the management server
+websocket.enable=true
+
+# WebSocket server port used by the management server
+# If not set, defaults to 8822. It can be set to same value as http.port or https.port if needed.
+websocket.port=8822

client/src/main/java/org/apache/cloudstack/websocket/JettyWebSocketServlet.java

@@ -21,7 +21,6 @@
 import java.util.Map;
 
 import javax.servlet.ServletException;
-import javax.servlet.UnavailableException;
 
 import org.apache.cloudstack.framework.websocket.server.common.WebSocketHandler;
 import org.apache.cloudstack.framework.websocket.server.common.WebSocketRouter;
@@ -31,6 +30,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.eclipse.jetty.websocket.api.Session;
+import org.eclipse.jetty.websocket.api.UpgradeRequest;
 import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
 import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
 import org.eclipse.jetty.websocket.servlet.WebSocketCreator;
@@ -63,16 +63,13 @@ public void init() throws ServletException {
         LOGGER.info("Initializing JettyWebSocketServlet");
         if (!isWebSocketServletEnabled()) {
             enabled = false;
-            String msg = "WebSocket Server is not enabled, embedded WebSocket Server will not be running";
-            LOGGER.info(msg);
-            throw new UnavailableException(msg);
+            LOGGER.info("WebSocket Server is not enabled, embedded WebSocket Server will not be running");
         }
         Integer port = getWebSocketServletPort();
         if (port == null) {
             enabled = false;
-            String msg = "WebSocket Server port is configured, embedded WebSocket Server will not be running";
-            LOGGER.info(msg);
-            throw new UnavailableException(msg);
+            LOGGER.info("WebSocket Server port is configured, embedded WebSocket Server will not be running");
+            return;
         }
         enabled = true;
         LOGGER.info("Embedded WebSocket Server initialized at {}/* with port: {}",
@@ -155,24 +152,31 @@ private Map<String, String> parse(String q) {
         }
 
         @Override
-        public void onWebSocketConnect(Session jettySess) {
-            super.onWebSocketConnect(jettySess);
-            this.session = JettyWebSocketSession.adapt(jettySess, routePath, parse(rawQuery));
+        public void onWebSocketConnect(Session jettySession) {
+            super.onWebSocketConnect(jettySession);
+            this.session = JettyWebSocketSession.adapt(jettySession, routePath, parse(rawQuery));
+            UpgradeRequest request = jettySession.getUpgradeRequest();
+            String remoteAddr = request.getHeader("X-Forwarded-For");
+            if (remoteAddr == null) {
+                remoteAddr = jettySession.getRemoteAddress().getAddress().getHostAddress();
+            }
+            this.session.setAttr(WebSocketSession.ATTR_REMOTE_ADDR, remoteAddr);
             try {
+
                 handler.onOpen(session);
             } catch (Throwable t) {
                 try {
                     handler.onError(session, t);
                 } finally {
-                    jettySess.close();
+                    jettySession.close();
                 }
             }
         }
 
         @Override
         public void onWebSocketText(String message) {
             try {
-                handler.onText(session, message);
+                handler.onTextMessage(session, message);
             } catch (Throwable t) {
                 handler.onError(session, t);
             }
@@ -181,7 +185,7 @@ public void onWebSocketText(String message) {
         @Override
         public void onWebSocketBinary(byte[] payload, int offset, int len) {
             try {
-                handler.onBinary(session, java.nio.ByteBuffer.wrap(payload, offset, len));
+                handler.onBinaryMessage(session, java.nio.ByteBuffer.wrap(payload, offset, len));
             } catch (Throwable t) {
                 handler.onError(session, t);
             }
@@ -203,4 +207,4 @@ public void onWebSocketError(Throwable cause) {
             } finally { /* no-op */ }
         }
     }
-}
+}

engine/schema/src/main/java/com/cloud/upgrade/DatabaseUpgradeChecker.java

@@ -89,10 +89,10 @@
 import com.cloud.upgrade.dao.Upgrade41910to42000;
 import com.cloud.upgrade.dao.Upgrade42000to42010;
 import com.cloud.upgrade.dao.Upgrade42010to42100;
-import com.cloud.upgrade.dao.Upgrade42100to42200;
-import com.cloud.upgrade.dao.Upgrade42200to42210;
 import com.cloud.upgrade.dao.Upgrade420to421;
+import com.cloud.upgrade.dao.Upgrade42100to42200;
 import com.cloud.upgrade.dao.Upgrade421to430;
+import com.cloud.upgrade.dao.Upgrade42200to42210;
 import com.cloud.upgrade.dao.Upgrade42210to42300;
 import com.cloud.upgrade.dao.Upgrade430to440;
 import com.cloud.upgrade.dao.Upgrade431to440;
@@ -132,7 +132,6 @@
 import com.cloud.utils.db.TransactionLegacy;
 import com.cloud.utils.db.TransactionStatus;
 import com.cloud.utils.exception.CloudRuntimeException;
-
 import com.google.common.annotations.VisibleForTesting;
 
 public class DatabaseUpgradeChecker implements SystemIntegrityChecker {

engine/schema/src/main/java/org/apache/cloudstack/util/StringListJsonConverter.java

@@ -29,15 +29,28 @@ public class StringListJsonConverter implements AttributeConverter<List<String>,
 
     private static final ObjectMapper mapper = new ObjectMapper();
 
-    @Override
-    public String convertToDatabaseColumn(List<String> attribute) {
+    public static String getDatabaseColumnTypeValue(List<String> attribute) {
         try {
             return attribute == null ? null : mapper.writeValueAsString(attribute);
         } catch (JsonProcessingException e) {
             throw new IllegalArgumentException("Error converting list to JSON", e);
         }
     }
 
+    public static boolean isValidAttribute(List<String> attribute, int length) {
+        try {
+            String json = getDatabaseColumnTypeValue(attribute);
+            return json != null && json.length() <= length;
+        } catch (IllegalArgumentException e) {
+            return false;
+        }
+    }
+
+    @Override
+    public String convertToDatabaseColumn(List<String> attribute) {
+        return getDatabaseColumnTypeValue(attribute);
+    }
+
     @Override
     public List<String> convertToEntityAttribute(String dbData) {
         try {

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql

@@ -120,21 +120,21 @@ CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.nics','enabled', 'TINYINT(1) NOT NUL
 
 -- Add management_server_details table to allow ManagementServer scope configs
 CREATE TABLE IF NOT EXISTS `cloud`.`management_server_details` (
-                                                                   `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
-                                                                   `management_server_id` bigint unsigned NOT NULL COMMENT 'management server the detail is related to',
-                                                                   `name` varchar(255) NOT NULL COMMENT 'name of the detail',
+    `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id',
+    `management_server_id` bigint unsigned NOT NULL COMMENT 'management server the detail is related to',
+    `name` varchar(255) NOT NULL COMMENT 'name of the detail',
     `value` varchar(255) NOT NULL,
     `display` tinyint(1) NOT NULL DEFAULT '1' COMMENT 'True if the detail can be displayed to the end user',
     PRIMARY KEY (`id`),
     CONSTRAINT `fk_management_server_details__management_server_id` FOREIGN KEY `fk_management_server_details__management_server_id`(`management_server_id`) REFERENCES `mshost`(`id`) ON DELETE CASCADE,
     KEY `i_management_server_details__name__value` (`name`(128),`value`(128))
     ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
--- Create table for logs web session
+-- Create table for Logs Web Session
 CREATE TABLE IF NOT EXISTS `cloud`.`logs_web_session` (
-                                                          `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the session',
+    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the session',
     `uuid` varchar(40) NOT NULL COMMENT 'UUID generated for the session',
-    `filter` varchar(64) DEFAULT NULL COMMENT 'Filter keyword for the session',
+    `filters` varchar(128) DEFAULT NULL COMMENT 'Filter keywords for the session',
     `created` datetime NOT NULL COMMENT 'When the session was created',
     `domain_id` bigint(20) unsigned NOT NULL COMMENT 'Domain of the account who generated the session',
     `account_id` bigint(20) unsigned NOT NULL COMMENT 'Account who generated the session',

framework/websocket-server/pom.xml

@@ -24,7 +24,7 @@
     <parent>
         <groupId>org.apache.cloudstack</groupId>
         <artifactId>cloudstack-framework</artifactId>
-        <version>4.22.0.0-SNAPSHOT</version>
+        <version>4.23.0.0-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
     <dependencies>
@@ -44,4 +44,4 @@
             <version>${cs.netty.version}</version>
         </dependency>
     </dependencies>
-</project>
+</project>

framework/websocket-server/src/main/java/org/apache/cloudstack/framework/websocket/server/NettyWebSocketSession.java

@@ -24,9 +24,13 @@
 
 import org.apache.cloudstack.framework.websocket.server.common.WebSocketSession;
 
+import io.netty.buffer.Unpooled;
 import io.netty.channel.Channel;
+import io.netty.channel.ChannelFutureListener;
 import io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame;
+import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
 import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
+import io.netty.util.AttributeKey;
 
 final class NettyWebSocketSession implements WebSocketSession {
     private final Channel ch;
@@ -61,28 +65,28 @@ public void sendText(String text) {
 
     @Override
     public void sendBinary(ByteBuffer buf) {
-        io.netty.buffer.ByteBuf bb = io.netty.buffer.Unpooled.wrappedBuffer(buf);
+        io.netty.buffer.ByteBuf bb = Unpooled.wrappedBuffer(buf);
         ch.writeAndFlush(new BinaryWebSocketFrame(bb));
     }
 
     @Override
     public void close(int code, String reason) {
-        ch.writeAndFlush(new io.netty.handler.codec.http.websocketx.CloseWebSocketFrame(code, reason))
-                .addListener(io.netty.channel.ChannelFutureListener.CLOSE);
+        ch.writeAndFlush(new CloseWebSocketFrame(code, reason))
+                .addListener(ChannelFutureListener.CLOSE);
     }
 
     @Override
     public <T> void setAttr(String key, T val) {
-        ch.attr(io.netty.util.AttributeKey.valueOf(key)).set(val);
+        ch.attr(AttributeKey.valueOf(key)).set(val);
     }
 
     @SuppressWarnings("unchecked")
     @Override
     public <T> T getAttr(String key) {
-        return (T) ch.attr(io.netty.util.AttributeKey.valueOf(key)).get();
+        return (T) ch.attr(AttributeKey.valueOf(key)).get();
     }
 
     Channel unwrap() {
         return ch;
     }
-}
+}

framework/websocket-server/src/main/java/org/apache/cloudstack/framework/websocket/server/WebSocketServer.java

@@ -124,11 +124,11 @@ protected SslContext createServerSslContextIfNeeded() throws IllegalArgumentExce
             return null;
         }
         String keystoreFile = ServerPropertiesUtil.getProperty(ServerPropertiesUtil.KEY_KEYSTORE_FILE);
-        String keystorePassword = ServerPropertiesUtil.getProperty(ServerPropertiesUtil.KEY_KEYSTORE_FILE);
+        String keystorePassword = ServerPropertiesUtil.getProperty(ServerPropertiesUtil.KEY_KEYSTORE_PASSWORD);
         if (StringUtils.isBlank(keystoreFile) || StringUtils.isBlank(keystorePassword)) {
             throw new IllegalArgumentException("SSL is enabled but keystore file or password is not configured");
         }
-        if (Files.exists(Path.of(keystoreFile))) {
+        if (!Files.exists(Path.of(keystoreFile))) {
             throw new IllegalArgumentException(String.format("SSL is enabled but keystore file does not exist: %s",
                     keystoreFile));
         }

framework/websocket-server/src/main/java/org/apache/cloudstack/framework/websocket/server/WebSocketServerRoutingHandler.java

@@ -62,7 +62,7 @@ public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exc
             final URI uri = URI.create(requestUri);
             final String rawQuery = uri.getQuery();
             String path = uri.getPath();
-            LOGGER.debug("WebSocket connection for path: {}, query: {}", path, rawQuery);
+            LOGGER.trace("WebSocket connection for path: {}, query: {}", path, rawQuery);
 
             path = WebSocketRouter.stripWebSocketPathPrefix(uri.getPath());
 
@@ -80,7 +80,7 @@ public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exc
             }
 
             session = new NettyWebSocketSession(ctx.channel(), path, QueryUtils.parse(rawQuery));
-            session.setAttr("remoteAddress", String.valueOf(ctx.channel().remoteAddress()));
+            session.setAttr(WebSocketSession.ATTR_REMOTE_ADDR, String.valueOf(ctx.channel().remoteAddress()));
 
             try {
                 handler.onOpen(session);
@@ -104,10 +104,10 @@ protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame) {
         }
         try {
             if (frame instanceof TextWebSocketFrame) {
-                handler.onText(session, ((TextWebSocketFrame) frame).text());
+                handler.onTextMessage(session, ((TextWebSocketFrame) frame).text());
             } else if (frame instanceof BinaryWebSocketFrame) {
                 ByteBuffer buf = frame.content().nioBuffer();
-                handler.onBinary(session, buf);
+                handler.onBinaryMessage(session, buf);
             } else if (frame instanceof CloseWebSocketFrame) {
                 CloseWebSocketFrame c = (CloseWebSocketFrame) frame.retain();
                 handler.onClose(session, c.statusCode(), c.reasonText());