/*
- 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 <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> 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, kdms) {
+ for (auto i: kdms) {
cout << i->kdm_as_xml ();
++written;
}
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, kdms) {
- 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;
}
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;
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) {
- 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());
}
/** Collect a list of KDMWithMetadatas into a list of lists so that
- * each list contains the KDMs for one cinema.
+ * 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()->cinema() == i->cinema()) {
+ if (j->front()->group() == i->group()) {
j->push_back (i);
break;
}
}
-/** 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;
/** 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();
}
}
/** 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();
- 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);
+ 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);
- 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);
+ 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", name_values['b']);
- boost::algorithm::replace_all (body, "$END_TIME", name_values['e']);
- boost::algorithm::replace_all (body, "$CINEMA_NAME", i.front()->cinema()->name);
+ 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()->cinema()->emails, subject, body);
+ 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(), { emails.front() }, subject, body);
+
+ /* 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);
+ }
- 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(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);
+ dcp::filesystem::remove(zip_file);
+ log_details (email);
throw;
}
- boost::filesystem::remove (zip_file);
+ log_details (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);
+ dcp::filesystem::remove(zip_file);
}
}