github.com/google/osv-scalibr@v0.4.1/extractor/filesystem/os/pacman/metadata/metadata.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package metadata defines a metadata struct for arch packages.
    16  package metadata
    17  
    18  import (
    19  	"github.com/google/osv-scalibr/log"
    20  
    21  	pb "github.com/google/osv-scalibr/binary/proto/scan_result_go_proto"
    22  )
    23  
    24  // Metadata holds parsing information for an arch package.
    25  type Metadata struct {
    26  	PackageName         string
    27  	PackageVersion      string
    28  	OSID                string
    29  	OSVersionID         string
    30  	PackageDependencies string
    31  }
    32  
    33  // ToNamespace extracts the PURL namespace from the metadata.
    34  func (m *Metadata) ToNamespace() string {
    35  	if m.OSID != "" {
    36  		return m.OSID
    37  	}
    38  	log.Errorf("os-id not set, fallback to 'linux'")
    39  	return "linux"
    40  }
    41  
    42  // ToDistro extracts the OS distro from the metadata.
    43  func (m *Metadata) ToDistro() string {
    44  	// fallback: e.g. 22.04
    45  	if m.OSVersionID != "" {
    46  		return m.OSVersionID
    47  	}
    48  	log.Errorf("VERSION_ID not set in os-release")
    49  	return ""
    50  }
    51  
    52  // SetProto sets the PACMANPackageMetadata field in the Package proto.
    53  func (m *Metadata) SetProto(p *pb.Package) {
    54  	if m == nil {
    55  		return
    56  	}
    57  	if p == nil {
    58  		return
    59  	}
    60  
    61  	p.Metadata = &pb.Package_PacmanMetadata{
    62  		PacmanMetadata: &pb.PACMANPackageMetadata{
    63  			PackageName:         m.PackageName,
    64  			PackageVersion:      m.PackageVersion,
    65  			OsId:                m.OSID,
    66  			OsVersionId:         m.OSVersionID,
    67  			PackageDependencies: m.PackageDependencies,
    68  		},
    69  	}
    70  }
    71  
    72  // ToStruct converts the PACMANPackageMetadata proto to a Metadata struct.
    73  func ToStruct(m *pb.PACMANPackageMetadata) *Metadata {
    74  	if m == nil {
    75  		return nil
    76  	}
    77  
    78  	return &Metadata{
    79  		PackageName:         m.GetPackageName(),
    80  		PackageVersion:      m.GetPackageVersion(),
    81  		OSID:                m.GetOsId(),
    82  		OSVersionID:         m.GetOsVersionId(),
    83  		PackageDependencies: m.GetPackageDependencies(),
    84  	}
    85  }