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>
32 using std::stringstream;
33 using boost::shared_ptr;
35 /** @param s Film that we are operating on.
36 * @param req Job that must be completed before this job is run.
38 Job::Job (shared_ptr<Film> f, shared_ptr<Job> req)
43 , _progress_unknown (false)
49 /** Start the job in a separate thread, returning immediately */
54 _start_time = time (0);
55 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());
73 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
74 if (s.available < pow (1024, 3)) {
75 m += "\n\nThe drive that the film is stored on is low in disc space. Free some more space and try again.";
78 set_error (e.what(), m);
80 } catch (std::exception& e) {
83 set_state (FINISHED_ERROR);
86 "It is not known what caused this error. The best idea is to report the problem to the DVD-o-matic mailing list (dvdomatic@carlh.net)"
92 set_state (FINISHED_ERROR);
95 "It is not known what caused this error. The best idea is to report the problem to the DVD-o-matic mailing list (dvdomatic@carlh.net)"
101 /** @return true if this job is new (ie has not started running) */
105 boost::mutex::scoped_lock lm (_state_mutex);
106 return _state == NEW;
109 /** @return true if the job is running */
111 Job::running () const
113 boost::mutex::scoped_lock lm (_state_mutex);
114 return _state == RUNNING;
117 /** @return true if the job has finished (either successfully or unsuccessfully) */
119 Job::finished () const
121 boost::mutex::scoped_lock lm (_state_mutex);
122 return _state == FINISHED_OK || _state == FINISHED_ERROR;
125 /** @return true if the job has finished successfully */
127 Job::finished_ok () const
129 boost::mutex::scoped_lock lm (_state_mutex);
130 return _state == FINISHED_OK;
133 /** @return true if the job has finished unsuccessfully */
135 Job::finished_in_error () const
137 boost::mutex::scoped_lock lm (_state_mutex);
138 return _state == FINISHED_ERROR;
141 /** Set the state of this job.
142 * @param s New state.
145 Job::set_state (State s)
147 boost::mutex::scoped_lock lm (_state_mutex);
150 if (_state == FINISHED_OK || _state == FINISHED_ERROR) {
151 _ran_for = elapsed_time ();
156 /** @return Time (in seconds) that this job has been running */
158 Job::elapsed_time () const
160 if (_start_time == 0) {
164 return time (0) - _start_time;
167 /** Set the progress of the current part of the job.
168 * @param p Progress (from 0 to 1)
171 Job::set_progress (float p)
173 boost::mutex::scoped_lock lm (_progress_mutex);
174 _progress_unknown = false;
175 _stack.back().normalised = p;
178 /** @return fractional overall progress, or -1 if not known */
180 Job::overall_progress () const
182 boost::mutex::scoped_lock lm (_progress_mutex);
183 if (_progress_unknown) {
189 for (list<Level>::const_iterator i = _stack.begin(); i != _stack.end(); ++i) {
190 factor *= i->allocation;
191 overall += i->normalised * factor;
201 /** Ascend up one level in terms of progress reporting; see descend() */
205 boost::mutex::scoped_lock lm (_progress_mutex);
207 assert (!_stack.empty ());
208 float const a = _stack.back().allocation;
210 _stack.back().normalised += a;
213 /** Descend down one level in terms of progress reporting; e.g. if
214 * there is a task which is split up into N subtasks, each of which
215 * report their progress from 0 to 100%, call descend() before executing
216 * each subtask, and ascend() afterwards to ensure that overall progress
217 * is reported correctly.
219 * @param a Fraction (from 0 to 1) of the current task to allocate to the subtask.
222 Job::descend (float a)
224 boost::mutex::scoped_lock lm (_progress_mutex);
225 _stack.push_back (Level (a));
229 Job::error_details () const
231 boost::mutex::scoped_lock lm (_state_mutex);
232 return _error_details;
235 /** @return A summary of any error that the job has generated */
237 Job::error_summary () const
239 boost::mutex::scoped_lock lm (_state_mutex);
240 return _error_summary;
243 /** Set the current error string.
244 * @param e New error string.
247 Job::set_error (string s, string d)
249 boost::mutex::scoped_lock lm (_state_mutex);
254 /** Say that this job's progress will be unknown until further notice */
256 Job::set_progress_unknown ()
258 boost::mutex::scoped_lock lm (_progress_mutex);
259 _progress_unknown = true;
262 /** @return Human-readable status of this job */
266 float const p = overall_progress ();
267 int const t = elapsed_time ();
268 int const r = remaining_time ();
271 if (!finished () && p >= 0 && t > 10 && r > 0) {
272 s << rint (p * 100) << "%; " << seconds_to_approximate_hms (r) << " remaining";
273 } else if (!finished () && (t <= 10 || r == 0)) {
274 s << rint (p * 100) << "%";
275 } else if (finished_ok ()) {
276 s << "OK (ran for " << seconds_to_hms (_ran_for) << ")";
277 } else if (finished_in_error ()) {
278 s << "Error (" << error_summary() << ")";
284 /** @return An estimate of the remaining time for this job, in seconds */
286 Job::remaining_time () const
288 return elapsed_time() / overall_progress() - elapsed_time();