aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/swarm/manifest.go
blob: 312c72fa2103935f59046247ed2b9eaa609bd610 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
// Copyright 2017 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.

// Command  MANIFEST update
package main

import (
    "fmt"
    "os"
    "strings"

    "github.com/ethereum/go-ethereum/cmd/utils"
    "github.com/ethereum/go-ethereum/swarm/api"
    swarm "github.com/ethereum/go-ethereum/swarm/api/client"
    "gopkg.in/urfave/cli.v1"
)

var manifestCommand = cli.Command{
    Name:               "manifest",
    CustomHelpTemplate: helpTemplate,
    Usage:              "perform operations on swarm manifests",
    ArgsUsage:          "COMMAND",
    Description:        "Updates a MANIFEST by adding/removing/updating the hash of a path.\nCOMMAND could be: add, update, remove",
    Subcommands: []cli.Command{
        {
            Action:             manifestAdd,
            CustomHelpTemplate: helpTemplate,
            Name:               "add",
            Usage:              "add a new path to the manifest",
            ArgsUsage:          "<MANIFEST> <path> <hash>",
            Description:        "Adds a new path to the manifest",
        },
        {
            Action:             manifestUpdate,
            CustomHelpTemplate: helpTemplate,
            Name:               "update",
            Usage:              "update the hash for an already existing path in the manifest",
            ArgsUsage:          "<MANIFEST> <path> <newhash>",
            Description:        "Update the hash for an already existing path in the manifest",
        },
        {
            Action:             manifestRemove,
            CustomHelpTemplate: helpTemplate,
            Name:               "remove",
            Usage:              "removes a path from the manifest",
            ArgsUsage:          "<MANIFEST> <path>",
            Description:        "Removes a path from the manifest",
        },
    },
}

// manifestAdd adds a new entry to the manifest at the given path.
// New entry hash, the last argument, must be the hash of a manifest
// with only one entry, which meta-data will be added to the original manifest.
// On success, this function will print new (updated) manifest's hash.
func manifestAdd(ctx *cli.Context) {
    args := ctx.Args()
    if len(args) != 3 {
        utils.Fatalf("Need exactly three arguments <MHASH> <path> <HASH>")
    }

    var (
        mhash = args[0]
        path  = args[1]
        hash  = args[2]
    )

    bzzapi := strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
    client := swarm.NewClient(bzzapi)

    m, _, err := client.DownloadManifest(hash)
    if err != nil {
        utils.Fatalf("Error downloading manifest to add: %v", err)
    }
    l := len(m.Entries)
    if l == 0 {
        utils.Fatalf("No entries in manifest %s", hash)
    } else if l > 1 {
        utils.Fatalf("Too many entries in manifest %s", hash)
    }

    newManifest := addEntryToManifest(client, mhash, path, m.Entries[0])
    fmt.Println(newManifest)
}

// manifestUpdate replaces an existing entry of the manifest at the given path.
// New entry hash, the last argument, must be the hash of a manifest
// with only one entry, which meta-data will be added to the original manifest.
// On success, this function will print hash of the updated manifest.
func manifestUpdate(ctx *cli.Context) {
    args := ctx.Args()
    if len(args) != 3 {
        utils.Fatalf("Need exactly three arguments <MHASH> <path> <HASH>")
    }

    var (
        mhash = args[0]
        path  = args[1]
        hash  = args[2]
    )

    bzzapi := strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
    client := swarm.NewClient(bzzapi)

    m, _, err := client.DownloadManifest(hash)
    if err != nil {
        utils.Fatalf("Error downloading manifest to update: %v", err)
    }
    l := len(m.Entries)
    if l == 0 {
        utils.Fatalf("No entries in manifest %s", hash)
    } else if l > 1 {
        utils.Fatalf("Too many entries in manifest %s", hash)
    }

    newManifest, _, defaultEntryUpdated := updateEntryInManifest(client, mhash, path, m.Entries[0], true)
    if defaultEntryUpdated {
        // Print informational message to stderr
        // allowing the user to get the new manifest hash from stdout
        // without the need to parse the complete output.
        fmt.Fprintln(os.Stderr, "Manifest default entry is updated, too")
    }
    fmt.Println(newManifest)
}

// manifestRemove removes an existing entry of the manifest at the given path.
// On success, this function will print hash of the manifest which does not
// contain the path.
func manifestRemove(ctx *cli.Context) {
    args := ctx.Args()
    if len(args) != 2 {
        utils.Fatalf("Need exactly two arguments <MHASH> <path>")
    }

    var (
        mhash = args[0]
        path  = args[1]
    )

    bzzapi := strings.TrimRight(ctx.GlobalString(SwarmApiFlag.Name), "/")
    client := swarm.NewClient(bzzapi)

    newManifest := removeEntryFromManifest(client, mhash, path)
    fmt.Println(newManifest)
}

func addEntryToManifest(client *swarm.Client, mhash, path string, entry api.ManifestEntry) string {
    var longestPathEntry = api.ManifestEntry{}

    mroot, isEncrypted, err := client.DownloadManifest(mhash)
    if err != nil {
        utils.Fatalf("Manifest download failed: %v", err)
    }

    // See if we path is in this Manifest or do we have to dig deeper
    for _, e := range mroot.Entries {
        if path == e.Path {
            utils.Fatalf("Path %s already present, not adding anything", path)
        } else {
            if e.ContentType == api.ManifestType {
                prfxlen := strings.HasPrefix(path, e.Path)
                if prfxlen && len(path) > len(longestPathEntry.Path) {
                    longestPathEntry = e
                }
            }
        }
    }

    if longestPathEntry.Path != "" {
        // Load the child Manifest add the entry there
        newPath := path[len(longestPathEntry.Path):]
        newHash := addEntryToManifest(client, longestPathEntry.Hash, newPath, entry)

        // Replace the hash for parent Manifests
        newMRoot := &api.Manifest{}
        for _, e := range mroot.Entries {
            if longestPathEntry.Path == e.Path {
                e.Hash = newHash
            }
            newMRoot.Entries = append(newMRoot.Entries, e)
        }
        mroot = newMRoot
    } else {
        // Add the entry in the leaf Manifest
        entry.Path = path
        mroot.Entries = append(mroot.Entries, entry)
    }

    newManifestHash, err := client.UploadManifest(mroot, isEncrypted)
    if err != nil {
        utils.Fatalf("Manifest upload failed: %v", err)
    }
    return newManifestHash
}

