src/lib/job.cc

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