Pulse the progress bar 'automatically' if we haven't had a progress update for a...
[dcpomatic.git] / src / wx / job_view.cc
index fca29743055a9902852f5b6d9a13080db2797eac..77620142473af4a6d0823da4c283d2ffefbad0d9 100644 (file)
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 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 "job_view.h"
 #include "wx_util.h"
+#include "message_dialog.h"
+#include "static_text.h"
+#include "check_box.h"
+#include "dcpomatic_button.h"
 #include "lib/job.h"
+#include "lib/job_manager.h"
 #include "lib/compose.hpp"
+#include "lib/config.h"
+#include "lib/send_notification_email_job.h"
+#include "lib/transcode_job.h"
+#include "lib/analyse_audio_job.h"
 #include <wx/wx.h>
+#include <boost/algorithm/string.hpp>
+
 
 using std::string;
 using std::min;
-using boost::shared_ptr;
+using std::shared_ptr;
+using boost::bind;
+using std::dynamic_pointer_cast;
 
-JobView::JobView (shared_ptr<Job> job, wxScrolledWindow* window, wxPanel* panel, wxFlexGridSizer* table)
+
+JobView::JobView (shared_ptr<Job> job, wxWindow* parent, wxWindow* container, wxFlexGridSizer* table)
        : _job (job)
