2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A parent class to represent long-running tasks which are run in their own thread.
28 #include "exceptions.h"
31 #include "compose.hpp"
32 #include <dcp/exceptions.h>
33 #include <sub/exceptions.h>
34 #include <boost/thread.hpp>
35 #include <boost/filesystem.hpp>
36 #include <boost/foreach.hpp>
37 #include <boost/date_time/posix_time/posix_time.hpp>
45 using boost::shared_ptr;
46 using boost::optional;
47 using boost::function;
49 #define LOG_ERROR_NC(...) if (_film) { _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR); }
50 #define LOG_GENERAL(...) if (_film) { _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); }
52 /** @param film Associated film, or 0 */
53 Job::Job (shared_ptr<const Film> film)
68 _thread->interrupt ();
69 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
70 if (_thread->joinable ()) {
74 /* Too late to do anything about this */
82 /** Start the job in a separate thread, returning immediately */
87 _start_time = time (0);
88 _sub_start_time = time (0);
89 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
92 /** A wrapper for the ::run() method to catch exceptions */
100 } catch (dcp::FileError& e) {
102 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
105 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
106 if (s.available < pow (1024, 3)) {
108 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
114 set_error (e.what(), m);
116 set_state (FINISHED_ERROR);
118 } catch (OpenFileError& e) {
121 String::compose (_("Could not open %1"), e.file().string()),
123 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
124 boost::filesystem::absolute (e.file()).string(),
130 set_state (FINISHED_ERROR);
132 } catch (boost::filesystem::filesystem_error& e) {
134 if (e.code() == boost::system::errc::no_such_file_or_directory) {
136 String::compose (_("Could not open %1"), e.path1().string ()),
138 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
139 boost::filesystem::absolute (e.path1()).string(),
146 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
151 set_state (FINISHED_ERROR);
153 } catch (boost::thread_interrupted &) {
155 set_state (FINISHED_CANCELLED);
157 } catch (sub::SubripError& e) {
159 string extra = "Error is near:\n";
160 BOOST_FOREACH (string i, e.context()) {
164 set_error (e.what (), extra);
166 set_state (FINISHED_ERROR);
168 } catch (std::bad_alloc& e) {
170 set_error (_("Out of memory"), _("There was not enough memory to do this. If you are running a 32-bit operating system try reducing the number of encoding threads in the General tab of Preferences."));
172 set_state (FINISHED_ERROR);
174 } catch (std::exception& e) {
178 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
182 set_state (FINISHED_ERROR);
188 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
192 set_state (FINISHED_ERROR);
196 /** @return true if this job is new (ie has not started running) */
200 boost::mutex::scoped_lock lm (_state_mutex);
201 return _state == NEW;
204 /** @return true if the job is running */
206 Job::running () const
208 boost::mutex::scoped_lock lm (_state_mutex);
209 return _state == RUNNING;
212 /** @return true if the job has finished (either successfully or unsuccessfully) */
214 Job::finished () const
216 boost::mutex::scoped_lock lm (_state_mutex);
217 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
220 /** @return true if the job has finished successfully */
222 Job::finished_ok () const
224 boost::mutex::scoped_lock lm (_state_mutex);
225 return _state == FINISHED_OK;
228 /** @return true if the job has finished unsuccessfully */
230 Job::finished_in_error () const
232 boost::mutex::scoped_lock lm (_state_mutex);
233 return _state == FINISHED_ERROR;
237 Job::finished_cancelled () const
239 boost::mutex::scoped_lock lm (_state_mutex);
240 return _state == FINISHED_CANCELLED;
244 Job::paused_by_user () const
246 boost::mutex::scoped_lock lm (_state_mutex);
247 return _state == PAUSED_BY_USER;
251 Job::paused_by_priority () const
253 boost::mutex::scoped_lock lm (_state_mutex);
254 return _state == PAUSED_BY_PRIORITY;
257 /** Set the state of this job.
258 * @param s New state.
261 Job::set_state (State s)
263 bool finished = false;
266 boost::mutex::scoped_lock lm (_state_mutex);
269 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
270 _ran_for = time(0) - _start_time;
277 emit (boost::bind (boost::ref (Finished)));
281 /** @return DCPTime (in seconds) that this sub-job has been running */
283 Job::elapsed_sub_time () const
285 if (_sub_start_time == 0) {
289 return time (0) - _sub_start_time;
292 /** Check to see if this job has been interrupted or paused */
294 Job::check_for_interruption_or_pause ()
296 boost::this_thread::interruption_point ();
298 boost::mutex::scoped_lock lm (_state_mutex);
299 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
300 emit (boost::bind (boost::ref (Progress)));
301 _pause_changed.wait (lm);
305 /** Set the progress of the current part of the job.
306 * @param p Progress (from 0 to 1)
307 * @param force Do not ignore this update, even if it hasn't been long since the last one.
310 Job::set_progress (float p, bool force)
312 check_for_interruption_or_pause ();
315 /* Check for excessively frequent progress reporting */
316 boost::mutex::scoped_lock lm (_progress_mutex);
318 gettimeofday (&now, 0);
319 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
320 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
321 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
326 _last_progress_update = now;
329 set_progress_common (p);
333 Job::set_progress_common (optional<float> p)
336 boost::mutex::scoped_lock lm (_progress_mutex);
340 emit (boost::bind (boost::ref (Progress)));
343 /** @return fractional progress of the current sub-job, if known */
345 Job::progress () const
347 boost::mutex::scoped_lock lm (_progress_mutex);
355 boost::mutex::scoped_lock lm (_progress_mutex);
356 LOG_GENERAL ("Sub-job %1 starting", n);
360 set_progress (0, true);
361 _sub_start_time = time (0);
365 Job::error_details () const
367 boost::mutex::scoped_lock lm (_state_mutex);
368 return _error_details;
371 /** @return A summary of any error that the job has generated */
373 Job::error_summary () const
375 boost::mutex::scoped_lock lm (_state_mutex);
376 return _error_summary;
379 /** Set the current error string.
380 * @param s New error string.
381 * @param d New error detail string.
384 Job::set_error (string s, string d)
389 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
392 boost::mutex::scoped_lock lm (_state_mutex);
397 /** Say that this job's progress will be unknown until further notice */
399 Job::set_progress_unknown ()
401 check_for_interruption_or_pause ();
402 set_progress_common (optional<float> ());
405 /** @return Human-readable status of this job */
409 optional<float> p = progress ();
410 int const t = elapsed_sub_time ();
411 int const r = remaining_time ();
414 if (!finished () && p) {
415 int pc = lrintf (p.get() * 100);
417 /* 100% makes it sound like we've finished when we haven't */
422 snprintf (buffer, sizeof(buffer), "%d%%", pc);
425 if (t > 10 && r > 0) {
426 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
427 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
428 char finish_string[16];
429 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
431 if (now.date() != finish.date()) {
432 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
433 /// to say what day a job will finish.
434 day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
436 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
437 /// on an operation; after it is an estimated wall-clock completion time.
438 s += String::compose(
439 _("; %1 remaining; finishing at %2%3"),
440 seconds_to_approximate_hms(r), finish_string, day
443 } else if (finished_ok ()) {
444 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
445 } else if (finished_in_error ()) {
446 s = String::compose (_("Error: %1"), error_summary ());
447 } else if (finished_cancelled ()) {
455 Job::json_status () const
457 boost::mutex::scoped_lock lm (_state_mutex);
463 return N_("running");
465 case PAUSED_BY_PRIORITY:
468 return N_("finished_ok");
470 return N_("finished_error");
471 case FINISHED_CANCELLED:
472 return N_("finished_cancelled");
478 /** @return An estimate of the remaining time for this sub-job, in seconds */
480 Job::remaining_time () const
482 if (progress().get_value_or(0) == 0) {
483 return elapsed_sub_time ();
486 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
496 if (paused_by_user() || paused_by_priority()) {
500 _thread->interrupt ();
501 DCPOMATIC_ASSERT (_thread->joinable ());
508 Job::pause_by_user ()
511 set_state (PAUSED_BY_USER);
512 _pause_changed.notify_all ();
517 Job::pause_by_priority ()
520 set_state (PAUSED_BY_PRIORITY);
521 _pause_changed.notify_all ();
528 if (paused_by_user() || paused_by_priority()) {
530 _pause_changed.notify_all ();
535 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
537 boost::mutex::scoped_lock lm (_state_mutex);
538 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
541 connection = Finished.connect (finished);