gnu: Properly credit Konrad Hinsen.
[jackhill/guix/guix.git] / guix / ftp-client.scm
index ba3201f..8d5adcb 100644 (file)
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2010, 2011, 2012, 2013 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -22,7 +22,7 @@
   #:use-module (srfi srfi-11)
   #:use-module (srfi srfi-26)
   #:use-module (srfi srfi-31)
-  #:use-module (rnrs io ports)
+  #:use-module (ice-9 binary-ports)
   #:use-module (rnrs bytevectors)
   #:use-module (ice-9 match)
   #:use-module (ice-9 regex)
@@ -30,6 +30,7 @@
   #:export (ftp-connection?
             ftp-connection-addrinfo
 
+            connect*
             ftp-open
             ftp-close
             ftp-chdir
@@ -73,7 +74,8 @@
         (throw 'ftp-error port command code message))))
 
 (define (%ftp-login user pass port)
-  (let ((command (string-append "USER " user (string #\newline))))
+  (let ((command (string-append "USER " user
+                                (string #\return) (string #\newline))))
     (display command port)
     (let-values (((code message) (%ftp-listen port)))
       (case code
         ((331) (%ftp-command (string-append "PASS " pass) 230 port))
         (else  (throw 'ftp-error port command code message))))))
 
-(define* (ftp-open host #:optional (port 21))
-  "Open an FTP connection to HOST on PORT (a service-identifying string,
-or a TCP port number), and return it."
-  ;; Use 21 as the default PORT instead of "ftp", to avoid depending on
-  ;; libc's NSS, which is not available during bootstrap.
-
-  (catch 'getaddrinfo-error
+(define-syntax-rule (catch-EINPROGRESS body ...)
+  (catch 'system-error
     (lambda ()
-      (define addresses
-        (getaddrinfo host
-                     (if (number? port) (number->string port) port)
-                     (if (number? port) AI_NUMERICSERV 0)))
-
-      (let loop ((addresses addresses))
-        (let* ((ai (car addresses))
-               (s  (socket (addrinfo:fam ai) (addrinfo:socktype ai)
-                           (addrinfo:protocol ai))))
-
-          (catch 'system-error
-            (lambda ()
-              (connect s (addrinfo:addr ai))
-              (setvbuf s _IOLBF)
-              (let-values (((code message) (%ftp-listen s)))
-                (if (eqv? code 220)
-                    (begin
-                      ;;(%ftp-command "OPTS UTF8 ON" 200 s)
-                      (%ftp-login "anonymous" "guix@example.com" s)
-                      (%make-ftp-connection s ai))
-                    (begin
-                      (format (current-error-port)
-                              "FTP to `~a' failed: ~A: ~A~%"
-                              host code message)
-                      (close s)
-                      #f))))
-
-            (lambda args
-              ;; Connection failed, so try one of the other addresses.
-              (close s)
-              (if (null? addresses)
-                  (apply throw args)
-                  (loop (cdr addresses))))))))
-    (lambda (key errcode)
-      (format (current-error-port) "failed to resolve `~a': ~a~%"
-              host (gai-strerror errcode))
-      #f)))
+      body ...)
+    (lambda args
+      (unless (= (system-error-errno args) EINPROGRESS)
+        (apply throw args)))))
+
+;; XXX: For lack of a better place.
+(define* (connect* s sockaddr #:optional timeout)
+  "When TIMEOUT is omitted or #f, this procedure is equivalent to 'connect'.
+When TIMEOUT is a number, it is the (possibly inexact) maximum number of
+seconds to wait for the connection to succeed."
+  (define (raise-error errno)
+    (throw 'system-error 'connect* "~A"
+           (list (strerror errno))
+           (list errno)))
+
+  (if timeout
+      (let ((flags (fcntl s F_GETFL)))
+        (fcntl s F_SETFL (logior flags O_NONBLOCK))
+        (catch-EINPROGRESS (connect s sockaddr))
+        (match (select '() (list s) (list s) timeout)
+          ((() () ())
+           ;; Time is up!
+           (raise-error ETIMEDOUT))
+          ((() (write) ())
+           ;; Check for ECONNREFUSED and the likes.
+           (fcntl s F_SETFL flags)
+           (let ((errno (getsockopt s SOL_SOCKET SO_ERROR)))
+             (unless (zero? errno)
+               (raise-error errno))))
+          ((() () (except))
+           ;; Seems like this cannot really happen, but who knows.
+           (let ((errno (getsockopt s SOL_SOCKET SO_ERROR)))
+             (raise-error errno)))))
+      (connect s sockaddr)))
+
+(define* (ftp-open host #:optional (port "ftp")
+                        #:key timeout
+                              (username "anonymous")
+                              (password "guix@example.com"))
+  "Open an FTP connection to HOST on PORT (a service-identifying string,
+or a TCP port number), and return it.
+
+When TIMEOUT is not #f, it must be a (possibly inexact) number denoting the
+maximum duration in seconds to wait for the connection to complete; passed
+TIMEOUT, an ETIMEDOUT error is raised."
+  ;; Using "ftp" for PORT instead of 21 allows 'getaddrinfo' to return only
+  ;; TCP/IP addresses (otherwise it would return SOCK_DGRAM and SOCK_RAW
+  ;; addresses as well.)  With our bootstrap Guile, which includes a
+  ;; statically-linked NSS, resolving "ftp" works well, as long as
+  ;; /etc/services is available.
+
+  (define addresses
+    (getaddrinfo host
+                 (if (number? port) (number->string port) port)
+                 (if (number? port)
+                     (logior AI_ADDRCONFIG AI_NUMERICSERV)
+                     AI_ADDRCONFIG)))
+
+  (let loop ((addresses addresses))
+    (match addresses
+      ((ai rest ...)
+       (let ((s (socket (addrinfo:fam ai)
+                        ;; TCP/IP only
+                        SOCK_STREAM IPPROTO_IP)))
+
+         (catch 'system-error
+           (lambda ()
+             (connect* s (addrinfo:addr ai) timeout)
+             (setvbuf s 'line)
+             (let-values (((code message) (%ftp-listen s)))
+               (if (eqv? code 220)
+                   (begin
+                     ;;(%ftp-command "OPTS UTF8 ON" 200 s)
+                     (%ftp-login username password s)
+                     (%make-ftp-connection s ai))
+                   (begin
+                     (close s)
+                     (throw 'ftp-error s "log-in" code message)))))
+
+           (lambda args
+             ;; Connection failed, so try one of the other addresses.
+             (close s)
+             (if (null? rest)
+                 (apply throw args)
+                 (loop rest)))))))))
 
 (define (ftp-close conn)
   (close (ftp-connection-socket conn)))
@@ -149,6 +194,11 @@ or a TCP port number), and return it."
 
 (define (ftp-size conn file)
   "Return the size in bytes of FILE."
+
+  ;; Ask for "binary mode", otherwise some servers, such as sourceware.org,
+  ;; fail with 550 ("SIZE not allowed in ASCII mode").
+  (%ftp-command "TYPE I" 200 (ftp-connection-socket conn))
+
   (let ((message (%ftp-command (string-append "SIZE " file) 213
                                (ftp-connection-socket conn))))
     (string->number (string-trim-both message))))
@@ -178,7 +228,7 @@ or a TCP port number), and return it."
                                 (sockaddr:scopeid sa)))
           (else #f))))
 
-(define* (ftp-list conn #:optional directory)
+(define* (ftp-list conn #:optional directory #:key timeout)
   (if directory
       (ftp-chdir conn directory))
 
@@ -186,8 +236,8 @@ or a TCP port number), and return it."
          (ai   (ftp-connection-addrinfo conn))
          (s    (socket (addrinfo:fam ai) (addrinfo:socktype ai)
                        (addrinfo:protocol ai))))
-    (connect s (address-with-port (addrinfo:addr ai) port))
-    (setvbuf s _IOLBF)
+    (connect* s (address-with-port (addrinfo:addr ai) port) timeout)
+    (setvbuf s 'line)
 
     (dynamic-wind
       (lambda () #t)
@@ -220,7 +270,8 @@ or a TCP port number), and return it."
           (or (eqv? code 226)
               (throw 'ftp-error conn "LIST" code message)))))))
 
-(define* (ftp-retr conn file #:optional directory)
+(define* (ftp-retr conn file #:optional directory
+                   #:key timeout)
   "Retrieve FILE from DIRECTORY (or, if omitted, the current directory) from
 FTP connection CONN.  Return a binary port to that file.  The returned port
 must be closed before CONN can be used for other purposes."
@@ -241,8 +292,8 @@ must be closed before CONN can be used for other purposes."
         (or (eqv? code 226)
             (throw 'ftp-error conn "LIST" code message))))
 
-    (connect s (address-with-port (addrinfo:addr ai) port))
-    (setvbuf s _IOLBF)
+    (connect* s (address-with-port (addrinfo:addr ai) port) timeout)
+    (setvbuf s 'line)
 
     (%ftp-command (string-append "RETR " file)
                   150 (ftp-connection-socket conn))