version.go

// Copyright (c) 2013-2017 The btcsuite developers
// Copyright (c) 2015-2016 The Decred developers
// Heavily inspired by https://github.com/btcsuite/btcd/blob/master/version.go
// Copyright (C) 2015-2017 The Lightning Network Developers
// Copyright (C) 2018 Breez

package main

import (
	"bytes"
	"context"
	"fmt"
	"log"
	"os"
	"strings"

	"github.com/breez/server/breez"
)

// semanticAlphabet
const semanticAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-"

// These constants define the application version and follow the semantic
// versioning 2.0.0 spec (http://semver.org/).
const (
	appMajor uint = 0
	appMinor uint = 1
	appPatch uint = 0

	// appPreRelease MUST only contain characters from semanticAlphabet
	// per the semantic versioning spec.
	appPreRelease = ""
)

// appBuild is defined as a variable so it can be overridden during the build
// process with '-ldflags "-X main.appBuild foo' if needed.  It MUST only
// contain characters from semanticAlphabet per the semantic versioning spec.
var appBuild string
var commit string

// version returns the application version as a properly formed string per the
// semantic versioning 2.0.0 spec (http://semver.org/).
func version() string {
	// Start with the major, minor, and patch versions.
	version := fmt.Sprintf("%d.%d.%d", appMajor, appMinor, appPatch)

	// Append pre-release version if there is one.  The hyphen called for
	// by the semantic versioning spec is automatically appended and should
	// not be contained in the pre-release string.  The pre-release version
	// is not appended if it contains invalid characters.
	preRelease := normalizeVerString(appPreRelease)
	if preRelease != "" {
		version = fmt.Sprintf("%s-%s", version, preRelease)
	}

	// Append build metadata if there is any.  The plus called for
	// by the semantic versioning spec is automatically appended and should
	// not be contained in the build metadata string.  The build metadata
	// string is not appended if it contains invalid characters.
	build := normalizeVerString(appBuild)
	if build != "" {
		version = fmt.Sprintf("%s+%s", version, build)
	}

	// Append commit hash of current build to version.
	version = fmt.Sprintf("%s commit=%s", version, commit)

	return version
}

// normalizeVerString returns the passed string stripped of all characters which
// are not valid according to the semantic versioning guidelines for pre-release
// version and build metadata strings.  In particular they MUST only contain
// characters in semanticAlphabet.
func normalizeVerString(str string) string {
	var result bytes.Buffer
	for _, r := range str {
		if strings.ContainsRune(semanticAlphabet, r) {
			result.WriteRune(r)
		}
	}
	return result.String()
}

func (s *server) Ping(ctx context.Context, in *breez.PingRequest) (*breez.PingReply, error) {
	return &breez.PingReply{Version: version()}, nil
}

func (s *server) BreezAppVersions(ctx context.Context, in *breez.BreezAppVersionsRequest) (*breez.BreezAppVersionsReply, error) {
	rows, err := breezAppVersion()
	if err != nil {
		log.Printf("breezAppVersion(): %v", err)
		return nil, fmt.Errorf("breezAppVersion(): %w", err)
	}
	defer rows.Close()
	var versions []string
	for rows.Next() {
		var version string
		err = rows.Scan(&version)
		if err != nil {
			log.Printf("rows.Scan: %v", err)
			continue
		}
		versions = append(versions, version)
	}
	return &breez.BreezAppVersionsReply{Version: versions}, nil
}

func (s *server) ReceiverInfo(ctx context.Context, in *breez.ReceiverInfoRequest) (*breez.ReceiverInfoReply, error) {
	return &breez.ReceiverInfoReply{Pubkey: os.Getenv("RECEIVER_NODE")}, nil
}