X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=912c6a6ef3c961374a81bd4863509a94d0c524f2;hp=cb2120de1ea492fb907f3a74d5653a3f007739eb;hb=a6c4b4fa16d9c6597e362044b875f3d6df80753f;hpb=dd3ddb4359a9f8b7ce08ce92e0315dccc65bf40b diff --git a/src/lib/job.cc b/src/lib/job.cc index cb2120de1..912c6a6ef 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -18,35 +18,40 @@ */ + /** @file src/job.cc * @brief A parent class to represent long-running tasks which are run in their own thread. */ -#include "job.h" -#include "util.h" + +#include "compose.hpp" +#include "constants.h" #include "cross.h" +#include "dcpomatic_log.h" #include "exceptions.h" #include "film.h" +#include "job.h" #include "log.h" -#include "dcpomatic_log.h" -#include "compose.hpp" +#include "util.h" #include #include -#include -#include #include +#include +#include #include #include "i18n.h" -using std::string; -using std::list; + using std::cout; +using std::function; +using std::list; using std::shared_ptr; +using std::string; using boost::optional; -using std::function; using namespace dcpomatic; + /** @param film Associated film, or 0 */ Job::Job (shared_ptr film) : _film (film) @@ -59,6 +64,7 @@ Job::Job (shared_ptr film) } + Job::~Job () { #ifdef DCPOMATIC_DEBUG @@ -67,6 +73,7 @@ Job::~Job () #endif } + void Job::stop_thread () { @@ -78,6 +85,7 @@ Job::stop_thread () } catch (...) {} } + /** Start the job in a separate thread, returning immediately */ void Job::start () @@ -91,6 +99,7 @@ Job::start () #endif } + /** A wrapper for the ::run() method to catch exceptions */ void Job::run_wrapper () @@ -191,9 +200,7 @@ Job::run_wrapper () set_state (FINISHED_ERROR); } catch (boost::thread_interrupted &) { - - set_state (FINISHED_CANCELLED); - + /* The job was cancelled; there's nothing else we need to do here */ } catch (sub::SubripError& e) { string extra = "Error is near:\n"; @@ -229,6 +236,12 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); + } catch (CPLNotFoundError& e) { + + set_error(e.what()); + set_progress(1); + set_state(FINISHED_ERROR); + } catch (std::exception& e) { set_error ( @@ -251,6 +264,7 @@ Job::run_wrapper () } } + /** @return true if this job is new (ie has not started running) */ bool Job::is_new () const @@ -259,6 +273,7 @@ Job::is_new () const return _state == NEW; } + /** @return true if the job is running */ bool Job::running () const @@ -267,6 +282,7 @@ Job::running () const return _state == RUNNING; } + /** @return true if the job has finished (either successfully or unsuccessfully) */ bool Job::finished () const @@ -275,6 +291,7 @@ Job::finished () const return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED; } + /** @return true if the job has finished successfully */ bool Job::finished_ok () const @@ -283,6 +300,7 @@ Job::finished_ok () const return _state == FINISHED_OK; } + /** @return true if the job has finished unsuccessfully */ bool Job::finished_in_error () const @@ -291,6 +309,7 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } + bool Job::finished_cancelled () const { @@ -298,6 +317,7 @@ Job::finished_cancelled () const return _state == FINISHED_CANCELLED; } + bool Job::paused_by_user () const { @@ -305,6 +325,7 @@ Job::paused_by_user () const return _state == PAUSED_BY_USER; } + bool Job::paused_by_priority () const { @@ -312,6 +333,7 @@ Job::paused_by_priority () const return _state == PAUSED_BY_PRIORITY; } + /** Set the state of this job. * @param s New state. */ @@ -322,6 +344,10 @@ Job::set_state (State s) { boost::mutex::scoped_lock lm (_state_mutex); + if (_state == s) { + return; + } + _state = s; if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { @@ -332,11 +358,31 @@ Job::set_state (State s) } if (finished) { - emit (boost::bind (boost::ref (Finished))); - FinishedImmediate (); + auto const result = state_to_result(s); + emit(boost::bind(boost::ref(Finished), result)); + FinishedImmediate(result); } } + +Job::Result +Job::state_to_result(State state) const +{ + switch (state) { + case FINISHED_OK: + return Result::RESULT_OK; + case FINISHED_ERROR: + return Result::RESULT_ERROR; + case FINISHED_CANCELLED: + return Result::RESULT_CANCELLED; + default: + DCPOMATIC_ASSERT(false); + }; + + DCPOMATIC_ASSERT(false); +} + + /** @return DCPTime (in seconds) that this sub-job has been running */ int Job::elapsed_sub_time () const @@ -348,6 +394,7 @@ 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 () @@ -361,6 +408,22 @@ Job::check_for_interruption_or_pause () } } + +optional +Job::seconds_since_last_progress_update () const +{ + boost::mutex::scoped_lock lm (_progress_mutex); + if (!_last_progress_update) { + return {}; + } + + struct timeval now; + gettimeofday (&now, 0); + + return seconds(now) - seconds(*_last_progress_update); +} + + /** 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. @@ -387,6 +450,7 @@ Job::set_progress (float p, bool force) set_progress_common (p); } + void Job::set_progress_common (optional p) { @@ -398,6 +462,7 @@ Job::set_progress_common (optional p) emit (boost::bind (boost::ref (Progress))); } + /** @return fractional progress of the current sub-job, if known */ optional Job::progress () const @@ -406,6 +471,7 @@ Job::progress () const return _progress; } + void Job::sub (string n) { @@ -419,6 +485,7 @@ Job::sub (string n) _sub_start_time = time (0); } + string Job::error_details () const { @@ -426,6 +493,7 @@ Job::error_details () const return _error_details; } + /** @return A summary of any error that the job has generated */ string Job::error_summary () const @@ -434,6 +502,7 @@ Job::error_summary () const return _error_summary; } + /** Set the current error string. * @param s New error string. * @param d New error detail string. @@ -450,6 +519,7 @@ Job::set_error (string s, string d) _error_details = d; } + /** Say that this job's progress will be unknown until further notice */ void Job::set_progress_unknown () @@ -458,6 +528,7 @@ Job::set_progress_unknown () set_progress_common (optional ()); } + /** @return Human-readable status of this job */ string Job::status () const @@ -466,6 +537,27 @@ Job::status () const int const t = elapsed_sub_time (); int const r = remaining_time (); + auto day_of_week_to_string = [](boost::gregorian::greg_weekday d) -> std::string { + switch (d.as_enum()) { + case boost::date_time::Sunday: + return _("Sunday"); + case boost::date_time::Monday: + return _("Monday"); + case boost::date_time::Tuesday: + return _("Tuesday"); + case boost::date_time::Wednesday: + return _("Wednesday"); + case boost::date_time::Thursday: + return _("Thursday"); + case boost::date_time::Friday: + return _("Friday"); + case boost::date_time::Saturday: + return _("Saturday"); + } + + return d.as_long_string(); + }; + string s; if (!finished () && p) { int pc = lrintf (p.get() * 100); @@ -507,6 +599,7 @@ Job::status () const return s; } + string Job::json_status () const { @@ -531,6 +624,7 @@ Job::json_status () const return ""; } + /** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const @@ -542,21 +636,21 @@ Job::remaining_time () const return elapsed_sub_time() / progress().get() - elapsed_sub_time(); } + void Job::cancel () { - if (!_thread.joinable()) { - return; - } + if (_thread.joinable()) { + resume(); - if (paused_by_user() || paused_by_priority()) { - resume (); + _thread.interrupt (); + _thread.join (); } - _thread.interrupt (); - _thread.join (); + set_state (FINISHED_CANCELLED); } + /** @return true if the job was paused, false if it was not running */ bool Job::pause_by_user () @@ -580,6 +674,7 @@ Job::pause_by_user () return paused; } + void Job::pause_by_priority () { @@ -589,6 +684,7 @@ Job::pause_by_priority () } } + void Job::resume () { @@ -598,17 +694,19 @@ Job::resume () } } + void -Job::when_finished (boost::signals2::connection& connection, function finished) +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 (); + finished(state_to_result(_state)); } else { connection = Finished.connect (finished); } } + optional Job::message () const { @@ -616,6 +714,7 @@ Job::message () const return _message; } + void Job::set_message (string m) {