core

package

Go to main page

Versions in this module

v0

v0.4.1

Jan 6, 2025

v0.4.0

Dec 31, 2024

v0.3.2

Nov 6, 2024

v0.3.1

Nov 6, 2024

v0.3.0

Nov 6, 2024

Changes in this version

type CronService

+ CreateRecurringOneOffJob func(function string, args any) error

type PluginInfo

+ Version build.BuildInfo

type PortalMeta

+ Build build.Info

type PortalMetaBuilder

+ AddPluginWithBuild func(key string, buildInfo build.Info) PortalMetaBuilder

type PortalMetaPlugin

+ Build build.Info

+ type RenterHostFilterMode string

+ const RenterHostFilterModeAll

+ const RenterHostFilterModeAllowed

+ const RenterHostFilterModeBlocked

+ type RenterHostUsabilityMode string

+ const RenterHostUsabilityModeAll

+ const RenterHostUsabilityModeUnusable

+ const RenterHostUsabilityModeUsable

type RenterService

+ AddHostsToAllowlist func(ctx context.Context, hosts []types.PublicKey) error

+ AutopilotConfig func(_ context.Context) (api.AutopilotConfig, error)

+ AutopilotHosts func(ctx context.Context, usabilityMode RenterHostUsabilityMode, ...) ([]api.HostResponse, error)

+ AutopilotState func(_ context.Context) (api.AutopilotStateResponse, error)

+ ConsensusState func(ctx context.Context) (api.ConsensusState, error)

+ GetAllowlistedHosts func(ctx context.Context) ([]types.PublicKey, error)

+ Host func(ctx context.Context, host types.PublicKey) (api.Host, error)

+ Hosts func(ctx context.Context, usabilityMode RenterHostUsabilityMode, ...) ([]api.Host, error)

+ RecommendedFee func(ctx context.Context) (types.Currency, error)

+ ScanHost func(ctx context.Context, host types.PublicKey, hostIP string) (api.RHPScanResponse, error)

+ TestAutoPilotConfig func(ctx context.Context, gs api.GougingSettings) (api.ConfigEvaluationResponse, error)

+ TriggerAutoPilot func(_ context.Context) (bool, error)

v0.2.1

Oct 31, 2024

v0.2.0

Oct 30, 2024

Changes in this version

+ const ACCESS_ADMIN_ROLE

+ const ACCESS_SERVICE

+ const ACCESS_USER_ROLE

+ const CONFIG_SERVICE

+ const MAILER_TPL_PASSWORD_RESET

+ const MAILER_TPL_VERIFY_EMAIL

+ const REQUEST_SERVICE

+ const TEMPORARY_UPLOADS_PATH

+ const TUS_SERVICE

+ const UPLOAD_SERVICE

+ var ErrDuplicateRequest = errors.New("duplicate request")

+ var ErrProofNotSupported = errors.New("protocol does not support proofs")

+ var ErrUploadNotFound = errors.New("upload not found")

+ func APIExists(id string) bool

+ func CronTaskDefinitionDaily() gocron.JobDefinition

+ func GetService[T Service](ctx Context, id string) T

+ func IsAccountError(err error) bool

+ func PluginHasCron(pi PluginInfo) bool

+ func ProtocolExists(id string) bool

+ func ProtocolHasDataRequestHandler(name string) bool

+ func ProtocolHasPinHandler(name string) bool

+ func RegisterUploadDataHandler(id string, handler UploadDataHandler)

+ func ServiceExists(ctx Context, id string) bool

type API

+ Name func() string

+ type AccessModel struct

+ Matchers AccessModelDef

+ PolicyDefinition AccessModelDef

+ PolicyEffect AccessModelDef

+ RequestDefinition AccessModelDef

+ RoleDefinition AccessModelDef

+ type AccessModelDef struct

+ Key string

+ Value string

+ type AccessPolicy struct

+ Action string

+ Domain string

+ Object string

+ Subject string

+ type AccessService interface

+ AssignRoleToUser func(userId uint, role string) error

+ CheckAccess func(userId uint, fqdn, path, method string) (bool, error)

