options to allow/deny package build

option cleanup

.gitlab-ci.yml

@@ -0,0 +1,17 @@
+image: luki42/dynuiprefresher_build:latest
+
+stages:
+  - build
+
+
+build:
+  stage: build
+  script:
+    - cmake -S . -B build
+    - cd build
+    - make
+    - make package
+  artifacts:
+    paths:
+      - "build/bin/*"
+      - "build/packages/*"

.idea/.gitignore

@@ -1,2 +0,0 @@
-# Default ignored files
-/workspace.xml

.idea/iprefresher.iml

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module classpath="CMake" type="CPP_MODULE" version="4" />

.idea/misc.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CMakeWorkspace" PROJECT_DIR="$PROJECT_DIR$" />
-  <component name="JavaScriptSettings">
-    <option name="languageLevel" value="ES6" />
-  </component>
-</project>

.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/iprefresher.iml" filepath="$PROJECT_DIR$/.idea/iprefresher.iml" />
-    </modules>
-  </component>
-</project>

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

CMakeLists.txt

@@ -1,25 +1,37 @@
+# @author Lukas Heiligenbrunner
+# main CMake file
+#
+# Build lib dependencies:
+## libcurl (with sources)
+## libconfig (with sources)
+#
+# documenation build needs doxygen to be installed.
+
 cmake_minimum_required(VERSION 3.13)
 project(iprefresher DESCRIPTION "Dynu ip refresher")
+SET(PROJECT_VERSION 1.3.3)
+SET(CMAKE_CXX_STANDARD 17)
 
-set(CMAKE_CXX_STANDARD 17)
+# CONFIGURATION
+SET(CMAKE_BUILD_TYPE Release) # manually SET build type (Release / Debug)
+SET(LIB_METHOD STATIC) #SHARED / STATIC
 
-set(CMAKE_BUILD_TYPE Release) # manually set build type (Release / Debug)
-set(LIB_METHOD STATIC) #SHARED / STATIC
+option(BUILD_DOC "Build documentation" OFF) # additional dependency for Doxygen
+option(PACKAGING "Allow Packaging to <exe>, <deb> or <rpm>" ON) # additional dependencies for RPMbuild,dpkg  or NSIS
 set(WinBuild false)
-set(PROJECT_VERSION 1.2.2)
-option(BUILD_DOC "Build documentation" ON)
 
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-#set up toolchain
+SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
+# setup winbuild compilers
 if (${WinBuild})
     set(LIBSUFFIX .dll)
     set(SUFFIX .exe)
 
-    set(CMAKE_SYSTEM_NAME Windows)
-    set(TOOLCHAIN_PREFIX x86_64-w64-mingw32)
+    set(CMAKE_SYSTEM_NAME WindowsStore)
+    set(CMAKE_SYSTEM_VERSION 10.0)
+    set(TOOLCHAIN_PREFIX x86_64-w64-mingw32) # x64 build toolchain
     #set(TOOLCHAIN_PREFIX i686-w64-mingw32)
 
     # cross compilers to use for C and C++
@@ -28,137 +40,236 @@ if (${WinBuild})
     set(CMAKE_RC_COMPILER ${TOOLCHAIN_PREFIX}-windres)
 
     # target environment on the build host system
-    set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX} /usr/lib/gcc/${TOOLCHAIN_PREFIX}/9.2.1)
+    set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX})
 
 
     # modify default behavior of FIND_XXX() commands to
     # search for headers/libs in the target environment and
     # search for programs in the build host environment
-    set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+    set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
     set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
     set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+    set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
 
-    #    set(CMAKE_CXX_STANDARD_LIBRARIES -lcurl -lpthread -static-libgcc -static-libstdc++ -lcrypto -lssl -lws2_32 -std=c++11 -static -DCURL_STATICLIB)
-#    set(CMAKE_CXX_STANDARD_LIBRARIES "-static-libgcc -static-libstdc++  -DCURL_STATICLIB -lstdc++ -lwsock32 -lws2_32 ${CMAKE_CSS_STANDARD_LIBRARIES}")
-    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -DCURL_STATICLIB -static -lpthread")
-    #    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14")
-    #    set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS)
-    #add_definitions(-DCURL_STATICLIB)
+    set(CMAKE_CXX_STANDARD_LIBRARIES "${CMAKE_CSS_STANDARD_LIBRARIES}")
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}")
+    # currently libs are dynamically linked eg. dlls have to be copied to same folder
+    # todo link dynamically.
+    # maybe so: set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++ -static")
+    # or set(CMAKE_CXX_STANDARD_LIBRARIES -lcurl -lpthread -static-libgcc -static-libstdc++ -lcrypto -lssl -lws2_32 -static -DCURL_STATICLIB)
+    # or add_definitions(-DCURL_STATICLIB)
+
+    # windows config path is same as executable
+    set(CONFIG_PATH "./iprefresher.cfg")
 else ()
     set(LIBSUFFIX .so)
     set(SUFFIX "")
