provider

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 5, 2021 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// MetadataDirectoryName directory where metadata are stored
	MetadataDirectoryName = ".fibr"
)

Variables

View Source 
var (
	// ArchiveExtensions contains extensions of Archive
	ArchiveExtensions = map[string]bool{".zip": true, ".tar": true, ".gz": true, ".rar": true}
	// AudioExtensions contains extensions of Audio
	AudioExtensions = map[string]bool{".mp3": true}
	// CodeExtensions contains extensions of Code
	CodeExtensions = map[string]bool{".html": true, ".css": true, ".js": true, ".jsx": true, ".json": true, ".yml": true, ".yaml": true, ".toml": true, ".md": true, ".go": true, ".py": true, ".java": true, ".xml": true}
	// ExcelExtensions contains extensions of Excel
	ExcelExtensions = map[string]bool{".xls": true, ".xlsx": true, ".xlsm": true}
	// ImageExtensions contains extensions of Image
	ImageExtensions = map[string]bool{".jpg": true, ".jpeg": true, ".png": true, ".gif": true, ".svg": true, ".tiff": true}
	// PdfExtensions contains extensions of Pdf
	PdfExtensions = map[string]bool{".pdf": true}
	// VideoExtensions contains extensions of Video
	VideoExtensions = map[string]string{".mp4": "video/mp4", ".mov": "video/quicktime", ".avi": "video/x-msvideo"}
	// WordExtensions contains extensions of Word
	WordExtensions = map[string]bool{".doc": true, ".docx": true, ".docm": true}
)
View Source 
var (
	// NoneShare is an undefined Share
	NoneShare = Share{}

	// DefaultDisplay format
	DefaultDisplay = "grid"
)
View Source 
var (
	// BcryptCost is the cost for the bcrypt fonction
	BcryptCost = bcrypt.DefaultCost
)
View Source 
var (

	// BufferPool for io.CopyBuffer
	BufferPool = sync.Pool{
		New: func() interface{} {
			return bytes.NewBuffer(make([]byte, 32*1024))
		},
	}
)

Functions

func ErrNotExist 

func ErrNotExist(err error) error

ErrNotExist create a NotExist error

func FindIndex 

func FindIndex(arr []string, value string) int

FindIndex finds index of given value into array, or -1 if not found

func GetPathname 

func GetPathname(folder, name string, share Share) string

GetPathname computes pathname for given params

func IsNotExist 

func IsNotExist(err error) bool

IsNotExist checks if error match a not found

func RemoveIndex 

func RemoveIndex(arr []string, index int) []string

RemoveIndex removes element at given index, if valid

func SafeWrite 

func SafeWrite(w io.Writer, content string)

SafeWrite writes content to writer with error handling

func SanitizeName 

func SanitizeName(name string, removeSlash bool) (string, error)

SanitizeName return sanitized name (remove diacritics)

func SetPrefsCookie added in v0.4.1 

func SetPrefsCookie(w http.ResponseWriter, request Request)

SetPrefsCookie set preferences cookie for given request

func URL added in v0.4.1 

func URL(folder, name string, share Share) string

URL computes public URI for given params

Types

type Aggregate added in v0.7.0 

type Aggregate struct {
	Location string    `json:"location"`
	Start    time.Time `json:"start"`
	End      time.Time `json:"end"`
}

Aggregate contains aggregated data for a folder

type Event added in v0.7.0 

type Event struct {
	Type EventType
	Item StorageItem
	New  StorageItem
}

Event describes an event on fibr

func NewDeleteEvent added in v0.7.0 

func NewDeleteEvent(item StorageItem) Event

NewDeleteEvent creates a new delete event

func NewRenameEvent added in v0.7.0 

func NewRenameEvent(old, new StorageItem) Event

NewRenameEvent creates a new rename event

func NewStartEvent added in v0.7.0 

func NewStartEvent(item StorageItem) Event

NewStartEvent creates a new start event

func NewUploadEvent added in v0.7.0 

func NewUploadEvent(item StorageItem) Event

NewUploadEvent creates a new upload event

type EventBus added in v0.7.0 

type EventBus struct {
	// contains filtered or unexported fields
}

EventBus describes a channel for exchanging Event

func NewEventBus added in v0.7.0 

func NewEventBus(size int) EventBus

NewEventBus create an event exchange channel

