X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=05a90524c9818615112b77464da5a56bd154ec69;hb=097a1fb413bbbb89182161d4c1a31daa5419ec96;hp=68cdce3cd3a961ed1e3e272280d2ce3c62ac4fa6;hpb=cbaed1119cdf3acb8662e5240f59706722437d94;p=dcpomatic.git diff --git a/src/lib/job.cc b/src/lib/job.cc index 68cdce3cd..05a90524c 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -26,25 +26,27 @@ #include #include "job.h" #include "util.h" +#include "cross.h" +#include "ui_signaller.h" +#include "exceptions.h" -using namespace std; -using namespace boost; +#include "i18n.h" -/** @param s FilmState for the film that we are operating on. - * @param l A log that we can write to. - */ -Job::Job (shared_ptr s, Log* l, shared_ptr req) - : _fs (s) - , _log (l) - , _required (req) +using std::string; +using std::list; +using std::cout; +using std::stringstream; +using boost::shared_ptr; + +Job::Job (shared_ptr f) + : _film (f) + , _thread (0) , _state (NEW) , _start_time (0) - , _progress_unknown (false) + , _progress (0) , _ran_for (0) { - assert (_log); - - descend (1); + } /** Start the job in a separate thread, returning immediately */ @@ -53,7 +55,7 @@ Job::start () { set_state (RUNNING); _start_time = time (0); - boost::thread (boost::bind (&Job::run_wrapper, this)); + _thread = new boost::thread (boost::bind (&Job::run_wrapper, this)); } /** A wrapper for the ::run() method to catch exceptions */ @@ -68,17 +70,57 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); - set_error (String::compose ("%1 (%2)", e.what(), filesystem::path (e.filename()).leaf())); + + string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf()); + + try { + boost::filesystem::space_info const s = boost::filesystem::space (e.filename()); + if (s.available < pow (1024, 3)) { + m += N_("\n\n"); + m += _("The drive that the film is stored on is low in disc space. Free some more space and try again."); + } + } catch (...) { + + } + + set_error (e.what(), m); + + } catch (OpenFileError& e) { + + set_progress (1); + set_state (FINISHED_ERROR); + + 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."), e.file().string()) + ); + + } catch (boost::thread_interrupted &) { + + set_state (FINISHED_CANCELLED); } catch (std::exception& e) { set_progress (1); set_state (FINISHED_ERROR); - set_error (e.what ()); + 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)") + ); + + } catch (...) { + + set_progress (1); + set_state (FINISHED_ERROR); + 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)") + ); } } +/** @return true if this job is new (ie has not started running) */ bool Job::is_new () const { @@ -99,7 +141,7 @@ bool Job::finished () const { boost::mutex::scoped_lock lm (_state_mutex); - return _state == FINISHED_OK || _state == FINISHED_ERROR; + return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED; } /** @return true if the job has finished successfully */ @@ -118,32 +160,45 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } +bool +Job::finished_cancelled () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == FINISHED_CANCELLED; +} + +bool +Job::paused () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == PAUSED; +} + /** Set the state of this job. * @param s New state. */ void Job::set_state (State s) { - boost::mutex::scoped_lock lm (_state_mutex); - _state = s; - - if (_state == FINISHED_OK || _state == FINISHED_ERROR) { - _ran_for = elapsed_time (); + bool finished = false; + + { + boost::mutex::scoped_lock lm (_state_mutex); + _state = s; + + if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { + _ran_for = elapsed_time (); + finished = true; + _sub_name.clear (); + } } -} -/** A hack to work around our lack of cross-thread - * signalling; this emits Finished, and listeners - * assume that it will be emitted in the GUI thread, - * so this method must be called from the GUI thread. - */ -void -Job::emit_finished () -{ - Finished (); + if (finished && ui_signaller) { + ui_signaller->emit (boost::bind (boost::ref (Finished))); + } } -/** @return Time (in seconds) that this job has been running */ +/** @return DCPTime (in seconds) that this sub-job has been running */ int Job::elapsed_time () const { @@ -158,79 +213,69 @@ Job::elapsed_time () const * @param p Progress (from 0 to 1) */ void -Job::set_progress (float p) +Job::set_progress (float p, bool force) { - boost::mutex::scoped_lock lm (_progress_mutex); - _progress_unknown = false; - _stack.back().normalised = p; -} + if (!force && fabs (p - progress()) < 0.01) { + /* Calm excessive progress reporting */ + return; + } -/** @return fractional overall progress, or -1 if not known */ -float -Job::overall_progress () const -{ boost::mutex::scoped_lock lm (_progress_mutex); - if (_progress_unknown) { - return -1; - } + _progress = p; + boost::this_thread::interruption_point (); - float overall = 0; - float factor = 1; - for (list::const_iterator i = _stack.begin(); i != _stack.end(); ++i) { - factor *= i->allocation; - overall += i->normalised * factor; + if (paused ()) { + dcpomatic_sleep (1); } - if (overall > 1) { - overall = 1; + if (ui_signaller) { + ui_signaller->emit (boost::bind (boost::ref (Progress))); } - - return overall; } -/** Ascend up one level in terms of progress reporting; see descend() */ -void -Job::ascend () +/** @return fractional progress of this sub-job, or -1 if not known */ +float +Job::progress () const { boost::mutex::scoped_lock lm (_progress_mutex); - - assert (!_stack.empty ()); - float const a = _stack.back().allocation; - _stack.pop_back (); - _stack.back().normalised += a; + return _progress.get_value_or (-1); } -/** Descend down one level in terms of progress reporting; e.g. if - * there is a task which is split up into N subtasks, each of which - * report their progress from 0 to 100%, call descend() before executing - * each subtask, and ascend() afterwards to ensure that overall progress - * is reported correctly. - * - * @param a Fraction (from 0 to 1) of the current task to allocate to the subtask. - */ void -Job::descend (float a) +Job::sub (string n) { - boost::mutex::scoped_lock lm (_progress_mutex); - _stack.push_back (Level (a)); + { + boost::mutex::scoped_lock lm (_progress_mutex); + _sub_name = n; + } + + set_progress (0, true); } -/** @return Any error string that the job has generated */ string -Job::error () const +Job::error_details () const { boost::mutex::scoped_lock lm (_state_mutex); - return _error; + return _error_details; +} + +/** @return A summary of any error that the job has generated */ +string +Job::error_summary () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _error_summary; } /** Set the current error string. * @param e New error string. */ void -Job::set_error (string e) +Job::set_error (string s, string d) { boost::mutex::scoped_lock lm (_state_mutex); - _error = e; + _error_summary = s; + _error_details = d; } /** Say that this job's progress will be unknown until further notice */ @@ -238,34 +283,72 @@ void Job::set_progress_unknown () { boost::mutex::scoped_lock lm (_progress_mutex); - _progress_unknown = true; + _progress.reset (); } /** @return Human-readable status of this job */ string Job::status () const { - float const p = overall_progress (); + float const 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; + } + stringstream s; - if (!finished () && p >= 0 && t > 10 && r > 0) { - s << rint (p * 100) << "%; " << seconds_to_approximate_hms (r) << " remaining"; - } else if (!finished () && (t <= 10 || r == 0)) { - s << rint (p * 100) << "%"; + if (!finished ()) { + s << pc << N_("%"); + if (p >= 0 && 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"); + } } else if (finished_ok ()) { - s << "OK (ran for " << seconds_to_hms (_ran_for) << ")"; + s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for)); } else if (finished_in_error ()) { - s << "Error (" << error() << ")"; + s << String::compose (_("Error (%1)"), error_summary()); + } else if (finished_cancelled ()) { + s << _("Cancelled"); } return s.str (); } -/** @return An estimate of the remaining time for this job, in seconds */ +/** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const { - return elapsed_time() / overall_progress() - elapsed_time(); + return elapsed_time() / progress() - elapsed_time(); +} + +void +Job::cancel () +{ + if (!_thread) { + return; + } + + _thread->interrupt (); + _thread->join (); +} + +void +Job::pause () +{ + if (running ()) { + set_state (PAUSED); + } +} + +void +Job::resume () +{ + if (paused ()) { + set_state (RUNNING); + } }