pax_global_header00006660000000000000000000000064152071214320014507gustar00rootroot0000000000000052 comment=9d0c0ee2ea6296d84800a8bb3f1c3e02085098dc golang-github-ysmood-fetchup-0.3.0/000077500000000000000000000000001520712143200172025ustar00rootroot00000000000000golang-github-ysmood-fetchup-0.3.0/.github/000077500000000000000000000000001520712143200205425ustar00rootroot00000000000000golang-github-ysmood-fetchup-0.3.0/.github/workflows/000077500000000000000000000000001520712143200225775ustar00rootroot00000000000000golang-github-ysmood-fetchup-0.3.0/.github/workflows/test.yml000066400000000000000000000007311520712143200243020ustar00rootroot00000000000000name: Go on: [push] jobs: old-go: runs-on: ubuntu-latest steps: - uses: actions/setup-go@v4 with: go-version: 1.16 - uses: actions/checkout@v3 - run: go build test: runs-on: ${{ matrix.os }} strategy: matrix: os: [macos-latest, windows-latest, ubuntu-latest] steps: - uses: actions/setup-go@v4 with: go-version: 1.20.1 - uses: actions/checkout@v3 - run: go test golang-github-ysmood-fetchup-0.3.0/.gitignore000066400000000000000000000000121520712143200211630ustar00rootroot00000000000000tmp/ *.outgolang-github-ysmood-fetchup-0.3.0/LICENSE000066400000000000000000000020521520712143200202060ustar00rootroot00000000000000MIT License Copyright (c) 2023 Yad Smood Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. golang-github-ysmood-fetchup-0.3.0/README.md000066400000000000000000000002011520712143200204520ustar00rootroot00000000000000# Overview A lib to fetch the target file from remote. It will auto choose the fastest url to download and decompress the file. golang-github-ysmood-fetchup-0.3.0/download.go000066400000000000000000000075741520712143200213550ustar00rootroot00000000000000package fetchup import ( "archive/tar" "archive/zip" "bytes" "compress/gzip" "io" "net/http" "os" "path/filepath" "strings" ) type Response struct { Req *http.Request ResHeader http.Header ProgressedBody io.Reader Close func() } func (fu *Fetchup) Request(u string) (*Response, error) { req, err := http.NewRequestWithContext(fu.Ctx, http.MethodGet, u, nil) if err != nil { return nil, err } res, err := fu.HttpClient.Do(req) if err != nil { return nil, err } return &Response{ Req: req, ResHeader: res.Header, ProgressedBody: newProgress(fu.Ctx, res.Body, int(res.ContentLength), fu.MinReportSpan, fu.Logger), Close: func() { _ = res.Body.Close() }, }, nil } func (fu *Fetchup) Download(u string) error { fu.Logger.Println(EventDownload, u) res, err := fu.Request(u) if err != nil { return err } defer res.Close() r := res.ProgressedBody if strings.HasSuffix(u, ".gz") || res.ResHeader.Get("Content-Encoding") == "gzip" { u = strings.TrimSuffix(u, ".gz") r, err = gzip.NewReader(r) if err != nil { return err } } if strings.HasSuffix(u, ".tar") { err := fu.UnTar(r) if err != nil { return err } } else if strings.HasSuffix(u, ".zip") { err := fu.UnZip(r) if err != nil { return err } } else { err = os.MkdirAll(filepath.Dir(fu.To), 0755) if err != nil { return err } f, err := os.Create(fu.To) if err != nil { return err } defer f.Close() _, err = io.Copy(f, r) if err != nil { return err } } fu.Logger.Println(EventDownloaded, fu.To) return nil } func (fu *Fetchup) UnZip(r io.Reader) error { // Because zip format does not streaming, we need to download to a temp file f, err := os.CreateTemp("", "fetchup") if err != nil { return err } defer os.Remove(f.Name()) defer f.Close() n, err := io.Copy(f, r) if err != nil { return err } zr, err := zip.NewReader(f, n) if err != nil { return err } size := 0 for _, f := range zr.File { size += int(f.UncompressedSize64) } fu.Logger.Println(EventUnzip, fu.To) progress := newProgress(fu.Ctx, nil, size, fu.MinReportSpan, fu.Logger) for _, f := range zr.File { p := filepath.Join(fu.To, normalizePath(f.Name)) if f.FileInfo().IsDir() { err := os.MkdirAll(p, f.Mode()) if err != nil { return err } continue } r, err := f.Open() if err != nil { return err } if f.FileInfo().Mode()&os.ModeSymlink == os.ModeSymlink { buf := bytes.NewBuffer(nil) _, err = io.Copy(io.MultiWriter(buf, progress), r) if err != nil { return err } err = os.Symlink(normalizePath(buf.String()), p) if err != nil { return err } continue } err = os.MkdirAll(filepath.Dir(p), 0755) if err != nil { return err } dst, err := os.OpenFile(p, os.O_RDWR|os.O_CREATE|os.O_TRUNC, f.Mode()) if err != nil { return err } _, err = io.Copy(io.MultiWriter(dst, progress), r) if err != nil { return err } err = dst.Close() if err != nil { return err } } return nil } func (fu *Fetchup) UnTar(r io.Reader) error { tr := tar.NewReader(r) for { if fu.Ctx.Err() != nil { return fu.Ctx.Err() } hdr, err := tr.Next() if err == io.EOF { break // End of archive } if err != nil { return err } info := hdr.FileInfo() p := filepath.Join(fu.To, hdr.Name) if info.IsDir() { err = os.MkdirAll(p, info.Mode()) if err != nil { return err } continue } err = os.MkdirAll(filepath.Dir(p), 0755) if err != nil { return err } if hdr.Linkname != "" { err = os.Symlink(hdr.Linkname, p) if err != nil { return err } continue } dst, err := os.OpenFile(p, os.O_RDWR|os.O_CREATE|os.O_TRUNC, info.Mode()) if err != nil { return err } _, err = io.Copy(dst, tr) if err != nil { return err } err = dst.Close() if err != nil { return err } } return nil } golang-github-ysmood-fetchup-0.3.0/events.go000066400000000000000000000003011520712143200210270ustar00rootroot00000000000000package fetchup type Event string const ( EventDownload Event = "Download:" EventProgress Event = "Progress:" EventUnzip Event = "Unzip:" EventDownloaded Event = "Downloaded:" ) golang-github-ysmood-fetchup-0.3.0/fetchup.go000066400000000000000000000037511520712143200211750ustar00rootroot00000000000000package fetchup import ( "context" "fmt" "io" "log" "net/http" "os" "sync" "time" ) type Fetchup struct { Ctx context.Context // To is the path to save the file. To string // URLs is the list of candidates, the fastest one will be used to download the file. URLs []string Logger Logger // SpeedPacketSize is the size of the packet used to calculate the download speed. // The size should be much smaller than the whole file size to download. SpeedPacketSize int MinReportSpan time.Duration HttpClient *http.Client } func New(to string, us ...string) *Fetchup { return &Fetchup{ Ctx: context.Background(), To: to, URLs: us, Logger: log.New(os.Stderr, "", log.LstdFlags), SpeedPacketSize: 64 * 1024, MinReportSpan: time.Second, HttpClient: &http.Client{ Transport: &DefaultTransport{UA: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36"}, }, } } func (fu *Fetchup) Fetch() error { u := fu.FastestURL() if u == "" { return &ErrNoURLs{fu.URLs} } return fu.Download(u) } type ErrNoURLs struct { URLs []string } func (e *ErrNoURLs) Error() string { return fmt.Sprintf("Not able to find a valid URL to download %v", e.URLs) } func (fu *Fetchup) FastestURL() (fastest string) { setURL := sync.Once{} ctx, cancel := context.WithCancel(fu.Ctx) defer cancel() wg := sync.WaitGroup{} for _, u := range fu.URLs { u := u wg.Add(1) go func() { defer wg.Done() req, err := http.NewRequestWithContext(ctx, http.MethodGet, u, nil) if err != nil { return } res, err := fu.HttpClient.Do(req) if err != nil { return } defer func() { _ = res.Body.Close() }() if res.StatusCode == http.StatusOK { buf := make([]byte, fu.SpeedPacketSize) _, err = io.ReadFull(res.Body, buf) if err != nil { return } setURL.Do(func() { fastest = u cancel() }) } }() } wg.Wait() return } golang-github-ysmood-fetchup-0.3.0/fetchup_test.go000066400000000000000000000064351520712143200222360ustar00rootroot00000000000000package fetchup_test import ( "errors" "io" "log" "os" "path/filepath" "runtime" "testing" "github.com/ysmood/fetchup" "github.com/ysmood/got" ) func TestUnTar(t *testing.T) { g, s, data := setup(t) logger := &bufLogger{} u := s.URL("/tar-gz/t.tar.gz") d := getTmpDir(g) fu := fetchup.New(d) fu.Logger = logger g.E(fu.Download(u)) g.Eq(g.Read(filepath.Join(d, "a", "t.txt")).Bytes(), data) g.Eq(logger.buf, g.Render(`Download: {{.U}} Progress: 19% Downloaded: {{.D}} `, struct { U string D string }{u, d}).String()) } func TestZip(t *testing.T) { g, s, data := setup(t) logger := &bufLogger{} u := s.URL("/zip/t.zip") d := getTmpDir(g) fu := fetchup.New(d) fu.Logger = logger fu.MinReportSpan = 0 g.E(fu.Download(u)) g.Eq(g.Read(filepath.Join(d, "to", "file.txt")).Bytes(), data) g.Eq(logger.buf, g.Render(`Download: {{.U}} Progress: 19% Unzip: {{.D}} Progress: 99% Progress: 100% Downloaded: {{.D}} `, struct { U string D string }{u, d}).String()) } func TestNew(t *testing.T) { g, s, data := setup(t) logger := &bufLogger{} u := s.URL("/tar-gz/t.tar.gz") d := getTmpDir(g) fu := fetchup.New(d, s.URL("/slow/"), u) fu.Logger = logger fu.SpeedPacketSize = 100 g.E(fu.Fetch()) g.Eq(g.Read(filepath.Join(d, "a/t.txt")).Bytes(), data) g.Eq(logger.buf, g.Render(`Download: {{.U}} Progress: 19% Downloaded: {{.D}} `, struct { U string D string }{u, d}).String()) g.E(fetchup.StripFirstDir(d)) g.True(g.PathExists(filepath.Join(d, "t.txt"))) } func TestUnTarSymbolLink(t *testing.T) { if runtime.GOOS == "windows" { t.Skip() } g := got.T(t) p := filepath.FromSlash("tmp/t/t") g.E(os.RemoveAll(p)) g.E(os.MkdirAll(p, 0755)) fu := fetchup.New(p, "") g.E(fu.UnTar(g.Open(false, filepath.FromSlash("fixtures/test.tar")))) g.Eq(g.Read(filepath.FromSlash("tmp/t/t/test/b.txt")).String(), "test test") } func TestUnZipSymbolLink(t *testing.T) { if runtime.GOOS == "windows" { t.Skip() } g := got.T(t) p := filepath.FromSlash("tmp/t/t") g.E(os.RemoveAll(p)) g.E(os.MkdirAll(p, 0755)) fu := fetchup.New(p, "") fu.Logger = log.New(io.Discard, "", 0) g.E(fu.UnZip(g.Open(false, filepath.FromSlash("fixtures/test.zip")))) g.Eq(g.Read(filepath.FromSlash("tmp/t/t/test/b.txt")).String(), "test test") } func TestURLErr(t *testing.T) { g, s, _ := setup(t) fu := fetchup.New(getTmpDir(g), s.URL("/err/")) e := &fetchup.ErrNoURLs{} g.True(errors.As(fu.Fetch(), &e)) } func TestGzipHttpBody(t *testing.T) { g, s, data := setup(t) p := filepath.Join(getTmpDir(g), "t.out") fu := fetchup.New(p, s.URL("/file/")) fu.Logger = log.New(io.Discard, "", 0) fu.SpeedPacketSize = 100 g.E(fu.Fetch()) g.Eq(g.Read(p).Bytes(), data) } func TestNoContentLength(t *testing.T) { g, s, data := setup(t) p := filepath.Join(getTmpDir(g), "t.out") fu := fetchup.New(p, s.URL("/no-content-length/")) fu.Logger = log.New(io.Discard, "", 0) fu.SpeedPacketSize = 100 g.E(fu.Fetch()) g.Eq(g.Read(p).Bytes(), data) } func TestContext(t *testing.T) { g, s, _ := setup(t) p := getTmpDir(g) ctx := g.Context() ctx.Cancel() fu := fetchup.New(p, s.URL("/slow/")) fu.Logger = log.New(io.Discard, "", 0) fu.Ctx = ctx g.Err(fu.Fetch()) fu = fetchup.New(p, s.URL("/slow/")) fu.Logger = log.New(io.Discard, "", 0) fu.Ctx = ctx g.Err(fu.Download(s.URL("/slow/"))) } golang-github-ysmood-fetchup-0.3.0/fixtures/000077500000000000000000000000001520712143200210535ustar00rootroot00000000000000golang-github-ysmood-fetchup-0.3.0/fixtures/test.tar000066400000000000000000000060001520712143200225360ustar00rootroot00000000000000test/000755 000765 000024 00000000000 14412243751 011760 5ustar00yadstaff000000 000000 test/b.txt000755 000765 000024 00000000000 14412243751 013714 2a.txtustar00yadstaff000000 000000 test/a.txt000644 000765 000024 00000000011 14412243734 012732 0ustar00yadstaff000000 000000 test testgolang-github-ysmood-fetchup-0.3.0/fixtures/test.zip000066400000000000000000000014411520712143200225560ustar00rootroot00000000000000PK V test/UT G)d0)d0)dux PK V __MACOSX/._testUT G)d0)d9)dux c`cg`b`MLVVP'* 0CBL)@쁦!ΟXPdeTg2S{3䈳PK}l]PK V test/b.txtUT G)d0)d0)dux a.txtPKV test/a.txtUT G)d0)d0)dux +I-.Q(PK# PK V Atest/UT G)d0)d0)dux PK V}l] C__MACOSX/._testUT G)d0)d9)dux PK V test/b.txtUT G)d0)d0)dux PKV# Jtest/a.txtUT G)d0)d0)dux PK`golang-github-ysmood-fetchup-0.3.0/go.mod000066400000000000000000000002031520712143200203030ustar00rootroot00000000000000module github.com/ysmood/fetchup go 1.21 require github.com/ysmood/got v0.38.2 require github.com/ysmood/gop v0.2.0 // indirect golang-github-ysmood-fetchup-0.3.0/go.sum000066400000000000000000000005041520712143200203340ustar00rootroot00000000000000github.com/ysmood/gop v0.2.0 h1:+tFrG0TWPxT6p9ZaZs+VY+opCvHU8/3Fk6BaNv6kqKg= github.com/ysmood/gop v0.2.0/go.mod h1:rr5z2z27oGEbyB787hpEcx4ab8cCiPnKxn0SUHt6xzk= github.com/ysmood/got v0.38.2 h1:h2RYvAe5nIK+oBRMLzNIrkZaX5kjmkOBqfRMIsFzLyU= github.com/ysmood/got v0.38.2/go.mod h1:W7DdpuX6skL3NszLmAsC5hT7JAhuLZhByVzHTq874Qg= golang-github-ysmood-fetchup-0.3.0/setup_test.go000066400000000000000000000050531520712143200217330ustar00rootroot00000000000000package fetchup_test import ( "archive/tar" "archive/zip" "bytes" "compress/gzip" "crypto/rand" "fmt" "io" "net/http" "path/filepath" "testing" "time" "github.com/ysmood/fetchup" "github.com/ysmood/got" ) type bufLogger struct { buf string } var _ fetchup.Logger = (*bufLogger)(nil) func (b *bufLogger) Println(msg ...interface{}) { b.buf += fmt.Sprintln(msg...) } func getTmpDir(g got.G) string { return filepath.Join("tmp", g.RandStr(8)) } func setup(t *testing.T) (got.G, *got.Router, []byte) { g := got.T(t) data := make([]byte, 20000) g.E(rand.Read(data)) s := g.Serve() s.Mux.HandleFunc("/tar-gz/", func(rw http.ResponseWriter, r *http.Request) { buf := bytes.NewBuffer(nil) gz := gzip.NewWriter(buf) tw := tar.NewWriter(gz) g.E(tw.WriteHeader(&tar.Header{ Typeflag: tar.TypeDir, Name: "a", Mode: 0755, })) g.E(tw.Write(nil)) g.E(tw.WriteHeader(&tar.Header{ Typeflag: tar.TypeReg, Name: "a/t.txt", Mode: 0644, Size: int64(len(data)), })) g.E(tw.Write(data)) g.E(tw.Close()) g.E(gz.Close()) rw.Header().Add("Content-Length", fmt.Sprintf("%d", buf.Len())) g.E(io.Copy(rw, buf)) }) s.Mux.HandleFunc("/zip/", func(rw http.ResponseWriter, r *http.Request) { buf := bytes.NewBuffer(nil) zw := zip.NewWriter(buf) // folder "to" h := &zip.FileHeader{Name: "to/"} h.SetMode(0755) _, err := zw.CreateHeader(h) g.E(err) // file "file.txt" w, err := zw.CreateHeader(&zip.FileHeader{Name: "to/file.txt"}) g.E(err) g.E(w.Write(data)) // file "file2.txt" w, err = zw.CreateHeader(&zip.FileHeader{Name: "to/file2.txt"}) g.E(err) g.E(w.Write([]byte("ok"))) g.E(zw.Close()) rw.Header().Add("Content-Length", fmt.Sprintf("%d", buf.Len())) _, _ = io.Copy(rw, buf) }) s.Mux.HandleFunc("/slow/", func(rw http.ResponseWriter, r *http.Request) { t := time.NewTimer(3 * time.Second) select { case <-t.C: case <-r.Context().Done(): t.Stop() } }) s.Mux.HandleFunc("/file/", func(rw http.ResponseWriter, r *http.Request) { buf := bytes.NewBuffer(nil) gz := gzip.NewWriter(buf) g.E(gz.Write(data)) g.E(gz.Close()) rw.Header().Add("Content-Length", fmt.Sprintf("%d", buf.Len())) rw.Header().Add("Content-Encoding", "gzip") g.E(io.Copy(rw, buf)) }) s.Mux.HandleFunc("/no-content-length/", func(rw http.ResponseWriter, r *http.Request) { rw.WriteHeader(http.StatusOK) g.E(rw.Write(data)) }) s.Mux.HandleFunc("/err/", func(rw http.ResponseWriter, r *http.Request) { rw.WriteHeader(http.StatusInternalServerError) }) return g, s, data } golang-github-ysmood-fetchup-0.3.0/utils.go000066400000000000000000000072351520712143200207000ustar00rootroot00000000000000package fetchup import ( "context" "crypto/rand" "fmt" "io" "net/http" "os" "path/filepath" "runtime" "strings" "time" ) // Logger interface type Logger interface { // Same as fmt.Printf Println(...interface{}) } // Log type for Println type Log func(msg ...interface{}) // Println interface func (l Log) Println(msg ...interface{}) { l(msg...) } // LoggerQuiet does nothing var LoggerQuiet Logger = Log(func(_ ...interface{}) {}) // MultiLogger is similar to https://golang.org/pkg/io/#MultiWriter func MultiLogger(list ...Logger) Log { return Log(func(msg ...interface{}) { for _, lg := range list { lg.Println(msg...) } }) } type progress struct { ctx context.Context s io.Reader total int count int logger Logger last time.Time minSpan time.Duration } var _ io.ReadWriter = &progress{} // newProgress returns a new progress reader. func newProgress(ctx context.Context, s io.Reader, total int, minSpan time.Duration, logger Logger) *progress { return &progress{ ctx: ctx, s: s, total: total, logger: logger, minSpan: minSpan, } } func (p *progress) Read(b []byte) (n int, err error) { if p.ctx.Err() != nil { return 0, p.ctx.Err() } n, err = p.s.Read(b) p.count += n if err != nil { return } if time.Since(p.last) < p.minSpan { return } p.last = time.Now() p.report() return } func (p *progress) Write(b []byte) (n int, err error) { if p.ctx.Err() != nil { return len(b), p.ctx.Err() } n = len(b) p.count += n if time.Since(p.last) < p.minSpan { return } p.last = time.Now() p.report() return } func (p *progress) report() { out := "" if p.total > 0 { out = fmt.Sprintf("%02d%%", p.count*100/p.total) } else { out = fmt.Sprintf("%.3fMB", float64(p.count)/1024/1024) } p.logger.Println(EventProgress, out) } func CacheDir() string { return filepath.Join(map[string]string{ "windows": filepath.Join(os.Getenv("APPDATA")), "darwin": filepath.Join(os.Getenv("HOME"), ".cache"), "linux": filepath.Join(os.Getenv("HOME"), ".cache"), }[runtime.GOOS]) } // StripFirstDir removes the first dir but keep all its children. func StripFirstDir(dir string) error { list, err := readDir(dir) if err != nil { return err } name := "" for _, f := range list { if f.IsDir() { if name != "" { return fmt.Errorf("expected only one dir in %s", dir) } name = f.Name() continue } } if name == "" { return fmt.Errorf("no dir found under %s", dir) } root := filepath.Join(dir, name) up := filepath.Join(filepath.Dir(dir)) toName := filepath.Base(dir) b := make([]byte, 8) _, err = rand.Read(b) if err != nil { return err } tmp := filepath.Join(up, fmt.Sprintf("%x", b)) err = os.Rename(root, tmp) if err != nil { return err } err = os.RemoveAll(dir) if err != nil { return err } return os.Rename(tmp, filepath.Join(up, toName)) } func readDir(dir string) ([]os.FileInfo, error) { dirFile, err := os.Open(dir) if err != nil { return nil, err } defer func() { _ = dirFile.Close() }() list, err := dirFile.Readdir(0) if err != nil { return nil, err } return list, nil } func normalizePath(p string) string { p = strings.ReplaceAll(p, "\\", string(filepath.Separator)) return strings.ReplaceAll(p, "/", string(filepath.Separator)) } // DefaultTransport is the default http transport for fetchup, it auto handles the gzip and user-agent. type DefaultTransport struct { UA string } var _ http.RoundTripper = (*DefaultTransport)(nil) func (t *DefaultTransport) RoundTrip(req *http.Request) (*http.Response, error) { req.Header.Set("User-Agent", t.UA) req.Header.Set("Accept-Encoding", "gzip") return http.DefaultTransport.RoundTrip(req) }