Files
zeekayandHanzo Dev aa87442fdd Record upstream authorship centrally in NOTICE instead of in every file header
Source files keep their SPDX-License-Identifier and Hanzo copyright line; the
Gitea, Gogs and LFS Test Server copyrights they used to repeat now live once in
NOTICE, alongside LICENSE. The header lint accepts any copyright line above the
SPDX line, so it no longer demands an upstream one.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-10 17:50:35 -07:00

97 lines
1.9 KiB
Go

// Copyright 2026 Hanzo AI, Inc. All rights reserved.
// SPDX-License-Identifier: MIT
package vagrant
import (
"archive/tar"
"compress/gzip"
"io"
"strings"
"github.com/hanzoai/git/modules/json"
"github.com/hanzoai/git/modules/validation"
)
const (
PropertyProvider = "vagrant.provider"
)
// Metadata represents the metadata of a Vagrant package
type Metadata struct {
Author string `json:"author,omitempty"`
Description string `json:"description,omitempty"`
ProjectURL string `json:"project_url,omitempty"`
RepositoryURL string `json:"repository_url,omitempty"`
}
// ParseMetadataFromBox parses the metadata of a box file
func ParseMetadataFromBox(r io.Reader) (*Metadata, error) {
gzr, err := gzip.NewReader(r)
if err != nil {
return nil, err
}
defer gzr.Close()
tr := tar.NewReader(gzr)
for {
hd, err := tr.Next()
if err == io.EOF {
break
}
if err != nil {
return nil, err
}
if hd.Typeflag != tar.TypeReg {
continue
}
if hd.Name == "info.json" {
return ParseInfoFile(tr)
}
}
return &Metadata{}, nil
}
// ParseInfoFile parses a info.json file to retrieve the metadata of a Vagrant package
func ParseInfoFile(r io.Reader) (*Metadata, error) {
var values map[string]string
if err := json.NewDecoder(r).Decode(&values); err != nil {
return nil, err
}
m := &Metadata{}
// There is no defined format for this file, just try the common keys
for k, v := range values {
switch strings.ToLower(k) {
case "description":
fallthrough
case "short_description":
m.Description = v
case "website":
fallthrough
case "homepage":
fallthrough
case "url":
if validation.IsValidURL(v) {
m.ProjectURL = v
}
case "repository":
fallthrough
case "source":
if validation.IsValidURL(v) {
m.RepositoryURL = v
}
case "author":
fallthrough
case "authors":
m.Author = v
}
}
return m, nil
}