portal/api/s5/file.go

package s5

import (
	"context"
	"encoding/hex"
	"errors"
	"io"
	"io/fs"
	"time"

	s5libmetadata "git.lumeweb.com/LumeWeb/libs5-go/metadata"

	"git.lumeweb.com/LumeWeb/portal/protocols/s5"

	"git.lumeweb.com/LumeWeb/portal/metadata"

	"git.lumeweb.com/LumeWeb/portal/storage"

	"git.lumeweb.com/LumeWeb/libs5-go/encoding"
	"git.lumeweb.com/LumeWeb/libs5-go/types"
)

var _ io.ReadSeekCloser = (*S5File)(nil)
var _ fs.File = (*S5File)(nil)
var _ fs.FileInfo = (*S5FileInfo)(nil)

type S5File struct {
	reader   io.ReadCloser
	hash     []byte
	storage  storage.StorageService
	metadata metadata.MetadataService
	record   *metadata.UploadMetadata
	protocol *s5.S5Protocol
	cid      *encoding.CID
	typ      types.CIDType
	read     bool
	tus      *s5.TusHandler
	ctx      context.Context
	name     string
}

type FileParams struct {
	Storage  storage.StorageService
	Metadata metadata.MetadataService
	Hash     []byte
	Type     types.CIDType
	Protocol *s5.S5Protocol
	Tus      *s5.TusHandler
	Name     string
}

func NewFile(params FileParams) *S5File {
	return &S5File{
		storage:  params.Storage,
		metadata: params.Metadata,
		hash:     params.Hash,
		typ:      params.Type,
		protocol: params.Protocol,
		tus:      params.Tus,
		ctx:      context.Background(),
		name:     params.Name,
	}
}

func (f *S5File) Exists() bool {
	_, err := f.metadata.GetUpload(context.Background(), f.hash)

	if err != nil {
		return false
	}

	return true
}

func (f *S5File) Read(p []byte) (n int, err error) {
	err = f.init(0)
	if err != nil {
		return 0, err
	}
	f.read = true

	return f.reader.Read(p)
}

func (f *S5File) Seek(offset int64, whence int) (int64, error) {
	switch whence {
	case io.SeekStart:
		if !f.read {
			return 0, nil
		}

		if f.reader != nil {
			err := f.reader.Close()
			if err != nil {
				return 0, err
			}
			f.reader = nil
		}
		err := f.init(offset)
		if err != nil {
			return 0, err
		}
	case io.SeekCurrent:
		return 0, errors.New("not supported")
	case io.SeekEnd:
		return int64(f.Size()), nil
	default:
		return 0, errors.New("invalid whence")
	}

	return 0, nil
}

func (f *S5File) Close() error {
	if f.reader != nil {
		r := f.reader
		f.reader = nil
		return r.Close()
	}

	return nil
}

func (f *S5File) init(offset int64) error {
	if f.reader == nil {
		reader, err := f.tus.GetUploadReader(f.ctx, f.hash, offset)

		if err == nil {
			f.reader = reader
			f.read = false
			return nil
		}

		reader, err = f.storage.DownloadObject(context.Background(), f.StorageProtocol(), f.hash, offset)
		if err != nil {
			return err
		}

		f.reader = reader
		f.read = false
	}

	return nil
}

func (f *S5File) Record() (*metadata.UploadMetadata, error) {
	if f.record == nil {
		record, err := f.metadata.GetUpload(context.Background(), f.Hash())

		if err != nil {
			return nil, errors.New("file does not exist")
		}

		f.record = &record
	}

	return f.record, nil
}

func (f *S5File) Hash() []byte {
	hashStr := f.HashString()

	if hashStr == "" {
		return nil
	}

	str, err := hex.DecodeString(hashStr)
	if err != nil {
		return nil
	}

	return str
}

func (f *S5File) HashString() string {
	record, err := f.Record()
	if err != nil {
		return ""
	}

	return hex.EncodeToString(record.Hash)
}

func (f *S5File) Name() string {
	if f.name != "" {
		return f.name
	}

	cid, _ := f.CID().ToString()

	return cid
}

func (f *S5File) Modtime() time.Time {
	record, err := f.Record()
	if err != nil {
		return time.Unix(0, 0)
	}

	return record.Created
}
func (f *S5File) Size() uint64 {
	record, err := f.Record()
	if err != nil {
		return 0
	}

	return record.Size
}
func (f *S5File) CID() *encoding.CID {
	if f.cid == nil {
		multihash := encoding.MultihashFromBytes(f.Hash(), types.HashTypeBlake3)

		typ := f.typ
		if typ == 0 {
			typ = types.CIDTypeRaw
		}

		cid := encoding.NewCID(typ, *multihash, f.Size())
		f.cid = cid
	}
	return f.cid
}

func (f *S5File) Mime() string {
	record, err := f.Record()
	if err != nil {
		return ""
	}

	return record.MimeType
}

func (f *S5File) StorageProtocol() storage.StorageProtocol {
	return s5.GetStorageProtocol(f.protocol)
}

func (f *S5File) Proof() ([]byte, error) {
	object, err := f.storage.DownloadObjectProof(context.Background(), f.StorageProtocol(), f.hash)

	if err != nil {
		return nil, err
	}

	proof, err := io.ReadAll(object)
	if err != nil {
		return nil, err
	}

	err = object.Close()
	if err != nil {
		return nil, err
	}

	return proof, nil
}
func (f *S5File) Manifest() (s5libmetadata.Metadata, error) {
	meta, err := f.protocol.Node().Services().Storage().GetMetadataByCID(f.CID())
	if err != nil {
		return nil, err
	}

	return meta, nil
}

func (f *S5File) Stat() (fs.FileInfo, error) {
	return newS5FileInfo(f), nil
}

type S5FileInfo struct {
	file *S5File
}

func (s S5FileInfo) Name() string {
	return s.file.Name()
}

func (s S5FileInfo) Size() int64 {
	return int64(s.file.Size())
}

func (s S5FileInfo) Mode() fs.FileMode {
	return 0
}

func (s S5FileInfo) ModTime() time.Time {
	return s.file.Modtime()
}

func (s S5FileInfo) IsDir() bool {
	return s.file.typ == types.CIDTypeDirectory
}

func (s S5FileInfo) Sys() any {
	return nil
}

func newS5FileInfo(file *S5File) *S5FileInfo {
	return &S5FileInfo{
		file: file,
	}
}