Basics of custom DCP filename components.
[dcpomatic.git] / src / lib / cinema_kdms.cc
index 9584a3f236200a22bbabd576221de1784d9bdcce..cbfad4bb3706c4c824d6bd5fdd04c1a79684734b 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    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.
 
-    This program is distributed in the hope that it will be useful,
+    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 this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -25,6 +26,8 @@
 #include "util.h"
 #include "emailer.h"
 #include "compose.hpp"
+#include "log.h"
+#include "kdm_name_format.h"
 #include <zip.h>
 #include <boost/foreach.hpp>
 
 using std::list;
 using std::cout;
 using std::string;
+using std::runtime_error;
 using boost::shared_ptr;
 
 void
-CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) const
+CinemaKDMs::make_zip_file (boost::filesystem::path zip_file, KDMNameFormat name_format, dcp::NameFormat::Map name_values) const
 {
        int error;
        struct zip* zip = zip_open (zip_file.string().c_str(), ZIP_CREATE | ZIP_EXCL, &error);
@@ -49,25 +53,32 @@ CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) c
 
        list<shared_ptr<string> > kdm_strings;
 
+       name_values["cinema"] = cinema->name;
+
        BOOST_FOREACH (ScreenKDM const & i, screen_kdms) {
                shared_ptr<string> kdm (new string (i.kdm.as_xml ()));
                kdm_strings.push_back (kdm);
 
                struct zip_source* source = zip_source_buffer (zip, kdm->c_str(), kdm->length(), 0);
                if (!source) {
-                       throw StringError ("could not create ZIP source");
+                       throw runtime_error ("could not create ZIP source");
                }
 
-               if (zip_add (zip, i.filename(film_name).c_str(), source) == -1) {
-                       throw StringError ("failed to add KDM to ZIP archive");
+               name_values["screen"] = i.screen->name;
+               string const name = name_format.get(name_values) + ".xml";
+               if (zip_add (zip, name.c_str(), source) == -1) {
+                       throw runtime_error ("failed to add KDM to ZIP archive");
                }
        }
 
        if (zip_close (zip) == -1) {
-               throw StringError ("failed to close ZIP archive");
+               throw runtime_error ("failed to close ZIP archive");
        }
 }
 
+/** Collect a list of ScreenKDMs into a list of CinemaKDMs so that each
+ *  CinemaKDM contains the KDMs for its cinema.
+ */
 list<CinemaKDMs>
 CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
 {
@@ -103,61 +114,103 @@ CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
        return cinema_kdms;
 }
 
+/** Write one ZIP file per cinema into a directory */
 void
-CinemaKDMs::write_zip_files (string film_name, list<CinemaKDMs> cinema_kdms, boost::filesystem::path directory)
+CinemaKDMs::write_zip_files (
+       list<CinemaKDMs> cinema_kdms,
+       boost::filesystem::path directory,
+       KDMNameFormat name_format,
+       dcp::NameFormat::Map name_values
+       )
 {
+       /* No specific screen */
+       name_values["screen"] = "";
+
        BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
                boost::filesystem::path path = directory;
-               path /= tidy_for_filename (i.cinema->name) + ".zip";
-               i.make_zip_file (film_name, path);
+               name_values["cinema"] = i.cinema->name;
+               path /= name_format.get(name_values) + ".zip";
+               i.make_zip_file (path, name_format, name_values);
        }
 }
 
-/* XXX: should probably get from/to from the KDMs themselves */
+/** Email one ZIP file per cinema to the cinema.
+ *  @param log Log to write email session transcript to, or 0.
+ */
 void
-CinemaKDMs::email (string film_name, string cpl_name, list<CinemaKDMs> cinema_kdms, dcp::LocalTime from, dcp::LocalTime to, shared_ptr<Job> job)
+CinemaKDMs::email (
+       list<CinemaKDMs> cinema_kdms,
+       KDMNameFormat name_format,
+       dcp::NameFormat::Map name_values,
+       string cpl_name,
+       shared_ptr<Log> log
+       )
 {
        Config* config = Config::instance ();
 
+       if (config->mail_server().empty()) {
+               throw NetworkError (_("No mail server configured in preferences"));
+       }
+
+       /* No specific screen */
+       name_values["screen"] = "";
+
        BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
 
+               name_values["cinema"] = i.cinema->name;
+
                boost::filesystem::path zip_file = boost::filesystem::temp_directory_path ();
                zip_file /= boost::filesystem::unique_path().string() + ".zip";
-               i.make_zip_file (film_name, zip_file);
+               i.make_zip_file (zip_file, name_format, name_values);
 
                string subject = config->kdm_subject();
-               SafeStringStream start;
-               start << from.date() << " " << from.time_of_day();
-               SafeStringStream end;
-               end << to.date() << " " << to.time_of_day();
                boost::algorithm::replace_all (subject, "$CPL_NAME", cpl_name);
-               boost::algorithm::replace_all (subject, "$START_TIME", start.str ());
-               boost::algorithm::replace_all (subject, "$END_TIME", end.str ());
+               boost::algorithm::replace_all (subject, "$START_TIME", name_values["from"]);
+               boost::algorithm::replace_all (subject, "$END_TIME", name_values["to"]);
                boost::algorithm::replace_all (subject, "$CINEMA_NAME", i.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", start.str ());
-               boost::algorithm::replace_all (body, "$END_TIME", end.str ());
+               boost::algorithm::replace_all (body, "$START_TIME", name_values["from"]);
+               boost::algorithm::replace_all (body, "$END_TIME", name_values["to"]);
                boost::algorithm::replace_all (body, "$CINEMA_NAME", i.cinema->name);
 
-               SafeStringStream screens;
+               locked_stringstream screens;
                BOOST_FOREACH (ScreenKDM const & j, i.screen_kdms) {
                        screens << j.screen->name << ", ";
                }
                boost::algorithm::replace_all (body, "$SCREENS", screens.str().substr (0, screens.str().length() - 2));
 
-               Emailer email (config->kdm_from(), i.cinema->email, subject, body);
+               Emailer email (config->kdm_from(), i.cinema->emails, subject, body);
 
-               if (!config->kdm_cc().empty ()) {
-                       email.add_cc (config->kdm_cc ());
+               BOOST_FOREACH (string i, config->kdm_cc()) {
+                       email.add_cc (i);
                }
                if (!config->kdm_bcc().empty ()) {
                        email.add_bcc (config->kdm_bcc ());
                }
 
-               string const name = tidy_for_filename(i.cinema->name) + "_" + tidy_for_filename(film_name) + ".zip";
-               email.add_attachment (zip_file, name, "application/zip");
-               email.send (job);
+               email.add_attachment (zip_file, name_format.get(name_values) + ".zip", "application/zip");
+
+               Config* c = Config::instance ();
+
+               try {
+                       email.send (c->mail_server(), c->mail_port(), c->mail_user(), c->mail_password());
+               } catch (...) {
+                       if (log) {
+                               log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
+                               log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
+                               log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
+                               log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
+                       }
+                       throw;
+               }
+
+               if (log) {
+                       log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
+                       log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
+                       log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
+                       log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
+               }
        }
 }