From: Carl Hetherington Date: Mon, 4 May 2020 22:56:54 +0000 (+0200) Subject: Move some functions to kdm_with_metadata X-Git-Tag: v2.15.72~6^2~14 X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=8f8730cadb3dae36e8aa7b7c732a7c162eac0fb6 Move some functions to kdm_with_metadata --- diff --git a/src/lib/cinema_kdms.cc b/src/lib/cinema_kdms.cc deleted file mode 100644 index 94e83f807..000000000 --- a/src/lib/cinema_kdms.cc +++ /dev/null @@ -1,245 +0,0 @@ -/* - Copyright (C) 2013-2015 Carl Hetherington - - This file is part of DCP-o-matic. - - DCP-o-matic is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - DCP-o-matic is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with DCP-o-matic. If not, see . - -*/ - -#include "exceptions.h" -#include "cinema_kdms.h" -#include "cinema.h" -#include "screen.h" -#include "config.h" -#include "util.h" -#include "emailer.h" -#include "compose.hpp" -#include "log.h" -#include "zipper.h" -#include "dcpomatic_log.h" -#include "kdm_with_metadata.h" -#include - -#include "i18n.h" - -using std::list; -using std::cout; -using std::string; -using std::runtime_error; -using boost::shared_ptr; -using boost::function; -using boost::optional; - -void -make_zip_file (list kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values) -{ - 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")); - zipper.add (name, i->kdm_as_xml()); - } - - zipper.close (); -} - -/** Collect a list of KDMWithMetadatas into a list of list so that each - * CinemaKDM contains the KDMs for its cinema. - */ -list > -collect (list screen_kdms) -{ - list > cinema_kdms; - - while (!screen_kdms.empty ()) { - - /* Get all the screens from a single cinema */ - - list ck; - - list::iterator i = screen_kdms.begin (); - ck.push_back (*i); - list::iterator j = i; - ++i; - screen_kdms.remove (*j); - - while (i != screen_kdms.end ()) { - if ((*i)->cinema() == ck.front()->cinema()) { - ck.push_back (*i); - list::iterator j = i; - ++i; - screen_kdms.remove (*j); - } else { - ++i; - } - } - - cinema_kdms.push_back (ck); - } - - return cinema_kdms; -} - -/** Write one directory per cinema into another directory */ -int -write_directories ( - list > cinema_kdms, - boost::filesystem::path directory, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - function confirm_overwrite - ) -{ - /* No specific screen */ - name_values['s'] = ""; - - int written = 0; - - BOOST_FOREACH (list 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); - } - written += i.size(); - } - - return written; -} - -/** Write one ZIP file per cinema into a directory */ -int -write_zip_files ( - list > cinema_kdms, - boost::filesystem::path directory, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - function confirm_overwrite - ) -{ - /* No specific screen */ - name_values['s'] = ""; - - int written = 0; - - BOOST_FOREACH (list 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)) { - /* Creating a new zip file over an existing one is an error */ - boost::filesystem::remove (path); - } - make_zip_file (i, path, filename_format, name_values); - written += i.size(); - } - } - - return written; -} - -/** Email one ZIP file per cinema to the cinema. - * @param cinema_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 > cinema_kdms, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - string cpl_name - ) -{ - Config* config = Config::instance (); - - if (config->mail_server().empty()) { - throw NetworkError (_("No mail server configured in preferences")); - } - - /* No specific screen */ - name_values['s'] = ""; - - BOOST_FOREACH (list const & i, cinema_kdms) { - - if (i.front()->cinema()->emails.empty()) { - continue; - } - - 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 screen_name = j->get('n'); - 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); - - BOOST_FOREACH (string i, config->kdm_cc()) { - email.add_cc (i); - } - 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"); - - Config* c = Config::instance (); - - try { - email.send (c->mail_server(), c->mail_port(), c->mail_protocol(), c->mail_user(), c->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); - 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); - } -} diff --git a/src/lib/cinema_kdms.h b/src/lib/cinema_kdms.h deleted file mode 100644 index 0a5749ee8..000000000 --- a/src/lib/cinema_kdms.h +++ /dev/null @@ -1,56 +0,0 @@ -/* - Copyright (C) 2013-2015 Carl Hetherington - - This file is part of DCP-o-matic. - - DCP-o-matic is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - DCP-o-matic is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with DCP-o-matic. If not, see . - -*/ - -#include "kdm_with_metadata.h" - -class Cinema; -class Job; -class Log; - -void make_zip_file (std::list kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values); - -std::list > collect (std::list kdms); - -int write_directories ( - std::list > cinema_kdms, - boost::filesystem::path directory, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - boost::function confirm_overwrite - ); - -int write_zip_files ( - std::list > cinema_kdms, - boost::filesystem::path directory, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - boost::function confirm_overwrite - ); - -void email ( - std::list > cinema_kdms, - dcp::NameFormat container_name_format, - dcp::NameFormat filename_format, - dcp::NameFormat::Map name_values, - std::string cpl_name - ); - diff --git a/src/lib/kdm_with_metadata.cc b/src/lib/kdm_with_metadata.cc index 012172a8e..fe4f9ccdd 100644 --- a/src/lib/kdm_with_metadata.cc +++ b/src/lib/kdm_with_metadata.cc @@ -22,13 +22,22 @@ #include "cinema.h" #include "screen.h" #include "util.h" +#include "zipper.h" +#include "config.h" +#include "dcpomatic_log.h" +#include "emailer.h" #include +#include +#include + +#include "i18n.h" using std::string; using std::cout; using std::list; using boost::shared_ptr; using boost::optional; +using boost::function; int write_files ( @@ -79,3 +88,210 @@ KDMWithMetadata::get (char k) const return i->second; } + + +void +make_zip_file (list kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values) +{ + 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")); + zipper.add (name, i->kdm_as_xml()); + } + + zipper.close (); +} + + +/** Collect a list of KDMWithMetadatas into a list of list so that each + * CinemaKDM contains the KDMs for its cinema. + */ +list > +collect (list screen_kdms) +{ + list > cinema_kdms; + + while (!screen_kdms.empty ()) { + + /* Get all the screens from a single cinema */ + + list ck; + + list::iterator i = screen_kdms.begin (); + ck.push_back (*i); + list::iterator j = i; + ++i; + screen_kdms.remove (*j); + + while (i != screen_kdms.end ()) { + if ((*i)->cinema() == ck.front()->cinema()) { + ck.push_back (*i); + list::iterator j = i; + ++i; + screen_kdms.remove (*j); + } else { + ++i; + } + } + + cinema_kdms.push_back (ck); + } + + return cinema_kdms; +} + + +/** Write one directory per cinema into another directory */ +int +write_directories ( + list > cinema_kdms, + boost::filesystem::path directory, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + function confirm_overwrite + ) +{ + /* No specific screen */ + name_values['s'] = ""; + + int written = 0; + + BOOST_FOREACH (list 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); + } + written += i.size(); + } + + return written; +} + + +/** Write one ZIP file per cinema into a directory */ +int +write_zip_files ( + list > cinema_kdms, + boost::filesystem::path directory, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + function confirm_overwrite + ) +{ + /* No specific screen */ + name_values['s'] = ""; + + int written = 0; + + BOOST_FOREACH (list 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)) { + /* Creating a new zip file over an existing one is an error */ + boost::filesystem::remove (path); + } + make_zip_file (i, path, filename_format, name_values); + written += i.size(); + } + } + + return written; +} + + +/** Email one ZIP file per cinema to the cinema. + * @param cinema_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 > cinema_kdms, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + string cpl_name + ) +{ + Config* config = Config::instance (); + + if (config->mail_server().empty()) { + throw NetworkError (_("No mail server configured in preferences")); + } + + /* No specific screen */ + name_values['s'] = ""; + + BOOST_FOREACH (list const & i, cinema_kdms) { + + if (i.front()->cinema()->emails.empty()) { + continue; + } + + 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 screen_name = j->get('n'); + 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); + + BOOST_FOREACH (string i, config->kdm_cc()) { + email.add_cc (i); + } + 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"); + + Config* c = Config::instance (); + + try { + email.send (c->mail_server(), c->mail_port(), c->mail_protocol(), c->mail_user(), c->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); + 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); + } +} diff --git a/src/lib/kdm_with_metadata.h b/src/lib/kdm_with_metadata.h index ee84d9eb4..c2a13fced 100644 --- a/src/lib/kdm_with_metadata.h +++ b/src/lib/kdm_with_metadata.h @@ -70,6 +70,41 @@ int write_files ( ); +void make_zip_file (std::list kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values); + + +std::list > collect (std::list kdms); + + +int write_directories ( + std::list > cinema_kdms, + boost::filesystem::path directory, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + boost::function confirm_overwrite + ); + + +int write_zip_files ( + std::list > cinema_kdms, + boost::filesystem::path directory, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + boost::function confirm_overwrite + ); + + +void email ( + std::list > cinema_kdms, + dcp::NameFormat container_name_format, + dcp::NameFormat filename_format, + dcp::NameFormat::Map name_values, + std::string cpl_name + ); + + class DCPKDMWithMetadata : public KDMWithMetadata { public: diff --git a/src/lib/send_kdm_email_job.cc b/src/lib/send_kdm_email_job.cc index e9bad4c20..7b4d349f3 100644 --- a/src/lib/send_kdm_email_job.cc +++ b/src/lib/send_kdm_email_job.cc @@ -20,8 +20,8 @@ #include "send_kdm_email_job.h" #include "compose.hpp" +#include "kdm_with_metadata.h" #include "film.h" -#include "cinema_kdms.h" #include #include "i18n.h" diff --git a/src/lib/wscript b/src/lib/wscript index 19d68f045..49c55cc6d 100644 --- a/src/lib/wscript +++ b/src/lib/wscript @@ -47,7 +47,6 @@ sources = """ checker.cc check_content_change_job.cc cinema.cc - cinema_kdms.cc cinema_sound_processor.cc colour_conversion.cc config.cc diff --git a/src/tools/dcpomatic.cc b/src/tools/dcpomatic.cc index 5976de22a..546286e48 100644 --- a/src/tools/dcpomatic.cc +++ b/src/tools/dcpomatic.cc @@ -72,7 +72,6 @@ #include "lib/cross.h" #include "lib/content_factory.h" #include "lib/compose.hpp" -#include "lib/cinema_kdms.h" #include "lib/dcpomatic_socket.h" #include "lib/hints.h" #include "lib/dcp_content.h" diff --git a/src/tools/dcpomatic_kdm.cc b/src/tools/dcpomatic_kdm.cc index bda944d83..bbaf5bad7 100644 --- a/src/tools/dcpomatic_kdm.cc +++ b/src/tools/dcpomatic_kdm.cc @@ -40,7 +40,6 @@ #include "lib/job_manager.h" #include "lib/kdm_with_metadata.h" #include "lib/exceptions.h" -#include "lib/cinema_kdms.h" #include "lib/send_kdm_email_job.h" #include "lib/compose.hpp" #include "lib/cinema.h" diff --git a/src/tools/dcpomatic_kdm_cli.cc b/src/tools/dcpomatic_kdm_cli.cc index 493eea2c9..e3e977c6a 100644 --- a/src/tools/dcpomatic_kdm_cli.cc +++ b/src/tools/dcpomatic_kdm_cli.cc @@ -25,7 +25,6 @@ #include "lib/film.h" #include "lib/cinema.h" #include "lib/kdm_with_metadata.h" -#include "lib/cinema_kdms.h" #include "lib/config.h" #include "lib/exceptions.h" #include "lib/emailer.h" diff --git a/src/wx/confirm_kdm_email_dialog.cc b/src/wx/confirm_kdm_email_dialog.cc index eca34b5cf..df6131fe1 100644 --- a/src/wx/confirm_kdm_email_dialog.cc +++ b/src/wx/confirm_kdm_email_dialog.cc @@ -23,7 +23,6 @@ #include "static_text.h" #include "check_box.h" #include "lib/config.h" -#include "lib/cinema_kdms.h" #include using std::list; diff --git a/src/wx/kdm_dialog.cc b/src/wx/kdm_dialog.cc index f041c16c5..14ba5cf05 100644 --- a/src/wx/kdm_dialog.cc +++ b/src/wx/kdm_dialog.cc @@ -31,7 +31,6 @@ #include "lib/screen.h" #include "lib/kdm_with_metadata.h" #include "lib/job_manager.h" -#include "lib/cinema_kdms.h" #include "lib/config.h" #include "lib/cinema.h" #include diff --git a/src/wx/kdm_output_panel.cc b/src/wx/kdm_output_panel.cc index c2884008f..dcd5c6f91 100644 --- a/src/wx/kdm_output_panel.cc +++ b/src/wx/kdm_output_panel.cc @@ -20,7 +20,6 @@ #include "lib/config.h" #include "lib/cinema.h" -#include "lib/cinema_kdms.h" #include "lib/send_kdm_email_job.h" #include "kdm_output_panel.h" #include "kdm_timing_panel.h" diff --git a/src/wx/recreate_chain_dialog.cc b/src/wx/recreate_chain_dialog.cc index e477cdc1f..ae6afdd08 100644 --- a/src/wx/recreate_chain_dialog.cc +++ b/src/wx/recreate_chain_dialog.cc @@ -23,7 +23,6 @@ #include "static_text.h" #include "check_box.h" #include "lib/config.h" -#include "lib/cinema_kdms.h" #include using std::list;