src/lib/kdm_with_metadata.cc

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "kdm_with_metadata.h"
  22 #include "cinema.h"
  23 #include "screen.h"
  24 #include "util.h"
  25 #include "zipper.h"
  26 #include "config.h"
  27 #include "dcpomatic_log.h"
  28 #include "emailer.h"
  29 #include <boost/foreach.hpp>
  30 #include <boost/function.hpp>
  31 #include <boost/function.hpp>
  32
  33 #include "i18n.h"
  34
  35 using std::string;
  36 using std::cout;
  37 using std::list;
  38 using boost::shared_ptr;
  39 using boost::optional;
  40 using boost::function;
  41
  42 int
  43 write_files (
  44         list<KDMWithMetadataPtr> kdms,
  45         boost::filesystem::path directory,
  46         dcp::NameFormat name_format,
  47         dcp::NameFormat::Map name_values,
  48         boost::function<bool (boost::filesystem::path)> confirm_overwrite
  49         )
  50 {
  51         int written = 0;
  52
  53         if (directory == "-") {
  54                 /* Write KDMs to the stdout */
  55                 BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
  56                         cout << i->kdm_as_xml ();
  57                         ++written;
  58                 }
  59
  60                 return written;
  61         }
  62
  63         if (!boost::filesystem::exists (directory)) {
  64                 boost::filesystem::create_directories (directory);
  65         }
  66
  67         /* Write KDMs to the specified directory */
  68         BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
  69                 name_values['i'] = i->kdm_id ();
  70                 boost::filesystem::path out = directory / careful_string_filter(name_format.get(name_values, ".xml"));
  71                 if (!boost::filesystem::exists (out) || confirm_overwrite (out)) {
  72                         i->kdm_as_xml (out);
  73                         ++written;
  74                 }
  75         }
  76
  77         return written;
  78 }
  79
  80
  81 optional<string>
  82 KDMWithMetadata::get (char k) const
  83 {
  84         dcp::NameFormat::Map::const_iterator i = _name_values.find (k);
  85         if (i == _name_values.end()) {
  86                 return optional<string>();
  87         }
  88
  89         return i->second;
  90 }
  91
  92
  93 void
  94 make_zip_file (list<KDMWithMetadataPtr> kdms, boost::filesystem::path zip_file, dcp::NameFormat name_format, dcp::NameFormat::Map name_values)
  95 {
  96         Zipper zipper (zip_file);
  97
  98         BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
  99                 name_values['i'] = i->kdm_id ();
 100                 string const name = careful_string_filter(name_format.get(name_values, ".xml"));
 101                 zipper.add (name, i->kdm_as_xml());
 102         }
 103
 104         zipper.close ();
 105 }
 106
 107
 108 /** Collect a list of KDMWithMetadatas into a list of lists so that
 109  *  each list contains the KDMs for one cinema.
 110  */
 111 list<list<KDMWithMetadataPtr> >
 112 collect (list<KDMWithMetadataPtr> kdms)
 113 {
 114         list<list<KDMWithMetadataPtr> > grouped;
 115
 116         BOOST_FOREACH (KDMWithMetadataPtr i, kdms) {
 117
 118                 list<list<KDMWithMetadataPtr> >::iterator j = grouped.begin ();
 119
 120                 while (j != grouped.end()) {
 121                         if (j->front()->cinema() == i->cinema()) {
 122                                 j->push_back (i);
 123                                 break;
 124                         }
 125                 }
 126
 127                 if (j == grouped.end()) {
 128                         grouped.push_back (list<KDMWithMetadataPtr>());
 129                         grouped.back().push_back (i);
 130                 }
 131         }
 132
 133         return grouped;
 134 }
 135
 136
 137 /** Write one directory per cinema into another directory */
 138 int
 139 write_directories (
 140         list<list<KDMWithMetadataPtr> > cinema_kdms,
 141         boost::filesystem::path directory,
 142         dcp::NameFormat container_name_format,
 143         dcp::NameFormat filename_format,
 144         dcp::NameFormat::Map name_values,
 145         function<bool (boost::filesystem::path)> confirm_overwrite
 146         )
 147 {
 148         /* No specific screen */
 149         name_values['s'] = "";
 150
 151         int written = 0;
 152
 153         BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
 154                 boost::filesystem::path path = directory;
 155                 path /= container_name_format.get(name_values, "");
 156                 if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
 157                         boost::filesystem::create_directories (path);
 158                         write_files (i, path, filename_format, name_values, confirm_overwrite);
 159                 }
 160                 written += i.size();
 161         }
 162
 163         return written;
 164 }
 165
 166
 167 /** Write one ZIP file per cinema into a directory */
 168 int
 169 write_zip_files (
 170         list<list<KDMWithMetadataPtr> > cinema_kdms,
 171         boost::filesystem::path directory,
 172         dcp::NameFormat container_name_format,
 173         dcp::NameFormat filename_format,
 174         dcp::NameFormat::Map name_values,
 175         function<bool (boost::filesystem::path)> confirm_overwrite
 176         )
 177 {
 178         /* No specific screen */
 179         name_values['s'] = "";
 180
 181         int written = 0;
 182
 183         BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
 184                 boost::filesystem::path path = directory;
 185                 path /= container_name_format.get(name_values, ".zip");
 186                 if (!boost::filesystem::exists (path) || confirm_overwrite (path)) {
 187                         if (boost::filesystem::exists (path)) {
 188                                 /* Creating a new zip file over an existing one is an error */
 189                                 boost::filesystem::remove (path);
 190                         }
 191                         make_zip_file (i, path, filename_format, name_values);
 192                         written += i.size();
 193                 }
 194         }
 195
 196         return written;
 197 }
 198
 199
 200 /** Email one ZIP file per cinema to the cinema.
 201  *  @param cinema_kdms KDMS to email.
 202  *  @param container_name_format Format of folder / ZIP to use.
 203  *  @param filename_format Format of filenames to use.
 204  *  @param name_values Values to substitute into \p container_name_format and \p filename_format.
 205  *  @param cpl_name Name of the CPL that the KDMs are for.
 206  */
 207 void
 208 email (
 209         list<list<KDMWithMetadataPtr> > cinema_kdms,
 210         dcp::NameFormat container_name_format,
 211         dcp::NameFormat filename_format,
 212         dcp::NameFormat::Map name_values,
 213         string cpl_name
 214         )
 215 {
 216         Config* config = Config::instance ();
 217
 218         if (config->mail_server().empty()) {
 219                 throw NetworkError (_("No mail server configured in preferences"));
 220         }
 221
 222         /* No specific screen */
 223         name_values['s'] = "";
 224
 225         BOOST_FOREACH (list<KDMWithMetadataPtr> const & i, cinema_kdms) {
 226
 227                 if (i.front()->cinema()->emails.empty()) {
 228                         continue;
 229                 }
 230
 231                 boost::filesystem::path zip_file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
 232                 boost::filesystem::create_directories (zip_file);
 233                 zip_file /= container_name_format.get(name_values, ".zip");
 234                 make_zip_file (i, zip_file, filename_format, name_values);
 235
 236                 string subject = config->kdm_subject();
 237                 boost::algorithm::replace_all (subject, "$CPL_NAME", cpl_name);
 238                 boost::algorithm::replace_all (subject, "$START_TIME", name_values['b']);
 239                 boost::algorithm::replace_all (subject, "$END_TIME", name_values['e']);
 240                 boost::algorithm::replace_all (subject, "$CINEMA_NAME", i.front()->cinema()->name);
 241
 242                 string body = config->kdm_email().c_str();
 243                 boost::algorithm::replace_all (body, "$CPL_NAME", cpl_name);
 244                 boost::algorithm::replace_all (body, "$START_TIME", name_values['b']);
 245                 boost::algorithm::replace_all (body, "$END_TIME", name_values['e']);
 246                 boost::algorithm::replace_all (body, "$CINEMA_NAME", i.front()->cinema()->name);
 247
 248                 string screens;
 249                 BOOST_FOREACH (KDMWithMetadataPtr j, i) {
 250                         optional<string> screen_name = j->get('n');
 251                         if (screen_name) {
 252                                 screens += *screen_name + ", ";
 253                         }
 254                 }
 255                 boost::algorithm::replace_all (body, "$SCREENS", screens.substr (0, screens.length() - 2));
 256
 257                 Emailer email (config->kdm_from(), i.front()->cinema()->emails, subject, body);
 258
 259                 BOOST_FOREACH (string i, config->kdm_cc()) {
 260                         email.add_cc (i);
 261                 }
 262                 if (!config->kdm_bcc().empty ()) {
 263                         email.add_bcc (config->kdm_bcc ());
 264                 }
 265
 266                 email.add_attachment (zip_file, container_name_format.get(name_values, ".zip"), "application/zip");
 267
 268                 Config* c = Config::instance ();
 269
 270                 try {
 271                         email.send (c->mail_server(), c->mail_port(), c->mail_protocol(), c->mail_user(), c->mail_password());
 272                 } catch (...) {
 273                         boost::filesystem::remove (zip_file);
 274                         dcpomatic_log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
 275                         dcpomatic_log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
 276                         dcpomatic_log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
 277                         dcpomatic_log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
 278                         throw;
 279                 }
 280
 281                 boost::filesystem::remove (zip_file);
 282
 283                 dcpomatic_log->log ("Email content follows", LogEntry::TYPE_DEBUG_EMAIL);
 284                 dcpomatic_log->log (email.email(), LogEntry::TYPE_DEBUG_EMAIL);
 285                 dcpomatic_log->log ("Email session follows", LogEntry::TYPE_DEBUG_EMAIL);
 286                 dcpomatic_log->log (email.notes(), LogEntry::TYPE_DEBUG_EMAIL);
 287         }
 288 }