Cleanup CMakeFiles prior to release

* Remove Git revision finding code in favor of a simple command call: git rev-parse --short=7 HEAD
* Added GIT_HEAD_OVERRIDE to explicitly define the hash for the current commit in case git is not available 
* Made WIX default over NSIS in release tool 
* Rename version.h to git-info.h

CMakeLists.txt

@@ -84,11 +84,25 @@ set(KEEPASSXC_VERSION "${KEEPASSXC_VERSION_MAJOR}.${KEEPASSXC_VERSION_MINOR}.${K
 set(KEEPASSXC_BUILD_TYPE "Snapshot" CACHE STRING "Set KeePassXC build type to distinguish between stable releases and snapshots")
 set_property(CACHE KEEPASSXC_BUILD_TYPE PROPERTY STRINGS Snapshot Release PreRelease)
 
+# Retrieve git HEAD revision hash
+set(GIT_HEAD_OVERRIDE "" CACHE STRING "Manually set the Git HEAD hash when missing (eg, when no .git folder exists)")
+execute_process(COMMAND git rev-parse --short=7 HEAD
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        OUTPUT_VARIABLE GIT_HEAD
+        ERROR_QUIET)
+string(STRIP "${GIT_HEAD}" GIT_HEAD)
+if(GIT_HEAD STREQUAL "")
+    string(SUBSTRING "${GIT_HEAD_OVERRIDE}" 0 7 GIT_HEAD)
+endif()
+message(STATUS "Found Git HEAD Revision: ${GIT_HEAD}\n")
+
 # Check if on a tag, if so build as a release
 execute_process(COMMAND git tag --points-at HEAD
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-        OUTPUT_VARIABLE GIT_TAG)
+        OUTPUT_VARIABLE GIT_TAG
+        ERROR_QUIET)
 if(GIT_TAG)
+    string(STRIP "${GIT_TAG}" GIT_TAG)
     set(OVERRIDE_VERSION ${GIT_TAG})
 elseif(EXISTS ${CMAKE_SOURCE_DIR}/.version)
     file(READ ${CMAKE_SOURCE_DIR}/.version OVERRIDE_VERSION)

cmake/GenerateProductVersion.cmake

@@ -91,7 +91,7 @@ function(generate_product_version outfiles)
         set(PRODUCT_COMPANY_COPYRIGHT "Copyright (C) ${PRODUCT_CURRENT_YEAR} ${PRODUCT_COMPANY_NAME}")
     endif()
     if (NOT PRODUCT_COMMENTS OR "${PRODUCT_COMMENTS}" STREQUAL "")
-        set(PRODUCT_COMMENTS "${PRODUCT_NAME} v${PRODUCT_VERSION_MAJOR}.${PRODUCT_VERSION_MINOR}")
+        set(PRODUCT_COMMENTS "${PRODUCT_NAME} v${PRODUCT_VERSION_MAJOR}.${PRODUCT_VERSION_MINOR}.${PRODUCT_VERSION_PATCH}")
     endif()
     if (NOT PRODUCT_ORIGINAL_FILENAME OR "${PRODUCT_ORIGINAL_FILENAME}" STREQUAL "")
         set(PRODUCT_ORIGINAL_FILENAME "${PRODUCT_NAME}")

release-tool

@@ -35,7 +35,7 @@ TAG_NAME=""
 DOCKER_IMAGE=""
 DOCKER_CONTAINER_NAME="keepassxc-build-container"
 CMAKE_OPTIONS=""
-CPACK_GENERATORS="NSIS;ZIP"
+CPACK_GENERATORS="WIX;ZIP"
 COMPILER="g++"
 MAKE_OPTIONS="-j8"
 BUILD_PLUGINS="all"

src/CMakeLists.txt

@@ -17,15 +17,7 @@
 include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
 
 configure_file(config-keepassx.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-keepassx.h)
