Compare commits

...

50 Commits

Author SHA1 Message Date
891330825a set interval to correct integer 2021-05-05 16:36:38 +02:00
ad452feca2 fix executeable name in systemd service 2021-05-05 16:28:33 +02:00
05ca1ff60b fix failing build --> exchange libs 2021-04-09 18:45:01 +02:00
94964d69be remove cmake task from gitlab ci and run it within every task 2021-04-09 16:10:13 +02:00
2d1e99260d better error correction if ip syntax not correct 2021-02-01 18:33:36 +01:00
095eb5c0cd fixed incorrect merge of branches 2020-06-08 11:17:08 +02:00
a231e6c852 improved gitlab ci 2020-06-08 11:03:08 +02:00
Lukas-Heiligenbrunner
8d688716eb
Merge pull request #12 from Lukas-Heiligenbrunner/GUI
Gui
2020-06-08 10:55:28 +02:00
4b19ecf3c3 added dockerfiles and edited readme 2020-06-08 10:54:22 +02:00
85ba334c21 added options in nsis install what to install. 2020-05-26 19:59:23 +02:00
Lukas-Heiligenbrunner
2762605ca4
Merge branch 'master' into GUI 2020-05-26 18:04:16 +02:00
81de98bf6c rename Version.h to StaticData.h
new temp file path for windows and linux
temp file now writeable on windows
compare string find method with SIZE_MAX instead of ULONG_MAX
2020-05-26 16:51:29 +02:00
3f75484f77 improved inc directory inclusion 2020-05-22 21:58:51 +02:00
f4069d02bf right naming in gitlab ci 2020-05-21 14:27:16 +02:00
ce4a3a830e release version v1.3.4 2020-05-21 14:18:29 +02:00
Lukas-Heiligenbrunner
af4a9c8350
Merge pull request #20 from Lukas-Heiligenbrunner/servicebinarypackagesamename
Servicebinarypackagesamename
2020-05-21 14:16:35 +02:00
86fd995923 some minor renamings
edited README.md
2020-05-21 14:09:17 +02:00
12ff16dc8e renamed service-binarayname and config file name to dynuiprefresher 2020-05-21 11:52:55 +02:00
ea648d5946 added usage info to readme 2020-05-21 11:38:39 +02:00
Lukas-Heiligenbrunner
8c0c888472
Merge pull request #19 from Lukas-Heiligenbrunner/configfilewriteable
Configfilewriteable
2020-05-21 11:28:49 +02:00
Lukas-Heiligenbrunner
fed6d251be
Merge branch 'master' into configfilewriteable 2020-05-21 11:28:33 +02:00
ca47949a38 check if config folder exists if not create it
right appdata folder for windows hosts
seperate config path and config name in cmake header
2020-05-21 11:26:15 +02:00
8199fc2c1e correct build of test targets
correct upload of report.xml
2020-05-20 19:37:39 +02:00
998f3ea5e8 right xml export of unit test cases for test target 2020-05-20 19:25:37 +02:00
d8c3d4ffb8 correct build of gtests in one target with xml output 2020-05-19 23:57:16 +02:00
ede1afcce3 correct build dependencies for unit test 2020-05-19 21:50:43 +02:00
1239ae015a right ci camke dependencies for win and unix build 2020-05-19 21:29:36 +02:00
5271a25cbc use artifacts instead of cache 2020-05-19 21:13:53 +02:00
fb65ef98fa new gitlab ci for windows build
cmake- check if gtest is installed on build system
validate compiler after setting of compiler paths
2020-05-19 20:58:18 +02:00
Lukas-Heiligenbrunner
da53941cba
enable and start iprefresher service automatically after package installation (#18)
- dont terminate service if config not valid.
2020-05-19 16:35:57 +02:00
4344e7c118 added tabbed view
new config page with ability to edit config file
new features in config class - setting member variables
new button locations in gui
2020-05-19 16:23:00 +02:00
a356bca964 install config in other folder win 2020-05-18 19:46:19 +02:00
268aa3a1ad hide console window - windows gui
right windows gui dll dependencies
linux package qt dependencies for packaging
2020-05-18 17:18:41 +02:00
3be8203111 begin of gui implementations in cmake install script 2020-05-16 20:30:23 +02:00
b5b352f83d namespace for IPRefresher instead of class 2020-05-15 13:57:09 +02:00
3b32f60190 added return codes for IPrefresher refresh method.
error messages in gui.
2020-05-14 23:08:19 +02:00
0eea7095e0 added better thread management
cross compilation features.
2020-05-10 18:10:44 +02:00
ab772aac55 further gui developments 2020-05-10 15:00:51 +02:00
c25996a925 first qt gui steps 2020-05-09 23:08:23 +02:00
826386e849 define cached files globally/ including last test job 2020-05-08 17:28:19 +02:00
25f32dc4f4 cache whole project between jobs 2020-05-08 17:23:19 +02:00
2b863c6050 keep data between stages 2020-05-08 17:20:11 +02:00
a43b730b53 multistaging ci 2020-05-08 17:17:20 +02:00
309aefee2e added a build badge 2020-05-08 17:02:46 +02:00
713e7a1f95 everywhere same code header
reformatings
cdoc
2020-05-08 16:45:27 +02:00
12de026842 Update .gitlab-ci.yml 2020-05-07 18:08:31 +00:00
Lukas-Heiligenbrunner
463853dbd7
Unit test framework (#10)
* add first Unit Test
with gtest and cmake dependencies

* optionally build tests or not
added some realistic tests

* added ci compatible run configuration

* added test dependencies -lpthread -lm to work in debian correctly

* added some docs
and option infos
2020-05-07 19:58:16 +02:00
335bcf1259 wrong variable name 2020-05-07 16:19:59 +02:00
db4c71d7fe don't use find_package for libconfig, no default package in debian/libconfig installation 2020-05-07 16:17:47 +02:00
ba4af36df0 * new class for IP utils
* method to check telegram support out of config
* getters in Config.cpp
* lots of reformatings and cdoc
2020-05-07 14:54:40 +02:00
32 changed files with 1325 additions and 232 deletions

View File

@ -1,17 +1,68 @@
image: luki42/dynuiprefresher_build:latest
stages:
- build
- post
# Unix Build
build:
stage: build
image: luki42/dynuiprefresher_build:latest
script:
- cmake -S . -B build
- cmake -S . -B build -D WinBuild=OFF -D GUI=OFF
- cd build
- make dynuiprefresher
artifacts:
paths:
- build/bin/
build_package:
stage: post
image: luki42/dynuiprefresher_build:latest
script:
- cmake -S . -B build -D WinBuild=OFF -D GUI=OFF
- cd build
- make
- make package
artifacts:
paths:
- "build/bin/*"
- "build/packages/*"
- build/packages/
needs:
- build
test:
stage: post
image: luki42/dynuiprefresher_build:latest
script:
- cmake -S . -B build -D WinBuild=OFF -D GUI=OFF
- cd build
- make build-test
artifacts:
reports:
junit: build/*.xml
needs:
- build
# Windows Build
build_win64:
stage: build
image: luki42/dynuiprefresher_build:windows
script:
- cmake -S . -B build -D WinBuild=ON
- cd build
- make dynuiprefresher
artifacts:
paths:
- build/bin/
build_package_win64:
stage: post
image: luki42/dynuiprefresher_build:windows
script:
- cmake -S . -B build -D WinBuild=ON
- cd build
- make package
artifacts:
paths:
- build/packages/
needs:
- build_win64

View File

@ -5,20 +5,27 @@
## libcurl (with sources)
## libconfig (with sources)
#
# documenation build needs doxygen to be installed.
# for documenation build doxygen needs to be installed.
# for test build gtest needs 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)
project(dynuiprefresher DESCRIPTION "Dynu ip refresher" LANGUAGES)
SET(PROJECT_VERSION 1.3.4)
# CONFIGURATION
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(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
set(WinBuild false)
option(TESTS "Build Tests" ON) # additional dependencies for GTEST - to build tests
option(GUI "Build GUI elements" ON) # additional dependencies to QT libraries needed
option(WinBuild "cross compile for Windows Platform" ON)
# helper variables
SET(CMAKE_CXX_STANDARD 17)
string(TIMESTAMP TIMESTAMP_NOW "%d.%m.%Y")
SET(Application_Name "dynuiprefresher")
SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
@ -26,6 +33,7 @@ SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
# setup winbuild compilers
if (${WinBuild})
message(STATUS "setup Mingw Toolchain for cross compile.")
set(LIBSUFFIX .dll)
set(SUFFIX .exe)
@ -35,9 +43,9 @@ if (${WinBuild})
#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)
set(CMAKE_C_COMPILER /usr/bin/${TOOLCHAIN_PREFIX}-gcc)
set(CMAKE_CXX_COMPILER /usr/bin/${TOOLCHAIN_PREFIX}-g++)
set(CMAKE_RC_COMPILER /usr/bin/${TOOLCHAIN_PREFIX}-windres)
# target environment on the build host system
set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX})
@ -59,18 +67,31 @@ if (${WinBuild})
# 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")
# windows config path is in %appdata% folder of user
set(CONFIG_PATH "std::string(std::getenv(\"USERPROFILE\")) + \"\\\\AppData\\\\Roaming\\\\DynuIPrefresher\\\\\"")
# temp file is also stored in appdata folder
set(TempFilePath "std::string(std::getenv(\"USERPROFILE\")) + \"\\\\AppData\\\\Roaming\\\\DynuIPrefresher\\\\\"")
else ()
message(STATUS "using nativ gcc toolchain.")
set(LIBSUFFIX .so)
set(SUFFIX "")
# set /etc/ config path
set(CONFIG_PATH "/etc/iprefresher.cfg")
# set linux config path
set(CONFIG_PATH "\"/etc/\"")
# set path of temp file
set(TempFilePath "\"/var/tmp/\"")
endif ()
# test compiler settings and enable languages here
message("")
message(STATUS "Testing the C++ compiler!")
enable_language(CXX)
message("")
message(STATUS "Testing the C compiler!")
enable_language(C)
# config libs
message("")
message(STATUS "Config of Libraries")
# libcurl
if (${WinBuild})
@ -83,7 +104,7 @@ if (${WinBuild})
message(STATUS "Using CURL lib(s): ${CURL_LIBRARIES}")
message(STATUS "")
include_directories(${CURL_INCLUDE_DIRS} inc)
include_directories(${CURL_INCLUDE_DIRS})
# configure libconfig
FIND_PATH(LIBCONFIG++_INCLUDE_DIRS libconfig.h++ /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/include/) # search for libconfig include headers
@ -92,7 +113,11 @@ if (${WinBuild})
message(STATUS "Using LIBCONFIG++ include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
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 ()
include_directories(${LIBCONFIG++_INCLUDE_DIRS})
else ()
find_package(CURL REQUIRED)
if (CURL_INCLUDE_DIRS AND CURL_LIBRARIES)
@ -102,32 +127,63 @@ else ()
else ()
message(FATAL_ERROR "Could not find CURL")
endif ()
include_directories(${CURL_INCLUDE_DIR} inc)
include_directories(${CURL_INCLUDE_DIR})
message("")
# libconfig
FIND_PACKAGE(libconfig++ REQUIRED)
if (LIBCONFIG++_INCLUDE_DIRS AND LIBCONFIG++_LIBRARY_DIRS)
message(STATUS "Found libconfig version: ${LIBCONFIG++_VERSION}")
FIND_PATH(LIBCONFIG++_INCLUDE_DIRS
NAMES libconfig.h++
PATHS /usr/include /usr/local/include) # search for libconfig include headers
FIND_LIBRARY(LIBCONFIG++_LIBRARIES
NAMES config++
PATHS /usr/lib /usr/local/lib) # search for actual lib
if (LIBCONFIG++_INCLUDE_DIRS AND LIBCONFIG++_LIBRARIES)
message(STATUS "Fount libconfig!")
message(STATUS "Using libconfig include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
message(STATUS "Using libconfig lib(s): ${LIBCONFIG++_LIBRARY_DIRS}")
message(STATUS "Using libconfig lib(s): ${LIBCONFIG++_LIBRARIES}")
else ()
message(FATAL_ERROR "Could not find CURL")
message(FATAL_ERROR "Could not find LIBCONFIG")
endif ()
include_directories(${LIBCONFIG++_INCLUDE_DIRS} inc)
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 ()
include_directories(inc)
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
FILE(READ ${CMAKE_SOURCE_DIR}/config/dynuiprefresher.cfg SAMPLECONFIG)
#add StaticData header
FILE(WRITE ${CMAKE_SOURCE_DIR}/inc/StaticData.h
"/**
* StaticData header to store Version, Config dir and a Sample config
* Do not edit this file manually, it is generated by the cmake script!
*
* @author Lukas Heiligenbrunner
* @date ${TIMESTAMP_NOW}
*/
#pragma once
#include <string>
namespace Version {
namespace StaticData {
const std::string VERSION = \"${PROJECT_VERSION}\";
const std::string ConfigDir = \"${CONFIG_PATH}\";
const std::string TempFilePath = ${TempFilePath};
const std::string ConfigDir = ${CONFIG_PATH};
const std::string ConfName = \"${Application_Name}.cfg\";
const std::string SAMPLECONFIG = R\"(${SAMPLECONFIG})\";
}"
)
@ -138,49 +194,125 @@ add_library(api ${LIB_METHOD}
src/api/DynuAPI.cpp
src/api/IPAPI.cpp)
add_library(logger ${LIB_METHOD}
src/FileLogger.cpp
src/Logger.cpp)
SET(SOURCE
src/main.cpp
add_library(libdynuiprefresher ${LIB_METHOD}
src/IPRefresher.cpp
src/Config.cpp)
src/Config.cpp
src/IpHelper.cpp
src/FileLogger.cpp
src/Logger.cpp
)
add_executable(iprefresher ${SOURCE})
add_executable(${Application_Name} src/main.cpp)
# LINK generated LIBS #
target_link_libraries(iprefresher api logger ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
target_link_libraries(${Application_Name} libdynuiprefresher 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(${Application_Name}-gui
src/maingui.cpp
src/gui/MainWindow.cpp
inc/gui/MainWindow.h
${UI_GENERATED_HEADERS})
if (${WinBuild})
# hide console window when starting ui on windows
set_target_properties(${Application_Name}-gui PROPERTIES LINK_FLAGS "-mwindows")
endif ()
# LINK generated LIBS #
target_link_libraries(${Application_Name}-gui -lpthread libdynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES} ${QT5_LIBRARIES})
endif ()
# setting install targets
IF (NOT ${WinBuild})
# INSTALL to Linux SYSTEM #
# install binaries
install(TARGETS iprefresher DESTINATION usr/bin)
install(
TARGETS ${Application_Name}
DESTINATION usr/bin
COMPONENT ${Application_Name})
# install systemd service and enable it
install(FILES service/iprefresher.service DESTINATION lib/systemd/system)
install(
FILES service/${Application_Name}.service
DESTINATION lib/systemd/system
COMPONENT ${Application_Name})
if (${GUI})
# install binaries
install(
TARGETS ${Application_Name}-gui
DESTINATION usr/bin
COMPONENT ${Application_Name}gui)
endif ()
ELSE ()
# INSTALL to Windows SYSTEM #
# install binary to current folder
set_target_properties(iprefresher PROPERTIES SUFFIX ".exe")
install(TARGETS iprefresher DESTINATION .)
set_target_properties(${Application_Name} PROPERTIES SUFFIX ".exe")
install(
TARGETS ${Application_Name}
DESTINATION .
COMPONENT ${Application_Name})
# install .dll dependencies
# todo check if files exist...
SET(LIBBINARYPATH "/usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin")
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 .)
${LIBBINARYPATH}/libssh2-1.dll
${LIBBINARYPATH}/libstdc++-6.dll
${LIBBINARYPATH}/libgcc_s_seh-1.dll
${LIBBINARYPATH}/libcrypto-1_1-x64.dll
${LIBBINARYPATH}/libssl-1_1-x64.dll
${LIBBINARYPATH}/libwinpthread-1.dll
${LIBBINARYPATH}/zlib1.dll
${LIBBINARYPATH}/libidn2-0.dll
${LIBBINARYPATH}/libconfig++-11.dll
DESTINATION .
COMPONENT ${Application_Name})
if (${GUI})
# install binaries
set_target_properties(${Application_Name}-gui PROPERTIES SUFFIX ".exe")
install(
TARGETS ${Application_Name}-gui
DESTINATION .
COMPONENT ${Application_Name}gui)
# install .dll dependencies
install(FILES
${LIBBINARYPATH}/Qt5Widgets.dll
${LIBBINARYPATH}/Qt5Core.dll
${LIBBINARYPATH}/Qt5Gui.dll
${LIBBINARYPATH}/iconv.dll
${LIBBINARYPATH}/libpcre2-16-0.dll
${LIBBINARYPATH}/libpng16-16.dll
${LIBBINARYPATH}/libharfbuzz-0.dll
${LIBBINARYPATH}/libglib-2.0-0.dll
${LIBBINARYPATH}/libintl-8.dll
${LIBBINARYPATH}/libpcre-1.dll
${LIBBINARYPATH}/libbz2-1.dll
${LIBBINARYPATH}/libfreetype-6.dll
DESTINATION .
COMPONENT ${Application_Name}gui)
install(FILES
/usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib/qt5/plugins/platforms/qwindows.dll
DESTINATION ./platforms
COMPONENT ${Application_Name}gui)
endif ()
ENDIF ()
if (${PACKAGING})
@ -201,11 +333,15 @@ if (${PACKAGING})
# generate post script for checking if configuration already exists
FILE(WRITE ${CMAKE_SOURCE_DIR}/postinst
"#!/bin/bash
# Post installation script for linux packages
# do not edit this file manually, it is generated by the cmake script
if [ ! -f ${CONFIG_PATH} ]; then
cat > ${CONFIG_PATH} <<- EOM
${SAMPLECONFIG}EOM
fi\n"
)
fi
systemctl enable ${Application_Name}.service
systemctl restart ${Application_Name}.service")
SET(CPACK_DEB_COMPONENT_INSTALL 1)
@ -222,8 +358,19 @@ fi\n"
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_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
"/lib/systemd/system"
"/lib/systemd"
"/lib"
"/usr/local/bin"
"/usr/local") # --> not override existing folders
# dependency management tested with fedora!
set(CPACK_RPM_PACKAGE_REQUIRES "libcurl,libconfig")
if (${GUI})
# append rpm GUI dependencies (qt5)
set(CPACK_RPM_PACKAGE_REQUIRES "${CPACK_RPM_PACKAGE_REQUIRES},qt5-qtbase")
endif ()
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")
@ -233,7 +380,13 @@ fi\n"
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
# dependency management tested with fedora!
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libcurl4,libconfig++9v5") # add debian dependencies
if (${GUI})
# append debian GUI dependencies (qt5)
set(CPACK_DEBIAN_PACKAGE_DEPENDS "${CPACK_DEBIAN_PACKAGE_DEPENDS},qt5-default")
endif ()
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")
@ -248,17 +401,45 @@ fi\n"
set(CPACK_GENERATOR NSIS)
message(STATUS "Using NSIS Package build.")
set(CPACK_NSIS_testcomp_INSTALL_DIRECTORY /)
set(CPACK_NSIS_EXECUTABLES_DIRECTORY "DynuIpRefresher")
set(CPACK_PACKAGE_INSTALL_DIRECTORY "DynuIpRefresher")
SET(CPACK_NSIS_MODIFY_PATH ON)
set(CPACK_NSIS_MENU_LINKS
"${Application_Name}.exe" "DynuIpRefresher Console"
"${Application_Name}-gui.exe" "DynuIpRefresher GUI")
# varnames need uppercase strings
string(TOUPPER ${Application_Name} APPLICATION_NAME_UPPER)
# Define components and their display names
set (CPACK_COMPONENTS_ALL ${Application_Name} ${Application_Name}gui)
set (CPACK_COMPONENT_${APPLICATION_NAME_UPPER}_DISPLAY_NAME "Dynu IP Refresher Console")
set (CPACK_COMPONENT_${APPLICATION_NAME_UPPER}GUI_DISPLAY_NAME "Dynu IP Refresher GUI")
# Human readable component descriptions
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}_DESCRIPTION "An extremely useful application that makes use of MyLib")
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}GUI_DESCRIPTION "Static libraries used to build programs with MyLib")
# Define dependencies between components
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}GUI_DEPENDS ${Application_Name})
# Define groups
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}_GROUP "Runtime")
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}GUI_GROUP "Development")
set(CPACK_COMPONENT_GROUP_DEVELOPMENT_DESCRIPTION "All of the tools you'll ever need to develop software")
# Define NSIS installation types
set(CPACK_ALL_INSTALL_TYPES Full Developer)
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}_INSTALL_TYPES Developer Full)
set(CPACK_COMPONENT_${APPLICATION_NAME_UPPER}GUI_INSTALL_TYPES Full)
ENDIF ()
INCLUDE(CPack)
add_custom_target(build-packages
"${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target package
DEPENDS ${PROJECT_NAME}
COMMENT "Packing ${PROJECT_NAME}")
DEPENDS ${Application_Name}
COMMENT "Packing ${Application_Name}")
message("")
ENDIF ()
@ -285,4 +466,44 @@ if (BUILD_DOC)
message(STATUS "Doxygen need to be installed to generate the doxygen documentation")
endif (DOXYGEN_FOUND)
message("")
endif (BUILD_DOC)
endif (BUILD_DOC)
# Test Cases
if (TESTS)
# include(GoogleTest)
message(STATUS "Configuring GTEST")
find_package(GTest)
if (GTEST_FOUND)
mark_as_advanced(
BUILD_GMOCK BUILD_GTEST BUILD_SHARED_LIBS
gmock_build_tests gtest_build_samples gtest_build_tests
gtest_disable_pthreads gtest_force_shared_crt gtest_hide_internal_symbols
)
enable_testing()
macro(package_add_test TESTNAME)
# create an exectuable in which the tests will be stored
add_executable(${TESTNAME} ${ARGN})
# link the Google test infrastructure, mocking library, and a default main fuction to
target_link_libraries(${TESTNAME} gtest gtest_main -lpthread -lm api libdynuiprefresher ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
# see https://cmake.org/cmake/help/v3.10/module/GoogleTest.html for more options to pass to it
gtest_discover_tests(${TESTNAME})
add_custom_command(TARGET build-test
POST_BUILD
COMMAND "${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target ${TESTNAME}
COMMAND "bin/${TESTNAME}" --gtest_output=xml:${TESTNAME}-report.xml)
endmacro()
add_custom_target(build-test
DEPENDS ${PROJECT_NAME}
COMMENT "Testing ${PROJECT_NAME}")
package_add_test(test1 tests/UnitTest.cpp ${SOURCE})
else ()
message(STATUS "GTEST environment not found!")
endif ()
ENDIF ()

19
Docker/Linux/Dockerfile Normal file
View File

@ -0,0 +1,19 @@
FROM gcc:latest
MAINTAINER luki42
RUN \
\
# Install texlive
echo "instaling cmake" && \
apt-get update && \
apt-get install -y --no-install-recommends cmake libgtest-dev && \
echo "installing build dependencies" && \
apt-get install -y --no-install-recommends libcurl4-openssl-dev libconfig++-dev && \
echo "installing packaging tools" && \
apt-get install -y --no-install-recommends dpkg rpm && \
# clean up
apt-get clean
# Expose /home as workin dir
WORKDIR /home
VOLUME ["/home"]

20
Docker/Windows/Dockerfile Normal file
View File

@ -0,0 +1,20 @@
FROM fedora:33
MAINTAINER luki42
RUN \
\
# Install texlive
echo "instaling cmake" && \
dnf install -y mingw64-gcc-c++ mingw64-curl-static mingw64-qt5-qtbase wget cmake make tar xz mingw32-nsis gtest gtest-devel && \
wget http://repo.msys2.org/mingw/x86_64/mingw-w64-x86_64-libconfig-1.7.2-1-any.pkg.tar.xz && \
tar -xf mingw-w64-x86_64-libconfig-1.7.2-1-any.pkg.tar.xz && \
mv ./mingw64/bin/* /usr/x86_64-w64-mingw32/sys-root/mingw/bin && \
mv ./mingw64/include/* /usr/x86_64-w64-mingw32/sys-root/mingw/include && \
mv ./mingw64/lib/*.a /usr/x86_64-w64-mingw32/sys-root/mingw/lib && \
mv ./mingw64/lib/cmake/* /usr/x86_64-w64-mingw32/sys-root/mingw/lib/cmake && \
rm -Rv mingw-w64-x86_64-libconfig-1.7.2-1-any.pkg.tar.xz mingw64 && \
#cleanup
dnf clean dbcache && dnf clean packages
# Expose /home as workin dir
WORKDIR /home
VOLUME ["/home"]

View File

@ -1,6 +1,8 @@
[![pipeline status](http://gitlab.heili.eu/lukas/dynuiprefresher/badges/master/pipeline.svg)](http://gitlab.heili.eu/lukas/dynuiprefresher/-/commits/master)
# 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.
There is also a GUI for Windows Users and beginners.
## Installation
Download the latest Release at [Release_Page](https://github.com/Lukas-Heiligenbrunner/DynuIPRefresher/releases).
@ -8,11 +10,38 @@ 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.
There is a configuration file `/etc/dynuiprefresher.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`
`systemctl enable dynuiprefresher.service` and `systemctl start dynuiprefresher.service`
## Usage
First of all configure the right keys in the `/etc/dynuiprefresher.cfg` or `%appdata%\DynuIpRefresher\dynuiprefresher.cfg` config file.
Afterwards use the following options:
```
help page:
[-h] [--help] print this help page
[-v] [--version] print the software version
[-f] [--force] force refresh of ip
[-l] [--loop] infinite loop to refresh ip every five minutes
[-c] [--checkconfig] validate configuration
[-ip] [--currentip] get current global ip
[no argument] normal ip check and refresh
```
### GUI
You can also build the grapical user inteface if you want.
There you can manually trigger a refresh in a gui and set all the config parameters.
Home Page:
![couldn't load image](https://i.ibb.co/syDwWQg/Screenshot-20200608-104253.png)
Config Page:
![couldn't load image](https://i.ibb.co/89vnJXY/Screenshot-20200608-104308.png)
## Build
@ -68,6 +97,10 @@ cd into downloaded files and Generate makefiles:
`make package`
### GUI Build
please use the predefined Docker-Image here:
[DockerHub](https://hub.docker.com/repository/docker/luki42/dynuiprefresher_build)
### Windows cross build
@ -82,5 +115,7 @@ 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.
The Simplest way to install all dependencies is the preconfigured Docker-Image:
[DockerHub](https://hub.docker.com/repository/docker/luki42/dynuiprefresher_build)
`make package` will pack it into a NSIS installer for Windows.

View File

@ -1,6 +1,9 @@
//
// Created by lukas on 11.02.20.
//
/**
* A static class to manage the configuration file, read/write parameters to it.
*
* @author Lukas Heiligenbrunner
* @date 11.02.2020
*/
#pragma once
@ -8,20 +11,19 @@
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 readConfig();
/**
* read configuration out of config file
* save back configuration to file
*
* @return success of config read
* @return success of config write
*/
static bool readCredentials();
static bool saveConfig();
/**
* validate config file
@ -30,5 +32,82 @@ public:
*/
static bool validateConfig();
/**
* check if telegram credentials in config are set
* @return is supported?
*/
static bool isTelegramSupported();
/** Getters **/
/**
* encapsulated getter for DynuApiKey
* @return api key
*/
static const std::string &getDynuapikey();
/**
* encapsulated getter for DomainId
* @return DomainId
*/
static const std::string &getDomainid();
/**
* encapsulated getter for Domainname
* @return Domainname
*/
static const std::string &getDomainname();
/**
* encapsulated getter for TelegramApiKey
* @return TelegramApiKey
*/
static const std::string &getTelegramApiKey();
/**
* encapsulated getter for ChatId
* @return ChatId
*/
static const std::string &getChatId();
/**
* set all parameters without telegram support
*
* @param domainname Dynu Domain name
* @param dynuapikey Dynu api key
* @param domainid Dynu domain id
*/
static void setValues(const std::string &domainname, const std::string &dynuapikey, const std::string &domainid);
/**
* set all parameters with telegram support
*
* @param domainname Dynu Domain name
* @param dynuapikey Dynu api key
* @param domainid Dynu domain id
* @param telegramApiKey Telegram api key
* @param chatId Telegram chat id
*/
static void setValues(const std::string &domainname, const std::string &dynuapikey, const std::string &domainid,
const std::string &telegramApiKey, const std::string &chatId);
private:
/**
* private constructor --> don't allow instance of this class
*/
Config() = default;
/**
* helper variable for managing telegram Support
*/
static bool telegramSupport;
/**
* helper variables for storing keys and ids
*/
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;
};