+
+    # set /etc/ config path
+    set(CONFIG_PATH "/etc/iprefresher.cfg")
 endif ()
 
-#config libs
+
+# config libs
 message(STATUS "Config of Libraries")
-find_package(CURL REQUIRED)
-if (CURL_FOUND)
-    message(STATUS "Found CURL version: ${CURL_VERSION_STRING}")
+# libcurl
+if (${WinBuild})
+    SET(CMAKE_FIND_LIBRARY_SUFFIXES ".lib" ".dll")
+    # configure libcurl
+    FIND_PATH(CURL_INCLUDE_DIRS curl/curl.h /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/include/) # search for libconfig include headers
+    FIND_LIBRARY(CURL_LIBRARIES NAMES libcurl.dll.a HINTS /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib) # search for actual lib
+
     message(STATUS "Using CURL include dir(s): ${CURL_INCLUDE_DIRS}")
     message(STATUS "Using CURL lib(s): ${CURL_LIBRARIES}")
-else ()
-    message(FATAL_ERROR "Could not find CURL")
-endif ()
-message("")
-include_directories(${CURL_INCLUDE_DIR} inc)
+    message(STATUS "")
 
+    include_directories(${CURL_INCLUDE_DIRS} inc)
+
+    # configure libconfig
+    FIND_PATH(LIBCONFIG++_INCLUDE_DIRS libconfig.h++ /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/include/) # search for libconfig include headers
+    FIND_LIBRARY(LIBCONFIG++_LIBRARIES NAMES libconfig++.dll.a HINTS /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib) # search for actual lib
+
+    message(STATUS "Using LIBCONFIG++ include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
+    message(STATUS "Using LIBCONFIG++ lib(s): ${LIBCONFIG++_LIBRARIES}")
+
+    include_directories(${LIBCONFIG++_INCLUDE_DIRS} inc)
+else ()
+    find_package(CURL REQUIRED)
+    if (CURL_INCLUDE_DIRS AND CURL_LIBRARIES)
+        message(STATUS "Found CURL version: ${CURL_VERSION_STRING}")
+        message(STATUS "Using CURL include dir(s): ${CURL_INCLUDE_DIRS}")
+        message(STATUS "Using CURL lib(s): ${CURL_LIBRARIES}")
+    else ()
+        message(FATAL_ERROR "Could not find CURL")
+    endif ()
+    include_directories(${CURL_INCLUDE_DIR} inc)
+
+    message("")
+    # libconfig
+    FIND_PACKAGE(libconfig++ REQUIRED)
+    if (LIBCONFIG++_INCLUDE_DIRS AND LIBCONFIG++_LIBRARY_DIRS)
+        message(STATUS "Found libconfig version: ${LIBCONFIG++_VERSION}")
+        message(STATUS "Using libconfig include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
+        message(STATUS "Using libconfig lib(s): ${LIBCONFIG++_LIBRARY_DIRS}")
+    else ()
+        message(FATAL_ERROR "Could not find CURL")
+    endif ()
+    include_directories(${LIBCONFIG++_INCLUDE_DIRS} inc)
+endif ()
+
+message("")
+
+#read sample config
+FILE(READ ${CMAKE_SOURCE_DIR}/config/iprefresher.cfg SAMPLECONFIG)
 #add version header
 FILE(WRITE ${CMAKE_SOURCE_DIR}/inc/Version.h
-        "\#pragma once\nclass Version {\npublic:\n  static const std::string VERSION;\n};\n\n std::string const Version::VERSION = \"${PROJECT_VERSION}\";"
+        "\#pragma once
+#include <string>
+namespace Version {
+  const std::string VERSION = \"${PROJECT_VERSION}\";
+  const std::string ConfigDir = \"${CONFIG_PATH}\";
+  const std::string SAMPLECONFIG = R\"(${SAMPLECONFIG})\";
+}"
         )
 
 add_library(api ${LIB_METHOD}
         src/api/API.cpp
-
         src/api/TelegramAPI.cpp
-
         src/api/DynuAPI.cpp
-
-        src/api/IPAPI.cpp
-        )
+        src/api/IPAPI.cpp)
 
 add_library(logger ${LIB_METHOD}
         src/FileLogger.cpp
-        src/Logger.cpp
-        )
+        src/Logger.cpp)
 
 
-set(SOURCE
+SET(SOURCE
         src/main.cpp
         src/IPRefresher.cpp
-        )
+        src/Config.cpp)
 
 add_executable(iprefresher ${SOURCE})
 
 # LINK generated LIBS #
-target_link_libraries(iprefresher api logger ${CURL_LIBRARIES})
+target_link_libraries(iprefresher api logger ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
 
-# INSTALL to SYSTEM #
-install(TARGETS iprefresher DESTINATION bin)
-install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/iprefresher.service DESTINATION /lib/systemd/system)
+# setting install targets
+IF (NOT ${WinBuild})
+    # INSTALL to Linux SYSTEM #
 
