src/wx/job_view.cc

   1 /*
   2     Copyright (C) 2012-2019 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
  22 #include "job_view.h"
  23 #include "wx_util.h"
  24 #include "message_dialog.h"
  25 #include "static_text.h"
  26 #include "check_box.h"
  27 #include "dcpomatic_button.h"
  28 #include "lib/job.h"
  29 #include "lib/job_manager.h"
  30 #include "lib/compose.hpp"
  31 #include "lib/config.h"
  32 #include "lib/send_notification_email_job.h"
  33 #include "lib/transcode_job.h"
  34 #include "lib/analyse_audio_job.h"
  35 #include <wx/wx.h>
  36 #include <boost/algorithm/string.hpp>
  37
  38
  39 using std::string;
  40 using std::min;
  41 using std::shared_ptr;
  42 using boost::bind;
  43 using std::dynamic_pointer_cast;
  44
  45
  46 JobView::JobView (shared_ptr<Job> job, wxWindow* parent, wxWindow* container, wxFlexGridSizer* table)
  47         : _job (job)
  48         , _table (table)
  49         , _parent (parent)
  50         , _container (container)
  51         , _gauge (0)
  52 {
  53
  54 }
  55
  56
  57 void
  58 JobView::setup ()
  59 {
  60         int n = insert_position ();
  61
  62         _gauge_message = new wxBoxSizer (wxVERTICAL);
  63         _gauge = new wxGauge (_container, wxID_ANY, 100);
  64         /* This seems to be required to allow the gauge to shrink under OS X */
  65         _gauge->SetMinSize (wxSize (0, -1));
  66         _gauge_message->Add (_gauge, 0, wxEXPAND | wxLEFT | wxRIGHT);
  67         _message = new StaticText (_container, wxT(" \n "), wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_MIDDLE);
  68         _gauge_message->Add (_message, 1, wxEXPAND | wxALL, 6);
  69         _table->Insert (n, _gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
  70         ++n;
  71
  72         _buttons = new wxBoxSizer (wxHORIZONTAL);
  73
  74         _cancel = new Button (_container, _("Cancel"));
  75         _cancel->Bind (wxEVT_BUTTON, &JobView::cancel_clicked, this);
  76         _buttons->Add (_cancel, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_BUTTON_STACK_GAP);
  77
  78         _details = new Button (_container, _("Details..."));
  79         _details->Bind (wxEVT_BUTTON, &JobView::details_clicked, this);
  80         _details->Enable (false);
  81         _buttons->Add (_details, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_BUTTON_STACK_GAP);
  82
  83         finish_setup (_container, _buttons);
  84
  85         _controls = new wxBoxSizer (wxVERTICAL);
  86         _controls->Add (_buttons);
  87         _notify = new CheckBox (_container, _("Notify when complete"));
  88         _notify->Bind (wxEVT_CHECKBOX, bind (&JobView::notify_clicked, this));
  89         _notify->SetValue (Config::instance()->default_notify());
  90         _controls->Add (_notify, 0, wxTOP, DCPOMATIC_BUTTON_STACK_GAP);
  91
  92         _table->Insert (n, _controls, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
  93
  94         _progress_connection = _job->Progress.connect (boost::bind (&JobView::progress, this));
  95         _finished_connection = _job->Finished.connect (boost::bind (&JobView::finished, this));
  96
  97         progress ();
  98
  99         _table->Layout ();
 100 }
 101
 102
 103 void
 104 JobView::maybe_pulse ()
 105 {
 106         if (_gauge && _job->running()) {
 107                 auto elapsed = _job->seconds_since_last_progress_update();
 108                 if (!_job->progress() || !elapsed || *elapsed > 2) {
 109                         _gauge->Pulse ();
 110                 }
 111         }
 112 }
 113
 114
 115 void
 116 JobView::progress ()
 117 {
 118         string whole = "<b>" + _job->name () + "</b>\n";
 119         if (!_job->sub_name().empty ()) {
 120                 whole += _job->sub_name() + " ";
 121         }
 122         auto s = _job->status ();
 123         /* Watch out for < > in the error string */
 124         boost::algorithm::replace_all (s, "<", "&lt;");
 125         boost::algorithm::replace_all (s, ">", "&gt;");
 126         whole += s;
 127         if (whole != _last_message) {
 128                 _message->SetLabelMarkup (std_to_wx (whole));
 129                 /* This hack fixes the size of _message on OS X */
 130                 _message->InvalidateBestSize ();
 131                 _message->SetSize (_message->GetBestSize ());
 132                 _gauge_message->Layout ();
 133                 _last_message = whole;
 134         }
 135         if (_job->progress ()) {
 136                 _gauge->SetValue (min (100.0f, _job->progress().get() * 100));
 137         }
 138 }
 139
 140
 141 void
 142 JobView::finished ()
 143 {
 144         progress ();
 145
 146         if (!_job->finished_cancelled ()) {
 147                 _gauge->SetValue (100);
 148         }
 149
 150         _cancel->Enable (false);
 151         _notify->Enable (false);
 152         if (!_job->error_details().empty ()) {
 153                 _details->Enable (true);
 154         }
 155
 156         if (_job->message()) {
 157                 auto d = new MessageDialog (_parent, std_to_wx(_job->name()), std_to_wx(_job->message().get()));
 158                 d->ShowModal ();
 159                 d->Destroy ();
 160         }
 161
 162         if ((dynamic_pointer_cast<TranscodeJob>(_job) || dynamic_pointer_cast<AnalyseAudioJob>(_job)) && _notify->GetValue()) {
 163                 if (Config::instance()->notification(Config::MESSAGE_BOX)) {
 164                         wxMessageBox (std_to_wx(_job->name() + ": " + _job->status()), _("DCP-o-matic"), wxICON_INFORMATION);
 165                 }
 166                 if (Config::instance()->notification(Config::EMAIL)) {
 167                         string body = Config::instance()->notification_email();
 168                         boost::algorithm::replace_all (body, "$JOB_NAME", _job->name());
 169                         boost::algorithm::replace_all (body, "$JOB_STATUS", _job->status());
 170                         JobManager::instance()->add_after (_job, shared_ptr<Job> (new SendNotificationEmailJob (body)));
 171                 }
 172         }
 173 }
 174
 175
 176 void
 177 JobView::details_clicked (wxCommandEvent &)
 178 {
 179         auto s = _job->error_summary();
 180         s[0] = toupper (s[0]);
 181         error_dialog (_parent, std_to_wx(s), std_to_wx(_job->error_details()));
 182 }
 183
 184
 185 void
 186 JobView::cancel_clicked (wxCommandEvent &)
 187 {
 188         if (confirm_dialog (_parent, _("Are you sure you want to cancel this job?"))) {
 189                 _job->cancel ();
 190         }
 191 }
 192
 193
 194 void
 195 JobView::insert (int pos)
 196 {
 197         _table->Insert (pos, _gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
 198         _table->Insert (pos + 1, _controls, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
 199         _table->Layout ();
 200 }
 201
 202
 203 void
 204 JobView::detach ()
 205 {
 206         _table->Detach (_gauge_message);
 207         _table->Detach (_controls);
 208 }
 209
 210
 211 void
 212 JobView::notify_clicked ()
 213 {
 214         Config::instance()->set_default_notify (_notify->GetValue ());
 215 }