-
-include(GetGitRevisionDescription)
-get_git_head_revision(GIT_REFSPEC GIT_HEAD)
-git_describe(GIT_DESCRIBE --long)
-
-if(NOT GIT_HEAD OR NOT GIT_DESCRIBE)
-    set(GIT_HEAD "")
-    set(GIT_DESCRIBE "")
-endif()
+configure_file(git-info.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/git-info.h)
 
 find_library(ZXCVBN_LIBRARIES zxcvbn)
 if(NOT ZXCVBN_LIBRARIES)
@@ -34,8 +26,6 @@ if(NOT ZXCVBN_LIBRARIES)
     set(ZXCVBN_LIBRARIES zxcvbn)
 endif(NOT ZXCVBN_LIBRARIES)
 
-configure_file(version.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/version.h @ONLY)
-
 set(keepassx_SOURCES
         core/AutoTypeAssociations.cpp
         core/AutoTypeMatch.cpp
@@ -380,7 +370,7 @@ if(MINGW)
 
     string(REGEX REPLACE "-snapshot$" "" KEEPASSXC_VERSION_CLEAN ${KEEPASSXC_VERSION})
 
-    set(CPACK_GENERATOR "ZIP;NSIS")
+    set(CPACK_GENERATOR "ZIP;WIX")
     set(CPACK_STRIP_FILES OFF)
     set(CPACK_PACKAGE_FILE_NAME "${PROGNAME}-${KEEPASSXC_VERSION}-${OUTPUT_FILE_POSTFIX}")
     set(CPACK_PACKAGE_INSTALL_DIRECTORY ${PROGNAME})
@@ -414,9 +404,7 @@ if(MINGW)
     set(CPACK_WIX_EXTENSIONS "WixUtilExtension.dll")
     include(CPack)
 
-    install(CODE "
-    set(gp_tool \"objdump\")
-    " COMPONENT Runtime)
+    install(CODE "set(gp_tool \"objdump\")" COMPONENT Runtime)
 
     include(DeployQt4)
     install_qt4_executable(${PROGNAME}.exe)

src/browser/BrowserAction.cpp

@@ -20,9 +20,10 @@
 #include "BrowserSettings.h"
 #include "NativeMessagingBase.h"
 #include "config-keepassx.h"
-#include "sodium.h"
-#include "sodium/crypto_box.h"
-#include "sodium/randombytes.h"
+
+#include <sodium.h>
+#include <sodium/crypto_box.h>
+#include <sodium/randombytes.h>
 #include <QJsonDocument>
 #include <QJsonParseError>
 

src/git-info.h.cmake

@@ -0,0 +1,8 @@
+/* git-info.h. Generated by cmake from git-info.h.cmake */
+
+#ifndef KEEPASSXC_GIT_INFO_H
+#define KEEPASSXC_GIT_INFO_H
+
+#define GIT_HEAD "@GIT_HEAD@"
+
+#endif // KEEPASSXC_GIT_INFO_H

src/gui/AboutDialog.cpp

@@ -20,9 +20,9 @@
 #include "ui_AboutDialog.h"
 
 #include "config-keepassx.h"
+#include "git-info.h"
 #include "core/FilePath.h"
 #include "crypto/Crypto.h"
-#include "version.h"
 
 #include <QClipboard>
 #include <QSysInfo>
@@ -47,8 +47,6 @@ AboutDialog::AboutDialog(QWidget* parent)
     QString commitHash;
     if (!QString(GIT_HEAD).isEmpty()) {
         commitHash = GIT_HEAD;
-    } else if (!QString(DIST_HASH).contains("Format")) {
-        commitHash = DIST_HASH;
     }
 
     QString debugInfo = "KeePassXC - ";

src/gui/CloneDialog.cpp

@@ -24,7 +24,6 @@
 #include "core/FilePath.h"
 #include "crypto/Crypto.h"
 #include "gui/DatabaseWidget.h"
-#include "version.h"
 
 CloneDialog::CloneDialog(DatabaseWidget* parent, Database* db, Entry* entry)
     : QDialog(parent)