+    # install binaries
+    install(TARGETS iprefresher DESTINATION usr/bin)
+    # install systemd service and enable it
+    install(FILES service/iprefresher.service DESTINATION lib/systemd/system)
+ELSE ()
+    # INSTALL to Windows SYSTEM #
 
-IF (UNIX)
+    # install binary to current folder
+    set_target_properties(iprefresher PROPERTIES SUFFIX ".exe")
+    install(TARGETS iprefresher DESTINATION .)
+
+    # install .dll dependencies
+    # todo check if files exist...
+    install(FILES /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libcurl-4.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libssh2-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libstdc++-6.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libgcc_s_seh-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libcrypto-1_1-x64.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libssl-1_1-x64.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libwinpthread-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/zlib1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libidn2-0.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libconfig++-11.dll
+            DESTINATION .)
+ENDIF ()
+
+if (${PACKAGING})
+    # General Packaging options:
     message(STATUS "config of Package build")
-    SET(CPACK_DEB_COMPONENT_INSTALL 1)
-    SET(CPACK_OUTPUT_FILE_PREFIX packages)
-
-    FIND_PROGRAM(RPMBUILD_EXECUTABLE rpmbuild)
-    FIND_PROGRAM(DEB_EXECUTABLE dpkg)
-
-    SET(CPACK_GENERATOR "TGZ;TBZ2")
-
-    #check if rpm build is possible
-    if (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
-        message(STATUS "found rpm build executeable --> able to build rpm")
-        set(CPACK_GENERATOR "${CPACK_GENERATOR};RPM")
-        set(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/lib/systemd/system" "/lib/systemd" "/lib") # --> needed to not override existing folders
-    else (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
-        message(STATUS "not found rpm build tools --> not building rpm")
-    endif (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
-
-    #check if deb build is possible
-    if (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
-        message(STATUS "found deb build tools --> able to build deb")
-        set(CPACK_GENERATOR "${CPACK_GENERATOR};DEB")
-    else (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
-        message(STATUS "not found  deb build tools --> not building deb")
-    endif (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
-
-
-    SET(CPACK_CMAKE_GENERATOR "Unix Makefiles")
-    SET(CPACK_SOURCE_GENERATOR "TGZ;TBZ2")
 
+    set(CPACK_PACKAGE_NAME "DynuIpRefresher")
     SET(CPACK_PACKAGE_DESCRIPTION "IPrefresher to refresh Dynu ip address and notify user via Telegram")
     SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "IPrefresher to refresh Dynu ip address and notify user via Telegram")
     SET(CPACK_PACKAGE_VENDOR "Lukas Heilgienbrunner")
-    SET(CPACK_PACKAGE_VERSION_MAJOR "1")
-    SET(CPACK_PACKAGE_VERSION_MINOR "2")
-    set(CPACK_PACKAGE_VERSION_PATCH "1")
     SET(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
     SET(CPACK_SOURCE_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${PROJECT_VERSION}")
-    SET(CPACK_PACKAGE_CONTACT "Lukas Heiligenbrunner <ultimategameingcookie@gmail.com>")
-    SET(CPACK_PACKAGE_SECTION "games")
-    set(CPACK_PACKAGE_DEPENDS "libcurl (>= 7.0.0-1)")
+    SET(CPACK_PACKAGE_CONTACT "Lukas Heiligenbrunner <lukas.heiligenbrunner@gmail.com>")
+
+    SET(CMAKE_INSTALL_PREFIX "/")
+
+    IF (NOT ${WinBuild})
+        # generate post script for checking if configuration already exists
+        FILE(WRITE ${CMAKE_SOURCE_DIR}/postinst
+                "#!/bin/bash
+if [ ! -f ${CONFIG_PATH} ]; then
+    cat > ${CONFIG_PATH} <<- EOM
+${SAMPLECONFIG}EOM
+fi\n"
+                )
+
+
+        SET(CPACK_DEB_COMPONENT_INSTALL 1)
+        SET(CPACK_OUTPUT_FILE_PREFIX packages)
+        SET(CPACK_PACKAGING_INSTALL_PREFIX "/") # no prefix for package structure
+
+        FIND_PROGRAM(RPMBUILD_EXECUTABLE rpmbuild)
+        FIND_PROGRAM(DEB_EXECUTABLE dpkg)
+
+        SET(CPACK_GENERATOR "TGZ;TBZ2")
+
+        #check if rpm build is possible
+        if (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
+            message(STATUS "found rpm build executeable --> able to build rpm")
+            SET(CPACK_GENERATOR "${CPACK_GENERATOR};RPM")
+            SET(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst")
+            SET(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/lib/systemd/system" "/lib/systemd" "/lib" "/usr/local/bin" "/usr/local") # --> needed to not override existing folders
+            set(CPACK_RPM_PACKAGE_REQUIRES "libcurl,libconfig")
+        else (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
+            message(STATUS "not found rpm build tools --> not building rpm")
+        endif (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
+
+        #check if deb build is possible
+        if (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
+            message(STATUS "found deb build tools --> able to build deb")
+            SET(CPACK_GENERATOR "${CPACK_GENERATOR};DEB") # add deb generator
+            set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") # set post inst file
+            set(CPACK_DEBIAN_PACKAGE_DEPENDS "libcurl4,libconfig++9v5") # add debian dependencies
+        else (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
+            message(STATUS "not found  deb build tools --> not building deb")
+        endif (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
+
+
+        SET(CPACK_CMAKE_GENERATOR "Unix Makefiles")
+        SET(CPACK_SOURCE_GENERATOR "TGZ;TBZ2")
+
+        SET(CPACK_PACKAGE_SECTION "games")
+    ELSE ()
+        # Pack a NSIS intaller
+        set(CPACK_GENERATOR NSIS)
+        message(STATUS "Using NSIS Package build.")
+
+        set(CPACK_NSIS_testcomp_INSTALL_DIRECTORY /)
+        set(CPACK_PACKAGE_INSTALL_DIRECTORY "DynuIpRefresher")
+        SET(CPACK_NSIS_MODIFY_PATH ON)
+    ENDIF ()
 
     INCLUDE(CPack)
 
-    add_custom_target(build-linux-packages
+    add_custom_target(build-packages
             "${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target package
             DEPENDS ${PROJECT_NAME}
-            COMMENT "Installing ${PROJECT_NAME}")
-message("")
-ENDIF (UNIX)
+            COMMENT "Packing ${PROJECT_NAME}")
+    message("")
+ENDIF ()
 
 # check if Doxygen is installed
-
 if (BUILD_DOC)
     message(STATUS "config of DOxygen build")
     find_package(Doxygen)
     if (DOXYGEN_FOUND)
-        # set input and output files
-        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
-        set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+        # SET input and output files
+        SET(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
+        SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
         # request to configure the file
         configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
@@ -170,9 +281,8 @@ if (BUILD_DOC)
                 COMMENT "Generating API documentation with Doxygen"
                 VERBATIM)
         message(STATUS "Successfully configured doxygen")
-
     else (DOXYGEN_FOUND)
         message(STATUS "Doxygen need to be installed to generate the doxygen documentation")
     endif (DOXYGEN_FOUND)
     message("")
-endif (BUILD_DOC)
+endif (BUILD_DOC)

README.md

@@ -1,4 +1,19 @@
 # DynuIPRefresher
+A lightweight C++ application to setup a service for refreshing a dynamic IP to the Dynu servers. 
+Dynu.com is a free DDns service and provides an API.
+
+## Installation
+Download the latest Release at [Release_Page](https://github.com/Lukas-Heiligenbrunner/DynuIPRefresher/releases).
+I'm providing executables for Debian/Ubuntu (.deb) and RHEL/Debian (.rpm). 
+But you can still compile the code my your own (see build section).
+
+## Configuration
+There is a configuration file `/etc/iprefresher.cfg` where you have to specify the DYNU API key (get it from their homepage), the domainid and your domain.
+Furthermore, you can optionally specify a Telegram API key and a Chat ID if you want to be notfied when your local ip changes.
+
+To enable and start the service: 
+`systemctl enable iprefresher.service` and `systemctl start iprefresher.service`
+
 
 ## Build
 ## Basic Build
@@ -9,13 +24,27 @@
 ### install build dependencies
 
 `libcurl`
-`libcurl-devel`
+`libconfig`
 
-Debian:
+#### Debian:
 `apt install libcurl4-openssl-dev`
 
-Fedora:
-`dnf install libcurl-devel`
+#### Fedora:
+`dnf install libcurl-devel libconfig-devel`
+
+#### Alpine Linux:
+Compiler dependencies:
+
+`apk add make cmake g++`
+
+Lib dependencies:
+
+`apk add libcurl curl-dev libconfig libconfig-dev`
+
+Packaging dependencies:
+
+`apk add dpkg rpm`
+
 
 #### dependencies for package build
 `dpkg` --> debian/ubuntu package
@@ -35,11 +64,23 @@ cd into downloaded files and Generate makefiles:
 
 `make install`
 
-[root] or create Linux packages
+(optional) create Linux packages
 
 `make package`
 
 
 
 ### Windows cross build
-TODO!
+Set Winbuild flag in CMakeList.txt.
+
+Dependencies:
+* MinGW Compiler
+* MinGW-libcurl
+* MinGW-libconfig++
+
+Optional dependencies
+* NSIS Pack tool (for creating installer)
+* doxygen (for generating html doc)
+
+Some addition configuration of lib paths may be needed in CMakeList.txt. 
+`make package` will pack it into a NSIS installer for Windows. 

config/iprefresher.cfg

@@ -0,0 +1,12 @@
+# Dynu IP refresher config
+# 2020
+# Lukas Heiligenbrunner
+
+## DYNU API Config
+dynuapikey = ""
+domainid = ""
+domainname = ""
+
+## Telegram API Config (optional)
+#telegramApiKey = ""
+#chatId = ""

inc/Config.h

@@ -0,0 +1,34 @@
+//
+// Created by lukas on 11.02.20.
+//
+
+#pragma once
+
+#include <string>
+
+class Config {
+public:
+    static std::string dynuapikey;
+
+    static std::string domainid; //id of the dynu domain
+    static std::string domainname;
+
+    static std::string telegramApiKey;
+    static std::string chatId;
+
+    /**
+     * read configuration out of config file
+     *
+     * @return success of config read
+     */
+    static bool readCredentials();
+
+    /**
+     * validate config file
+     *
+     * @return validity of config file
+     */
+    static bool validateConfig();
+
+private:
+};

inc/FileLogger.h

@@ -1,17 +1,13 @@
 //
 // Created by lukas on 05.05.19.
 //
+
 #pragma once
 
 #include <string>
+
 class FileLogger {
 public:
-    /**
-     * log messages to logfile
-     * @param text message
-     */
-    void logToLogfile(std::string text);
-
     /**
      * safe ip to temp file
      * @param ip ip address to save

inc/IPRefresher.h

@@ -11,6 +11,15 @@ public:
      */
     void checkIPAdress(bool force);
 
+    /**
+     * default constructor
+     */
     IPRefresher();
+
+    /**
+     * 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);
 };

inc/Logger.h

@@ -8,15 +8,40 @@
 
 class Logger {
 public:
+    /**
+     * a debug message
+     * @param message message
+     */
     static void debug(std::string message);
+
+    /**
+     * a default message
+     * @param message message
+     */
     static void message(std::string message);
+
+    /**
+     * a warning message
+     * @param message message
+     */
     static void warning(std::string message);
+
+    /**
+     * a error message
+     * @param message message
+     */
     static void error(std::string message);
 
-    static void log(std::string &message, int level);
+    /**
+     * a log message with manual level set
+     * @param message message
+     * @param level loglevel (1-4) or predefined labels
+     */
+    static void log(const std::string &message, int level);
 
-    static const int Debug;
-    static const int Message;
-    static const int Warning;
-    static const int Error;
+
+    static const int Debug = 4;
+    static const int Message = 3;
+    static const int Warning = 2;
+    static const int Error = 1;
 };

inc/api/API.h

@@ -4,9 +4,9 @@
 
 #pragma once
 
+#include "Hashmap.h"
 
 #include <string>
-#include "Hashmap.h"
 
 class API {
 public:

inc/api/DynuAPI.h

@@ -4,7 +4,6 @@
 
 #pragma once
 
-
 #include "API.h"
 
 class DynuAPI : API{
@@ -15,9 +14,17 @@ public:
      * @return request status
      */
     int refreshIp(std::string ip);
-private:
-    const std::string dynuapikey = "88vNpMfDhMM2YYDNfWR1DNYfRX9W6fYg";
 
-    const std::string domainid = "8506047"; //id of the dynu domain
-    const std::string domainname = "luki.dynu.net";
+    /**
+     * init Telegram api with apikey and chatid
+     * @param dynuApiKey Dynu Api key
+     * @param domainId ID of domain received by Dynu
+     * @param domainName domainname to refresh
+     */
+    void init(const std::string& dynuApiKey, const std::string& domainId, const std::string& domainName);
+private:
+    std::string dynuapikey; // Dynu API key
+
+    std::string domainid; //id of the dynu domain
+    std::string domainname;
 };

inc/api/Hashmap.h

@@ -4,7 +4,6 @@
 
 #pragma once
 
-
 #include <iostream>
 #include <vector>
 

inc/api/IPAPI.h

@@ -4,9 +4,10 @@
 
 #pragma once
 
-#include <string>
 #include "API.h"
 
+#include <string>
+
 class IPAPI : API{
 public:
     /**

inc/api/TelegramAPI.h

@@ -4,9 +4,9 @@
 
 #pragma once
 
+#include "API.h"
 
 #include <string>
-#include "API.h"
 
 class TelegramAPI : API {
 public:
@@ -14,7 +14,7 @@ public:
      * send telegram Message to predefined destination
      * @param text message
      */
-    void sendMessage(std::string text);
+    int sendMessage(const std::string& text);
 
     /**
      * init Telegram api with apikey and chatid

src/Config.cpp

@@ -0,0 +1,109 @@
+//
+// Created by lukas on 11.02.20.
+//
+
+#include "Config.h"
+#include "Logger.h"
+#include "Version.h"
+
+#include <iostream>
+#include <cstring>
+#include <fstream>
+#include <libconfig.h++>
+
+std::string Config::dynuapikey;
+std::string Config::domainid; //id of the dynu domain
+std::string Config::domainname;
+
+std::string Config::telegramApiKey;
+std::string Config::chatId;
+
+bool Config::readCredentials() {
+    libconfig::Config cfg;
+    try {
+        // todo make dynamic here
+        cfg.readFile(Version::ConfigDir.c_str());
+    }
+    catch (const libconfig::FileIOException &fioex) {
+        std::cout << "I/O error while reading config file." << std::endl << "creating new config file!" << std::endl;
+
+        std::ofstream myfile;
+        myfile.open(Version::ConfigDir);
+        if (myfile.is_open()) {
+            myfile << Version::SAMPLECONFIG;
+            myfile.close();
+        } else {
+            std::cout << "error creating file" << std::endl;
+        }
+
+        return false;
+    }
+    catch (const libconfig::ParseException &pex) {
+        std::cerr << "Parse error at " << pex.getFile() << ":" << pex.getLine()
+                  << " - " << pex.getError() << std::endl;
+        return false;
+    }
+
+    try {
+        // needed parameters
+        dynuapikey = (std::string) cfg.lookup("dynuapikey");
+        domainid = (std::string) cfg.lookup("domainid");
+        domainname = (std::string) cfg.lookup("domainname");
+        // optional parameters
+        telegramApiKey = (std::string) cfg.lookup("telegramApiKey");
+        chatId = (std::string) cfg.lookup("chatId");
+    }
+    catch (const libconfig::SettingNotFoundException &nfex) {
+        // triggered if setting is missing in config
+        if (!(std::strcmp("telegramApiKey", nfex.getPath()) == 0 || std::strcmp("chatId", nfex.getPath()) == 0)) {
+            std::cerr << "No '" << nfex.getPath() << "' setting in configuration file." << std::endl;
+        }
+    }
+    // check if needed values aren't empty
+    return !(Config::dynuapikey.empty() || Config::domainid.empty() || Config::domainname.empty());
+}
+
+bool Config::validateConfig() {
+    libconfig::Config cfg;
+    try {
+        Logger::message("reading config file");
+        cfg.readFile(Version::ConfigDir.c_str());
+    }
+    catch (const libconfig::FileIOException &fioex) {
+        Logger::warning("config file doesn't exist or permission denied!");
+        return false;
+    }
+    catch (const libconfig::ParseException &pex) {
+        std::cerr << "Parse error at " << pex.getFile() << ":" << pex.getLine()
+                  << " - " << pex.getError() << std::endl;
+        return false;
+    }
+    Logger::message("Syntax and Permission is OK");
+
+    try {
+        // needed parameters
+        if (((std::string) cfg.lookup("dynuapikey")).empty()) {
+            Logger::warning("required parameter dynuapikey seems to be empty.");
+            return false;
+        }
+        if (((std::string) cfg.lookup("domainid")).empty()) {
+            Logger::warning("required parameter domainid seems to be empty.");
+            return false;
+        }
+        if (((std::string) cfg.lookup("domainname")).empty()) {
+            Logger::warning("required parameter domainname seems to be empty.");
+            return false;
+        }
+        // optional parameters
+        cfg.lookup("telegramApiKey");
+        cfg.lookup("chatId");
+    }
+    catch (const libconfig::SettingNotFoundException &nfex) {
+        // triggered if setting is missing in config
+        if (!(std::strcmp("telegramApiKey", nfex.getPath()) == 0 || std::strcmp("chatId", nfex.getPath()) == 0)) {
+            std::cerr << "No '" << nfex.getPath() << "' setting in configuration file." << std::endl;
+            return false;
+        }
+    }
+    return true;
+}

src/FileLogger.cpp

@@ -2,13 +2,12 @@
 // Created by lukas on 05.05.19.
 //
 
-#include <fstream>
-#include <ctime>
-#include <iostream>
-#include <sstream>
-
 #include "FileLogger.h"
 
+#include <fstream>
+#include <iostream>
+#include <climits>
+
 void FileLogger::safeip(std::string ip) {
     std::ofstream out;
     out.open("ip.txt", std::ios::out);
@@ -26,24 +25,9 @@ std::string FileLogger::readip() {
 
     in >> ip;
 
-    return ip;
-}
-
-void FileLogger::logToLogfile(std::string text) {
-    std::ofstream out;
-    out.open("dynurefresher.log", std::ios::out | std::ios::app);
-
-
-    std::time_t t = std::time(0);   // get time now
-    std::tm *now = std::localtime(&t);
-
-    std::stringstream logline;
-
-    logline << "[ " << (now->tm_year + 1900) << '-' << (now->tm_mon + 1) << '-' << now->tm_mday
-            << "_" << now->tm_hour << ":" << now->tm_min << ":" << now->tm_sec << " ] " << '\t' << text << std::endl;
-
-
-    out << logline.str();
-
-    out.close();
+    // when received ip has no : return 0.0.0.0
+    if (ip.find(':') == ULONG_MAX)
+        return "0.0.0.0";
+    else
+        return ip;
 }

src/IPRefresher.cpp

@@ -2,18 +2,19 @@
 // Created by lukas on 02.08.19.
 //
 
+#include "IPRefresher.h"
+#include "FileLogger.h"
+#include "api/IPAPI.h"
+#include "api/DynuAPI.h"
+#include "api/TelegramAPI.h"
+#include "Config.h"
+#include "Version.h"
+
 #include <string>
-
-#include <FileLogger.h>
-#include <api/IPAPI.h>
-#include <api/DynuAPI.h>
-#include <api/TelegramAPI.h>
-
 #include <chrono>
 #include <thread>
 #include <Logger.h>
-
-#include <IPRefresher.h>
+#include <climits>
 
 void IPRefresher::checkIPAdress(bool force) {
     FileLogger logger;
@@ -22,28 +23,28 @@ void IPRefresher::checkIPAdress(bool force) {
     std::string ip = ipapi.getGlobalIp();
 
     if (ip.empty()) {
-        //no internet connection
-        logger.logToLogfile("[WARNING] no internet connection");
+        //no internet connection (or other error)
         Logger::warning("no internet connection");
+    } else if (ip.find(':') == ULONG_MAX) {
+        // error when ip doesn't contain a :
+        Logger::warning("an error occured when getting the global ip");
     } else {
         std::string oldip = logger.readip();
 
         if (oldip == ip && !force) {
             Logger::message("no change -- ip: " + ip);
-            logger.logToLogfile(" [INFO] no change -- ip: " + ip);
         } else {
-            logger.logToLogfile(" [INFO] ip changed! -- from :" + oldip + "to: " + ip);
             Logger::message("ip changed! -- from :" + oldip + "to: " + ip);
 
             DynuAPI dynu;
+            dynu.init(Config::dynuapikey, Config::domainid, Config::domainname);
 
             if (dynu.refreshIp(ip)) {
                 TelegramAPI tele;
-                tele.init("717213769:AAHan1nSXhUsxLJAN1Dv8Oc0z8wqwDdYPn4", "618154204");
+                tele.init(Config::telegramApiKey, Config::chatId);
                 tele.sendMessage(oldip + " moved to " + ip);
             } else {
                 //error
-                logger.logToLogfile(" [ERROR] failed to write ip to dynu api!");
                 Logger::error("failed to write ip to dynu api!");
             }
 
@@ -52,15 +53,20 @@ void IPRefresher::checkIPAdress(bool force) {
     }
 }
 
-IPRefresher::IPRefresher() {
-
-}
+IPRefresher::IPRefresher() = default;
 
 IPRefresher::IPRefresher(bool loop) {
-    Logger::message("startup of service");
-    while (loop) {
-        Logger::message("starting check");
-        checkIPAdress(false);
-        std::this_thread::sleep_for(std::chrono::milliseconds(300000));
+    if (loop) {
+        Logger::message("startup of service");
+        Logger::message("Version: " + Version::VERSION);
+        if (Config::readCredentials()) {
+            while (true) {
+                Logger::message("starting check");
+                checkIPAdress(false);
+                std::this_thread::sleep_for(std::chrono::milliseconds(300000));
+            }
+        } else {
+            std::cout << "incorrect credentials!" << std::endl;
+        }
     }
 }

src/Logger.cpp

@@ -2,34 +2,28 @@
 // Created by lukas on 26.10.19.
 //
 
+#include "Logger.h"
+
 #include <sstream>
 #include <iostream>
 
-#include "Logger.h"
-
-
-const int Logger::Warning = 1;
-const int Logger::Debug = 2;
-const int Logger::Message = 3;
-const int Logger::Error = 4;
-
-void Logger::debug(std::string message) {
+void Logger::debug(const std::string message) {
     log(message, Logger::Debug);
 }
 
-void Logger::message(std::string message) {
+void Logger::message(const std::string message) {
     log(message, Logger::Message);
 }
 
-void Logger::warning(std::string message) {
+void Logger::warning(const std::string message) {
     log(message, Logger::Warning);
 }
 
-void Logger::error(std::string message) {
+void Logger::error(const std::string message) {
     log(message, Logger::Error);
 }
 
-void Logger::log(std::string &message, int level) {
+void Logger::log(const std::string &message, int level) {
     std::stringstream out;
     out << "[";
     switch (level) {
@@ -45,6 +39,9 @@ void Logger::log(std::string &message, int level) {
         case Error:
             out << "ERROR";
             break;
+        default:
+            out << "UNDEFINED";
+            break;
     }
     out << "] ";
     out << message;

src/api/API.cpp

@@ -3,14 +3,10 @@
 //
 
 #include "api/API.h"
-#include "api/Hashmap.h"
 
-#include <string>
-#include <iostream>
 #include <sstream>
 #include <curl/curl.h>
 
-
 std::string API::request(std::string myurl) {
     Hashmap<std::string, std::string> map;
     std::vector<std::string> str;

src/api/DynuAPI.cpp

@@ -5,19 +5,16 @@
 #include "api/DynuAPI.h"
 
 int DynuAPI::refreshIp(std:: string ip) {
-
     Hashmap<std::string, std::string> args;
     args.add("name", domainname);
     args.add("ipv4Address", ip);
 
     std::vector<std::string> headers;
-    headers.push_back("accept: application/json");
-    headers.push_back("User-Agent: Mozilla/5.0 (compatible; Rigor/1.0.0; http://rigor.com)");
-    headers.push_back("API-Key: " + dynuapikey);
+    headers.emplace_back("accept: application/json");
+    headers.emplace_back("User-Agent: Mozilla/5.0 (compatible; Rigor/1.0.0; http://rigor.com)");
+    headers.emplace_back("API-Key: " + dynuapikey);
 
-    std::string dynurepl = request("https://api.dynu.com/v2/dns/" + domainid, true, args, headers);
-
-//    std::cout << "[DEBUG] api reply:: " << dynurepl << std::endl;
+    const std::string dynurepl = request("https://api.dynu.com/v2/dns/" + domainid, true, args, headers);
 
     if (dynurepl != "{\"statusCode\":200}") {
         return -1;
@@ -25,3 +22,9 @@ int DynuAPI::refreshIp(std:: string ip) {
         return 1;
     }
 }
+
+void DynuAPI::init(const std::string& dynuApiKey, const std::string& domainId, const std::string& domainName) {
+    this->dynuapikey=dynuApiKey;
+    this->domainid=domainId;
+    this->domainname=domainName;
+}

src/api/TelegramAPI.cpp

@@ -3,8 +3,11 @@
 //
 
 #include "api/TelegramAPI.h"
+#include "Logger.h"
 
-void TelegramAPI::sendMessage(std::string text) {
+#include <climits>
+
+int TelegramAPI::sendMessage(const std::string& text) {
     Hashmap<std::string, std::string> args;
     args.add("chat_id", chatid);
     args.add("text", text);
@@ -12,10 +15,15 @@ void TelegramAPI::sendMessage(std::string text) {
     std::vector<std::string> headers;
 
     std::string reply = request("https://api.telegram.org/bot" + apikey + "/sendmessage", false, args, headers);
-//    std::cout << "[DEBUG] " << reply << std::endl;
+
+    if (reply.find("\"error_code\"") != ULONG_MAX) {
+        Logger::error("failed to refresh the ip (Dynu API)");
+        return -1;
+    }
+    return 1;
 }
 
-void TelegramAPI::init(std::string apikey, std::string chatid) {
+void TelegramAPI::init(const std::string apikey, const std::string chatid) {
     this->apikey = apikey;
     this->chatid = chatid;
 }

src/main.cpp

@@ -1,8 +1,18 @@
-#include <iostream>
-#include <IPRefresher.h>
-#include <Version.h>
-#include <Logger.h>
+//
+// Created by lukas on 18.06.19.
+//
 
+#include "Version.h"
+#include "IPRefresher.h"
+#include "Logger.h"
+#include "Config.h"
+#include "api/IPAPI.h"
+
+#include <iostream>
+
+/**
+ * application entry point
+ */
 int main(int argc, char *argv[]) {
     if (argc > 1) {
         std::string firstarg(argv[1]);
@@ -11,22 +21,42 @@ int main(int argc, char *argv[]) {
                       << "[-v] [--version] print the software version" << std::endl
                       << "[-f] [--force] force refresh of ip" << std::endl
                       << "[-l] [--loop] infinite loop to refresh ip every five minutes" << std::endl
+                      << "[-c] [--checkconfig] validate configuration" << std::endl
+                      << "[-ip] [--currentip] get current global ip" << std::endl
                       << "[no argument] normal ip check and refresh" << std::endl;
         } else if (firstarg == "-v" || firstarg == "--version") {
             std::cout << "Version " << Version::VERSION << std::endl;
         } else if (firstarg == "-f" || firstarg == "--force") {
             IPRefresher ipr;
-            ipr.checkIPAdress(true);
+            if (Config::readCredentials()) {
+                ipr.checkIPAdress(true);
+            } else {
+                std::cout << "incorrect credentials!" << std::endl;
+            }
+
         } else if (firstarg == "-l" || firstarg == "--loop") {
-            IPRefresher ipr(true);
+            IPRefresher(true);
+        } else if (firstarg == "-c" || firstarg == "--checkconfig") {
+            if (Config::validateConfig()) {
+                Logger::message("Config file is OK");
+            } else {
+                Logger::warning("There are errors in config file!");
+                return -1;
+            }
+        } else if (firstarg == "-ip" || firstarg == "--currentip") {
+            IPAPI ipapi;
+            std::cout << "Current global IP: " << ipapi.getGlobalIp() << std::endl;
         } else {
             Logger::message("wrong arguments!  -h for help");
         }
     } else {
         IPRefresher ipr;
         Logger::message("starting check");
-        ipr.checkIPAdress(false);
-
+        if (Config::readCredentials()) {
+            ipr.checkIPAdress(false);
+        } else {
+            std::cout << "incorrect credentials!" << std::endl;
+        }
     }
 
     return 0;