X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fkdm_with_metadata.cc;h=7dee935c4a0346c2b11b97aee5e2268f87055baf;hp=fe4f9ccdde7154e9e15fcab784253a191c073ccf;hb=HEAD;hpb=8f8730cadb3dae36e8aa7b7c732a7c162eac0fb6

diff --git a/src/lib/kdm_with_metadata.cc b/src/lib/kdm_with_metadata.cc
index fe4f9ccdd..f7ff84435 100644
--- a/src/lib/kdm_with_metadata.cc
+++ b/src/lib/kdm_with_metadata.cc
@@ -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.
 
@@ -18,41 +18,44 @@
 
 */
 
-#include "kdm_with_metadata.h"
+
 #include "cinema.h"
+#include "config.h"
+#include "cross.h"
+#include "dcpomatic_log.h"
+#include "email.h"
+#include "kdm_with_metadata.h"
 #include "screen.h"
 #include "util.h"
 #include "zipper.h"
-#include "config.h"
-#include "dcpomatic_log.h"
-#include "emailer.h"
-#include <boost/foreach.hpp>
-#include <boost/function.hpp>
-#include <boost/function.hpp>
+#include <dcp/file.h>
+#include <dcp/filesystem.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> screen_kdms,
+	list<KDMWithMetadataPtr> kdms,
 	boost::filesystem::path directory,
 	dcp::NameFormat name_format,