+ ExportModel func() *AccessModel

+ ExportUserPolicy func(userId uint) ([]*AccessPolicy, error)

+ RegisterRoute func(subdomain, path, method, role string) error

type AccountError

+ func AsAccountError(err error) *AccountError

+ func (e *AccountError) HttpStatus() int

+ func (e *AccountError) IsErrorType(key AccountErrorType) bool

+ type AccountErrorType string

+ const ErrKeyAccountDeletionRequestAlreadyExists

+ const ErrKeyAccountNotVerified

+ const ErrKeyAccountPendingDeletion

+ const ErrKeyAssigningAdminRoleFailed

+ const ErrorAssigningUserRoleFailed

type AuthService

+ LoginID func(id uint, ip string) (string, error)

+ type ConfigPropertyUpdateHandler func(key string, value any) error

+ type ConfigService interface

+ RegisterPropertyHandler func(scope config.Scope, handler ConfigPropertyUpdateHandler)

type Context

+ APILogger func(api API) *Logger

+ GetContext func() context.Context

+ NamedLogger func(name string) *Logger

+ ProtocolLogger func(protocol Protocol) *Logger

+ ServiceLogger func(service Service) *Logger

type ContextBuilderOption

+ func ContextWithCron(factory CronFactory) ContextBuilderOption

+ type CronFactory func(Context) (Cronable, error)

+ type CronTaskArgs interface

type CronTaskFunction

+ func CronTaskFuncHandler[T CronTaskArgs](f func(args T, ctx Context) error) CronTaskFunction[CronTaskArgs]

+ type DBMigration func(*gorm.DB) error

type Event

+ func (e *Event) Abort(abort bool)

+ func (e *Event) Add(key string, val any)

+ func (e *Event) AttachTo(em event.ManagerFace)

+ func (e *Event) Data() map[string]any

+ func (e *Event) Fill(target any, data event.M) *Event

+ func (e *Event) Get(key string) any

+ func (e *Event) IsAborted() bool

+ func (e *Event) Name() string

+ func (e *Event) Set(key string, val any)

+ func (e *Event) SetData(data event.M) event.Event

+ func (e *Event) SetName(name string) Eventer

+ func (e *Event) SetTarget(target any) *Event

+ func (e *Event) Target() any

type Eventer

+ SetName func(name string) Eventer

type HTTPService

+ APISubdomain func(id string, proto bool) string

+ type LifecycleFunc func(Context) error

type MailerService

+ TemplateRegister func(name string, template MailerTemplate) error

+ type MailerTemplate interface

+ Body func() *template.Template

+ Subject func() *template.Template

+ type MailerTemplates map[string]MailerTemplate

+ type MultipartUploadParams struct

+ Bucket string

+ FileName string

+ ReaderFactory ReaderFactory

+ Size uint64

+ type PinFilter struct

+ CreatedAfter time.Time

+ Hash StorageHash

+ Limit int

+ Offset int

+ Protocol string

+ Status string

+ UploadID uint

+ UserID uint

type PinService

+ AllAccountPins func(id uint) ([]*models.Pin, error)

+ CreatePin func(ctx context.Context, pin *models.Pin, protocolData any) (*models.Pin, error)

+ DeletePin func(ctx context.Context, id uint) error

+ GetPin func(ctx context.Context, id uint) (*models.Pin, error)

+ GetPinsByUploadID func(ctx context.Context, uploadID uint) ([]*models.Pin, error)

+ GetProtocolPin func(ctx context.Context, id uint) (any, error)

+ QueryPin func(ctx context.Context, query interface{}, filter PinFilter) (*models.Pin, error)

+ QueryProtocolPin func(ctx context.Context, protocol string, query any, filter PinFilter) (any, error)

+ UpdatePin func(ctx context.Context, pin *models.Pin) error

+ UpdateProtocolPin func(ctx context.Context, id uint, protocolData any) error

type PluginInfo

+ Cron func() CronFactory

+ MailerTemplates MailerTemplates

+ Meta func(Context, PortalMetaBuilder) error

