removed useless ide files

added some doc

.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

@@ -5,52 +5,16 @@ set(CMAKE_CXX_STANDARD 17)
 
 set(CMAKE_BUILD_TYPE Release) # manually set build type (Release / Debug)
 set(LIB_METHOD STATIC) #SHARED / STATIC
-set(WinBuild false)
-set(PROJECT_VERSION 1.2.2)
+set(PROJECT_VERSION 1.2.3)
 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
 
-if (${WinBuild})
-    set(LIBSUFFIX .dll)
-    set(SUFFIX .exe)
-
-    set(CMAKE_SYSTEM_NAME Windows)
-    set(TOOLCHAIN_PREFIX x86_64-w64-mingw32)
-    #set(TOOLCHAIN_PREFIX i686-w64-mingw32)
-
-    # cross compilers to use for C and C++
-    set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc)
-    set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++)
-    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)
-
-
-    # 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_LIBRARY ONLY)
-    set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE 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)
-else ()
-    set(LIBSUFFIX .so)
-    set(SUFFIX "")
-endif ()
-
-#config libs
+# config libs
 message(STATUS "Config of Libraries")
+# libcurl
 find_package(CURL REQUIRED)
 if (CURL_FOUND)
     message(STATUS "Found CURL version: ${CURL_VERSION_STRING}")
@@ -59,12 +23,31 @@ if (CURL_FOUND)
 else ()
     message(FATAL_ERROR "Could not find CURL")
 endif ()
-message("")
 include_directories(${CURL_INCLUDE_DIR} inc)
 
+# libconfig
+FIND_PATH(LIBCONFIG_INCLUDE_DIR libconfig.h++ /usr/include /usr/local/include) # search for libconfig include headers
+FIND_LIBRARY(CONFIG++_LIBRARY NAMES config++ PATH /usr/lib /usr/local/lib) # search for actual lib
+
+IF (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
+    MESSAGE(STATUS "Found Config++: ${CONFIG++_LIBRARY}")
+ELSE (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
+    IF (NOT LIBCONFIG_INCLUDE_DIR)
+        MESSAGE(FATAL_ERROR "Could not find LibConfig++ header file! Try to install 'libconfig-devel'")
+    ENDIF (NOT LIBCONFIG_INCLUDE_DIR)
+
+    IF (NOT CONFIG++_LIBRARY)
+        MESSAGE(FATAL_ERROR "Could not find LibConfig++ library file! Try to install 'libconfig'")
+    ENDIF (NOT CONFIG++_LIBRARY)
+ENDIF (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
+
+include_directories(${LIBCONFIG_INCLUDE_DIR})
+
+message("")
+
 #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\nclass Version {\npublic:\n  static const std::string VERSION;\n};\n\nstd::string const Version::VERSION = \"${PROJECT_VERSION}\";"
         )
 
 add_library(api ${LIB_METHOD}
@@ -86,22 +69,25 @@ add_library(logger ${LIB_METHOD}
 set(SOURCE
         src/main.cpp
         src/IPRefresher.cpp
-        )
+        src/Credentials.cpp)
 
 add_executable(iprefresher ${SOURCE})
 
 # LINK generated LIBS #
-target_link_libraries(iprefresher api logger ${CURL_LIBRARIES})
+target_link_libraries(iprefresher api logger ${CURL_LIBRARIES} config++)
 
 # INSTALL to SYSTEM #
-install(TARGETS iprefresher DESTINATION bin)
-install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/iprefresher.service DESTINATION /lib/systemd/system)
+set(CMAKE_INSTALL_PREFIX "/")
+install(TARGETS iprefresher DESTINATION usr/local/bin)
+install(FILES service/iprefresher.service DESTINATION lib/systemd/system)
+install(FILES config/iprefresher.cfg DESTINATION etc)
 
 
 IF (UNIX)
     message(STATUS "config of Package build")
     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)
@@ -112,7 +98,7 @@ IF (UNIX)
     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
+        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
     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")
@@ -132,14 +118,11 @@ IF (UNIX)
     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_CONTACT "Lukas Heiligenbrunner <lukas.heiligenbrunner@gmail.com>")
     SET(CPACK_PACKAGE_SECTION "games")
-    set(CPACK_PACKAGE_DEPENDS "libcurl (>= 7.0.0-1)")
+    set(CPACK_PACKAGE_DEPENDS "libcurl (>= 7.0.0-1), libconfig (>= 1.5.0)")
 
     INCLUDE(CPack)
 
@@ -147,11 +130,10 @@ IF (UNIX)
             "${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target package
             DEPENDS ${PROJECT_NAME}
             COMMENT "Installing ${PROJECT_NAME}")
-message("")
+    message("")
 ENDIF (UNIX)
 
 # check if Doxygen is installed
-
 if (BUILD_DOC)
     message(STATUS "config of DOxygen build")
     find_package(Doxygen)
@@ -170,9 +152,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,5 @@
 # DynuIPRefresher
+A lightweight C++ application to setup a service for refreshing a dynamic IP to the Dynu servers. 
 
 ## Build
 ## Basic Build
@@ -10,12 +11,14 @@
 
 `libcurl`
 `libcurl-devel`
