namespace for IPRefresher instead of class

error messages in gui.

CMakeLists.txt

@@ -19,6 +19,7 @@ SET(LIB_METHOD STATIC) #SHARED / STATIC
 option(BUILD_DOC "Build documentation" ON) # additional dependency for Doxygen
 option(PACKAGING "Allow Packaging to <exe>, <deb> or <rpm>" ON) # additional dependencies for RPMbuild,dpkg  or NSIS
 option(TESTS "Build Tests" ON) # additional dependencies for GTEST - to build tests
+option(GUI "Build GUI elements" ON) # additional dependencies to QT libraries needed
 set(WinBuild false)
 
 # helper variables
@@ -98,6 +99,10 @@ if (${WinBuild})
     message(STATUS "Using LIBCONFIG++ lib(s): ${LIBCONFIG++_LIBRARIES}")
 
     include_directories(${LIBCONFIG++_INCLUDE_DIRS} inc)
+
+    if (${GUI})
+        set(CMAKE_PREFIX_PATH "/usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib/cmake")
+    endif ()
 else ()
     find_package(CURL REQUIRED)
     if (CURL_INCLUDE_DIRS AND CURL_LIBRARIES)
@@ -129,6 +134,15 @@ else ()
     include_directories(${LIBCONFIG_INCLUDE_DIRS})
 endif ()
 
+if (${GUI})
+    set(CMAKE_AUTOMOC ON)
+    set(CMAKE_INCLUDE_CURRENT_DIR ON)
+
+    find_package(Qt5Widgets REQUIRED)
+    find_package(Qt5PrintSupport REQUIRED)
+    find_package(Qt5Sql REQUIRED)
+endif ()
+
 message("")
 
 #read sample config
@@ -173,6 +187,28 @@ add_executable(iprefresher src/main.cpp)
 # LINK generated LIBS #
 target_link_libraries(iprefresher dynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
 
+if (${GUI})
+    set(QT5_LIBRARIES Qt5::Widgets Qt5::PrintSupport Qt5::Sql)
+
+    set(UI_SOURCES
+            src/gui/mainwindow.ui
+            )
+
+    #
+    # Generate necessary headers from .ui files. (qmake lets `uic` do this job.)
+    # hint from [Cross-platform Qt5 project using cmake](http://stackoverflow.com/questions/21174586/cross-platform-qt5-project-using-cmake)
+    #
+    qt5_wrap_ui(UI_GENERATED_HEADERS ${UI_SOURCES})
+
+    add_executable(iprefresher-gui
+            src/maingui.cpp
+            src/gui/MainWindow.cpp
+            src/gui/MainWindow.h ${UI_GENERATED_HEADERS})
+
+    # LINK generated LIBS #
+    target_link_libraries(iprefresher-gui -lpthread dynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES} ${QT5_LIBRARIES})
+endif ()
+
 # setting install targets
 IF (NOT ${WinBuild})
     # INSTALL to Linux SYSTEM #

inc/IPRefresher.h

@@ -9,22 +9,25 @@
 
 #pragma once
 
-class IPRefresher {
+namespace IPRefresher {
-public:
+    /**
+     * Status return-codes for startUpService
+     */
+    namespace Status_Code {
+        const int SUCCESS = 1;
+        const int ERROR = -1;
+        const int ERROR_NO_INTERNET = -2;
+        const int NOREFRESH = 0;
+    }
+
     /**
      * refresh ip address on Dynu server
      */
-    void checkIPAdress(bool force);
+    bool checkIPAdress(bool force);
-
-    /**
-     * default constructor
-     */
-    IPRefresher() = default;
 
     /**
      * start the service in loop mode
      * every 5 minutes the ip is checked an refreshed (needed for .service)
-     * @param loop true->loopmode on
      */
-    explicit IPRefresher(bool loop);
+    void startUpService(int interval = 300);
-};
+}

src/IPRefresher.cpp

@@ -11,7 +11,9 @@
 #include <thread>
 #include <Logger.h>
 
