src/lib/kdm_util.h

   1 /*
   2     Copyright (C) 2023 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #ifndef DCPOMATIC_KDM_UTIL_H
  23 #define DCPOMATIC_KDM_UTIL_H
  24
  25
  26 #include <dcp/local_time.h>
  27 #include <utility>
  28
  29
  30 namespace dcp {
  31         class Certificate;
  32 }
  33
  34
  35 enum class KDMCertificateOverlap {
  36         KDM_WITHIN_CERTIFICATE,
  37         KDM_OVERLAPS_CERTIFICATE,
  38         KDM_OUTSIDE_CERTIFICATE
  39 };
  40
  41
  42 struct KDMCertificatePeriod
  43 {
  44         KDMCertificatePeriod(std::string cinema_name_, std::string screen_name_, dcp::LocalTime from_, dcp::LocalTime to_)
  45                 : cinema_name(std::move(cinema_name_))
  46                 , screen_name(std::move(screen_name_))
  47                 , from(std::move(from_))
  48                 , to(std::move(to_))
  49         {}
  50
  51         std::string cinema_name;
  52         std::string screen_name;
  53         KDMCertificateOverlap overlap = KDMCertificateOverlap::KDM_WITHIN_CERTIFICATE;
  54         dcp::LocalTime from;
  55         dcp::LocalTime to;
  56 };
  57
  58
  59 /** @param recipient Some KDM recipient certificate.
  60  *  @param kdm_from Proposed KDM start time.
  61  *  @param kdm_to Proposed KDM end time.
  62  *  @return Relationship between certificate and KDM validity periods.
  63  */
  64
  65 KDMCertificatePeriod check_kdm_and_certificate_validity_periods(
  66         std::string const& cinema_name,
  67         std::string const& screen_name,
  68         dcp::Certificate const& recipient,
  69         dcp::LocalTime kdm_from,
  70         dcp::LocalTime kdm_to
  71         );
  72
  73
  74 #endif
  75