;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2020 Ludovic Courtès <ludo@gnu.org>
;;;
;;; 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/>.

;;;
;;; Validate 'etc/news.scm'.
;;;

(use-modules (git)
             (guix git)
             (guix ui)
             (guix channels)
             (srfi srfi-26)
             (ice-9 match))

;; XXX: These two things are currently private.
(define read-channel-news (@@ (guix channels) read-channel-news))
(define channel-news-entries (cut struct-ref <> 0))

(define (all-the-news directory)
  "Return the <channel-news> read from DIRECTORY, a checkout of the 'guix'
channel."
  (call-with-input-file (string-append directory "/etc/news.scm")
    read-channel-news))

(define (validate-texinfo str type language)
  "Parse STR as a Texinfo fragment and raise an error if that fails."
  (catch #t
    (lambda ()
      (texi->plain-text str))
    (lambda (key . args)
      (print-exception (current-error-port) #f key args)
      (report-error (G_ "the Texinfo snippet below is invalid (~a, ~a):~%")
                    type language)
      (display str (current-error-port))
      (exit 1))))

(define (validate-news-entry repository entry)
  "Validate ENTRY, a <channel-news-entry>, making sure it refers to an
existent commit of REPOSITORY and contains only valid Texinfo."
  (catch 'git-error
    (lambda ()
      (let ((commit (commit-lookup repository
                                   (string->oid
                                    (channel-news-entry-commit entry)))))
        (for-each (match-lambda
                    ((language . title)
                     (validate-texinfo title 'title language)))
                  (channel-news-entry-title entry))
        (for-each (match-lambda
                    ((language . body)
                     (validate-texinfo body 'body language)))
                  (channel-news-entry-body entry))))
    (lambda (key error . rest)
      (if (= GIT_ENOTFOUND (git-error-code error))
          (leave (G_ "commit '~a' of entry '~a' does not exist~%")
                 (channel-news-entry-commit entry)
                 (channel-news-entry-title entry))
          (apply throw key error rest)))))

(let* ((this-directory (dirname (current-filename)))
       (top-directory  (string-append this-directory "/.."))
       (entries        (channel-news-entries (all-the-news top-directory))))
  (with-repository top-directory repository
    (for-each (cut validate-news-entry repository <>)
              entries)
    (info (G_ "All ~a channel news entries are valid.~%")
          (length entries))))

<tr class='logheader'><td><span title='2018-06-23 16:23:50 +0200'>2018-06-23</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=2cf2c778846153f3d5a56e98232fbef6f71b57a6'>nls: Update 'fr' translation.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
</td></tr>
<tr class='logheader'><td><span title='2018-06-13 18:50:41 +0200'>2018-06-13</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=8c655f31db66a27730cae7c97ba001899143101b'>nls: Update 'fr' translation.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
</td></tr>
<tr class='logheader'><td><span title='2018-06-08 20:38:41 +0200'>2018-06-08</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=7f3f72b292b218873fe3379d5dc5cdae5c4f4747'>nls: Update 'fr' translation.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
</td></tr>
<tr class='logheader'><td><span title='2018-06-08 17:04:23 +0200'>2018-06-08</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=dd8646555a979c563e9890dd1189b4d6a4ed4db7'>doc: Update 'fr' translation.</a></td><td>Ludovic Courtès</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
</td></tr>
<tr class='logheader'><td><span title='2018-04-29 21:42:14 +0200'>2018-04-29</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=39764ef893b7b65a8ce55e13746fed8fd0bad6e0'>build: Use only one domain for guix-manual.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
* Makefile.am (assert-no-store-file-names): Exclude guix-manual.
* po/doc/guix.pot po/doc/contributing.pot: Merge into...
* po/doc/guix-manual.pot: ...this.
* po/doc/guix.fr.po po/doc/contributing.fr.po: Merge into...
* po/doc/guix-manual.fr.po: ...this.
* doc/local.mk: Replace old file names.
* po/doc/local.mk: Replace old file names.


</td></tr>
<tr class='logheader'><td><span title='2018-04-19 21:32:07 +0200'>2018-04-19</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=bf5c74e713c623cbb0001eb36af6998e92243482'>gnu: doc: Add French documentation.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
* doc/contributing.fr.texi: New file.
* doc/guix.fr.texi: New file.
* doc/local.mk (TRANSLATED_INFO): Add them.
(info_TEXINFOS): Add guix.fr.texi.
* po/doc/contributing.fr.po: New file.
* po/doc/guix.fr.po: New file.
* po/doc/local.mk (EXTRA_DIST): Add them.


</td></tr>
<tr class='logheader'><td><span title='2018-04-19 21:30:30 +0200'>2018-04-19</span></td><td class='logsubject'><a href='/guix/commit/po/doc?id=b9fe8fd662180e64156d2b95a671242c20f0acfc'>gnu: doc: Allow documentation to be translated.</a></td><td>Julien Lepiller</td></tr>
<tr class='nohover-highlight'><td/><td colspan='3' class='logmsg'>
* po/doc/contributing.pot: New file.
* po/doc/guix.pot: New file.
* po/doc/local.mk: New file.
* Makefile.am: Include it. Add gettext command. Add silent rules for po4a.
* configure.ac: Look for po4a-translate and po4a-updatepo.
* doc/local.mk: Add rules to generate translated texi files.
(TRANSLATED_INFO): New variable.
(BUILT_SOURCES, EXTRA_DIST, MAINTAINERCLEANFILES): Add it.
* .gitignore: Add generated files.


</td></tr>