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. Perhaps it does not exist or is in an unexpected format."),
124 boost::filesystem::absolute (e.file()).string()
129 set_state (FINISHED_ERROR);
131 } catch (boost::filesystem::filesystem_error& e) {
133 if (e.code() == boost::system::errc::no_such_file_or_directory) {
135 String::compose (_("Could not open %1"), e.path1().string ()),
137 _("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."),
138 boost::filesystem::absolute (e.path1()).string()
144 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
149 set_state (FINISHED_ERROR);
151 } catch (boost::thread_interrupted &) {
153 set_state (FINISHED_CANCELLED);
155 } catch (sub::SubripError& e) {
157 string extra = "Error is near:\n";
158 BOOST_FOREACH (string i, e.context()) {
162 set_error (e.what (), extra);
164 set_state (FINISHED_ERROR);
166 } catch (std::bad_alloc& e) {
168 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."));
170 set_state (FINISHED_ERROR);
172 } catch (std::exception& e) {
176 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
180 set_state (FINISHED_ERROR);
186 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
190 set_state (FINISHED_ERROR);
194 /** @return true if this job is new (ie has not started running) */
198 boost::mutex::scoped_lock lm (_state_mutex);
199 return _state == NEW;
202 /** @return true if the job is running */
204 Job::running () const
206 boost::mutex::scoped_lock lm (_state_mutex);
207 return _state == RUNNING;
210 /** @return true if the job has finished (either successfully or unsuccessfully) */
212 Job::finished () const
214 boost::mutex::scoped_lock lm (_state_mutex);
215 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
218 /** @return true if the job has finished successfully */
220 Job::finished_ok () const
222 boost::mutex::scoped_lock lm (_state_mutex);
223 return _state == FINISHED_OK;
226 /** @return true if the job has finished unsuccessfully */
228 Job::finished_in_error () const
230 boost::mutex::scoped_lock lm (_state_mutex);
231 return _state == FINISHED_ERROR;
235 Job::finished_cancelled () const
237 boost::mutex::scoped_lock lm (_state_mutex);
238 return _state == FINISHED_CANCELLED;
242 Job::paused_by_user () const
244 boost::mutex::scoped_lock lm (_state_mutex);
245 return _state == PAUSED_BY_USER;
249 Job::paused_by_priority () const
251 boost::mutex::scoped_lock lm (_state_mutex);
252 return _state == PAUSED_BY_PRIORITY;
255 /** Set the state of this job.
256 * @param s New state.
259 Job::set_state (State s)
261 bool finished = false;
264 boost::mutex::scoped_lock lm (_state_mutex);
267 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
268 _ran_for = time(0) - _start_time;
275 emit (boost::bind (boost::ref (Finished)));
279 /** @return DCPTime (in seconds) that this sub-job has been running */
281 Job::elapsed_sub_time () const
283 if (_sub_start_time == 0) {
287 return time (0) - _sub_start_time;
290 /** Check to see if this job has been interrupted or paused */
292 Job::check_for_interruption_or_pause ()
294 boost::this_thread::interruption_point ();
296 boost::mutex::scoped_lock lm (_state_mutex);
297 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
298 emit (boost::bind (boost::ref (Progress)));
299 _pause_changed.wait (lm);
303 /** Set the progress of the current part of the job.
304 * @param p Progress (from 0 to 1)
307 Job::set_progress (float p, bool force)
309 check_for_interruption_or_pause ();
312 /* Check for excessively frequent progress reporting */
313 boost::mutex::scoped_lock lm (_progress_mutex);
315 gettimeofday (&now, 0);
316 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
317 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
318 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
323 _last_progress_update = now;
326 set_progress_common (p);
330 Job::set_progress_common (optional<float> p)
333 boost::mutex::scoped_lock lm (_progress_mutex);
337 emit (boost::bind (boost::ref (Progress)));
340 /** @return fractional progress of the current sub-job, if known */
342 Job::progress () const
344 boost::mutex::scoped_lock lm (_progress_mutex);
352 boost::mutex::scoped_lock lm (_progress_mutex);
353 LOG_GENERAL ("Sub-job %1 starting", n);
357 set_progress (0, true);
358 _sub_start_time = time (0);
362 Job::error_details () const
364 boost::mutex::scoped_lock lm (_state_mutex);
365 return _error_details;
368 /** @return A summary of any error that the job has generated */
370 Job::error_summary () const
372 boost::mutex::scoped_lock lm (_state_mutex);
373 return _error_summary;
376 /** Set the current error string.
377 * @param e New error string.
380 Job::set_error (string s, string d)
385 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
388 boost::mutex::scoped_lock lm (_state_mutex);
393 /** Say that this job's progress will be unknown until further notice */
395 Job::set_progress_unknown ()
397 check_for_interruption_or_pause ();
398 set_progress_common (optional<float> ());
401 /** @return Human-readable status of this job */
405 optional<float> p = progress ();
406 int const t = elapsed_sub_time ();
407 int const r = remaining_time ();
410 if (!finished () && p) {
411 int pc = lrintf (p.get() * 100);
413 /* 100% makes it sound like we've finished when we haven't */
418 snprintf (buffer, sizeof(buffer), "%d%%", pc);
421 if (t > 10 && r > 0) {
422 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
423 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
424 char finish_string[6];
425 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", finish.time_of_day().hours(), finish.time_of_day().minutes());
427 if (now.date() != finish.date()) {
428 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
429 /// to say what day a job will finish.
430 day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
432 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
433 /// on an operation; after it is an estimated wall-clock completion time.
434 s += String::compose(
435 _("; %1 remaining; finishing at %2%3"),
436 seconds_to_approximate_hms(r), finish_string, day
439 } else if (finished_ok ()) {
440 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
441 } else if (finished_in_error ()) {
442 s = String::compose (_("Error: %1"), error_summary ());
443 } else if (finished_cancelled ()) {
451 Job::json_status () const
453 boost::mutex::scoped_lock lm (_state_mutex);
459 return N_("running");
461 case PAUSED_BY_PRIORITY:
464 return N_("finished_ok");
466 return N_("finished_error");
467 case FINISHED_CANCELLED:
468 return N_("finished_cancelled");
474 /** @return An estimate of the remaining time for this sub-job, in seconds */
476 Job::remaining_time () const
478 if (progress().get_value_or(0) == 0) {
479 return elapsed_sub_time ();
482 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
492 if (paused_by_user() || paused_by_priority()) {
496 _thread->interrupt ();
497 DCPOMATIC_ASSERT (_thread->joinable ());
504 Job::pause_by_user ()
507 set_state (PAUSED_BY_USER);
508 _pause_changed.notify_all ();
513 Job::pause_by_priority ()
516 set_state (PAUSED_BY_PRIORITY);
517 _pause_changed.notify_all ();
524 if (paused_by_user() || paused_by_priority()) {
526 _pause_changed.notify_all ();
531 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
533 boost::mutex::scoped_lock lm (_state_mutex);
534 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
537 connection = Finished.connect (finished);