+ Migrations []DBMigration

+ type PortalMeta struct

+ Domain string

+ FeatureFlags map[string]bool

+ Plugins PortalMetaPlugins

+ type PortalMetaBuilder interface

+ AddFeatureFlag func(key string, value bool) PortalMetaBuilder

+ AddPlugin func(key string) PortalMetaBuilder

+ AddPluginMeta func(pluginKey string, metaKey string, metaValue any) PortalMetaBuilder

+ Build func() *PortalMeta

+ type PortalMetaPlugin struct

+ Meta map[string]any

+ type PortalMetaPlugins = map[string]PortalMetaPlugin

+ type ProtocolPinHandler interface

+ CreateProtocolPin func(ctx context.Context, id uint, data any) error

+ DeleteProtocolPin func(ctx context.Context, id uint) error

+ GetProtocolPin func(ctx context.Context, tx *gorm.DB, id uint) (any, error)

+ GetProtocolPinModel func() any

+ QueryProtocolPin func(ctx context.Context, query any) *gorm.DB

+ UpdateProtocolPin func(ctx context.Context, id uint, data any) error

+ func GetProtocolPinHandler(name string) ProtocolPinHandler

+ type ProtocolRequestDataHandler interface

+ CompleteProtocolData func(ctx context.Context, id uint) error

+ CreateProtocolData func(ctx context.Context, id uint, data any) error

+ DeleteProtocolData func(ctx context.Context, id uint) error

+ GetProtocolData func(ctx context.Context, tx *gorm.DB, id uint) (any, error)

+ GetProtocolDataModel func() any

+ QueryProtocolData func(ctx context.Context, tx *gorm.DB, query any) *gorm.DB

+ UpdateProtocolData func(ctx context.Context, id uint, data any) error

+ func GetProtocolDataRequestHandler(name string) ProtocolRequestDataHandler

type RenterService

+ SlabSize func(ctx context.Context) (uint64, error)

+ type RequestFilter struct

+ Limit int

+ Offset int

+ Operation models.RequestOperationType

+ Protocol string

+ UserID uint

+ type RequestService interface

+ CompleteRequest func(ctx context.Context, id uint) error

+ CompleteUploadData func(ctx context.Context, id uint) error

+ CreateRequest func(ctx context.Context, req *models.Request, protocolData any, uploadData any) (*models.Request, error)

+ DeleteRequest func(ctx context.Context, id uint) error

+ DeleteUploadData func(ctx context.Context, id uint) error

+ GetProtocolData func(ctx context.Context, id uint) (any, error)

+ GetRequest func(ctx context.Context, id uint) (*models.Request, error)

+ GetRequestByHash func(ctx context.Context, hash StorageHash, filter RequestFilter) (*models.Request, error)

+ GetRequestByUploadHash func(ctx context.Context, hash StorageHash, filter RequestFilter) (*models.Request, error)

+ GetUploadData func(ctx context.Context, id uint) (any, error)

+ ListRequestsByStatus func(ctx context.Context, status string, filter RequestFilter) ([]*models.Request, error)

+ ListRequestsByUser func(ctx context.Context, userID uint, filter RequestFilter) ([]*models.Request, error)

+ QueryProtocolData func(ctx context.Context, protocol string, query any, filter RequestFilter) (any, error)

+ QueryRequest func(ctx context.Context, query any, filter RequestFilter) (*models.Request, error)

+ QueryUploadData func(ctx context.Context, uploadMethod models.RequestOperationType, query any, ...) (any, error)

+ RequestExists func(ctx context.Context, id uint) (bool, error)

+ UpdateProtocolData func(ctx context.Context, id uint, data any) error

+ UpdateRequest func(ctx context.Context, req *models.Request) error

+ UpdateRequestStatus func(ctx context.Context, id uint, status models.RequestStatusType) error

+ UpdateUploadData func(ctx context.Context, id uint, data any) error

type Service

+ ID func() string

+ type StorageHash interface

+ CIDType func() uint64

+ Multihash func() mh.Multihash

+ Proof func() []byte

+ ProofExists func() bool

