Release 0.9.1 (Fix errors of MQTT module if server is not specified); Add tray icon

Author: maksimkurb

iopc-server/build.gradle

@@ -12,7 +12,7 @@ plugins {
 apply plugin: 'io.spring.dependency-management'
 
 group = 'ru.cubly.iopc'
-version = '0.9.0'
+version = '0.9.1'
 
 processResources {
     filesMatching('application.properties') {
@@ -29,26 +29,36 @@ setupBuilder {
     application = "IoPC Agent"
     appIdentifier = "iopc-agent"
     licenseFile = '../LICENSE.txt'
-    icons = ['src/main/resources/icon/icon16.png',
-             'src/main/resources/icon/icon32.png',
-             'src/main/resources/icon/icon48.png',
-             'src/main/resources/icon/icon64.png',
-             'src/main/resources/icon/icon128.png'
+    icons = [
+            "src/main/resources/static/icon/icon16.png",
+            "src/main/resources/static/icon/icon24.png",
+            "src/main/resources/static/icon/icon32.png",
+            "src/main/resources/static/icon/icon48.png",
+            "src/main/resources/static/icon/icon64.png",
+            "src/main/resources/static/icon/icon128.png",
+            "src/main/resources/static/icon/icon256.png",
+            "src/main/resources/static/icon/icon512.png"
     ]
     failOnEmptyFrom = true
     from bootJar.outputs
     mainClass = "org.springframework.boot.loader.JarLauncher"
     mainJar = "iopc-server-${version}.jar"
 
-    bundleJre = new File( System.getProperty('java.home') )
+    bundleJre = new File(System.getProperty('java.home'))
     bundleJreTarget = "javaruntime"
 
-    service {
+    desktopStarter {
+
         displayName = "IoPC Agent"
         description = "Internet of PC (IoPC) Agent helps you to integrate PC into your smart home system"
-        executable = "iopc-server.exe"
+
+        // an alternative executable. Overrides the mainJar and mainClass
+        // either relative to installation root or absolute
+        executable = "iopc-agent.exe"
+
+        // The working directory of the service, relative to installation root
         workDir = "."
-        startOnBoot = true
+
     }
 }
 
@@ -57,12 +67,17 @@ msi {
     installScope = "perMachine"
 
     launch4j {
-        displayName   = "Internet of PC agent (IoPC)"
-        description   = "IoPC helps you to integrate PC into your smart home system"
+        displayName = "Internet of PC agent (IoPC)"
+        description = "IoPC helps you to integrate PC into your smart home system"
 
-        executable = "iopc-server.exe"
+        executable = "iopc-agent.exe"
+        // requestedExecutionLevel = "asInvoker"
     }
 
+    minOS = 6.1
+
+    // wxsTemplate = 'installer/template.wsx'
+
     bannerBmp = 'installer/TopBanner.bmp'
     dialogBmp = 'installer/DialogBanner.bmp'
 }
@@ -88,6 +103,8 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springframework.integration:spring-integration-mqtt:5.4.4'
     implementation 'org.springframework.integration:spring-integration-websocket:5.4.4'
+
+    implementation 'org.springframework.cloud:spring-cloud-starter'
     implementation 'org.springframework.cloud:spring-cloud-starter-config'
 
     implementation 'org.jmdns:jmdns:3.5.1'

iopc-server/installer/template.wsx

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+    <Product>
+
+        <Directory Id="TARGETDIR" Name="SourceDir">
+            <!-- Auto-start via Registry -->
+            <Component Id="IoPCAgentAutostart" Guid="ca29d30d-c217-4050-84fa-a4864c5d75eb">
+                <RegistryValue Id="IoPC.rst" Root="HKCU" Action="write"
+                               Key="Software\Microsoft\Windows\CurrentVersion\Run"
+                               Name="IoPC Agent"
+                               Value="[INSTALLDIR]iopc-agent.exe"
+                               Type="string"/>
+            </Component>
+        </Directory>
+
+        <Feature Id="MainApplication">
+            <ComponentRef Id="IoPCAgentAutostart"/>
+        </Feature>
+    </Product>
+</Wix>

iopc-server/src/main/java/ru/cubly/iopc/IoPCApplication.java

@@ -20,12 +20,10 @@
 @SpringBootApplication
 @ConfigurationPropertiesScan("ru.cubly.iopc")
 public class IoPCApplication {
-    static {
-        System.setProperty("java.awt.headless", "false");
-    }
 
     public static void main(String[] args) {
         new SpringApplicationBuilder(IoPCApplication.class)
+                .headless(false)
                 .run(args);
     }
 

iopc-server/src/main/java/ru/cubly/iopc/config/FlowConfig.java

@@ -10,7 +10,7 @@
 @Configuration
 public class FlowConfig {
     @Bean
-    public IntegrationFlow loggingFlow() {
+    public IntegrationFlow routerLoggingFlow() {
         return IntegrationFlows.from("defaultRouterChannel")
                 .log(LoggingHandler.Level.WARN, "ROUTER_LOGGER",
                         m -> "Route not found for message: service="

iopc-server/src/main/java/ru/cubly/iopc/module/mqtt/MqttConfig.java

@@ -2,6 +2,8 @@
 
 import lombok.extern.log4j.Log4j2;
 import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.integration.channel.DirectChannel;
@@ -17,6 +19,8 @@
 import java.nio.charset.StandardCharsets;
 
 @Configuration
+@ConditionalOnProperty("mqtt.server-uri")
+@ConditionalOnExpression("'${mqtt.server-uri}'!=null && '${mqtt.server-uri}'!=''")
 @Log4j2
 public class MqttConfig {
     public static final int STATE_QOS = 1;

iopc-server/src/main/java/ru/cubly/iopc/module/mqtt/MqttModule.java

@@ -1,6 +1,9 @@
 package ru.cubly.iopc.module.mqtt;
 
 import lombok.extern.log4j.Log4j2;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.context.annotation.Bean;
 import org.springframework.integration.annotation.MessagingGateway;
@@ -58,6 +61,7 @@ public Class<? extends IntentPayload> getPayloadType(String action) {
     }
 
     @Bean
+    @ConditionalOnBean(MqttConfig.class)
     public IntegrationFlow mqttInbound(MessageProducerSupport mqttMessageDrivenChannelAdapter) {
         return FlowUtils.moduleRouterFlow(
                 mqttMessageDrivenChannelAdapter,
@@ -73,6 +77,7 @@ public interface MqttMessagingTemplate {
     }
 
     @Bean
+    @ConditionalOnBean(MqttConfig.class)
     public IntegrationFlow mqttOutbound(MessageHandler mqttOutboundMessageHandler) {
         return FlowUtils.forService(this, ACTION_SEND)
                 .enrichHeaders(h -> h.headerExpression(MqttHeaders.TOPIC,
@@ -85,9 +90,12 @@ public IntegrationFlow mqttOutbound(MessageHandler mqttOutboundMessageHandler) {
                 .get();
     }
 
-    @Scheduled(fixedRate = 30000, initialDelay = 1000)
-    public void sendScheduledReport() {
-        mqttMessagingTemplate.send(new MqttPayload(STATE_TOPIC, STATE_ONLINE, STATE_QOS, true));
+    @Bean
+    @ConditionalOnMissingBean(MqttConfig.class)
+    public IntegrationFlow mqttOutboundBlackHole() {
+        return FlowUtils.forService(this, ACTION_SEND)
+                .handle((o, h) -> null)
+                .get();
     }
 
     @Override

iopc-server/src/main/java/ru/cubly/iopc/module/mqtt/MqttOnlineActuator.java

@@ -0,0 +1,22 @@
+package ru.cubly.iopc.module.mqtt;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+import static ru.cubly.iopc.module.mqtt.MqttConfig.STATE_ONLINE;
+import static ru.cubly.iopc.module.mqtt.MqttConfig.STATE_QOS;
+import static ru.cubly.iopc.module.mqtt.MqttUtil.STATE_TOPIC;
+
+@Component
+@ConditionalOnBean(MqttConfig.class)
+@RequiredArgsConstructor
+public class MqttOnlineActuator {
+    private final MqttModule.MqttMessagingTemplate mqttMessagingTemplate;
+
+    @Scheduled(fixedRate = 30000, initialDelay = 1000)
+    public void sendScheduledReport() {
+        mqttMessagingTemplate.send(new MqttPayload(STATE_TOPIC, STATE_ONLINE, STATE_QOS, true));
+    }
+}

iopc-server/src/main/java/ru/cubly/iopc/util/IoPCTrayIcon.java

@@ -0,0 +1,114 @@
+package ru.cubly.iopc.util;
+
+import lombok.extern.log4j.Log4j2;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.SpringApplication;
+import org.springframework.cloud.context.restart.RestartEndpoint;
+import org.springframework.context.ApplicationContext;
+import org.springframework.stereotype.Component;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.swing.*;
+import java.awt.*;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+
+@Component
+@Log4j2
+public class IoPCTrayIcon extends TrayIcon {
+
+    private static final String IMAGE_PATH = "/static/icon/icon16.png";
+    private static final String TOOLTIP = "IoPC Agent";
+
+    private final PopupMenu popup;
+    private final SystemTray tray;
+
+    private final String version;
+    private final Integer port;
+    private final RestartEndpoint restartEndpoint;
+    private final ApplicationContext appContext;
+
+    public IoPCTrayIcon(
+            @Value("${app.build-info.version}") String version,
+            @Value("${server.port}") Integer port,
+            RestartEndpoint restartEndpoint, ApplicationContext appContext) {
+        super(createImage(IMAGE_PATH, TOOLTIP), TOOLTIP);
+
+        this.version = version;
+        this.port = port;
+        this.restartEndpoint = restartEndpoint;
+        this.appContext = appContext;
+
+        popup = new PopupMenu();
+        tray = SystemTray.getSystemTray();
+    }
+
+    @PostConstruct
+    private void setup() throws AWTException {
+        if (!SystemTray.isSupported()) {
+            log.warn("Tray is not supported in this environment");
+            return;
+        }
+
+        MenuItem aboutItem = new MenuItem("IoPC v" + version + " is running");
+        aboutItem.setEnabled(false);
+
+        MenuItem configuratorItem = new MenuItem("Preferences");
+        MenuItem restartItem = new MenuItem("Restart");
+        MenuItem exitItem = new MenuItem("Exit");
+
+        configuratorItem.addActionListener(e -> {
+            if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.BROWSE)) {
+                try {
+                    Desktop.getDesktop().browse(new URI("http://127.0.0.1:" + port));
+                } catch (IOException | URISyntaxException exception) {
+                    log.error("Could not open browser", exception);
+                }
+            } else {
+                log.error("Could not open browser, this feature is not supported in this environment");
+            }
+        });
+        restartItem.addActionListener(e -> {
+            restartEndpoint.restart();
+            configuratorItem.setEnabled(false);
+            restartItem.setEnabled(false);
+            restartItem.setLabel("Restarting...");
+            exitItem.setEnabled(false);
+        });
+        exitItem.addActionListener(e -> {
+            SpringApplication.exit(appContext, () -> 0);
+            configuratorItem.setEnabled(false);
+            restartItem.setEnabled(false);
+            exitItem.setEnabled(false);
+            exitItem.setLabel("Exiting...");
+        });
+
+        popup.add(aboutItem);
+        popup.add(configuratorItem);
+        popup.add(restartItem);
+        popup.add(exitItem);
+
+        // popup.add(itemAbout);
+        // here add the items to your popup menu. These extend MenuItem
+        // popup.addSeparator();
+        setPopupMenu(popup);
+        tray.add(this);
+    }
+
+    @PreDestroy
+    public void destroy() {
+        if (!SystemTray.isSupported()) {
+            return;
+        }
+
+        tray.remove(this);
+    }
+
+    protected static Image createImage(String path, String description) {
+        URL imageURL = IoPCTrayIcon.class.getResource(path);
+        return new ImageIcon(imageURL, description).getImage();
+    }
+}

iopc-server/src/main/resources/application.properties

@@ -5,6 +5,7 @@ spring.web.locale=\${server.language}
 spring.web.locale-resolver=fixed
 
 management.endpoint.restart.enabled=true
+management.endpoints.web.exposure.include=restart,health
 
 app.build-info.version=${version}
 
@@ -16,7 +17,7 @@ logging.level.org.jnativehook=warn
 spring.config.import=optional:file:iopc-overrides.properties
 spring.jackson.serialization.write-dates-as-timestamps=false
 
-mqtt.server-uri=\${IOPC_MQTT_SERVER_URI:tcp://127.0.0.1:1883}
+mqtt.server-uri=\${IOPC_MQTT_SERVER_URI:}
 mqtt.username=\${IOPC_MQTT_USERNAME:mylogin}
 mqtt.password=\${IOPC_MQTT_PASSWORD:mypassword}
 

iopc-server/src/main/resources/static/icon/android-chrome-192x192.png

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/icon/mstile-150x150.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>