github.com/ubuntu/ubuntu-report@v1.7.4-0.20240410144652-96f37d845fac/internal/metrics/metrics.go

package metrics

import (
	"bufio"
	"bytes"
	"encoding/json"
	"math"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"

	"github.com/pkg/errors"
	log "github.com/sirupsen/logrus"
	"github.com/ubuntu/ubuntu-report/internal/utils"
)

const (
	installerLogsPath = "var/log/installer/telemetry"
	upgradeLogsPath   = "var/log/upgrade/telemetry"
)

// Metrics collect system, upgrade and installer data
type Metrics struct {
	root          string
	screenInfoCmd *exec.Cmd
	spaceInfoCmd  *exec.Cmd
	cpuInfoCmd    *exec.Cmd
	gpuInfoCmd    *exec.Cmd
	archCmd       *exec.Cmd
	libc6Cmd      *exec.Cmd
	hwCapCmd      *exec.Cmd
	getenv        GetenvFn
}

// New return a new metrics element with optional testing functions
func New(options ...func(*Metrics) error) (Metrics, error) {

	hwCapCmd := getHwCapCmd(options)

	m := Metrics{
		root:          "/",
		screenInfoCmd: setCommand("xrandr"),
		spaceInfoCmd:  setCommand("df"),
		cpuInfoCmd:    setCommand("lscpu", "-J"),
		gpuInfoCmd:    setCommand("lspci", "-n"),
		archCmd:       setCommand("dpkg", "--print-architecture"),
		hwCapCmd:      hwCapCmd,
		getenv:        os.Getenv,
	}
	m.cpuInfoCmd.Env = []string{"LANG=C"}

	for _, options := range options {
		if err := options(&m); err != nil {
			return m, err
		}
	}

	return m, nil
}

// GetIDS returns distro and version information
func (m Metrics) GetIDS() (string, string, error) {
	p := filepath.Join(m.root, "etc", "os-release")
	f, err := os.Open(p)
	if err != nil {
		return "", "", errors.Wrapf(err, "couldn't open %s", p)
	}
	defer f.Close()

	scanner := bufio.NewScanner(f)
	dRe := regexp.MustCompile(`^ID=(.*)$`)
	vRe := regexp.MustCompile(`^VERSION_ID="(.*)"$`)
	var distro, version string
	for scanner.Scan() {
		v := dRe.FindStringSubmatch(scanner.Text())
		if v != nil {
			distro = strings.TrimSpace(v[1])
		}
		v = vRe.FindStringSubmatch(scanner.Text())
		if v != nil {
			version = strings.TrimSpace(v[1])
		}
	}

	if err := scanner.Err(); (distro == "" || version == "") && err != nil {
		return "", "", errors.Wrap(err, "error while scanning")
	}

	if distro == "" || version == "" {
		return "", "", errors.Errorf("distribution '%s' or version '%s' information missing", distro, version)
	}

	return distro, version, nil
}

func setCommand(cmds ...string) *exec.Cmd {
	if len(cmds) == 1 {
		return exec.Command(cmds[0])
	}
	return exec.Command(cmds[0], cmds[1:]...)
}

// Collect system, installer and update info, returning a json formatted byte
func (m Metrics) Collect() ([]byte, error) {
	log.Debugf("Collecting metrics on system with root set to %s", m.root)
	r := metrics{}

	r.Version = m.getVersion()

	if vendor, product, family, dcd := m.getOEM(); vendor != "" || product != "" {
		r.OEM = &struct {
			Vendor  string
			Product string
			Family  string
			DCD     string `json:",omitempty"`
		}{vendor, product, family, dcd}
	}
	if vendor, version := m.getBIOS(); vendor != "" || version != "" {
		r.BIOS = &struct {
			Vendor  string
			Version string
		}{vendor, version}
	}

	cpu := m.getCPU()
	if cpu != (cpuInfo{}) {
		r.CPU = &cpu
	} else {
		r.CPU = nil
	}
	r.Arch = m.getArch()
	r.GPU = m.getGPU()
	r.RAM = m.getRAM()
	r.Disks = m.getDisks()
	r.Partitions = m.getPartitions()
	r.Screens = m.getScreens()
	r.HwCap = m.getHwCap()

	a := m.getAutologin()
	r.Autologin = &a
	l := m.getLivePatch()
	r.LivePatch = &l

	de := m.getenv("XDG_CURRENT_DESKTOP")
	sessionName := m.getenv("XDG_SESSION_DESKTOP")
	sessionType := m.getenv("XDG_SESSION_TYPE")
	if de != "" || sessionName != "" || sessionType != "" {
		r.Session = &struct {
			DE   string
			Name string
			Type string
		}{de, sessionName, sessionType}
	}
	r.Language = m.getLanguage()
	r.Timezone = m.getTimeZone()

	r.Install = m.installerInfo()
	r.Upgrade = m.upgradeInfo()

	d, err := json.Marshal(r)
	return d, errors.Wrapf(err, "can't be converted to a valid json")
}

func (m Metrics) getLanguage() string {
	lang := m.getenv("LC_ALL")
	if lang == "" {
		lang = m.getenv("LANG")
	}
	if lang == "" {
		lang = strings.Split(m.getenv("LANGUAGE"), ":")[0]
	}
	return strings.Split(lang, ".")[0]
}

func convKBToGB(s string) (float64, error) {
	v, err := strconv.Atoi(s)
	if err != nil {
		return 0, errors.Wrapf(err, "couldn't convert %s to an integer", s)
	}
	// convert in GB (SI) and round it to 0.1
	f := float64(v) / (1000 * 1000)
	return math.Round(f*10) / 10, nil
}

func getHwCapCmd(options []func(*Metrics) error) *exec.Cmd {
	// set up the map for architecture -> ld binary
	ldPath := make(map[string]string, 3)
	ldPath["amd64"] = "/lib/x86_64-linux-gnu/ld-linux-x86-64.so.2"
	ldPath["ppc64el"] = "/lib/powerpc64le-linux-gnu/ld64.so.2"
	ldPath["s390x"] = "/lib/s390x-linux-gnu/ld64.so.1"

	// check if libc6Cmd has been mocked
	mTemp := Metrics{}
	for _, mockFuncs := range options {
		mockFuncs(&mTemp)
	}
	var libc6Cmd *exec.Cmd
	if mTemp.libc6Cmd != nil {
		libc6Cmd = mTemp.libc6Cmd
	} else {
		libc6Cmd = setCommand("dpkg", "--status", "libc6")
	}

	// Make sure we have glibc version > 2.33
	r := runCmd(libc6Cmd)
	libc6Result, err := filterFirst(r, `^(?:Version: (.*))`, false)
	if err != nil {
		log.Infof("Couldn't get glibc version: "+utils.ErrFormat, err)
		return nil
	}
	if strings.Compare(libc6Result, "2.33") < 0 {
		// glibc versions older than 2.33 cannot report hwcap
		return nil
	}

	// find the architecture so we can directly assign hwCapCmd
	archCmd := setCommand("dpkg", "--print-architecture")
	r = runCmd(archCmd)
	buf := new(bytes.Buffer)
	buf.ReadFrom(r)
	arch := strings.TrimSpace(buf.String())

	if _, found := ldPath[arch]; found {
		return setCommand(ldPath[arch], "--help")
	} else {
		// architecture has no supported hwcap, string will be empty
		return nil
	}
}