-	dcp::NameFormat::Map name_values,
-	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, screen_kdms) {
+		for (auto i: kdms) {
 			cout << i->kdm_as_xml ();
 			++written;
 		}
@@ -60,15 +63,14 @@ write_files (
 		return written;
 	}
 
-	if (!boost::filesystem::exists (directory)) {
-		boost::filesystem::create_directories (directory);
+	if (!dcp::filesystem::exists(directory)) {
+		dcp::filesystem::create_directories(directory);
 	}
 
 	/* Write KDMs to the specified directory */
-	BOOST_FOREACH (KDMWithMetadataPtr i, screen_kdms) {
-		name_values['i'] = i->kdm_id ();
-		boost::filesystem::path out = directory / careful_string_filter(name_format.get(name_values, ".xml"));
-		if (!boost::filesystem::exists (out) || confirm_overwrite (out)) {
+	for (auto i: kdms) {
+		auto out = directory / careful_string_filter(name_format.get(i->name_values(), ".xml"));
+		if (!dcp::filesystem::exists(out) || confirm_overwrite(out)) {
 			i->kdm_as_xml (out);
 			++written;
 		}
@@ -81,9 +83,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;
@@ -91,13 +93,12 @@ KDMWithMetadata::get (char k) const
 
 
 void
-make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values)
+make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format)
 {
 	Zipper zipper (zip_file);
 
-	BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
-		name_values['i'] = i->kdm_id ();
-		string const name = careful_string_filter(name_format.get(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,68 +106,56 @@ make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file,
 }
 
 
-/** Collect a list of KDMWithMetadatas into a list of list<KDMWithMetadata> so that each
- *  CinemaKDM contains the KDMs for its cinema.
+/** Collect a list of KDMWithMetadatas into a list of lists so that
+ *  each list contains the KDMs for one list.
  */
-list<list<KDMWithMetadataPtr> >
-collect (list<KDMWithMetadataPtr> screen_kdms)
+list<list<KDMWithMetadataPtr>>
+collect (list<KDMWithMetadataPtr> kdms)
 {
-	list<list<KDMWithMetadataPtr> > cinema_kdms;
+	list<list<KDMWithMetadataPtr>> grouped;
 
-	while (!screen_kdms.empty ()) {
+	for (auto i: kdms) {
 
-		/* Get all the screens from a single cinema */
+		auto j = grouped.begin ();
 
-		list<KDMWithMetadataPtr> ck;
-
-		list<KDMWithMetadataPtr>::iterator i = screen_kdms.begin ();
-		ck.push_back (*i);
-		list<KDMWithMetadataPtr>::iterator j = i;
-		++i;
-		screen_kdms.remove (*j);
-
-		while (i != screen_kdms.end ()) {
-			if ((*i)->cinema() == ck.front()->cinema()) {
-				ck.push_back (*i);
-				list<KDMWithMetadataPtr>::iterator j = i;
-				++i;
-				screen_kdms.remove (*j);
-			} else {
-				++i;
+		while (j != grouped.end()) {
+			if (j->front()->group() == i->group()) {
+				j->push_back (i);
+				break;
 			}
+			++j;
 		}
 
-		cinema_kdms.push_back (ck);
+		if (j == grouped.end()) {
+			grouped.push_back (list<KDMWithMetadataPtr>());
+			grouped.back().push_back (i);
+		}
 	}
 
-	return cinema_kdms;
+	return grouped;
 }
 
 
-/** Write one directory per cinema into another directory */
+/** Write one directory per list into another directory */
 int
 write_directories (
-	list<list<KDMWithMetadataPtr> > cinema_kdms,
+	list<list<KDMWithMetadataPtr>> kdms,
 	boost::filesystem::path directory,
 	dcp::NameFormat container_name_format,
 	dcp::NameFormat filename_format,
-	dcp::NameFormat::Map name_values,
 	function<bool (boost::filesystem::path)> confirm_overwrite
 	)
 {
-	/* No specific screen */
-	name_values['s'] = "";
-
 	int written = 0;
 
-	BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
-		boost::filesystem::path path = directory;
-		path /= container_name_format.get(name_values, "");
-		if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
-			boost::filesystem::create_directories (path);
-			write_files (i, path, filename_format, name_values, confirm_overwrite);
+	for (auto const& kdm: kdms) {
+		auto path = directory;
+		path /= container_name_format.get(kdm.front()->name_values(), "", "s");
+		if (!dcp::filesystem::exists(path) || confirm_overwrite(path)) {
+			dcp::filesystem::create_directories(path);
+			write_files(kdm, path, filename_format, confirm_overwrite);
+			written += kdm.size();
 		}
-		written += i.size();
 	}
 
 	return written;
@@ -176,29 +165,25 @@ write_directories (
 /** Write one ZIP file per cinema into a directory */
 int
 write_zip_files (
-	list<list<KDMWithMetadataPtr> > cinema_kdms,
+	list<list<KDMWithMetadataPtr>> kdms,
 	boost::filesystem::path directory,
 	dcp::NameFormat container_name_format,
 	dcp::NameFormat filename_format,
-	dcp::NameFormat::Map name_values,
 	function<bool (boost::filesystem::path)> confirm_overwrite
 	)
 {
-	/* No specific screen */
-	name_values['s'] = "";
-
 	int written = 0;
 
-	BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
-		boost::filesystem::path path = directory;
-		path /= container_name_format.get(name_values, ".zip");
-		if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
-			if (boost::filesystem::exists (path)) {
+	for (auto const& kdm: kdms) {
+		auto path = directory;
+		path /= container_name_format.get(kdm.front()->name_values(), ".zip", "s");
+		if (!dcp::filesystem::exists(path) || confirm_overwrite(path)) {
+			if (dcp::filesystem::exists(path)) {
 				/* Creating a new zip file over an existing one is an error */
-				boost::filesystem::remove (path);
+				dcp::filesystem::remove(path);
 			}
-			make_zip_file (i, path, filename_format, name_values);
-			written += i.size();
+			make_zip_file(kdm, path, filename_format);
+			written += kdm.size();
 		}
 	}
 
@@ -207,91 +192,97 @@ write_zip_files (
 
 
 /** Email one ZIP file per cinema to the cinema.
- *  @param cinema_kdms KDMS to email.
+ *  @param kdms KDMs to email.
  *  @param container_name_format Format of folder / ZIP to use.
  *  @param filename_format Format of filenames to use.
  *  @param name_values Values to substitute into \p container_name_format and \p filename_format.
  *  @param cpl_name Name of the CPL that the KDMs are for.
  */
 void
-email (
-	list<list<KDMWithMetadataPtr> > cinema_kdms,
+send_emails (
+	list<list<KDMWithMetadataPtr>> kdms,
 	dcp::NameFormat container_name_format,
 	dcp::NameFormat filename_format,
-	dcp::NameFormat::Map name_values,
-	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"));
+		throw MissingConfigurationError(_("No outgoing mail server configured in the Email tab of preferences"));
 	}
 
-	/* No specific screen */
-	name_values['s'] = "";
+	if (config->kdm_from().empty()) {
+		throw MissingConfigurationError(_("No from address configured in the KDM Email tab of preferences"));
+	}
 
-	BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
+	for (auto const& kdms_for_cinema: kdms) {
 
-		if (i.front()->cinema()->emails.empty()) {
-			continue;
-		}
+		auto first = kdms_for_cinema.front();
+
+		auto zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
+		dcp::filesystem::create_directories(zip_file);
+		zip_file /= container_name_format.get(first->name_values(), ".zip");
+		make_zip_file (kdms_for_cinema, zip_file, filename_format);
+
+		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;
+		};
 
-		boost::filesystem::path zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
-		boost::filesystem::create_directories (zip_file);
-		zip_file /= container_name_format.get(name_values, ".zip");
-		make_zip_file (i, zip_file, filename_format, name_values);
-
-		string subject = config->kdm_subject();
-		boost::algorithm::replace_all (subject, "$CPL_NAME", cpl_name);
-		boost::algorithm::replace_all (subject, "$START_TIME", name_values['b']);
-		boost::algorithm::replace_all (subject, "$END_TIME", name_values['e']);
-		boost::algorithm::replace_all (subject, "$CINEMA_NAME", i.front()->cinema()->name);
-
-		string body = config->kdm_email().c_str();
-		boost::algorithm::replace_all (body, "$CPL_NAME", cpl_name);
-		boost::algorithm::replace_all (body, "$START_TIME", name_values['b']);
-		boost::algorithm::replace_all (body, "$END_TIME", name_values['e']);
-		boost::algorithm::replace_all (body, "$CINEMA_NAME", i.front()->cinema()->name);
-
-		string screens;
-		BOOST_FOREACH (KDMWithMetadataPtr j, i) {
-			optional<string> screen_name = j->get('n');
-			if (screen_name) {
-				screens += *screen_name + ", ";
+		auto subject = substitute_variables(config->kdm_subject());
+		auto body = substitute_variables(config->kdm_email());
+
+		vector<string> screens;
+		for (auto kdm: kdms_for_cinema) {
+			if (auto screen_name = kdm->get('s')) {
+				screens.push_back(*screen_name);
 			}
 		}
-		boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
+		boost::algorithm::replace_all(body, "$SCREENS", screen_names_to_string(screens));
+
+		auto emails = first->emails();
+		std::copy(extra_addresses.begin(), extra_addresses.end(), std::back_inserter(emails));
+		if (emails.empty()) {
+			continue;
+		}
 
-		Emailer email (config->kdm_from(), i.front()->cinema()->emails, subject, body);
+		Email email(config->kdm_from(), { emails.front() }, subject, body);
 
-		BOOST_FOREACH (string i, config->kdm_cc()) {
-			email.add_cc (i);
+		/* Use CC for the second and subsequent email addresses, so we seem less spammy (#2310) */
+		for (auto cc = std::next(emails.begin()); cc != emails.end(); ++cc) {
+			email.add_cc(*cc);
 		}
-		if (!config->kdm_bcc().empty ()) {
-			email.add_bcc (config->kdm_bcc ());
+
+		for (auto cc: config->kdm_cc()) {
+			email.add_cc (cc);
+		}
+		if (!config->kdm_bcc().empty()) {
+			email.add_bcc (config->kdm_bcc());
 		}
 
-		email.add_attachment (zip_file, container_name_format.get(name_values, ".zip"), "application/zip");
+		email.add_attachment (zip_file, container_name_format.get(first->name_values(), ".zip"), "application/zip");
+		dcp::filesystem::remove(zip_file);
 
-		Config* c = Config::instance ();
+		auto log_details = [](Email& 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);
-
-		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);
 	}
 }