Barely-functioning GL playback with new arrangement.
[dcpomatic.git] / src / lib / cinema_kdms.cc
index 9b106a0111285b87ceee289ffba88f4344049c15..32879cf6b5763355378e6ddc58432b8095d8ef52 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/>.
 
 */
 
@@ -26,6 +27,7 @@
 #include "emailer.h"
 #include "compose.hpp"
 #include "log.h"
+#include "dcpomatic_log.h"
 #include <zip.h>
 #include <boost/foreach.hpp>
 
@@ -36,9 +38,10 @@ using std::cout;
 using std::string;
 using std::runtime_error;
 using boost::shared_ptr;
+using boost::function;
 
 void
-CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) const
+CinemaKDMs::make_zip_file (boost::filesystem::path zip_file, dcp::NameFormat 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);
@@ -51,8 +54,10 @@ CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) c
 
        list<shared_ptr<string> > kdm_strings;
 
-       BOOST_FOREACH (ScreenKDM const & i, screen_kdms) {
-               shared_ptr<string> kdm (new string (i.kdm.as_xml ()));
+       name_values['c'] = cinema->name;
+
+       BOOST_FOREACH (shared_ptr<ScreenKDM> 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);
@@ -60,7 +65,10 @@ CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) c
                        throw runtime_error ("could not create ZIP source");
                }
 
-               if (zip_add (zip, i.filename(film_name).c_str(), source) == -1) {
+               name_values['s'] = i->screen->name;
+               name_values['i'] = i->kdm_id ();
+               string const name = careful_string_filter(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");
                }
        }
@@ -70,8 +78,11 @@ CinemaKDMs::make_zip_file (string film_name, boost::filesystem::path zip_file) c
        }
 }
 
+/** 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)
+CinemaKDMs::collect (list<shared_ptr<ScreenKDM> > screen_kdms)
 {
        list<CinemaKDMs> cinema_kdms;
 
@@ -81,17 +92,17 @@ CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
 
                CinemaKDMs ck;
 
-               list<ScreenKDM>::iterator i = screen_kdms.begin ();
-               ck.cinema = i->screen->cinema;
+               list<shared_ptr<ScreenKDM> >::iterator i = screen_kdms.begin ();
+               ck.cinema = (*i)->screen->cinema;
                ck.screen_kdms.push_back (*i);
-               list<ScreenKDM>::iterator j = i;
+               list<shared_ptr<ScreenKDM> >::iterator j = i;
                ++i;
                screen_kdms.remove (*j);
 
                while (i != screen_kdms.end ()) {
-                       if (i->screen->cinema == ck.cinema) {
+                       if ((*i)->screen->cinema == ck.cinema) {
                                ck.screen_kdms.push_back (*i);
-                               list<ScreenKDM>::iterator j = i;
+                               list<shared_ptr<ScreenKDM> >::iterator j = i;
                                ++i;
                                screen_kdms.remove (*j);
                        } else {
@@ -105,21 +116,83 @@ CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
        return cinema_kdms;
 }
 
-void
-CinemaKDMs::write_zip_files (string film_name, list<CinemaKDMs> cinema_kdms, boost::filesystem::path directory)
+/** Write one directory per cinema into another directory */
+int
+CinemaKDMs::write_directories (
+       list<CinemaKDMs> cinema_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 (CinemaKDMs const & i, cinema_kdms) {
+               boost::filesystem::path path = directory;
+               name_values['c'] = i.cinema->name;
+               path /= container_name_format.get(name_values, "");
+               if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
+                       boost::filesystem::create_directories (path);
+                       ScreenKDM::write_files (i.screen_kdms, path, filename_format, name_values, confirm_overwrite);
+               }
+               written += i.screen_kdms.size();
+       }
+
+       return written;
+}
+
+/** Write one ZIP file per cinema into a directory */
+int
+CinemaKDMs::write_zip_files (
+       list<CinemaKDMs> cinema_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 (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['c'] = i.cinema->name;
+               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);
+                       }
+                       i.make_zip_file (path, filename_format, name_values);
+                       written += i.screen_kdms.size();
+               }
        }
+
+       return written;
 }
 
-/** @param log Log to write email session transcript to, or 0 */
-/* XXX: should probably get from/to from the KDMs themselves */
+/** 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
 CinemaKDMs::email (
-       string film_name, string cpl_name, list<CinemaKDMs> cinema_kdms, dcp::LocalTime from, dcp::LocalTime to, shared_ptr<Log> log
+       list<CinemaKDMs> cinema_kdms,
+       dcp::NameFormat container_name_format,
+       dcp::NameFormat filename_format,
+       dcp::NameFormat::Map name_values,
+       string cpl_name
        )
 {
        Config* config = Config::instance ();
@@ -128,51 +201,69 @@ CinemaKDMs::email (
                throw NetworkError (_("No mail server configured in preferences"));
        }
 
+       /* No specific screen */
+       name_values['s'] = "";
+
        BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
 
-               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);
+               if (i.cinema->emails.empty()) {
+                       continue;
+               }
+
+               name_values['c'] = i.cinema->name;
+
+               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");
+               i.make_zip_file (zip_file, filename_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['b']);
+               boost::algorithm::replace_all (subject, "$END_TIME", name_values['e']);
                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['b']);
+               boost::algorithm::replace_all (body, "$END_TIME", name_values['e']);
                boost::algorithm::replace_all (body, "$CINEMA_NAME", i.cinema->name);
 
-               SafeStringStream screens;
-               BOOST_FOREACH (ScreenKDM const & j, i.screen_kdms) {
-                       screens << j.screen->name << ", ";
+               string screens;
+               BOOST_FOREACH (shared_ptr<ScreenKDM> j, i.screen_kdms) {
+                       screens += j->screen->name + ", ";
                }
-               boost::algorithm::replace_all (body, "$SCREENS", screens.str().substr (0, screens.str().length() - 2));
+               boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
 
                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.add_attachment (zip_file, container_name_format.get(name_values, ".zip"), "application/zip");
 
                Config* c = Config::instance ();
-               email.send (c->mail_server(), c->mail_port(), c->mail_user(), c->mail_password());
 
-               if (log) {
-                       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());
+               } 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);
        }
 }