-       , _window (window)
-       , _panel (panel)
+       , _table (table)
+       , _parent (parent)
+       , _container (container)
+       , _gauge (0)
+{
+
+}
+
+
+void
+JobView::setup ()
 {
-       int n = 0;
+       int n = insert_position ();
 
        _gauge_message = new wxBoxSizer (wxVERTICAL);
-       _gauge = new wxGauge (panel, wxID_ANY, 100);
+       _gauge = new wxGauge (_container, wxID_ANY, 100);
        /* This seems to be required to allow the gauge to shrink under OS X */
        _gauge->SetMinSize (wxSize (0, -1));
        _gauge_message->Add (_gauge, 0, wxEXPAND | wxLEFT | wxRIGHT);
-       _message = new wxStaticText (panel, wxID_ANY, wxT (" \n "));
-       _gauge_message->Add (_message, 1, wxEXPAND | wxALIGN_CENTER_VERTICAL | wxALL, 6);
-       table->Insert (n, _gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
+       _message = new StaticText (_container, wxT(" \n "), wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_MIDDLE);
+       _gauge_message->Add (_message, 1, wxEXPAND | wxALL, 6);
+       _table->Insert (n, _gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
        ++n;
 
-       _cancel = new wxButton (panel, wxID_ANY, _("Cancel"));
-       _cancel->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobView::cancel_clicked, this);
-       table->Insert (n, _cancel, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
-       ++n;
+       _buttons = new wxBoxSizer (wxHORIZONTAL);
 
-       _pause = new wxButton (_panel, wxID_ANY, _("Pause"));
-       _pause->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobView::pause_clicked, this);
-       table->Insert (n, _pause, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
-       ++n;
+       _cancel = new Button (_container, _("Cancel"));
+       _cancel->Bind (wxEVT_BUTTON, &JobView::cancel_clicked, this);
+       _buttons->Add (_cancel, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_BUTTON_STACK_GAP);
 
-       _details = new wxButton (_panel, wxID_ANY, _("Details..."));
-       _details->Bind (wxEVT_COMMAND_BUTTON_CLICKED, &JobView::details_clicked, this);
+       _details = new Button (_container, _("Details..."));
+       _details->Bind (wxEVT_BUTTON, &JobView::details_clicked, this);
        _details->Enable (false);
-       table->Insert (n, _details, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
-       ++n;
+       _buttons->Add (_details, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_BUTTON_STACK_GAP);
+
+       finish_setup (_container, _buttons);
+
+       _controls = new wxBoxSizer (wxVERTICAL);
+       _controls->Add (_buttons);
+       _notify = new CheckBox (_container, _("Notify when complete"));
+       _notify->Bind (wxEVT_CHECKBOX, bind (&JobView::notify_clicked, this));
+       _notify->SetValue (Config::instance()->default_notify());
+       _controls->Add (_notify, 0, wxTOP, DCPOMATIC_BUTTON_STACK_GAP);
 
-       _progress_connection = job->Progress.connect (boost::bind (&JobView::progress, this));
-       _finished_connection = job->Finished.connect (boost::bind (&JobView::finished, this));
+       _table->Insert (n, _controls, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
+
+       _progress_connection = _job->Progress.connect (boost::bind (&JobView::progress, this));
+       _finished_connection = _job->Finished.connect (boost::bind (&JobView::finished, this));
 
        progress ();
 
-       table->Layout ();
+       _table->Layout ();
 }
 
+
 void
 JobView::maybe_pulse ()
 {
-       if (_job->running() && !_job->progress ()) {
-               _gauge->Pulse ();
+       if (_gauge && _job->running()) {
+               auto elapsed = _job->seconds_since_last_progress_update();
+               if (!_job->progress() || !elapsed || *elapsed > 2) {
+                       _gauge->Pulse ();
+               }
        }
 }
 
+
 void
 JobView::progress ()
 {
@@ -83,9 +119,16 @@ JobView::progress ()
        if (!_job->sub_name().empty ()) {
                whole += _job->sub_name() + " ";
        }
-       whole += _job->status ();
+       auto s = _job->status ();
+       /* Watch out for < > in the error string */
+       boost::algorithm::replace_all (s, "<", "&lt;");
+       boost::algorithm::replace_all (s, ">", "&gt;");
+       whole += s;
        if (whole != _last_message) {
                _message->SetLabelMarkup (std_to_wx (whole));
+               /* This hack fixes the size of _message on OS X */
+               _message->InvalidateBestSize ();
+               _message->SetSize (_message->GetBestSize ());
                _gauge_message->Layout ();
                _last_message = whole;
        }
@@ -94,6 +137,7 @@ JobView::progress ()
        }
 }
 
+
 void
 JobView::finished ()
 {
@@ -104,34 +148,68 @@ JobView::finished ()
        }
 
        _cancel->Enable (false);
-       _pause->Enable (false);
+       _notify->Enable (false);
        if (!_job->error_details().empty ()) {
                _details->Enable (true);
        }
+
+       if (_job->message()) {
+               auto d = new MessageDialog (_parent, std_to_wx(_job->name()), std_to_wx(_job->message().get()));
+               d->ShowModal ();
+               d->Destroy ();
+       }
+
+       if ((dynamic_pointer_cast<TranscodeJob>(_job) || dynamic_pointer_cast<AnalyseAudioJob>(_job)) && _notify->GetValue()) {
+               if (Config::instance()->notification(Config::MESSAGE_BOX)) {
+                       wxMessageBox (std_to_wx(_job->name() + ": " + _job->status()), _("DCP-o-matic"), wxICON_INFORMATION);
+               }
+               if (Config::instance()->notification(Config::EMAIL)) {
+                       string body = Config::instance()->notification_email();
+                       boost::algorithm::replace_all (body, "$JOB_NAME", _job->name());
+                       boost::algorithm::replace_all (body, "$JOB_STATUS", _job->status());
+                       JobManager::instance()->add_after (_job, shared_ptr<Job> (new SendNotificationEmailJob (body)));
+               }
+       }
 }
 
+
 void
 JobView::details_clicked (wxCommandEvent &)
 {
-       string s = _job->error_summary();
+       auto s = _job->error_summary();
        s[0] = toupper (s[0]);
-       error_dialog (_window, std_to_wx (String::compose ("%1.\n\n%2", s, _job->error_details())));
+       error_dialog (_parent, std_to_wx(s), std_to_wx(_job->error_details()));
 }
 
+
 void
 JobView::cancel_clicked (wxCommandEvent &)
 {
-       _job->cancel ();
+       if (confirm_dialog (_parent, _("Are you sure you want to cancel this job?"))) {
+               _job->cancel ();
+       }
 }
 
+
 void
-JobView::pause_clicked (wxCommandEvent &)
+JobView::insert (int pos)
 {
-       if (_job->paused()) {
-               _job->resume ();
-               _pause->SetLabel (_("Pause"));
-       } else {
-               _job->pause ();
-               _pause->SetLabel (_("Resume"));
-       }
+       _table->Insert (pos, _gauge_message, 1, wxEXPAND | wxLEFT | wxRIGHT);
+       _table->Insert (pos + 1, _controls, 1, wxALIGN_CENTER_VERTICAL | wxALL, 3);
+       _table->Layout ();
+}
+
+
+void
+JobView::detach ()
+{
+       _table->Detach (_gauge_message);
+       _table->Detach (_controls);
+}
+
+
+void
+JobView::notify_clicked ()
+{
+       Config::instance()->set_default_notify (_notify->GetValue ());
 }