// updateEntryInManifest updates an existing entry o path with a new one in the manifest with provided mhash
// finding the path recursively through all nested manifests. Argument isRoot is used for default
// entry update detection. If the updated entry has the same hash as the default entry, then the
// default entry in root manifest will be updated too.
// Returned values are the new manifest hash, hash of the entry that was replaced by the new entry and
// a a bool that is true if default entry is updated.
func updateEntryInManifest(client *swarm.Client, mhash, path string, entry api.ManifestEntry, isRoot bool) (newManifestHash, oldHash string, defaultEntryUpdated bool) {
    var (
        newEntry         = api.ManifestEntry{}
        longestPathEntry = api.ManifestEntry{}
    )

    mroot, isEncrypted, err := client.DownloadManifest(mhash)
    if err != nil {
        utils.Fatalf("Manifest download failed: %v", err)
    }

    // See if we path is in this Manifest or do we have to dig deeper
    for _, e := range mroot.Entries {
        if path == e.Path {
            newEntry = e
            // keep the reference of the hash of the entry that should be replaced
            // for default entry detection
            oldHash = e.Hash
        } else {
            if e.ContentType == api.ManifestType {
                prfxlen := strings.HasPrefix(path, e.Path)
                if prfxlen && len(path) > len(longestPathEntry.Path) {
                    longestPathEntry = e
                }
            }
        }
    }

    if longestPathEntry.Path == "" && newEntry.Path == "" {
        utils.Fatalf("Path %s not present in the Manifest, not setting anything", path)
    }

    if longestPathEntry.Path != "" {
        // Load the child Manifest add the entry there
        newPath := path[len(longestPathEntry.Path):]
        var newHash string
        newHash, oldHash, _ = updateEntryInManifest(client, longestPathEntry.Hash, newPath, entry, false)

        // Replace the hash for parent Manifests
        newMRoot := &api.Manifest{}
        for _, e := range mroot.Entries {
            if longestPathEntry.Path == e.Path {
                e.Hash = newHash
            }
            newMRoot.Entries = append(newMRoot.Entries, e)

        }
        mroot = newMRoot
    }

    // update the manifest if the new entry is found and
    // check if default entry should be updated
    if newEntry.Path != "" || isRoot {
        // Replace the hash for leaf Manifest
        newMRoot := &api.Manifest{}
        for _, e := range mroot.Entries {
            if newEntry.Path == e.Path {
                entry.Path = e.Path
                newMRoot.Entries = append(newMRoot.Entries, entry)
            } else if isRoot && e.Path == "" && e.Hash == oldHash {
                entry.Path = e.Path
                newMRoot.Entries = append(newMRoot.Entries, entry)
                defaultEntryUpdated = true
            } else {
                newMRoot.Entries = append(newMRoot.Entries, e)
            }
        }
        mroot = newMRoot
    }

    newManifestHash, err = client.UploadManifest(mroot, isEncrypted)
    if err != nil {
        utils.Fatalf("Manifest upload failed: %v", err)
    }
    return newManifestHash, oldHash, defaultEntryUpdated
}

func removeEntryFromManifest(client *swarm.Client, mhash, path string) string {
    var (
        entryToRemove    = api.ManifestEntry{}
        longestPathEntry = api.ManifestEntry{}
    )

    mroot, isEncrypted, err := client.DownloadManifest(mhash)
    if err != nil {
        utils.Fatalf("Manifest download failed: %v", err)
    }

    // See if we path is in this Manifest or do we have to dig deeper
    for _, entry := range mroot.Entries {
        if path == entry.Path {
            entryToRemove = entry
        } else {
            if entry.ContentType == api.ManifestType {
                prfxlen := strings.HasPrefix(path, entry.Path)
                if prfxlen && len(path) > len(longestPathEntry.Path) {
                    longestPathEntry = entry
                }
            }
        }
    }

    if longestPathEntry.Path == "" && entryToRemove.Path == "" {
        utils.Fatalf("Path %s not present in the Manifest, not removing anything", path)
    }

    if longestPathEntry.Path != "" {
        // Load the child Manifest remove the entry there
        newPath := path[len(longestPathEntry.Path):]
        newHash := removeEntryFromManifest(client, longestPathEntry.Hash, newPath)

        // Replace the hash for parent Manifests
        newMRoot := &api.Manifest{}
        for _, entry := range mroot.Entries {
            if longestPathEntry.Path == entry.Path {
                entry.Hash = newHash
            }
            newMRoot.Entries = append(newMRoot.Entries, entry)
        }
        mroot = newMRoot
    }

    if entryToRemove.Path != "" {
        // remove the entry in this Manifest
        newMRoot := &api.Manifest{}
        for _, entry := range mroot.Entries {
            if entryToRemove.Path != entry.Path {
                newMRoot.Entries = append(newMRoot.Entries, entry)
            }
        }
        mroot = newMRoot
    }

    newManifestHash, err := client.UploadManifest(mroot, isEncrypted)
    if err != nil {
        utils.Fatalf("Manifest upload failed: %v", err)
    }
    return newManifestHash
}