Merge pull request #6546 from spycrab/updater_ui

Implement Updater UI

Source/Core/Common/HttpRequest.cpp

@@ -6,9 +6,10 @@
 
 #include <chrono>
 #include <cstddef>
-#include <curl/curl.h>
 #include <mutex>
 
+#include <curl/curl.h>
+
 #include "Common/Logging/Log.h"
 #include "Common/ScopeGuard.h"
 #include "Common/StringUtil.h"
@@ -24,23 +25,27 @@ class HttpRequest::Impl final
     POST,
   };
 
-  explicit Impl(std::chrono::milliseconds timeout_ms);
+  explicit Impl(std::chrono::milliseconds timeout_ms, ProgressCallback callback);
 
   bool IsValid() const;
   Response Fetch(const std::string& url, Method method, const Headers& headers, const u8* payload,
                  size_t size);
 
+  static int CurlProgressCallback(Impl* impl, double dlnow, double dltotal, double ulnow,
+                                  double ultotal);
+
 private:
   static std::mutex s_curl_was_inited_mutex;
   static bool s_curl_was_inited;
+  ProgressCallback m_callback;
   std::unique_ptr<CURL, decltype(&curl_easy_cleanup)> m_curl{nullptr, curl_easy_cleanup};
 };
 
 std::mutex HttpRequest::Impl::s_curl_was_inited_mutex;
 bool HttpRequest::Impl::s_curl_was_inited = false;
 
-HttpRequest::HttpRequest(std::chrono::milliseconds timeout_ms)
-    : m_impl(std::make_unique<Impl>(timeout_ms))
+HttpRequest::HttpRequest(std::chrono::milliseconds timeout_ms, ProgressCallback callback)
+    : m_impl(std::make_unique<Impl>(timeout_ms, callback))
 {
 }
 
@@ -69,7 +74,15 @@ HttpRequest::Response HttpRequest::Post(const std::string& url, const std::strin
                        reinterpret_cast<const u8*>(payload.data()), payload.size());
 }
 
-HttpRequest::Impl::Impl(std::chrono::milliseconds timeout_ms)
+int HttpRequest::Impl::CurlProgressCallback(Impl* impl, double dlnow, double dltotal, double ulnow,
+                                            double ultotal)
+{
+  // Abort if callback isn't true
+  return !impl->m_callback(dlnow, dltotal, ulnow, ultotal);
+}
+
+HttpRequest::Impl::Impl(std::chrono::milliseconds timeout_ms, ProgressCallback callback)
+    : m_callback(callback)
 {
   {
     std::lock_guard<std::mutex> lk(s_curl_was_inited_mutex);
@@ -84,6 +97,14 @@ HttpRequest::Impl::Impl(std::chrono::milliseconds timeout_ms)
   if (!m_curl)
     return;
 
+  curl_easy_setopt(m_curl.get(), CURLOPT_NOPROGRESS, m_callback == nullptr);
+
+  if (m_callback)
+  {
+    curl_easy_setopt(m_curl.get(), CURLOPT_PROGRESSDATA, this);
+    curl_easy_setopt(m_curl.get(), CURLOPT_PROGRESSFUNCTION, CurlProgressCallback);
+  }
+
   // libcurl may not have been built with async DNS support, so we disable
   // signal handlers to avoid a possible and likely crash if a resolve times out.
   curl_easy_setopt(m_curl.get(), CURLOPT_NOSIGNAL, true);
@@ -99,7 +120,7 @@ bool HttpRequest::Impl::IsValid() const
   return m_curl != nullptr;
 }
 
-static size_t CurlCallback(char* data, size_t size, size_t nmemb, void* userdata)
+static size_t CurlWriteCallback(char* data, size_t size, size_t nmemb, void* userdata)
 {
   auto* buffer = static_cast<std::vector<u8>*>(userdata);
   const size_t actual_size = size * nmemb;
@@ -133,7 +154,7 @@ HttpRequest::Response HttpRequest::Impl::Fetch(const std::string& url, Method me
   curl_easy_setopt(m_curl.get(), CURLOPT_HTTPHEADER, list);
 
   std::vector<u8> buffer;
-  curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, CurlCallback);
+  curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, CurlWriteCallback);
   curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, &buffer);
 
   const char* type = method == Method::POST ? "POST" : "GET";

