X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=c4632a83c6e9e9dbb036de90a3598d2abe5cd02e;hb=1858190cff2f960f3d1f0a5cc02c69da86088f5b;hp=e48daa4109bbfb935fdc1f532a0d6947c9a276f9;hpb=e6f28e7cda23c1ba3c49cc1bf2dc1491c2f87160;p=dcpomatic.git diff --git a/src/lib/job.cc b/src/lib/job.cc index e48daa410..c4632a83c 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2015 Carl Hetherington 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 @@ -17,29 +17,35 @@ */ -/** @file src/job.cc +/** @file src/job.cc * @brief A parent class to represent long-running tasks which are run in their own thread. */ -#include -#include -#include #include "job.h" #include "util.h" #include "cross.h" -#include "ui_signaller.h" #include "exceptions.h" +#include "film.h" +#include "log.h" +#include "compose.hpp" +#include +#include +#include +#include #include "i18n.h" using std::string; using std::list; using std::cout; -using std::stringstream; using boost::shared_ptr; +using boost::optional; +using boost::function; + +#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR); -Job::Job (shared_ptr f) - : _film (f) +Job::Job (shared_ptr film) + : _film (film) , _thread (0) , _state (NEW) , _start_time (0) @@ -49,6 +55,16 @@ Job::Job (shared_ptr f) } +Job::~Job () +{ + if (_thread) { + _thread->interrupt (); + _thread->join (); + } + + delete _thread; +} + /** Start the job in a separate thread, returning immediately */ void Job::start () @@ -67,7 +83,7 @@ Job::run_wrapper () run (); } 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 +99,7 @@ Job::run_wrapper () set_error (e.what(), m); set_progress (1); set_state (FINISHED_ERROR); - + } catch (OpenFileError& e) { set_error ( @@ -94,6 +110,23 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); + } catch (boost::filesystem::filesystem_error& e) { + + if (e.code() == boost::system::errc::no_such_file_or_directory) { + 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."), e.path1().string()) + ); + } else { + set_error ( + e.what (), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + } + + set_progress (1); + set_state (FINISHED_ERROR); + } catch (boost::thread_interrupted &) { set_state (FINISHED_CANCELLED); @@ -103,22 +136,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 +212,7 @@ Job::paused () const boost::mutex::scoped_lock lm (_state_mutex); return _state == PAUSED; } - + /** Set the state of this job. * @param s New state. */ @@ -199,9 +232,9 @@ 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))); + } } /** @return DCPTime (in seconds) that this sub-job has been running */ @@ -211,7 +244,7 @@ Job::elapsed_time () const if (_start_time == 0) { return 0; } - + return time (0) - _start_time; } @@ -221,30 +254,38 @@ 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; } + set_progress_common (p); +} + +void +Job::set_progress_common (optional p) +{ boost::mutex::scoped_lock lm (_progress_mutex); _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 the current sub-job, or -1 if not known */ -float +/** @return fractional progress of the current sub-job, if known */ +optional Job::progress () const { boost::mutex::scoped_lock lm (_progress_mutex); - return _progress.get_value_or (-1); + return _progress; } void @@ -254,7 +295,7 @@ Job::sub (string n) boost::mutex::scoped_lock lm (_progress_mutex); _sub_name = n; } - + set_progress (0, true); } @@ -279,6 +320,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; @@ -288,28 +333,28 @@ Job::set_error (string s, string d) void Job::set_progress_unknown () { - boost::mutex::scoped_lock lm (_progress_mutex); - _progress.reset (); + set_progress_common (optional ()); } /** @return Human-readable status of this job */ string Job::status () const { - float const p = progress (); + optional 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 = lrintf (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 +362,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"); } @@ -352,7 +397,11 @@ Job::json_status () const 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 @@ -362,6 +411,10 @@ Job::cancel () return; } + if (paused ()) { + resume (); + } + _thread->interrupt (); _thread->join (); } @@ -371,6 +424,7 @@ Job::pause () { if (running ()) { set_state (PAUSED); + _pause_changed.notify_all (); } } @@ -379,5 +433,18 @@ Job::resume () { if (paused ()) { set_state (RUNNING); + _pause_changed.notify_all (); + } +} + +void +Job::when_finished (boost::signals2::connection& connection, function finished) +{ + boost::mutex::scoped_lock lm (_state_mutex); + if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { + finished (); + } else { + connection = Finished.connect (finished); } } +