+ Type func() uint64

type StorageProtocol

+ Hash func(r io.Reader, size uint64) (StorageHash, error)

type StorageService

+ S3DeleteTemporaryUpload func(ctx context.Context, protocol StorageProtocol, uploadId string) error

+ S3GetTemporaryUpload func(ctx context.Context, protocol StorageProtocol, uploadId string) (io.ReadCloser, error)

+ S3TemporaryUpload func(ctx context.Context, data io.ReadCloser, size uint64, protocol StorageProtocol) (string, error)

+ type StorageUploadOption func(StorageUploadRequest)

+ func StorageUploadWithData(data io.ReadSeeker) StorageUploadOption

+ func StorageUploadWithMultipartUploadParams(params *MultipartUploadParams) StorageUploadOption

+ func StorageUploadWithProof(proof StorageHash) StorageUploadOption

+ func StorageUploadWithProtocol(protocol StorageProtocol) StorageUploadOption

+ func StorageUploadWithSize(size uint64) StorageUploadOption

+ type StorageUploadRequest interface

+ Data func() io.ReadSeeker

+ Hash func() StorageHash

+ MuParams func() *MultipartUploadParams

+ Protocol func() StorageProtocol

+ SetData func(io.ReadSeeker)

+ SetHash func(StorageHash)

+ SetMuParams func(*MultipartUploadParams)

+ SetProtocol func(StorageProtocol)

+ SetSize func(uint64)

+ Size func() uint64

+ type TUSService interface

+ CreateUpload func(ctx context.Context, hash StorageHash, uploadID string, uploaderID uint, ...) (*models.TUSRequest, error)

+ DeleteUpload func(ctx context.Context, uploadID string) error

+ SetHash func(ctx context.Context, uploadID string, hash StorageHash) error

+ UploadCompleted func(ctx context.Context, uploadID string) error

+ UploadExists func(ctx context.Context, id string) (bool, *models.TUSRequest)

+ UploadHashExists func(ctx context.Context, hash StorageHash) (bool, *models.TUSRequest)

+ UploadProcessing func(ctx context.Context, uploadID string) error

+ UploadProgress func(ctx context.Context, uploadID string) error

+ Uploads func(ctx context.Context, uploaderID uint) ([]*models.TUSRequest, error)

+ type UploadDataHandler interface

+ CompleteUploadData func(ctx context.Context, tx *gorm.DB, id uint) error

+ CreateUploadData func(ctx context.Context, tx *gorm.DB, id uint, data any) error

+ DeleteUploadData func(ctx context.Context, tx *gorm.DB, id uint) error

+ GetUploadData func(ctx context.Context, tx *gorm.DB, id uint) (any, error)

+ GetUploadDataModel func() any

+ QueryUploadData func(ctx context.Context, tx *gorm.DB, query any) *gorm.DB

+ UpdateUploadData func(ctx context.Context, tx *gorm.DB, id uint, data any) error

+ func GetUploadDataHandler(id string) (UploadDataHandler, bool)

+ type UploadService interface

+ DeleteUpload func(ctx context.Context, objectHash StorageHash) error

+ GetAllUploads func(ctx context.Context) ([]*models.Upload, error)

+ GetUpload func(ctx context.Context, objectHash StorageHash) (*models.Upload, error)

+ GetUploadByID func(ctx context.Context, uploadID uint) (*models.Upload, error)

+ SaveUpload func(ctx context.Context, upload *models.Upload) error

type UserService

+ DeleteAccount func(userId uint) error

+ GetAccountsPendingDeletion func() ([]*models.User, error)

+ IsAccountPendingDeletion func(userId uint) (bool, error)

+ IsAccountVerified func(userId uint) (bool, error)

+ RequestAccountDeletion func(userId uint, userIP string) error

v0.1.1

Jun 19, 2024

Changes in this version

+ const EVENT_STORAGE_OBJECT_UPLOADED

+ func RegisterEvent(id string, event Eventer)

type ContextBuilderOption

+ func ContextWithDB(db *gorm.DB) ContextBuilderOption