Source/Core/Common/HttpRequest.h

@@ -5,6 +5,7 @@
 #pragma once
 
 #include <chrono>
+#include <functional>
 #include <map>
 #include <memory>
 #include <optional>
@@ -18,7 +19,12 @@ namespace Common
 class HttpRequest final
 {
 public:
-  explicit HttpRequest(std::chrono::milliseconds timeout_ms = std::chrono::milliseconds{3000});
+  // Return false to abort the request
+  using ProgressCallback =
+      std::function<bool(double dlnow, double dltotal, double ulnow, double ultotal)>;
+
+  explicit HttpRequest(std::chrono::milliseconds timeout_ms = std::chrono::milliseconds{3000},
+                       ProgressCallback callback = nullptr);
   ~HttpRequest();
   bool IsValid() const;
 

Source/Core/Updater/Main.cpp

@@ -14,6 +14,7 @@
 #include <mbedtls/sha256.h>
 #include <optional>
 #include <shellapi.h>
+#include <thread>
 #include <vector>
 #include <zlib.h>
 
@@ -23,6 +24,8 @@
 #include "Common/HttpRequest.h"
 #include "Common/StringUtil.h"
 
+#include "Updater/UI.h"
+
 namespace
 {
 // Public key used to verify update manifests.
@@ -286,6 +289,7 @@ std::optional<Manifest> ParseManifest(const std::string& manifest)
   return parsed;
 }
 
+// Not showing a progress bar here because this part is just too quick
 std::optional<Manifest> FetchAndParseManifest(const std::string& url)
 {
   Common::HttpRequest http;
@@ -336,7 +340,12 @@ std::optional<Manifest> FetchAndParseManifest(const std::string& url)
 // Represent the operations to be performed by the updater.
 struct TodoList
 {
-  std::vector<Manifest::Hash> to_download;
+  struct DownloadOp
+  {
+    Manifest::Filename filename;
+    Manifest::Hash hash;
+  };
+  std::vector<DownloadOp> to_download;
 
   struct UpdateOp
   {
@@ -405,7 +414,11 @@ TodoList ComputeActionsToDo(Manifest this_manifest, Manifest next_manifest)
 
     if (!old_hash || *old_hash != entry.second)
     {
-      todo.to_download.push_back(entry.second);
+      TodoList::DownloadOp download;
+      download.filename = entry.first;
+      download.hash = entry.second;
+
+      todo.to_download.push_back(std::move(download));
 
       TodoList::UpdateOp update;
       update.filename = entry.first;
@@ -454,8 +467,8 @@ std::optional<std::string> FindOrCreateTempDir(const std::string& base_path)
 void CleanUpTempDir(const std::string& temp_dir, const TodoList& todo)
 {
   // This is best-effort cleanup, we ignore most errors.
-  for (const auto& hash : todo.to_download)
-    File::Delete(temp_dir + DIR_SEP + HexEncode(hash.data(), hash.size()));
+  for (const auto& download : todo.to_download)
+    File::Delete(temp_dir + DIR_SEP + HexEncode(download.hash.data(), download.hash.size()));
   File::DeleteDir(temp_dir);
 }
 
@@ -469,13 +482,25 @@ Manifest::Hash ComputeHash(const std::string& contents)
   return out;
 }
 
-bool DownloadContent(const std::vector<Manifest::Hash>& to_download,
+bool ProgressCallback(double total, double now, double, double)
+{
+  UI::SetProgress(static_cast<int>(now), static_cast<int>(total));
+  return true;
+}
+
+bool DownloadContent(const std::vector<TodoList::DownloadOp>& to_download,
                      const std::string& content_base_url, const std::string& temp_path)
 {
-  Common::HttpRequest req(std::chrono::seconds(30));
-  for (const auto& h : to_download)
+  Common::HttpRequest req(std::chrono::seconds(30), ProgressCallback);
+
+  for (size_t i = 0; i < to_download.size(); i++)
   {
-    std::string hash_filename = HexEncode(h.data(), h.size());
+    auto& download = to_download[i];
+
+    std::string hash_filename = HexEncode(download.hash.data(), download.hash.size());
+    UI::SetDescription("Downloading " + download.filename + "... (File " + std::to_string(i + 1) +
+                       " of " + std::to_string(to_download.size()) + ")");
+    UI::SetMarquee(false);
 
     // Add slashes where needed.
     std::string content_store_path = hash_filename;
@@ -484,10 +509,14 @@ bool DownloadContent(const std::vector<Manifest::Hash>& to_download,
 
     std::string url = content_base_url + content_store_path;
     fprintf(log_fp, "Downloading %s ...\n", url.c_str());
+
     auto resp = req.Get(url);
     if (!resp)
       return false;
 
+    UI::SetMarquee(true);
+    UI::SetDescription("Verifying " + download.filename + "...");
+
     std::string contents(reinterpret_cast<char*>(resp->data()), resp->size());
     std::optional<std::string> maybe_decompressed = GzipInflate(contents);
     if (!maybe_decompressed)
@@ -496,7 +525,7 @@ bool DownloadContent(const std::vector<Manifest::Hash>& to_download,
 
     // Check that the downloaded contents have the right hash.
     Manifest::Hash contents_hash = ComputeHash(decompressed);
-    if (contents_hash != h)
+    if (contents_hash != download.hash)
     {
       fprintf(log_fp, "Wrong hash on downloaded content %s.\n", url.c_str());
       return false;
@@ -631,9 +660,11 @@ void FatalError(const std::string& message)
   MessageBox(nullptr,
              (L"A fatal error occured and the updater cannot continue:\n " + wide_message).c_str(),
              L"Error", MB_ICONERROR);
+
   fprintf(log_fp, "%s\n", message.c_str());
-}
 
+  UI::Stop();
+}
 }  // namespace
 
 int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine, int nCmdShow)
@@ -671,6 +702,11 @@ int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine
     fprintf(log_fp, "Completed! Proceeding with update.\n");
   }
 
+  std::thread thread(UI::MessageLoop);
+  thread.detach();
+
+  UI::SetDescription("Fetching and parsing manifests...");
+
   Manifest this_manifest, next_manifest;
   {
     std::optional<Manifest> maybe_manifest = FetchAndParseManifest(opts.this_manifest_url);
@@ -690,6 +726,8 @@ int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine
     next_manifest = std::move(*maybe_manifest);
   }
 
+  UI::SetDescription("Computing what to do...");
+
   TodoList todo = ComputeActionsToDo(this_manifest, next_manifest);
   todo.Log();
 
@@ -698,16 +736,29 @@ int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine
     return 1;
   std::string temp_dir = std::move(*maybe_temp_dir);
 
+  UI::SetDescription("Performing Update...");
+
   bool ok = PerformUpdate(todo, opts.install_base_path, opts.content_store_url, temp_dir);
   if (!ok)
     FatalError("Failed to apply the update.");
 
   CleanUpTempDir(temp_dir, todo);
 
+  UI::ResetProgress();
+  UI::SetMarquee(false);
+  UI::SetProgress(100, 100);
+  UI::SetDescription("Done!");
+
+  // Let the user process that we are done.
+  Sleep(1000);
+
   if (opts.binary_to_restart)
   {
     ShellExecuteW(nullptr, L"open", UTF8ToUTF16(*opts.binary_to_restart).c_str(), L"", nullptr,
                   SW_SHOW);
   }
+
+  UI::Stop();
+
   return !ok;
 }