src/lib/job.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file  src/job.cc
  22  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  23  */
  24
  25 #include "job.h"
  26 #include "util.h"
  27 #include "cross.h"
  28 #include "exceptions.h"
  29 #include "film.h"
  30 #include "log.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>
  38 #include <iostream>
  39
  40 #include "i18n.h"
  41
  42 using std::string;
  43 using std::list;
  44 using std::cout;
  45 using boost::shared_ptr;
  46 using boost::optional;
  47 using boost::function;
  48
  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); }
  51
  52 /** @param film Associated film, or 0 */
  53 Job::Job (shared_ptr<const Film> film)
  54         : _film (film)
  55         , _thread (0)
  56         , _state (NEW)
  57         , _start_time (0)
  58         , _sub_start_time (0)
  59         , _progress (0)
  60         , _ran_for (0)
  61 {
  62
  63 }
  64
  65 Job::~Job ()
  66 {
  67         if (_thread) {
  68                 _thread->interrupt ();
  69                 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
  70                 if (_thread->joinable ()) {
  71                         try {
  72                                 _thread->join ();
  73                         } catch (...) {
  74                                 /* Too late to do anything about this */
  75                         }
  76                 }
  77         }
  78
  79         delete _thread;
  80 }
  81
  82 /** Start the job in a separate thread, returning immediately */
  83 void
  84 Job::start ()
  85 {
  86         set_state (RUNNING);
  87         _start_time = time (0);
  88         _sub_start_time = time (0);
  89         _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
  90 }
  91
  92 /** A wrapper for the ::run() method to catch exceptions */
  93 void
  94 Job::run_wrapper ()
  95 {
  96         try {
  97
  98                 run ();
  99
 100         } catch (dcp::FileError& e) {
 101
 102                 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
 103
 104                 try {
 105                         boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
 106                         if (s.available < pow (1024, 3)) {
 107                                 m += N_("\n\n");
 108                                 m += _("The drive that the film is stored on is low in disc space.  Free some more space and try again.");
 109                         }
 110                 } catch (...) {
 111
 112                 }
 113
 114                 set_error (e.what(), m);
 115                 set_progress (1);
 116                 set_state (FINISHED_ERROR);
 117
 118         } catch (OpenFileError& e) {
 119
 120                 set_error (
 121                         String::compose (_("Could not open %1"), e.file().string()),
 122                         String::compose (
 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()
 125                                 )
 126                         );
 127
 128                 set_progress (1);
 129                 set_state (FINISHED_ERROR);
 130
 131         } catch (boost::filesystem::filesystem_error& e) {
 132
 133                 if (e.code() == boost::system::errc::no_such_file_or_directory) {
 134                         set_error (
 135                                 String::compose (_("Could not open %1"), e.path1().string ()),
 136                                 String::compose (
 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()
 139                                         )
 140                                 );
 141                 } else {
 142                         set_error (
 143                                 e.what (),
 144                                 string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
 145                                 );
 146                 }
 147
 148                 set_progress (1);
 149                 set_state (FINISHED_ERROR);
 150
 151         } catch (boost::thread_interrupted &) {
 152
 153                 set_state (FINISHED_CANCELLED);
 154
 155         } catch (sub::SubripError& e) {
 156
 157                 string extra = "Error is near:\n";
 158                 BOOST_FOREACH (string i, e.context()) {
 159                         extra += i + "\n";
 160                 }
 161
 162                 set_error (e.what (), extra);
 163                 set_progress (1);
 164                 set_state (FINISHED_ERROR);
 165
 166         } catch (std::bad_alloc& e) {
 167
 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."));
 169                 set_progress (1);
 170                 set_state (FINISHED_ERROR);
 171
 172         } catch (std::exception& e) {
 173
 174                 set_error (
 175                         e.what (),
 176                         string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
 177                         );
 178
 179                 set_progress (1);
 180                 set_state (FINISHED_ERROR);
 181
 182         } catch (...) {
 183
 184                 set_error (
 185                         _("Unknown error"),
 186                         string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
 187                         );
 188
 189                 set_progress (1);
 190                 set_state (FINISHED_ERROR);
 191         }
 192 }
 193
 194 /** @return true if this job is new (ie has not started running) */
 195 bool
 196 Job::is_new () const
 197 {
 198         boost::mutex::scoped_lock lm (_state_mutex);
 199         return _state == NEW;
 200 }
 201
 202 /** @return true if the job is running */
 203 bool
 204 Job::running () const
 205 {
 206         boost::mutex::scoped_lock lm (_state_mutex);
 207         return _state == RUNNING;
 208 }
 209
 210 /** @return true if the job has finished (either successfully or unsuccessfully) */
 211 bool
 212 Job::finished () const
 213 {
 214         boost::mutex::scoped_lock lm (_state_mutex);
 215         return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
 216 }
 217
 218 /** @return true if the job has finished successfully */
 219 bool
 220 Job::finished_ok () const
 221 {
 222         boost::mutex::scoped_lock lm (_state_mutex);
 223         return _state == FINISHED_OK;
 224 }
 225
 226 /** @return true if the job has finished unsuccessfully */
 227 bool
 228 Job::finished_in_error () const
 229 {
 230         boost::mutex::scoped_lock lm (_state_mutex);
 231         return _state == FINISHED_ERROR;
 232 }
 233
 234 bool
 235 Job::finished_cancelled () const
 236 {
 237         boost::mutex::scoped_lock lm (_state_mutex);
 238         return _state == FINISHED_CANCELLED;
 239 }
 240
 241 bool
 242 Job::paused () const
 243 {
 244         boost::mutex::scoped_lock lm (_state_mutex);
 245         return _state == PAUSED;
 246 }
 247
 248 /** Set the state of this job.
 249  *  @param s New state.
 250  */
 251 void
 252 Job::set_state (State s)
 253 {
 254         bool finished = false;
 255
 256         {
 257                 boost::mutex::scoped_lock lm (_state_mutex);
 258                 _state = s;
 259
 260                 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
 261                         _ran_for = time(0) - _start_time;
 262                         finished = true;
 263                         _sub_name.clear ();
 264                 }
 265         }
 266
 267         if (finished) {
 268                 emit (boost::bind (boost::ref (Finished)));
 269         }
 270 }
 271
 272 /** @return DCPTime (in seconds) that this sub-job has been running */
 273 int
 274 Job::elapsed_sub_time () const
 275 {
 276         if (_sub_start_time == 0) {
 277                 return 0;
 278         }
 279
 280         return time (0) - _sub_start_time;
 281 }
 282
 283 /** Check to see if this job has been interrupted or paused */
 284 void
 285 Job::check_for_interruption_or_pause ()
 286 {
 287         boost::this_thread::interruption_point ();
 288
 289         boost::mutex::scoped_lock lm (_state_mutex);
 290         while (_state == PAUSED) {
 291                 emit (boost::bind (boost::ref (Progress)));
 292                 _pause_changed.wait (lm);
 293         }
 294 }
 295
 296 /** Set the progress of the current part of the job.
 297  *  @param p Progress (from 0 to 1)
 298  */
 299 void
 300 Job::set_progress (float p, bool force)
 301 {
 302         check_for_interruption_or_pause ();
 303
 304         if (!force) {
 305                 /* Check for excessively frequent progress reporting */
 306                 boost::mutex::scoped_lock lm (_progress_mutex);
 307                 struct timeval now;
 308                 gettimeofday (&now, 0);
 309                 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
 310                         double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
 311                                 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
 312                         if (elapsed < 0.5) {
 313                                 return;
 314                         }
 315                 }
 316                 _last_progress_update = now;
 317         }
 318
 319         set_progress_common (p);
 320 }
 321
 322 void
 323 Job::set_progress_common (optional<float> p)
 324 {
 325         {
 326                 boost::mutex::scoped_lock lm (_progress_mutex);
 327                 _progress = p;
 328         }
 329
 330         emit (boost::bind (boost::ref (Progress)));
 331 }
 332
 333 /** @return fractional progress of the current sub-job, if known */
 334 optional<float>
 335 Job::progress () const
 336 {
 337         boost::mutex::scoped_lock lm (_progress_mutex);
 338         return _progress;
 339 }
 340
 341 void
 342 Job::sub (string n)
 343 {
 344         {
 345                 boost::mutex::scoped_lock lm (_progress_mutex);
 346                 LOG_GENERAL ("Sub-job %1 starting", n);
 347                 _sub_name = n;
 348         }
 349
 350         set_progress (0, true);
 351         _sub_start_time = time (0);
 352 }
 353
 354 string
 355 Job::error_details () const
 356 {
 357         boost::mutex::scoped_lock lm (_state_mutex);
 358         return _error_details;
 359 }
 360
 361 /** @return A summary of any error that the job has generated */
 362 string
 363 Job::error_summary () const
 364 {
 365         boost::mutex::scoped_lock lm (_state_mutex);
 366         return _error_summary;
 367 }
 368
 369 /** Set the current error string.
 370  *  @param e New error string.
 371  */
 372 void
 373 Job::set_error (string s, string d)
 374 {
 375         if (_film) {
 376                 LOG_ERROR_NC (s);
 377                 LOG_ERROR_NC (d);
 378                 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
 379         }
 380
 381         boost::mutex::scoped_lock lm (_state_mutex);
 382         _error_summary = s;
 383         _error_details = d;
 384 }
 385
 386 /** Say that this job's progress will be unknown until further notice */
 387 void
 388 Job::set_progress_unknown ()
 389 {
 390         check_for_interruption_or_pause ();
 391         set_progress_common (optional<float> ());
 392 }
 393
 394 /** @return Human-readable status of this job */
 395 string
 396 Job::status () const
 397 {
 398         optional<float> p = progress ();
 399         int const t = elapsed_sub_time ();
 400         int const r = remaining_time ();
 401
 402         string s;
 403         if (!finished () && p) {
 404                 int pc = lrintf (p.get() * 100);
 405                 if (pc == 100) {
 406                         /* 100% makes it sound like we've finished when we haven't */
 407                         pc = 99;
 408                 }
 409
 410                 char buffer[64];
 411                 snprintf (buffer, sizeof(buffer), "%d%%", pc);
 412                 s += buffer;
 413
 414                 if (t > 10 && r > 0) {
 415                         boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
 416                         boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
 417                         char finish_string[6];
 418                         snprintf (finish_string, sizeof(finish_string), "%02d:%02d", finish.time_of_day().hours(), finish.time_of_day().minutes());
 419                         string day;
 420                         if (now.date() != finish.date()) {
 421                                 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
 422                                 /// to say what day a job will finish.
 423                                 day = String::compose (_(" on %1"), finish.date().day_of_week().as_long_string());
 424                         }
 425                         /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
 426                         /// on an operation; after it is an estimated wall-clock completion time.
 427                         s += String::compose(
 428                                 _("; %1 remaining; finishing at %2%3"),
 429                                 seconds_to_approximate_hms(r), finish_string, day
 430                                 );
 431                 }
 432         } else if (finished_ok ()) {
 433                 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
 434         } else if (finished_in_error ()) {
 435                 s = String::compose (_("Error: %1"), error_summary ());
 436         } else if (finished_cancelled ()) {
 437                 s = _("Cancelled");
 438         }
 439
 440         return s;
 441 }
 442
 443 string
 444 Job::json_status () const
 445 {
 446         boost::mutex::scoped_lock lm (_state_mutex);
 447
 448         switch (_state) {
 449         case NEW:
 450                 return N_("new");
 451         case RUNNING:
 452                 return N_("running");
 453         case PAUSED:
 454                 return N_("paused");
 455         case FINISHED_OK:
 456                 return N_("finished_ok");
 457         case FINISHED_ERROR:
 458                 return N_("finished_error");
 459         case FINISHED_CANCELLED:
 460                 return N_("finished_cancelled");
 461         }
 462
 463         return "";
 464 }
 465
 466 /** @return An estimate of the remaining time for this sub-job, in seconds */
 467 int
 468 Job::remaining_time () const
 469 {
 470         if (progress().get_value_or(0) == 0) {
 471                 return elapsed_sub_time ();
 472         }
 473
 474         return elapsed_sub_time() / progress().get() - elapsed_sub_time();
 475 }
 476
 477 void
 478 Job::cancel ()
 479 {
 480         if (!_thread) {
 481                 return;
 482         }
 483
 484         if (paused ()) {
 485                 resume ();
 486         }
 487
 488         _thread->interrupt ();
 489         DCPOMATIC_ASSERT (_thread->joinable ());
 490         _thread->join ();
 491         delete _thread;
 492         _thread = 0;
 493 }
 494
 495 void
 496 Job::pause ()
 497 {
 498         if (running ()) {
 499                 set_state (PAUSED);
 500                 _pause_changed.notify_all ();
 501         }
 502 }
 503
 504 void
 505 Job::resume ()
 506 {
 507         if (paused ()) {
 508                 set_state (RUNNING);
 509                 _pause_changed.notify_all ();
 510         }
 511 }
 512
 513 void
 514 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
 515 {
 516         boost::mutex::scoped_lock lm (_state_mutex);
 517         if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
 518                 finished ();
 519         } else {
 520                 connection = Finished.connect (finished);
 521         }
 522 }