|
| 1 | +// This file is part of arduino-cli. |
| 2 | +// |
| 3 | +// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) |
| 4 | +// |
| 5 | +// This software is released under the GNU General Public License version 3, |
| 6 | +// which covers the main part of arduino-cli. |
| 7 | +// The terms of this license can be found at: |
| 8 | +// https://www.gnu.org/licenses/gpl-3.0.en.html |
| 9 | +// |
| 10 | +// You can be released from the requirements of the above licenses by purchasing |
| 11 | +// a commercial license. Buying such a license is mandatory if you want to |
| 12 | +// modify or otherwise use the software for commercial activities involving the |
| 13 | +// Arduino software without disclosing the source code of your own applications. |
| 14 | +// To purchase a commercial license, send an email to [email protected]. |
| 15 | + |
| 16 | +package updater |
| 17 | + |
| 18 | +import ( |
| 19 | + "os" |
| 20 | + "strings" |
| 21 | + "time" |
| 22 | + |
| 23 | + "github.com/arduino/arduino-cli/cli/feedback" |
| 24 | + "github.com/arduino/arduino-cli/cli/globals" |
| 25 | + "github.com/arduino/arduino-cli/configuration" |
| 26 | + "github.com/arduino/arduino-cli/httpclient" |
| 27 | + "github.com/arduino/arduino-cli/i18n" |
| 28 | + "github.com/arduino/arduino-cli/inventory" |
| 29 | + "github.com/fatih/color" |
| 30 | + semver "go.bug.st/relaxed-semver" |
| 31 | +) |
| 32 | + |
| 33 | +var tr = i18n.Tr |
| 34 | + |
| 35 | +// CheckForUpdate returns the latest available version if greater than |
| 36 | +// the one running and it makes sense to check for an update, nil in all other cases |
| 37 | +func CheckForUpdate(currentVersion *semver.Version) *semver.Version { |
| 38 | + if !shouldCheckForUpdate(currentVersion) { |
| 39 | + return nil |
| 40 | + } |
| 41 | + |
| 42 | + return ForceCheckForUpdate(currentVersion) |
| 43 | +} |
| 44 | + |
| 45 | +// ForceCheckForUpdate always returns the latest available version if greater than |
| 46 | +// the one running, nil in all other cases |
| 47 | +func ForceCheckForUpdate(currentVersion *semver.Version) *semver.Version { |
| 48 | + defer func() { |
| 49 | + // Always save the last time we checked for updates at the end |
| 50 | + inventory.Store.Set("updater.last_check_time", time.Now()) |
| 51 | + inventory.WriteStore() |
| 52 | + }() |
| 53 | + |
| 54 | + latestVersion, err := semver.Parse(getLatestRelease()) |
| 55 | + if err != nil { |
| 56 | + return nil |
| 57 | + } |
| 58 | + |
| 59 | + if currentVersion.GreaterThanOrEqual(latestVersion) { |
| 60 | + // Current version is already good enough |
| 61 | + return nil |
| 62 | + } |
| 63 | + |
| 64 | + return latestVersion |
| 65 | +} |
| 66 | + |
| 67 | +// NotifyNewVersionIsAvailable prints information about the new latestVersion |
| 68 | +func NotifyNewVersionIsAvailable(latestVersion string) { |
| 69 | + feedback.Errorf("\n\n%s %s → %s\n%s", |
| 70 | + color.YellowString(tr("A new release of Arduino CLI is available:")), |
| 71 | + color.CyanString(globals.VersionInfo.VersionString), |
| 72 | + color.CyanString(latestVersion), |
| 73 | + color.YellowString("https://arduino.github.io/arduino-cli/latest/installation/#latest-packages")) |
| 74 | +} |
| 75 | + |
| 76 | +// shouldCheckForUpdate return true if it actually makes sense to check for new updates, |
| 77 | +// false in all other cases. |
| 78 | +func shouldCheckForUpdate(currentVersion *semver.Version) bool { |
| 79 | + if strings.Contains(currentVersion.String(), "git-snapshot") || strings.Contains(currentVersion.String(), "nightly") { |
| 80 | + // This is a dev build, no need to check for updates |
| 81 | + return false |
| 82 | + } |
| 83 | + |
| 84 | + if !configuration.Settings.GetBool("updater.enable_notification") { |
| 85 | + // Don't check if the user disabled the notification |
| 86 | + return false |
| 87 | + } |
| 88 | + |
| 89 | + if inventory.Store.IsSet("updater.last_check_time") && time.Since(inventory.Store.GetTime("updater.last_check_time")).Hours() < 24 { |
| 90 | + // Checked less than 24 hours ago, let's wait |
| 91 | + return false |
| 92 | + } |
| 93 | + |
| 94 | + // Don't check when running on CI or on non interactive consoles |
| 95 | + return !isCI() && configuration.IsInteractive && configuration.HasConsole |
| 96 | +} |
| 97 | + |
| 98 | +// based on https://github.com/watson/ci-info/blob/HEAD/index.js |
| 99 | +func isCI() bool { |
| 100 | + return os.Getenv("CI") != "" || // GitHub Actions, Travis CI, CircleCI, Cirrus CI, GitLab CI, AppVeyor, CodeShip, dsari |
| 101 | + os.Getenv("BUILD_NUMBER") != "" || // Jenkins, TeamCity |
| 102 | + os.Getenv("RUN_ID") != "" // TaskCluster, dsari |
| 103 | +} |
| 104 | + |
| 105 | +// getLatestRelease queries the official Arduino download server for the latest release, |
| 106 | +// if there are no errors or issues a version string is returned, in all other case an empty string. |
| 107 | +func getLatestRelease() string { |
| 108 | + client, err := httpclient.New() |
| 109 | + if err != nil { |
| 110 | + return "" |
| 111 | + } |
| 112 | + |
| 113 | + // We just use this URL to check if there's a new release available and |
| 114 | + // never show it to the user, so it's fine to use the Linux one for all OSs. |
| 115 | + URL := "https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_64bit.tar.gz" |
| 116 | + res, err := client.Head(URL) |
| 117 | + if err != nil { |
| 118 | + // Yes, we ignore it |
| 119 | + return "" |
| 120 | + } |
| 121 | + |
| 122 | + // Get redirected URL |
| 123 | + location := res.Request.URL.String() |
| 124 | + |
| 125 | + // The location header points to the the latest release of the CLI, it's supposed to be formatted like this: |
| 126 | + // https://downloads.arduino.cc/arduino-cli/arduino-cli_0.18.3_Linux_64bit.tar.gz |
| 127 | + // so we split it to get the version, if there are not enough splits something must have gone wrong. |
| 128 | + split := strings.Split(location, "_") |
| 129 | + if len(split) < 2 { |
| 130 | + return "" |
| 131 | + } |
| 132 | + |
| 133 | + return split[1] |
| 134 | +} |
0 commit comments