path: root/guix/scripts/download.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2012, 2013, 2015, 2016, 2017, 2020 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2021 Simon Tournier <zimon.toutoune@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix 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 General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (guix scripts download)
  #:use-module (guix ui)
  #:use-module (guix scripts)
  #:use-module (guix store)
  #:use-module (gcrypt hash)
  #:use-module (guix hash)
  #:use-module (guix base16)
  #:use-module (guix base32)
  #:autoload   (guix base64) (base64-encode)
  #:use-module ((guix download) #:hide (url-fetch))
  #:use-module ((guix git)
                #:select (latest-repository-commit
                          update-cached-checkout
                          with-git-error-handling))
  #:use-module ((guix build download)
                #:select (url-fetch))
  #:use-module (guix build utils)
  #:use-module ((guix progress)
                #:select (current-terminal-columns))
  #:use-module ((guix build syscalls)
                #:select (terminal-columns))
  #:use-module (web uri)
  #:use-module (ice-9 ftw)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-26)
  #:use-module (srfi srfi-37)
  #:export (guix-download))


;;;
;;; Command-line options.
;;;

(define (download-to-file url file)
  "Download the file at URI to FILE.  Return FILE."
  (let ((uri (string->uri url)))
    (match (uri-scheme uri)
      ((or 'file #f)
       (copy-file (uri-path uri) file))
      (_
       (url-fetch url file #:mirrors %mirrors)))
    file))

;; This is a simplified version of 'copy-recursively'.
;; It allows us to filter out the ".git" subfolder.
;; TODO: Remove when 'copy-recursively' supports '#:select?'.
(define (copy-recursively-without-dot-git source destination)
  (define strip-source
    (let ((len (string-length source)))
      (lambda (file)
        (substring file len))))

  (file-system-fold (lambda (file stat result) ; enter?
                      (not (string-suffix? "/.git" file)))
                    (lambda (file stat result) ; leaf
                      (let ((dest (string-append destination
                                                 (strip-source file))))
                        (case (stat:type stat)
                          ((symlink)
                           (let ((target (readlink file)))
                             (symlink target dest)))
                          (else
                           (copy-file file dest)))))
                    (lambda (dir stat result) ; down
                      (let ((target (string-append destination
                                                   (strip-source dir))))
                        (mkdir-p target)))
                    (const #t)          ; up
                    (const #t)          ; skip
                    (lambda (file stat errno result)
                      (format (current-error-port) "i/o error: ~a: ~a~%"
                              file (strerror errno))
                      #f)
                    #t
                    source))

(define (git-download-to-file url file reference recursive?)
  "Download the git repo at URL to file, checked out at REFERENCE.
REFERENCE must be a pair argument as understood by 'latest-repository-commit'.
Return FILE."
  ;; 'libgit2' doesn't support the URL format generated by 'uri->string' so
  ;; we have to do a little fixup. Dropping completely the 'file:' protocol
  ;; part gives better performance.
  (let ((url (cond ((string-prefix? "file://" url)
                     (string-drop url (string-length "file://")))
                    ((string-prefix? "file:" url)
                     (string-drop url (string-length "file:")))
                    (else url))))
    (copy-recursively-without-dot-git
     (with-git-error-handling
      (update-cached-checkout url #:ref reference #:recursive? recursive?))
     file))
  file)

(define (ensure-valid-store-file-name name)
  "Replace any character not allowed in a store name by an underscore."

  (define valid
    ;; according to nix/libstore/store-api.cc
    (string->char-set (string-append "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                                     "abcdefghijklmnopqrstuvwxyz"
                                     "0123456789" "+-._?=")))
  (string-map (lambda (c)
                (if (char-set-contains? valid c) c #\_))
              name))


(define* (download-to-store* url
                             #:key (verify-certificate? #t)
                             #:allow-other-keys)
  (with-store store
    (download-to-store store url
                       (ensure-valid-store-file-name (basename url))
                       #:verify-certificate? verify-certificate?)))

(define* (git-download-to-store* url
                                 reference
                                 recursive?
                                 #:key (verify-certificate? #t))
  "Download the git repository at URL to the store, checked out at REFERENCE.
URL must specify a protocol (i.e https:// or file://), REFERENCE must be a
pair argument as understood by 'latest-repository-commit'."
  ;; Ensure the URL string is properly formatted  when using the 'file'
  ;; protocol: URL is generated using 'uri->string', which returns
  ;; "file:/path/to/file" instead of "file:///path/to/file", which in turn
  ;; makes 'git-download-to-store' fail.
  (let* ((file? (string-prefix? "file:" url))
         (url (if (and file?
                        (not (string-prefix? "file:///" url)))
                   (string-append "file://"
                                  (string-drop url (string-length "file:")))
                   url)))
    (with-store store
      ;; TODO: Verify certificate support and deactivation.
      (with-git-error-handling
       (latest-repository-commit store
                                 url
                                 #:recursive? recursive?
                                 #:ref reference)))))

(define %default-options
  ;; Alist of default option values.
  `((format . ,bytevector->nix-base32-string)
    (hash-algorithm . ,(hash-algorithm sha256))
    (verify-certificate? . #t)
    (git-reference . #f)
    (recursive? . #f)
    (download-proc . ,download-to-store*)))

(define (show-help)
  (display (G_ "Usage: guix download [OPTION] URL
Download the file at URL to the store or to the given file, and print its
file name and the hash of its contents.\n"))
  (newline)
  (display (G_ "\
Supported formats: 'base64', 'nix-base32' (default), 'base32',
and 'base16' ('hex' and 'hexadecimal' can be used as well).\n"))
  (format #t (G_ "
  -f, --format=FMT       write the hash in the given format"))
  (format #t (G_ "
  -H, --hash=ALGORITHM   use the given hash ALGORITHM"))
  (format #t (G_ "
      --no-check-certificate
                         do not validate the certificate of HTTPS servers "))
  (format #t (G_ "
  -o, --output=FILE      download to FILE"))
  (format #t (G_ "
  -g, --git              download the default branch's latest commit of the
                         Git repository at URL"))
  (format #t (G_ "
      --commit=COMMIT-OR-TAG
                         download the given commit or tag of the Git
                         repository at URL"))
  (format #t (G_ "
      --branch=BRANCH    download the given branch of the Git repository
                         at URL"))
  (format #t (G_ "
  -r, --recursive        download a Git repository recursively"))

  (newline)
  (display (G_ "
  -h, --help             display this help and exit"))
  (display (G_ "
  -V, --version          display version information and exit"))
  (newline)
  (show-bug-report-information))

(define (add-git-download-option result)
  (alist-cons 'download-proc
              ;; XXX: #:verify-certificate? currently ignored.
              (lambda* (url #:key verify-certificate? ref recursive?)
                (git-download-to-store* url ref recursive?))
              (alist-delete 'download result)))

(define %options
  ;; Specifications of the command-line options.
  (list (option '(#\f "format") #t #f
                (lambda (opt name arg result)
                  (define fmt-proc
                    (match arg
                      ("base64"
                       base64-encode)
                      ("nix-base32"
                       bytevector->nix-base32-string)
                      ("base32"
                       bytevector->base32-string)
                      ((or "base16" "hex" "hexadecimal")
                       bytevector->base16-string)
                      (x
                       (leave (G_ "unsupported hash format: ~a~%") arg))))

                  (alist-cons 'format fmt-proc
                              (alist-delete 'format result))))
        (option '(#\H "hash") #t #f
                (lambda (opt name arg result)
                  (match (lookup-hash-algorithm (string->symbol arg))
                    (#f
                     (leave (G_ "~a: unknown hash algorithm~%") arg))
                    (algo
                     (alist-cons 'hash-algorithm algo result)))))
        (option '("no-check-certificate") #f #f
                (lambda (opt name arg result)
                  (alist-cons 'verify-certificate? #f result)))
        (option '(#\o "output") #t #f
                (lambda (opt name arg result)
                  (let* ((git
                          (assoc-ref result 'git-reference)))
                    (if git
                        (alist-cons 'download-proc
                                    (lambda* (url
                                              #:key
                                              verify-certificate?
                                              ref
                                              recursive?)
                                      (git-download-to-file
                                       url
                                       arg
                                       (assoc-ref result 'git-reference)
                                       recursive?))
                                    (alist-delete 'download result))
                        (alist-cons 'download-proc
                                    (lambda* (url
                                              #:key verify-certificate?
                                              #:allow-other-keys)
                                      (download-to-file url arg))
                                    (alist-delete 'download result))))))
        (option '(#\g "git") #f #f
                (lambda (opt name arg result)
                  ;; Ignore this option if 'commit' or 'branch' has
                  ;; already been provided
                  (if (assoc-ref result 'git-reference)
                      result
                      (alist-cons 'git-reference '()
                                  (add-git-download-option result)))))
        (option '("commit") #t #f
                (lambda (opt name arg result)
                  (alist-cons 'git-reference `(tag-or-commit . ,arg)
                              (add-git-download-option result))))
        (option '("branch") #t #f
                (lambda (opt name arg result)
                  (alist-cons 'git-reference `(branch . ,arg)
                              (add-git-download-option result))))
        (option '(#\r "recursive") #f #f
                (lambda (opt name arg result)
                  (alist-cons 'recursive? #t result)))

        (option '(#\h "help") #f #f
                (lambda args
                  (leave-on-EPIPE (show-help))
                  (exit 0)))
        (option '(#\V "version") #f #f
                (lambda args
                  (show-version-and-exit "guix download")))))


;;;
;;; Entry point.
;;;

(define-command (guix-download . args)
  (category packaging)
  (synopsis "download a file to the store and print its hash")

  (define (parse-options)
    ;; Return the alist of option values.
    (parse-command-line args %options (list %default-options)
                        #:build-options? #f
                        #:argument-handler
                        (lambda (arg result)
                          (when (assq 'argument result)
                            (leave (G_ "~A: extraneous argument~%") arg))
                          (alist-cons 'argument arg result))))

  (with-error-handling
    (let* ((opts  (parse-options))
           (arg   (or (assq-ref opts 'argument)
                      (leave (G_ "no download URI was specified~%"))))
           (uri   (or (string->uri arg)
                      (false-if-exception
                       (string->uri
                        (string-append "file://" (canonicalize-path arg))))
                      (leave (G_ "~a: failed to parse URI~%")
                             arg)))
           (fetch (assq-ref opts 'download-proc))
           (path  (parameterize ((current-terminal-columns
                                  (terminal-columns)))
                    (fetch (uri->string uri)
                           #:verify-certificate?
                           (assq-ref opts 'verify-certificate?)
                           #:ref (assq-ref opts 'git-reference)
                           #:recursive? (assq-ref opts 'recursive?))))
           (hash  (let* ((path* (or path
                                  (leave (G_ "~a: download failed~%")
                                         arg))))
                   (file-hash* path*
                               #:algorithm (assoc-ref opts 'hash-algorithm))))
           (fmt   (assq-ref opts 'format)))
      (format #t "~a~%~a~%" path (fmt hash))
      #t)))