2 Copyright (C) 2012 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 <libdcp/exceptions.h>
35 using std::stringstream;
36 using boost::shared_ptr;
38 Job::Job (shared_ptr<Film> f)
43 , _progress_unknown (false)
49 /** Start the job in a separate thread, returning immediately */
54 _start_time = time (0);
55 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
58 /** A wrapper for the ::run() method to catch exceptions */
66 } catch (libdcp::FileError& e) {
69 set_state (FINISHED_ERROR);
71 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
74 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
75 if (s.available < pow (1024, 3)) {
77 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
83 set_error (e.what(), m);
85 } catch (boost::thread_interrupted &) {
87 set_state (FINISHED_CANCELLED);
89 } catch (std::exception& e) {
92 set_state (FINISHED_ERROR);
95 _("It is not known what caused this error. The best idea is to report the problem to the DCP-o-matic mailing list (dcpomatic@carlh.net)")
101 set_state (FINISHED_ERROR);
104 _("It is not known what caused this error. The best idea is to report the problem to the DCP-o-matic mailing list (dcpomatic@carlh.net)")
110 /** @return true if this job is new (ie has not started running) */
114 boost::mutex::scoped_lock lm (_state_mutex);
115 return _state == NEW;
118 /** @return true if the job is running */
120 Job::running () const
122 boost::mutex::scoped_lock lm (_state_mutex);
123 return _state == RUNNING;
126 /** @return true if the job has finished (either successfully or unsuccessfully) */
128 Job::finished () const
130 boost::mutex::scoped_lock lm (_state_mutex);
131 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
134 /** @return true if the job has finished successfully */
136 Job::finished_ok () const
138 boost::mutex::scoped_lock lm (_state_mutex);
139 return _state == FINISHED_OK;
142 /** @return true if the job has finished unsuccessfully */
144 Job::finished_in_error () const
146 boost::mutex::scoped_lock lm (_state_mutex);
147 return _state == FINISHED_ERROR;
151 Job::finished_cancelled () const
153 boost::mutex::scoped_lock lm (_state_mutex);
154 return _state == FINISHED_CANCELLED;
160 boost::mutex::scoped_lock lm (_state_mutex);
161 return _state == PAUSED;
164 /** Set the state of this job.
165 * @param s New state.
168 Job::set_state (State s)
170 boost::mutex::scoped_lock lm (_state_mutex);
173 if (_state == FINISHED_OK || _state == FINISHED_ERROR) {
174 _ran_for = elapsed_time ();
178 /** @return Time (in seconds) that this job has been running */
180 Job::elapsed_time () const
182 if (_start_time == 0) {
186 return time (0) - _start_time;
189 /** Set the progress of the current part of the job.
190 * @param p Progress (from 0 to 1)
193 Job::set_progress (float p)
195 boost::mutex::scoped_lock lm (_progress_mutex);
196 _progress_unknown = false;
197 _stack.back().normalised = p;
198 boost::this_thread::interruption_point ();
205 /** @return fractional overall progress, or -1 if not known */
207 Job::overall_progress () const
209 boost::mutex::scoped_lock lm (_progress_mutex);
210 if (_progress_unknown) {
216 for (list<Level>::const_iterator i = _stack.begin(); i != _stack.end(); ++i) {
217 factor *= i->allocation;
218 overall += i->normalised * factor;
228 /** Ascend up one level in terms of progress reporting; see descend() */
232 boost::mutex::scoped_lock lm (_progress_mutex);
234 assert (!_stack.empty ());
235 float const a = _stack.back().allocation;
237 _stack.back().normalised += a;
240 /** Descend down one level in terms of progress reporting; e.g. if
241 * there is a task which is split up into N subtasks, each of which
242 * report their progress from 0 to 100%, call descend() before executing
243 * each subtask, and ascend() afterwards to ensure that overall progress
244 * is reported correctly.
246 * @param a Fraction (from 0 to 1) of the current task to allocate to the subtask.
249 Job::descend (float a)
251 boost::mutex::scoped_lock lm (_progress_mutex);
252 _stack.push_back (Level (a));
256 Job::error_details () const
258 boost::mutex::scoped_lock lm (_state_mutex);
259 return _error_details;
262 /** @return A summary of any error that the job has generated */
264 Job::error_summary () const
266 boost::mutex::scoped_lock lm (_state_mutex);
267 return _error_summary;
270 /** Set the current error string.
271 * @param e New error string.
274 Job::set_error (string s, string d)
276 boost::mutex::scoped_lock lm (_state_mutex);
281 /** Say that this job's progress will be unknown until further notice */
283 Job::set_progress_unknown ()
285 boost::mutex::scoped_lock lm (_progress_mutex);
286 _progress_unknown = true;
289 /** @return Human-readable status of this job */
293 float const p = overall_progress ();
294 int const t = elapsed_time ();
295 int const r = remaining_time ();
297 int pc = rint (p * 100);
299 /* 100% makes it sound like we've finished when we haven't */
306 if (p >= 0 && t > 10 && r > 0) {
307 /// TRANSLATORS: remaining here follows an amount of time that is remaining
309 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
311 } else if (finished_ok ()) {
312 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
313 } else if (finished_in_error ()) {
314 s << String::compose (_("Error (%1)"), error_summary());
315 } else if (finished_cancelled ()) {
322 /** @return An estimate of the remaining time for this job, in seconds */
324 Job::remaining_time () const
326 return elapsed_time() / overall_progress() - elapsed_time();
336 _thread->interrupt ();