+`libconfig`
+`libconfig-devel`
 
 Debian:
 `apt install libcurl4-openssl-dev`
 
 Fedora:
-`dnf install libcurl-devel`
+`dnf install libcurl-devel libconfig-devel`
 
 #### dependencies for package build
 `dpkg` --> debian/ubuntu package

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/Credentials.h

@@ -0,0 +1,22 @@
+//
+// Created by lukas on 11.02.20.
+//
+
+#pragma once
+
+#include <string>
+
+class Credentials {
+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;
+
+    static bool readCredentials();
+
+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

@@ -12,5 +12,11 @@ public:
     void checkIPAdress(bool force);
 
     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

@@ -13,7 +13,7 @@ public:
     static void warning(std::string message);
     static void error(std::string message);
 
-    static void log(std::string &message, int level);
+    static void log(const std::string &message, int level);
 
     static const int Debug;
     static const int Message;

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(std::string dynuApiKey, std::string domainId, std::string domainName);
+private:
+    std::string dynuapikey;
+
+    std::string domainid; //id of the dynu domain
+    std::string domainname;
 };

src/Credentials.cpp

@@ -0,0 +1,53 @@
+//
+// Created by lukas on 11.02.20.
+//
+
+#include <Credentials.h>
+#include <iostream>
+#include <cstring>
+
+#include "libconfig.h++"
+
+std::string Credentials::dynuapikey;
+std::string Credentials::domainid; //id of the dynu domain
+std::string Credentials::domainname;
+
+std::string Credentials::telegramApiKey;
+std::string Credentials::chatId;
+
+bool Credentials::readCredentials() {
+    libconfig::Config cfg;
+    try {
+        cfg.readFile("/etc/iprefresher.cfg");
+    }
+    catch (const libconfig::FileIOException &fioex) {
+        std::cout << "I/O error while reading config file." << std::endl << "creating new config file!" << std::endl;
+        cfg.writeFile("/etc/iprefresher.cfg");
+        return false;
+    }
+    catch (const libconfig::ParseException &pex) {
+        std::cerr << "Parse error at " << pex.getFile() << ":" << pex.getLine()
+                  << " - " << pex.getError() << std::endl;
+        return false;
+    }
+
+    // Get the store name.
+    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");
+        std::cout << "Store name: " << dynuapikey << std::endl;
+    }
+    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 !(Credentials::dynuapikey.empty() || Credentials::domainid.empty() || Credentials::domainname.empty());
+}

src/FileLogger.cpp

@@ -3,9 +3,7 @@
 //
 
 #include <fstream>
-#include <ctime>
 #include <iostream>
-#include <sstream>
 
 #include "FileLogger.h"
 
@@ -28,22 +26,3 @@ std::string FileLogger::readip() {
 
     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();
-}

src/IPRefresher.cpp

@@ -14,6 +14,7 @@
 #include <Logger.h>
 
 #include <IPRefresher.h>
+#include <Credentials.h>
 
 void IPRefresher::checkIPAdress(bool force) {
     FileLogger logger;
@@ -22,28 +23,25 @@ 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 {
         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(Credentials::dynuapikey, Credentials::domainid, Credentials::domainname);
 
             if (dynu.refreshIp(ip)) {
                 TelegramAPI tele;
-                tele.init("717213769:AAHan1nSXhUsxLJAN1Dv8Oc0z8wqwDdYPn4", "618154204");
+                tele.init(Credentials::telegramApiKey, Credentials::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 +50,17 @@ 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 (Credentials::readCredentials()) {
+        Logger::message("startup of service");
+        while (loop) {
+            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

@@ -13,23 +13,23 @@ 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) {

src/api/DynuAPI.cpp

@@ -25,3 +25,9 @@ int DynuAPI::refreshIp(std:: string ip) {
         return 1;
     }
 }
+
+void DynuAPI::init(std::string dynuApiKey, std::string domainId, std::string domainName) {
+    this->dynuapikey=dynuApiKey;
+    this->domainid=domainId;
+    this->domainname=domainName;
+}

src/main.cpp

@@ -2,6 +2,7 @@
 #include <IPRefresher.h>
 #include <Version.h>
 #include <Logger.h>
+#include <Credentials.h>
 
 int main(int argc, char *argv[]) {
     if (argc > 1) {
@@ -16,16 +17,25 @@ int main(int argc, char *argv[]) {
             std::cout << "Version " << Version::VERSION << std::endl;
         } else if (firstarg == "-f" || firstarg == "--force") {
             IPRefresher ipr;
-            ipr.checkIPAdress(true);
+            if (Credentials::readCredentials()) {
+                ipr.checkIPAdress(true);
+            } else {
+                std::cout << "incorrect credentials!" << std::endl;
+            }
+
         } else if (firstarg == "-l" || firstarg == "--loop") {
-            IPRefresher ipr(true);
+            IPRefresher(true);
         } else {
             Logger::message("wrong arguments!  -h for help");
         }
     } else {
         IPRefresher ipr;
         Logger::message("starting check");
-        ipr.checkIPAdress(false);
+        if (Credentials::readCredentials()) {
+            ipr.checkIPAdress(false);
+        } else {
+            std::cout << "incorrect credentials!" << std::endl;
+        }
 
     }