harbor/src/pkg/accessory/manager.go

// Copyright Project Harbor Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package accessory

import (
	"context"

	"github.com/goharbor/harbor/src/lib/errors"
	"github.com/goharbor/harbor/src/lib/icon"
	"github.com/goharbor/harbor/src/lib/q"
	"github.com/goharbor/harbor/src/pkg/accessory/dao"
	"github.com/goharbor/harbor/src/pkg/accessory/model"
)

var (
	// Mgr is a global artifact manager instance
	Mgr = NewManager()

	// icon digests for each known type
	defaultIcons = map[string]string{
		model.TypeCosignSignature:   icon.DigestOfIconAccCosign,
		model.TypeNotationSignature: icon.DigestOfIconAccNotation,
		model.TypeNydusAccelerator:  icon.DigestOfIconAccNydus,
	}
)

// Manager is the only interface of artifact module to provide the management functions for artifacts
type Manager interface {
	// Ensure ...
	Ensure(ctx context.Context, subArtDigest, subArtRepo string, subArtID, artifactID, size int64, digest, accType string) error
	// Get the artifact specified by the ID
	Get(ctx context.Context, id int64) (accessory model.Accessory, err error)
	// Count returns the total count of accessory according to the query.
	Count(ctx context.Context, query *q.Query) (total int64, err error)
	// List accessory according to the query
	List(ctx context.Context, query *q.Query) (accs []model.Accessory, err error)
	// Create the accessory and returns the ID
	Create(ctx context.Context, accessory model.AccessoryData) (id int64, err error)
	// Update the accessory
	Update(ctx context.Context, accessory model.AccessoryData) error
	// Delete the accessory specified by ID
	Delete(ctx context.Context, id int64) (err error)
	// DeleteAccessories deletes accessories according to the query
	DeleteAccessories(ctx context.Context, q *q.Query) (err error)
}

// NewManager returns an instance of the default manager
func NewManager() Manager {
	return &manager{
		dao.New(),
	}
}

var _ Manager = &manager{}

type manager struct {
	dao dao.DAO
}

func (m *manager) Ensure(ctx context.Context, subArtDigest, subArtRepo string, subArtID, artifactID, size int64, digest, accType string) error {
	accs, err := m.dao.List(ctx, q.New(q.KeyWords{"ArtifactID": artifactID, "Digest": digest}))
	if err != nil {
		return err
	}
	if len(accs) > 0 {
		return nil
	}

	acc := model.AccessoryData{
		ArtifactID:        artifactID,
		SubArtifactID:     subArtID,
		SubArtifactRepo:   subArtRepo,
		SubArtifactDigest: subArtDigest,
		Digest:            digest,
		Size:              size,
		Type:              accType,
	}
	_, err = m.Create(ctx, acc)
	return err
}

func (m *manager) Get(ctx context.Context, id int64) (model.Accessory, error) {
	acc, err := m.dao.Get(ctx, id)
	if err != nil {
		return nil, err
	}
	return model.New(acc.Type, model.AccessoryData{
		ID:                acc.ID,
		ArtifactID:        acc.ArtifactID,
		SubArtifactID:     acc.SubjectArtifactID,
		SubArtifactRepo:   acc.SubjectArtifactRepo,
		SubArtifactDigest: acc.SubjectArtifactDigest,
		Size:              acc.Size,
		Digest:            acc.Digest,
		CreatTime:         acc.CreationTime,
		Icon:              m.GetIcon(acc.Type),
	})
}

func (m *manager) Count(ctx context.Context, query *q.Query) (int64, error) {
	return m.dao.Count(ctx, query)
}

func (m *manager) List(ctx context.Context, query *q.Query) ([]model.Accessory, error) {
	accsDao, err := m.dao.List(ctx, query)
	if err != nil {
		return nil, err
	}
	var accs []model.Accessory
	for _, accD := range accsDao {
		acc, err := model.New(accD.Type, model.AccessoryData{
			ID:                accD.ID,
			ArtifactID:        accD.ArtifactID,
			SubArtifactID:     accD.SubjectArtifactID,
			SubArtifactRepo:   accD.SubjectArtifactRepo,
			SubArtifactDigest: accD.SubjectArtifactDigest,
			Size:              accD.Size,
			Digest:            accD.Digest,
			CreatTime:         accD.CreationTime,
			Icon:              m.GetIcon(accD.Type),
		})
		if err != nil {
			return nil, errors.New(err).WithCode(errors.BadRequestCode)
		}
		accs = append(accs, acc)
	}
	return accs, nil
}

func (m *manager) Create(ctx context.Context, accessory model.AccessoryData) (int64, error) {
	acc := &dao.Accessory{
		ArtifactID:            accessory.ArtifactID,
		SubjectArtifactID:     accessory.SubArtifactID,
		SubjectArtifactRepo:   accessory.SubArtifactRepo,
		SubjectArtifactDigest: accessory.SubArtifactDigest,
		Size:                  accessory.Size,
		Digest:                accessory.Digest,
		Type:                  accessory.Type,
	}
	return m.dao.Create(ctx, acc)
}

func (m *manager) Update(ctx context.Context, accessory model.AccessoryData) error {
	acc := &dao.Accessory{
		ID:                accessory.ID,
		SubjectArtifactID: accessory.SubArtifactID,
	}
	return m.dao.Update(ctx, acc)
}

func (m *manager) Delete(ctx context.Context, id int64) error {
	return m.dao.Delete(ctx, id)
}

func (m *manager) DeleteAccessories(ctx context.Context, q *q.Query) error {
	_, err := m.dao.DeleteAccessories(ctx, q)
	return err
}

func (m *manager) GetIcon(accType string) string {
	accIcon := ""
	if i, ok := defaultIcons[accType]; ok {
		accIcon = i
	}
	return accIcon
}