V2024.6.2

Author: nlogozzo

CMakeLists.txt

@@ -20,7 +20,7 @@ endif()
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
 
 #libnick Definition
-project ("libnick" LANGUAGES C CXX VERSION 2024.6.1 DESCRIPTION "A cross-platform base for native Nickvision applications.")
+project ("libnick" LANGUAGES C CXX VERSION 2024.6.2 DESCRIPTION "A cross-platform base for native Nickvision applications.")
 include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)
 include(CTest)

docs/update.md

@@ -24,17 +24,12 @@ Path: `Nickvision::Update::Updater`
      - Accepts: The url of a GitHub repo to check for updates, githubRepoUrl.
      - Throws: `std::invalid_argument` if the GitHub url is not of valid format
 - ```cpp
-  Nickvision::Version fetchCurrentStableVersion()
+  Nickvision::Version fetchCurrentVersion(VersionType type)
   ``` 
-    - Returns: The latest stable Version found in the repo.
+    - Accepts: The type of version to fetch, type.
+    - Returns: The latest Version of type found in the repo.
     - Returns: An empty version on error.
     - Note: This method scans the tags of the repo and parses versions in the format `major.minor.build`.
-- ```cpp
-  Nickvision::Version fetchCurrentPreviewVersion()
-  ``` 
-    - Returns: The latest preview (dev) Version found in the repo.
-    - Returns: An empty version on error.
-    - Note: This method scans the tags of the repo and parses versions in the format `major.minor.build-dev`.
 - ```cpp
   bool windowsUpdate(VersionType versionType)
   ``` 

include/update/updater.h

@@ -30,18 +30,16 @@ namespace Nickvision::Update
          */
         Updater(Updater&& u) noexcept;
         /**
-         * @brief Gets the latest stable version from the GitHub repo.
-         * @return The current stable version if available, else empty Version
-         */
-        Version fetchCurrentStableVersion();
-        /**
-         * @brief Gets the latest preview version from the GitHub repo.
-         * @return The current preview version if available, else empty Version
+         * @brief Gets the latest version of the provided type from the GitHub repo.
+         * @brief This method looks for tags in the format major.minor.build-dev for preview versions and major.minor.build for stable versions.
+         * @param versionType The type of the version to get
+         * @return The current version of the provided type if available, else empty Version
          */
-        Version fetchCurrentPreviewVersion();
+        Version fetchCurrentVersion(VersionType versionType);
 #ifdef _WIN32
         /**
-         * @brief Downloads and installs an application update for Windows. getCurrentStableVersion or getCurrentPreviewVersion should be called first before running this method. This method will force quit the current running application to install the update.
+         * @brief Downloads and installs an application update for Windows. 
+         * @brief fetchCurrentVersion should be called first before running this method.
          * @param versionType The type of version update to install
          * @return True if successful, else false
          */
@@ -61,12 +59,6 @@ namespace Nickvision::Update
         Updater& operator=(Updater&& u) noexcept;
 
     private:
-        /**
-         * @brief Gets the latest version of the provided type from the GitHub repo
-         * @param versionType The type of the version to get
-         * @return The current version of the proivded type if available, else empty Version
-         */
-        Version fetchCurrentVersion(VersionType versionType);
         mutable std::mutex m_mutex;
         std::string m_repoOwner;
         std::string m_repoName;

src/update/updater.cpp

@@ -55,14 +55,37 @@ namespace Nickvision::Update
         m_latestPreviewReleaseId = std::move(u.m_latestPreviewReleaseId);
     }
 
