upload

Documentation

Overview

Package upload 提供文件上传与下载功能

Index

• Constants
• Variables
• type IngestPolicy
• type IngestRequest
• type IngestResult
• type MigrationHandler
• type RebuildUploadStatsHandler
• type SystemCleanupHandler
• type WarmImageCacheHandler
• type WarmImageCachePayload

Constants

const (
	ErrNoFileSelected               = shared.ErrNoFileSelected
	ErrUnsupportedFormat            = shared.ErrUnsupportedFormat
	ErrProcessFileFailed            = shared.ErrProcessFileFailed
	ErrSaveFileFailed               = shared.ErrSaveFileFailed
	ErrOpenFileFailed               = shared.ErrOpenFileFailed
	ErrSaveUploadRecordFailed       = shared.ErrSaveUploadRecordFailed
	ErrGenericFileTooLarge          = shared.ErrGenericFileTooLarge
	ErrFileContentExtensionMismatch = shared.ErrFileContentExtensionMismatch
	ErrFileValidationFailed         = shared.ErrFileValidationFailed
	ErrInvalidMetadataJSON          = shared.ErrInvalidMetadataJSON
	ErrInvalidFileID                = shared.ErrInvalidFileID
	ErrQueryUploadRecordFailed      = shared.ErrQueryUploadRecordFailed
	ErrInvalidBatchDownloadRequest  = shared.ErrInvalidBatchDownloadRequest
	ErrInvalidIDValueFormat         = shared.ErrInvalidIDValueFormat
	ErrRetrieveUploadRecordsFailed  = shared.ErrRetrieveUploadRecordsFailed
	ErrNoValidFilesForArchive       = shared.ErrNoValidFilesForArchive
	ErrInvalidParams                = shared.ErrInvalidParams
	ErrQueryFileCountFailed         = shared.ErrQueryFileCountFailed
	ErrQueryFileListFailed          = shared.ErrQueryFileListFailed
	ErrDeleteFileFailed             = shared.ErrDeleteFileFailed
	ErrStorageReadOnly              = shared.ErrStorageReadOnly
	ErrS3KeyRequired                = shared.ErrS3KeyRequired
	ErrS3KeyTooLongFormat           = shared.ErrS3KeyTooLongFormat
	ErrS3KeyStartsWithSlash         = shared.ErrS3KeyStartsWithSlash
	ErrS3KeyContainsNullBytes       = shared.ErrS3KeyContainsNullBytes
	ErrQueryUnusedUploadsFailed     = shared.ErrQueryUnusedUploadsFailed
)

文件管理常量

const (
	PolicyCreate          = ingest.PolicyCreate
	PolicyDedupNewRecord  = ingest.PolicyDedupNewRecord
	PolicyResolveExisting = ingest.PolicyResolveExisting
)

Ingest policy constants

const (
	StorageMigrationTask   = uploadtask.StorageMigrationTask
	SystemCleanupTask      = uploadtask.SystemCleanupTask
	WarmImageCacheTask     = uploadtask.WarmImageCacheTask
	RebuildUploadStatsTask = uploadtask.RebuildUploadStatsTask
)

Task identifiers and metadata

Variables

var (
	UploadFile             = handler.UploadFile
	DownloadFile           = handler.DownloadFile
	BatchDownloadFiles     = handler.BatchDownloadFiles
	ListFiles              = handler.ListFiles
	DeleteFile             = handler.DeleteFile
	GetDistinctUploadTypes = handler.GetDistinctUploadTypes
	ListMyFiles            = handler.ListMyFiles
	DeleteMyFile           = handler.DeleteMyFile
	UpdateMyFile           = handler.UpdateMyFile
	GetFileStats           = handler.GetFileStats
	ServeFileByID          = filesrv.ServeFileByID
)

HTTP handlers

var (
	Ingest      = ingest.Ingest
	Remove      = ingest.Remove
	RemoveOwned = ingest.RemoveOwned
	FindByHash  = ingest.FindByHash
)

Programmatic ingest API

var (
	ErrIngestForbidden       = ingest.ErrForbidden
	ErrIngestStorageReadOnly = ingest.ErrStorageReadOnly
)

Ingest errors

var (
	ResetAccessCaches              = cache.ResetAccessCaches
	PublishAccessCacheInvalidation = cache.PublishAccessCacheInvalidation
)

Cache management

var (
	// Deprecated: use upload.Ingest or upload.Remove; stats are applied internally.
	ApplyUploadStatsAdd = uploadstats.ApplyUploadStatsAdd
	// Deprecated: use upload.Ingest or upload.Remove; stats are applied internally.
	ApplyUploadStatsRemove = uploadstats.ApplyUploadStatsRemove
	RebuildUploadStats     = uploadstats.RebuildUploadStats
)

Stats

var (
	CompressImageToWebP = util.CompressImageToWebP
	ValidateS3Key       = util.ValidateS3Key
)

Utilities

var (
	// StorageMigrationMeta describes the storage migration async task.
	StorageMigrationMeta = uploadtask.StorageMigrationMeta
	// SystemCleanupMeta describes the orphaned upload cleanup task.
	SystemCleanupMeta = uploadtask.SystemCleanupMeta
	// WarmImageCacheMeta describes the image compression cache warmup task.
	WarmImageCacheMeta = uploadtask.WarmImageCacheMeta
	// RebuildUploadStatsMeta describes the upload stats rebuild task.
	RebuildUploadStatsMeta = uploadtask.RebuildUploadStatsMeta
)

Types

type IngestPolicy

type IngestPolicy = ingest.Policy

IngestPolicy controls hash-collision behavior during ingest.

type IngestRequest

type IngestRequest = ingest.Request

IngestRequest is the programmatic upload ingest payload.

type IngestResult

type IngestResult = ingest.Result

IngestResult reports ingest side effects.

type MigrationHandler

type MigrationHandler = uploadtask.MigrationHandler

MigrationHandler executes storage migration tasks.

type RebuildUploadStatsHandler

type RebuildUploadStatsHandler = uploadtask.RebuildUploadStatsHandler

RebuildUploadStatsHandler rebuilds upload stats from active records.

type SystemCleanupHandler

type SystemCleanupHandler = uploadtask.SystemCleanupHandler

SystemCleanupHandler removes orphaned upload files.

type WarmImageCacheHandler

type WarmImageCacheHandler = uploadtask.WarmImageCacheHandler

WarmImageCacheHandler pre-warms compressed image caches.

type WarmImageCachePayload

type WarmImageCachePayload = uploadtask.WarmImageCachePayload

WarmImageCachePayload is the payload for image cache warmup tasks.