mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-09 23:00:58 +00:00
4f367e4376
This adds some env vars to the long version string as if they were build tags. The purpose is to better understand what code was running or not in the version output, usage reporting and crash reports. In order to prevent possible privacy issues the actual value of the variable is not reported, just the fact that it was set to something non-empty. Example: % ./bin/syncthing --version syncthing v1.6.1+47-g1eb104f3-buildtags "Fermium Flea" (go1.14.3 darwin-amd64) jb@kvin.kastelo.net 2020-06-03 07:25:46 UTC [stnoupgrade, use_badger]
101 lines
2.9 KiB
Go
101 lines
2.9 KiB
Go
// Copyright (C) 2019 The Syncthing Authors.
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
// You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
package build
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"regexp"
|
|
"runtime"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
var (
|
|
// Injected by build script
|
|
Version = "unknown-dev"
|
|
Host = "unknown"
|
|
User = "unknown"
|
|
Stamp = "0"
|
|
|
|
// Static
|
|
Codename = "Fermium Flea"
|
|
|
|
// Set by init()
|
|
Date time.Time
|
|
IsRelease bool
|
|
IsCandidate bool
|
|
IsBeta bool
|
|
LongVersion string
|
|
|
|
// Set by Go build tags
|
|
Tags []string
|
|
|
|
allowedVersionExp = regexp.MustCompile(`^v\d+\.\d+\.\d+(-[a-z0-9]+)*(\.\d+)*(\+\d+-g[0-9a-f]+)?(-[^\s]+)?$`)
|
|
|
|
envTags = []string{
|
|
"STGUIASSETS",
|
|
"STHASHING",
|
|
"STNORESTART",
|
|
"STNOUPGRADE",
|
|
"USE_BADGER",
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
if Version != "unknown-dev" {
|
|
// If not a generic dev build, version string should come from git describe
|
|
if !allowedVersionExp.MatchString(Version) {
|
|
log.Fatalf("Invalid version string %q;\n\tdoes not match regexp %v", Version, allowedVersionExp)
|
|
}
|
|
}
|
|
setBuildData()
|
|
}
|
|
|
|
func setBuildData() {
|
|
// Check for a clean release build. A release is something like
|
|
// "v0.1.2", with an optional suffix of letters and dot separated
|
|
// numbers like "-beta3.47". If there's more stuff, like a plus sign and
|
|
// a commit hash and so on, then it's not a release. If it has a dash in
|
|
// it, it's some sort of beta, release candidate or special build. If it
|
|
// has "-rc." in it, like "v0.14.35-rc.42", then it's a candidate build.
|
|
//
|
|
// So, every build that is not a stable release build has IsBeta = true.
|
|
// This is used to enable some extra debugging (the deadlock detector).
|
|
//
|
|
// Release candidate builds are also "betas" from this point of view and
|
|
// will have that debugging enabled. In addition, some features are
|
|
// forced for release candidates - auto upgrade, and usage reporting.
|
|
|
|
exp := regexp.MustCompile(`^v\d+\.\d+\.\d+(-[a-z]+[\d\.]+)?$`)
|
|
IsRelease = exp.MatchString(Version)
|
|
IsCandidate = strings.Contains(Version, "-rc.")
|
|
IsBeta = strings.Contains(Version, "-")
|
|
|
|
stamp, _ := strconv.Atoi(Stamp)
|
|
Date = time.Unix(int64(stamp), 0)
|
|
LongVersion = LongVersionFor("syncthing")
|
|
}
|
|
|
|
// LongVersionFor returns the long version string for the given program name.
|
|
func LongVersionFor(program string) string {
|
|
// This string and date format is essentially part of our external API. Never change it.
|
|
date := Date.UTC().Format("2006-01-02 15:04:05 MST")
|
|
v := fmt.Sprintf(`%s %s "%s" (%s %s-%s) %s@%s %s`, program, Version, Codename, runtime.Version(), runtime.GOOS, runtime.GOARCH, User, Host, date)
|
|
for _, envVar := range envTags {
|
|
if os.Getenv(envVar) != "" {
|
|
Tags = append(Tags, strings.ToLower(envVar))
|
|
}
|
|
}
|
|
if len(Tags) > 0 {
|
|
v = fmt.Sprintf("%s [%s]", v, strings.Join(Tags, ", "))
|
|
}
|
|
return v
|
|
}
|