-    Version Updater::fetchCurrentStableVersion()
-    {
-        return fetchCurrentVersion(VersionType::Stable);
-    }
-
-    Version Updater::fetchCurrentPreviewVersion()
+    Version Updater::fetchCurrentVersion(VersionType versionType)
     {
-        return fetchCurrentVersion(VersionType::Preview);
+        std::lock_guard<std::mutex> lock{ m_mutex };
+        std::string releases{ WebHelpers::fetchJsonString("https://api.github.com/repos/" + m_repoOwner + "/" + m_repoName + "/releases") };
+        if (!releases.empty())
+        {
+            Json::Value root;
+            Json::Reader reader;
+            if (reader.parse(releases, root, false))
+            {
+                for (const Json::Value& release : root)
+                {
+                    std::string version{ release.get("tag_name", "NULL").asString() };
+                    if (version == "NULL")
+                    {
+                        return {};
+                    }
+                    if (versionType == VersionType::Stable && version.find('-') == std::string::npos)
+                    {
+                        m_latestStableReleaseId = release.get("id", -1).asInt();
+                        return version;
+                    }
+                    if (versionType == VersionType::Preview && version.find('-') != std::string::npos)
+                    {
+                        m_latestPreviewReleaseId = release.get("id", -1).asInt();
+                        return version;
+                    }
+                }
+            }
+        }
+        return {};
     }
 
 #ifdef _WIN32
@@ -85,17 +108,16 @@ namespace Nickvision::Update
                     std::string name{ asset.get("name", "").asString() };
                     if (StringHelpers::toLower(name).find("setup.exe") != std::string::npos)
                     {
-                        std::filesystem::path setup{ UserDirectories::getApplicationCache() / name };
-                        if (WebHelpers::downloadFile(asset.get("browser_download_url", "").asString(), setup))
+                        std::filesystem::path setupPath{ UserDirectories::getCache() / name };
+                        std::wstring quotedSetupPath{ L"\"" + setupPath.wstring() + L"\""};
+                        if (WebHelpers::downloadFile(asset.get("browser_download_url", "").asString(), setupPath))
                         {
-                            std::wstring cmd{ L"\"" + setup.wstring() + L"\"" };
-                            if ((INT_PTR)ShellExecuteW(nullptr, L"open", cmd.c_str(), nullptr, nullptr, SW_SHOWDEFAULT) > 32)
+                            if ((INT_PTR)ShellExecuteW(nullptr, L"open", quotedSetupPath.c_str(), nullptr, nullptr, SW_SHOWDEFAULT) > 32)
                             {
-                                std::exit(0);
                                 return true;
                             }
-                            return false;
                         }
+                        return false;
                     }
                 }
             }
@@ -131,37 +153,4 @@ namespace Nickvision::Update
         }
         return *this;
     }
-
-    Version Updater::fetchCurrentVersion(VersionType versionType)
-    {
-        std::lock_guard<std::mutex> lock{ m_mutex };
-        std::string releases{ WebHelpers::fetchJsonString("https://api.github.com/repos/" + m_repoOwner + "/" + m_repoName + "/releases") };
-        if (!releases.empty())
-        {
-            Json::Value root;
-            Json::Reader reader;
-            if (reader.parse(releases, root, false))
-            {
-                for (const Json::Value& release : root)
-                {
-                    std::string version{ release.get("tag_name", "NULL").asString() };
-                    if (version == "NULL")
-                    {
-                        return {};
-                    }
-                    if (versionType == VersionType::Stable && version.find('-') == std::string::npos)
-                    {
-                        m_latestStableReleaseId = release.get("id", -1).asInt();
-                        return version;
-                    }
-                    if (versionType == VersionType::Preview && version.find('-') != std::string::npos)
-                    {
-                        m_latestPreviewReleaseId = release.get("id", -1).asInt();
-                        return version;
-                    }
-                }
-            }
-        }
-        return {};
-    }
 }

tests/updatertests.cpp

@@ -7,7 +7,7 @@ using namespace Nickvision::Update;
 TEST(UpdaterTests, ParabolicStableUpdate)
 {
     Updater updater{ "https://github.com/NickvisionApps/Parabolic" };
-    Version stable{ updater.fetchCurrentStableVersion() };
+    Version stable{ updater.fetchCurrentVersion(VersionType::Stable) };
     ASSERT_TRUE(!stable.empty());
     ASSERT_TRUE(stable.getVersionType() == VersionType::Stable);
     ASSERT_TRUE(stable >= Version("2023.12.0"));