UpdateCheckAPI 2.1.0 release

PLohrmannAMD · PLohrmannAMD · commit e8d1e1a1672f · 2022-12-15T15:42:02.000-08:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,7 +6,7 @@
 # code that other projects can include, it is not a buildable project on its
 # own.
 
-cmake_minimum_required (VERSION 3.0)
+cmake_minimum_required (VERSION 3.10)
 
 # Root to the UpdateCheckApi directory.
 set (UPDATECHECKAPI_DIR ${CMAKE_CURRENT_SOURCE_DIR})
diff --git a/README.md b/README.md
@@ -1,28 +1,28 @@
 # UpdateCheckAPI
-
 The UpdateCheckAPI repository provides utility source code for AMD Tools to check for new releases available through GitHub's Release API. The code also provides a Qt-based dialog that can be used to display the results of the check for updates.
 
 ## Usage:
-
 Projects that want to utilize UpdateCheckAPI can do so using CMake's add_subdirectory(<path to UpdateCheckAPI>) command. UpdateCheckAPI contains a CMakeLists.txt which defines several other cached variables that identify the various files that are necessary to use UpdateCheckAPI:
-
 * UPDATECHECKAPI_SRC (source files)
 * UPDATECHECKAPI_INC (header files)
 * UPDATECHECKAPI_INC_DIRS (additional include directories)
 * UPDATECHECKAPI_LIBS (required libraries)
 * UPDATECHECKAPI_LIB_DIRS (additional library directories)
 
 Additional CMake variables are also defined to utilize the Qt widgets:
-
 * UPDATECHECKAPI_QT_SRC (source files which reference Qt components)
 * UPDATECHECKAPI_QT_INC (header files which reference Qt components)
 * UPDATECHECKAPI_QT_UI (ui files for the new widgets)
 
-Also, the UpdateCheckAPI utilizes an executabled named rtda to download files from the internet. This needs to copied into the applications working directory. To simplify copying the executable, its platform-specific path is cached in the CMake variable:
-
+Also, the UpdateCheckAPI utilizes an executable named rtda to download files from the internet. This needs to copied into the application's working directory. To simplify copying the executable, its platform-specific path is cached in the CMake variable:
 * RTDA_PATH (Path to the platform-specific rtda executable)
 
 ## Release Notes:
+Version 2.1.0
+* An optional PackageName tag has been added to the DownloadLinks which allows for customizing the text that will appear in the UI in place of the package type.
+* RTDA now has a --version cmd line option to report both the RTDA and UpdateCheckAPI version numbers.
+* Add RTDA binaries to git lfs.
+
 Version 2.0.1
 * Fix the close button on Update Check Results dialog.
 
@@ -40,3 +40,4 @@ Version 1.0.1
 
 Version 1.0
 * Initial release
+
diff --git a/rtda/.gitattributes b/rtda/.gitattributes
@@ -0,0 +1,3 @@
+windows/rtda.exe filter=lfs diff=lfs merge=lfs -text
+linux/rtda filter=lfs diff=lfs merge=lfs -text
+macos/rtda filter=lfs diff=lfs merge=lfs -text
diff --git a/rtda/CMakeLists.txt b/rtda/CMakeLists.txt
@@ -3,7 +3,7 @@
 #=================================================================
 # CMakeList.txt : CMake project to compile radeon_tools_download_assistant.go
 #
-cmake_minimum_required(VERSION 2.8.11)
+cmake_minimum_required(VERSION 3.10)
 
 # Make a target that other projects can add as a dependency.
 add_custom_target(rtda)
diff --git a/rtda/README.txt b/rtda/README.txt
@@ -1,14 +1,16 @@
 #=================================================================
-# Copyright 2018-2020 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright 2018-2022 Advanced Micro Devices, Inc. All rights reserved.
 #=================================================================
 In order to build this project:
 
 1) Download and install the Go tools from here: https://golang.org/doc/install
-2) Make any changes to the radeon_tools_download_assistant.go file.
-3) cd into the rtda directory.
-4) Compile it with the command: "go build"
+2) Update rtda.rc if there needs to be an updated version number.
+2b) If on Windows, run generate_syso.bat. This will convert the rtda.rc file into a versioninfo.syso file that will automatically get embedded in the resulting executable so that the file properties in Windows are properly filled in.
+3) Make any changes to the radeon_tools_download_assistant.go file.
+4) cd into the rtda directory.
+5) Compile it with the command: "go build"
    * If there are compiler errors, they will be printed.
    * If the compilation is successful, nothing will get printed.
