;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014, 2020, 2023 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2014 Sree Harsha Totakura <sreeharsha@totakura.in>
;;; Copyright © 2018 Mark H Weaver <mhw@netris.org>
;;; Copyright © 2020 Simon Tournier <zimon.toutoune@gmail.com>
;;; Copyright © 2024 Maxim Cournoyer <maxim.cournoyer@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 build svn)
  #:use-module (guix build utils)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-26)
  #:use-module (srfi srfi-34)
  #:export (svn-fetch))

;;; Commentary:
;;;
;;; This is the build-side support code of (guix svn-download).  It allows a
;;; Subversion repository to be cloned and checked out at a specific revision.
;;;
;;; Code:

(define* (svn-fetch url revision directory
                    #:key (svn-command "svn")
                    recursive?
                    user-name
                    password
                    subdirectories)
  "Fetch REVISION from URL into DIRECTORY.  REVISION must be an integer, and a
valid Subversion revision.  If SUBDIRECTORIES is provided, only these
subdirectories will be fully fetched (partial checkout).  Return #t on
success, #f otherwise."
  (define base-options
    `("--non-interactive"
      ;; Trust the server certificate.  This is OK as we
      ;; verify the checksum later.  This can be removed when
      ;; ca-certificates package is added.
      "--trust-server-cert"
      "-r" ,(number->string revision)
      ,@(if (and user-name password)
            (list (string-append "--username=" user-name)
                  (string-append "--password=" password))
            '())
      ,@(if recursive?
            '()
            (list "--ignore-externals"))))

  (guard (c ((invoke-error? c)
             (report-invoke-error c)
             #f))
    (match subdirectories
      (#f
       (apply invoke svn-command "export"
              (append base-options
                      `(;; Disable keyword substitutions (keywords are CVS-like strings
                        ;; like "$Date$", "$Id$", and so on) for two reasons: (1) some
                        ;; expansions depend on the local time zone, and (2) SWH disables
                        ;; it in its archive for this very reason.
                        "--ignore-keywords"
                        ,url ,directory))))
      (_
       (apply invoke svn-command "checkout"
              (append base-options
                      `(,@(if subdirectories
                              (list "--depth" "immediates")
                              '())
                        ,url ,directory)))
       (with-directory-excursion directory
         (apply invoke svn-command "update"
                (append base-options
                        (append-map (cut list "--set-depth" "infinity" <>)
                                    subdirectories)))
         (delete-file-recursively ".svn"))))
    #t))

;;; svn.scm ends here