;;; GNU Guix web site
;;; Copyright © 2019 Florian Pelz <pelzflorian@pelzflorian.de>
;;; Initially written by sirgazil who waves all
;;; copyright interest on this file.

(define-module (apps videos types)
  #:use-module (srfi srfi-9)
  #:export (video
            video?
            video-description
            video-last-updated
            video-poster
            video-title
            video-url))


;;;
;;; Data types.
;;;

;;; Video (record type)
;;; ---------------------
;;;
;;; A video object represents something viewable in an HTML video
;;; element and accessible from the videos list on the website.
;;;
;;; Objects of this type can be created with the "video" procedure as
;;; well (see Helper procedures below).
;;;
;;; Fields:
;;;
;;; title (string)
;;;   The full name of the video. For example:
;;;   "Everyday use of GNU Guix, Part One".
;;;
;;; description (SXML)
;;;   A short description. For example:
;;;   '(p "Shows you how to install packages and how to manage
;;;   software package generations.").
;;;
;;; url (string)
;;;   A URL to the video file.
;;;
;;; poster (string)
;;;   A URL to a representative preview image for the video.
;;;
;;; last-updated (date)
;;;   Optional SRFI-19 upload date of the video file's most recent
;;;   version, or #f.  This should be specified for videos that
;;;   possibly become outdated over time such as documentation videos.
;;;
(define-record-type <video>
  (make-video title description url poster last-updated)
  video?
  (title video-title)
  (description video-description)
  (url video-url)
  (poster video-poster)
  (last-updated video-last-updated))

;;; Helper procedures.

(define* (video #:key (title "") (description "")
                (url "") (poster "") (last-updated #f))
  "Return a <video> object with the given attributes."
  (make-video title description url poster last-updated))