tools/check-licenses/file.go

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package checklicenses

import (
	"encoding/json"
	"fmt"
	"path/filepath"
)

type File struct {
	Name     string
	Path     string     `json:"-"`
	Symlink  string     `json:"-"`
	Parent   *FileTree  `json:"-"`
	Licenses []*License `json:"licenses"`
}

// ByPath implements sort.Interface for []*File based on the Path field.
type byPath []*File

func (a byPath) Len() int           { return len(a) }
func (a byPath) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
func (a byPath) Less(i, j int) bool { return a[i].Path < a[j].Path }

func NewFile(path string, parent *FileTree) (*File, error) {
	symlink, err := filepath.EvalSymlinks(path)
	if err != nil {
		return nil, fmt.Errorf("error creating file %v: %v\n", path, err)
	}
	file := &File{
		Name:    filepath.Base(path),
		Path:    path,
		Symlink: symlink,
		Parent:  parent,
	}
	return file, nil
}

func (f *File) Equal(other *File) bool {
	if f.Name != other.Name {
		return false
	}
	if f.Path != other.Path {
		return false
	}
	if f.Symlink != other.Symlink {
		return false
	}

	if len(f.Licenses) != len(other.Licenses) {
		return false
	}
	for i := range f.Licenses {
		if f.Licenses[i] != other.Licenses[i] {
			return false
		}
	}

	return true
}

// Use a custom Marshal function to make Files easier to read in JSON:
// reduce associated license information down to a string list.
func (f *File) MarshalJSON() ([]byte, error) {
	type Alias File
	licenseList := []string{}

	for _, l := range f.Licenses {
		licenseList = append(licenseList, l.Category)
	}

	return json.Marshal(&struct {
		*Alias
		Licenses []string `json:"licenses"`
	}{
		Alias:    (*Alias)(f),
		Licenses: licenseList,
	})
}