Handle errors in subtitle XML better (#1209).
[dcpomatic.git] / src / lib / job.cc
index 51deca4044b0a4debc300fed8dfab54ac44cd2d8..5134475ce6aa2f1b86fc8c6ac38635ac9bf10ca2 100644 (file)
@@ -34,6 +34,7 @@
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
 #include <boost/foreach.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 #include <iostream>
 
 #include "i18n.h"
@@ -86,6 +87,9 @@ Job::start ()
        _start_time = time (0);
        _sub_start_time = time (0);
        _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
+#ifdef DCPOMATIC_LINUX
+       pthread_setname_np (_thread->native_handle(), "job-wrapper");
+#endif
 }
 
 /** A wrapper for the ::run() method to catch exceptions */
@@ -119,8 +123,9 @@ Job::run_wrapper ()
                set_error (
                        String::compose (_("Could not open %1"), e.file().string()),
                        String::compose (
-                               _("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."),
-                               boost::filesystem::absolute (e.file()).string()
+                               _("DCP-o-matic could not open the file %1 (%2).  Perhaps it does not exist or is in an unexpected format."),
+                               boost::filesystem::absolute (e.file()).string(),
+                               e.what()
                                )
                        );
 
@@ -133,8 +138,9 @@ Job::run_wrapper ()
                        set_error (
                                String::compose (_("Could not open %1"), e.path1().string ()),
                                String::compose (
-                                       _("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."),
-                                       boost::filesystem::absolute (e.path1()).string()
+                                       _("DCP-o-matic could not open the file %1 (%2).  Perhaps it does not exist or is in an unexpected format."),
+                                       boost::filesystem::absolute (e.path1()).string(),
+                                       e.what()
                                        )
                                );
                } else {
@@ -168,6 +174,12 @@ Job::run_wrapper ()
                set_progress (1);
                set_state (FINISHED_ERROR);
 
+       } catch (dcp::DCPReadError& e) {
+
+               set_error (e.message(), e.detail().get_value_or(""));
+               set_progress (1);
+               set_state (FINISHED_ERROR);
+
        } catch (std::exception& e) {
 
                set_error (
@@ -238,10 +250,17 @@ Job::finished_cancelled () const
 }
 
 bool
-Job::paused () const
+Job::paused_by_user () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       return _state == PAUSED_BY_USER;
+}
+
+bool
+Job::paused_by_priority () const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
-       return _state == PAUSED;
+       return _state == PAUSED_BY_PRIORITY;
 }
 
 /** Set the state of this job.
@@ -279,12 +298,28 @@ Job::elapsed_sub_time () const
        return time (0) - _sub_start_time;
 }
 
+/** Check to see if this job has been interrupted or paused */
+void
+Job::check_for_interruption_or_pause ()
+{
+       boost::this_thread::interruption_point ();
+
+       boost::mutex::scoped_lock lm (_state_mutex);
+       while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
+               emit (boost::bind (boost::ref (Progress)));
+               _pause_changed.wait (lm);
+       }
+}
+
 /** Set the progress of the current part of the job.
  *  @param p Progress (from 0 to 1)
+ *  @param force Do not ignore this update, even if it hasn't been long since the last one.
  */
 void
 Job::set_progress (float p, bool force)
 {
+       check_for_interruption_or_pause ();
+
        if (!force) {
                /* Check for excessively frequent progress reporting */
                boost::mutex::scoped_lock lm (_progress_mutex);
@@ -306,18 +341,11 @@ Job::set_progress (float p, bool force)
 void
 Job::set_progress_common (optional<float> p)
 {
-       boost::mutex::scoped_lock lm (_progress_mutex);
-       _progress = p;
-       boost::this_thread::interruption_point ();
-
-       boost::mutex::scoped_lock lm2 (_state_mutex);
-       while (_state == PAUSED) {
-               _pause_changed.wait (lm2);
+       {
+               boost::mutex::scoped_lock lm (_progress_mutex);
+               _progress = p;
        }
 
-       lm.unlock ();
-       lm2.unlock ();
-
        emit (boost::bind (boost::ref (Progress)));
 }
 
@@ -358,7 +386,8 @@ Job::error_summary () const
 }
 
 /** Set the current error string.
- *  @param e New error string.
+ *  @param s New error string.
+ *  @param d New error detail string.
  */
 void
 Job::set_error (string s, string d)
@@ -378,6 +407,7 @@ Job::set_error (string s, string d)
 void
 Job::set_progress_unknown ()
 {
+       check_for_interruption_or_pause ();
        set_progress_common (optional<float> ());
 }
 
@@ -402,9 +432,22 @@ Job::status () const
                s += buffer;
 
                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");
+                       boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
+                       boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
+                       char finish_string[16];
+                       snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
+                       string day;
+                       if (now.date() != finish.date()) {
+                               /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
+                               /// to say what day a job will finish.
+                               day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
+                       }
+                       /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
+                       /// on an operation; after it is an estimated wall-clock completion time.
+                       s += String::compose(
+                               _("; %1 remaining; finishing at %2%3"),
+                               seconds_to_approximate_hms(r), finish_string, day
+                               );
                }
        } else if (finished_ok ()) {
                s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
@@ -427,7 +470,8 @@ Job::json_status () const
                return N_("new");
        case RUNNING:
                return N_("running");
-       case PAUSED:
+       case PAUSED_BY_USER:
+       case PAUSED_BY_PRIORITY:
                return N_("paused");
        case FINISHED_OK:
                return N_("finished_ok");
@@ -458,7 +502,7 @@ Job::cancel ()
                return;
        }
 
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                resume ();
        }
 
@@ -470,10 +514,19 @@ Job::cancel ()
 }
 
 void
-Job::pause ()
+Job::pause_by_user ()
+{
+       if (running ()) {
+               set_state (PAUSED_BY_USER);
+               _pause_changed.notify_all ();
+       }
+}
+
+void
+Job::pause_by_priority ()
 {
        if (running ()) {
-               set_state (PAUSED);
+               set_state (PAUSED_BY_PRIORITY);
                _pause_changed.notify_all ();
        }
 }
@@ -481,7 +534,7 @@ Job::pause ()
 void
 Job::resume ()
 {
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                set_state (RUNNING);
                _pause_changed.notify_all ();
        }