+ func ContextWithEvents(events ...Eventer) ContextBuilderOption

+ type Event struct

+ type Eventer interface

+ func GetEvents() []Eventer

type HTTPService

+ Init func() error

type PluginInfo

+ Events []Eventer

+ type StorageObjectUploadedEvent struct

+ func (e *StorageObjectUploadedEvent) Name() string

+ func (e *StorageObjectUploadedEvent) ObjectMetadata() *UploadMetadata

v0.1.0

Jun 19, 2024

Changes in this version

+ const AUTH_COOKIE_NAME

+ const AUTH_SERVICE

+ const AUTH_TOKEN_NAME

+ const CRON_SERVICE

+ const DNSLINK_SERVICE

+ const EVENT_USER_SUBDOMAIN_SET

+ const ErrKeyAccountAlreadyVerified

+ const ErrKeyAccountCreationFailed

+ const ErrKeyAccountSubdomainNotSet

+ const ErrKeyAccountUpdateFailed

+ const ErrKeyAddPublicKeyFailed

+ const ErrKeyDatabaseOperationFailed

+ const ErrKeyEmailAlreadyExists

+ const ErrKeyHashingFailed

+ const ErrKeyInvalidLogin

+ const ErrKeyInvalidOTPCode

+ const ErrKeyInvalidPassword

+ const ErrKeyJWTGenerationFailed

+ const ErrKeyLoginFailed

+ const ErrKeyOTPDisableFailed

+ const ErrKeyOTPEnableFailed

+ const ErrKeyOTPGenerationFailed

+ const ErrKeyOTPVerificationFailed

+ const ErrKeyPasswordHashingFailed

+ const ErrKeyPinAddFailed

+ const ErrKeyPinDeleteFailed

+ const ErrKeyPinsRetrievalFailed

+ const ErrKeyPublicKeyExists

+ const ErrKeyPublicKeyNotFound

+ const ErrKeySecurityInvalidToken

+ const ErrKeySecurityTokenExpired

+ const ErrKeyUpdatingSameEmail

+ const ErrKeyUserNotFound

+ const ExitCodeFailedQuit

+ const ExitCodeFailedStartup

+ const ExitCodeForceQuit

+ const ExitCodeSuccess

+ const HTTP_SERVICE

+ const IMPORT_SERVICE

+ const MAILER_SERVICE

+ const METADATA_SERVICE

+ const OTP_SERVICE

+ const PASSWORD_RESET_SERVICE

+ const PIN_SERVICE

+ const PROOF_EXTENSION

+ const RENTER_SERVICE

+ const S3_MULTIPART_MAX_PARTS

+ const S3_MULTIPART_MIN_PART_SIZE

+ const STORAGE_SERVICE

+ const USER_SERVICE

+ var ErrInvalidModel = errors.New("model is invalid")

+ var ErrInvalidOTPCode = errors.New("Invalid OTP code")

+ var ErrJWTInvalid = errors.New("invalid JWT")

+ var ErrJWTUnexpectedClaimsType = errors.New("unexpected claims type")

+ var ErrJWTUnexpectedIssuer = errors.New("unexpected issuer")

+ var ErrorCodeToHttpStatus = map[string]int

+ func ClearAuthCookie(w http.ResponseWriter, ctx Context)

+ func CronTaskDefinitionOneTimeJob() gocron.JobDefinition

+ func CronTaskNoArgsFactory() any

+ func EchoAuthCookie(w http.ResponseWriter, r *http.Request, ctx Context)

+ func GenerateSecurityToken() string

+ func GetAPIs() map[string]API

+ func GetPluginForService(id string) string

+ func GetProtocols() map[string]Protocol

+ func IsCoreService(id string) bool

+ func JWTGenerateToken(domain string, privateKey ed25519.PrivateKey, userID uint, purpose JWTPurpose) (string, error)

+ func JWTGenerateTokenWithDuration(domain string, privateKey ed25519.PrivateKey, userID uint, ...) (string, error)

+ func JWTVerifyToken(token string, domain string, privateKey ed25519.PrivateKey, ...) (*jwt.RegisteredClaims, error)

