aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/api/manifest.go
blob: d6dc24c486b04e8dffbf46a42ffd97a1e83c81ec (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
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package api

import (
    "bytes"
    "encoding/json"
    "fmt"
    "sync"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/swarm/storage"
)

const (
    manifestType = "application/bzz-manifest+json"
)

type manifestTrie struct {
    dpa     *storage.DPA
    entries [257]*manifestTrieEntry // indexed by first character of path, entries[256] is the empty path entry
    hash    storage.Key             // if hash != nil, it is stored
}

type manifestJSON struct {
    Entries []*manifestTrieEntry `json:"entries"`
}

type manifestTrieEntry struct {
    Path        string `json:"path"`
    Hash        string `json:"hash"` // for manifest content type, empty until subtrie is evaluated
    ContentType string `json:"contentType"`
    Status      int    `json:"status"`
    subtrie     *manifestTrie
}

func loadManifest(dpa *storage.DPA, hash storage.Key, quitC chan bool) (trie *manifestTrie, err error) { // non-recursive, subtrees are downloaded on-demand

    glog.V(logger.Detail).Infof("manifest lookup key: '%v'.", hash.Log())
    // retrieve manifest via DPA
    manifestReader := dpa.Retrieve(hash)
    return readManifest(manifestReader, hash, dpa, quitC)
}

func readManifest(manifestReader storage.LazySectionReader, hash storage.Key, dpa *storage.DPA, quitC chan bool) (trie *manifestTrie, err error) { // non-recursive, subtrees are downloaded on-demand

    // TODO check size for oversized manifests
    size, err := manifestReader.Size(quitC)
    if err != nil { // size == 0
        // can't determine size means we don't have the root chunk
        err = fmt.Errorf("Manifest not Found")
        return
    }
    manifestData := make([]byte, size)
    read, err := manifestReader.Read(manifestData)
    if int64(read) < size {
        glog.V(logger.Detail).Infof("Manifest %v not found.", hash.Log())
        if err == nil {
            err = fmt.Errorf("Manifest retrieval cut short: read %v, expect %v", read, size)
        }
        return
    }

    glog.V(logger.Detail).Infof("Manifest %v retrieved", hash.Log())
    man := manifestJSON{}
    err = json.Unmarshal(manifestData, &man)
    if err != nil {
        err = fmt.Errorf("Manifest %v is malformed: %v", hash.Log(), err)
        glog.V(logger.Detail).Infof("%v", err)
        return
    }

    glog.V(logger.Detail).Infof("Manifest %v has %d entries.", hash.Log(), len(man.Entries))

    trie = &manifestTrie{
        dpa: dpa,
    }
    for _, entry := range man.Entries {
        trie.addEntry(entry, quitC)
    }
    return
}

func (self *manifestTrie) addEntry(entry *manifestTrieEntry, quitC chan bool) {
    self.hash = nil // trie modified, hash needs to be re-calculated on demand

    if len(entry.Path) == 0 {
        self.entries[256] = entry
        return
    }

    b := byte(entry.Path[0])
    if (self.entries[b] == nil) || (self.entries[b].Path == entry.Path) {
        self.entries[b] = entry
        return
    }

    oldentry := self.entries[b]
    cpl := 0
    for (len(entry.Path) > cpl) && (len(oldentry.Path) > cpl) && (entry.Path[cpl] == oldentry.Path[cpl]) {
        cpl++
    }

    if (oldentry.ContentType == manifestType) && (cpl == len(oldentry.Path)) {
        if self.loadSubTrie(oldentry, quitC) != nil {
            return
        }
        entry.Path = entry.Path[cpl:]
        oldentry.subtrie.addEntry(entry, quitC)
        oldentry.Hash = ""
        return
    }

    commonPrefix := entry.Path[:cpl]

    subtrie := &manifestTrie{
        dpa: self.dpa,
    }
    entry.Path = entry.Path[cpl:]
    oldentry.Path = oldentry.Path[cpl:]
    subtrie.addEntry(entry, quitC)
    subtrie.addEntry(oldentry, quitC)

    self.entries[b] = &manifestTrieEntry{
        Path:        commonPrefix,
        Hash:        "",
        ContentType: manifestType,
        subtrie:     subtrie,
    }
}

func (self *manifestTrie) getCountLast() (cnt int, entry *manifestTrieEntry) {
    for _, e := range self.entries {
        if e != nil {
            cnt++
            entry = e
        }
    }
    return
}

func (self *manifestTrie) deleteEntry(path string, quitC chan bool) {
    self.hash = nil // trie modified, hash needs to be re-calculated on demand

    if len(path) == 0 {
        self.entries[256] = nil
        return
    }

    b := byte(path[0])
    entry := self.entries[b]
    if entry == nil {
        return
    }
    if entry.Path == path {
        self.entries[b] = nil
        return
    }

    epl := len(entry.Path)
    if (entry.ContentType == manifestType) && (len(path) >= epl) && (path[:epl] == entry.Path) {
        if self.loadSubTrie(entry, quitC) != nil {
            return
        }
        entry.subtrie.deleteEntry(path[epl:], quitC)
        entry.Hash = ""
        // remove subtree if it has less than 2 elements
        cnt, lastentry := entry.subtrie.getCountLast()
        if cnt < 2 {
            if lastentry != nil {
                lastentry.Path = entry.Path + lastentry.Path
            }
            self.entries[b] = lastentry
        }
    }
}

func (self *manifestTrie) recalcAndStore() error {
    if self.hash != nil {
        return nil
    }

    var buffer bytes.Buffer
    buffer.WriteString(`{"entries":[`)

    list := &manifestJSON{}
    for _, entry := range self.entries {
        if entry != nil {
            if entry.Hash == "" { // TODO: paralellize
                err := entry.subtrie.recalcAndStore()
                if err != nil {
                    return err
                }
                entry.Hash = entry.subtrie.hash.String()
            }
            list.Entries = append(list.Entries, entry)
        }
    }

    manifest, err := json.Marshal(list)
    if err != nil {
        return err
    }

    sr := bytes.NewReader(manifest)
    wg := &sync.WaitGroup{}
    key, err2 := self.dpa.Store(sr, int64(len(manifest)), wg, nil)
    wg.Wait()
    self.hash = key
    return err2
}

func (self *manifestTrie) loadSubTrie(entry *manifestTrieEntry, quitC chan bool) (err error) {
    if entry.subtrie == nil {
        hash := common.Hex2Bytes(entry.Hash)
        entry.subtrie, err = loadManifest(self.dpa, hash, quitC)
        entry.Hash = "" // might not match, should be recalculated
    }
    return
}

func (self *manifestTrie) listWithPrefixInt(prefix, rp string, quitC chan bool, cb func(entry *manifestTrieEntry, suffix string)) error {
    plen := len(prefix)
    var start, stop int
    if plen == 0 {
        start = 0
        stop = 256
    } else {
        start = int(prefix[0])
        stop = start
    }

    for i := start; i <= stop; i++ {
        select {
        case <-quitC:
            return fmt.Errorf("aborted")
        default:
        }
        entry := self.entries[i]
        if entry != nil {
            epl := len(entry.Path)
            if entry.ContentType == manifestType {
                l := plen
                if epl < l {
                    l = epl
                }
                if prefix[:l] == entry.Path[:l] {
                    err := self.loadSubTrie(entry, quitC)
                    if err != nil {
                        return err
                    }
                    err = entry.subtrie.listWithPrefixInt(prefix[l:], rp+entry.Path[l:], quitC, cb)
                    if err != nil {
                        return err
                    }
                }
            } else {
                if (epl >= plen) && (prefix == entry.Path[:plen]) {
                    cb(entry, rp+entry.Path[plen:])
                }
            }
        }
    }
    return nil
}

func (self *manifestTrie) listWithPrefix(prefix string, quitC chan bool, cb func(entry *manifestTrieEntry, suffix string)) (err error) {
    return self.listWithPrefixInt(prefix, "", quitC, cb)
}

func (self *manifestTrie) findPrefixOf(path string, quitC chan bool) (entry *manifestTrieEntry, pos int) {

    glog.V(logger.Detail).Infof("findPrefixOf(%s)", path)

    if len(path) == 0 {
        return self.entries[256], 0
    }

    b := byte(path[0])
    entry = self.entries[b]
    if entry == nil {
        return self.entries[256], 0
    }
    epl := len(entry.Path)
    glog.V(logger.Detail).Infof("path = %v  entry.Path = %v  epl = %v", path, entry.Path, epl)
    if (len(path) >= epl) && (path[:epl] == entry.Path) {
        glog.V(logger.Detail).Infof("entry.ContentType = %v", entry.ContentType)
        if entry.ContentType == manifestType {
            if self.loadSubTrie(entry, quitC) != nil {
                return nil, 0
            }
            entry, pos = entry.subtrie.findPrefixOf(path[epl:], quitC)
            if entry != nil {
                pos += epl
            }
        } else {
            pos = epl
        }
    } else {
        entry = nil
    }
    return
}

// file system manifest always contains regularized paths
// no leading or trailing slashes, only single slashes inside
func RegularSlashes(path string) (res string) {
    for i := 0; i < len(path); i++ {
        if (path[i] != '/') || ((i > 0) && (path[i-1] != '/')) {
            res = res + path[i:i+1]
        }
    }
    if (len(res) > 0) && (res[len(res)-1] == '/') {
        res = res[:len(res)-1]
    }
    return
}

func (self *manifestTrie) getEntry(spath string) (entry *manifestTrieEntry, fullpath string) {
    path := RegularSlashes(spath)
    var pos int
    quitC := make(chan bool)
    entry, pos = self.findPrefixOf(path, quitC)
    return entry, path[:pos]
}