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)
66 _thread->interrupt ();
67 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
68 if (_thread->joinable ()) {
72 /* Too late to do anything about this */
80 /** Start the job in a separate thread, returning immediately */
85 _start_time = time (0);
86 _sub_start_time = time (0);
87 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
88 #ifdef DCPOMATIC_LINUX
89 pthread_setname_np (_thread->native_handle(), "job-wrapper");
93 /** A wrapper for the ::run() method to catch exceptions */
101 } catch (dcp::FileError& e) {
103 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
106 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
107 if (s.available < pow (1024, 3)) {
109 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
115 set_error (e.what(), m);
117 set_state (FINISHED_ERROR);
119 } catch (OpenFileError& e) {
122 String::compose (_("Could not open %1"), e.file().string()),
124 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
125 boost::filesystem::absolute (e.file()).string(),
131 set_state (FINISHED_ERROR);
133 } catch (boost::filesystem::filesystem_error& e) {
135 if (e.code() == boost::system::errc::no_such_file_or_directory) {
137 String::compose (_("Could not open %1"), e.path1().string ()),
139 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
140 boost::filesystem::absolute (e.path1()).string(),
147 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
152 set_state (FINISHED_ERROR);
154 } catch (boost::thread_interrupted &) {
156 set_state (FINISHED_CANCELLED);
158 } catch (sub::SubripError& e) {
160 string extra = "Error is near:\n";
161 BOOST_FOREACH (string i, e.context()) {
165 set_error (e.what (), extra);
167 set_state (FINISHED_ERROR);
169 } catch (std::bad_alloc& e) {
171 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."));
173 set_state (FINISHED_ERROR);
175 } catch (dcp::MissingAssetError& e) {
177 set_error (e.message(), e.path().string());
179 set_state (FINISHED_ERROR);
181 } catch (dcp::DCPReadError& e) {
183 set_error (e.message(), e.detail().get_value_or(""));
185 set_state (FINISHED_ERROR);
187 } catch (KDMError& e) {
189 set_error (e.summary(), e.detail());
191 set_state (FINISHED_ERROR);
193 } catch (FileError& e) {
195 set_error (e.what(), e.what());
197 set_state (FINISHED_ERROR);
199 } catch (std::exception& e) {
203 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
207 set_state (FINISHED_ERROR);
213 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
217 set_state (FINISHED_ERROR);
221 /** @return true if this job is new (ie has not started running) */
225 boost::mutex::scoped_lock lm (_state_mutex);
226 return _state == NEW;
229 /** @return true if the job is running */
231 Job::running () const
233 boost::mutex::scoped_lock lm (_state_mutex);
234 return _state == RUNNING;
237 /** @return true if the job has finished (either successfully or unsuccessfully) */
239 Job::finished () const
241 boost::mutex::scoped_lock lm (_state_mutex);
242 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
245 /** @return true if the job has finished successfully */
247 Job::finished_ok () const
249 boost::mutex::scoped_lock lm (_state_mutex);
250 return _state == FINISHED_OK;
253 /** @return true if the job has finished unsuccessfully */
255 Job::finished_in_error () const
257 boost::mutex::scoped_lock lm (_state_mutex);
258 return _state == FINISHED_ERROR;
262 Job::finished_cancelled () const
264 boost::mutex::scoped_lock lm (_state_mutex);
265 return _state == FINISHED_CANCELLED;
269 Job::paused_by_user () const
271 boost::mutex::scoped_lock lm (_state_mutex);
272 return _state == PAUSED_BY_USER;
276 Job::paused_by_priority () const
278 boost::mutex::scoped_lock lm (_state_mutex);
279 return _state == PAUSED_BY_PRIORITY;
282 /** Set the state of this job.
283 * @param s New state.
286 Job::set_state (State s)
288 bool finished = false;
291 boost::mutex::scoped_lock lm (_state_mutex);
294 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
295 _ran_for = time(0) - _start_time;
302 emit (boost::bind (boost::ref (Finished)));
303 FinishedImmediate ();
307 /** @return DCPTime (in seconds) that this sub-job has been running */
309 Job::elapsed_sub_time () const
311 if (_sub_start_time == 0) {
315 return time (0) - _sub_start_time;
318 /** Check to see if this job has been interrupted or paused */
320 Job::check_for_interruption_or_pause ()
322 boost::this_thread::interruption_point ();
324 boost::mutex::scoped_lock lm (_state_mutex);
325 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
326 emit (boost::bind (boost::ref (Progress)));
327 _pause_changed.wait (lm);
331 /** Set the progress of the current part of the job.
332 * @param p Progress (from 0 to 1)
333 * @param force Do not ignore this update, even if it hasn't been long since the last one.
336 Job::set_progress (float p, bool force)
338 check_for_interruption_or_pause ();
341 /* Check for excessively frequent progress reporting */
342 boost::mutex::scoped_lock lm (_progress_mutex);
344 gettimeofday (&now, 0);
345 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
346 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
347 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
352 _last_progress_update = now;
355 set_progress_common (p);
359 Job::set_progress_common (optional<float> p)
362 boost::mutex::scoped_lock lm (_progress_mutex);
366 emit (boost::bind (boost::ref (Progress)));
369 /** @return fractional progress of the current sub-job, if known */
371 Job::progress () const
373 boost::mutex::scoped_lock lm (_progress_mutex);
381 boost::mutex::scoped_lock lm (_progress_mutex);
382 LOG_GENERAL ("Sub-job %1 starting", n);
386 set_progress (0, true);
387 _sub_start_time = time (0);
391 Job::error_details () const
393 boost::mutex::scoped_lock lm (_state_mutex);
394 return _error_details;
397 /** @return A summary of any error that the job has generated */
399 Job::error_summary () const
401 boost::mutex::scoped_lock lm (_state_mutex);
402 return _error_summary;
405 /** Set the current error string.
406 * @param s New error string.
407 * @param d New error detail string.
410 Job::set_error (string s, string d)
413 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
416 boost::mutex::scoped_lock lm (_state_mutex);
421 /** Say that this job's progress will be unknown until further notice */
423 Job::set_progress_unknown ()
425 check_for_interruption_or_pause ();
426 set_progress_common (optional<float> ());
429 /** @return Human-readable status of this job */
433 optional<float> p = progress ();
434 int const t = elapsed_sub_time ();
435 int const r = remaining_time ();
438 if (!finished () && p) {
439 int pc = lrintf (p.get() * 100);
441 /* 100% makes it sound like we've finished when we haven't */
446 snprintf (buffer, sizeof(buffer), "%d%%", pc);
449 if (t > 10 && r > 0) {
450 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
451 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
452 char finish_string[16];
453 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
455 if (now.date() != finish.date()) {
456 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
457 /// to say what day a job will finish.
458 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
460 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
461 /// on an operation; after it is an estimated wall-clock completion time.
462 s += String::compose(
463 _("; %1 remaining; finishing at %2%3"),
464 seconds_to_approximate_hms(r), finish_string, day
467 } else if (finished_ok ()) {
468 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
469 } else if (finished_in_error ()) {
470 s = String::compose (_("Error: %1"), error_summary ());
471 } else if (finished_cancelled ()) {
479 Job::json_status () const
481 boost::mutex::scoped_lock lm (_state_mutex);
487 return N_("running");
489 case PAUSED_BY_PRIORITY:
492 return N_("finished_ok");
494 return N_("finished_error");
495 case FINISHED_CANCELLED:
496 return N_("finished_cancelled");
502 /** @return An estimate of the remaining time for this sub-job, in seconds */
504 Job::remaining_time () const
506 if (progress().get_value_or(0) == 0) {
507 return elapsed_sub_time ();
510 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
520 if (paused_by_user() || paused_by_priority()) {
524 _thread->interrupt ();
525 DCPOMATIC_ASSERT (_thread->joinable ());
531 /** @return true if the job was paused, false if it was not running */
533 Job::pause_by_user ()
537 boost::mutex::scoped_lock lm (_state_mutex);
538 /* We can set _state here directly because we have a lock and we aren't
539 setting the job to FINISHED_*
541 if (_state == RUNNING) {
543 _state = PAUSED_BY_USER;
548 _pause_changed.notify_all ();
555 Job::pause_by_priority ()
558 set_state (PAUSED_BY_PRIORITY);
559 _pause_changed.notify_all ();
566 if (paused_by_user() || paused_by_priority()) {
568 _pause_changed.notify_all ();
573 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
575 boost::mutex::scoped_lock lm (_state_mutex);
576 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
579 connection = Finished.connect (finished);
584 Job::message () const
586 boost::mutex::scoped_lock lm (_state_mutex);
591 Job::set_message (string m)
593 boost::mutex::scoped_lock lm (_state_mutex);