No-op: remove all trailing whitespace.
[dcpomatic.git] / src / lib / job.cc
index b543a043f0550cc176af9874834633dc678a9128..71e4c34464be7db3eec2db19dbd8b0c5fa31a454 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
-#include <libdcp/exceptions.h>
+#include <dcp/exceptions.h>
 #include "job.h"
 #include "util.h"
 #include "cross.h"
-#include "ui_signaller.h"
 #include "exceptions.h"
+#include "film.h"
+#include "log.h"
 
 #include "i18n.h"
 
 using std::string;
 using std::list;
 using std::cout;
-using std::stringstream;
 using boost::shared_ptr;
+using boost::optional;
 
-Job::Job (shared_ptr<const Film> f)
-       : _film (f)
+#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
+
+Job::Job (shared_ptr<const Film> film)
+       : _film (film)
        , _thread (0)
        , _state (NEW)
        , _start_time (0)
@@ -66,8 +69,8 @@ Job::run_wrapper ()
 
                run ();
 
-       } catch (libdcp::FileError& e) {
-               
+       } catch (dcp::FileError& e) {
+
                string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
 
                try {
@@ -83,7 +86,7 @@ Job::run_wrapper ()
                set_error (e.what(), m);
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (OpenFileError& e) {
 
                set_error (
@@ -103,22 +106,22 @@ Job::run_wrapper ()
                set_error (_("Out of memory"), _("There was not enough memory to do this."));
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (std::exception& e) {
 
                set_error (
                        e.what (),
-                       _("It is not known what caused this error.  The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+                       string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
                        );
 
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (...) {
 
                set_error (
                        _("Unknown error"),
-                       _("It is not known what caused this error.  The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+                       string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
                        );
 
                set_progress (1);
@@ -179,7 +182,7 @@ Job::paused () const
        boost::mutex::scoped_lock lm (_state_mutex);
        return _state == PAUSED;
 }
-       
+
 /** Set the state of this job.
  *  @param s New state.
  */
@@ -187,7 +190,7 @@ void
 Job::set_state (State s)
 {
        bool finished = false;
-       
+
        {
                boost::mutex::scoped_lock lm (_state_mutex);
                _state = s;
@@ -199,8 +202,8 @@ Job::set_state (State s)
                }
        }
 
-       if (finished && ui_signaller) {
-               ui_signaller->emit (boost::bind (boost::ref (Finished)));
+       if (finished) {
+               emit (boost::bind (boost::ref (Finished)));
        }
 }
 
@@ -211,7 +214,7 @@ Job::elapsed_time () const
        if (_start_time == 0) {
                return 0;
        }
-       
+
        return time (0) - _start_time;
 }
 
@@ -221,7 +224,7 @@ Job::elapsed_time () const
 void
 Job::set_progress (float p, bool force)
 {
-       if (!force && fabs (p - progress()) < 0.01) {
+       if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
                /* Calm excessive progress reporting */
                return;
        }
@@ -230,21 +233,23 @@ Job::set_progress (float p, bool force)
        _progress = p;
        boost::this_thread::interruption_point ();
 
-       if (paused ()) {
-               dcpomatic_sleep (1);
+       boost::mutex::scoped_lock lm2 (_state_mutex);
+       while (_state == PAUSED) {
+               _pause_changed.wait (lm2);
        }
 
-       if (ui_signaller) {
-               ui_signaller->emit (boost::bind (boost::ref (Progress)));
-       }
+       lm.unlock ();
+       lm2.unlock ();
+
+       emit (boost::bind (boost::ref (Progress)));
 }
 
-/** @return fractional progress of this sub-job, or -1 if not known */
-float
+/** @return fractional progress of the current sub-job, if known */
+optional<float>
 Job::progress () const
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
-       return _progress.get_value_or (-1);
+       return _progress;
 }
 
 void
@@ -254,7 +259,7 @@ Job::sub (string n)
                boost::mutex::scoped_lock lm (_progress_mutex);
                _sub_name = n;
        }
-       
+
        set_progress (0, true);
 }
 
@@ -279,6 +284,10 @@ Job::error_summary () const
 void
 Job::set_error (string s, string d)
 {
+       LOG_ERROR_NC (s);
+       LOG_ERROR_NC (d);
+
+       _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
        boost::mutex::scoped_lock lm (_state_mutex);
        _error_summary = s;
        _error_details = d;
@@ -290,26 +299,30 @@ Job::set_progress_unknown ()
 {
        boost::mutex::scoped_lock lm (_progress_mutex);
        _progress.reset ();
+       lm.unlock ();
+
+       emit (boost::bind (boost::ref (Progress)));
 }
 
 /** @return Human-readable status of this job */
 string
 Job::status () const
 {
-       float const p = progress ();
+       optional<float> p = progress ();
        int const t = elapsed_time ();
        int const r = remaining_time ();
 
-       int pc = rint (p * 100);
-       if (pc == 100) {
-               /* 100% makes it sound like we've finished when we haven't */
-               pc = 99;
-       }
+       SafeStringStream s;
+       if (!finished () && p) {
+               int pc = rint (p.get() * 100);
+               if (pc == 100) {
+                       /* 100% makes it sound like we've finished when we haven't */
+                       pc = 99;
+               }
 
-       stringstream s;
-       if (!finished ()) {
                s << pc << N_("%");
-               if (p >= 0 && t > 10 && r > 0) {
+
+               if (t > 10 && r > 0) {
                        /// TRANSLATORS: remaining here follows an amount of time that is remaining
                        /// on an operation.
                        s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
@@ -317,7 +330,7 @@ Job::status () const
        } else if (finished_ok ()) {
                s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
        } else if (finished_in_error ()) {
-               s << String::compose (_("Error (%1)"), error_summary());
+               s << String::compose (_("Error (%1)"), error_summary ());
        } else if (finished_cancelled ()) {
                s << _("Cancelled");
        }
@@ -325,11 +338,38 @@ Job::status () const
        return s.str ();
 }
 
+string
+Job::json_status () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+
+       switch (_state) {
+       case NEW:
+               return N_("new");
+       case RUNNING:
+               return N_("running");
+       case PAUSED:
+               return N_("paused");
+       case FINISHED_OK:
+               return N_("finished_ok");
+       case FINISHED_ERROR:
+               return N_("finished_error");
+       case FINISHED_CANCELLED:
+               return N_("finished_cancelled");
+       }
+
+       return "";
+}
+
 /** @return An estimate of the remaining time for this sub-job, in seconds */
 int
 Job::remaining_time () const
 {
-       return elapsed_time() / progress() - elapsed_time();
+       if (progress().get_value_or(0) == 0) {
+               return elapsed_time ();
+       }
+
+       return elapsed_time() / progress().get() - elapsed_time();
 }
 
 void
@@ -339,6 +379,10 @@ Job::cancel ()
                return;
        }
 
+       if (paused ()) {
+               resume ();
+       }
+
        _thread->interrupt ();
        _thread->join ();
 }
@@ -348,6 +392,7 @@ Job::pause ()
 {
        if (running ()) {
                set_state (PAUSED);
+               _pause_changed.notify_all ();
        }
 }
 
@@ -356,5 +401,6 @@ Job::resume ()
 {
        if (paused ()) {
                set_state (RUNNING);
+               _pause_changed.notify_all ();
        }
 }