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