2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A parent class to represent long-running tasks which are run in their own thread.
24 #include <boost/thread.hpp>
25 #include <boost/filesystem.hpp>
26 #include <dcp/exceptions.h>
30 #include "exceptions.h"
39 using boost::shared_ptr;
40 using boost::optional;
42 #define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
44 Job::Job (shared_ptr<const Film> f)
55 /** Start the job in a separate thread, returning immediately */
60 _start_time = time (0);
61 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
64 /** A wrapper for the ::run() method to catch exceptions */
72 } catch (dcp::FileError& e) {
74 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
77 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
78 if (s.available < pow (1024, 3)) {
80 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
86 set_error (e.what(), m);
88 set_state (FINISHED_ERROR);
90 } catch (OpenFileError& e) {
93 String::compose (_("Could not open %1"), e.file().string()),
94 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())
98 set_state (FINISHED_ERROR);
100 } catch (boost::thread_interrupted &) {
102 set_state (FINISHED_CANCELLED);
104 } catch (std::bad_alloc& e) {
106 set_error (_("Out of memory"), _("There was not enough memory to do this."));
108 set_state (FINISHED_ERROR);
110 } catch (std::exception& e) {
114 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
118 set_state (FINISHED_ERROR);
124 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
128 set_state (FINISHED_ERROR);
132 /** @return true if this job is new (ie has not started running) */
136 boost::mutex::scoped_lock lm (_state_mutex);
137 return _state == NEW;
140 /** @return true if the job is running */
142 Job::running () const
144 boost::mutex::scoped_lock lm (_state_mutex);
145 return _state == RUNNING;
148 /** @return true if the job has finished (either successfully or unsuccessfully) */
150 Job::finished () const
152 boost::mutex::scoped_lock lm (_state_mutex);
153 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
156 /** @return true if the job has finished successfully */
158 Job::finished_ok () const
160 boost::mutex::scoped_lock lm (_state_mutex);
161 return _state == FINISHED_OK;
164 /** @return true if the job has finished unsuccessfully */
166 Job::finished_in_error () const
168 boost::mutex::scoped_lock lm (_state_mutex);
169 return _state == FINISHED_ERROR;
173 Job::finished_cancelled () const
175 boost::mutex::scoped_lock lm (_state_mutex);
176 return _state == FINISHED_CANCELLED;
182 boost::mutex::scoped_lock lm (_state_mutex);
183 return _state == PAUSED;
186 /** Set the state of this job.
187 * @param s New state.
190 Job::set_state (State s)
192 bool finished = false;
195 boost::mutex::scoped_lock lm (_state_mutex);
198 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
199 _ran_for = elapsed_time ();
206 emit (boost::bind (boost::ref (Finished)));
210 /** @return DCPTime (in seconds) that this sub-job has been running */
212 Job::elapsed_time () const
214 if (_start_time == 0) {
218 return time (0) - _start_time;
221 /** Set the progress of the current part of the job.
222 * @param p Progress (from 0 to 1)
225 Job::set_progress (float p, bool force)
227 if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
228 /* Calm excessive progress reporting */
232 boost::mutex::scoped_lock lm (_progress_mutex);
234 boost::this_thread::interruption_point ();
236 boost::mutex::scoped_lock lm2 (_state_mutex);
237 while (_state == PAUSED) {
238 _pause_changed.wait (lm2);
244 emit (boost::bind (boost::ref (Progress)));
247 /** @return fractional progress of the current sub-job, if known */
249 Job::progress () const
251 boost::mutex::scoped_lock lm (_progress_mutex);
259 boost::mutex::scoped_lock lm (_progress_mutex);
263 set_progress (0, true);
267 Job::error_details () const
269 boost::mutex::scoped_lock lm (_state_mutex);
270 return _error_details;
273 /** @return A summary of any error that the job has generated */
275 Job::error_summary () const
277 boost::mutex::scoped_lock lm (_state_mutex);
278 return _error_summary;
281 /** Set the current error string.
282 * @param e New error string.
285 Job::set_error (string s, string d)
290 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
291 boost::mutex::scoped_lock lm (_state_mutex);
296 /** Say that this job's progress will be unknown until further notice */
298 Job::set_progress_unknown ()
300 boost::mutex::scoped_lock lm (_progress_mutex);
304 emit (boost::bind (boost::ref (Progress)));
307 /** @return Human-readable status of this job */
311 optional<float> p = progress ();
312 int const t = elapsed_time ();
313 int const r = remaining_time ();
316 if (!finished () && p) {
317 int pc = rint (p.get() * 100);
319 /* 100% makes it sound like we've finished when we haven't */
325 if (t > 10 && r > 0) {
326 /// TRANSLATORS: remaining here follows an amount of time that is remaining
328 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
330 } else if (finished_ok ()) {
331 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
332 } else if (finished_in_error ()) {
333 s << String::compose (_("Error (%1)"), error_summary ());
334 } else if (finished_cancelled ()) {
342 Job::json_status () const
344 boost::mutex::scoped_lock lm (_state_mutex);
350 return N_("running");
354 return N_("finished_ok");
356 return N_("finished_error");
357 case FINISHED_CANCELLED:
358 return N_("finished_cancelled");
364 /** @return An estimate of the remaining time for this sub-job, in seconds */
366 Job::remaining_time () const
368 if (progress().get_value_or(0) == 0) {
369 return elapsed_time ();
372 return elapsed_time() / progress().get() - elapsed_time();
386 _thread->interrupt ();
395 _pause_changed.notify_all ();
404 _pause_changed.notify_all ();