ui/software_update.c

   1 /* software_update.h
   2  * Wrappers and routines to check for software updates.
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #include "config.h"
  12
  13 #include "software_update.h"
  14 #include "language.h"
  15 #include "../epan/prefs.h"
  16 #include "../wsutil/filesystem.h"
  17
  18 /*
  19  * Version 0 of the update URI path has the following elements:
  20  * - The update path prefix (fixed, "update")
  21  * - The schema version (fixed, 0)
  22  * - The application name (variable, "Wireshark" or "Stratoshark")
  23  * - The application version ("<major>.<minor>.<micro>")
  24  * - The operating system (variable, one of "Windows" or "macOS")
  25  * - The architecture name (variable, one of "x86", "x86-64", or "arm64")
  26  * - The locale (fixed, "en-US")
  27  * - The update channel (variable, one of "development" or "stable") + .xml
  28  *
  29  * Based on https://wiki.mozilla.org/Software_Update:Checking_For_Updates
  30  *
  31  * To do for version 1:
  32  * - Distinguish between NSIS (.exe) and WiX (.msi) on Windows.
  33  */
  34
  35 #ifdef HAVE_SOFTWARE_UPDATE
  36 #define SU_SCHEMA_PREFIX "update"
  37 #define SU_SCHEMA_VERSION 0
  38 #define SU_LOCALE "en-US"
  39 #endif /* HAVE_SOFTWARE_UPDATE */
  40
  41 #ifdef HAVE_SOFTWARE_UPDATE
  42
  43 #include "glib.h"
  44
  45 #ifdef _WIN32
  46 #include <winsparkle.h>
  47 #define SU_OSNAME "Windows"
  48 #elif defined(__APPLE__)
  49 #include <macosx/sparkle_bridge.h>
  50 #define SU_OSNAME "macOS"
  51 #else
  52 #error HAVE_SOFTWARE_UPDATE can only be defined for Windows or macOS.
  53 #endif
  54
  55 // https://sourceforge.net/p/predef/wiki/Architectures/
  56 #if defined(__x86_64__) || defined(_M_X64)
  57 #define SU_ARCH "x86-64"
  58 #elif defined(__i386__) || defined(_M_IX86)
  59 #define SU_ARCH "x86"
  60 #elif defined(__arm64__) || defined(_M_ARM64)
  61 #define SU_ARCH "arm64"
  62 #else
  63 #error HAVE_SOFTWARE_UPDATE can only be defined for x86-64 or x86 or arm64.
  64 #endif
  65
  66 static char *get_appcast_update_url(software_update_channel_e chan) {
  67     GString *update_url_str = g_string_new("");
  68     const char *chan_name;
  69     const char *su_application = get_configuration_namespace();
  70     const char *su_version = VERSION;
  71
  72     if (!is_packet_configuration_namespace()) {
  73         su_version = LOG_VERSION;
  74     }
  75
  76     switch (chan) {
  77         case UPDATE_CHANNEL_DEVELOPMENT:
  78             chan_name = "development";
  79             break;
  80         default:
  81             chan_name = "stable";
  82             break;
  83     }
  84     g_string_printf(update_url_str, "https://www.wireshark.org/%s/%u/%s/%s/%s/%s/en-US/%s.xml",
  85                     SU_SCHEMA_PREFIX,
  86                     SU_SCHEMA_VERSION,
  87                     su_application,
  88                     su_version,
  89                     SU_OSNAME,
  90                     SU_ARCH,
  91                     chan_name);
  92     return g_string_free(update_url_str, FALSE);
  93 }
  94
  95 #ifdef _WIN32
  96 /** Initialize software updates.
  97  */
  98 void
  99 software_update_init(void) {
 100     const char *update_url = get_appcast_update_url(prefs.gui_update_channel);
 101
 102     /*
 103      * According to the WinSparkle 0.5 documentation these must be called
 104      * once, before win_sparkle_init. We can't update them dynamically when
 105      * our preferences change.
 106      */
 107     win_sparkle_set_registry_path("Software\\Wireshark\\WinSparkle Settings");
 108     win_sparkle_set_appcast_url(update_url);
 109     win_sparkle_set_automatic_check_for_updates(prefs.gui_update_enabled ? 1 : 0);
 110     win_sparkle_set_update_check_interval(prefs.gui_update_interval);
 111     win_sparkle_set_can_shutdown_callback(software_update_can_shutdown_callback);
 112     win_sparkle_set_shutdown_request_callback(software_update_shutdown_request_callback);
 113     if ((language != NULL) && (strcmp(language, "system") != 0)) {
 114         win_sparkle_set_lang(language);
 115     }
 116     win_sparkle_init();
 117 }
 118
 119 /** Force a software update check.
 120  */
 121 void
 122 software_update_check(void) {
 123     win_sparkle_check_update_with_ui();
 124 }
 125
 126 /** Clean up software update checking.
 127  *
 128  * Does nothing on platforms that don't support software updates.
 129  */
 130 extern void software_update_cleanup(void) {
 131     win_sparkle_cleanup();
 132 }
 133
 134 const char *software_update_info(void) {
 135     return "WinSparkle " WIN_SPARKLE_VERSION_STRING;
 136 }
 137
 138 #elif defined (__APPLE__)
 139 /** Initialize software updates.
 140  */
 141 void
 142 software_update_init(void) {
 143     char *update_url = get_appcast_update_url(prefs.gui_update_channel);
 144
 145     sparkle_software_update_init(update_url, prefs.gui_update_enabled, prefs.gui_update_interval);
 146
 147     g_free(update_url);
 148 }
 149
 150 /** Force a software update check.
 151  */
 152 void
 153 software_update_check(void) {
 154     sparkle_software_update_check();
 155 }
 156
 157 /** Clean up software update checking.
 158  */
 159 void software_update_cleanup(void) {
 160 }
 161
 162 const char *software_update_info(void) {
 163     return "Sparkle";
 164 }
 165 #endif
 166
 167 #else /* No updates */
 168
 169 /** Initialize software updates.
 170  */
 171 void
 172 software_update_init(void) {
 173 }
 174
 175 /** Force a software update check.
 176  */
 177 void
 178 software_update_check(void) {
 179 }
 180
 181 /** Clean up software update checking.
 182  */
 183 void software_update_cleanup(void) {
 184 }
 185
 186 const char *software_update_info(void) {
 187     return NULL;
 188 }
 189
 190 #endif /* defined(HAVE_SOFTWARE_UPDATE) && defined (_WIN32) */