Merge pull request #145 from allanpk716/master

add proxy settings

Dockerfile

@@ -1,18 +1,18 @@
 # bump: golang /GOLANG_VERSION=([\d.]+)/ docker:golang|^1
 # bump: golang link "Release notes" https://golang.org/doc/devel/release.html
-ARG GOLANG_VERSION=1.17.5
-# bump: youtube-dl /YDL_VERSION=([\d.]+)/ https://github.com/ytdl-org/youtube-dl.git|/^\d/|sort
-# bump: youtube-dl link "Release notes" https://github.com/ytdl-org/youtube-dl/releases/tag/$LATEST
-ARG YDL_VERSION=2021.06.06
+ARG GOLANG_VERSION=1.20.5
+# bump: yt-dlp /YT_DLP=([\d.-]+)/ https://github.com/yt-dlp/yt-dlp.git|/^\d/|sort
+# bump: yt-dlp link "Release notes" https://github.com/yt-dlp/yt-dlp/releases/tag/$LATEST
+ARG YT_DLP=2023.03.04
 
 FROM golang:$GOLANG_VERSION AS base
-ARG YDL_VERSION
+ARG YT_DLP
 
 RUN \
   apt-get update -q && \
   apt-get install -y -q python-is-python3 && \
-  curl -L -o /usr/local/bin/youtube-dl https://yt-dl.org/downloads/$YDL_VERSION/youtube-dl && \
-  chmod a+x /usr/local/bin/youtube-dl
+  curl -L https://github.com/yt-dlp/yt-dlp/releases/download/$YT_DLP/yt-dlp -o /usr/local/bin/yt-dlp && \
+  chmod a+x /usr/local/bin/yt-dlp
 
 FROM base AS dev
 

README.md

@@ -1,12 +1,15 @@
 ## goutubedl
 
