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;
50 /** @param film Associated film, or 0 */
51 Job::Job (shared_ptr<const Film> film)
65 #ifdef DCPOMATIC_DEBUG
66 /* Any subclass should have called stop_thread in its destructor */
75 _thread->interrupt ();
76 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
77 if (_thread->joinable ()) {
81 /* Too late to do anything about this */
90 /** Start the job in a separate thread, returning immediately */
95 _start_time = time (0);
96 _sub_start_time = time (0);
97 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
98 #ifdef DCPOMATIC_LINUX
99 pthread_setname_np (_thread->native_handle(), "job-wrapper");
103 /** A wrapper for the ::run() method to catch exceptions */
111 } catch (dcp::FileError& e) {
113 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
116 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
117 if (s.available < pow (1024, 3)) {
119 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
125 set_error (e.what(), m);
127 set_state (FINISHED_ERROR);
129 } catch (OpenFileError& e) {
132 String::compose (_("Could not open %1"), e.file().string()),
134 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
135 boost::filesystem::absolute (e.file()).string(),
141 set_state (FINISHED_ERROR);
143 } catch (boost::filesystem::filesystem_error& e) {
145 if (e.code() == boost::system::errc::no_such_file_or_directory) {
147 String::compose (_("Could not open %1"), e.path1().string ()),
149 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
150 boost::filesystem::absolute (e.path1()).string(),
157 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
162 set_state (FINISHED_ERROR);
164 } catch (boost::thread_interrupted &) {
166 set_state (FINISHED_CANCELLED);
168 } catch (sub::SubripError& e) {
170 string extra = "Error is near:\n";
171 BOOST_FOREACH (string i, e.context()) {
175 set_error (e.what (), extra);
177 set_state (FINISHED_ERROR);
179 } catch (std::bad_alloc& e) {
181 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."));
183 set_state (FINISHED_ERROR);
185 } catch (dcp::MissingAssetError& e) {
187 set_error (e.message(), e.path().string());
189 set_state (FINISHED_ERROR);
191 } catch (dcp::DCPReadError& e) {
193 set_error (e.message(), e.detail().get_value_or(""));
195 set_state (FINISHED_ERROR);
197 } catch (KDMError& e) {
199 set_error (e.summary(), e.detail());
201 set_state (FINISHED_ERROR);
203 } catch (FileError& e) {
205 set_error (e.what(), e.what());
207 set_state (FINISHED_ERROR);
209 } catch (std::exception& e) {
213 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
217 set_state (FINISHED_ERROR);
223 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
227 set_state (FINISHED_ERROR);
231 /** @return true if this job is new (ie has not started running) */
235 boost::mutex::scoped_lock lm (_state_mutex);
236 return _state == NEW;
239 /** @return true if the job is running */
241 Job::running () const
243 boost::mutex::scoped_lock lm (_state_mutex);
244 return _state == RUNNING;
247 /** @return true if the job has finished (either successfully or unsuccessfully) */
249 Job::finished () const
251 boost::mutex::scoped_lock lm (_state_mutex);
252 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
255 /** @return true if the job has finished successfully */
257 Job::finished_ok () const
259 boost::mutex::scoped_lock lm (_state_mutex);
260 return _state == FINISHED_OK;
263 /** @return true if the job has finished unsuccessfully */
265 Job::finished_in_error () const
267 boost::mutex::scoped_lock lm (_state_mutex);
268 return _state == FINISHED_ERROR;
272 Job::finished_cancelled () const
274 boost::mutex::scoped_lock lm (_state_mutex);
275 return _state == FINISHED_CANCELLED;
279 Job::paused_by_user () const
281 boost::mutex::scoped_lock lm (_state_mutex);
282 return _state == PAUSED_BY_USER;
286 Job::paused_by_priority () const
288 boost::mutex::scoped_lock lm (_state_mutex);
289 return _state == PAUSED_BY_PRIORITY;
292 /** Set the state of this job.
293 * @param s New state.
296 Job::set_state (State s)
298 bool finished = false;
301 boost::mutex::scoped_lock lm (_state_mutex);
304 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
305 _ran_for = time(0) - _start_time;
312 emit (boost::bind (boost::ref (Finished)));
313 FinishedImmediate ();
317 /** @return DCPTime (in seconds) that this sub-job has been running */
319 Job::elapsed_sub_time () const
321 if (_sub_start_time == 0) {
325 return time (0) - _sub_start_time;
328 /** Check to see if this job has been interrupted or paused */
330 Job::check_for_interruption_or_pause ()
332 boost::this_thread::interruption_point ();
334 boost::mutex::scoped_lock lm (_state_mutex);
335 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
336 emit (boost::bind (boost::ref (Progress)));
337 _pause_changed.wait (lm);
341 /** Set the progress of the current part of the job.
342 * @param p Progress (from 0 to 1)
343 * @param force Do not ignore this update, even if it hasn't been long since the last one.
346 Job::set_progress (float p, bool force)
348 check_for_interruption_or_pause ();
351 /* Check for excessively frequent progress reporting */
352 boost::mutex::scoped_lock lm (_progress_mutex);
354 gettimeofday (&now, 0);
355 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
356 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
357 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
362 _last_progress_update = now;
365 set_progress_common (p);
369 Job::set_progress_common (optional<float> p)
372 boost::mutex::scoped_lock lm (_progress_mutex);
376 emit (boost::bind (boost::ref (Progress)));
379 /** @return fractional progress of the current sub-job, if known */
381 Job::progress () const
383 boost::mutex::scoped_lock lm (_progress_mutex);
391 boost::mutex::scoped_lock lm (_progress_mutex);
392 LOG_GENERAL ("Sub-job %1 starting", n);
396 set_progress (0, true);
397 _sub_start_time = time (0);
401 Job::error_details () const
403 boost::mutex::scoped_lock lm (_state_mutex);
404 return _error_details;
407 /** @return A summary of any error that the job has generated */
409 Job::error_summary () const
411 boost::mutex::scoped_lock lm (_state_mutex);
412 return _error_summary;
415 /** Set the current error string.
416 * @param s New error string.
417 * @param d New error detail string.
420 Job::set_error (string s, string d)
423 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
426 boost::mutex::scoped_lock lm (_state_mutex);
431 /** Say that this job's progress will be unknown until further notice */
433 Job::set_progress_unknown ()
435 check_for_interruption_or_pause ();
436 set_progress_common (optional<float> ());
439 /** @return Human-readable status of this job */
443 optional<float> p = progress ();
444 int const t = elapsed_sub_time ();
445 int const r = remaining_time ();
448 if (!finished () && p) {
449 int pc = lrintf (p.get() * 100);
451 /* 100% makes it sound like we've finished when we haven't */
456 snprintf (buffer, sizeof(buffer), "%d%%", pc);
459 if (t > 10 && r > 0) {
460 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
461 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
462 char finish_string[16];
463 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
465 if (now.date() != finish.date()) {
466 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
467 /// to say what day a job will finish.
468 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
470 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
471 /// on an operation; after it is an estimated wall-clock completion time.
472 s += String::compose(
473 _("; %1 remaining; finishing at %2%3"),
474 seconds_to_approximate_hms(r), finish_string, day
477 } else if (finished_ok ()) {
478 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
479 } else if (finished_in_error ()) {
480 s = String::compose (_("Error: %1"), error_summary ());
481 } else if (finished_cancelled ()) {
489 Job::json_status () const
491 boost::mutex::scoped_lock lm (_state_mutex);
497 return N_("running");
499 case PAUSED_BY_PRIORITY:
502 return N_("finished_ok");
504 return N_("finished_error");
505 case FINISHED_CANCELLED:
506 return N_("finished_cancelled");
512 /** @return An estimate of the remaining time for this sub-job, in seconds */
514 Job::remaining_time () const
516 if (progress().get_value_or(0) == 0) {
517 return elapsed_sub_time ();
520 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
530 if (paused_by_user() || paused_by_priority()) {
534 _thread->interrupt ();
535 DCPOMATIC_ASSERT (_thread->joinable ());
541 /** @return true if the job was paused, false if it was not running */
543 Job::pause_by_user ()
547 boost::mutex::scoped_lock lm (_state_mutex);
548 /* We can set _state here directly because we have a lock and we aren't
549 setting the job to FINISHED_*
551 if (_state == RUNNING) {
553 _state = PAUSED_BY_USER;
558 _pause_changed.notify_all ();
565 Job::pause_by_priority ()
568 set_state (PAUSED_BY_PRIORITY);
569 _pause_changed.notify_all ();
576 if (paused_by_user() || paused_by_priority()) {
578 _pause_changed.notify_all ();
583 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
585 boost::mutex::scoped_lock lm (_state_mutex);
586 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
589 connection = Finished.connect (finished);
594 Job::message () const
596 boost::mutex::scoped_lock lm (_state_mutex);
601 Job::set_message (string m)
603 boost::mutex::scoped_lock lm (_state_mutex);