luet/pkg/versioner/versioner.go

// Copyright © 2019-2020 Ettore Di Giacinto <mudler@gentoo.org>,
//                  Daniele Rondina <geaaru@sabayonlinux.org>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see <http://www.gnu.org/licenses/>.

package version

import (
	"errors"
	"regexp"
	"sort"
	"strconv"
	"strings"

	semver "github.com/hashicorp/go-version"
	debversion "github.com/knqyf263/go-deb-version"
)

// WrappedVersioner uses different means to return unique result that is understendable by Luet
// It tries different approaches to sort, validate, and sanitize to a common versioning format
// that is understendable by the whole code
type WrappedVersioner struct{}

func DefaultVersioner() Versioner {
	return &WrappedVersioner{}
}

func (w *WrappedVersioner) Validate(version string) error {
	if !debversion.Valid(version) {
		return errors.New("Invalid version")
	}
	return nil
}

func (w *WrappedVersioner) ValidateSelector(version string, selector string) bool {
	vS, err := ParseVersion(selector)
	if err != nil {
		return false
	}

	vSI, err := ParseVersion(version)
	if err != nil {
		return false
	}
	ok, err := PackageAdmit(vS, vSI)
	if err != nil {
		return false
	}
	return ok
}

func (w *WrappedVersioner) Sanitize(s string) string {
	return strings.ReplaceAll(s, "_", "-")
}

func (w *WrappedVersioner) IsSemver(v string) bool {

	// Taken https://github.com/hashicorp/go-version/blob/2b13044f5cdd3833370d41ce57d8bf3cec5e62b8/version.go#L44
	// semver doesn't have a Validate method, so we should filter before
	// going to use it blindly (it panics)
	semverRegexp := regexp.MustCompile("^" + semver.SemverRegexpRaw + "$")

	// See https://github.com/hashicorp/go-version/blob/2b13044f5cdd3833370d41ce57d8bf3cec5e62b8/version.go#L61
	matches := semverRegexp.FindStringSubmatch(v)
	if matches == nil {
		return false
	}
	segmentsStr := strings.Split(matches[1], ".")
	segments := make([]int64, len(segmentsStr))
	for i, str := range segmentsStr {
		val, err := strconv.ParseInt(str, 10, 64)
		if err != nil {
			return false
		}

		segments[i] = int64(val)
	}
	return (len(segments) != 0)
}

func (w *WrappedVersioner) Sort(toSort []string) []string {
	if len(toSort) == 0 {
		return toSort
	}
	var versionsMap map[string]string = make(map[string]string)
	versionsRaw := []string{}
	result := []string{}
	for _, v := range toSort {
		sanitizedVersion := w.Sanitize(v)
		versionsMap[sanitizedVersion] = v
		versionsRaw = append(versionsRaw, sanitizedVersion)
	}

	versions := make([]*semver.Version, len(versionsRaw))

	// Check if all of them are semver, otherwise we cannot do a good comparison
	allSemverCompliant := true
	for _, raw := range versionsRaw {
		if !w.IsSemver(raw) {
			allSemverCompliant = false
		}
	}

	if allSemverCompliant {
		for i, raw := range versionsRaw {
			if w.IsSemver(raw) { // Make sure we include only semver, or go-version will panic
				v, _ := semver.NewVersion(raw)
				versions[i] = v
			}
		}

		// Try first semver sorting
		sort.Sort(semver.Collection(versions))
		if len(versions) > 0 {
			for _, v := range versions {
				result = append(result, versionsMap[v.Original()])

			}
			return result
		}
	}
	// Try with debian sorting
	vs := make([]debversion.Version, len(versionsRaw))
	for i, r := range versionsRaw {
		v, _ := debversion.NewVersion(r)
		vs[i] = v
	}

	sort.Slice(vs, func(i, j int) bool {
		return vs[i].LessThan(vs[j])
	})

	for _, v := range vs {
		result = append(result, versionsMap[v.String()])
	}
	return result
}