Disable the update checker by default and add option to disable networking (#2376)

This avoids some privacy concerns linked to pinging an external server each time the game is open.

It also allows the user to decide whether the game should connect to the internet at all.

---------

Co-authored-by: Semphris <[email protected]>
Co-authored-by: Vankata453 <[email protected]>

Author: 3 people

src/addon/addon_manager.cpp

@@ -276,7 +276,10 @@ AddonManager::request_check_online()
 {
   empty_cache_directory();
 
-  TransferStatusPtr status = m_downloader.request_download(m_repository_url, ADDON_INFO_PATH);
+  // Since then() may be called immediately if networking is disabled,
+  // hold the status in a separate variable so that `m_transfer_status = {}`
+  // below doesn't cause this function to return nullptr.
+  auto status = m_downloader.request_download(m_repository_url, ADDON_INFO_PATH);
   status->then(
     [this](bool success)
     {

src/addon/downloader.cpp

@@ -33,6 +33,7 @@
 #endif
 
 #include "physfs/util.hpp"
+#include "supertux/gameconfig.hpp"
 #include "supertux/globals.hpp"
 #include "util/file_system.hpp"
 #include "util/log.hpp"
@@ -137,6 +138,7 @@ TransferStatusList::update()
 void
 TransferStatusList::push(TransferStatusPtr status)
 {
+  assert(!status->parent_list);
   status->parent_list = this;
 
   m_transfer_statuses.push_back(status);
@@ -421,6 +423,9 @@ Downloader::download(const std::string& url,
                      size_t (*write_func)(void* ptr, size_t size, size_t nmemb, void* userdata),
                      void* userdata)
 {
+  if (g_config->disable_network)
+    throw std::runtime_error("Networking is disabled");
+
   log_info << "Downloading " << url << std::endl;
 
 #ifndef EMSCRIPTEN
@@ -456,6 +461,9 @@ Downloader::download(const std::string& url,
 std::string
 Downloader::download(const std::string& url)
 {
+  if (g_config->disable_network)
+    throw std::runtime_error("Networking is disabled");
+
   std::string result;
   download(url, my_curl_string_append, &result);
   return result;
@@ -464,6 +472,9 @@ Downloader::download(const std::string& url)
 void
 Downloader::download(const std::string& url, const std::string& filename)
 {
+  if (g_config->disable_network)
+    throw std::runtime_error("Networking is disabled");
+
 #ifndef EMSCRIPTEN
   log_info << "download: " << url << " to " << filename << std::endl;
   std::unique_ptr<PHYSFS_file, int(*)(PHYSFS_File*)> fout(PHYSFS_openWrite(filename.c_str()),
@@ -512,6 +523,31 @@ Downloader::abort(TransferId id)
 void
 Downloader::update()
 {
+  if (g_config->disable_network)
+  {
+    // Remove any on-going transfers
+    for (const auto& transfer_data : m_transfers)
+    {
+      TransferStatusPtr status = transfer_data.second->get_status();
+      status->error_msg = "Networking is disabled";
+      for (const auto& callback : status->callbacks)
+      {
+        try
+        {
+          callback(false);
+        }
+        catch(const std::exception& err)
+        {
+          log_warning << "Illegal exception in Downloader: " << err.what() << std::endl;
+        }
+      }
+      if (status->parent_list)
+        status->parent_list->on_transfer_complete(status, false);
+    }
+    m_transfers.clear();
+    return;
+  }
+
 #ifndef EMSCRIPTEN
   // Prevent updating a Downloader multiple times in the same frame.
   if (m_last_update_time == g_real_time) return;

src/gui/menu_manager.cpp

@@ -131,7 +131,8 @@ MenuManager::draw(DrawingContext& context)
 {
   if (m_dialog.has_next) // Has next dialog
   {
-    if (m_dialog.next) m_dialog.next->update();
+    // Removed to fix a crash with changing dialog in initial next dialog update
+    //if (m_dialog.next) m_dialog.next->update();
 
     if (m_dialog.current && m_dialog.next)
     {

src/supertux/gameconfig.cpp

@@ -35,6 +35,7 @@
 #endif
 
 Config::Config() :
+  m_initial(true),
   profile(1),
   fullscreen_size(0, 0),
   fullscreen_refresh_rate(0),
@@ -78,11 +79,8 @@ Config::Config() :
   confirmation_dialog(false),
   pause_on_focusloss(true),
   custom_mouse_cursor(true),
-#ifdef __EMSCRIPTEN__
   do_release_check(false),
-#else
-  do_release_check(true),
-#endif
+  disable_network(true),
   custom_title_levels(true),
 #ifdef ENABLE_DISCORD
   enable_discord(false),
@@ -155,6 +153,7 @@ Config::load()
   config_mapping.get("pause_on_focusloss", pause_on_focusloss);
   config_mapping.get("custom_mouse_cursor", custom_mouse_cursor);
   config_mapping.get("do_release_check", do_release_check);
+  config_mapping.get("disable_network", disable_network);
   config_mapping.get("custom_title_levels", custom_title_levels);
 
   std::optional<ReaderMapping> config_integrations_mapping;
@@ -351,6 +350,7 @@ Config::load()
   }
 
   check_values();
+  m_initial = false;
 }
 
 void
@@ -374,6 +374,7 @@ Config::save()
   writer.write("pause_on_focusloss", pause_on_focusloss);
   writer.write("custom_mouse_cursor", custom_mouse_cursor);
   writer.write("do_release_check", do_release_check);
+  writer.write("disable_network", disable_network);
   writer.write("custom_title_levels", custom_title_levels);
 
   writer.start_list("integrations");

src/supertux/gameconfig.hpp

@@ -36,6 +36,11 @@ class Config final
 
   void check_values();
 
+  bool is_initial() const { return m_initial; }
+
+private:
+  bool m_initial;
+
 public:
   int profile;
 
@@ -108,6 +113,7 @@ class Config final
   bool pause_on_focusloss;
   bool custom_mouse_cursor;
   bool do_release_check;
+  bool disable_network;
   bool custom_title_levels;
 
 #ifdef ENABLE_DISCORD

src/supertux/main.cpp

@@ -771,6 +771,9 @@ Main::run(int argc, char** argv)
 void
 Main::release_check()
 {
+  if (g_config->disable_network)
+    return;
+
   // Detect a potential new release of SuperTux. If a release, other than
   // the current one is indicated on the given web file, show a notification on the main menu screen.
   const std::string target_file = "ver_info.nfo";

src/supertux/menu/addon_menu.cpp

@@ -23,6 +23,8 @@
 #include "gui/dialog.hpp"
 #include "gui/menu_item.hpp"
 #include "gui/menu_manager.hpp"
+#include "supertux/gameconfig.hpp"
+#include "supertux/globals.hpp"
 #include "supertux/menu/addon_browse_menu.hpp"
 #include "supertux/menu/addon_file_install_menu.hpp"
 #include "supertux/menu/addon_preview_menu.hpp"
@@ -169,7 +171,10 @@ AddonMenu::menu_action(MenuItem& item)
   }
   else if (index == MNID_BROWSE)
   {
-    MenuManager::instance().push_menu(std::make_unique<AddonBrowseMenu>(m_langpacks_only, false));
+    if (g_config->disable_network)
+      Dialog::show_message(_("To browse through the add-on catalog, you must enable networking."));
+    else
+      MenuManager::instance().push_menu(std::make_unique<AddonBrowseMenu>(m_langpacks_only, false));
   }
   else if (index == MNID_INSTALL_FROM_FILE)
   { 
@@ -202,17 +207,23 @@ AddonMenu::menu_action(MenuItem& item)
 void
 AddonMenu::check_for_updates()
 {
+  if (g_config->disable_network)
+  {
+    Dialog::show_message(_("To check for add-on updates, you must enable networking."));
+    return;
+  }
+
   try
   {
     TransferStatusPtr status = m_addon_manager.request_check_online();
+    auto dialog = std::make_unique<DownloadDialog>(status, false);
+    dialog->set_title(_("Checking for updates..."));
+    MenuManager::instance().set_dialog(std::move(dialog));
     status->then([this](bool success)
     {
       if (success) refresh();
       set_active_item(MNID_CHECK_ONLINE);
     });
-    auto dialog = std::make_unique<DownloadDialog>(status, false);
-    dialog->set_title(_("Checking for updates..."));
-    MenuManager::instance().set_dialog(std::move(dialog));
   }
   catch (std::exception& e)
   {

src/supertux/menu/addon_preview_menu.cpp

@@ -22,6 +22,8 @@
 #include "addon/addon_manager.hpp"
 #include "gui/menu_item.hpp"
 #include "gui/menu_manager.hpp"
+#include "supertux/gameconfig.hpp"
+#include "supertux/globals.hpp"
 #include "supertux/menu/download_dialog.hpp"
 #include "supertux/resources.hpp"
 #include "util/log.hpp"
@@ -147,6 +149,10 @@ AddonPreviewMenu::rebuild_menu()
         add_inactive(_("Failed to load all available screenshot previews."));
       }
     }
+    else if (g_config->disable_network)
+    {
+      add_inactive(_("To fetch add-on screenshots, you must enable networking."));
+    }
     else
     {
       const std::string show_screenshots_text = _("Show screenshots");

src/supertux/menu/main_menu.cpp

@@ -22,6 +22,7 @@
 #include "gui/menu_item.hpp"
 #include "gui/menu_manager.hpp"
 #include "supertux/fadetoblack.hpp"
+#include "supertux/gameconfig.hpp"
 #include "supertux/globals.hpp"
 #include "supertux/level.hpp"
 #include "supertux/level_parser.hpp"
@@ -68,6 +69,24 @@ MainMenu::MainMenu()
 #endif
 
   on_window_resize();
+
+#ifndef __EMSCRIPTEN__
+  // Show network-related confirmation dialogs on first startup
+  if (g_config->is_initial())
+  {
+    Dialog::show_confirmation(_("Would you allow SuperTux to connect to the Internet?\n\nThis enables additional features, such as the in-game add-on catalog."),
+      []()
+      {
+        g_config->disable_network = false;
+
+        Dialog::show_confirmation(_("Would you allow SuperTux to check for new releases on startup?\n\nYou will be notified if any are found."),
+          []()
+          {
+            g_config->do_release_check = true;
+          });
+      }, true);
+  }
+#endif
 }
 
 void

src/supertux/menu/options_menu.cpp

@@ -56,6 +56,8 @@ OptionsMenu::less_than_volume(const std::string& lhs, const std::string& rhs)
 }
 
 OptionsMenu::OptionsMenu(Type type, bool complete) :
+  m_type(type),
+  m_complete(complete),
   m_magnifications(),
   m_aspect_ratios(),
   m_window_resolutions(),
@@ -66,13 +68,21 @@ OptionsMenu::OptionsMenu(Type type, bool complete) :
   m_flash_intensity_values(),
   m_mobile_control_scales()
 {
-  switch (type) // Insert label and menu items, appropriate for the chosen OptionsMenu type
+  refresh();
+}
+
+void
+OptionsMenu::refresh()
+{
+  clear();
+
+  switch (m_type) // Insert label and menu items, appropriate for the chosen OptionsMenu type
   {
     case LOCALE: /** LOCALE */
     {
       insert_label(_("Locale"));
 
-      if (complete)
+      if (m_complete)
       {
         add_submenu(_("Select Language"), MenuStorage::LANGUAGE_MENU)
           .set_help(_("Select a different language to display text in"));
@@ -174,7 +184,7 @@ OptionsMenu::OptionsMenu(Type type, bool complete) :
     {
       insert_label(_("Extras"));
 
-      if (complete)
+      if (m_complete)
         add_submenu(_("Select Profile"), MenuStorage::PROFILE_MENU)
           .set_help(_("Select a profile to play with"));
 
@@ -219,8 +229,12 @@ OptionsMenu::OptionsMenu(Type type, bool complete) :
       add_toggle(MNID_CUSTOM_CURSOR, _("Use custom mouse cursor"), &g_config->custom_mouse_cursor).set_help(_("Whether the game renders its own cursor or uses the system's cursor"));
 
 #ifndef __EMSCRIPTEN__
-      add_toggle(MNID_RELEASE_CHECK, _("Check for new releases"), &g_config->do_release_check)
-        .set_help(_("Allows the game to perform checks for new SuperTux releases on startup and notify if any found."));
+      if (!g_config->disable_network)
+        add_toggle(MNID_RELEASE_CHECK, _("Check for new releases"), &g_config->do_release_check)
+          .set_help(_("Allows the game to perform checks for new SuperTux releases on startup and notify if any found."));
+
+      add_toggle(MNID_DISABLE_NETWORK, _("Disable network"), &g_config->disable_network)
+        .set_help(_("Prevents the game from connecting online"));
 #endif
 
       break;
@@ -767,6 +781,11 @@ OptionsMenu::menu_action(MenuItem& item)
         g_config->m_mobile_controls_scale /= 100.0f;
       break;
 
+    case MNID_DISABLE_NETWORK:
+      refresh();
+      set_active_item(MNID_DISABLE_NETWORK);
+      break;
+
     default:
       break;
   }

src/supertux/menu/options_menu.hpp

@@ -39,6 +39,7 @@ class OptionsMenu final : public Menu
   OptionsMenu(Type type, bool complete);
   ~OptionsMenu() override;
 
+  void refresh() override;
   void on_window_resize() override;
 
   void menu_action(MenuItem& item) override;
@@ -81,6 +82,7 @@ class OptionsMenu final : public Menu
     MNID_PAUSE_ON_FOCUSLOSS,
     MNID_CUSTOM_CURSOR,
     MNID_RELEASE_CHECK,
+    MNID_DISABLE_NETWORK,
     MNID_MOBILE_CONTROLS,
     MNID_MOBILE_CONTROLS_SCALE
   };
@@ -92,6 +94,9 @@ class OptionsMenu final : public Menu
   };
 
 private:
+  const Type m_type;
+  const bool m_complete;
+
   StringOption m_magnifications;
   StringOption m_aspect_ratios;
   StringOption m_window_resolutions;