Extract all uses of DCP-o-matic name to allow branding.

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

diff --git a/src/lib/job.cc b/src/lib/job.cc
index 912c6a6ef3c961374a81bd4863509a94d0c524f2..94c23aac68d2621c40c69b055d541dccda95cf6f 100644 (file)
--- a/src/lib/job.cc
+++ b/src/lib/job.cc
@@ -33,11 +33,13 @@
 #include "job.h"
 #include "log.h"
 #include "util.h"
+#include "variant.h"
 #include <dcp/exceptions.h>
 #include <sub/exceptions.h>
 #include <boost/date_time/posix_time/posix_time.hpp>
 #include <boost/filesystem.hpp>
 #include <boost/thread.hpp>
+#include <time.h>
 #include <iostream>
 
 #include "i18n.h"
@@ -56,10 +58,9 @@ using namespace dcpomatic;
 Job::Job (shared_ptr<const Film> film)
        : _film (film)
        , _state (NEW)
-       , _start_time (0)
        , _sub_start_time (0)
        , _progress (0)
-       , _ran_for (0)
+       , _rate_limit_progress(true)
 {
 
 }
@@ -112,10 +113,10 @@ Job::run_wrapper ()
 
        } catch (dcp::FileError& e) {
 
-               string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
+               string m = String::compose(_("An error occurred whilst handling the file %1."), e.filename().filename());
 
                try {
-                       auto const s = boost::filesystem::space (e.filename());
+                       auto const s = dcp::filesystem::space(e.filename());
                        if (s.available < pow (1024, 3)) {
                                m += N_("\n\n");
                                m += _("The drive that the film is stored on is low in disc space.  Free some more space and try again.");
@@ -137,9 +138,13 @@ Job::run_wrapper ()
                /* 32-bit */
                set_error (
                        _("Failed to encode the DCP."),
-                       _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and "
-                         "trying to use too many encoding threads.  Please reduce the 'number of threads DCP-o-matic should "
-                         "use' in the General tab of Preferences and try again.")
+                       String::compose(
+                               _("This error has probably occurred because you are running the 32-bit version of %1 and "
+                                 "trying to use too many encoding threads.  Please reduce the 'number of threads %2 should "
+                                 "use' in the General tab of Preferences and try again."),
+                               variant::dcpomatic(),
+                               variant::dcpomatic()
+                               )
                        );
                done = true;
 #else
@@ -147,7 +152,12 @@ Job::run_wrapper ()
                if (running_32_on_64()) {
                        set_error (
                                _("Failed to encode the DCP."),
-                               _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic.  Please re-install DCP-o-matic with the 64-bit installer and try again.")
+                               String::compose(
+                                       _("This error has probably occurred because you are running the 32-bit version of %1.  "
+                                         "Please re-install %2 with the 64-bit installer and try again."),
+                                       variant::dcpomatic(),
+                                       variant::dcpomatic()
+                                       )
                                );
                        done = true;
                }
@@ -168,9 +178,9 @@ Job::run_wrapper ()
 
                set_error (
                        String::compose (_("Could not open %1"), e.file().string()),
-                       String::compose (
-                               _("DCP-o-matic could not open the file %1 (%2).  Perhaps it does not exist or is in an unexpected format."),
-                               boost::filesystem::absolute (e.file()).string(),
+                       String::compose(_("%1 could not open the file %2 (%3).  Perhaps it does not exist or is in an unexpected format."),
+                               variant::dcpomatic(),
+                               dcp::filesystem::absolute(e.file()).string(),
                                e.what()
                                )
                        );
@@ -183,9 +193,9 @@ Job::run_wrapper ()
                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 (%2).  Perhaps it does not exist or is in an unexpected format."),
-                                       boost::filesystem::absolute (e.path1()).string(),
+                               String::compose(_("%1 could not open the file %2 (%3).  Perhaps it does not exist or is in an unexpected format."),
+                                       variant::dcpomatic(),
+                                       dcp::filesystem::absolute(e.path1()).string(),
                                        e.what()
                                        )
                                );
@@ -242,6 +252,12 @@ Job::run_wrapper ()
                set_progress(1);
                set_state(FINISHED_ERROR);
 
+       } catch (MissingConfigurationError& e) {
+
+               set_error(e.what());
+               set_progress(1);
+               set_state(FINISHED_ERROR);
+
        } catch (std::exception& e) {
 
                set_error (
@@ -351,7 +367,7 @@ Job::set_state (State s)
                _state = s;
 
                if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
-                       _ran_for = time(0) - _start_time;
+                       _finish_time = time(nullptr);
                        finished = true;
                        _sub_name.clear ();
                }
@@ -433,7 +449,7 @@ Job::set_progress (float p, bool force)
 {
        check_for_interruption_or_pause ();
 
-       if (!force) {
+       if (!force && _rate_limit_progress) {
                /* Check for excessively frequent progress reporting */
                boost::mutex::scoped_lock lm (_progress_mutex);
                struct timeval now;
@@ -589,7 +605,22 @@ Job::status () const
                                );
                }
        } else if (finished_ok ()) {
-               s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
+               auto time_string = [](time_t time) {
+                       auto tm = localtime(&time);
+                       char buffer[8];
+                       snprintf(buffer, sizeof(buffer), "%02d:%02d", tm->tm_hour, tm->tm_min);
+                       return string(buffer);
+               };
+               auto const duration = _finish_time - _start_time;
+               if (duration < 10) {
+                       /* It took less than 10 seconds; it doesn't seem worth saying how long it took */
+                       s = _("OK");
+               } else if (duration < 600) {
+                       /* It took less than 10 minutes; it doesn't seem worth saying when it started and finished */
+                       s = String::compose(_("OK (ran for %1)"), seconds_to_hms(duration));
+               } else {
+                       s = String::compose(_("OK (ran for %1 from %2 to %3)"),  seconds_to_hms(duration), time_string(_start_time), time_string(_finish_time));
+               }
        } else if (finished_in_error ()) {
                s = String::compose (_("Error: %1"), error_summary ());
        } else if (finished_cancelled ()) {
@@ -641,7 +672,7 @@ void
 Job::cancel ()
 {
        if (_thread.joinable()) {
-               resume();
+               Job::resume();
 
                _thread.interrupt ();
                _thread.join ();
@@ -668,6 +699,7 @@ Job::pause_by_user ()
        }
 
        if (paused) {
+               pause();
                _pause_changed.notify_all ();
        }
 
@@ -680,6 +712,7 @@ Job::pause_by_priority ()
 {
        if (running ()) {
                set_state (PAUSED_BY_PRIORITY);
+               pause();
                _pause_changed.notify_all ();
        }
 }
@@ -721,3 +754,11 @@ Job::set_message (string m)
        boost::mutex::scoped_lock lm (_state_mutex);
        _message = m;
 }
+
+
+void
+Job::set_rate_limit_progress(bool rate_limit)
+{
+       _rate_limit_progress = rate_limit;
+}
+