feat: initial goget release — modern IPv6-first download utility

This commit is contained in:
2026-06-26 21:21:58 +02:00
commit 53db81e1f7
147 changed files with 45931 additions and 0 deletions
+817
View File
@@ -0,0 +1,817 @@
//go:build linux || freebsd
// +build linux freebsd
package ftp
import (
"bufio"
"context"
"crypto/tls"
"fmt"
"io"
"net"
"net/textproto"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"sync"
"time"
"codeberg.org/petrbalvin/goget/internal/output"
)
type Client struct {
conn net.Conn
reader *textproto.Reader
writer *bufio.Writer
host string
port int
user string
password string
url string
tlsConfig *tls.Config
useTLS bool
passive bool
timeout time.Duration
}
func NewClient(rawURL string, timeout time.Duration) (*Client, error) {
u, err := url.Parse(rawURL)
if err != nil {
return nil, fmt.Errorf("invalid url: %w", err)
}
host := u.Hostname()
port := 21
if u.Port() != "" {
p, err := strconv.Atoi(u.Port())
if err != nil {
return nil, fmt.Errorf("invalid port: %w", err)
}
port = p
}
user := "anonymous"
password := "anonymous@"
if u.User != nil {
user = u.User.Username()
if pass, ok := u.User.Password(); ok {
password = pass
}
}
useTLS := u.Scheme == "ftps"
if !useTLS && (user != "anonymous" || (u.User != nil && u.User.Username() != "anonymous")) {
fmt.Fprintf(os.Stderr, "Warning: FTP credentials sent in plaintext. Use ftps:// for encrypted transfers.\n")
}
c := &Client{
host: host,
port: port,
user: user,
password: password,
url: rawURL,
useTLS: useTLS,
passive: true, // Default to passive mode
timeout: timeout,
tlsConfig: &tls.Config{
MinVersion: tls.VersionTLS12,
ServerName: host,
InsecureSkipVerify: false,
},
}
return c, nil
}
func (c *Client) Connect() error {
addr := net.JoinHostPort(c.host, fmt.Sprintf("%d", c.port))
conn, err := net.DialTimeout("tcp", addr, c.timeout)
if err != nil {
return fmt.Errorf("failed to connect: %w", err)
}
c.conn = conn
c.reader = textproto.NewReader(bufio.NewReader(conn))
c.writer = bufio.NewWriter(conn)
// Read greeting
code, _, err := c.readResponse()
if err != nil {
return fmt.Errorf("failed to read greeting: %w", err)
}
if code != 220 {
return fmt.Errorf("unexpected greeting code: %d", code)
}
// Upgrade to TLS if FTPS (explicit)
if c.useTLS {
if err := c.sendCommand("AUTH TLS"); err != nil {
return err
}
code, _, err := c.readResponse()
if err != nil {
return fmt.Errorf("auth tls failed: %w", err)
}
if code != 234 && code != 334 {
// Try AUTH SSL as fallback
if err := c.sendCommand("AUTH SSL"); err != nil {
return err
}
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("auth ssl failed: %w", err)
}
if code != 234 && code != 334 {
return fmt.Errorf("server does not support tls/ssl")
}
}
// Wrap connection with TLS
tlsConn := tls.Client(c.conn, c.tlsConfig)
if err := tlsConn.Handshake(); err != nil {
return fmt.Errorf("tls handshake failed: %w", err)
}
c.conn = tlsConn
c.reader = textproto.NewReader(bufio.NewReader(tlsConn))
c.writer = bufio.NewWriter(tlsConn)
}
// Send USER
if err := c.sendCommand("USER %s", c.user); err != nil {
return err
}
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("user command failed: %w", err)
}
// 331 means password required, 230 means already logged in
if code == 331 {
// Send PASS
if err := c.sendCommand("PASS %s", c.password); err != nil {
return err
}
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("pass command failed: %w", err)
}
}
if code != 230 && code != 200 {
return fmt.Errorf("login failed with code: %d", code)
}
// Set binary mode
if err := c.sendCommand("TYPE I"); err != nil {
return err
}
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("type command failed: %w", err)
}
if code != 200 {
return fmt.Errorf("failed to set binary mode")
}
return nil
}
func (c *Client) sendCommand(format string, args ...interface{}) error {
cmd := fmt.Sprintf(format, args...)
if _, err := c.writer.WriteString(cmd); err != nil {
return fmt.Errorf("failed to send command: %w", err)
}
if _, err := c.writer.WriteString("\r\n"); err != nil {
return fmt.Errorf("failed to send command terminator: %w", err)
}
if err := c.writer.Flush(); err != nil {
return fmt.Errorf("failed to flush command: %w", err)
}
return nil
}
func (c *Client) readResponse() (int, string, error) {
code, msg, err := c.reader.ReadResponse(0)
if err != nil {
return 0, "", err
}
return code, msg, nil
}
func (c *Client) getFileSize(path string) (int64, error) {
if err := c.sendCommand("SIZE %s", path); err != nil {
return 0, err
}
code, msg, err := c.readResponse()
if err != nil {
return 0, fmt.Errorf("size command failed: %w", err)
}
if code != 213 {
return 0, fmt.Errorf("size command failed with code: %d", code)
}
size, err := strconv.ParseInt(strings.TrimSpace(msg), 10, 64)
if err != nil {
return 0, fmt.Errorf("failed to parse size: %w", err)
}
return size, nil
}
func (c *Client) establishDataConnection() (net.Conn, error) {
if c.passive {
return c.enterPassiveMode()
}
return c.enterActiveMode()
}
func (c *Client) enterPassiveMode() (net.Conn, error) {
if err := c.sendCommand("PASV"); err != nil {
return nil, err
}
code, msg, err := c.readResponse()
if err != nil {
return nil, fmt.Errorf("pasv command failed: %w", err)
}
if code != 227 {
return nil, fmt.Errorf("pasv command failed with code: %d", code)
}
// Parse PASV response: 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
start := strings.Index(msg, "(")
end := strings.Index(msg, ")")
if start == -1 || end == -1 {
return nil, fmt.Errorf("invalid pasv response")
}
parts := strings.Split(msg[start+1:end], ",")
if len(parts) != 6 {
return nil, fmt.Errorf("invalid pasv response format")
}
h1, _ := strconv.Atoi(parts[0])
h2, _ := strconv.Atoi(parts[1])
h3, _ := strconv.Atoi(parts[2])
h4, _ := strconv.Atoi(parts[3])
p1, _ := strconv.Atoi(parts[4])
p2, _ := strconv.Atoi(parts[5])
dataHost := fmt.Sprintf("%d.%d.%d.%d", h1, h2, h3, h4)
dataPort := p1*256 + p2
// Use original host for TLS connections to match certificate
if c.useTLS {
dataHost = c.host
}
conn, err := net.DialTimeout("tcp", fmt.Sprintf("%s:%d", dataHost, dataPort), c.timeout)
if err != nil {
return nil, fmt.Errorf("failed to connect to data port: %w", err)
}
if c.useTLS {
tlsConn := tls.Client(conn, c.tlsConfig)
if err := tlsConn.Handshake(); err != nil {
conn.Close()
return nil, fmt.Errorf("tls handshake on data connection failed: %w", err)
}
return tlsConn, nil
}
return conn, nil
}
func (c *Client) enterActiveMode() (net.Conn, error) {
// Get local IP from the control connection to bind only to that interface
ctrlAddr, ok := c.conn.LocalAddr().(*net.TCPAddr)
if !ok || ctrlAddr.IP == nil {
return nil, fmt.Errorf("failed to get local address for active mode")
}
ctrlIP := ctrlAddr.IP.To4()
if ctrlIP == nil {
return nil, fmt.Errorf("no ipv4 address available for active mode")
}
// Bind listener only to the interface of the control connection, not 0.0.0.0
listener, err := net.Listen("tcp", net.JoinHostPort(ctrlIP.String(), "0"))
if err != nil {
return nil, fmt.Errorf("failed to create listener: %w", err)
}
defer listener.Close()
// Set a deadline so Accept respects the timeout
if tcpListener, ok := listener.(*net.TCPListener); ok {
tcpListener.SetDeadline(time.Now().Add(c.timeout))
}
listenAddr := listener.Addr().(*net.TCPAddr)
p1 := listenAddr.Port / 256
p2 := listenAddr.Port % 256
portCmd := fmt.Sprintf("PORT %d,%d,%d,%d,%d,%d",
ctrlIP[0], ctrlIP[1], ctrlIP[2], ctrlIP[3], p1, p2)
if err := c.sendCommand("%s", portCmd); err != nil {
return nil, err
}
code, _, err := c.readResponse()
if err != nil {
return nil, fmt.Errorf("port command failed: %w", err)
}
if code != 200 {
return nil, fmt.Errorf("port command failed with code: %d", code)
}
// Accept incoming connection
connChan := make(chan net.Conn, 1)
errChan := make(chan error, 1)
go func() {
conn, err := listener.Accept()
if err != nil {
errChan <- err
return
}
connChan <- conn
}()
select {
case conn := <-connChan:
return conn, nil
case err := <-errChan:
return nil, fmt.Errorf("failed to accept data connection: %w", err)
case <-time.After(c.timeout):
return nil, fmt.Errorf("timeout waiting for data connection")
}
}
func (c *Client) DownloadFile(ctx context.Context, remotePath, localPath string, resumeOffset int64, progressFunc func(current, total int64)) error {
// Get file size
totalSize, err := c.getFileSize(remotePath)
if err != nil {
return fmt.Errorf("failed to get file size: %w", err)
}
// Check if we need to resume
var startOffset int64 = 0
if resumeOffset > 0 && resumeOffset < totalSize {
startOffset = resumeOffset
if err := c.sendCommand("REST %d", startOffset); err != nil {
return err
}
code, _, err := c.readResponse()
if err != nil {
return fmt.Errorf("rest command failed: %w", err)
}
if code != 350 {
return fmt.Errorf("rest command failed with code: %d", code)
}
} else if resumeOffset >= totalSize {
// File already complete
return nil
}
// Open local file for writing
mode := os.O_CREATE | os.O_WRONLY
if startOffset > 0 {
mode |= os.O_APPEND
} else {
mode |= os.O_TRUNC
}
localFile, err := os.OpenFile(localPath, mode, 0644)
if err != nil {
return fmt.Errorf("failed to open local file: %w", err)
}
defer localFile.Close()
// Seek to start position if resuming
if startOffset > 0 {
if _, err := localFile.Seek(startOffset, io.SeekStart); err != nil {
return fmt.Errorf("failed to seek: %w", err)
}
}
// Establish data connection FIRST (before RETR command)
dataConn, err := c.establishDataConnection()
if err != nil {
return fmt.Errorf("failed to establish data connection: %w", err)
}
defer dataConn.Close()
// Send RETR command AFTER data connection is established
if err := c.sendCommand("RETR %s", remotePath); err != nil {
return err
}
// Read response (should be 150 or 125)
code, _, err := c.readResponse()
if err != nil {
return fmt.Errorf("retr command failed: %w", err)
}
if code != 150 && code != 125 {
// Try waiting a bit for the server to respond
time.Sleep(100 * time.Millisecond)
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("retr command failed with code: %d", code)
}
if code != 150 && code != 125 {
return fmt.Errorf("retr command failed with code: %d", code)
}
}
// Copy data with progress. Polls ctx between reads so a SIGINT
// arriving mid-transfer is detected on the next iteration and the
// partial progress is saved to ResumeMetadata before returning.
var copied int64 = startOffset
buf := make([]byte, 32*1024)
for {
if ctx.Err() != nil {
if err := saveFTPResume(c.url, localPath, copied, totalSize); err != nil {
return fmt.Errorf("failed to save resume metadata: %w", err)
}
return ctx.Err()
}
n, err := dataConn.Read(buf)
if n > 0 {
written, werr := localFile.Write(buf[:n])
copied += int64(written)
if werr != nil {
return fmt.Errorf("failed to write: %w", err)
}
if progressFunc != nil {
progressFunc(copied, totalSize)
}
}
if err == io.EOF {
break
}
if err != nil {
return fmt.Errorf("failed to read from data connection: %w", err)
}
}
// Read final response
code, _, err = c.readResponse()
if err != nil {
return fmt.Errorf("failed to read final response: %w", err)
}
if code != 226 && code != 250 {
return fmt.Errorf("transfer failed with code: %d", code)
}
// Successful transfer — drop any stale resume sidecar.
_ = output.DeleteResumeMetadata(localPath)
return nil
}
func (c *Client) ListRemoteDir(path string) ([]string, error) {
// Establish data connection
dataConn, err := c.establishDataConnection()
if err != nil {
return nil, fmt.Errorf("failed to establish data connection: %w", err)
}
defer dataConn.Close()
// Send LIST command
cmd := "LIST"
if path != "" {
cmd = fmt.Sprintf("LIST %s", path)
}
if err := c.sendCommand("%s", cmd); err != nil {
return nil, err
}
// Read response (should be 150 or 125)
code, _, err := c.readResponse()
if err != nil {
return nil, fmt.Errorf("list command failed: %w", err)
}
if code != 150 && code != 125 {
return nil, fmt.Errorf("list command failed with code: %d", code)
}
// Read directory listing
var lines []string
scanner := bufio.NewScanner(dataConn)
for scanner.Scan() {
lines = append(lines, scanner.Text())
}
if err := scanner.Err(); err != nil {
return nil, fmt.Errorf("failed to read directory listing: %w", err)
}
// Read final response
code, _, err = c.readResponse()
if err != nil {
return nil, fmt.Errorf("failed to read final response: %w", err)
}
if code != 226 && code != 250 {
return nil, fmt.Errorf("list command failed with code: %d", code)
}
return lines, nil
}
func (c *Client) ChangeDir(path string) error {
if err := c.sendCommand("CWD %s", path); err != nil {
return err
}
code, _, err := c.readResponse()
if err != nil {
return fmt.Errorf("cwd command failed: %w", err)
}
if code != 250 {
return fmt.Errorf("cwd command failed with code: %d", code)
}
return nil
}
func (c *Client) GetCurrentDir() (string, error) {
if err := c.sendCommand("PWD"); err != nil {
return "", err
}
code, msg, err := c.readResponse()
if err != nil {
return "", fmt.Errorf("pwd command failed: %w", err)
}
if code != 257 {
return "", fmt.Errorf("pwd command failed with code: %d", code)
}
// Extract path from response (usually quoted)
start := strings.Index(msg, "\"")
end := strings.LastIndex(msg, "\"")
if start != -1 && end > start {
return msg[start+1 : end], nil
}
return strings.TrimSpace(msg), nil
}
func (c *Client) Close() error {
if err := c.sendCommand("QUIT"); err != nil {
return err
}
_, _, _ = c.readResponse() // Ignore errors on close
if c.conn != nil {
return c.conn.Close()
}
return nil
}
// Helper function to download entire directory recursively
func (c *Client) DownloadDirectory(ctx context.Context, remotePath, localPath string, progressFunc func(file string, current, total int64)) error {
// Create local directory
if err := os.MkdirAll(localPath, 0755); err != nil {
return fmt.Errorf("failed to create local directory: %w", err)
}
// Save current directory
origDir, err := c.GetCurrentDir()
if err != nil {
return err
}
defer func() {
c.ChangeDir(origDir)
}()
// Change to remote directory
if err := c.ChangeDir(remotePath); err != nil {
return err
}
// List directory contents
entries, err := c.ListRemoteDir("")
if err != nil {
return err
}
// Parse entries and download files
for _, entry := range entries {
fields := strings.Fields(entry)
if len(fields) < 9 {
continue
}
name := fields[len(fields)-1]
if name == "." || name == ".." {
continue
}
isDir := fields[0][0] == 'd'
remoteFilePath := filepath.Join(remotePath, name)
localFilePath := filepath.Join(localPath, name)
if isDir {
if err := c.DownloadDirectory(ctx, remoteFilePath, localFilePath, progressFunc); err != nil {
return err
}
} else {
if progressFunc != nil {
progressFunc(name, 0, 0)
}
if err := c.DownloadFile(ctx, remoteFilePath, localFilePath, 0, nil); err != nil {
return err
}
}
}
return nil
}
// saveFTPResume persists partial FTP download progress to the standard
// `.goget.meta` sidecar so a subsequent `goget --resume` can continue
// from `downloaded` bytes. Errors are wrapped to surface failures
// without aborting the cancellation handling.
func saveFTPResume(url, localPath string, downloaded, total int64) error {
if localPath == "" || localPath == "-" || downloaded <= 0 {
return nil
}
meta := output.NewResumeMetadata(url, "", "", downloaded, total)
return meta.Save(localPath)
}
// clientPool holds N pre-connected FTP clients. A single shared pool
// removes the need to open/close connections for every file in a
// recursive download, and is required for the parallel recursive
// implementation because each *Client owns its own TCP control
// connection and is not safe for concurrent use.
type clientPool struct {
available chan *Client
all []*Client
}
// newClientPool opens `size` independent FTP connections to the same
// server. Connections are kept open until close() is called.
func newClientPool(rawURL string, timeout time.Duration, size int) (*clientPool, error) {
if size < 1 {
size = 1
}
all := make([]*Client, 0, size)
avail := make(chan *Client, size)
for i := 0; i < size; i++ {
c, err := NewClient(rawURL, timeout)
if err != nil {
for _, existing := range all {
_ = existing.Close()
}
return nil, err
}
if err := c.Connect(); err != nil {
for _, existing := range all {
_ = existing.Close()
}
return nil, err
}
all = append(all, c)
avail <- c
}
return &clientPool{available: avail, all: all}, nil
}
// acquire blocks until a client is available, then returns it. The
// caller must call release() when done.
func (p *clientPool) acquire() *Client {
return <-p.available
}
// release returns a client to the pool. It must be called exactly once
// per acquire().
func (p *clientPool) release(c *Client) {
p.available <- c
}
// size returns the number of clients in the pool.
func (p *clientPool) size() int {
return len(p.all)
}
// close shuts down every client in the pool. The pool must not be used
// after this call.
func (p *clientPool) close() {
for _, c := range p.all {
_ = c.Close()
}
}
// DownloadDirectoryConcurrent downloads a remote directory to localPath
// using a pool of N FTP connections. All operations (LIST, RETR) use
// absolute paths so concurrent workers never share or mutate CWD state
// on the server side. The returned error is the first error encountered
// by any worker; other workers continue in the background until they
// hit ctx cancellation or finish their tasks.
func DownloadDirectoryConcurrent(ctx context.Context, rawURL string, timeout time.Duration, remotePath, localPath string, parallel int, progressFunc func(file string, current, total int64)) error {
if parallel < 1 {
parallel = 1
}
pool, err := newClientPool(rawURL, timeout, parallel)
if err != nil {
return err
}
defer pool.close()
sem := make(chan struct{}, parallel)
var wg sync.WaitGroup
var firstErr error
var errMu sync.Mutex
setErr := func(err error) {
errMu.Lock()
if firstErr == nil {
firstErr = err
}
errMu.Unlock()
}
processEntry(ctx, pool, sem, &wg, setErr, remotePath, localPath, progressFunc)
wg.Wait()
return firstErr
}
// processEntry processes one remote path: lists it, then dispatches
// its child entries (file → download, subdir → recursive processEntry)
// through the shared semaphore-bounded goroutine pool. A single
// sem is threaded through the recursion so the total in-flight
// goroutines never exceed `parallel`, regardless of directory depth.
func processEntry(ctx context.Context, pool *clientPool, sem chan struct{}, wg *sync.WaitGroup, setErr func(error), remotePath, localPath string, progressFunc func(file string, current, total int64)) {
defer wg.Done()
defer func() { <-sem }()
if ctx.Err() != nil {
return
}
if err := os.MkdirAll(localPath, 0755); err != nil {
setErr(fmt.Errorf("failed to create local dir %s: %w", localPath, err))
return
}
c := pool.acquire()
entries, err := c.ListRemoteDir(remotePath)
pool.release(c)
if err != nil {
setErr(fmt.Errorf("list %s: %w", remotePath, err))
return
}
for _, entry := range entries {
fields := strings.Fields(entry)
if len(fields) < 9 {
continue
}
name := fields[len(fields)-1]
if name == "." || name == ".." {
continue
}
isDir := fields[0][0] == 'd'
remoteFilePath := filepath.Join(remotePath, name)
localFilePath := filepath.Join(localPath, name)
if isDir {
wg.Add(1)
select {
case sem <- struct{}{}:
go processEntry(ctx, pool, sem, wg, setErr, remoteFilePath, localFilePath, progressFunc)
case <-ctx.Done():
return
}
} else {
wg.Add(1)
select {
case sem <- struct{}{}:
go func(remoteFilePath, localFilePath, name string) {
defer wg.Done()
defer func() { <-sem }()
if ctx.Err() != nil {
return
}
c := pool.acquire()
defer pool.release(c)
if progressFunc != nil {
progressFunc(name, 0, 0)
}
// DownloadFile's progress callback has a different
// signature than our directory-level progressFunc, so
// we wrap it here to keep the existing per-file
// progress behaviour.
var fileProgress func(current, total int64)
if progressFunc != nil {
fileProgress = func(current, total int64) {
progressFunc(name, current, total)
}
}
if err := c.DownloadFile(ctx, remoteFilePath, localFilePath, 0, fileProgress); err != nil {
setErr(fmt.Errorf("download %s: %w", remoteFilePath, err))
}
}(remoteFilePath, localFilePath, name)
case <-ctx.Done():
return
}
}
}
}
+382
View File
@@ -0,0 +1,382 @@
//go:build linux || freebsd
// +build linux freebsd
package ftp
import (
"errors"
"net/url"
"strings"
"testing"
"time"
)
// ---------- Protocol tests ----------
func TestNewProtocol(t *testing.T) {
p := NewProtocol()
if p == nil {
t.Fatal("NewProtocol() returned nil")
}
}
func TestScheme(t *testing.T) {
p := &Protocol{}
if got := p.Scheme(); got != "ftp" {
t.Errorf("Scheme() = %q, want %q", got, "ftp")
}
}
func TestCanHandle(t *testing.T) {
tests := []struct {
name string
raw string
want bool
}{
{"ftp scheme", "ftp://ftp.example.com/file.txt", true},
{"ftps scheme", "ftps://ftp.example.com/file.txt", true},
{"http scheme", "http://example.com/file.txt", false},
{"https scheme", "https://example.com/file.txt", false},
{"sftp scheme", "sftp://example.com/file.txt", false},
{"empty scheme", "file.txt", false},
{"nil URL", "", false},
}
p := &Protocol{}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var u *url.URL
if tt.raw != "" {
var err error
u, err = url.Parse(tt.raw)
if err != nil {
t.Fatalf("failed to parse URL %q: %v", tt.raw, err)
}
}
if got := p.CanHandle(u); got != tt.want {
t.Errorf("CanHandle(%q) = %v, want %v", tt.raw, got, tt.want)
}
})
}
}
func TestCanHandleCaseInsensitive(t *testing.T) {
p := &Protocol{}
u, _ := url.Parse("FTP://example.com/file.txt")
if !p.CanHandle(u) {
t.Errorf("CanHandle should be case-insensitive for FTP")
}
u, _ = url.Parse("FTPS://example.com/file.txt")
if !p.CanHandle(u) {
t.Errorf("CanHandle should be case-insensitive for FTPS")
}
}
func TestCapabilities(t *testing.T) {
p := &Protocol{}
caps := p.Capabilities()
if caps == nil {
t.Fatal("Capabilities() returned nil")
}
expected := map[string]bool{
"download": true,
"resume": true,
"recursive": true,
"tls": true,
}
if len(caps) != len(expected) {
t.Errorf("Capabilities() length = %d, want %d", len(caps), len(expected))
}
for _, cap := range caps {
if !expected[cap] {
t.Errorf("unexpected capability: %q", cap)
}
}
}
func TestSupportsResume(t *testing.T) {
p := &Protocol{}
if !p.SupportsResume() {
t.Errorf("SupportsResume() should return true")
}
}
func TestSupportsCompression(t *testing.T) {
p := &Protocol{}
if p.SupportsCompression() {
t.Errorf("SupportsCompression() should return false")
}
}
func TestSupportsParallel(t *testing.T) {
p := &Protocol{}
if p.SupportsParallel() {
t.Errorf("SupportsParallel() should return false")
}
}
func TestSupportsRecursive(t *testing.T) {
p := &Protocol{}
if !p.SupportsRecursive() {
t.Errorf("SupportsRecursive() should return true")
}
}
func TestReadAll(t *testing.T) {
t.Run("normal content", func(t *testing.T) {
input := "Hello, FTP world!"
r := strings.NewReader(input)
data, err := readAll(r)
if err != nil {
t.Fatalf("readAll() returned error: %v", err)
}
if string(data) != input {
t.Errorf("readAll() = %q, want %q", string(data), input)
}
})
t.Run("empty reader", func(t *testing.T) {
r := strings.NewReader("")
data, err := readAll(r)
if err != nil {
t.Fatalf("readAll() returned error: %v", err)
}
if len(data) != 0 {
t.Errorf("readAll() returned %d bytes, want 0", len(data))
}
})
t.Run("large content", func(t *testing.T) {
// Create content larger than the 32KB buffer to ensure multiple reads
content := strings.Repeat("A", 100*1024)
r := strings.NewReader(content)
data, err := readAll(r)
if err != nil {
t.Fatalf("readAll() returned error: %v", err)
}
if len(data) != len(content) {
t.Errorf("readAll() returned %d bytes, want %d", len(data), len(content))
}
})
t.Run("reader error", func(t *testing.T) {
expectedErr := errors.New("read error")
r := &errorReader{err: expectedErr}
_, err := readAll(r)
if err == nil {
t.Fatal("readAll() should return error")
}
if !strings.Contains(err.Error(), expectedErr.Error()) {
t.Errorf("readAll() error = %v, want %v", err, expectedErr)
}
})
}
// errorReader implements io.Reader that always returns an error
type errorReader struct {
err error
}
func (r *errorReader) Read(p []byte) (n int, err error) {
return 0, r.err
}
// ---------- Client tests ----------
func TestNewClient(t *testing.T) {
tests := []struct {
name string
rawURL string
wantErr bool
}{
{"basic FTP URL", "ftp://ftp.example.com/pub/file.txt", false},
{"FTP URL with path", "ftp://ftp.example.com/pub/", false},
{"FTP URL root", "ftp://ftp.example.com", false},
{"FTP URL with trailing slash", "ftp://ftp.example.com/", false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
client, err := NewClient(tt.rawURL, 30*time.Second)
if tt.wantErr {
if err == nil {
t.Errorf("NewClient(%q) expected error", tt.rawURL)
}
return
}
if err != nil {
t.Fatalf("NewClient(%q) returned error: %v", tt.rawURL, err)
}
if client == nil {
t.Fatal("NewClient() returned nil")
}
})
}
}
func TestNewClientWithAuth(t *testing.T) {
client, err := NewClient("ftp://user:password@ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.user != "user" {
t.Errorf("client.user = %q, want %q", client.user, "user")
}
if client.password != "password" {
t.Errorf("client.password = %q, want %q", client.password, "password")
}
}
func TestNewClientWithUserOnly(t *testing.T) {
client, err := NewClient("ftp://user@ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.user != "user" {
t.Errorf("client.user = %q, want %q", client.user, "user")
}
if client.password != "anonymous@" {
t.Errorf("client.password should default to %q when only username is provided, got %q", "anonymous@", client.password)
}
}
func TestNewClientFTPS(t *testing.T) {
client, err := NewClient("ftps://ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if !client.useTLS {
t.Errorf("client.useTLS should be true for ftps:// scheme")
}
}
func TestNewClientFTPSWithAuth(t *testing.T) {
client, err := NewClient("ftps://alice:secret@ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if !client.useTLS {
t.Errorf("client.useTLS should be true for ftps:// scheme")
}
if client.user != "alice" {
t.Errorf("client.user = %q, want %q", client.user, "alice")
}
if client.password != "secret" {
t.Errorf("client.password = %q, want %q", client.password, "secret")
}
}
func TestNewClientInvalidURL(t *testing.T) {
// Only inputs where url.Parse itself fails
_, err := NewClient("://invalid", 30*time.Second)
if err == nil {
t.Errorf("NewClient(%q) expected error", "://invalid")
}
}
func TestNewClientEmptyURL(t *testing.T) {
client, err := NewClient("", 30*time.Second)
if err != nil {
t.Fatalf("NewClient(\"\") returned error: %v", err)
}
// url.Parse("") returns an empty URL struct, so host will be empty
if client.host != "" {
t.Errorf("client.host = %q, want empty", client.host)
}
if client.port != 21 {
t.Errorf("client.port = %d, want %d", client.port, 21)
}
}
func TestNewClientNoScheme(t *testing.T) {
client, err := NewClient("not-a-url", 30*time.Second)
if err != nil {
t.Fatalf("NewClient(\"not-a-url\") returned error: %v", err)
}
// url.Parse("not-a-url") parses it as a path with empty host
if client.host != "" {
t.Errorf("client.host = %q, want empty", client.host)
}
if client.port != 21 {
t.Errorf("client.port = %d, want %d", client.port, 21)
}
}
func TestNewClientDefaultPort(t *testing.T) {
client, err := NewClient("ftp://ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.port != 21 {
t.Errorf("client.port = %d, want %d", client.port, 21)
}
}
func TestNewClientCustomPort(t *testing.T) {
client, err := NewClient("ftp://ftp.example.com:2121/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.port != 2121 {
t.Errorf("client.port = %d, want %d", client.port, 2121)
}
}
func TestNewClientInvalidPort(t *testing.T) {
_, err := NewClient("ftp://ftp.example.com:invalid/file.txt", 30*time.Second)
if err == nil {
t.Errorf("NewClient() expected error for invalid port")
}
}
func TestNewClientDefaultCredentials(t *testing.T) {
client, err := NewClient("ftp://ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.user != "anonymous" {
t.Errorf("default user = %q, want %q", client.user, "anonymous")
}
if client.password != "anonymous@" {
t.Errorf("default password = %q, want %q", client.password, "anonymous@")
}
}
func TestNewClientHostParsing(t *testing.T) {
client, err := NewClient("ftp://ftp.example.com/path/to/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.host != "ftp.example.com" {
t.Errorf("client.host = %q, want %q", client.host, "ftp.example.com")
}
}
func TestNewClientPassiveModeDefault(t *testing.T) {
client, err := NewClient("ftp://ftp.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if !client.passive {
t.Errorf("client.passive should default to true")
}
}
func TestNewClientTLSConfig(t *testing.T) {
client, err := NewClient("ftps://secure.example.com/file.txt", 30*time.Second)
if err != nil {
t.Fatalf("NewClient() returned error: %v", err)
}
if client.tlsConfig == nil {
t.Fatal("client.tlsConfig should not be nil")
}
if client.tlsConfig.ServerName != "secure.example.com" {
t.Errorf("tlsConfig.ServerName = %q, want %q", client.tlsConfig.ServerName, "secure.example.com")
}
if client.tlsConfig.InsecureSkipVerify {
t.Errorf("tlsConfig.InsecureSkipVerify should be false by default")
}
}
+220
View File
@@ -0,0 +1,220 @@
//go:build linux || freebsd
// +build linux freebsd
package ftp
import (
"context"
"fmt"
"io"
"net/url"
"os"
"path/filepath"
"strings"
"time"
"codeberg.org/petrbalvin/goget/internal/core"
"codeberg.org/petrbalvin/goget/internal/output"
)
// Protocol implements the core.Protocol interface for FTP/FTPS
type Protocol struct{}
// NewProtocol creates a new instance of FTP protocol
func NewProtocol() *Protocol {
return &Protocol{}
}
// Scheme returns the protocol scheme
func (p *Protocol) Scheme() string {
return "ftp"
}
// CanHandle checks whether the protocol can handle the given URL
func (p *Protocol) CanHandle(u *url.URL) bool {
if u == nil {
return false
}
scheme := strings.ToLower(u.Scheme)
return scheme == "ftp" || scheme == "ftps"
}
// Capabilities returns the list of supported features
func (p *Protocol) Capabilities() []string {
return []string{
"download",
"resume",
"recursive",
"tls",
}
}
// SupportsResume returns whether the protocol supports resume
func (p *Protocol) SupportsResume() bool {
return true
}
// SupportsCompression returns whether the protocol supports compression
func (p *Protocol) SupportsCompression() bool {
return false
}
// SupportsParallel returns whether the protocol supports parallel downloading
func (p *Protocol) SupportsParallel() bool {
return false
}
// SupportsRecursive returns whether the protocol supports recursive downloading
func (p *Protocol) SupportsRecursive() bool {
return true
}
// Download downloads a file or directory via FTP/FTPS
func (p *Protocol) Download(ctx context.Context, req *core.DownloadRequest) (*core.DownloadResult, error) {
timeout := req.Timeout
if timeout <= 0 {
timeout = 30 * time.Second
}
client, err := NewClient(req.URL.String(), timeout)
if err != nil {
return nil, core.NewProtocolError(fmt.Sprintf("failed to create FTP client: %v", err), nil, core.SafeURL(req.URL))
}
if err := client.Connect(); err != nil {
return nil, core.NewProtocolError(fmt.Sprintf("failed to connect: %v", err), nil, core.SafeURL(req.URL))
}
defer client.Close()
startTime := time.Now()
var bytesDownloaded int64 = 0
var chunksCount int
// Determine whether it is a file or directory
remotePath := req.URL.Path
if remotePath == "" {
remotePath = "/"
}
// Try to get file size - if it fails, it's probably a directory
fileSize, err := client.getFileSize(remotePath)
isFile := (err == nil)
if isFile {
// Downloading file
var outputFile string
if req.Output != "" {
outputFile = req.Output
} else {
outputFile = filepath.Base(remotePath)
if outputFile == "" || outputFile == "/" {
outputFile = "index.html"
}
}
// Kontrola resume
var resumeOffset int64 = 0
if req.Resume && req.Output != "" {
if canResume, meta, _ := output.CanResume(req.Output, req.URL.String()); canResume && meta != nil {
resumeOffset = meta.Downloaded
if req.Verbose {
fmt.Fprintf(os.Stderr, "Resuming from offset %d\n", resumeOffset)
}
}
}
// Progress callback
var progressCallback func(current, total int64)
if req.ProgressCallback != nil && fileSize > 0 {
totalSize := fileSize
startOffset := resumeOffset
progressCallback = func(current, _ int64) {
req.ProgressCallback(startOffset+current, totalSize, 0)
}
}
if err := client.DownloadFile(ctx, remotePath, outputFile, resumeOffset, progressCallback); err != nil {
return nil, core.NewProtocolError(fmt.Sprintf("download failed: %v", err), nil, core.SafeURL(req.URL))
}
// Get the actual size of the downloaded file
if info, err := os.Stat(outputFile); err == nil {
bytesDownloaded = info.Size()
}
chunksCount = 1
} else {
// Recursive download of directory
if !req.Recursive {
return nil, core.NewProtocolError("remote path is a directory, use --recursive to download", nil, core.SafeURL(req.URL))
}
outputDir := req.Output
if outputDir == "" {
outputDir = filepath.Base(remotePath)
if outputDir == "" || outputDir == "/" {
outputDir = "download"
}
}
var progressCallback func(file string, current, total int64)
if req.Verbose {
progressCallback = func(file string, current, total int64) {
fmt.Fprintf(os.Stderr, "Downloading: %s\n", file)
}
}
// Dispatch to the parallel implementation when the user
// requested worker-pool concurrency, otherwise fall back to the
// single-connection sequential implementation. The parallel path
// opens N control connections to avoid stepping on CWD state and
// to keep the existing client-side protocol serialisation.
if req.RecursiveParallel > 1 {
if err := DownloadDirectoryConcurrent(ctx, req.URL.String(), timeout, remotePath, outputDir, req.RecursiveParallel, progressCallback); err != nil {
return nil, core.NewProtocolError(fmt.Sprintf("directory download failed: %v", err), nil, core.SafeURL(req.URL))
}
} else {
if err := client.DownloadDirectory(ctx, remotePath, outputDir, progressCallback); err != nil {
return nil, core.NewProtocolError(fmt.Sprintf("directory download failed: %v", err), nil, core.SafeURL(req.URL))
}
}
// Calculate total size and file count
filepath.Walk(outputDir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if !info.IsDir() {
bytesDownloaded += info.Size()
chunksCount++
}
return nil
})
}
duration := time.Since(startTime)
return &core.DownloadResult{
BytesDownloaded: bytesDownloaded,
Duration: duration,
ChunksCount: chunksCount,
}, nil
}
// Helper function for reading from io.Reader
func readAll(reader io.Reader) ([]byte, error) {
var data []byte
buf := make([]byte, 32*1024)
for {
n, err := reader.Read(buf)
if n > 0 {
data = append(data, buf[:n]...)
}
if err == io.EOF {
break
}
if err != nil {
return nil, err
}
}
return data, nil
}
+62
View File
@@ -0,0 +1,62 @@
//go:build linux || freebsd
// +build linux freebsd
package ftp
import (
"os"
"path/filepath"
"testing"
"codeberg.org/petrbalvin/goget/internal/output"
)
// TestSaveFTPResume verifies the helper persists partial FTP progress
// to a .goget.meta sidecar and that the sidecar is suitable for a
// subsequent goget --resume invocation. The function is called from
// Client.DownloadFile when ctx is cancelled mid-transfer; without a
// working sidecar the user's interrupted download cannot be continued.
func TestSaveFTPResume(t *testing.T) {
tmp := t.TempDir()
out := filepath.Join(tmp, "file.bin")
// 1. First call records partial progress.
if err := saveFTPResume("ftp://example.com/file.bin", out, 4096, 1<<20); err != nil {
t.Fatalf("saveFTPResume: %v", err)
}
meta, err := output.LoadResumeMetadata(out)
if err != nil {
t.Fatalf("LoadResumeMetadata: %v", err)
}
if meta == nil {
t.Fatal("expected resume metadata, got nil")
}
if meta.URL != "ftp://example.com/file.bin" {
t.Errorf("URL = %q, want ftp://example.com/file.bin", meta.URL)
}
if meta.Downloaded != 4096 {
t.Errorf("Downloaded = %d, want 4096", meta.Downloaded)
}
if meta.Total != 1<<20 {
t.Errorf("Total = %d, want %d", meta.Total, 1<<20)
}
// 2. Second call overwrites the sidecar with a later snapshot.
if err := saveFTPResume("ftp://example.com/file.bin", out, 8192, 1<<20); err != nil {
t.Fatalf("saveFTPResume (2): %v", err)
}
meta2, _ := output.LoadResumeMetadata(out)
if meta2 == nil || meta2.Downloaded != 8192 {
t.Errorf("second call did not update sidecar: %+v", meta2)
}
// 3. Zero-byte save is a no-op (no point persisting a sidecar
// for an empty transfer).
out2 := filepath.Join(tmp, "empty.bin")
if err := saveFTPResume("ftp://x", out2, 0, 100); err != nil {
t.Errorf("zero-byte save returned error: %v", err)
}
if _, err := os.Stat(out2 + output.ResumeMetaFileSuffix); !os.IsNotExist(err) {
t.Errorf("expected no sidecar for zero-byte save, got one")
}
}