]> git.lyx.org Git - lyx.git/blobdiff - src/support/Systemcall.cpp
A first batch of potential bugs spotted by llvm/clang
[lyx.git] / src / support / Systemcall.cpp
index 1a23f93c06078cd855d0cf525e0b8b823c044a0c..ca804096603eb81b7f35732fe6bac5e6ac8820ab 100644 (file)
@@ -14,6 +14,8 @@
 #include <config.h>
 
 #include "support/debug.h"
+#include "support/filetools.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/qstring_helpers.h"
 #include "support/Systemcall.h"
@@ -21,6 +23,7 @@
 #include "support/os.h"
 #include "support/ProgressInterface.h"
 
+#include "LyXRC.h"
 
 #include <cstdlib>
 #include <iostream>
@@ -61,11 +64,17 @@ public:
        void appendMessage(QString const &) {}
        void appendError(QString const &) {}
        void clearMessages() {}
+       void lyxerrFlush() {}
+
+       void lyxerrConnect() {}
+       void lyxerrDisconnect() {}
 
        void warning(QString const &, QString const &) {}
        void toggleWarning(QString const &, QString const &, QString const &) {}
        void error(QString const &, QString const &) {}
        void information(QString const &, QString const &) {}
+       int prompt(docstring const &, docstring const &, int default_but, int,
+                  docstring const &, docstring const &) { return default_but; }
 };
 
 
@@ -92,9 +101,15 @@ ProgressInterface* ProgressInterface::instance()
 // Reuse of instance
 #ifndef USE_QPROCESS
 int Systemcall::startscript(Starttype how, string const & what,
-                                                       bool /*process_events*/)
+                           std::string const & path, bool /*process_events*/)
 {
-       string command = what;
+       string const python_call = "python -tt";
+       string command = to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path)));
+
+       if (prefixIs(what, python_call))
+               command += os::python() + what.substr(python_call.length());
+       else
+               command += what;
 
        if (how == DontWait) {
                switch (os::shell()) {
@@ -105,7 +120,8 @@ int Systemcall::startscript(Starttype how, string const & what,
                        command = "start /min " + command;
                        break;
                }
-       }
+       } else if (os::shell() == os::CMD_EXE)
+               command = subst(command, "cmd /d /c ", "");
 
        return ::system(command.c_str());
 }
