Don't try to send KDM email unless we have a from address.
[dcpomatic.git] / src / lib / kdm_with_metadata.cc
index 0ef1b8f380b1fc305366470b3278ce2be991c980..bebb5df86d0b44f6af12a2c5f371d2e2620eed6e 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
-#include "kdm_with_metadata.h"
+
 #include "cinema.h"
-#include "screen.h"
-#include "util.h"
-#include "zipper.h"
 #include "config.h"
+#include "cross.h"
 #include "dcpomatic_log.h"
 #include "emailer.h"
-#include <boost/foreach.hpp>
-#include <boost/function.hpp>
-#include <boost/function.hpp>
+#include "kdm_with_metadata.h"
+#include "screen.h"
+#include "util.h"
+#include "zipper.h"
+#include <dcp/file.h>
 
 #include "i18n.h"
 
-using std::string;
+
 using std::cout;
+using std::function;
 using std::list;
-using boost::shared_ptr;
+using std::shared_ptr;
+using std::string;
+using std::vector;
 using boost::optional;
-using boost::function;
+
 
 int
 write_files (
        list<KDMWithMetadataPtr> kdms,
        boost::filesystem::path directory,
        dcp::NameFormat name_format,
-       boost::function<bool (boost::filesystem::path)> confirm_overwrite
+       std::function<bool (boost::filesystem::path)> confirm_overwrite
        )
 {
        int written = 0;
 
        if (directory == "-") {
                /* Write KDMs to the stdout */
-               BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
+               for (auto i: kdms) {
                        cout << i->kdm_as_xml ();
                        ++written;
                }
@@ -64,8 +67,8 @@ write_files (
        }
 
        /* Write KDMs to the specified directory */
-       BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
-               boost::filesystem::path out = directory / careful_string_filter(name_format.get(i->name_values(), ".xml"));
+       for (auto i: kdms) {
+               auto out = dcp::fix_long_path(directory / careful_string_filter(name_format.get(i->name_values(), ".xml")));
                if (!boost::filesystem::exists (out) || confirm_overwrite (out)) {
                        i->kdm_as_xml (out);
                        ++written;
@@ -79,9 +82,9 @@ write_files (
 optional<string>
 KDMWithMetadata::get (char k) const
 {
-       dcp::NameFormat::Map::const_iterator i = _name_values.find (k);
+       auto i = _name_values.find (k);
        if (i == _name_values.end()) {
-               return optional<string>();
+               return {};
        }
 
        return i->second;
@@ -93,8 +96,8 @@ make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file,
 {
        Zipper zipper (zip_file);
 
-       BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
-               string const name = careful_string_filter(name_format.get(i->name_values(), ".xml"));
+       for (auto i: kdms) {
+               auto const name = careful_string_filter(name_format.get(i->name_values(), ".xml"));
                zipper.add (name, i->kdm_as_xml());
        }
 
@@ -105,14 +108,14 @@ make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file,
 /** Collect a list of KDMWithMetadatas into a list of lists so that
  *  each list contains the KDMs for one list.
  */
-list<list<KDMWithMetadataPtr> >
+list<list<KDMWithMetadataPtr>>
 collect (list<KDMWithMetadataPtr> kdms)
 {
-       list<list<KDMWithMetadataPtr> > grouped;
+       list<list<KDMWithMetadataPtr>> grouped;
 
-       BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
+       for (auto i: kdms) {
 
-               list<list<KDMWithMetadataPtr> >::iterator j = grouped.begin ();
+               auto j = grouped.begin ();
 
                while (j != grouped.end()) {
                        if (j->front()->group() == i->group()) {
@@ -135,7 +138,7 @@ collect (list<KDMWithMetadataPtr> kdms)
 /** Write one directory per list into another directory */
 int
 write_directories (
-       list<list<KDMWithMetadataPtr> > kdms,
+       list<list<KDMWithMetadataPtr>> kdms,
        boost::filesystem::path directory,
        dcp::NameFormat container_name_format,
        dcp::NameFormat filename_format,
@@ -144,14 +147,14 @@ write_directories (
 {
        int written = 0;
 
-       BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, kdms) {
-               boost::filesystem::path path = directory;
-               path /= container_name_format.get(i.front()->name_values(), "", "s");
+       for (auto const& kdm: kdms) {
+               auto path = directory;
+               path /= container_name_format.get(kdm.front()->name_values(), "", "s");
                if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
                        boost::filesystem::create_directories (path);
-                       write_files (i, path, filename_format, confirm_overwrite);
+                       write_files(kdm, path, filename_format, confirm_overwrite);
                }
-               written += i.size();
+               written += kdm.size();
        }
 
        return written;
@@ -161,7 +164,7 @@ write_directories (
 /** Write one ZIP file per cinema into a directory */
 int
 write_zip_files (
-       list<list<KDMWithMetadataPtr> > kdms,
+       list<list<KDMWithMetadataPtr>> kdms,
        boost::filesystem::path directory,
        dcp::NameFormat container_name_format,
        dcp::NameFormat filename_format,
@@ -170,16 +173,16 @@ write_zip_files (
 {
        int written = 0;
 
-       BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, kdms) {
-               boost::filesystem::path path = directory;
-               path /= container_name_format.get(i.front()->name_values(), ".zip", "s");
+       for (auto const& kdm: kdms) {
+               auto path = directory;
+               path /= container_name_format.get(kdm.front()->name_values(), ".zip", "s");
                if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
                        if (boost::filesystem::exists (path)) {
                                /* Creating a new zip file over an existing one is an error */
                                boost::filesystem::remove (path);
                        }
-                       make_zip_file (i, path, filename_format);
-                       written += i.size();
+                       make_zip_file(kdm, path, filename_format);
+                       written += kdm.size();
                }
        }
 
@@ -195,80 +198,101 @@ write_zip_files (
  *  @param cpl_name Name of the CPL that the KDMs are for.
  */
 void
-email (
-       list<list<KDMWithMetadataPtr> > kdms,
+send_emails (
+       list<list<KDMWithMetadataPtr>> kdms,
        dcp::NameFormat container_name_format,
        dcp::NameFormat filename_format,
-       string cpl_name
+       string cpl_name,
+       vector<string> extra_addresses
        )
 {
-       Config* config = Config::instance ();
+       auto config = Config::instance ();
 
        if (config->mail_server().empty()) {
                throw NetworkError (_("No mail server configured in preferences"));
        }
 
-       BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, kdms) {
+       if (config->kdm_from().empty()) {
+               throw NetworkError(_("No KDM from address configured in preferences"));
+       }
+
+       for (auto const& kdms_for_cinema: kdms) {
 
-               if (i.front()->emails().empty()) {
+               auto first = kdms_for_cinema.front();
+
+               if (first->emails().empty()) {
                        continue;
                }
 
-               boost::filesystem::path zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
+               auto zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
                boost::filesystem::create_directories (zip_file);
-               zip_file /= container_name_format.get(i.front()->name_values(), ".zip");
-               make_zip_file (i, zip_file, filename_format);
+               zip_file /= container_name_format.get(first->name_values(), ".zip");
+               make_zip_file (kdms_for_cinema, zip_file, filename_format);
 
-               string subject = config->kdm_subject();
-               boost::algorithm::replace_all (subject, "$CPL_NAME", cpl_name);
-               boost::algorithm::replace_all (subject, "$START_TIME", i.front()->get('b').get_value_or(""));
-               boost::algorithm::replace_all (subject, "$END_TIME", i.front()->get('e').get_value_or(""));
-               boost::algorithm::replace_all (subject, "$CINEMA_NAME", i.front()->get('c').get_value_or(""));
+               auto substitute_variables = [cpl_name, first](string target) {
+                       boost::algorithm::replace_all(target, "$CPL_NAME", cpl_name);
+                       boost::algorithm::replace_all(target, "$START_TIME", first->get('b').get_value_or(""));
+                       boost::algorithm::replace_all(target, "$END_TIME", first->get('e').get_value_or(""));
+                       boost::algorithm::replace_all(target, "$CINEMA_NAME", first->get('c').get_value_or(""));
+                       boost::algorithm::replace_all(target, "$CINEMA_SHORT_NAME", first->get('c').get_value_or("").substr(0, 14));
+                       return target;
+               };
 
-               string body = config->kdm_email().c_str();
-               boost::algorithm::replace_all (body, "$CPL_NAME", cpl_name);
-               boost::algorithm::replace_all (body, "$START_TIME", i.front()->get('b').get_value_or(""));
-               boost::algorithm::replace_all (body, "$END_TIME", i.front()->get('e').get_value_or(""));
-               boost::algorithm::replace_all (body, "$CINEMA_NAME", i.front()->get('c').get_value_or(""));
+               auto subject = substitute_variables(config->kdm_subject());
+               auto body = substitute_variables(config->kdm_email());
 
                string screens;
-               BOOST_FOREACH (KDMWithMetadataPtr j, i) {
-                       optional<string> screen_name = j->get('n');
+               for (auto kdm: kdms_for_cinema) {
+                       auto screen_name = kdm->get('s');
                        if (screen_name) {
                                screens += *screen_name + ", ";
                        }
                }
                boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
 
-               Emailer email (config->kdm_from(), i.front()->emails(), subject, body);
+               Emailer email (config->kdm_from(), first->emails(), subject, body);
 
-               BOOST_FOREACH (string i, config->kdm_cc()) {
-                       email.add_cc (i);
+               for (auto cc: config->kdm_cc()) {
+                       email.add_cc (cc);
                }
-               if (!config->kdm_bcc().empty ()) {
-                       email.add_bcc (config->kdm_bcc ());
+               if (!config->kdm_bcc().empty()) {
+                       email.add_bcc (config->kdm_bcc());
                }
 
-               email.add_attachment (zip_file, container_name_format.get(i.front()->name_values(), ".zip"), "application/zip");
+               email.add_attachment (zip_file, container_name_format.get(first->name_values(), ".zip"), "application/zip");
 
-               Config* c = Config::instance ();
+               auto log_details = [](Emailer& email) {
+                       dcpomatic_log->log("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
+                       dcpomatic_log->log(email.email(), LogEntry::TYPE_DEBUG_EMAIL);
+                       dcpomatic_log->log("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
+                       dcpomatic_log->log(email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
+               };
 
                try {
-                       email.send (c->mail_server(), c->mail_port(), c->mail_protocol(), c->mail_user(), c->mail_password());
+                       email.send (config->mail_server(), config->mail_port(), config->mail_protocol(), config->mail_user(), config->mail_password());
                } catch (...) {
                        boost::filesystem::remove (zip_file);
-                       dcpomatic_log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
-                       dcpomatic_log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
-                       dcpomatic_log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
-                       dcpomatic_log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
+                       log_details (email);
                        throw;
                }
 
-               boost::filesystem::remove (zip_file);
+               log_details (email);
+
+               for (auto extra: extra_addresses) {
+                       Emailer email (config->kdm_from(), { extra }, subject, body);
+                       email.add_attachment (zip_file, container_name_format.get(first->name_values(), ".zip"), "application/zip");
 
-               dcpomatic_log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
-               dcpomatic_log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
-               dcpomatic_log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
-               dcpomatic_log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
+                       try {
+                               email.send (config->mail_server(), config->mail_port(), config->mail_protocol(), config->mail_user(), config->mail_password());
+                       } catch (...) {
+                               boost::filesystem::remove (zip_file);
+                               log_details (email);
+                               throw;
+                       }
+
+                       log_details (email);
+               }
+
+               boost::filesystem::remove (zip_file);
        }
 }