X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=8ce63ced0213d66ea2c03dce79bd3a29579562d0;hp=4c8199bdcc1b52294368b305f101238dd222f0c9;hb=345df3ae8254f25299c2fc2022b1143d444f9a56;hpb=5723d8d8518ad1cc0fef8bcc34a47671ab959fb3 diff --git a/src/lib/job.cc b/src/lib/job.cc index 4c8199bdc..8ce63ced0 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -18,35 +18,39 @@ */ + /** @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 "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 +63,7 @@ Job::Job (shared_ptr film) } + Job::~Job () { #ifdef DCPOMATIC_DEBUG @@ -67,6 +72,7 @@ Job::~Job () #endif } + void Job::stop_thread () { @@ -78,6 +84,7 @@ Job::stop_thread () } catch (...) {} } + /** Start the job in a separate thread, returning immediately */ void Job::start () @@ -91,6 +98,7 @@ Job::start () #endif } + /** A wrapper for the ::run() method to catch exceptions */ void Job::run_wrapper () @@ -191,9 +199,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 +235,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 +263,7 @@ Job::run_wrapper () } } + /** @return true if this job is new (ie has not started running) */ bool Job::is_new () const @@ -259,6 +272,7 @@ Job::is_new () const return _state == NEW; } + /** @return true if the job is running */ bool Job::running () const @@ -267,6 +281,7 @@ Job::running () const return _state == RUNNING; } + /** @return true if the job has finished (either successfully or unsuccessfully) */ bool Job::finished () const @@ -275,6 +290,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 +299,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 +308,7 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } + bool Job::finished_cancelled () const { @@ -298,6 +316,7 @@ Job::finished_cancelled () const return _state == FINISHED_CANCELLED; } + bool Job::paused_by_user () const { @@ -305,6 +324,7 @@ Job::paused_by_user () const return _state == PAUSED_BY_USER; } + bool Job::paused_by_priority () const { @@ -312,6 +332,7 @@ Job::paused_by_priority () const return _state == PAUSED_BY_PRIORITY; } + /** Set the state of this job. * @param s New state. */ @@ -337,6 +358,7 @@ Job::set_state (State s) } } + /** @return DCPTime (in seconds) that this sub-job has been running */ int Job::elapsed_sub_time () const @@ -348,6 +370,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 () @@ -403,6 +426,7 @@ Job::set_progress (float p, bool force) set_progress_common (p); } + void Job::set_progress_common (optional p) { @@ -414,6 +438,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 @@ -422,6 +447,7 @@ Job::progress () const return _progress; } + void Job::sub (string n) { @@ -435,6 +461,7 @@ Job::sub (string n) _sub_start_time = time (0); } + string Job::error_details () const { @@ -442,6 +469,7 @@ Job::error_details () const return _error_details; } + /** @return A summary of any error that the job has generated */ string Job::error_summary () const @@ -450,6 +478,7 @@ Job::error_summary () const return _error_summary; } + /** Set the current error string. * @param s New error string. * @param d New error detail string. @@ -466,6 +495,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 () @@ -474,6 +504,7 @@ Job::set_progress_unknown () set_progress_common (optional ()); } + /** @return Human-readable status of this job */ string Job::status () const @@ -523,6 +554,7 @@ Job::status () const return s; } + string Job::json_status () const { @@ -547,6 +579,7 @@ Job::json_status () const return ""; } + /** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const @@ -558,21 +591,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 () @@ -596,6 +629,7 @@ Job::pause_by_user () return paused; } + void Job::pause_by_priority () { @@ -605,6 +639,7 @@ Job::pause_by_priority () } } + void Job::resume () { @@ -614,6 +649,7 @@ Job::resume () } } + void Job::when_finished (boost::signals2::connection& connection, function finished) { @@ -625,6 +661,7 @@ Job::when_finished (boost::signals2::connection& connection, function fi } } + optional Job::message () const { @@ -632,6 +669,7 @@ Job::message () const return _message; } + void Job::set_message (string m) {