+ func PluginHasAPI(plugin PluginInfo) bool

+ func PluginHasProtocol(plugin PluginInfo) bool

+ func PluginHasServices(plugin PluginInfo) bool

+ func RegisterAPI(id string, api API)

+ func RegisterPlugin(info PluginInfo)

+ func RegisterProtocol(id string, protocol Protocol)

+ func RegisterService(service ServiceInfo, plugin ...string)

+ func RegisterServicesFromPlugins()

+ func SendJWT(w http.ResponseWriter, jwt string)

+ func SetAuthCookie(w http.ResponseWriter, ctx Context, jwt string)

+ func TOTPGenerate(domain string, email string) (string, error)

+ func TOTPValidate(secret string, code string) bool

+ type API interface

+ AuthTokenName func() string

+ Config func() config.APIConfig

+ Configure func(router *gorilla.Router) error

+ Subdomain func() string

+ func GetAPI(id string) API

+ func GetAPIList() []API

+ type APIInit interface

+ Init func() ([]ContextBuilderOption, error)

+ type AccountError struct

+ Err error

+ Key string

+ Message string

+ func NewAccountError(key string, err error, customMessage ...string) *AccountError

+ func (e *AccountError) Error() string

+ type AuthService interface

+ LoginOTP func(userId uint, code string) (string, error)

+ LoginPassword func(email string, password string, ip string) (string, *models.User, error)

+ LoginPubkey func(pubkey string, ip string) (string, error)

+ ValidLoginByEmail func(email string, password string) (bool, *models.User, error)

+ ValidLoginByUserID func(id uint, password string) (bool, *models.User, error)

+ ValidLoginByUserObj func(user *models.User, password string) bool

+ type Configurable interface

+ Config func() (any, error)

+ type Context struct

+ func NewContext(config config.Manager, logger *Logger, options ...ContextBuilderOption) (Context, error)

+ func (ctx *Context) Cancel()

+ func (ctx *Context) Config() config.Manager

+ func (ctx *Context) DB() *gorm.DB

+ func (ctx *Context) Event() *event.Manager

+ func (ctx *Context) ExitCode() int

+ func (ctx *Context) ExitFuncs() []func(Context) error

+ func (ctx *Context) Logger() *Logger

+ func (ctx *Context) OnExit(f func(Context) error)

+ func (ctx *Context) OnStartup(f func(Context) error)

+ func (ctx *Context) Service(id string) any

+ func (ctx *Context) SetDB(db *gorm.DB)

+ func (ctx *Context) SetExitCode(code int)

+ func (ctx *Context) StartupFuncs() []func(Context) error

+ type ContextBuilderFunc func() error

+ type ContextBuilderOption func(Context) (Context, error)

+ func ContextOptions(options ...ContextBuilderOption) []ContextBuilderOption

+ func ContextWithExitFunc(f ExitFunc) ContextBuilderOption

+ func ContextWithService(id string, svc Service) ContextBuilderOption

+ func ContextWithStartupFunc(f StartupFunc) ContextBuilderOption

+ type CronService interface

+ CreateExistingJobScheduled func(uuid uuid.UUID, jobDef gocron.JobDefinition) error

+ CreateJob func(function string, args any, tags []string) error

+ CreateJobIfNotExists func(function string, args any, tags []string) error

+ CreateJobScheduled func(function string, args any, tags []string, jobDef gocron.JobDefinition) error

+ JobExists func(function string, args any, tags []string) (bool, *models.CronJob)

+ RegisterEntity func(entity Cronable)

+ RegisterTask func(name string, taskFunc CronTaskFunction, ...)

+ Start func() error

+ type CronTaskArgsFactoryFunction func() any

+ type CronTaskDefArgsFactoryFunction func() gocron.JobDefinition

+ type CronTaskFunction func(any, Context) error

+ type CronTaskNoArgs struct

+ type Cronable interface

+ RegisterTasks func(cron CronService) error

+ ScheduleJobs func(cron CronService) error

+ type DNSLinkService interface