-void IPRefresher::checkIPAdress(bool force) {
+using namespace IPRefresher;
+
+bool IPRefresher::checkIPAdress(bool force) {
     FileLogger logger;
 
     IPAPI ipapi;
@@ -20,14 +22,17 @@ void IPRefresher::checkIPAdress(bool force) {
     if (ip.empty()) {
         //no internet connection (or other error)
         Logger::warning("no internet connection");
+        return Status_Code::ERROR_NO_INTERNET;
     } else if (!IpHelper::isIpValid(ip)) {
         // error when ip doesn't contain a :
         Logger::warning("an error occured when getting the global ip");
+        return Status_Code::ERROR;
     } else {
         std::string oldip = logger.readip();
 
         if (oldip == ip && !force) {
             Logger::message("no change -- ip: " + ip);
+            return Status_Code::NOREFRESH;
         } else {
             Logger::message("ip changed! -- from :" + oldip + "to: " + ip);
 
@@ -43,25 +48,26 @@ void IPRefresher::checkIPAdress(bool force) {
             } else if (!result) {
                 //error
                 Logger::error("failed to write ip to dynu api!");
+                return Status_Code::ERROR;
             }
 
             logger.safeip(ip);
+            return result ? Status_Code::SUCCESS : Status_Code::ERROR;
         }
     }
 }
 
-IPRefresher::IPRefresher(bool loop) {
+void IPRefresher::startUpService(int interval) {
-    if (loop) {
+    Logger::message("startup of service");
-        Logger::message("startup of service");
+    Logger::message("Version: " + Version::VERSION);
-        Logger::message("Version: " + Version::VERSION);
+    if (Config::readConfig()) {
-        if (Config::readConfig()) {
+        while (true) {
-            while (true) {
+            Logger::message("starting check");
-                Logger::message("starting check");
+            checkIPAdress(false);
-                checkIPAdress(false);
+            std::this_thread::sleep_for(std::chrono::milliseconds(interval * 1000));
-                std::this_thread::sleep_for(std::chrono::milliseconds(300000));
-            }
-        } else {
-            std::cout << "incorrect credentials!" << std::endl;
         }
+    } else {
+        std::cout << "incorrect credentials!" << std::endl;
     }
+
 }

src/gui/MainWindow.cpp

@@ -0,0 +1,84 @@
+#include "MainWindow.h"
+#include "ui_mainwindow.h"
+
+#include "api/IPAPI.h"
+#include "IPRefresher.h"
+#include "Config.h"
+#include "Logger.h"
+
+#include <thread>
+
+MainWindow::MainWindow() : QMainWindow(), ui(new Ui::MainWindow) {
+    ui->setupUi(this);
+
+    // needs to be defined with new -- would be termintated after this constructor.
+    new std::thread([this]() {
+        IPAPI ipapi;
+        std::string ip = ipapi.getGlobalIp();
+        Logger::message("Current global IP: " + ip);
+        std::string msg = "Your current global IP: " + ip;
+        this->ui->labelCurrentIP->setText(msg.c_str());
+    });
+
+    // set config info label and initial check if config is valid
+    ui->labelConfig->setText(Config::validateConfig() ? "Config is: OK" : "Config is: NOT OK");
+
+    connect(ui->buttonCheckConfig, SIGNAL(clicked()), this, SLOT(checkConfigBtn()));
+    connect(ui->buttonRefreshIP, SIGNAL(clicked()), this, SLOT(refreshIPBtn()));
+
+    connect(this, SIGNAL(appendLogField(QString)), ui->textLog, SLOT(appendPlainText(QString)));
+}
+
+MainWindow::~MainWindow() {
+    // todo check if disconnects are really necessary
+    disconnect(ui->buttonCheckConfig);
+    disconnect(ui->buttonRefreshIP);
+    delete ui;
+}
+
+void MainWindow::checkConfigBtn() {
+    Logger::message("checking config!");
+    appendLogField("checking config!");
+
+    if (Config::validateConfig()) {
+        Logger::message("Config file is OK");
+        appendLogField("Config file is OK");
+        ui->labelConfig->setText("Config is: OK");
+    } else {
+        Logger::error("There are errors in config file!");
+        appendLogField("There are errors in config file!");
+    }
+    appendLogField("");
+}
+
+void MainWindow::refreshIPBtn() {
+    Logger::message("start refreshing Dynu IP.");
+    appendLogField("");
+    appendLogField("start refreshing Dynu IP.");
+    new std::thread([this]() {
+        if (Config::readConfig()) {
+            int code = IPRefresher::checkIPAdress(false);
+            switch (code) {
+                case IPRefresher::Status_Code::SUCCESS:
+                    appendLogField("successfully refreshed IP!");
+                    break;
+                case IPRefresher::Status_Code::NOREFRESH:
+                    appendLogField("IP is already correct.");
+                    break;
+                case IPRefresher::Status_Code::ERROR_NO_INTERNET:
+                    appendLogField("Error: No Internet connection");
+                    break;
+                case IPRefresher::Status_Code::ERROR:
+                    appendLogField("An error occured while refreshing.");
+                    break;
+                default:
+                    appendLogField("An unknown error code occured");
+            }
+        } else {
+            std::cout << "incorrect credentials!" << std::endl;
+        }
+
+        Logger::message("Finished refreshing Dynu IP.");
+        this->appendLogField("Finished refreshing Dynu IP.");
+    });
+}

src/gui/MainWindow.h

@@ -0,0 +1,50 @@
+/**
+ * Main GUI controller - User IO handlings
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 09.05.2020
+ */
+
+#pragma once
+
+#include <QtWidgets/QMainWindow>
+
+namespace Ui {
+    class MainWindow;
+}
+
+class MainWindow : public QMainWindow {
+Q_OBJECT
+
+public:
+    /**
+     * constructor with basic initializations
+     */
+    explicit MainWindow();
+
+    /**
+     * destruct all gui elements
+     */
+    ~MainWindow();
+
+private:
+    Ui::MainWindow *ui;
+private slots:
+    /**
+     * executed click handler for config button
+     */
+    void checkConfigBtn();
+
+    /**
+     * executed click handler for refresh btn
+     */
+    void refreshIPBtn();
+
+signals:
+    /**
+     * append a String line to the Log field
+     *
+     * @param QString string to be appended
+     */
+    void appendLogField(QString);
+};

src/gui/mainwindow.ui

@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>823</width>
+    <height>618</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>MainWindow</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <widget class="QPushButton" name="buttonRefreshIP">
+    <property name="geometry">
+     <rect>
+      <x>290</x>
+      <y>300</y>
+      <width>91</width>
+      <height>33</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Refresh IP</string>
+    </property>
+   </widget>
+   <widget class="QLabel" name="labelCurrentIP">
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>60</y>
+      <width>301</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Your current global IP:</string>
+    </property>
+   </widget>
+   <widget class="QPlainTextEdit" name="textLog">
+    <property name="enabled">
+     <bool>false</bool>
+    </property>
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>410</y>
+      <width>691</width>
+      <height>191</height>
+     </rect>
+    </property>
+    <property name="cursor" stdset="0">
+     <cursorShape>IBeamCursor</cursorShape>
+    </property>
+   </widget>
+   <widget class="QLabel" name="label_2">
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>380</y>
+      <width>64</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Log:</string>
+    </property>
+   </widget>
+   <widget class="QPushButton" name="buttonCheckConfig">
+    <property name="geometry">
+     <rect>
+      <x>270</x>
+      <y>140</y>
+      <width>91</width>
+      <height>33</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Check Config</string>
+    </property>
+   </widget>
+   <widget class="QLabel" name="labelConfig">
+    <property name="geometry">
+     <rect>
+      <x>270</x>
+      <y>180</y>
+      <width>141</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Config is: undefined</string>
+    </property>
+   </widget>
+  </widget>
+  <widget class="QStatusBar" name="statusbar"/>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

src/main.cpp

@@ -21,15 +21,14 @@ int main(int argc, char *argv[]) {
         } else if (firstarg == "-v" || firstarg == "--version") {
             std::cout << "Version " << Version::VERSION << std::endl;
         } else if (firstarg == "-f" || firstarg == "--force") {
-            IPRefresher ipr;
             if (Config::readConfig()) {
-                ipr.checkIPAdress(true);
+                IPRefresher::checkIPAdress(true);
             } else {
                 std::cout << "incorrect credentials!" << std::endl;
             }
 
         } else if (firstarg == "-l" || firstarg == "--loop") {
-            IPRefresher(true);
+            IPRefresher::startUpService(true);
         } else if (firstarg == "-c" || firstarg == "--checkconfig") {
             if (Config::validateConfig()) {
                 Logger::message("Config file is OK");
@@ -44,10 +43,9 @@ int main(int argc, char *argv[]) {
             Logger::message("wrong arguments!  -h for help");
         }
     } else {
-        IPRefresher ipr;
         Logger::message("starting check");
         if (Config::readConfig()) {
-            ipr.checkIPAdress(false);
+            IPRefresher::checkIPAdress(false);
         } else {
             std::cout << "incorrect credentials!" << std::endl;
         }

src/maingui.cpp

@@ -0,0 +1,14 @@
+#include <QApplication>
+#include "gui/MainWindow.h"
+
+/**
+ * application entry point
+ */
+int main(int argc, char *argv[]) {
+    QApplication a(argc, argv);
+    MainWindow w;
+    w.setWindowTitle("startUpService");
+    w.show();
+
+    return QApplication::exec();
+}