src/lib/job.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/job.cc
  21  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  22  */
  23
  24 #include <boost/thread.hpp>
  25 #include <boost/filesystem.hpp>
  26 #include <libdcp/exceptions.h>
  27 #include "job.h"
  28 #include "util.h"
  29 #include "cross.h"
  30 #include "ui_signaller.h"
  31 #include "exceptions.h"
  32 #include "safe_stringstream.h"
  33
  34 #include "i18n.h"
  35
  36 using std::string;
  37 using std::list;
  38 using std::cout;
  39 using boost::shared_ptr;
  40
  41 Job::Job (shared_ptr<const Film> f)
  42         : _film (f)
  43         , _thread (0)
  44         , _state (NEW)
  45         , _start_time (0)
  46         , _progress (0)
  47         , _ran_for (0)
  48 {
  49
  50 }
  51
  52 /** Start the job in a separate thread, returning immediately */
  53 void
  54 Job::start ()
  55 {
  56         set_state (RUNNING);
  57         _start_time = time (0);
  58         _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
  59 }
  60
  61 /** A wrapper for the ::run() method to catch exceptions */
  62 void
  63 Job::run_wrapper ()
  64 {
  65         try {
  66
  67                 run ();
  68
  69         } catch (libdcp::FileError& e) {
  70
  71                 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
  72
  73                 try {
  74                         boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
  75                         if (s.available < pow (1024, 3)) {
  76                                 m += N_("\n\n");
  77                                 m += _("The drive that the film is stored on is low in disc space.  Free some more space and try again.");
  78                         }
  79                 } catch (...) {
  80
  81                 }
  82
  83                 set_error (e.what(), m);
  84                 set_progress (1);
  85                 set_state (FINISHED_ERROR);
  86
  87         } catch (OpenFileError& e) {
  88
  89                 set_error (
  90                         String::compose (_("Could not open %1"), e.file().string()),
  91                         String::compose (_("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."), e.file().string())
  92                         );
  93
  94                 set_progress (1);
  95                 set_state (FINISHED_ERROR);
  96
  97         } catch (boost::thread_interrupted &) {
  98
  99                 set_state (FINISHED_CANCELLED);
 100
 101         } catch (std::bad_alloc& e) {
 102
 103                 set_error (_("Out of memory"), _("There was not enough memory to do this."));
 104                 set_progress (1);
 105                 set_state (FINISHED_ERROR);
 106
 107         } catch (std::exception& e) {
 108
 109                 set_error (
 110                         e.what (),
 111                         _("It is not known what caused this error.  Please report the problem to the DCP-o-matic author (carl@dcpomatic.com).")
 112                         );
 113
 114                 set_progress (1);
 115                 set_state (FINISHED_ERROR);
 116
 117         } catch (...) {
 118
 119                 set_error (
 120                         _("Unknown error"),
 121                         _("It is not known what caused this error.  Please report the problem to the DCP-o-matic author (carl@dcpomatic.com).")
 122                         );
 123
 124                 set_progress (1);
 125                 set_state (FINISHED_ERROR);
 126         }
 127 }
 128
 129 /** @return true if this job is new (ie has not started running) */
 130 bool
 131 Job::is_new () const
 132 {
 133         boost::mutex::scoped_lock lm (_state_mutex);
 134         return _state == NEW;
 135 }
 136
 137 /** @return true if the job is running */
 138 bool
 139 Job::running () const
 140 {
 141         boost::mutex::scoped_lock lm (_state_mutex);
 142         return _state == RUNNING;
 143 }
 144
 145 /** @return true if the job has finished (either successfully or unsuccessfully) */
 146 bool
 147 Job::finished () const
 148 {
 149         boost::mutex::scoped_lock lm (_state_mutex);
 150         return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
 151 }
 152
 153 /** @return true if the job has finished successfully */
 154 bool
 155 Job::finished_ok () const
 156 {
 157         boost::mutex::scoped_lock lm (_state_mutex);
 158         return _state == FINISHED_OK;
 159 }
 160
 161 /** @return true if the job has finished unsuccessfully */
 162 bool
 163 Job::finished_in_error () const
 164 {
 165         boost::mutex::scoped_lock lm (_state_mutex);
 166         return _state == FINISHED_ERROR;
 167 }
 168
 169 bool
 170 Job::finished_cancelled () const
 171 {
 172         boost::mutex::scoped_lock lm (_state_mutex);
 173         return _state == FINISHED_CANCELLED;
 174 }
 175
 176 bool
 177 Job::paused () const
 178 {
 179         boost::mutex::scoped_lock lm (_state_mutex);
 180         return _state == PAUSED;
 181 }
 182
 183 /** Set the state of this job.
 184  *  @param s New state.
 185  */
 186 void
 187 Job::set_state (State s)
 188 {
 189         bool finished = false;
 190
 191         {
 192                 boost::mutex::scoped_lock lm (_state_mutex);
 193                 _state = s;
 194
 195                 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
 196                         _ran_for = elapsed_time ();
 197                         finished = true;
 198                         _sub_name.clear ();
 199                 }
 200         }
 201
 202         if (finished && ui_signaller) {
 203                 ui_signaller->emit (boost::bind (boost::ref (Finished)));
 204         }
 205 }
 206
 207 /** @return Time (in seconds) that this sub-job has been running */
 208 int
 209 Job::elapsed_time () const
 210 {
 211         if (_start_time == 0) {
 212                 return 0;
 213         }
 214
 215         return time (0) - _start_time;
 216 }
 217
 218 /** Set the progress of the current part of the job.
 219  *  @param p Progress (from 0 to 1)
 220  */
 221 void
 222 Job::set_progress (float p, bool force)
 223 {
 224         if (!force && fabs (p - progress()) < 0.01) {
 225                 /* Calm excessive progress reporting */
 226                 return;
 227         }
 228
 229         boost::mutex::scoped_lock lm (_progress_mutex);
 230         _progress = p;
 231         boost::this_thread::interruption_point ();
 232
 233         if (paused ()) {
 234                 dcpomatic_sleep (1);
 235         }
 236
 237         if (ui_signaller) {
 238                 ui_signaller->emit (boost::bind (boost::ref (Progress)));
 239         }
 240 }
 241
 242 /** @return fractional progress of the current sub-job, or -1 if not known */
 243 float
 244 Job::progress () const
 245 {
 246         boost::mutex::scoped_lock lm (_progress_mutex);
 247         return _progress.get_value_or (-1);
 248 }
 249
 250 void
 251 Job::sub (string n)
 252 {
 253         {
 254                 boost::mutex::scoped_lock lm (_progress_mutex);
 255                 _sub_name = n;
 256         }
 257
 258         set_progress (0, true);
 259 }
 260
 261 string
 262 Job::error_details () const
 263 {
 264         boost::mutex::scoped_lock lm (_state_mutex);
 265         return _error_details;
 266 }
 267
 268 /** @return A summary of any error that the job has generated */
 269 string
 270 Job::error_summary () const
 271 {
 272         boost::mutex::scoped_lock lm (_state_mutex);
 273         return _error_summary;
 274 }
 275
 276 /** Set the current error string.
 277  *  @param e New error string.
 278  */
 279 void
 280 Job::set_error (string s, string d)
 281 {
 282         boost::mutex::scoped_lock lm (_state_mutex);
 283         _error_summary = s;
 284         _error_details = d;
 285 }
 286
 287 /** Say that this job's progress will be unknown until further notice */
 288 void
 289 Job::set_progress_unknown ()
 290 {
 291         boost::mutex::scoped_lock lm (_progress_mutex);
 292         _progress.reset ();
 293 }
 294
 295 /** @return Human-readable status of this job */
 296 string
 297 Job::status () const
 298 {
 299         float const p = progress ();
 300         int const t = elapsed_time ();
 301         int const r = remaining_time ();
 302
 303         int pc = rint (p * 100);
 304         if (pc == 100) {
 305                 /* 100% makes it sound like we've finished when we haven't */
 306                 pc = 99;
 307         }
 308
 309         SafeStringStream s;
 310         if (!finished ()) {
 311                 s << pc << N_("%");
 312                 if (p >= 0 && t > 10 && r > 0) {
 313                         /// TRANSLATORS: remaining here follows an amount of time that is remaining
 314                         /// on an operation.
 315                         s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
 316                 }
 317         } else if (finished_ok ()) {
 318                 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
 319         } else if (finished_in_error ()) {
 320                 s << String::compose (_("Error (%1)"), error_summary());
 321         } else if (finished_cancelled ()) {
 322                 s << _("Cancelled");
 323         }
 324
 325         return s.str ();
 326 }
 327
 328 /** @return An estimate of the remaining time for this sub-job, in seconds */
 329 int
 330 Job::remaining_time () const
 331 {
 332         return elapsed_time() / progress() - elapsed_time();
 333 }
 334
 335 void
 336 Job::cancel ()
 337 {
 338         if (!_thread) {
 339                 return;
 340         }
 341
 342         _thread->interrupt ();
 343         _thread->join ();
 344 }
 345
 346 void
 347 Job::pause ()
 348 {
 349         if (running ()) {
 350                 set_state (PAUSED);
 351         }
 352 }
 353
 354 void
 355 Job::resume ()
 356 {
 357         if (paused ()) {
 358                 set_state (RUNNING);
 359         }
 360 }