mirror of
https://github.com/ipfs/kubo.git
synced 2026-03-10 10:47:51 +08:00
4f4dac9564
align kubo with unified golang ci linter from IPDX and rules used in boxo and other go packages addressed lint rules: - ST1000: added package comments - ST1020, ST1021, ST1022: fixed function/method comments - QF1001: applied De Morgan's law - QF1003: converted if-else chains to tagged switches - QF1004: replaced strings.Replace with strings.ReplaceAll - QF1008: simplified embedded struct field selectors - unconvert: removed unnecessary type conversions - usestdlibvars: used stdlib constants instead of literals disabled errcheck linter in .golangci.yml
92 lines
1.9 KiB
Go
92 lines
1.9 KiB
Go
// Package flatfs provides a flatfs datastore plugin.
|
|
package flatfs
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
|
|
"github.com/ipfs/kubo/plugin"
|
|
"github.com/ipfs/kubo/repo"
|
|
"github.com/ipfs/kubo/repo/fsrepo"
|
|
|
|
flatfs "github.com/ipfs/go-ds-flatfs"
|
|
)
|
|
|
|
// Plugins is exported list of plugins that will be loaded.
|
|
var Plugins = []plugin.Plugin{
|
|
&flatfsPlugin{},
|
|
}
|
|
|
|
type flatfsPlugin struct{}
|
|
|
|
var _ plugin.PluginDatastore = (*flatfsPlugin)(nil)
|
|
|
|
func (*flatfsPlugin) Name() string {
|
|
return "ds-flatfs"
|
|
}
|
|
|
|
func (*flatfsPlugin) Version() string {
|
|
return "0.1.0"
|
|
}
|
|
|
|
func (*flatfsPlugin) Init(_ *plugin.Environment) error {
|
|
return nil
|
|
}
|
|
|
|
func (*flatfsPlugin) DatastoreTypeName() string {
|
|
return "flatfs"
|
|
}
|
|
|
|
type datastoreConfig struct {
|
|
path string
|
|
shardFun *flatfs.ShardIdV1
|
|
syncField bool
|
|
}
|
|
|
|
// BadgerdsDatastoreConfig returns a configuration stub for a flatfs datastore
|
|
// from the given parameters.
|
|
func (*flatfsPlugin) DatastoreConfigParser() fsrepo.ConfigFromMap {
|
|
return func(params map[string]interface{}) (fsrepo.DatastoreConfig, error) {
|
|
var c datastoreConfig
|
|
var ok bool
|
|
var err error
|
|
|
|
c.path, ok = params["path"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("'path' field is missing or not boolean")
|
|
}
|
|
|
|
sshardFun, ok := params["shardFunc"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("'shardFunc' field is missing or not a string")
|
|
}
|
|
c.shardFun, err = flatfs.ParseShardFunc(sshardFun)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
c.syncField, ok = params["sync"].(bool)
|
|
if !ok {
|
|
return nil, fmt.Errorf("'sync' field is missing or not boolean")
|
|
}
|
|
return &c, nil
|
|
}
|
|
}
|
|
|
|
func (c *datastoreConfig) DiskSpec() fsrepo.DiskSpec {
|
|
return map[string]interface{}{
|
|
"type": "flatfs",
|
|
"path": c.path,
|
|
"shardFunc": c.shardFun.String(),
|
|
}
|
|
}
|
|
|
|
func (c *datastoreConfig) Create(path string) (repo.Datastore, error) {
|
|
p := c.path
|
|
if !filepath.IsAbs(p) {
|
|
p = filepath.Join(path, p)
|
|
}
|
|
|
|
return flatfs.CreateOrOpen(p, c.shardFun, c.syncField)
|
|
}
|