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 "ui_signaller.h"
31 #include "exceptions.h"
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> f)
56 /** Start the job in a separate thread, returning immediately */
61 _start_time = time (0);
62 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
65 /** A wrapper for the ::run() method to catch exceptions */
73 } catch (dcp::FileError& e) {
75 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
78 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
79 if (s.available < pow (1024, 3)) {
81 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
87 set_error (e.what(), m);
89 set_state (FINISHED_ERROR);
91 } catch (OpenFileError& e) {
94 String::compose (_("Could not open %1"), e.file().string()),
95 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())
99 set_state (FINISHED_ERROR);
101 } catch (boost::thread_interrupted &) {
103 set_state (FINISHED_CANCELLED);
105 } catch (std::bad_alloc& e) {
107 set_error (_("Out of memory"), _("There was not enough memory to do this."));
109 set_state (FINISHED_ERROR);
111 } catch (std::exception& e) {
115 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
119 set_state (FINISHED_ERROR);
125 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
129 set_state (FINISHED_ERROR);
133 /** @return true if this job is new (ie has not started running) */
137 boost::mutex::scoped_lock lm (_state_mutex);
138 return _state == NEW;
141 /** @return true if the job is running */
143 Job::running () const
145 boost::mutex::scoped_lock lm (_state_mutex);
146 return _state == RUNNING;
149 /** @return true if the job has finished (either successfully or unsuccessfully) */
151 Job::finished () const
153 boost::mutex::scoped_lock lm (_state_mutex);
154 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
157 /** @return true if the job has finished successfully */
159 Job::finished_ok () const
161 boost::mutex::scoped_lock lm (_state_mutex);
162 return _state == FINISHED_OK;
165 /** @return true if the job has finished unsuccessfully */
167 Job::finished_in_error () const
169 boost::mutex::scoped_lock lm (_state_mutex);
170 return _state == FINISHED_ERROR;
174 Job::finished_cancelled () const
176 boost::mutex::scoped_lock lm (_state_mutex);
177 return _state == FINISHED_CANCELLED;
183 boost::mutex::scoped_lock lm (_state_mutex);
184 return _state == PAUSED;
187 /** Set the state of this job.
188 * @param s New state.
191 Job::set_state (State s)
193 bool finished = false;
196 boost::mutex::scoped_lock lm (_state_mutex);
199 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
200 _ran_for = elapsed_time ();
206 if (finished && ui_signaller) {
207 ui_signaller->emit (boost::bind (boost::ref (Finished)));
211 /** @return DCPTime (in seconds) that this sub-job has been running */
213 Job::elapsed_time () const
215 if (_start_time == 0) {
219 return time (0) - _start_time;
222 /** Set the progress of the current part of the job.
223 * @param p Progress (from 0 to 1)
226 Job::set_progress (float p, bool force)
228 if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
229 /* Calm excessive progress reporting */
233 boost::mutex::scoped_lock lm (_progress_mutex);
235 boost::this_thread::interruption_point ();
237 boost::mutex::scoped_lock lm2 (_state_mutex);
238 while (_state == PAUSED) {
239 _pause_changed.wait (lm2);
243 ui_signaller->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);
305 ui_signaller->emit (boost::bind (boost::ref (Progress)));
309 /** @return Human-readable status of this job */
313 optional<float> p = progress ();
314 int const t = elapsed_time ();
315 int const r = remaining_time ();
318 if (!finished () && p) {
319 int pc = rint (p.get() * 100);
321 /* 100% makes it sound like we've finished when we haven't */
327 if (t > 10 && r > 0) {
328 /// TRANSLATORS: remaining here follows an amount of time that is remaining
330 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
332 } else if (finished_ok ()) {
333 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
334 } else if (finished_in_error ()) {
335 s << String::compose (_("Error (%1)"), error_summary ());
336 } else if (finished_cancelled ()) {
344 Job::json_status () const
346 boost::mutex::scoped_lock lm (_state_mutex);
352 return N_("running");
356 return N_("finished_ok");
358 return N_("finished_error");
359 case FINISHED_CANCELLED:
360 return N_("finished_cancelled");
366 /** @return An estimate of the remaining time for this sub-job, in seconds */
368 Job::remaining_time () const
370 if (progress().get_value_or(0) == 0) {
371 return elapsed_time ();
374 return elapsed_time() / progress().get() - elapsed_time();
384 _thread->interrupt ();
393 _pause_changed.notify_all ();
402 _pause_changed.notify_all ();