portainer/api/dataservices/version/version.go

package version

import (
	"errors"

	portainer "github.com/portainer/portainer/api"
	"github.com/portainer/portainer/api/database/models"
	"github.com/portainer/portainer/api/dataservices"
	dserrors "github.com/portainer/portainer/api/dataservices/errors"
)

const (
	// BucketName represents the name of the bucket where this service stores data.
	BucketName  = "version"
	versionKey  = "VERSION"
	updatingKey = "DB_UPDATING"
)

// Service represents a service to manage stored versions.
type Service struct {
	connection portainer.Connection
}

// NewService creates a new instance of a service.
func NewService(connection portainer.Connection) (*Service, error) {
	err := connection.SetServiceName(BucketName)
	if err != nil {
		return nil, err
	}

	return &Service{
		connection: connection,
	}, nil
}

func (service *Service) Tx(tx portainer.Transaction) ServiceTx {
	return ServiceTx{
		BaseDataServiceTx: dataservices.BaseDataServiceTx[models.Version, int]{
			Bucket:     BucketName,
			Connection: service.connection,
			Tx:         tx,
		},
	}
}

func (service *Service) SchemaVersion() (string, error) {
	v, err := service.Version()
	if err != nil {
		return "", err
	}

	return v.SchemaVersion, nil
}

func (service *Service) UpdateSchemaVersion(version string) error {
	v, err := service.Version()
	if err != nil {
		return err
	}

	v.SchemaVersion = version
	return service.UpdateVersion(v)
}

func (service *Service) Edition() (portainer.SoftwareEdition, error) {
	v, err := service.Version()
	if err != nil {
		return 0, err
	}

	return portainer.SoftwareEdition(v.Edition), nil
}

// IsUpdating retrieves the database updating status.
func (service *Service) IsUpdating() (bool, error) {
	var isUpdating bool
	err := service.connection.GetObject(BucketName, []byte(updatingKey), &isUpdating)
	if err != nil && errors.Is(err, dserrors.ErrObjectNotFound) {
		return false, nil
	}
	return isUpdating, err
}

// StoreIsUpdating store the database updating status.
func (service *Service) StoreIsUpdating(isUpdating bool) error {
	if isUpdating {
		return service.connection.UpdateObject(BucketName, []byte(updatingKey), isUpdating)
	}

	return service.connection.DeleteObject(BucketName, []byte(updatingKey))
}

// InstanceID retrieves the stored instance ID.
func (service *Service) InstanceID() (string, error) {
	v, err := service.Version()
	if err != nil {
		return "", err
	}

	return v.InstanceID, nil
}

// StoreInstanceID store the instance ID.
func (service *Service) UpdateInstanceID(id string) error {
	v, err := service.Version()
	if err != nil {
		if !dataservices.IsErrObjectNotFound(err) {
			return err
		}

		v = &models.Version{}
	}

	v.InstanceID = id
	return service.UpdateVersion(v)
}

// Version retrieve the version object.
func (service *Service) Version() (*models.Version, error) {
	var v models.Version

	err := service.connection.GetObject(BucketName, []byte(versionKey), &v)
	if err != nil {
		return nil, err
	}

	return &v, nil
}

// UpdateVersion persists a Version object.
func (service *Service) UpdateVersion(version *models.Version) error {
	return service.connection.UpdateObject(BucketName, []byte(versionKey), version)
}