2018-08-06 10:44:44 +00:00
|
|
|
package api
|
2018-07-04 16:30:24 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"errors"
|
2018-07-24 13:22:29 +00:00
|
|
|
"fmt"
|
2018-07-04 16:30:24 +00:00
|
|
|
"net/url"
|
|
|
|
"strconv"
|
2019-08-19 04:52:50 +00:00
|
|
|
"strings"
|
2019-03-06 18:48:25 +00:00
|
|
|
|
|
|
|
cid "github.com/ipfs/go-cid"
|
2018-07-04 16:30:24 +00:00
|
|
|
)
|
|
|
|
|
2018-07-24 12:21:29 +00:00
|
|
|
// DefaultShardSize is the shard size for params objects created with DefaultParams().
|
2018-08-13 09:56:16 +00:00
|
|
|
var DefaultShardSize = uint64(100 * 1024 * 1024) // 100 MB
|
2018-07-23 09:14:43 +00:00
|
|
|
|
2018-08-06 20:49:28 +00:00
|
|
|
// AddedOutput carries information for displaying the standard ipfs output
|
|
|
|
// indicating a node of a file has been added.
|
|
|
|
type AddedOutput struct {
|
2019-03-06 18:48:25 +00:00
|
|
|
Name string `json:"name" codec:"n,omitempty"`
|
2019-03-07 11:30:08 +00:00
|
|
|
Cid cid.Cid `json:"cid" codec:"c"`
|
2019-03-06 18:48:25 +00:00
|
|
|
Bytes uint64 `json:"bytes,omitempty" codec:"b,omitempty"`
|
|
|
|
Size uint64 `json:"size,omitempty" codec:"s,omitempty"`
|
2018-08-06 20:49:28 +00:00
|
|
|
}
|
|
|
|
|
2018-08-06 12:31:45 +00:00
|
|
|
// AddParams contains all of the configurable parameters needed to specify the
|
2018-07-04 16:30:24 +00:00
|
|
|
// importing process of a file being added to an ipfs-cluster
|
2018-08-06 10:44:44 +00:00
|
|
|
type AddParams struct {
|
|
|
|
PinOptions
|
2018-07-04 16:30:24 +00:00
|
|
|
|
2019-01-04 18:30:41 +00:00
|
|
|
Recursive bool
|
|
|
|
Layout string
|
|
|
|
Chunker string
|
|
|
|
RawLeaves bool
|
|
|
|
Hidden bool
|
|
|
|
Wrap bool
|
|
|
|
Shard bool
|
|
|
|
Progress bool
|
|
|
|
CidVersion int
|
|
|
|
HashFun string
|
|
|
|
StreamChannels bool
|
2019-03-23 13:47:45 +00:00
|
|
|
NoCopy bool
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
|
|
|
|
2018-08-06 10:44:44 +00:00
|
|
|
// DefaultAddParams returns a AddParams object with standard defaults
|
|
|
|
func DefaultAddParams() *AddParams {
|
|
|
|
return &AddParams{
|
2019-01-04 18:30:41 +00:00
|
|
|
Recursive: false,
|
|
|
|
Layout: "", // corresponds to balanced layout
|
|
|
|
Chunker: "size-262144",
|
|
|
|
RawLeaves: false,
|
|
|
|
Hidden: false,
|
|
|
|
Wrap: false,
|
|
|
|
Shard: false,
|
|
|
|
Progress: false,
|
|
|
|
CidVersion: 0,
|
|
|
|
HashFun: "sha2-256",
|
|
|
|
StreamChannels: true,
|
2019-03-23 13:47:45 +00:00
|
|
|
NoCopy: false,
|
2018-08-06 10:44:44 +00:00
|
|
|
PinOptions: PinOptions{
|
2018-07-19 14:27:23 +00:00
|
|
|
ReplicationFactorMin: 0,
|
|
|
|
ReplicationFactorMax: 0,
|
2018-07-04 16:30:24 +00:00
|
|
|
Name: "",
|
2018-07-23 13:56:46 +00:00
|
|
|
ShardSize: DefaultShardSize,
|
2019-08-19 04:52:50 +00:00
|
|
|
Metadata: make(map[string]string),
|
2018-07-04 16:30:24 +00:00
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-24 13:22:29 +00:00
|
|
|
func parseBoolParam(q url.Values, name string, dest *bool) error {
|
|
|
|
if v := q.Get(name); v != "" {
|
|
|
|
b, err := strconv.ParseBool(v)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("parameter %s invalid", name)
|
|
|
|
}
|
|
|
|
*dest = b
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func parseIntParam(q url.Values, name string, dest *int) error {
|
|
|
|
if v := q.Get(name); v != "" {
|
|
|
|
i, err := strconv.Atoi(v)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("parameter %s invalid", name)
|
|
|
|
}
|
|
|
|
*dest = i
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-08-06 10:44:44 +00:00
|
|
|
// AddParamsFromQuery parses the AddParams object from
|
2018-07-04 16:30:24 +00:00
|
|
|
// a URL.Query().
|
2018-08-06 10:44:44 +00:00
|
|
|
func AddParamsFromQuery(query url.Values) (*AddParams, error) {
|
|
|
|
params := DefaultAddParams()
|
2018-07-19 14:27:23 +00:00
|
|
|
|
2018-07-04 16:30:24 +00:00
|
|
|
layout := query.Get("layout")
|
|
|
|
switch layout {
|
2018-08-09 11:22:47 +00:00
|
|
|
case "trickle", "balanced", "":
|
2018-07-20 11:56:59 +00:00
|
|
|
// nothing
|
2018-07-04 16:30:24 +00:00
|
|
|
default:
|
2019-01-04 18:30:41 +00:00
|
|
|
return nil, errors.New("layout parameter invalid")
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-07-19 14:27:23 +00:00
|
|
|
params.Layout = layout
|
2018-07-04 16:30:24 +00:00
|
|
|
|
|
|
|
chunker := query.Get("chunker")
|
2019-08-11 18:08:54 +00:00
|
|
|
if chunker != "" {
|
|
|
|
params.Chunker = chunker
|
|
|
|
}
|
|
|
|
|
2018-07-04 16:30:24 +00:00
|
|
|
name := query.Get("name")
|
2019-08-11 18:08:54 +00:00
|
|
|
if name != "" {
|
|
|
|
params.Name = name
|
|
|
|
}
|
2018-07-19 14:27:23 +00:00
|
|
|
|
2018-08-20 14:25:26 +00:00
|
|
|
hashF := query.Get("hash")
|
|
|
|
if hashF != "" {
|
|
|
|
params.HashFun = hashF
|
|
|
|
}
|
|
|
|
|
2018-08-19 17:39:08 +00:00
|
|
|
err := parseBoolParam(query, "recursive", ¶ms.Recursive)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
err = parseBoolParam(query, "raw-leaves", ¶ms.RawLeaves)
|
2018-07-24 13:22:29 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-07-24 13:22:29 +00:00
|
|
|
err = parseBoolParam(query, "hidden", ¶ms.Hidden)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-08-08 19:11:26 +00:00
|
|
|
err = parseBoolParam(query, "wrap-with-directory", ¶ms.Wrap)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2018-07-24 13:22:29 +00:00
|
|
|
err = parseBoolParam(query, "shard", ¶ms.Shard)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-08-16 15:40:32 +00:00
|
|
|
|
|
|
|
err = parseBoolParam(query, "progress", ¶ms.Progress)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2018-08-08 19:11:26 +00:00
|
|
|
err = parseIntParam(query, "replication-min", ¶ms.ReplicationFactorMin)
|
2018-07-24 13:22:29 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-08-08 19:11:26 +00:00
|
|
|
err = parseIntParam(query, "replication-max", ¶ms.ReplicationFactorMax)
|
2018-07-24 13:22:29 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
|
|
|
|
2019-08-19 04:52:50 +00:00
|
|
|
for k := range query {
|
|
|
|
if !strings.HasPrefix(k, pinOptionsMetaPrefix) {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
metaKey := strings.TrimPrefix(k, pinOptionsMetaPrefix)
|
|
|
|
if metaKey == "" {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
params.Metadata[metaKey] = query.Get(k)
|
|
|
|
}
|
|
|
|
|
2019-08-11 18:08:54 +00:00
|
|
|
allocs := query.Get("user-allocations")
|
|
|
|
if allocs != "" {
|
|
|
|
params.UserAllocations = StringsToPeers(strings.Split(allocs, ","))
|
|
|
|
}
|
|
|
|
|
2018-08-20 14:25:26 +00:00
|
|
|
err = parseIntParam(query, "cid-version", ¶ms.CidVersion)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2018-08-08 19:11:26 +00:00
|
|
|
if v := query.Get("shard-size"); v != "" {
|
2018-07-19 14:27:23 +00:00
|
|
|
shardSize, err := strconv.ParseUint(v, 10, 64)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errors.New("parameter shard_size is invalid")
|
|
|
|
}
|
|
|
|
params.ShardSize = shardSize
|
2018-07-04 16:30:24 +00:00
|
|
|
}
|
2018-07-19 14:27:23 +00:00
|
|
|
|
2019-01-04 18:30:41 +00:00
|
|
|
err = parseBoolParam(query, "stream-channels", ¶ms.StreamChannels)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2019-03-23 13:47:45 +00:00
|
|
|
err = parseBoolParam(query, "nocopy", ¶ms.NoCopy)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2018-07-04 16:30:24 +00:00
|
|
|
return params, nil
|
|
|
|
}
|
2018-08-06 10:44:44 +00:00
|
|
|
|
|
|
|
// ToQueryString returns a url query string (key=value&key2=value2&...)
|
|
|
|
func (p *AddParams) ToQueryString() string {
|
2018-10-19 18:19:52 +00:00
|
|
|
query := url.Values{}
|
|
|
|
query.Set("replication-min", fmt.Sprintf("%d", p.ReplicationFactorMin))
|
|
|
|
query.Set("replication-max", fmt.Sprintf("%d", p.ReplicationFactorMax))
|
|
|
|
query.Set("name", p.Name)
|
2019-08-19 04:52:50 +00:00
|
|
|
for k, v := range p.Metadata {
|
|
|
|
if k == "" {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
query.Set(fmt.Sprintf("%s%s", pinOptionsMetaPrefix, k), v)
|
|
|
|
}
|
2019-08-11 18:08:54 +00:00
|
|
|
query.Set("user-allocations", strings.Join(PeersToStrings(p.UserAllocations), ","))
|
2018-10-19 18:19:52 +00:00
|
|
|
query.Set("shard", fmt.Sprintf("%t", p.Shard))
|
|
|
|
query.Set("shard-size", fmt.Sprintf("%d", p.ShardSize))
|
|
|
|
query.Set("recursive", fmt.Sprintf("%t", p.Recursive))
|
|
|
|
query.Set("layout", p.Layout)
|
|
|
|
query.Set("chunker", p.Chunker)
|
|
|
|
query.Set("raw-leaves", fmt.Sprintf("%t", p.RawLeaves))
|
|
|
|
query.Set("hidden", fmt.Sprintf("%t", p.Hidden))
|
|
|
|
query.Set("wrap-with-directory", fmt.Sprintf("%t", p.Wrap))
|
|
|
|
query.Set("progress", fmt.Sprintf("%t", p.Progress))
|
|
|
|
query.Set("cid-version", fmt.Sprintf("%d", p.CidVersion))
|
|
|
|
query.Set("hash", p.HashFun)
|
2019-01-04 18:30:41 +00:00
|
|
|
query.Set("stream-channels", fmt.Sprintf("%t", p.StreamChannels))
|
2019-03-23 13:47:45 +00:00
|
|
|
query.Set("nocopy", fmt.Sprintf("%t", p.NoCopy))
|
2018-10-19 18:19:52 +00:00
|
|
|
return query.Encode()
|
2018-08-06 10:44:44 +00:00
|
|
|
}
|
|
|
|
|
2018-08-06 12:31:45 +00:00
|
|
|
// Equals checks if p equals p2.
|
2018-08-06 10:44:44 +00:00
|
|
|
func (p *AddParams) Equals(p2 *AddParams) bool {
|
2019-08-19 04:52:50 +00:00
|
|
|
for k, v := range p.Metadata {
|
|
|
|
v2 := p2.Metadata[k]
|
|
|
|
if k != "" && v != v2 {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-06 10:44:44 +00:00
|
|
|
return p.ReplicationFactorMin == p2.ReplicationFactorMin &&
|
|
|
|
p.ReplicationFactorMax == p2.ReplicationFactorMax &&
|
|
|
|
p.Name == p2.Name &&
|
2018-08-19 17:39:08 +00:00
|
|
|
p.Recursive == p2.Recursive &&
|
2018-08-06 10:44:44 +00:00
|
|
|
p.Shard == p2.Shard &&
|
|
|
|
p.ShardSize == p2.ShardSize &&
|
|
|
|
p.Layout == p2.Layout &&
|
|
|
|
p.Chunker == p2.Chunker &&
|
|
|
|
p.RawLeaves == p2.RawLeaves &&
|
2018-08-08 19:11:26 +00:00
|
|
|
p.Hidden == p2.Hidden &&
|
2018-08-20 14:25:26 +00:00
|
|
|
p.Wrap == p2.Wrap &&
|
|
|
|
p.CidVersion == p2.CidVersion &&
|
2019-01-04 18:30:41 +00:00
|
|
|
p.HashFun == p2.HashFun &&
|
2019-03-23 13:47:45 +00:00
|
|
|
p.StreamChannels == p2.StreamChannels &&
|
|
|
|
p.NoCopy == p2.NoCopy
|
2018-08-06 10:44:44 +00:00
|
|
|
}
|