func (EventBus) Push added in v0.7.0 

func (e EventBus) Push(event Event) error

Push an event in the bus

func (EventBus) Start added in v0.7.0 

func (e EventBus) Start(done <-chan struct{}, consumers ...EventConsumer)

Start the distibution of Event

type EventConsumer added in v0.7.0 

type EventConsumer func(Event)

EventConsumer is a func that consume an event

type EventProducer added in v0.7.0 

type EventProducer func(Event) error

EventProducer is a func that push an event

type EventType added in v0.7.0 

type EventType uint

EventType is the enumeration of event that can happen 

const (
	// UploadEvent occurs when someone upload a file
	UploadEvent EventType = iota
	// CreateDir occurs when a directory is created
	CreateDir
	// RenameEvent occurs when an item is renamed
	RenameEvent
	// DeleteEvent occurs when an item is deleted
	DeleteEvent
	// StartEvent occurs when fibr start
	StartEvent
)

type Preferences 

type Preferences struct {
	ListLayoutPath []string
}

Preferences holds preferences of the user

type ReadSeekerCloser 

type ReadSeekerCloser interface {
	Read([]byte) (int, error)
	Seek(int64, int) (int64, error)
	Close() error
}

ReadSeekerCloser is a combination of io.Reader, io.Seeker and io.Closer

type RenderItem 

type RenderItem struct {
	ID  string
	URI string
	StorageItem
	Aggregate
}

RenderItem is a storage item with an id

type Request 

type Request struct {
	Path        string
	Display     string
	Preferences Preferences
	Share       Share
	CanEdit     bool
	CanShare    bool
}

Request from user

func (Request) Description added in v0.4.1 

func (r Request) Description() string

Description returns description of the page

func (Request) GetFilepath 

func (r Request) GetFilepath(name string) string

GetFilepath of request

func (Request) Layout 

func (r Request) Layout(name string) string

Layout returns layout of given name based on preferences

func (Request) LayoutPath 

func (r Request) LayoutPath(path string) string

LayoutPath returns layout of given path based on preferences

func (Request) Title added in v0.4.1 

func (r Request) Title() string

Title returns title of the page

func (Request) URL added in v0.4.1 

func (r Request) URL(name string) string

URL of request

type Share 

type Share struct {
	Creation time.Time     `json:"creation"`
	ID       string        `json:"id"`
	Path     string        `json:"path"`
	RootName string        `json:"rootName"`
	Password string        `json:"password"`
	Duration time.Duration `json:"duration"`
	Edit     bool          `json:"edit"`
	File     bool          `json:"file"`
}

Share stores informations about shared paths

func (Share) CheckPassword 

func (s Share) CheckPassword(authorizationHeader string) error

CheckPassword verifies that request has correct password for share

func (Share) IsExpired added in v0.4.0 

func (s Share) IsExpired(now time.Time) bool

IsExpired check if given share is expired

type Storage 

type Storage interface {
	Path(pathname string) string
	SetIgnoreFn(ignoreFn func(StorageItem) bool)
	Info(pathname string) (StorageItem, error)
	List(pathname string) ([]StorageItem, error)
	WriterTo(pathname string) (io.WriteCloser, error)
	ReaderFrom(pathname string) (ReadSeekerCloser, error)
	Walk(pathname string, walkFn func(StorageItem, error) error) error
	CreateDir(pathname string) error
	Store(pathname string, content io.ReadCloser) error
	Rename(oldName, newName string) error
	Remove(pathname string) error
	UpdateDate(pathname string, date time.Time) error
}

Storage describe action on a storage provider

type StorageItem 

type StorageItem struct {
	Info     interface{}
	Date     time.Time
	Pathname string
	Name     string
	Size     int64

	IsDir bool
}

StorageItem describe item on a storage provider

func (StorageItem) Extension 

func (s StorageItem) Extension() string

Extension gives extensions of item

func (StorageItem) IsImage 

func (s StorageItem) IsImage() bool

IsImage determine if item if an image

func (StorageItem) IsPdf 

func (s StorageItem) IsPdf() bool

IsPdf determine if item if a pdf

func (StorageItem) IsVideo 

func (s StorageItem) IsVideo() bool

IsVideo determine if item if a video

func (StorageItem) Mime 

func (s StorageItem) Mime() string

Mime gives Mime Type of item

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.