-Go wrapper for [youtube-dl](https://github.com/ytdl-org/youtube-dl). API documentation can be found at [godoc.org](https://pkg.go.dev/github.com/wader/goutubedl?tab=doc).
+Go wrapper for [youtube-dl](https://github.com/ytdl-org/youtube-dl) and [yt-dlp](https://github.com/yt-dlp/yt-dlp), currently tested and
+developed using yt-dlp.
+API documentation can be found at [godoc.org](https://pkg.go.dev/github.com/wader/goutubedl?tab=doc).
 
-See [youtube-dl documentation](https://github.com/ytdl-org/youtube-dl) for how to
+See [yt-dlp documentation](https://github.com/yt-dlp/yt-dlp) for how to
 install and what is recommended to install in addition to youtube-dl.
 
 goutubedl default uses `PATH` to find youtube-dl but it can be configured with the `goutubedl.Path`
-variable.
+variable. Default is currently `youtube-dl` for backwards compability. If your using yt-dlp you
+probably want to set it to `yt-dlp`.
 
 Due to the nature and frequent updates of youtube-dl only the latest version
 is tested. But it seems to work well with older versions also.

cmd/goutubedl/main.go

@@ -15,11 +15,17 @@ var dumpFlag = flag.Bool("J", false, "Dump JSON")
 var typeFlag = flag.String("t", "any", "Type")
 
 func main() {
+	goutubedl.Path = "yt-dlp"
+
 	log.SetFlags(0)
 	flag.Parse()
 
-	optType, _ := goutubedl.TypeFromString[*typeFlag]
-	result, err := goutubedl.New(context.Background(), flag.Arg(0), goutubedl.Options{Type: optType})
+	optType := goutubedl.TypeFromString[*typeFlag]
+	result, err := goutubedl.New(
+		context.Background(),
+		flag.Arg(0),
+		goutubedl.Options{Type: optType, DebugLog: log.Default()},
+	)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -44,6 +50,8 @@ func main() {
 		log.Fatal(err)
 	}
 	defer f.Close()
-	io.Copy(f, dr)
+	if _, err := io.Copy(f, dr); err != nil {
+		log.Fatal(err)
+	}
 	dr.Close()
 }

goutubedl.go

@@ -206,6 +206,7 @@ type Options struct {
 	PlaylistEnd       uint // --playlist-end
 	DownloadThumbnail bool
 	DownloadSubtitles bool
+	ProxyUrl          string // --proxy URL  http://host:port or socks5://host:port
 	DebugLog          Printer
 	StderrFn          func(cmd *exec.Cmd) io.Writer // if not nil, function to get Writer for stderr
 	HTTPClient        *http.Client                  // Client for download thumbnail and subtitles (nil use http.DefaultClient)
@@ -258,6 +259,11 @@ func infoFromURL(ctx context.Context, rawURL string, options Options) (info Info
 		"--batch-file", "-",
 		"-J",
 	)
+
+	if options.ProxyUrl != "" {
+		cmd.Args = append(cmd.Args, "--proxy", options.ProxyUrl)
+	}
+
 	if options.Type == TypePlaylist {
 		cmd.Args = append(cmd.Args, "--yes-playlist")
 
@@ -455,6 +461,10 @@ func (result Result) Download(ctx context.Context, filter string) (*DownloadResu
 		cmd.Args = append(cmd.Args, "-f", filter)
 	}
 
+	if result.Options.ProxyUrl != "" {
+		cmd.Args = append(cmd.Args, "--proxy", result.Options.ProxyUrl)
+	}
+
 	cmd.Dir = tempPath
 	var w io.WriteCloser
 	dr.reader, w = io.Pipe()

goutubedl_test.go

@@ -1,4 +1,4 @@
-package goutubedl
+package goutubedl_test
 
 // TODO: currently the tests only run on linux as they use osleaktest which only
 // has linux support
@@ -14,9 +14,15 @@ import (
 	"testing"
 
 	"github.com/fortytw2/leaktest"
+	"github.com/wader/goutubedl"
 	"github.com/wader/osleaktest"
 )
 
+func init() {
+	// we're using yt-dlp at the moment
+	goutubedl.Path = "yt-dlp"
+}
+
 const testVideoRawURL = "https://www.youtube.com/watch?v=C0DPdy98e4c"
 const playlistRawURL = "https://soundcloud.com/mattheis/sets/kindred-phenomena"
 const subtitlesTestVideoRawURL = "https://www.youtube.com/watch?v=QRS8MkLhQmM"
@@ -33,10 +39,10 @@ func leakChecks(t *testing.T) func() {
 
 func TestBinaryNotPath(t *testing.T) {
 	defer leakChecks(t)()
-	defer func(orig string) { Path = orig }(Path)
-	Path = "/non-existing"
+	defer func(orig string) { goutubedl.Path = orig }(goutubedl.Path)
+	goutubedl.Path = "/non-existing"
 
-	_, versionErr := Version(context.Background())
+	_, versionErr := goutubedl.Version(context.Background())
 	if versionErr == nil || !strings.Contains(versionErr.Error(), "no such file or directory") {
 		t.Fatalf("err should be nil 'no such file or directory': %v", versionErr)
 	}
@@ -46,7 +52,7 @@ func TestVersion(t *testing.T) {
 	defer leakChecks(t)()
 
 	versionRe := regexp.MustCompile(`^\d{4}\.\d{2}.\d{2}.*$`)
-	version, versionErr := Version(context.Background())
+	version, versionErr := goutubedl.Version(context.Background())
 
 	if versionErr != nil {
 		t.Fatalf("err: %s", versionErr)
@@ -61,7 +67,7 @@ func TestDownload(t *testing.T) {
 	defer leakChecks(t)()
 
 	stderrBuf := &bytes.Buffer{}
-	r, err := New(context.Background(), testVideoRawURL, Options{
+	r, err := goutubedl.New(context.Background(), testVideoRawURL, goutubedl.Options{
 		StderrFn: func(cmd *exec.Cmd) io.Writer {
 			return stderrBuf
 		},
@@ -84,8 +90,8 @@ func TestDownload(t *testing.T) {
 		t.Errorf("copy n not equal to download buffer: %d!=%d", n, downloadBuf.Len())
 	}
 
-	if n < 29000 {
-		t.Errorf("should have copied at least 29000 bytes: %d", n)
+	if n < 10000 {
+		t.Errorf("should have copied at least 10000 bytes: %d", n)
 	}
 
 	if !strings.Contains(stderrBuf.String(), "Destination") {
@@ -106,7 +112,7 @@ func TestParseInfo(t *testing.T) {
 			defer leakChecks(t)()
 
 			ctx, cancelFn := context.WithCancel(context.Background())
-			ydlResult, err := New(ctx, c.url, Options{
+			ydlResult, err := goutubedl.New(ctx, c.url, goutubedl.Options{
 				DownloadThumbnail: true,
 			})
 			if err != nil {
@@ -156,8 +162,8 @@ func TestParseInfo(t *testing.T) {
 func TestPlaylist(t *testing.T) {
 	defer leakChecks(t)()
 
-	ydlResult, ydlResultErr := New(context.Background(), playlistRawURL, Options{
-		Type:              TypePlaylist,
+	ydlResult, ydlResultErr := goutubedl.New(context.Background(), playlistRawURL, goutubedl.Options{
+		Type:              goutubedl.TypePlaylist,
 		DownloadThumbnail: false,
 	})
 
@@ -184,11 +190,11 @@ func TestPlaylist(t *testing.T) {
 func TestTestUnsupportedURL(t *testing.T) {
 	defer leaktest.Check(t)()
 
-	_, ydlResultErr := New(context.Background(), "https://www.google.com", Options{})
+	_, ydlResultErr := goutubedl.New(context.Background(), "https://www.google.com", goutubedl.Options{})
 	if ydlResultErr == nil {
 		t.Errorf("expected unsupported url")
 	}
-	expectedErrPrefix := "Unsupported URL: https://www.google.com"
+	expectedErrPrefix := "Unsupported URL:"
 	if ydlResultErr != nil && !strings.HasPrefix(ydlResultErr.Error(), expectedErrPrefix) {
 		t.Errorf("expected error prefix %q got %q", expectedErrPrefix, ydlResultErr.Error())
 
@@ -199,8 +205,8 @@ func TestPlaylistWithPrivateVideo(t *testing.T) {
 	defer leaktest.Check(t)()
 
 	playlistRawURL := "https://www.youtube.com/playlist?list=PLX0g748fkegS54oiDN4AXKl7BR7mLIydP"
-	ydlResult, ydlResultErr := New(context.Background(), playlistRawURL, Options{
-		Type:              TypePlaylist,
+	ydlResult, ydlResultErr := goutubedl.New(context.Background(), playlistRawURL, goutubedl.Options{
+		Type:              goutubedl.TypePlaylist,
 		DownloadThumbnail: false,
 	})
 
@@ -218,10 +224,10 @@ func TestPlaylistWithPrivateVideo(t *testing.T) {
 func TestSubtitles(t *testing.T) {
 	defer leakChecks(t)()
 
-	ydlResult, ydlResultErr := New(
+	ydlResult, ydlResultErr := goutubedl.New(
 		context.Background(),
 		subtitlesTestVideoRawURL,
-		Options{
+		goutubedl.Options{
 			DownloadSubtitles: true,
 		})
 
@@ -250,11 +256,11 @@ func TestSubtitles(t *testing.T) {
 func TestErrorNotAPlaylist(t *testing.T) {
 	defer leakChecks(t)()
 
-	_, ydlResultErr := New(context.Background(), testVideoRawURL, Options{
-		Type:              TypePlaylist,
+	_, ydlResultErr := goutubedl.New(context.Background(), testVideoRawURL, goutubedl.Options{
+		Type:              goutubedl.TypePlaylist,
 		DownloadThumbnail: false,
 	})
-	if ydlResultErr != ErrNotAPlaylist {
+	if ydlResultErr != goutubedl.ErrNotAPlaylist {
 		t.Errorf("expected is playlist error, got %s", ydlResultErr)
 	}
 }
@@ -262,11 +268,11 @@ func TestErrorNotAPlaylist(t *testing.T) {
 func TestErrorNotASingleEntry(t *testing.T) {
 	defer leakChecks(t)()
 
-	_, ydlResultErr := New(context.Background(), playlistRawURL, Options{
-		Type:              TypeSingle,
+	_, ydlResultErr := goutubedl.New(context.Background(), playlistRawURL, goutubedl.Options{
+		Type:              goutubedl.TypeSingle,
 		DownloadThumbnail: false,
 	})
-	if ydlResultErr != ErrNotASingleEntry {
+	if ydlResultErr != goutubedl.ErrNotASingleEntry {
 		t.Errorf("expected is single entry error, got %s", ydlResultErr)
 	}
 }