api

package

v0.0.0-...-2a2e411 Latest Latest Go to latest Published: Mar 2, 2023 License: GPL-3.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tlinden/up

Documentation ¶

Index ¶

Constants
func FileDelete(c *fiber.Ctx, cfg *cfg.Config, db *Db) error
func FileGet(c *fiber.Ctx, cfg *cfg.Config, db *Db) error
func FilePut(c *fiber.Ctx, cfg *cfg.Config, db *Db) (string, error)
func IsExpired(start time.Time, duration string) bool
func Log(format string, values ...any)
func NormalizeFilename(file string) string
func ProcessFormFiles(cfg *cfg.Config, members []string, id string) (string, string, error)
func Runserver(cfg *cfg.Config, args []string) error
func SaveFormFiles(c *fiber.Ctx, cfg *cfg.Config, files []*multipart.FileHeader, id string) ([]string, error)
func SendResponse(c *fiber.Ctx, msg string, err error) error
func Ts() string
func Untaint(input string, wanted string) (string, error)
func ZipDir(directory, zipfilename string) error
type Db
- func NewDb(file string) (*Db, error)
- func (db *Db) Close()
- func (db *Db) Delete(id string) error
- func (db *Db) Insert(id string, entry *Upload) error
- func (db *Db) Iterate(iterator func(id string, upload Upload)) error
- func (db *Db) Lookup(id string) (Upload, error)
type Id
type Meta
type Result
type Timestamp
- func (t Timestamp) MarshalJSON() ([]byte, error)
- func (t *Timestamp) UnmarshalJSON(data []byte) error
type Upload

Constants ¶

View Source

const ApiVersion string = "/v1"

View Source

const Bucket string = "uploads"

Variables ¶

This section is empty.

Functions ¶

func FileDelete ¶

func FileDelete(c *fiber.Ctx, cfg *cfg.Config, db *Db) error

func FileGet ¶

func FileGet(c *fiber.Ctx, cfg *cfg.Config, db *Db) error

func FilePut ¶

func FilePut(c *fiber.Ctx, cfg *cfg.Config, db *Db) (string, error)

func IsExpired ¶

func IsExpired(start time.Time, duration string) bool

Calculate   if  time   is   up  based   on   start  time.Time   and
duration. Returns  true if time  is expired. Start time  comes from
the database.

aka:

if(now - start) >= duration { time is up}

func Log ¶

func Log(format string, values ...any)

vaious helbers

func NormalizeFilename ¶

func NormalizeFilename(file string) string

func ProcessFormFiles ¶

func ProcessFormFiles(cfg *cfg.Config, members []string, id string) (string, string, error)

generate return url. in case of multiple files, zip and remove them

func Runserver ¶

func Runserver(cfg *cfg.Config, args []string) error

func SaveFormFiles ¶

func SaveFormFiles(c *fiber.Ctx, cfg *cfg.Config, files []*multipart.FileHeader, id string) ([]string, error)

Extract form file[s] and store them on disk, returns a list of files

func SendResponse ¶

func SendResponse(c *fiber.Ctx, msg string, err error) error

func Ts ¶

func Ts() string

func Untaint ¶

func Untaint(input string, wanted string) (string, error)

Untaint user input, that is: remove all non supported chars.

wanted is a regexp matching chars we shall leave. Everything else will be removed. Eg:

untainted := Untaint(input, `[^a-zA-Z0-9\-]`)

Returns a new string and an error if the input string has been modified. It's the callers choice to decide what to do about it. You may ignore the error and use the untainted string or bail out.

func ZipDir ¶

func ZipDir(directory, zipfilename string) error

Create a zip archive from a directory FIXME: -e option, if any, goes here

Types ¶

type Db ¶

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

wrapper for bolt db

func NewDb ¶

func NewDb(file string) (*Db, error)

func (*Db) Close ¶

func (db *Db) Close()

func (*Db) Delete ¶

func (db *Db) Delete(id string) error

func (*Db) Insert ¶

func (db *Db) Insert(id string, entry *Upload) error

func (*Db) Iterate ¶

func (db *Db) Iterate(iterator func(id string, upload Upload)) error

func (*Db) Lookup ¶

func (db *Db) Lookup(id string) (Upload, error)

type Id ¶

type Id struct {
	Id string `json:"name" xml:"name" form:"name"`
}

type Meta ¶

type Meta struct {
	Expire string `json:"expire" form:"expire"`
}

Binding from JSON, data coming from user, not tainted

type Result ¶

type Result struct {
	Success bool
	Message string
	Code    int
}

used to return to the api client

type Timestamp ¶

type Timestamp struct {
	time.Time
	// contains filtered or unexported fields
}

Timestamp is like time.Time, but knows how to unmarshal from JSON Unix timestamp numbers or RFC3339 strings, and marshal back into the same JSON representation.

func (Timestamp) MarshalJSON ¶

func (t Timestamp) MarshalJSON() ([]byte, error)

func (*Timestamp) UnmarshalJSON ¶

func (t *Timestamp) UnmarshalJSON(data []byte) error

type Upload ¶

type Upload struct {
	Id       string    `json:"id"`
	Expire   string    `json:"expire"`
	File     string    `json:"file"`    // final filename (visible to the downloader)
	Members  []string  `json:"members"` // contains multiple files, so File is an archive
	Uploaded Timestamp `json:"uploaded"`
}

stores 1 upload object, gets into db

Source Files ¶

View all Source files

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