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;
42 using boost::function;
44 #define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
46 Job::Job (shared_ptr<const Film> film)
60 _thread->interrupt ();
67 /** Start the job in a separate thread, returning immediately */
72 _start_time = time (0);
73 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
76 /** A wrapper for the ::run() method to catch exceptions */
84 } catch (dcp::FileError& e) {
86 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
89 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
90 if (s.available < pow (1024, 3)) {
92 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
98 set_error (e.what(), m);
100 set_state (FINISHED_ERROR);
102 } catch (OpenFileError& e) {
105 String::compose (_("Could not open %1"), e.file().string()),
106 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())
110 set_state (FINISHED_ERROR);
112 } catch (boost::filesystem::filesystem_error& e) {
114 if (e.code() == boost::system::errc::no_such_file_or_directory) {
116 String::compose (_("Could not open %1"), e.path1().string ()),
117 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())
122 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
127 set_state (FINISHED_ERROR);
129 } catch (boost::thread_interrupted &) {
131 set_state (FINISHED_CANCELLED);
133 } catch (std::bad_alloc& e) {
135 set_error (_("Out of memory"), _("There was not enough memory to do this."));
137 set_state (FINISHED_ERROR);
139 } catch (std::exception& e) {
143 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
147 set_state (FINISHED_ERROR);
153 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
157 set_state (FINISHED_ERROR);
161 /** @return true if this job is new (ie has not started running) */
165 boost::mutex::scoped_lock lm (_state_mutex);
166 return _state == NEW;
169 /** @return true if the job is running */
171 Job::running () const
173 boost::mutex::scoped_lock lm (_state_mutex);
174 return _state == RUNNING;
177 /** @return true if the job has finished (either successfully or unsuccessfully) */
179 Job::finished () const
181 boost::mutex::scoped_lock lm (_state_mutex);
182 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
185 /** @return true if the job has finished successfully */
187 Job::finished_ok () const
189 boost::mutex::scoped_lock lm (_state_mutex);
190 return _state == FINISHED_OK;
193 /** @return true if the job has finished unsuccessfully */
195 Job::finished_in_error () const
197 boost::mutex::scoped_lock lm (_state_mutex);
198 return _state == FINISHED_ERROR;
202 Job::finished_cancelled () const
204 boost::mutex::scoped_lock lm (_state_mutex);
205 return _state == FINISHED_CANCELLED;
211 boost::mutex::scoped_lock lm (_state_mutex);
212 return _state == PAUSED;
215 /** Set the state of this job.
216 * @param s New state.
219 Job::set_state (State s)
221 bool finished = false;
224 boost::mutex::scoped_lock lm (_state_mutex);
227 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
228 _ran_for = elapsed_time ();
235 emit (boost::bind (boost::ref (Finished)));
239 /** @return DCPTime (in seconds) that this sub-job has been running */
241 Job::elapsed_time () const
243 if (_start_time == 0) {
247 return time (0) - _start_time;
250 /** Set the progress of the current part of the job.
251 * @param p Progress (from 0 to 1)
254 Job::set_progress (float p, bool force)
256 if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
257 /* Calm excessive progress reporting */
261 set_progress_common (p);
265 Job::set_progress_common (optional<float> p)
267 boost::mutex::scoped_lock lm (_progress_mutex);
269 boost::this_thread::interruption_point ();
271 boost::mutex::scoped_lock lm2 (_state_mutex);
272 while (_state == PAUSED) {
273 _pause_changed.wait (lm2);
279 emit (boost::bind (boost::ref (Progress)));
282 /** @return fractional progress of the current sub-job, if known */
284 Job::progress () const
286 boost::mutex::scoped_lock lm (_progress_mutex);
294 boost::mutex::scoped_lock lm (_progress_mutex);
298 set_progress (0, true);
302 Job::error_details () const
304 boost::mutex::scoped_lock lm (_state_mutex);
305 return _error_details;
308 /** @return A summary of any error that the job has generated */
310 Job::error_summary () const
312 boost::mutex::scoped_lock lm (_state_mutex);
313 return _error_summary;
316 /** Set the current error string.
317 * @param e New error string.
320 Job::set_error (string s, string d)
325 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
326 boost::mutex::scoped_lock lm (_state_mutex);
331 /** Say that this job's progress will be unknown until further notice */
333 Job::set_progress_unknown ()
335 set_progress_common (optional<float> ());
338 /** @return Human-readable status of this job */
342 optional<float> p = progress ();
343 int const t = elapsed_time ();
344 int const r = remaining_time ();
347 if (!finished () && p) {
348 int pc = lrintf (p.get() * 100);
350 /* 100% makes it sound like we've finished when we haven't */
356 if (t > 10 && r > 0) {
357 /// TRANSLATORS: remaining here follows an amount of time that is remaining
359 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
361 } else if (finished_ok ()) {
362 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
363 } else if (finished_in_error ()) {
364 s << String::compose (_("Error: %1"), error_summary ());
365 } else if (finished_cancelled ()) {
373 Job::json_status () const
375 boost::mutex::scoped_lock lm (_state_mutex);
381 return N_("running");
385 return N_("finished_ok");
387 return N_("finished_error");
388 case FINISHED_CANCELLED:
389 return N_("finished_cancelled");
395 /** @return An estimate of the remaining time for this sub-job, in seconds */
397 Job::remaining_time () const
399 if (progress().get_value_or(0) == 0) {
400 return elapsed_time ();
403 return elapsed_time() / progress().get() - elapsed_time();
417 _thread->interrupt ();
426 _pause_changed.notify_all ();
435 _pause_changed.notify_all ();
440 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
442 boost::mutex::scoped_lock lm (_state_mutex);
443 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
446 connection = Finished.connect (finished);