@@ -115,8 +131,9 @@ int Systemcall::startscript(Starttype how, string const & what,
 namespace {
 
 /*
- * This is a parser that (mostly) mimics the behavior of a posix shell but
- * its output is tailored for being processed by QProcess.
+ * This is a parser that (mostly) mimics the behavior of a posix shell as
+ * regards quoting, but its output is tailored for being processed by QProcess.
+ * Note that shell metacharacters are not parsed.
  *
  * The escape character is the backslash.
  * A backslash that is not quoted preserves the literal value of the following
@@ -149,66 +166,92 @@ namespace {
  *    "\a"   ->  "\a"
  *    "a\"b" ->  "a"""b"
  */
-string const parsecmd(string const & inputcmd, string & outfile)
+string const parsecmd(string const & incmd, string & infile, string & outfile,
+                     string & errfile)
 {
        bool in_single_quote = false;
        bool in_double_quote = false;
        bool escaped = false;
-       string cmd;
+       string const python_call = "python -tt";
+       vector<string> outcmd(4);
+       size_t start = 0;
 
-       for (size_t i = 0; i < inputcmd.length(); ++i) {
-               char c = inputcmd[i];
+       if (prefixIs(incmd, python_call)) {
+               outcmd[0] = os::python();
+               start = python_call.length();
+       }
+
+       for (size_t i = start, o = 0; i < incmd.length(); ++i) {
+               char c = incmd[i];
                if (c == '\'') {
                        if (in_double_quote || escaped) {
                                if (in_double_quote && escaped)
-                                       cmd += '\\';
-                               cmd += c;
+                                       outcmd[o] += '\\';
+                               outcmd[o] += c;
                        } else
                                in_single_quote = !in_single_quote;
                        escaped = false;
                        continue;
                }
                if (in_single_quote) {
-                       cmd += c;
+                       outcmd[o] += c;
                        continue;
                }
                if (c == '"') {
                        if (escaped) {
-                               cmd += "\"\"\"";
+                               // Don't triple double-quotes for redirection
+                               // files as these won't be parsed by QProcess
+                               outcmd[o] += string(o ? "\"" : "\"\"\"");
                                escaped = false;
                        } else {
-                               cmd += c;
+                               outcmd[o] += c;
                                in_double_quote = !in_double_quote;
                        }
                } else if (c == '\\' && !escaped) {
                        escaped = !escaped;
                } else if (c == '>' && !(in_double_quote || escaped)) {
-                       outfile = trim(inputcmd.substr(i + 1), " \"");
-                       return trim(cmd);
+                       if (suffixIs(outcmd[o], " 2")) {
+                               outcmd[o] = rtrim(outcmd[o], "2");
+                               o = 2;
+                       } else {
+                               if (suffixIs(outcmd[o], " 1"))
+                                       outcmd[o] = rtrim(outcmd[o], "1");
+                               o = 1;
+                       }
+               } else if (c == '<' && !(in_double_quote || escaped)) {
+                       o = 3;
                } else {
                        if (escaped && in_double_quote)
-                               cmd += '\\';
-                       cmd += c;
+                               outcmd[o] += '\\';
+                       outcmd[o] += c;
                        escaped = false;
                }
        }
-       outfile.erase();
-       return cmd;
+       infile  = trim(outcmd[3], " \"");
+       outfile = trim(outcmd[1], " \"");
+       errfile = trim(outcmd[2], " \"");
+       return trim(outcmd[0]);
 }
 
 } // namespace anon
 
 
 
-int Systemcall::startscript(Starttype how, string const & what, bool process_events)
+int Systemcall::startscript(Starttype how, string const & what,
+                           string const & path, bool process_events)
 {
+       LYXERR(Debug::INFO,"Running: " << what);
+
+       string infile;
        string outfile;
-       QString cmd = toqstr(parsecmd(what, outfile));
+       string errfile;
+       QString const cmd = QString::fromLocal8Bit(
+                       parsecmd(what, infile, outfile, errfile).c_str());
 
-       SystemcallPrivate d(outfile);
+       SystemcallPrivate d(infile, outfile, errfile);
 
 
-       d.startProcess(cmd);
+       d.startProcess(cmd, path);
        if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
                LYXERR0("Systemcall: '" << cmd << "' did not start!");
                LYXERR0("error " << d.errorMessage());
@@ -221,8 +264,9 @@ int Systemcall::startscript(Starttype how, string const & what, bool process_eve
                return 0;
        }
 
-       if (!d.waitWhile(SystemcallPrivate::Running, process_events, 180000)) {
-               LYXERR0("Systemcall: '" << cmd << "' did not finished!");
+       if (!d.waitWhile(SystemcallPrivate::Running, process_events,
+                        os::timeout_min() * 60 * 1000)) {
+               LYXERR0("Systemcall: '" << cmd << "' did not finish!");
                LYXERR0("error " << d.errorMessage());
                LYXERR0("status " << d.exitStatusMessage());
                return 20;
@@ -237,41 +281,87 @@ int Systemcall::startscript(Starttype how, string const & what, bool process_eve
 }
 
 
-SystemcallPrivate::SystemcallPrivate(const std::string& of) : 
-                                proc_(new QProcess), outindex_(0), errindex_(0),
-                                outfile(of), showout_(false), showerr_(false), process_events(false)
+SystemcallPrivate::SystemcallPrivate(std::string const & sf,
+                                    std::string const & of,
+                                    std::string const & ef) :
+                               process_(new QProcess), 
+                               out_index_(0),
+                               err_index_(0),
+                               in_file_(sf),
+                               out_file_(of), 
+                               err_file_(ef), 
+                               process_events_(false)
 {
-       if (!outfile.empty()) {
-               // Check whether we have to simply throw away the output.
-               if (outfile != os::nulldev())
-                       proc_->setStandardOutputFile(toqstr(outfile));
-       } else if (os::is_terminal(os::STDOUT))
-               setShowOut(true);
-       if (os::is_terminal(os::STDERR))
-               setShowErr(true);
-
-       connect(proc_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
-       connect(proc_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
-       connect(proc_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
-       connect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
-       connect(proc_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
-}
+       if (!in_file_.empty())
+               process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
+       if (!out_file_.empty()) {
+               if (out_file_[0] == '&') {
+                       if (subst(out_file_, " ", "") == "&2"
+                           && err_file_[0] != '&') {
+                               out_file_ = err_file_;
+                               process_->setProcessChannelMode(
+                                               QProcess::MergedChannels);
+                       } else {
+                               if (err_file_[0] == '&') {
+                                       // Leave alone things such as
+                                       // "1>&2 2>&1". Should not be harmful,
+                                       // but let's give anyway a warning.
+                                       LYXERR0("Unsupported stdout/stderr redirect.");
+                                       err_file_.erase();
+                               } else {
+                                       LYXERR0("Ambiguous stdout redirect: "
+                                               << out_file_);
+                               }
+                               out_file_ = os::nulldev();
+                       }
+               }
+               // Check whether we have to set the output file.
+               if (out_file_ != os::nulldev()) {
+                       process_->setStandardOutputFile(QString::fromLocal8Bit(
+                                                       out_file_.c_str()));
+               }
+       }
+       if (!err_file_.empty()) {
+               if (err_file_[0] == '&') {
+                       if (subst(err_file_, " ", "") == "&1"
+                           && out_file_[0] != '&') {
+                               process_->setProcessChannelMode(
+                                               QProcess::MergedChannels);
+                       } else {
+                               LYXERR0("Ambiguous stderr redirect: "
+                                       << err_file_);
+                       }
+                       // In MergedChannels mode stderr goes to stdout.
+                       err_file_ = os::nulldev();
+               }
+               // Check whether we have to set the error file.
+               if (err_file_ != os::nulldev()) {
+                       process_->setStandardErrorFile(QString::fromLocal8Bit(
+                                                       err_file_.c_str()));
+               }
+       }
 
+       connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
+       connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
+       connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
+       connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
+       connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
+}
 
 
-void SystemcallPrivate::startProcess(const QString& cmd)
+void SystemcallPrivate::startProcess(QString const & cmd, string const & path)
 {
        cmd_ = cmd;
-       if (proc_) {
+       if (process_) {
                state = SystemcallPrivate::Starting;
-               proc_->start(cmd_);
+               process_->start(toqstr(latexEnvCmdPrefix(path)) + cmd_);
        }
 }
 
 
 void SystemcallPrivate::processEvents()
 {
-       if(process_events) {
+       if (process_events_) {
                QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
        }
 }
@@ -284,20 +374,51 @@ void SystemcallPrivate::waitAndProcessEvents()
 }
 
 
-bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout)
+namespace {
+
+bool queryStopCommand(QString const & cmd)
+{
+       docstring text = bformat(_(
+               "The command\n%1$s\nhas not yet completed.\n\n"
+               "Do you want to stop it?"), qstring_to_ucs4(cmd));
+       return ProgressInterface::instance()->prompt(_("Stop command?"), text,
+                       1, 1, _("&Stop it"), _("Let it &run")) == 0;
+}
+
+}
+
+
+bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
 {
-       if (!proc_)
+       if (!process_)
                return false;
 
-       process_events = proc_events;
+       bool timedout = false;
+       process_events_ = process_events;
 
        // Block GUI while waiting,
        // relay on QProcess' wait functions
-       if (!process_events) {
+       if (!process_events_) {
                if (waitwhile == Starting)
-                       return proc_->waitForStarted(timeout);
-               if (waitwhile == Running)
-                       return proc_->waitForFinished(timeout);
+                       return process_->waitForStarted(timeout);
+               if (waitwhile == Running) {
+                       int bump = 2;
+                       while (!timedout) {
+                               if (process_->waitForFinished(timeout))
+                                       return true;
+                               bool stop = queryStopCommand(cmd_);
+                               // The command may have finished in the meantime
+                               if (process_->state() == QProcess::NotRunning)
+                                       return true;
+                               if (stop) {
+                                       timedout = true;
+                                       process_->kill();
+                               } else {
+                                       timeout *= bump;
+                                       bump = 3;
+                               }
+                       }
+               }
                return false;
        }
 
@@ -309,32 +430,39 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout
                return state != Error;
        } 
 
-       // process events while waiting whith timeout
+       // process events while waiting with timeout
        QTime timer;
        timer.start();
-       while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
+       while (state == waitwhile && state != Error && !timedout) {
                waitAndProcessEvents();
+               if (timer.elapsed() > timeout) {
+                       bool stop = queryStopCommand(cmd_);
+                       // The command may have finished in the meantime
+                       if (process_->state() == QProcess::NotRunning)
+                               break;
+                       if (stop) {
+                               timedout = true;
+                               process_->kill();
+                       } else
+                               timeout *= 3;
+               }
        }
-       return (state != Error) && (timer.elapsed() < timeout);
+       return (state != Error) && !timedout;
 }
 
 
 SystemcallPrivate::~SystemcallPrivate()
 {
-       flush();
-
-       if (outindex_) {
-               outdata_[outindex_] = '\0';
-               outindex_ = 0;
-               if (showout_)
-                       cout << outdata_;
+       if (out_index_) {
+               out_data_[out_index_] = '\0';
+               out_index_ = 0;
+               cout << out_data_;
        }
        cout.flush();
-       if (errindex_) {
-               errdata_[errindex_] = '\0';
-               errindex_ = 0;
-               if (showerr_)
-                       cerr << errdata_;
+       if (err_index_) {
+               err_data_[err_index_] = '\0';
+               err_index_ = 0;
+               cerr << err_data_;
        }
        cerr.flush();
 
@@ -342,81 +470,57 @@ SystemcallPrivate::~SystemcallPrivate()
 }
 
 
-void SystemcallPrivate::flush()
-{
-       if (proc_) {
-               // If the output has been redirected, we write it all at once.
-               // Even if we are not running in a terminal, the output could go
-               // to some log file, for example ~/.xsession-errors on *nix.
-               if (!os::is_terminal(os::STDOUT) && outfile.empty())
-                       cout << fromqstr(QString::fromLocal8Bit(
-                                               proc_->readAllStandardOutput().data()));
-               if (!os::is_terminal(os::STDERR))
-                       cerr << fromqstr(QString::fromLocal8Bit(
-                                               proc_->readAllStandardError().data()));
-       }
-}
-
-
 void SystemcallPrivate::stdOut()
 {
-       if (proc_) {
+       if (process_) {
                char c;
-               proc_->setReadChannel(QProcess::StandardOutput);
-               while (proc_->getChar(&c)) {
-                       outdata_[outindex_++] = c;
-                       if (c == '\n' || outindex_ + 1 == bufsize_) {
-                               outdata_[outindex_] = '\0';
-                               outindex_ = 0;
-                               if (showout_)
-                                       cout << outdata_;
+               process_->setReadChannel(QProcess::StandardOutput);
+               while (process_->getChar(&c)) {
+                       out_data_[out_index_++] = c;
+                       if (c == '\n' || out_index_ + 1 == buffer_size_) {
+                               out_data_[out_index_] = '\0';
+                               out_index_ = 0;
+                               ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
+                               cout << out_data_;
                        }
                }
        }
-       const QString data = QString::fromLocal8Bit(outdata_);
-       if (!data.isEmpty()) {
-               // TODO No good messages from the processes. Disable batch mode?
-               //ProgressInterface::instance()->appendMessage(data);
-       }
-       processEvents();
 }
 
 
 void SystemcallPrivate::stdErr()
 {
-       if (proc_) {
+       if (process_) {
                char c;
-               proc_->setReadChannel(QProcess::StandardError);
-               while (proc_->getChar(&c)) {
-                       errdata_[errindex_++] = c;
-                       if (c == '\n' || errindex_ + 1 == bufsize_) {
-                               errdata_[errindex_] = '\0';
-                               errindex_ = 0;
-                               if (showerr_)
-                                       cerr << errdata_;
+               process_->setReadChannel(QProcess::StandardError);
+               while (process_->getChar(&c)) {
+                       err_data_[err_index_++] = c;
+                       if (c == '\n' || err_index_ + 1 == buffer_size_) {
+                               err_data_[err_index_] = '\0';
+                               err_index_ = 0;
+                               ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
+                               cerr << err_data_;
                        }
                }
        }
-       const QString data = QString::fromLocal8Bit(errdata_);
-       if (!data.isEmpty())
-               ProgressInterface::instance()->appendError(data);
-       processEvents();
 }
 
 
 void SystemcallPrivate::processStarted()
 {
        if (state != Running) {
-            state = Running;
-            ProgressInterface::instance()->processStarted(cmd_);
-        }
+               state = Running;
+               ProgressInterface::instance()->processStarted(cmd_);
+       }
 }
 
 
 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
 {
-       state = Finished;
-       ProgressInterface::instance()->processFinished(cmd_);
+       if (state != Finished) {
+               state = Finished;
+               ProgressInterface::instance()->processFinished(cmd_);
+       }
 }
 
 
@@ -429,11 +533,11 @@ void SystemcallPrivate::processError(QProcess::ProcessError)
 
 QString SystemcallPrivate::errorMessage() const 
 {
-       if (!proc_)
+       if (!process_)
                return "No QProcess available";
 
        QString message;
-       switch (proc_->error()) {
+       switch (process_->error()) {
                case QProcess::FailedToStart:
                        message = "The process failed to start. Either the invoked program is missing, "
                                      "or you may have insufficient permissions to invoke the program.";
@@ -463,11 +567,11 @@ QString SystemcallPrivate::errorMessage() const
 
 QString SystemcallPrivate::exitStatusMessage() const
 {
-       if (!proc_)
+       if (!process_)
                return "No QProcess available";
 
        QString message;
-       switch (proc_->exitStatus()) {
+       switch (process_->exitStatus()) {
                case QProcess::NormalExit:
                        message = "The process exited normally.";
                        break;
@@ -484,24 +588,24 @@ QString SystemcallPrivate::exitStatusMessage() const
 
 int SystemcallPrivate::exitCode()
 {
-       if (!proc_)
+       if (!process_)
                return -1;
 
-       return proc_->exitCode();
+       return process_->exitCode();
 }
 
 
 QProcess* SystemcallPrivate::releaseProcess()
 {
-       QProcess* released = proc_;
-       proc_ = 0;
+       QProcess* released = process_;
+       process_ = 0;
        return released;
 }
 
 
 void SystemcallPrivate::killProcess()
 {
-       killProcess(proc_);
+       killProcess(process_);
 }