+ DNSLinkExists func(hash []byte) (bool, *models.DNSLink, error)

+ type ExitFunc func(Context) error

+ type FileNameEncoderFunc func([]byte) string

+ type HTTPService interface

+ Router func() *mux.Router

+ Serve func() error

+ type ImportMetadata struct

+ Created time.Time

+ Hash []byte

+ ID uint

+ ImporterIP string

+ Progress float64

+ Protocol string

+ Status models.ImportStatus

+ UserID uint

+ func (u ImportMetadata) IsEmpty() bool

+ type ImportService interface

+ DeleteImport func(ctx context.Context, objectHash []byte) error

+ GetImport func(ctx context.Context, objectHash []byte) (ImportMetadata, error)

+ SaveImport func(ctx context.Context, metadata ImportMetadata, skipExisting bool) error

+ UpdateProgress func(ctx context.Context, objectHash []byte, stage int, totalStages int) error

+ UpdateStatus func(ctx context.Context, objectHash []byte, status models.ImportStatus) error

+ type JWTPurpose string

+ const JWTPurpose2FA

+ const JWTPurposeLogin

+ const JWTPurposeNone

+ type Logger struct

+ func NewLogger(cm config.Manager) *Logger

+ func (l *Logger) Level() *zap.AtomicLevel

+ func (l *Logger) SetLevelFromConfig()

+ type MailerService interface

+ TemplateSend func(template string, subjectVars MailerTemplateData, bodyVars MailerTemplateData, ...) error

+ type MailerTemplateData = map[string]any

+ type MetadataService interface

+ DeleteUpload func(ctx context.Context, objectHash []byte) error

+ GetAllUploads func(ctx context.Context) ([]UploadMetadata, error)

+ GetUpload func(ctx context.Context, objectHash []byte) (UploadMetadata, error)

+ SaveUpload func(ctx context.Context, metadata UploadMetadata, skipExisting bool) error

+ type MultiPartUploadParams struct

+ Bucket string

+ FileName string

+ ReaderFactory ReaderFactory

+ Size uint64

+ UploadIDHandler UploadIDHandler

+ type OTPService interface

+ OTPDisable func(userId uint) error

+ OTPEnable func(userId uint, code string) error

+ OTPGenerate func(userId uint) (string, error)

+ OTPVerify func(userId uint, code string) (bool, error)

+ type PasswordResetService interface

+ ResetPassword func(email string, token string, password string) error

+ SendPasswordReset func(user *models.User) error

+ type PinService interface

+ AccountPins func(id uint, createdAfter uint64) ([]models.Pin, error)

+ DeletePinByHash func(hash []byte, userId uint) error

+ PinByHash func(hash []byte, userId uint) error

+ PinByID func(uploadId uint, userId uint) error

+ UploadPinnedByUser func(hash []byte, userId uint) (bool, error)

+ UploadPinnedGlobal func(hash []byte) (bool, error)

+ type PluginFactory func() PluginInfo

+ type PluginInfo struct

+ API func() (API, []ContextBuilderOption, error)

+ Depends []string

+ ID string

+ Models []any

+ Protocol func() (Protocol, []ContextBuilderOption, error)

+ Services func() ([]ServiceInfo, error)

+ func GetPlugin(name string) PluginInfo

+ func GetPlugins() []PluginInfo

+ func (pi PluginInfo) String() string

+ type Protocol interface

+ Config func() config.ProtocolConfig

+ Name func() string

+ func GetProtocol(id string) Protocol

+ func GetProtocolList() []Protocol

+ type ProtocolInit interface

+ Init func(ctx *Context) error

+ type ProtocolStart interface

+ Start func(ctx Context) error

+ type ProtocolStop interface

+ Stop func(ctx Context) error

+ type ReaderFactory func(start uint, end uint) (io.ReadCloser, error)

+ type RenterService interface

+ CreateBucketIfNotExists func(bucket string) error

+ DeleteObject func(ctx context.Context, bucket string, fileName string) error

+ DeleteObjectMetadata func(ctx context.Context, bucket string, fileName string) error

