Logging improvements to allow prettier displays in the server GUI.

[dcpomatic.git] / src / lib / job.cc

diff --git a/src/lib/job.cc b/src/lib/job.cc
index e5d0933f83d7572477a0222972ddb1a80ea3ee38..35f5834080af4ab9de1f876a52656961631532c9 100644 (file)
--- a/src/lib/job.cc
+++ b/src/lib/job.cc
@@ -17,19 +17,21 @@
 
 */
 
-/** @file src/job.cc
+/** @file  src/job.cc
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
 
-#include <boost/thread.hpp>
-#include <boost/filesystem.hpp>
-#include <dcp/exceptions.h>
 #include "job.h"
 #include "util.h"
 #include "cross.h"
 #include "exceptions.h"
 #include "film.h"
 #include "log.h"
+#include "compose.hpp"
+#include <dcp/exceptions.h>
+#include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -38,11 +40,13 @@ using std::list;
 using std::cout;
 using boost::shared_ptr;
 using boost::optional;
+using boost::function;
 
-#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
+#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
 
-Job::Job (shared_ptr<const Film> f)
-       : _film (f)
+/** @param film Associated film, or 0 */
+Job::Job (shared_ptr<const Film> film)
+       : _film (film)
        , _thread (0)
        , _state (NEW)
        , _start_time (0)
@@ -52,6 +56,17 @@ Job::Job (shared_ptr<const Film> f)
 
 }
 
+Job::~Job ()
+{
+       if (_thread) {
+               _thread->interrupt ();
+               DCPOMATIC_ASSERT (_thread->joinable ());
+               _thread->join ();
+       }
+
+       delete _thread;
+}
+
 /** Start the job in a separate thread, returning immediately */
 void
 Job::start ()
@@ -86,7 +101,7 @@ Job::run_wrapper ()
                set_error (e.what(), m);
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (OpenFileError& e) {
 
                set_error (
@@ -97,16 +112,33 @@ Job::run_wrapper ()
                set_progress (1);
                set_state (FINISHED_ERROR);
 
+       } catch (boost::filesystem::filesystem_error& e) {
+
+               if (e.code() == boost::system::errc::no_such_file_or_directory) {
+                       set_error (
+                               String::compose (_("Could not open %1"), e.path1().string ()),
+                               String::compose (_("DCP-o-matic could not open the file %1.  Perhaps it does not exist or is in an unexpected format."), e.path1().string())
+                               );
+               } else {
+                       set_error (
+                               e.what (),
+                               string (_("It is not known what caused this error.")) + "  " + REPORT_PROBLEM
+                               );
+               }
+
+               set_progress (1);
+               set_state (FINISHED_ERROR);
+
        } catch (boost::thread_interrupted &) {
 
                set_state (FINISHED_CANCELLED);
 
        } catch (std::bad_alloc& e) {
 
-               set_error (_("Out of memory"), _("There was not enough memory to do this."));
+               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."));
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (std::exception& e) {
 
                set_error (
@@ -116,7 +148,7 @@ Job::run_wrapper ()
 
                set_progress (1);
                set_state (FINISHED_ERROR);
-               
+
        } catch (...) {
 
                set_error (
@@ -182,7 +214,7 @@ Job::paused () const
        boost::mutex::scoped_lock lm (_state_mutex);
        return _state == PAUSED;
 }
-       
+
 /** Set the state of this job.
  *  @param s New state.
  */
@@ -204,7 +236,7 @@ Job::set_state (State s)
 
        if (finished) {
                emit (boost::bind (boost::ref (Finished)));
-       }       
+       }
 }
 
 /** @return DCPTime (in seconds) that this sub-job has been running */
@@ -214,7 +246,7 @@ Job::elapsed_time () const
        if (_start_time == 0) {
                return 0;
        }
-       
+
        return time (0) - _start_time;
 }
 
@@ -229,6 +261,12 @@ Job::set_progress (float p, bool force)
                return;
        }
 
+       set_progress_common (p);
+}
+
+void
+Job::set_progress_common (optional<float> p)
+{
        boost::mutex::scoped_lock lm (_progress_mutex);
        _progress = p;
        boost::this_thread::interruption_point ();
@@ -259,7 +297,7 @@ Job::sub (string n)
                boost::mutex::scoped_lock lm (_progress_mutex);
                _sub_name = n;
        }
-       
+
        set_progress (0, true);
 }
 
@@ -284,10 +322,12 @@ Job::error_summary () const
 void
 Job::set_error (string s, string d)
 {
-       LOG_ERROR_NC (s);
-       LOG_ERROR_NC (d);
-       
-       _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
+       if (_film) {
+               LOG_ERROR_NC (s);
+               LOG_ERROR_NC (d);
+               _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
+       }
+
        boost::mutex::scoped_lock lm (_state_mutex);
        _error_summary = s;
        _error_details = d;
@@ -297,11 +337,7 @@ Job::set_error (string s, string d)
 void
 Job::set_progress_unknown ()
 {
-       boost::mutex::scoped_lock lm (_progress_mutex);
-       _progress.reset ();
-       lm.unlock ();
-
-       emit (boost::bind (boost::ref (Progress)));
+       set_progress_common (optional<float> ());
 }
 
 /** @return Human-readable status of this job */
@@ -314,14 +350,14 @@ Job::status () const
 
        SafeStringStream s;
        if (!finished () && p) {
-               int pc = rint (p.get() * 100);
+               int pc = lrintf (p.get() * 100);
                if (pc == 100) {
                        /* 100% makes it sound like we've finished when we haven't */
                        pc = 99;
                }
-               
+
                s << pc << N_("%");
-               
+
                if (t > 10 && r > 0) {
                        /// TRANSLATORS: remaining here follows an amount of time that is remaining
                        /// on an operation.
@@ -330,7 +366,7 @@ Job::status () const
        } else if (finished_ok ()) {
                s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
        } else if (finished_in_error ()) {
-               s << String::compose (_("Error (%1)"), error_summary ());
+               s << String::compose (_("Error: %1"), error_summary ());
        } else if (finished_cancelled ()) {
                s << _("Cancelled");
        }
@@ -368,7 +404,7 @@ Job::remaining_time () const
        if (progress().get_value_or(0) == 0) {
                return elapsed_time ();
        }
-       
+
        return elapsed_time() / progress().get() - elapsed_time();
 }
 
@@ -379,8 +415,15 @@ Job::cancel ()
                return;
        }
 
+       if (paused ()) {
+               resume ();
+       }
+
        _thread->interrupt ();
+       DCPOMATIC_ASSERT (_thread->joinable ());
        _thread->join ();
+       delete _thread;
+       _thread = 0;
 }
 
 void
@@ -400,3 +443,14 @@ Job::resume ()
                _pause_changed.notify_all ();
        }
 }
+
+void
+Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+               finished ();
+       } else {
+               connection = Finished.connect (finished);
+       }
+}