aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/api/client/client.go
blob: b3a5e929d0163f312f3f391bd1b0f32045cbf1de (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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
// Copyright 2017 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 client

import (
    "archive/tar"
    "bytes"
    "encoding/json"
    "errors"
    "fmt"
    "io"
    "io/ioutil"
    "mime"
    "mime/multipart"
    "net/http"
    "net/textproto"
    "os"
    "path/filepath"
    "regexp"
    "strconv"
    "strings"

    "github.com/ethereum/go-ethereum/swarm/api"
    "github.com/ethereum/go-ethereum/swarm/storage/mru"
)

var (
    DefaultGateway = "http://localhost:8500"
    DefaultClient  = NewClient(DefaultGateway)
)

func NewClient(gateway string) *Client {
    return &Client{
        Gateway: gateway,
    }
}

// Client wraps interaction with a swarm HTTP gateway.
type Client struct {
    Gateway string
}

// UploadRaw uploads raw data to swarm and returns the resulting hash. If toEncrypt is true it
// uploads encrypted data
func (c *Client) UploadRaw(r io.Reader, size int64, toEncrypt bool) (string, error) {
    if size <= 0 {
        return "", errors.New("data size must be greater than zero")
    }
    addr := ""
    if toEncrypt {
        addr = "encrypt"
    }
    req, err := http.NewRequest("POST", c.Gateway+"/bzz-raw:/"+addr, r)
    if err != nil {
        return "", err
    }
    req.ContentLength = size
    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return "", err
    }
    defer res.Body.Close()
    if res.StatusCode != http.StatusOK {
        return "", fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    data, err := ioutil.ReadAll(res.Body)
    if err != nil {
        return "", err
    }
    return string(data), nil
}

// DownloadRaw downloads raw data from swarm and it returns a ReadCloser and a bool whether the
// content was encrypted
func (c *Client) DownloadRaw(hash string) (io.ReadCloser, bool, error) {
    uri := c.Gateway + "/bzz-raw:/" + hash
    res, err := http.DefaultClient.Get(uri)
    if err != nil {
        return nil, false, err
    }
    if res.StatusCode != http.StatusOK {
        res.Body.Close()
        return nil, false, fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    isEncrypted := (res.Header.Get("X-Decrypted") == "true")
    return res.Body, isEncrypted, nil
}

// File represents a file in a swarm manifest and is used for uploading and
// downloading content to and from swarm
type File struct {
    io.ReadCloser
    api.ManifestEntry
}

// Open opens a local file which can then be passed to client.Upload to upload
// it to swarm
func Open(path string) (*File, error) {
    f, err := os.Open(path)
    if err != nil {
        return nil, err
    }
    stat, err := f.Stat()
    if err != nil {
        f.Close()
        return nil, err
    }
    return &File{
        ReadCloser: f,
        ManifestEntry: api.ManifestEntry{
            ContentType: mime.TypeByExtension(filepath.Ext(path)),
            Mode:        int64(stat.Mode()),
            Size:        stat.Size(),
            ModTime:     stat.ModTime(),
        },
    }, nil
}

// Upload uploads a file to swarm and either adds it to an existing manifest
// (if the manifest argument is non-empty) or creates a new manifest containing
// the file, returning the resulting manifest hash (the file will then be
// available at bzz:/<hash>/<path>)
func (c *Client) Upload(file *File, manifest string, toEncrypt bool) (string, error) {
    if file.Size <= 0 {
        return "", errors.New("file size must be greater than zero")
    }
    return c.TarUpload(manifest, &FileUploader{file}, toEncrypt)
}

// Download downloads a file with the given path from the swarm manifest with
// the given hash (i.e. it gets bzz:/<hash>/<path>)
func (c *Client) Download(hash, path string) (*File, error) {
    uri := c.Gateway + "/bzz:/" + hash + "/" + path
    res, err := http.DefaultClient.Get(uri)
    if err != nil {
        return nil, err
    }
    if res.StatusCode != http.StatusOK {
        res.Body.Close()
        return nil, fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    return &File{
        ReadCloser: res.Body,
        ManifestEntry: api.ManifestEntry{
            ContentType: res.Header.Get("Content-Type"),
            Size:        res.ContentLength,
        },
    }, nil
}

// UploadDirectory uploads a directory tree to swarm and either adds the files
// to an existing manifest (if the manifest argument is non-empty) or creates a
// new manifest, returning the resulting manifest hash (files from the
// directory will then be available at bzz:/<hash>/path/to/file), with
// the file specified in defaultPath being uploaded to the root of the manifest
// (i.e. bzz:/<hash>/)
func (c *Client) UploadDirectory(dir, defaultPath, manifest string, toEncrypt bool) (string, error) {
    stat, err := os.Stat(dir)
    if err != nil {
        return "", err
    } else if !stat.IsDir() {
        return "", fmt.Errorf("not a directory: %s", dir)
    }
    return c.TarUpload(manifest, &DirectoryUploader{dir, defaultPath}, toEncrypt)
}

// DownloadDirectory downloads the files contained in a swarm manifest under
// the given path into a local directory (existing files will be overwritten)
func (c *Client) DownloadDirectory(hash, path, destDir string) error {
    stat, err := os.Stat(destDir)
    if err != nil {
        return err
    } else if !stat.IsDir() {
        return fmt.Errorf("not a directory: %s", destDir)
    }

    uri := c.Gateway + "/bzz:/" + hash + "/" + path
    req, err := http.NewRequest("GET", uri, nil)
    if err != nil {
        return err
    }
    req.Header.Set("Accept", "application/x-tar")
    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return err
    }
    defer res.Body.Close()
    if res.StatusCode != http.StatusOK {
        return fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    tr := tar.NewReader(res.Body)
    for {
        hdr, err := tr.Next()
        if err == io.EOF {
            return nil
        } else if err != nil {
            return err
        }
        // ignore the default path file
        if hdr.Name == "" {
            continue
        }

        dstPath := filepath.Join(destDir, filepath.Clean(strings.TrimPrefix(hdr.Name, path)))
        if err := os.MkdirAll(filepath.Dir(dstPath), 0755); err != nil {
            return err
        }
        var mode os.FileMode = 0644
        if hdr.Mode > 0 {
            mode = os.FileMode(hdr.Mode)
        }
        dst, err := os.OpenFile(dstPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, mode)
        if err != nil {
            return err
        }
        n, err := io.Copy(dst, tr)
        dst.Close()
        if err != nil {
            return err
        } else if n != hdr.Size {
            return fmt.Errorf("expected %s to be %d bytes but got %d", hdr.Name, hdr.Size, n)
        }
    }
}

// DownloadFile downloads a single file into the destination directory
// if the manifest entry does not specify a file name - it will fallback
// to the hash of the file as a filename
func (c *Client) DownloadFile(hash, path, dest string) error {
    hasDestinationFilename := false
    if stat, err := os.Stat(dest); err == nil {
        hasDestinationFilename = !stat.IsDir()
    } else {
        if os.IsNotExist(err) {
            // does not exist - should be created
            hasDestinationFilename = true
        } else {
            return fmt.Errorf("could not stat path: %v", err)
        }
    }

    manifestList, err := c.List(hash, path)
    if err != nil {
        return fmt.Errorf("could not list manifest: %v", err)
    }

    switch len(manifestList.Entries) {
    case 0:
        return fmt.Errorf("could not find path requested at manifest address. make sure the path you've specified is correct")
    case 1:
        //continue
    default:
        return fmt.Errorf("got too many matches for this path")
    }

    uri := c.Gateway + "/bzz:/" + hash + "/" + path
    req, err := http.NewRequest("GET", uri, nil)
    if err != nil {
        return err
    }
    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return err
    }
    defer res.Body.Close()

    if res.StatusCode != http.StatusOK {
        return fmt.Errorf("unexpected HTTP status: expected 200 OK, got %d", res.StatusCode)
    }
    filename := ""
    if hasDestinationFilename {
        filename = dest
    } else {
        // try to assert
        re := regexp.MustCompile("[^/]+$") //everything after last slash

        if results := re.FindAllString(path, -1); len(results) > 0 {
            filename = results[len(results)-1]
        } else {
            if entry := manifestList.Entries[0]; entry.Path != "" && entry.Path != "/" {
                filename = entry.Path
            } else {
                // assume hash as name if there's nothing from the command line
                filename = hash
            }
        }
        filename = filepath.Join(dest, filename)
    }
    filePath, err := filepath.Abs(filename)
    if err != nil {
        return err
    }

    if err := os.MkdirAll(filepath.Dir(filePath), 0777); err != nil {
        return err
    }

    dst, err := os.Create(filename)
    if err != nil {
        return err
    }
    defer dst.Close()

    _, err = io.Copy(dst, res.Body)
    return err
}

// UploadManifest uploads the given manifest to swarm
func (c *Client) UploadManifest(m *api.Manifest, toEncrypt bool) (string, error) {
    data, err := json.Marshal(m)
    if err != nil {
        return "", err
    }
    return c.UploadRaw(bytes.NewReader(data), int64(len(data)), toEncrypt)
}

// DownloadManifest downloads a swarm manifest
func (c *Client) DownloadManifest(hash string) (*api.Manifest, bool, error) {
    res, isEncrypted, err := c.DownloadRaw(hash)
    if err != nil {
        return nil, isEncrypted, err
    }
    defer res.Close()
    var manifest api.Manifest
    if err := json.NewDecoder(res).Decode(&manifest); err != nil {
        return nil, isEncrypted, err
    }
    return &manifest, isEncrypted, nil
}

// List list files in a swarm manifest which have the given prefix, grouping
// common prefixes using "/" as a delimiter.
//
// For example, if the manifest represents the following directory structure:
//
// file1.txt
// file2.txt
// dir1/file3.txt
// dir1/dir2/file4.txt
//
// Then:
//
// - a prefix of ""      would return [dir1/, file1.txt, file2.txt]
// - a prefix of "file"  would return [file1.txt, file2.txt]
// - a prefix of "dir1/" would return [dir1/dir2/, dir1/file3.txt]
//
// where entries ending with "/" are common prefixes.
func (c *Client) List(hash, prefix string) (*api.ManifestList, error) {
    res, err := http.DefaultClient.Get(c.Gateway + "/bzz-list:/" + hash + "/" + prefix)
    if err != nil {
        return nil, err
    }
    defer res.Body.Close()
    if res.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    var list api.ManifestList
    if err := json.NewDecoder(res.Body).Decode(&list); err != nil {
        return nil, err
    }
    return &list, nil
}

// Uploader uploads files to swarm using a provided UploadFn
type Uploader interface {
    Upload(UploadFn) error
}

type UploaderFunc func(UploadFn) error

func (u UploaderFunc) Upload(upload UploadFn) error {
    return u(upload)
}

// DirectoryUploader uploads all files in a directory, optionally uploading
// a file to the default path
type DirectoryUploader struct {
    Dir         string
    DefaultPath string
}

// Upload performs the upload of the directory and default path
func (d *DirectoryUploader) Upload(upload UploadFn) error {
    if d.DefaultPath != "" {
        file, err := Open(d.DefaultPath)
        if err != nil {
            return err
        }
        if err := upload(file); err != nil {
            return err
        }
    }
    return filepath.Walk(d.Dir, func(path string, f os.FileInfo, err error) error {
        if err != nil {
            return err
        }
        if f.IsDir() {
            return nil
        }
        file, err := Open(path)
        if err != nil {
            return err
        }
        relPath, err := filepath.Rel(d.Dir, path)
        if err != nil {
            return err
        }
        file.Path = filepath.ToSlash(relPath)
        return upload(file)
    })
}

// FileUploader uploads a single file
type FileUploader struct {
    File *File
}

// Upload performs the upload of the file
func (f *FileUploader) Upload(upload UploadFn) error {
    return upload(f.File)
}

// UploadFn is the type of function passed to an Uploader to perform the upload
// of a single file (for example, a directory uploader would call a provided
// UploadFn for each file in the directory tree)
type UploadFn func(file *File) error

// TarUpload uses the given Uploader to upload files to swarm as a tar stream,
// returning the resulting manifest hash
func (c *Client) TarUpload(hash string, uploader Uploader, toEncrypt bool) (string, error) {
    reqR, reqW := io.Pipe()
    defer reqR.Close()
    addr := hash

    // If there is a hash already (a manifest), then that manifest will determine if the upload has
    // to be encrypted or not. If there is no manifest then the toEncrypt parameter decides if
    // there is encryption or not.
    if hash == "" && toEncrypt {
        // This is the built-in address for the encrypted upload endpoint
        addr = "encrypt"
    }
    req, err := http.NewRequest("POST", c.Gateway+"/bzz:/"+addr, reqR)
    if err != nil {
        return "", err
    }
    req.Header.Set("Content-Type", "application/x-tar")

    // use 'Expect: 100-continue' so we don't send the request body if
    // the server refuses the request
    req.Header.Set("Expect", "100-continue")

    tw := tar.NewWriter(reqW)

    // define an UploadFn which adds files to the tar stream
    uploadFn := func(file *File) error {
        hdr := &tar.Header{
            Name:    file.Path,
            Mode:    file.Mode,
            Size:    file.Size,
            ModTime: file.ModTime,
            Xattrs: map[string]string{
                "user.swarm.content-type": file.ContentType,
            },
        }
        if err := tw.WriteHeader(hdr); err != nil {
            return err
        }
        _, err = io.Copy(tw, file)
        return err
    }

    // run the upload in a goroutine so we can send the request headers and
    // wait for a '100 Continue' response before sending the tar stream
    go func() {
        err := uploader.Upload(uploadFn)
        if err == nil {
            err = tw.Close()
        }
        reqW.CloseWithError(err)
    }()

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return "", err
    }
    defer res.Body.Close()
    if res.StatusCode != http.StatusOK {
        return "", fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    data, err := ioutil.ReadAll(res.Body)
    if err != nil {
        return "", err
    }
    return string(data), nil
}

// MultipartUpload uses the given Uploader to upload files to swarm as a
// multipart form, returning the resulting manifest hash
func (c *Client) MultipartUpload(hash string, uploader Uploader) (string, error) {
    reqR, reqW := io.Pipe()
    defer reqR.Close()
    req, err := http.NewRequest("POST", c.Gateway+"/bzz:/"+hash, reqR)
    if err != nil {
        return "", err
    }

    // use 'Expect: 100-continue' so we don't send the request body if
    // the server refuses the request
    req.Header.Set("Expect", "100-continue")

    mw := multipart.NewWriter(reqW)
    req.Header.Set("Content-Type", fmt.Sprintf("multipart/form-data; boundary=%q", mw.Boundary()))

    // define an UploadFn which adds files to the multipart form
    uploadFn := func(file *File) error {
        hdr := make(textproto.MIMEHeader)
        hdr.Set("Content-Disposition", fmt.Sprintf("form-data; name=%q", file.Path))
        hdr.Set("Content-Type", file.ContentType)
        hdr.Set("Content-Length", strconv.FormatInt(file.Size, 10))
        w, err := mw.CreatePart(hdr)
        if err != nil {
            return err
        }
        _, err = io.Copy(w, file)
        return err
    }

    // run the upload in a goroutine so we can send the request headers and
    // wait for a '100 Continue' response before sending the multipart form
    go func() {
        err := uploader.Upload(uploadFn)
        if err == nil {
            err = mw.Close()
        }
        reqW.CloseWithError(err)
    }()

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return "", err
    }
    defer res.Body.Close()
    if res.StatusCode != http.StatusOK {
        return "", fmt.Errorf("unexpected HTTP status: %s", res.Status)
    }
    data, err := ioutil.ReadAll(res.Body)
    if err != nil {
        return "", err
    }
    return string(data), nil
}

// CreateResource creates a Mutable Resource with the given name and frequency, initializing it with the provided
// data. Data is interpreted as multihash or not depending on the multihash parameter.
// startTime=0 means "now"
// Returns the resulting Mutable Resource manifest address that you can use to include in an ENS Resolver (setContent)
// or reference future updates (Client.UpdateResource)
func (c *Client) CreateResource(request *mru.Request) (string, error) {
    responseStream, err := c.updateResource(request)
    if err != nil {
        return "", err
    }
    defer responseStream.Close()

    body, err := ioutil.ReadAll(responseStream)
    if err != nil {
        return "", err
    }

    var manifestAddress string
    if err = json.Unmarshal(body, &manifestAddress); err != nil {
        return "", err
    }
    return manifestAddress, nil
}

// UpdateResource allows you to set a new version of your content
func (c *Client) UpdateResource(request *mru.Request) error {
    _, err := c.updateResource(request)
    return err
}

func (c *Client) updateResource(request *mru.Request) (io.ReadCloser, error) {
    body, err := request.MarshalJSON()
    if err != nil {
        return nil, err
    }

    req, err := http.NewRequest("POST", c.Gateway+"/bzz-resource:/", bytes.NewBuffer(body))
    if err != nil {
        return nil, err
    }

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return nil, err
    }

    return res.Body, nil

}

// GetResource returns a byte stream with the raw content of the resource
// manifestAddressOrDomain is the address you obtained in CreateResource or an ENS domain whose Resolver
// points to that address
func (c *Client) GetResource(manifestAddressOrDomain string) (io.ReadCloser, error) {

    res, err := http.Get(c.Gateway + "/bzz-resource:/" + manifestAddressOrDomain)
    if err != nil {
        return nil, err
    }
    return res.Body, nil

}

// GetResourceMetadata returns a structure that describes the Mutable Resource
// manifestAddressOrDomain is the address you obtained in CreateResource or an ENS domain whose Resolver
// points to that address
func (c *Client) GetResourceMetadata(manifestAddressOrDomain string) (*mru.Request, error) {

    responseStream, err := c.GetResource(manifestAddressOrDomain + "/meta")
    if err != nil {
        return nil, err
    }
    defer responseStream.Close()

    body, err := ioutil.ReadAll(responseStream)
    if err != nil {
        return nil, err
    }

    var metadata mru.Request
    if err := metadata.UnmarshalJSON(body); err != nil {
        return nil, err
    }
    return &metadata, nil
}