+ GetObject func(ctx context.Context, bucket string, fileName string, ...) (*api.GetObjectResponse, error)

+ GetObjectMetadata func(ctx context.Context, bucket string, fileName string) (*api.Object, error)

+ GetSetting func(ctx context.Context, setting string, out any) error

+ GougingSettings func(ctx context.Context) (api.GougingSettings, error)

+ ImportObjectMetadata func(ctx context.Context, bucket string, fileName string, object_ object.Object) error

+ RedundancySettings func(ctx context.Context) (api.RedundancySettings, error)

+ UpdateGougingSettings func(ctx context.Context, settings api.GougingSettings) error

+ UploadExists func(ctx context.Context, bucket string, fileName string) (bool, error)

+ UploadObject func(ctx context.Context, file io.Reader, bucket string, fileName string) error

+ UploadObjectMultipart func(ctx context.Context, params *MultiPartUploadParams) error

+ type RoutableAPI interface

+ Can func(w http.ResponseWriter, r *http.Request) bool

+ Handle func(w http.ResponseWriter, r *http.Request)

+ type Service interface

+ type ServiceFactory func() (Service, []ContextBuilderOption, error)

+ type ServiceInfo struct

+ Depends []string

+ Factory ServiceFactory

+ ID string

+ func GetServiceInfo(id string) *ServiceInfo

+ func GetServices() []ServiceInfo

+ type StartupFunc func(Context) error

+ type StorageProtocol interface

+ EncodeFileName func([]byte) string

+ Name func() string

+ type StorageService interface

+ DeleteObject func(ctx context.Context, protocol StorageProtocol, objectHash []byte) error

+ DeleteObjectProof func(ctx context.Context, protocol StorageProtocol, objectHash []byte) error

+ DownloadObject func(ctx context.Context, protocol StorageProtocol, objectHash []byte, start int64) (io.ReadCloser, error)

+ DownloadObjectProof func(ctx context.Context, protocol StorageProtocol, objectHash []byte) (io.ReadCloser, error)

+ HashObject func(ctx context.Context, data io.Reader, size uint64) (*bao.Result, error)

+ S3Client func(ctx context.Context) (*s3.Client, error)

+ S3MultipartUpload func(ctx context.Context, data io.ReadCloser, bucket, key string, size uint64) error

+ UploadObject func(ctx context.Context, protocol StorageProtocol, data io.ReadSeeker, size uint64, ...) (*UploadMetadata, error)

+ UploadObjectProof func(ctx context.Context, protocol StorageProtocol, data io.ReadSeeker, ...) error

+ UploadStatus func(ctx context.Context, protocol StorageProtocol, objectName string) (StorageUploadStatus, error)

+ type StorageUploadStatus string

+ const StorageUploadStatusActive

+ const StorageUploadStatusProcessing

+ const StorageUploadStatusUnknown

+ type UploadIDHandler func(uploadID string)

+ type UploadMetadata struct

+ Created time.Time

+ Hash []byte

+ ID uint

+ MimeType string

+ Protocol string

+ Size uint64

+ UploaderIP string

+ UserID uint

+ func (u UploadMetadata) IsEmpty() bool

+ type UserService interface

+ AccountExists func(id uint) (bool, *models.User, error)

+ AddPubkeyToAccount func(user models.User, pubkey string) error

+ CreateAccount func(email string, password string, verifyEmail bool) (*models.User, error)

+ EmailExists func(email string) (bool, *models.User, error)

+ Exists func(model any, conditions map[string]any) (bool, any, error)

+ HashPassword func(password string) (string, error)

+ PubkeyExists func(pubkey string) (bool, *models.PublicKey, error)

+ SendEmailVerification func(userId uint) error

+ UpdateAccountEmail func(userId uint, email string, password string) error

+ UpdateAccountInfo func(userId uint, info models.User) error

+ UpdateAccountName func(userId uint, firstName string, lastName string) error

+ UpdateAccountPassword func(userId uint, password string, newPassword string) error

+ VerifyEmail func(email string, token string) error

+ type VerifyTokenFunc func(claim *jwt.RegisteredClaims) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL