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)
71 if (!_thread.joinable()) {
79 /* Too late to do anything about this */
83 /** Start the job in a separate thread, returning immediately */
88 _start_time = time (0);
89 _sub_start_time = time (0);
90 _thread = boost::thread (boost::bind(&Job::run_wrapper, this));
91 #ifdef DCPOMATIC_LINUX
92 pthread_setname_np (_thread.native_handle(), "job-wrapper");
96 /** A wrapper for the ::run() method to catch exceptions */
104 } catch (dcp::FileError& e) {
106 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
109 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
110 if (s.available < pow (1024, 3)) {
112 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
118 set_error (e.what(), m);
120 set_state (FINISHED_ERROR);
122 } catch (OpenFileError& e) {
125 String::compose (_("Could not open %1"), e.file().string()),
127 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
128 boost::filesystem::absolute (e.file()).string(),
134 set_state (FINISHED_ERROR);
136 } catch (boost::filesystem::filesystem_error& e) {
138 if (e.code() == boost::system::errc::no_such_file_or_directory) {
140 String::compose (_("Could not open %1"), e.path1().string ()),
142 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
143 boost::filesystem::absolute (e.path1()).string(),
150 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
155 set_state (FINISHED_ERROR);
157 } catch (boost::thread_interrupted &) {
159 set_state (FINISHED_CANCELLED);
161 } catch (sub::SubripError& e) {
163 string extra = "Error is near:\n";
164 BOOST_FOREACH (string i, e.context()) {
168 set_error (e.what (), extra);
170 set_state (FINISHED_ERROR);
172 } catch (std::bad_alloc& e) {
174 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."));
176 set_state (FINISHED_ERROR);
178 } catch (dcp::DCPReadError& e) {
180 set_error (e.message(), e.detail().get_value_or(""));
182 set_state (FINISHED_ERROR);
184 } catch (KDMError& e) {
186 set_error (e.summary(), e.detail());
188 set_state (FINISHED_ERROR);
190 } catch (FileError& e) {
192 set_error (e.what(), e.what());
194 set_state (FINISHED_ERROR);
196 } catch (std::exception& e) {
200 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
204 set_state (FINISHED_ERROR);
210 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
214 set_state (FINISHED_ERROR);
218 /** @return true if this job is new (ie has not started running) */
222 boost::mutex::scoped_lock lm (_state_mutex);
223 return _state == NEW;
226 /** @return true if the job is running */
228 Job::running () const
230 boost::mutex::scoped_lock lm (_state_mutex);
231 return _state == RUNNING;
234 /** @return true if the job has finished (either successfully or unsuccessfully) */
236 Job::finished () const
238 boost::mutex::scoped_lock lm (_state_mutex);
239 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
242 /** @return true if the job has finished successfully */
244 Job::finished_ok () const
246 boost::mutex::scoped_lock lm (_state_mutex);
247 return _state == FINISHED_OK;
250 /** @return true if the job has finished unsuccessfully */
252 Job::finished_in_error () const
254 boost::mutex::scoped_lock lm (_state_mutex);
255 return _state == FINISHED_ERROR;
259 Job::finished_cancelled () const
261 boost::mutex::scoped_lock lm (_state_mutex);
262 return _state == FINISHED_CANCELLED;
266 Job::paused_by_user () const
268 boost::mutex::scoped_lock lm (_state_mutex);
269 return _state == PAUSED_BY_USER;
273 Job::paused_by_priority () const
275 boost::mutex::scoped_lock lm (_state_mutex);
276 return _state == PAUSED_BY_PRIORITY;
279 /** Set the state of this job.
280 * @param s New state.
283 Job::set_state (State s)
285 bool finished = false;
288 boost::mutex::scoped_lock lm (_state_mutex);
291 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
292 _ran_for = time(0) - _start_time;
299 emit (boost::bind (boost::ref (Finished)));
300 FinishedImmediate ();
304 /** @return DCPTime (in seconds) that this sub-job has been running */
306 Job::elapsed_sub_time () const
308 if (_sub_start_time == 0) {
312 return time (0) - _sub_start_time;
315 /** Check to see if this job has been interrupted or paused */
317 Job::check_for_interruption_or_pause ()
319 boost::this_thread::interruption_point ();
321 boost::mutex::scoped_lock lm (_state_mutex);
322 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
323 emit (boost::bind (boost::ref (Progress)));
324 _pause_changed.wait (lm);
328 /** Set the progress of the current part of the job.
329 * @param p Progress (from 0 to 1)
330 * @param force Do not ignore this update, even if it hasn't been long since the last one.
333 Job::set_progress (float p, bool force)
335 check_for_interruption_or_pause ();
338 /* Check for excessively frequent progress reporting */
339 boost::mutex::scoped_lock lm (_progress_mutex);
341 gettimeofday (&now, 0);
342 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
343 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
344 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
349 _last_progress_update = now;
352 set_progress_common (p);
356 Job::set_progress_common (optional<float> p)
359 boost::mutex::scoped_lock lm (_progress_mutex);
363 emit (boost::bind (boost::ref (Progress)));
366 /** @return fractional progress of the current sub-job, if known */
368 Job::progress () const
370 boost::mutex::scoped_lock lm (_progress_mutex);
378 boost::mutex::scoped_lock lm (_progress_mutex);
379 LOG_GENERAL ("Sub-job %1 starting", n);
383 set_progress (0, true);
384 _sub_start_time = time (0);
388 Job::error_details () const
390 boost::mutex::scoped_lock lm (_state_mutex);
391 return _error_details;
394 /** @return A summary of any error that the job has generated */
396 Job::error_summary () const
398 boost::mutex::scoped_lock lm (_state_mutex);
399 return _error_summary;
402 /** Set the current error string.
403 * @param s New error string.
404 * @param d New error detail string.
407 Job::set_error (string s, string d)
410 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
413 boost::mutex::scoped_lock lm (_state_mutex);
418 /** Say that this job's progress will be unknown until further notice */
420 Job::set_progress_unknown ()
422 check_for_interruption_or_pause ();
423 set_progress_common (optional<float> ());
426 /** @return Human-readable status of this job */
430 optional<float> p = progress ();
431 int const t = elapsed_sub_time ();
432 int const r = remaining_time ();
435 if (!finished () && p) {
436 int pc = lrintf (p.get() * 100);
438 /* 100% makes it sound like we've finished when we haven't */
443 snprintf (buffer, sizeof(buffer), "%d%%", pc);
446 if (t > 10 && r > 0) {
447 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
448 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
449 char finish_string[16];
450 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
452 if (now.date() != finish.date()) {
453 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
454 /// to say what day a job will finish.
455 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
457 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
458 /// on an operation; after it is an estimated wall-clock completion time.
459 s += String::compose(
460 _("; %1 remaining; finishing at %2%3"),
461 seconds_to_approximate_hms(r), finish_string, day
464 } else if (finished_ok ()) {
465 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
466 } else if (finished_in_error ()) {
467 s = String::compose (_("Error: %1"), error_summary ());
468 } else if (finished_cancelled ()) {
476 Job::json_status () const
478 boost::mutex::scoped_lock lm (_state_mutex);
484 return N_("running");
486 case PAUSED_BY_PRIORITY:
489 return N_("finished_ok");
491 return N_("finished_error");
492 case FINISHED_CANCELLED:
493 return N_("finished_cancelled");
499 /** @return An estimate of the remaining time for this sub-job, in seconds */
501 Job::remaining_time () const
503 if (progress().get_value_or(0) == 0) {
504 return elapsed_sub_time ();
507 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
513 if (!_thread.joinable()) {
517 if (paused_by_user() || paused_by_priority()) {
521 _thread.interrupt ();
525 /** @return true if the job was paused, false if it was not running */
527 Job::pause_by_user ()
531 boost::mutex::scoped_lock lm (_state_mutex);
532 /* We can set _state here directly because we have a lock and we aren't
533 setting the job to FINISHED_*
535 if (_state == RUNNING) {
537 _state = PAUSED_BY_USER;
542 _pause_changed.notify_all ();
549 Job::pause_by_priority ()
552 set_state (PAUSED_BY_PRIORITY);
553 _pause_changed.notify_all ();
560 if (paused_by_user() || paused_by_priority()) {
562 _pause_changed.notify_all ();
567 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
569 boost::mutex::scoped_lock lm (_state_mutex);
570 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
573 connection = Finished.connect (finished);
578 Job::message () const
580 boost::mutex::scoped_lock lm (_state_mutex);
585 Job::set_message (string m)
587 boost::mutex::scoped_lock lm (_state_mutex);