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         boost::mutex::scoped_lock lm2 (_state_mutex);
 234         while (_state == PAUSED) {
 235                 _pause_changed.wait (lm2);
 236         }
 237
 238         if (ui_signaller) {
 239                 ui_signaller->emit (boost::bind (boost::ref (Progress)));
 240         }
 241 }
 242
 243 /** @return fractional progress of the current sub-job, or -1 if not known */
 244 float
 245 Job::progress () const
 246 {
 247         boost::mutex::scoped_lock lm (_progress_mutex);
 248         return _progress.get_value_or (-1);
 249 }
 250
 251 void
 252 Job::sub (string n)
 253 {
 254         {
 255                 boost::mutex::scoped_lock lm (_progress_mutex);
 256                 _sub_name = n;
 257         }
 258
 259         set_progress (0, true);
 260 }
 261
 262 string
 263 Job::error_details () const
 264 {
 265         boost::mutex::scoped_lock lm (_state_mutex);
 266         return _error_details;
 267 }
 268
 269 /** @return A summary of any error that the job has generated */
 270 string
 271 Job::error_summary () const
 272 {
 273         boost::mutex::scoped_lock lm (_state_mutex);
 274         return _error_summary;
 275 }
 276
 277 /** Set the current error string.
 278  *  @param e New error string.
 279  */
 280 void
 281 Job::set_error (string s, string d)
 282 {
 283         boost::mutex::scoped_lock lm (_state_mutex);
 284         _error_summary = s;
 285         _error_details = d;
 286 }
 287
 288 /** Say that this job's progress will be unknown until further notice */
 289 void
 290 Job::set_progress_unknown ()
 291 {
 292         boost::mutex::scoped_lock lm (_progress_mutex);
 293         _progress.reset ();
 294 }
 295
 296 /** @return Human-readable status of this job */
 297 string
 298 Job::status () const
 299 {
 300         float const p = progress ();
 301         int const t = elapsed_time ();
 302         int const r = remaining_time ();
 303
 304         int pc = rint (p * 100);
 305         if (pc == 100) {
 306                 /* 100% makes it sound like we've finished when we haven't */
 307                 pc = 99;
 308         }
 309
 310         SafeStringStream s;
 311         if (!finished ()) {
 312                 s << pc << N_("%");
 313                 if (p >= 0 && t > 10 && r > 0) {
 314                         /// TRANSLATORS: remaining here follows an amount of time that is remaining
 315                         /// on an operation.
 316                         s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
 317                 }
 318         } else if (finished_ok ()) {
 319                 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
 320         } else if (finished_in_error ()) {
 321                 s << String::compose (_("Error (%1)"), error_summary());
 322         } else if (finished_cancelled ()) {
 323                 s << _("Cancelled");
 324         }
 325
 326         return s.str ();
 327 }
 328
 329 /** @return An estimate of the remaining time for this sub-job, in seconds */
 330 int
 331 Job::remaining_time () const
 332 {
 333         return elapsed_time() / progress() - elapsed_time();
 334 }
 335
 336 void
 337 Job::cancel ()
 338 {
 339         if (!_thread) {
 340                 return;
 341         }
 342
 343         _thread->interrupt ();
 344         _thread->join ();
 345 }
 346
 347 void
 348 Job::pause ()
 349 {
 350         if (running ()) {
 351                 set_state (PAUSED);
 352                 _pause_changed.notify_all ();
 353         }
 354 }
 355
 356 void
 357 Job::resume ()
 358 {
 359         if (paused ()) {
 360                 set_state (RUNNING);
 361                 _pause_changed.notify_all ();
 362         }
 363 }