/*
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/>.
*/
-#include "quickmail.h"
#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 <zip.h>
+#include "log.h"
+#include "zipper.h"
+#include "dcpomatic_log.h"
+#include "kdm_with_metadata.h"
#include <boost/foreach.hpp>
#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;
-/** @param filename_first_part First part of name of KDM files inside the zip file
- * (perhaps the name of the film).
- */
void
-CinemaKDMs::make_zip_file (string filename_first_part, boost::filesystem::path zip_file) const
+make_zip_file (CinemaKDMs kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values)
{
- int error;
- struct zip* zip = zip_open (zip_file.string().c_str(), ZIP_CREATE | ZIP_EXCL, &error);
- if (!zip) {
- if (error == ZIP_ER_EXISTS) {
- throw FileError ("ZIP file already exists", zip_file);
- }
- throw FileError ("could not create ZIP file", zip_file);
- }
-
- list<shared_ptr<string> > kdm_strings;
+ Zipper zipper (zip_file);
- BOOST_FOREACH (ScreenKDM const & i, screen_kdms) {
- shared_ptr<string> kdm (new string (i.kdm.as_xml ()));
- kdm_strings.push_back (kdm);
+ name_values['c'] = kdms.cinema->name;
- struct zip_source* source = zip_source_buffer (zip, kdm->c_str(), kdm->length(), 0);
- if (!source) {
- throw StringError ("could not create ZIP source");
- }
-
- if (zip_add (zip, i.filename(filename_first_part).c_str(), source) == -1) {
- throw StringError ("failed to add KDM to ZIP archive");
- }
+ BOOST_FOREACH (KDMWithMetadataPtr i, kdms.screen_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());
}
- if (zip_close (zip) == -1) {
- throw StringError ("failed to close ZIP archive");
- }
+ zipper.close ();
}
+/** Collect a list of KDMWithMetadatas into a list of CinemaKDMs so that each
+ * CinemaKDM contains the KDMs for its cinema.
+ */
list<CinemaKDMs>
-CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
+collect (list<KDMWithMetadataPtr> screen_kdms)
{
list<CinemaKDMs> cinema_kdms;
CinemaKDMs ck;
- list<ScreenKDM>::iterator i = screen_kdms.begin ();
- ck.cinema = i->screen->cinema;
+ list<KDMWithMetadataPtr>::iterator i = screen_kdms.begin ();
+ ck.cinema = (*i)->cinema();
ck.screen_kdms.push_back (*i);
- list<ScreenKDM>::iterator j = i;
+ list<KDMWithMetadataPtr>::iterator j = i;
++i;
screen_kdms.remove (*j);
while (i != screen_kdms.end ()) {
- if (i->screen->cinema == ck.cinema) {
+ if ((*i)->cinema() == ck.cinema) {
ck.screen_kdms.push_back (*i);
- list<ScreenKDM>::iterator j = i;
+ list<KDMWithMetadataPtr>::iterator j = i;
++i;
screen_kdms.remove (*j);
} else {
return cinema_kdms;
}
-void
-CinemaKDMs::write_zip_files (string filename_first_part, list<CinemaKDMs> cinema_kdms, boost::filesystem::path directory)
+/** Write one directory per cinema into another directory */
+int
+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;
- path /= tidy_for_filename (i.cinema->name) + ".zip";
- i.make_zip_file (filename_first_part, path);
+ 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);
+ write_files (i.screen_kdms, path, filename_format, name_values, confirm_overwrite);
+ }
+ written += i.screen_kdms.size();
}
+
+ return written;
}
-/* XXX: should probably get from/to from the KDMs themselves */
-void
-CinemaKDMs::email (string filename_first_part, string cpl_name, list<CinemaKDMs> cinema_kdms, dcp::LocalTime from, dcp::LocalTime to)
+/** Write one ZIP file per cinema into a directory */
+int
+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;
+ 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);
+ }
+ make_zip_file (i, path, filename_format, name_values);
+ written += i.screen_kdms.size();
+ }
+ }
- boost::filesystem::path zip_file = boost::filesystem::temp_directory_path ();
- zip_file /= boost::filesystem::unique_path().string() + ".zip";
- i.make_zip_file (filename_first_part, zip_file);
+ return written;
+}
- /* Send email */
+/** 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<CinemaKDMs> cinema_kdms,
+ dcp::NameFormat container_name_format,
+ dcp::NameFormat filename_format,
+ dcp::NameFormat::Map name_values,
+ string cpl_name
+ )
+{
+ Config* config = Config::instance ();
- quickmail_initialize ();
+ if (config->mail_server().empty()) {
+ throw NetworkError (_("No mail server configured in preferences"));
+ }
- SafeStringStream start;
- start << from.date() << " " << from.time_of_day();
- SafeStringStream end;
- end << to.date() << " " << to.time_of_day();
+ /* No specific screen */
+ name_values['s'] = "";
- string subject = Config::instance()->kdm_subject();
- 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, "$CINEMA_NAME", i.cinema->name);
- quickmail mail = quickmail_create (Config::instance()->kdm_from().c_str(), subject.c_str ());
+ BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
- quickmail_add_to (mail, i.cinema->email.c_str ());
- if (!Config::instance()->kdm_cc().empty ()) {
- quickmail_add_cc (mail, Config::instance()->kdm_cc().c_str ());
- }
- if (!Config::instance()->kdm_bcc().empty ()) {
- quickmail_add_bcc (mail, Config::instance()->kdm_bcc().c_str ());
+ if (i.cinema->emails.empty()) {
+ continue;
}
- string body = Config::instance()->kdm_email().c_str();
+ 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");
+ 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.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 (KDMWithMetadataPtr j, i.screen_kdms) {
+ optional<string> screen_name = j->get('n');
+ if (screen_name) {
+ screens += *screen_name + ", ";
+ }
}
- boost::algorithm::replace_all (body, "$SCREENS", screens.str().substr (0, screens.str().length() - 2));
-
- quickmail_set_body (mail, body.c_str());
- quickmail_add_attachment_file (mail, zip_file.string().c_str(), "application/zip");
+ boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
- char const* e = quickmail_send (
- mail,
- Config::instance()->mail_server().c_str(),
- Config::instance()->mail_port(),
- Config::instance()->mail_user().c_str(),
- Config::instance()->mail_password().c_str()
- );
+ Emailer email (config->kdm_from(), i.cinema->emails, subject, body);
- if (e) {
- quickmail_destroy (mail);
+ BOOST_FOREACH (string i, config->kdm_cc()) {
+ email.add_cc (i);
+ }
+ if (!config->kdm_bcc().empty ()) {
+ email.add_bcc (config->kdm_bcc ());
+ }
- string error (e);
+ email.add_attachment (zip_file, container_name_format.get(name_values, ".zip"), "application/zip");
- if (Config::instance()->mail_server().empty ()) {
- error = _("no mail server set up in preferences");
- }
+ Config* c = Config::instance ();
- throw KDMError (
- String::compose (
- _("Failed to send KDM email to %1 (%2)"),
- i.cinema->email,
- error
- )
- );
+ 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;
}
- quickmail_destroy (mail);
+
+ 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);
}
}
projects / dcpomatic.git / blobdiff