-5) You should find an updated rtda.exe in the local directory.
+6) You should find an updated rtda.exe in the local directory. Make sure to run it manually from the command line to ensure it works properly. If you get an "access is denied" error, there may be coding errors that are preventing it from running properly.
 
 NOTE: The name of the compiled binary file is automatically selected from the project directory, not the source files, so in order to change the generated binary filename, the project directory name must also change.
diff --git a/rtda/linux/rtda b/rtda/linux/rtda
diff --git a/rtda/macos/rtda b/rtda/macos/rtda
diff --git a/rtda/radeon_tools_download_assistant.go b/rtda/radeon_tools_download_assistant.go
@@ -8,9 +8,19 @@ import (
     "os"
 )
 
+var rtda_version = "1.0.1"
+var update_check_api_version = "2.1.0"
+
 func main() {
 
     argCount := len(os.Args[1:])
+
+    if (argCount == 1 && os.Args[1] == "--version") {
+        fmt.Printf("RTDA version: %s\n", rtda_version)
+        fmt.Printf("UpdateCheckAPI version: %s\n", update_check_api_version)
+	os.Exit(0)
+    }
+
     if (argCount != 2) {
         fmt.Printf("Usage: rtda url local_path\n")
         fmt.Printf("\turl - The url to the file to download\n")
diff --git a/rtda/rtda.rc b/rtda/rtda.rc
@@ -1,6 +1,6 @@
 1 VERSIONINFO
-FILEVERSION     1,0,0,0
-PRODUCTVERSION  1,0,0,0
+FILEVERSION     1,0,1,0
+PRODUCTVERSION  1,0,1,0
 FILEFLAGSMASK   0X3FL
 FILEFLAGS       0L
 FILEOS          0X40004L
@@ -14,9 +14,9 @@ BEGIN
             VALUE "CompanyName", "Advanced Micro Devices, Inc."
             VALUE "FileDescription", "Radeon Tools Download Assistant"
             VALUE "OriginalFilename", "rtda" ".exe"
-            VALUE "LegalCopyright", "Copyright (C) 2018-2020 Advanced Micro Devices, Inc. All rights reserved."
+            VALUE "LegalCopyright", "Copyright (C) 2018-2021 Advanced Micro Devices, Inc. All rights reserved."
             VALUE "ProductName", "Radeon Tools Download Assistant"
-            VALUE "ProductVersion", "1.0.0.0"
+            VALUE "ProductVersion", "1.0.1.0"
         END
     END
     BLOCK "VarFileInfo"
diff --git a/rtda/windows/rtda.exe b/rtda/windows/rtda.exe
diff --git a/source/third_party/json-3.9.1/json.hpp b/source/third_party/json-3.9.1/json.hpp
@@ -2682,7 +2682,6 @@ template<typename T>
 using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
 
 // implementation of C++14 index_sequence and affiliates
-// source: https://stackoverflow.com/a/32223343
 template<std::size_t... Ints>
 struct index_sequence
 {
@@ -3107,8 +3106,6 @@ struct is_iterator_traits<iterator_traits<T>>
         is_detected<reference_t, traits>::value;
 };
 
-// source: https://stackoverflow.com/a/37193089/4116453
-
 template<typename T, typename = void>
 struct is_complete_type : std::false_type {};
 
@@ -7675,8 +7672,6 @@ enum class cbor_tag_handler_t
 @brief determine system byte order
 
 @return true if and only if system's byte order is little endian
-
-@note from https://stackoverflow.com/a/1001328/266378
 */
 static inline bool little_endianess(int num = 1) noexcept
 {
@@ -16642,10 +16637,6 @@ and `from_json()` (@ref adl_serializer by default)
 - If `m_type == value_t::string`, then `m_value.string != nullptr`.
 The invariants are checked by member function assert_invariant().
 
-@internal
-@note ObjectType trick from https://stackoverflow.com/a/9860911
-@endinternal
-
 @see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange
 Format](http://rfc7159.net/rfc7159)
 
diff --git a/source/update_check_api.cpp b/source/update_check_api.cpp
@@ -1319,6 +1319,7 @@ static bool ParseJsonSchema_1_6(json& json_doc, UpdateInfo& update_info, std::st
                         {
                             auto url_iter          = download_link_iter->find(DOWNLOADLINKS_URL);
                             auto package_type_iter = download_link_iter->find(DOWNLOADLINKS_PACKAGETYPE);
+                            auto package_name_iter = download_link_iter->find(DOWNLOADLINKS_PACKAGENAME);
                             if (url_iter == download_link_iter->end())
                             {
                                 is_parsed = false;
@@ -1341,7 +1342,15 @@ static bool ParseJsonSchema_1_6(json& json_doc, UpdateInfo& update_info, std::st
                                 }
                                 else
                                 {
+                                    // Extract the url.
                                     download_link.url = (*download_link_iter)[DOWNLOADLINKS_URL].get<std::string>();
+
+                                    // Extract the package name.
+                                    if (package_name_iter != download_link_iter->end())
+                                    {
+                                        download_link.package_name = package_name_iter->get<std::string>();
+                                    }
+
                                     release_info.download_links.push_back(download_link);
                                 }
                             }
diff --git a/source/update_check_api.h b/source/update_check_api.h
@@ -1,5 +1,5 @@
 //==============================================================================
-/// Copyright (c) 2018-2020 Advanced Micro Devices, Inc. All rights reserved.
+/// Copyright (c) 2018-2022 Advanced Micro Devices, Inc. All rights reserved.
 /// \author AMD Developer Tools Team
 /// \file
 /// \brief An interface to allow applications to check for updated versions.
@@ -12,7 +12,7 @@
 
 // Versioning information of the UpdateCheckAPI.
 #define UPDATECHECKAPI_MAJOR 2
-#define UPDATECHECKAPI_MINOR 0
+#define UPDATECHECKAPI_MINOR 1
 #define UPDATECHECKAPI_PATCH 0
 #define UPDATECHECKAPI_BUILD 0
 
@@ -99,6 +99,9 @@ namespace UpdateCheck
 
         /// A value describing the kind of archive/installer that url points to.
         PackageType package_type;
+
+        /// A value describing the name of the package.
+        std::string package_name;
     };
 
     /// A structure containing all the data pertaining to a specific release.
diff --git a/source/update_check_api_strings.h b/source/update_check_api_strings.h
@@ -30,6 +30,7 @@ const char* const kStringJsonFileExtension = ".json";
 #define RELEASETAGS "ReleaseTags"
 #define RELEASETITLE "ReleaseTitle"
 #define RELEASETYPE "ReleaseType"
+#define DOWNLOADLINKS_PACKAGENAME "PackageName"
 
 // JSON tags related to schema 1.5
 #define RELEASEVERSION "ReleaseVersion"
diff --git a/source/update_check_results_dialog.cpp b/source/update_check_results_dialog.cpp
@@ -127,7 +127,15 @@ void UpdateCheckResultsDialog::SetResults(const UpdateCheck::UpdateInfo& update_
                         update_result_html.append(kStringHtmlAHrefEndTitleStart);
                         update_result_html.append(iter->url.c_str());
                         update_result_html.append(kStringHtmlAHrefEndTitleEnd);
-                        update_result_html.append(UpdateCheck::PackageTypeToString(iter->package_type).c_str());
+
+                        // If the package_name is not blank, use the package name.
+                        std::string value = UpdateCheck::PackageTypeToString(iter->package_type).c_str();
+                        if (!iter->package_name.empty())
+                        {
+                            value = iter->package_name;
+                        }
+                        update_result_html.append(value.c_str());
+
                         update_result_html.append(kStringHtmlAClose);
                         update_result_html.append("]");
                     }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+windows/rtda.exe filter=lfs diff=lfs merge=lfs -text`
	`2`	`+linux/rtda filter=lfs diff=lfs merge=lfs -text`
	`3`	`+macos/rtda filter=lfs diff=lfs merge=lfs -text`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`#=================================================================`
`4`	`4`	`# CMakeList.txt : CMake project to compile radeon_tools_download_assistant.go`
`5`	`5`	`#`
`6`		`-cmake_minimum_required(VERSION 2.8.11)`
	`6`	`+cmake_minimum_required(VERSION 3.10)`
`7`	`7`
`8`	`8`	`# Make a target that other projects can add as a dependency.`
`9`	`9`	`add_custom_target(rtda)`