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.
27 #include "exceptions.h"
30 #include "compose.hpp"
31 #include <dcp/exceptions.h>
32 #include <boost/thread.hpp>
33 #include <boost/filesystem.hpp>
40 using boost::shared_ptr;
41 using boost::optional;
43 #define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
45 Job::Job (shared_ptr<const Film> film)
59 _thread->interrupt ();
66 /** Start the job in a separate thread, returning immediately */
71 _start_time = time (0);
72 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
75 /** A wrapper for the ::run() method to catch exceptions */
83 } catch (dcp::FileError& e) {
85 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
88 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
89 if (s.available < pow (1024, 3)) {
91 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
97 set_error (e.what(), m);
99 set_state (FINISHED_ERROR);
101 } catch (OpenFileError& e) {
104 String::compose (_("Could not open %1"), e.file().string()),
105 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())
109 set_state (FINISHED_ERROR);
111 } catch (boost::filesystem::filesystem_error& e) {
113 if (e.code() == boost::system::errc::no_such_file_or_directory) {
115 String::compose (_("Could not open %1"), e.path1().string ()),
116 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())
121 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
126 set_state (FINISHED_ERROR);
128 } catch (boost::thread_interrupted &) {
130 set_state (FINISHED_CANCELLED);
132 } catch (std::bad_alloc& e) {
134 set_error (_("Out of memory"), _("There was not enough memory to do this."));
136 set_state (FINISHED_ERROR);
138 } catch (std::exception& e) {
142 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
146 set_state (FINISHED_ERROR);
152 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
156 set_state (FINISHED_ERROR);
160 /** @return true if this job is new (ie has not started running) */
164 boost::mutex::scoped_lock lm (_state_mutex);
165 return _state == NEW;
168 /** @return true if the job is running */
170 Job::running () const
172 boost::mutex::scoped_lock lm (_state_mutex);
173 return _state == RUNNING;
176 /** @return true if the job has finished (either successfully or unsuccessfully) */
178 Job::finished () const
180 boost::mutex::scoped_lock lm (_state_mutex);
181 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
184 /** @return true if the job has finished successfully */
186 Job::finished_ok () const
188 boost::mutex::scoped_lock lm (_state_mutex);
189 return _state == FINISHED_OK;
192 /** @return true if the job has finished unsuccessfully */
194 Job::finished_in_error () const
196 boost::mutex::scoped_lock lm (_state_mutex);
197 return _state == FINISHED_ERROR;
201 Job::finished_cancelled () const
203 boost::mutex::scoped_lock lm (_state_mutex);
204 return _state == FINISHED_CANCELLED;
210 boost::mutex::scoped_lock lm (_state_mutex);
211 return _state == PAUSED;
214 /** Set the state of this job.
215 * @param s New state.
218 Job::set_state (State s)
220 bool finished = false;
223 boost::mutex::scoped_lock lm (_state_mutex);
226 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
227 _ran_for = elapsed_time ();
234 emit (boost::bind (boost::ref (Finished)));
238 /** @return DCPTime (in seconds) that this sub-job has been running */
240 Job::elapsed_time () const
242 if (_start_time == 0) {
246 return time (0) - _start_time;
249 /** Set the progress of the current part of the job.
250 * @param p Progress (from 0 to 1)
253 Job::set_progress (float p, bool force)
255 if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
256 /* Calm excessive progress reporting */
260 set_progress_common (p);
264 Job::set_progress_common (optional<float> p)
266 boost::mutex::scoped_lock lm (_progress_mutex);
268 boost::this_thread::interruption_point ();
270 boost::mutex::scoped_lock lm2 (_state_mutex);
271 while (_state == PAUSED) {
272 _pause_changed.wait (lm2);
278 emit (boost::bind (boost::ref (Progress)));
281 /** @return fractional progress of the current sub-job, if known */
283 Job::progress () const
285 boost::mutex::scoped_lock lm (_progress_mutex);
293 boost::mutex::scoped_lock lm (_progress_mutex);
297 set_progress (0, true);
301 Job::error_details () const
303 boost::mutex::scoped_lock lm (_state_mutex);
304 return _error_details;
307 /** @return A summary of any error that the job has generated */
309 Job::error_summary () const
311 boost::mutex::scoped_lock lm (_state_mutex);
312 return _error_summary;
315 /** Set the current error string.
316 * @param e New error string.
319 Job::set_error (string s, string d)
324 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
325 boost::mutex::scoped_lock lm (_state_mutex);
330 /** Say that this job's progress will be unknown until further notice */
332 Job::set_progress_unknown ()
334 set_progress_common (optional<float> ());
337 /** @return Human-readable status of this job */
341 optional<float> p = progress ();
342 int const t = elapsed_time ();
343 int const r = remaining_time ();
346 if (!finished () && p) {
347 int pc = lrintf (p.get() * 100);
349 /* 100% makes it sound like we've finished when we haven't */
355 if (t > 10 && r > 0) {
356 /// TRANSLATORS: remaining here follows an amount of time that is remaining
358 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
360 } else if (finished_ok ()) {
361 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
362 } else if (finished_in_error ()) {
363 s << String::compose (_("Error: %1"), error_summary ());
364 } else if (finished_cancelled ()) {
372 Job::json_status () const
374 boost::mutex::scoped_lock lm (_state_mutex);
380 return N_("running");
384 return N_("finished_ok");
386 return N_("finished_error");
387 case FINISHED_CANCELLED:
388 return N_("finished_cancelled");
394 /** @return An estimate of the remaining time for this sub-job, in seconds */
396 Job::remaining_time () const
398 if (progress().get_value_or(0) == 0) {
399 return elapsed_time ();
402 return elapsed_time() / progress().get() - elapsed_time();
416 _thread->interrupt ();
425 _pause_changed.notify_all ();
434 _pause_changed.notify_all ();