View File

@ -1,6 +1,9 @@
//
// Created by lukas on 05.05.19.
//
/**
* Read and write current ip to a temp file to remember last ip until restart
*
* @author Lukas Heiligenbrunner
* @date 05.05.2019
*/
#pragma once

View File

@ -1,25 +1,33 @@
//
// Created by lukas on 02.08.19.
//
/**
* IPrefresher library
* - start checking ip once
* - or in loop mode
*
* @author Lukas Heiligenbrunner
* @date 06.04.2019
*/
#pragma once
class IPRefresher {
public:
namespace IPRefresher {
/**
* 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);
/**
* default constructor
*/
IPRefresher();
bool checkIPAdress(bool force);
/**
* 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);
}

22
inc/IpHelper.h Normal file
View File

@ -0,0 +1,22 @@
/**
* A helper class for general IP String actions
*
* @author Lukas Heiligenbrunner
* @date 07.05.2020
*/
#pragma once
#include <string>
class IpHelper {
public:
/**
* check if ip is valid
* @param ip ip address to test
* @return validity
*/
static bool isIpValid(const std::string& ip);
private:
};

View File

@ -1,6 +1,10 @@
//
// Created by lukas on 26.10.19.
//
/**
* Fancy console log output format
* todo log level support
*
* @author Lukas Heiligenbrunner
* @date 26.10.2019
*/
#pragma once

View File

@ -1,6 +1,11 @@
//
// Created by lukas on 06.04.19.
//
/**
* API class
* - manages all curl download stuff
* - easy POST/GET requests
*
* @author Lukas Heiligenbrunner
* @date 06.04.2019
*/
#pragma once
@ -25,7 +30,10 @@ public:
* @param headers header fields
* @return return string of server
*/
std::string request(std::string myurl, bool post, Hashmap<std::string, std::string> &map, std::vector<std::string> &headers);
std::string request(std::string myurl,
bool post,
Hashmap<std::string, std::string> &map,
std::vector<std::string> &headers);
private:
static size_t write_data(void *buffer, size_t size, size_t buffersize, FILE *stream);

View File

@ -1,19 +1,22 @@
//
// Created by lukas on 18.06.19.
//
/**
* Dynu API - Refresh the IP
*
* @author Lukas Heiligenbrunner
* @date 18.06.2019
*/
#pragma once
#include "API.h"
class DynuAPI : API{
class DynuAPI : API {
public:
/**
* refresh the ip of domain on Dynu server
* @param ip new ip
* @return request status
*/
int refreshIp(std::string ip);
bool refreshIp(std::string ip);
/**
* init Telegram api with apikey and chatid
@ -21,10 +24,21 @@ public:
* @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
void init(const std::string &dynuApiKey, const std::string &domainId, const std::string &domainName);
std::string domainid; //id of the dynu domain
private:
/**
* Dynu API Key
*/
std::string dynuapikey;
/**
* Dynu Domain ID
*/
std::string domainid;
/**
* Domain name eg. "mydomain.dynu.net"
*/
std::string domainname;
};

View File

@ -1,6 +1,9 @@
//
// Created by lukas on 07.04.19.
//
/**
* A Hashmap class for easier Key-Value maps
*
* @author Lukas Heiligenbrunner
* @date 07.04.2019
*/
#pragma once

View File

@ -1,6 +1,9 @@
//
// Created by lukas on 18.06.19.
//
/**
* IPAPI for getting global ip of current network
*
* @author Lukas Heiligenbrunner
* @date 18.06.2019
*/
#pragma once
@ -8,7 +11,7 @@
#include <string>
class IPAPI : API{
class IPAPI : API {
public:
/**
* get global ip of current internet connection

View File

@ -1,6 +1,9 @@
//
// Created by lukas on 08.05.19.
//
/**
* Telegram API for sending message to specific chat
*
* @author Lukas Heiligenbrunner
* @date 08.05.2019
*/
#pragma once
@ -14,7 +17,7 @@ public:
* send telegram Message to predefined destination
* @param text message
*/
int sendMessage(const std::string& text);
int sendMessage(const std::string &text);
/**
* init Telegram api with apikey and chatid

63
inc/gui/MainWindow.h Normal file
View File

@ -0,0 +1,63 @@
/**
* 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;
/**
* all static initializations of custom gui elements
*/
void initGui();
private slots:
/**
* executed click handler for config button
*/
void checkConfigBtn();
/**
* executed click handler for refresh btn
*/
void refreshIPBtn();
/**
* executed click handler for save config btn
*/
void saveConfigBtn();
signals:
/**
* append a String line to the Log field
*
* @param QString string to be appended
*/
void appendLogField(QString);
};

View File

@ -2,7 +2,7 @@
Description=IP Refresher
After=network.target
[Service]
ExecStart=iprefresher -l
ExecStart=dynuiprefresher -l
WorkingDirectory=/root
StandardOutput=inherit
StandardError=inherit

View File

@ -1,15 +1,12 @@
//
// Created by lukas on 11.02.20.
//
#include "Config.h"
#include "Logger.h"
#include "Version.h"
#include "StaticData.h"
#include <iostream>
#include <cstring>
#include <fstream>
#include <libconfig.h++>
#include <sys/stat.h>
std::string Config::dynuapikey;
std::string Config::domainid; //id of the dynu domain
@ -18,22 +15,49 @@ std::string Config::domainname;
std::string Config::telegramApiKey;
std::string Config::chatId;
bool Config::readCredentials() {
bool Config::telegramSupport;
bool Config::readConfig() {
libconfig::Config cfg;
try {
// todo make dynamic here
cfg.readFile(Version::ConfigDir.c_str());
cfg.readFile(std::string(StaticData::ConfigDir + StaticData::ConfName).c_str());
}
catch (const libconfig::FileIOException &fioex) {
std::cout << "I/O error while reading config file." << std::endl << "creating new config file!" << std::endl;
// check if config folder exists
struct stat info{};
if (stat(StaticData::ConfigDir.c_str(), &info) != 0) {
Logger::warning("The config folder doesn't exist. Trying to create it.");
// mkdir command is different defined for windows
#ifdef __unix
int check = mkdir(StaticData::ConfigDir.c_str(), 777);
#else
int check = mkdir(StaticData::ConfigDir.c_str());
#endif
// check if directory is created or not
if (!check)
Logger::message("config directory successfully created. ");
else
Logger::error("unable to create config directory.");
} else if (info.st_mode & S_IFDIR) {
Logger::debug("config directory exists already");
} else {
Logger::error("A file exists with the same name as the config dir should be");
}
std::ofstream myfile;
myfile.open(Version::ConfigDir);
myfile.open(StaticData::ConfigDir + StaticData::ConfName);
if (myfile.is_open()) {
myfile << Version::SAMPLECONFIG;
myfile << StaticData::SAMPLECONFIG;
myfile.close();
} else {
std::cout << "error creating file" << std::endl;
Logger::error("error creating file");
}
return false;
@ -52,22 +76,31 @@ bool Config::readCredentials() {
// optional parameters
telegramApiKey = (std::string) cfg.lookup("telegramApiKey");
chatId = (std::string) cfg.lookup("chatId");
telegramSupport = true;
}
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;
} else {
Logger::message("no Telegram support - fields in config not set");
telegramSupport = false;
}
}
// check if needed values aren't empty
return !(Config::dynuapikey.empty() || Config::domainid.empty() || Config::domainname.empty());
}
bool Config::saveConfig() {
// todo save config
return false;
}
bool Config::validateConfig() {
libconfig::Config cfg;
try {
Logger::message("reading config file");
cfg.readFile(Version::ConfigDir.c_str());
cfg.readFile(std::string(StaticData::ConfigDir + StaticData::ConfName).c_str());
}
catch (const libconfig::FileIOException &fioex) {
Logger::warning("config file doesn't exist or permission denied!");
@ -83,27 +116,67 @@ bool Config::validateConfig() {
try {
// needed parameters
if (((std::string) cfg.lookup("dynuapikey")).empty()) {
Logger::warning("required parameter dynuapikey seems to be 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.");
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.");
Logger::warning("required parameter \"domainname\" seems to be empty.");
return false;
}
// optional parameters
cfg.lookup("telegramApiKey");
cfg.lookup("chatId");
telegramSupport = true;
}
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;
} else {
Logger::message("no Telegram support - fields in config not set");
telegramSupport = false;
}
}
return true;
}
}
bool Config::isTelegramSupported() {
return telegramSupport;
}
const std::string &Config::getDynuapikey() {
return dynuapikey;
}
const std::string &Config::getDomainid() {
return domainid;
}
const std::string &Config::getDomainname() {
return domainname;
}
const std::string &Config::getTelegramApiKey() {
return telegramApiKey;
}
const std::string &Config::getChatId() {
return chatId;
}
void Config::setValues(const std::string &domainname, const std::string &dynuapikey, const std::string &domainid) {
Config::domainname = domainname;
Config::dynuapikey = dynuapikey;
Config::domainid = domainid;
}
void Config::setValues(const std::string &domainname, const std::string &dynuapikey, const std::string &domainid, const std::string &telegramApiKey, const std::string &chatId) {
setValues(domainname, dynuapikey, domainid);
Config::telegramApiKey = telegramApiKey;
Config::chatId = chatId;
}

View File

@ -1,16 +1,13 @@
//
// Created by lukas on 05.05.19.
//
#include "FileLogger.h"
#include "IpHelper.h"
#include "StaticData.h"
#include <fstream>
#include <iostream>
#include <climits>
void FileLogger::safeip(std::string ip) {
std::ofstream out;
out.open("ip.txt", std::ios::out);
out.open(StaticData::TempFilePath + "temp-dynuiprefresher.txt", std::ios::out);
out << ip;
@ -19,15 +16,12 @@ void FileLogger::safeip(std::string ip) {
std::string FileLogger::readip() {
std::ifstream in;
in.open("ip.txt", std::ios::in);
in.open(StaticData::TempFilePath + "temp-dynuiprefresher.txt", std::ios::in);
std::string ip;
in >> ip;
// when received ip has no : return 0.0.0.0
if (ip.find(':') == ULONG_MAX)
return "0.0.0.0";
else
return ip;
// when received ip has no . return 0.0.0.0
return (IpHelper::isIpValid(ip) ? ip : "0.0.0.0");
}

View File

@ -1,22 +1,17 @@
//
// 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 "StaticData.h"
#include "IpHelper.h"
#include <string>
#include <chrono>
#include <thread>
#include <Logger.h>
#include <climits>
void IPRefresher::checkIPAdress(bool force) {
bool IPRefresher::checkIPAdress(bool force) {
FileLogger logger;
IPAPI ipapi;
@ -25,48 +20,52 @@ void IPRefresher::checkIPAdress(bool force) {
if (ip.empty()) {
//no internet connection (or other error)
Logger::warning("no internet connection");
} else if (ip.find(':') == ULONG_MAX) {
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);
DynuAPI dynu;
dynu.init(Config::dynuapikey, Config::domainid, Config::domainname);
dynu.init(Config::getDynuapikey(), Config::getDomainid(), Config::getDomainname());
// actual refresh of IP in api - here
bool result = dynu.refreshIp(ip);
if (dynu.refreshIp(ip)) {
if (result && Config::isTelegramSupported()) {
TelegramAPI tele;
tele.init(Config::telegramApiKey, Config::chatId);
tele.init(Config::getTelegramApiKey(), Config::getChatId());
tele.sendMessage(oldip + " moved to " + ip);
} else {
} 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() = default;
void IPRefresher::startUpService(int interval) {
Logger::message("startup of service");
Logger::message("Version: " + StaticData::VERSION);
IPRefresher::IPRefresher(bool loop) {
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));
}
while (true) {
Logger::message("starting check");
if (Config::readConfig()) {
checkIPAdress(false);
} else {
std::cout << "incorrect credentials!" << std::endl;
}
std::this_thread::sleep_for(std::chrono::milliseconds(interval * 1000));
}
}

7
src/IpHelper.cpp Normal file
View File

@ -0,0 +1,7 @@
#include <regex>
#include "IpHelper.h"
bool IpHelper::isIpValid(const std::string& ip) {
const std::regex rgx(R"(^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$)");
return (std::regex_match(ip, rgx));
}

View File

@ -1,7 +1,3 @@
//
// Created by lukas on 26.10.19.
//
#include "Logger.h"
#include <sstream>

View File

@ -1,7 +1,3 @@
//
// Created by lukas on 06.04.19.
//
#include "api/API.h"
#include <sstream>

View File

@ -1,10 +1,6 @@
//
// Created by lukas on 18.06.19.
//
#include "api/DynuAPI.h"
int DynuAPI::refreshIp(std:: string ip) {
bool DynuAPI::refreshIp(std::string ip) {
Hashmap<std::string, std::string> args;
args.add("name", domainname);
args.add("ipv4Address", ip);
@ -16,15 +12,11 @@ int DynuAPI::refreshIp(std:: string ip) {
const std::string dynurepl = request("https://api.dynu.com/v2/dns/" + domainid, true, args, headers);
if (dynurepl != "{\"statusCode\":200}") {
return -1;
} else {
return 1;
}
return (dynurepl == "{\"statusCode\":200}");
}
void DynuAPI::init(const std::string& dynuApiKey, const std::string& domainId, const std::string& domainName) {
this->dynuapikey=dynuApiKey;
this->domainid=domainId;
this->domainname=domainName;
void DynuAPI::init(const std::string &dynuApiKey, const std::string &domainId, const std::string &domainName) {
this->dynuapikey = dynuApiKey;
this->domainid = domainId;
this->domainname = domainName;
}

View File

@ -1,9 +1,11 @@
//
// Created by lukas on 18.06.19.
//
#include <IpHelper.h>
#include <Logger.h>
#include "api/IPAPI.h"
std::string IPAPI::getGlobalIp() {
return request("https://api.ipify.org");
}
const std::string ip = request("https://api.ipify.org");
if(!IpHelper::isIpValid(ip))
Logger::warning("no valid ip returned from ipapi");
return ip;
}

View File

@ -1,13 +1,7 @@
//
// Created by lukas on 08.05.19.
//
#include "api/TelegramAPI.h"
#include "Logger.h"
#include <climits>
int TelegramAPI::sendMessage(const std::string& text) {
int TelegramAPI::sendMessage(const std::string &text) {
Hashmap<std::string, std::string> args;
args.add("chat_id", chatid);
args.add("text", text);
@ -16,8 +10,8 @@ int TelegramAPI::sendMessage(const std::string& text) {
std::string reply = request("https://api.telegram.org/bot" + apikey + "/sendmessage", false, args, headers);
if (reply.find("\"error_code\"") != ULONG_MAX) {
Logger::error("failed to refresh the ip (Dynu API)");
if (reply.find("\"error_code\"") != SIZE_MAX) {
Logger::error("failed to send the Telegram Message");
return -1;
}
return 1;

129
src/gui/MainWindow.cpp Normal file
View File

@ -0,0 +1,129 @@
#include "inc/gui/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);
// initialize gui with start parameters
initGui();
connect(ui->buttonCheckConfig, SIGNAL(clicked()), this, SLOT(checkConfigBtn()));
connect(ui->buttonRefreshIP, SIGNAL(clicked()), this, SLOT(refreshIPBtn()));
connect(ui->buttonSaveConfig, SIGNAL(clicked()), this, SLOT(saveConfigBtn()));
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);
this->destroy();
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.");
});
}
void MainWindow::saveConfigBtn() {
if (ui->telegramsupportCheckbox->isChecked()) {
Config::setValues(
ui->domainnameedit->text().toStdString(),
ui->dynuapikeyedit->text().toStdString(),
ui->domainidedit->text().toStdString(),
ui->telegramapikeyedit->text().toStdString(),
ui->chatidedit->text().toStdString());
} else {
Config::setValues(
ui->domainnameedit->text().toStdString(),
ui->dynuapikeyedit->text().toStdString(),
ui->domainidedit->text().toStdString());
}
Config::saveConfig();
}
void MainWindow::initGui() {
// needs to be defined with new -- would be termintated after the constructor call.
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");
if (Config::readConfig()) {
ui->dynuapikeyedit->setText(Config::getDynuapikey().c_str());
ui->domainidedit->setText(Config::getDomainid().c_str());
ui->domainnameedit->setText(Config::getDomainname().c_str());
if (Config::isTelegramSupported()) {
ui->telegramsupportCheckbox->setCheckState(Qt::Checked);
ui->telegramapikeyedit->setText(Config::getTelegramApiKey().c_str());
ui->chatidedit->setText(Config::getChatId().c_str());
} else {
ui->telegramsupportCheckbox->setCheckState(Qt::Unchecked);
ui->telegramapikeyedit->setDisabled(true);
ui->chatidedit->setDisabled(true);
}
} else {
// todo duplicate code with above
ui->telegramsupportCheckbox->setCheckState(Qt::Unchecked);
ui->telegramapikeyedit->setDisabled(true);
ui->chatidedit->setDisabled(true);
}
}

320
src/gui/mainwindow.ui Normal file
View File

@ -0,0 +1,320 @@
<?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="cursor">
<cursorShape>ArrowCursor</cursorShape>
</property>
<property name="windowTitle">
<string>MainWindow</string>
</property>
<property name="styleSheet">
<string notr="true">/*background-color: rgb(69, 196, 255);</string>
</property>
<widget class="QWidget" name="centralwidget">
<widget class="QPlainTextEdit" name="textLog">
<property name="enabled">
<bool>false</bool>
</property>
<property name="geometry">
<rect>
<x>40</x>
<y>410</y>
<width>741</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="QTabWidget" name="tabWidget">
<property name="geometry">
<rect>
<x>40</x>
<y>20</y>
<width>741</width>
<height>351</height>
</rect>
</property>
<property name="currentIndex">
<number>0</number>
</property>
<widget class="QWidget" name="basic">
<attribute name="title">
<string>Basic</string>
</attribute>
<widget class="QLabel" name="labelCurrentIP">
<property name="geometry">
<rect>
<x>20</x>
<y>30</y>
<width>301</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Your current global IP:</string>
</property>
</widget>
<widget class="QLabel" name="labelConfig">
<property name="geometry">
<rect>
<x>20</x>
<y>70</y>
<width>141</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Config is: undefined</string>
</property>
</widget>
<widget class="QGroupBox" name="groupBox">
<property name="geometry">
<rect>
<x>20</x>
<y>120</y>
<width>231</width>
<height>151</height>
</rect>
</property>
<property name="title">
<string>Actions</string>
</property>
<widget class="QPushButton" name="buttonCheckConfig">
<property name="geometry">
<rect>
<x>30</x>
<y>50</y>
<width>91</width>
<height>33</height>
</rect>
</property>
<property name="cursor">
<cursorShape>ArrowCursor</cursorShape>
</property>
<property name="text">
<string>Check Config</string>
</property>
</widget>
<widget class="QPushButton" name="buttonRefreshIP">
<property name="geometry">
<rect>
<x>30</x>
<y>100</y>
<width>91</width>
<height>33</height>
</rect>
</property>
<property name="text">
<string>Refresh IP</string>
</property>
</widget>
</widget>
</widget>
<widget class="QWidget" name="config">
<attribute name="title">
<string>Config</string>
</attribute>
<widget class="QCheckBox" name="telegramsupportCheckbox">
<property name="geometry">
<rect>
<x>30</x>
<y>120</y>
<width>181</width>
<height>21</height>
</rect>
</property>
<property name="text">
<string>Telegram Notifications</string>
</property>
</widget>
<widget class="QPushButton" name="buttonSaveConfig">
<property name="geometry">
<rect>
<x>630</x>
<y>270</y>
<width>91</width>
<height>33</height>
</rect>
</property>
<property name="text">
<string>Save Config</string>
</property>
</widget>
<widget class="QLabel" name="label">
<property name="geometry">
<rect>
<x>30</x>
<y>20</y>
<width>101</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Dynu API Key</string>
</property>
</widget>
<widget class="QLabel" name="label_3">
<property name="geometry">
<rect>
<x>460</x>
<y>20</y>
<width>111</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Domain ID</string>
</property>
</widget>
<widget class="QLabel" name="label_4">
<property name="geometry">
<rect>
<x>30</x>
<y>170</y>
<width>131</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Telegram API Key</string>
</property>
</widget>
<widget class="QLabel" name="label_5">
<property name="geometry">
<rect>
<x>30</x>
<y>240</y>
<width>64</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Chat ID</string>
</property>
</widget>
<widget class="QLineEdit" name="dynuapikeyedit">
<property name="geometry">
<rect>
<x>30</x>
<y>40</y>
<width>211</width>
<height>31</height>
</rect>
</property>
</widget>
<widget class="QLineEdit" name="domainidedit">
<property name="geometry">
<rect>
<x>460</x>
<y>40</y>
<width>113</width>
<height>31</height>
</rect>
</property>
</widget>
<widget class="QLineEdit" name="chatidedit">
<property name="geometry">
<rect>
<x>30</x>
<y>260</y>
<width>113</width>
<height>31</height>
</rect>
</property>
</widget>
<widget class="QLineEdit" name="telegramapikeyedit">
<property name="geometry">
<rect>
<x>30</x>
<y>190</y>
<width>311</width>
<height>31</height>
</rect>
</property>
</widget>
<widget class="QLineEdit" name="domainnameedit">
<property name="geometry">
<rect>
<x>280</x>
<y>40</y>
<width>161</width>
<height>31</height>
</rect>
</property>
<property name="placeholderText">
<string>domain.dynu.net</string>
</property>
</widget>
<widget class="QLabel" name="label_6">
<property name="geometry">
<rect>
<x>280</x>
<y>20</y>
<width>111</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Domainname</string>
</property>
</widget>
</widget>
<widget class="QWidget" name="settings">
<attribute name="title">
<string>Settings</string>
</attribute>
<widget class="QLabel" name="label_7">
<property name="geometry">
<rect>
<x>20</x>
<y>30</y>
<width>161</width>
<height>17</height>
</rect>
</property>
<property name="text">
<string>Select your language:</string>
</property>
</widget>
<widget class="QComboBox" name="languageComboBox">
<property name="geometry">
<rect>
<x>20</x>
<y>60</y>
<width>94</width>
<height>31</height>
</rect>
</property>
</widget>
</widget>
</widget>
</widget>
<widget class="QStatusBar" name="statusbar"/>
</widget>
<resources/>
<connections/>
</ui>

View File

@ -1,15 +1,9 @@
//
// Created by lukas on 18.06.19.
//
#include "Version.h"
#include "StaticData.h"
#include "IPRefresher.h"
#include "Logger.h"
#include "Config.h"
#include "api/IPAPI.h"
#include <iostream>
/**
* application entry point
*/
@ -25,22 +19,21 @@ int main(int argc, char *argv[]) {
<< "[-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;
std::cout << "Version " << StaticData::VERSION << std::endl;
} else if (firstarg == "-f" || firstarg == "--force") {
IPRefresher ipr;
if (Config::readCredentials()) {
ipr.checkIPAdress(true);
if (Config::readConfig()) {
IPRefresher::checkIPAdress(true);
} else {
std::cout << "incorrect credentials!" << std::endl;
}
} else if (firstarg == "-l" || firstarg == "--loop") {
IPRefresher(true);
IPRefresher::startUpService(600);
} else if (firstarg == "-c" || firstarg == "--checkconfig") {
if (Config::validateConfig()) {
Logger::message("Config file is OK");
} else {
Logger::warning("There are errors in config file!");
Logger::error("There are errors in config file!");
return -1;
}
} else if (firstarg == "-ip" || firstarg == "--currentip") {
@ -50,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::readCredentials()) {
ipr.checkIPAdress(false);
if (Config::readConfig()) {
IPRefresher::checkIPAdress(false);
} else {
std::cout << "incorrect credentials!" << std::endl;
}

14
src/maingui.cpp Normal file
View File

@ -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("Dynu IP Refresher");
w.show();
return QApplication::exec();
}

29
tests/UnitTest.cpp Normal file
View File

@ -0,0 +1,29 @@
//
// Created by lukas on 06.05.20.
//
#include <FileLogger.h>
#include <api/IPAPI.h>
#include "gtest/gtest.h"
/**
* Test if default ip is 0.0.0.0 when last ip file doesn't exist.
*/
TEST(ReadIp, testzeroIpIfNotExists) {
FileLogger logger;
std::string oldip = logger.readip();
ASSERT_EQ(oldip, "0.0.0.0");
}
/**
* Test if default ip is 0.0.0.0 when last ip file doesn't exist.
*/
TEST(IPAPI, testIpAPIcheckIPSyntax) {
IPAPI ipapi;
std::string ip = ipapi.getGlobalIp();
if (ip.find('.') == SIZE_MAX) {
// error when ip doesn't contain a .
ASSERT_TRUE(false);
} else {
ASSERT_TRUE(true);
}
}