2 Copyright (C) 2012-2019 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 "dcpomatic_log.h"
32 #include "compose.hpp"
33 #include <dcp/exceptions.h>
34 #include <sub/exceptions.h>
35 #include <boost/thread.hpp>
36 #include <boost/filesystem.hpp>
37 #include <boost/foreach.hpp>
38 #include <boost/date_time/posix_time/posix_time.hpp>
46 using boost::shared_ptr;
47 using boost::optional;
48 using boost::function;
49 using namespace dcpomatic;
51 /** @param film Associated film, or 0 */
52 Job::Job (shared_ptr<const Film> film)
67 _thread->interrupt ();
68 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
69 if (_thread->joinable ()) {
73 /* Too late to do anything about this */
81 /** Start the job in a separate thread, returning immediately */
86 _start_time = time (0);
87 _sub_start_time = time (0);
88 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
89 #ifdef DCPOMATIC_LINUX
90 pthread_setname_np (_thread->native_handle(), "job-wrapper");
94 /** A wrapper for the ::run() method to catch exceptions */
102 } catch (dcp::FileError& e) {
104 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
107 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
108 if (s.available < pow (1024, 3)) {
110 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
116 set_error (e.what(), m);
118 set_state (FINISHED_ERROR);
120 } catch (OpenFileError& e) {
123 String::compose (_("Could not open %1"), e.file().string()),
125 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
126 boost::filesystem::absolute (e.file()).string(),
132 set_state (FINISHED_ERROR);
134 } catch (boost::filesystem::filesystem_error& e) {
136 if (e.code() == boost::system::errc::no_such_file_or_directory) {
138 String::compose (_("Could not open %1"), e.path1().string ()),
140 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
141 boost::filesystem::absolute (e.path1()).string(),
148 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
153 set_state (FINISHED_ERROR);
155 } catch (boost::thread_interrupted &) {
157 set_state (FINISHED_CANCELLED);
159 } catch (sub::SubripError& e) {
161 string extra = "Error is near:\n";
162 BOOST_FOREACH (string i, e.context()) {
166 set_error (e.what (), extra);
168 set_state (FINISHED_ERROR);
170 } catch (std::bad_alloc& e) {
172 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."));
174 set_state (FINISHED_ERROR);
176 } catch (dcp::MissingAssetError& e) {
178 set_error (e.message(), e.path().string());
180 set_state (FINISHED_ERROR);
182 } catch (dcp::DCPReadError& e) {
184 set_error (e.message(), e.detail().get_value_or(""));
186 set_state (FINISHED_ERROR);
188 } catch (KDMError& e) {
190 set_error (e.summary(), e.detail());
192 set_state (FINISHED_ERROR);
194 } catch (FileError& e) {
196 set_error (e.what(), e.what());
198 set_state (FINISHED_ERROR);
200 } catch (std::exception& e) {
204 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
208 set_state (FINISHED_ERROR);
214 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
218 set_state (FINISHED_ERROR);
222 /** @return true if this job is new (ie has not started running) */
226 boost::mutex::scoped_lock lm (_state_mutex);
227 return _state == NEW;
230 /** @return true if the job is running */
232 Job::running () const
234 boost::mutex::scoped_lock lm (_state_mutex);
235 return _state == RUNNING;
238 /** @return true if the job has finished (either successfully or unsuccessfully) */
240 Job::finished () const
242 boost::mutex::scoped_lock lm (_state_mutex);
243 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
246 /** @return true if the job has finished successfully */
248 Job::finished_ok () const
250 boost::mutex::scoped_lock lm (_state_mutex);
251 return _state == FINISHED_OK;
254 /** @return true if the job has finished unsuccessfully */
256 Job::finished_in_error () const
258 boost::mutex::scoped_lock lm (_state_mutex);
259 return _state == FINISHED_ERROR;
263 Job::finished_cancelled () const
265 boost::mutex::scoped_lock lm (_state_mutex);
266 return _state == FINISHED_CANCELLED;
270 Job::paused_by_user () const
272 boost::mutex::scoped_lock lm (_state_mutex);
273 return _state == PAUSED_BY_USER;
277 Job::paused_by_priority () const
279 boost::mutex::scoped_lock lm (_state_mutex);
280 return _state == PAUSED_BY_PRIORITY;
283 /** Set the state of this job.
284 * @param s New state.
287 Job::set_state (State s)
289 bool finished = false;
292 boost::mutex::scoped_lock lm (_state_mutex);
295 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
296 _ran_for = time(0) - _start_time;
303 emit (boost::bind (boost::ref (Finished)));
304 FinishedImmediate ();
308 /** @return DCPTime (in seconds) that this sub-job has been running */
310 Job::elapsed_sub_time () const
312 if (_sub_start_time == 0) {
316 return time (0) - _sub_start_time;
319 /** Check to see if this job has been interrupted or paused */
321 Job::check_for_interruption_or_pause ()
323 boost::this_thread::interruption_point ();
325 boost::mutex::scoped_lock lm (_state_mutex);
326 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
327 emit (boost::bind (boost::ref (Progress)));
328 _pause_changed.wait (lm);
332 /** Set the progress of the current part of the job.
333 * @param p Progress (from 0 to 1)
334 * @param force Do not ignore this update, even if it hasn't been long since the last one.
337 Job::set_progress (float p, bool force)
339 check_for_interruption_or_pause ();
342 /* Check for excessively frequent progress reporting */
343 boost::mutex::scoped_lock lm (_progress_mutex);
345 gettimeofday (&now, 0);
346 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
347 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
348 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
353 _last_progress_update = now;
356 set_progress_common (p);
360 Job::set_progress_common (optional<float> p)
363 boost::mutex::scoped_lock lm (_progress_mutex);
367 emit (boost::bind (boost::ref (Progress)));
370 /** @return fractional progress of the current sub-job, if known */
372 Job::progress () const
374 boost::mutex::scoped_lock lm (_progress_mutex);
382 boost::mutex::scoped_lock lm (_progress_mutex);
383 LOG_GENERAL ("Sub-job %1 starting", n);
387 set_progress (0, true);
388 _sub_start_time = time (0);
392 Job::error_details () const
394 boost::mutex::scoped_lock lm (_state_mutex);
395 return _error_details;
398 /** @return A summary of any error that the job has generated */
400 Job::error_summary () const
402 boost::mutex::scoped_lock lm (_state_mutex);
403 return _error_summary;
406 /** Set the current error string.
407 * @param s New error string.
408 * @param d New error detail string.
411 Job::set_error (string s, string d)
414 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
417 boost::mutex::scoped_lock lm (_state_mutex);
422 /** Say that this job's progress will be unknown until further notice */
424 Job::set_progress_unknown ()
426 check_for_interruption_or_pause ();
427 set_progress_common (optional<float> ());
430 /** @return Human-readable status of this job */
434 optional<float> p = progress ();
435 int const t = elapsed_sub_time ();
436 int const r = remaining_time ();
439 if (!finished () && p) {
440 int pc = lrintf (p.get() * 100);
442 /* 100% makes it sound like we've finished when we haven't */
447 snprintf (buffer, sizeof(buffer), "%d%%", pc);
450 if (t > 10 && r > 0) {
451 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
452 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
453 char finish_string[16];
454 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
456 if (now.date() != finish.date()) {
457 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
458 /// to say what day a job will finish.
459 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
461 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
462 /// on an operation; after it is an estimated wall-clock completion time.
463 s += String::compose(
464 _("; %1 remaining; finishing at %2%3"),
465 seconds_to_approximate_hms(r), finish_string, day
468 } else if (finished_ok ()) {
469 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
470 } else if (finished_in_error ()) {
471 s = String::compose (_("Error: %1"), error_summary ());
472 } else if (finished_cancelled ()) {
480 Job::json_status () const
482 boost::mutex::scoped_lock lm (_state_mutex);
488 return N_("running");
490 case PAUSED_BY_PRIORITY:
493 return N_("finished_ok");
495 return N_("finished_error");
496 case FINISHED_CANCELLED:
497 return N_("finished_cancelled");
503 /** @return An estimate of the remaining time for this sub-job, in seconds */
505 Job::remaining_time () const
507 if (progress().get_value_or(0) == 0) {
508 return elapsed_sub_time ();
511 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
521 if (paused_by_user() || paused_by_priority()) {
525 _thread->interrupt ();
526 DCPOMATIC_ASSERT (_thread->joinable ());
532 /** @return true if the job was paused, false if it was not running */
534 Job::pause_by_user ()
538 boost::mutex::scoped_lock lm (_state_mutex);
539 /* We can set _state here directly because we have a lock and we aren't
540 setting the job to FINISHED_*
542 if (_state == RUNNING) {
544 _state = PAUSED_BY_USER;
549 _pause_changed.notify_all ();
556 Job::pause_by_priority ()
559 set_state (PAUSED_BY_PRIORITY);
560 _pause_changed.notify_all ();
567 if (paused_by_user() || paused_by_priority()) {
569 _pause_changed.notify_all ();
574 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
576 boost::mutex::scoped_lock lm (_state_mutex);
577 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
580 connection = Finished.connect (finished);
585 Job::message () const
587 boost::mutex::scoped_lock lm (_state_mutex);
592 Job::set_message (string m)
594 boost::mutex::scoped_lock lm (_state_mutex);