2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "exceptions.h"
22 #include "cinema_kdms.h"
28 #include "compose.hpp"
31 #include <boost/foreach.hpp>
38 using std::runtime_error;
39 using boost::shared_ptr;
40 using boost::function;
43 CinemaKDMs::make_zip_file (boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values) const
46 struct zip* zip = zip_open (zip_file.string().c_str(), ZIP_CREATE | ZIP_EXCL, &error);
48 if (error == ZIP_ER_EXISTS) {
49 throw FileError ("ZIP file already exists", zip_file);
51 throw FileError ("could not create ZIP file", zip_file);
54 list<shared_ptr<string> > kdm_strings;
56 name_values['c'] = cinema->name;
58 BOOST_FOREACH (ScreenKDM const & i, screen_kdms) {
59 shared_ptr<string> kdm (new string (i.kdm.as_xml ()));
60 kdm_strings.push_back (kdm);
62 struct zip_source* source = zip_source_buffer (zip, kdm->c_str(), kdm->length(), 0);
64 throw runtime_error ("could not create ZIP source");
67 name_values['s'] = i.screen->name;
68 string const name = name_format.get(name_values, ".xml");
69 if (zip_add (zip, name.c_str(), source) == -1) {
70 throw runtime_error ("failed to add KDM to ZIP archive");
74 if (zip_close (zip) == -1) {
75 throw runtime_error ("failed to close ZIP archive");
79 /** Collect a list of ScreenKDMs into a list of CinemaKDMs so that each
80 * CinemaKDM contains the KDMs for its cinema.
83 CinemaKDMs::collect (list<ScreenKDM> screen_kdms)
85 list<CinemaKDMs> cinema_kdms;
87 while (!screen_kdms.empty ()) {
89 /* Get all the screens from a single cinema */
93 list<ScreenKDM>::iterator i = screen_kdms.begin ();
94 ck.cinema = i->screen->cinema;
95 ck.screen_kdms.push_back (*i);
96 list<ScreenKDM>::iterator j = i;
98 screen_kdms.remove (*j);
100 while (i != screen_kdms.end ()) {
101 if (i->screen->cinema == ck.cinema) {
102 ck.screen_kdms.push_back (*i);
103 list<ScreenKDM>::iterator j = i;
105 screen_kdms.remove (*j);
111 cinema_kdms.push_back (ck);
117 /** Write one directory per cinema into another directory */
119 CinemaKDMs::write_directories (
120 list<CinemaKDMs> cinema_kdms,
121 boost::filesystem::path directory,
122 dcp::NameFormat container_name_format,
123 dcp::NameFormat filename_format,
124 dcp::NameFormat::Map name_values,
125 function<bool (boost::filesystem::path)> confirm_overwrite
128 /* No specific screen */
129 name_values['s'] = "";
133 if (!boost::filesystem::exists (directory)) {
134 boost::filesystem::create_directories (directory);
137 BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
138 boost::filesystem::path path = directory;
139 name_values['c'] = i.cinema->name;
140 path /= container_name_format.get(name_values, "");
141 ScreenKDM::write_files (i.screen_kdms, path, filename_format, name_values, confirm_overwrite);
142 written += i.screen_kdms.size();
148 /** Write one ZIP file per cinema into a directory */
150 CinemaKDMs::write_zip_files (
151 list<CinemaKDMs> cinema_kdms,
152 boost::filesystem::path directory,
153 dcp::NameFormat container_name_format,
154 dcp::NameFormat filename_format,
155 dcp::NameFormat::Map name_values,
156 function<bool (boost::filesystem::path)> confirm_overwrite
159 /* No specific screen */
160 name_values['s'] = "";
164 if (!boost::filesystem::exists (directory)) {
165 boost::filesystem::create_directories (directory);
168 BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
169 boost::filesystem::path path = directory;
170 name_values['c'] = i.cinema->name;
171 path /= container_name_format.get(name_values, ".zip");
172 if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
173 if (boost::filesystem::exists (path)) {
174 /* Creating a new zip file over an existing one is an error */
175 boost::filesystem::remove (path);
177 i.make_zip_file (path, filename_format, name_values);
178 written += i.screen_kdms.size();
185 /** Email one ZIP file per cinema to the cinema.
186 * @param cinema_kdms KDMS to email.
187 * @param container_name_format Format of folder / ZIP to use.
188 * @param filename_format Format of filenames to use.
189 * @param name_values Values to substitute into \p container_name_format and \p filename_format.
190 * @param cpl_name Name of the CPL that the KDMs are for.
191 * @param log Log to write email session transcript to, or 0.
195 list<CinemaKDMs> cinema_kdms,
196 dcp::NameFormat container_name_format,
197 dcp::NameFormat filename_format,
198 dcp::NameFormat::Map name_values,
203 Config* config = Config::instance ();
205 if (config->mail_server().empty()) {
206 throw NetworkError (_("No mail server configured in preferences"));
209 /* No specific screen */
210 name_values['s'] = "";
212 BOOST_FOREACH (CinemaKDMs const & i, cinema_kdms) {
214 name_values['c'] = i.cinema->name;
216 boost::filesystem::path zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
217 boost::filesystem::create_directories (zip_file);
218 zip_file /= container_name_format.get(name_values, ".zip");
219 i.make_zip_file (zip_file, filename_format, name_values);
221 string subject = config->kdm_subject();
222 boost::algorithm::replace_all (subject, "$CPL_NAME", cpl_name);
223 boost::algorithm::replace_all (subject, "$START_TIME", name_values['b']);
224 boost::algorithm::replace_all (subject, "$END_TIME", name_values['e']);
225 boost::algorithm::replace_all (subject, "$CINEMA_NAME", i.cinema->name);
227 string body = config->kdm_email().c_str();
228 boost::algorithm::replace_all (body, "$CPL_NAME", cpl_name);
229 boost::algorithm::replace_all (body, "$START_TIME", name_values['b']);
230 boost::algorithm::replace_all (body, "$END_TIME", name_values['e']);
231 boost::algorithm::replace_all (body, "$CINEMA_NAME", i.cinema->name);
234 BOOST_FOREACH (ScreenKDM const & j, i.screen_kdms) {
235 screens += j.screen->name + ", ";
237 boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
239 Emailer email (config->kdm_from(), i.cinema->emails, subject, body);
241 BOOST_FOREACH (string i, config->kdm_cc()) {
244 if (!config->kdm_bcc().empty ()) {
245 email.add_bcc (config->kdm_bcc ());
248 email.add_attachment (zip_file, container_name_format.get(name_values, ".zip"), "application/zip");
250 Config* c = Config::instance ();
253 email.send (c->mail_server(), c->mail_port(), c->mail_user(), c->mail_password());
255 boost::filesystem::remove (zip_file);
257 log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
258 log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
259 log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
260 log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
265 boost::filesystem::remove (zip_file);
268 log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
269 log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
270 log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
271 log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);