X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2FSystemcall.cpp;h=7c4eaabc979490ae61930b290425582e83e262e5;hb=b198a36a363bb6a084407d476942d68ef5fb5e86;hp=3db5fd0a40d04783eee074aae948b3be63ab1a46;hpb=2301c5af8f8d12700a565467d28b19534d29543f;p=lyx.git diff --git a/src/support/Systemcall.cpp b/src/support/Systemcall.cpp index 3db5fd0a40..7c4eaabc97 100644 --- a/src/support/Systemcall.cpp +++ b/src/support/Systemcall.cpp @@ -4,9 +4,9 @@ * Licence details can be found in the file COPYING. * * \author Asger Alstrup - * - * Interface cleaned up by * \author Angus Leeming + * \author Enrico Forestieri + * \author Peter Kuemmel * * Full author contact details are available in file CREDITS. */ @@ -14,37 +14,99 @@ #include #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" +#include "support/SystemcallPrivate.h" #include "support/os.h" +#include "support/ProgressInterface.h" + +#include "LyX.h" #include #include #include +#include +#include +#include +#include #define USE_QPROCESS + +struct Sleep : QThread +{ + static void millisec(unsigned long ms) + { + QThread::usleep(ms * 1000); + } +}; + + + + using namespace std; namespace lyx { namespace support { -static void killProcess(QProcess * p) + +class ProgressDummy : public ProgressInterface { - p->closeReadChannel(QProcess::StandardOutput); - p->closeReadChannel(QProcess::StandardError); - p->close(); - delete p; +public: + ProgressDummy() {} + + void processStarted(QString const &) override {} + void processFinished(QString const &) override {} + void appendMessage(QString const &) override {} + void appendError(QString const &) override {} + void clearMessages() override {} + void lyxerrFlush() override {} + + void lyxerrConnect() override {} + void lyxerrDisconnect() override {} + + void warning(QString const &, QString const &) override {} + void toggleWarning(QString const &, QString const &, QString const &) override {} + void error(QString const &, QString const &, QString const &) override {} + void information(QString const &, QString const &) override {} + int prompt(docstring const &, docstring const &, int default_but, int, + docstring const &, docstring const &) override { return default_but; } +}; + + +static ProgressInterface * progress_instance = nullptr; + +void ProgressInterface::setInstance(ProgressInterface* p) +{ + progress_instance = p; } +ProgressInterface * ProgressInterface::instance() +{ + if (!progress_instance) { + static ProgressDummy dummy; + return &dummy; + } + return progress_instance; +} + + + + // Reuse of instance #ifndef USE_QPROCESS -int Systemcall::startscript(Starttype how, string const & what) +int Systemcall::startscript(Starttype how, string const & what, + string const & path, string const & lpath, + bool /*process_events*/) { - string command = what; + string command = + to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath))) + + commandPrep(what); if (how == DontWait) { switch (os::shell()) { @@ -55,7 +117,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()); } @@ -64,89 +127,588 @@ int Systemcall::startscript(Starttype how, string const & what) namespace { -string const parsecmd(string const & cmd, string & outfile) +/* + * 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 + * character, with the exception of a double-quote '"'. If a double-quote + * follows a backslash, it will be replaced by three consecutive double-quotes + * (this is how the QProcess parser recognizes a '"' as a simple character + * instead of a quoting character). Thus, for example: + * \\ -> \ + * \a -> a + * \" -> """ + * + * Single-quotes. + * Characters enclosed in single-quotes ('') have their literal value preserved. + * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot + * be used to escape a single-quote in a single-quoted string. In other words, + * anything enclosed in single-quotes is passed as is, but the single-quotes + * themselves are eliminated. Thus, for example: + * '\' -> \ + * '\\' -> \\ + * '\a' -> \a + * 'a\"b' -> a\"b + * + * Double-quotes. + * Characters enclosed in double-quotes ("") have their literal value preserved, + * with the exception of the backslash. The backslash retains its special + * meaning as an escape character only when followed by a double-quote. + * Contrarily to the behavior of a posix shell, the double-quotes themselves + * are *not* eliminated. Thus, for example: + * "\\" -> "\\" + * "\a" -> "\a" + * "a\"b" -> "a"""b" + */ +string const parsecmd(string const & incmd, string & infile, string & outfile, + string & errfile) { - bool inquote = false; + bool in_single_quote = false; + bool in_double_quote = false; bool escaped = false; + string const python_call = os::python(); + vector outcmd(4); + size_t start = 0; - for (size_t i = 0; i < cmd.length(); ++i) { - char c = cmd[i]; - if (c == '"' && !escaped) - inquote = !inquote; - else if (c == '\\' && !escaped) - escaped = !escaped; - else if (c == '>' && !(inquote || escaped)) { - outfile = trim(cmd.substr(i + 1), " \""); - return trim(cmd.substr(0, i)); - } else - escaped = false; + if (prefixIs(incmd, python_call)) { + outcmd[0] = os::python(); + start = python_call.length(); } - outfile.erase(); - return cmd; + 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) + outcmd[o] += '\\'; + outcmd[o] += c; + } else + in_single_quote = !in_single_quote; + escaped = false; + continue; + } + if (in_single_quote) { + outcmd[o] += c; + continue; + } + if (c == '"') { + if (escaped) { + // Don't triple double-quotes for redirection + // files as these won't be parsed by QProcess + outcmd[o] += string(o ? "\"" : "\"\"\""); + escaped = false; + } else { + outcmd[o] += c; + in_double_quote = !in_double_quote; + } + } else if (c == '\\' && !escaped) { + escaped = true; + } else if (c == '>' && !(in_double_quote || escaped)) { + 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; +#if defined (USE_MACOSX_PACKAGING) + } else if (o == 0 && i > 4 && c == ' ' && !(in_double_quote || escaped)) { + // if a macOS app is detected with an additional argument + // use open command as prefix to get it work + const size_t apos = outcmd[o].rfind(".app"); + const size_t len = outcmd[o].length(); + const bool quoted = outcmd[o].at(len - 1) == '"' && outcmd[o].at(0) == '"'; + const string & ocmd = "open -a "; + if (apos != string::npos && + (apos == (len - 4) || (apos == (len - 5) && quoted)) && + !prefixIs(trim(outcmd[o]), ocmd)) { + outcmd[o] = ocmd + outcmd[o]; + } + outcmd[o] += c; +#endif + } else { + if (escaped && in_double_quote) + outcmd[o] += '\\'; + outcmd[o] += c; + escaped = false; + } + } + infile = trim(outcmd[3], " \""); + outfile = trim(outcmd[1], " \""); + errfile = trim(outcmd[2], " \""); + return trim(outcmd[0]); } -} // namespace anon +} // namespace + + +void Systemcall::killscript() +{ + SystemcallPrivate::kill_script = true; +} -int Systemcall::startscript(Starttype how, string const & what) +int Systemcall::startscript(Starttype how, string const & what, + string const & path, string const & lpath, + bool process_events) { + string const what_ss = commandPrep(what); + if (verbose) + lyxerr << "\nRunning: " << what_ss << endl; + else + LYXERR(Debug::INFO,"Running: " << what_ss); + + string infile; string outfile; - QString cmd = toqstr(parsecmd(what, outfile)); - QProcess * process = new QProcess; - - // Qt won't start the process if we redirect stdout/stderr in - // this way and they are not connected to a terminal (maybe - // because we were launched from some desktop GUI). - if (!outfile.empty()) { - // Check whether we have to simply throw away the output. - if (outfile != os::nulldev()) - process->setStandardOutputFile(toqstr(outfile)); - } else if (os::is_terminal(os::STDOUT)) - process->setStandardOutputFile(toqstr(os::stdoutdev())); - if (os::is_terminal(os::STDERR)) - process->setStandardErrorFile(toqstr(os::stderrdev())); - - process->start(cmd); - if (!process->waitForStarted(3000)) { - LYXERR0("Qprocess " << cmd << " did not start!"); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); - return 10; - } - if (how == DontWait) - return 0; - - if (!process->waitForFinished(180000)) { - LYXERR0("Qprocess " << cmd << " did not finished!"); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); - return 20; - } - int const exit_code = process->exitCode(); + string errfile; + QString const cmd = QString::fromLocal8Bit( + parsecmd(what_ss, infile, outfile, errfile).c_str()); + + SystemcallPrivate d(infile, outfile, errfile); + bool do_events = process_events || how == WaitLoop; + + d.startProcess(cmd, path, lpath, how == DontWait); + if (how == DontWait && d.state == SystemcallPrivate::Running) + return OK; + + if (d.state == SystemcallPrivate::Error + || !d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) { + if (d.state == SystemcallPrivate::Error) { + LYXERR0("Systemcall: '" << cmd << "' did not start!"); + LYXERR0("error " << d.errorMessage()); + return NOSTART; + } else if (d.state == SystemcallPrivate::Killed) { + LYXERR0("Killed: " << cmd); + return KILLED; + } + } + + if (!d.waitWhile(SystemcallPrivate::Running, do_events, + os::timeout_ms())) { + if (d.state == SystemcallPrivate::Killed) { + LYXERR0("Killed: " << cmd); + return KILLED; + } + LYXERR0("Systemcall: '" << cmd << "' did not finish!"); + LYXERR0("error " << d.errorMessage()); + LYXERR0("status " << d.exitStatusMessage()); + return TIMEOUT; + } + + int const exit_code = d.exitCode(); if (exit_code) { - LYXERR0("Qprocess " << cmd << " finished!"); - LYXERR0("exitCode " << process->exitCode()); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); - } - - // 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( - process->readAllStandardOutput().data())); - if (!os::is_terminal(os::STDERR)) - cerr << fromqstr(QString::fromLocal8Bit( - process->readAllStandardError().data())); - - killProcess(process); + LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code); + } + return exit_code; } + + +bool SystemcallPrivate::kill_script = false; + + +SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of, + std::string const & ef) + : state(Error), process_(new QProcess), out_index_(0), err_index_(0), + in_file_(sf), out_file_(of), err_file_(ef), process_events_(false) +{ + 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())); +#if QT_VERSION >= 0x050600 + connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError))); +#else + connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError))); +#endif + connect(process_, SIGNAL(started()), this, SLOT(processStarted())); + connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus))); +} + + +void SystemcallPrivate::startProcess(QString const & cmd, string const & path, + string const & lpath, bool detached) +{ + cmd_ = cmd; +#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) + // FIXME pass command and arguments separated in the first place + /* The versions of startDetached() and start() that accept a + * QStringList object exist since Qt4, but it is only in Qt 5.15 + * that splitCommand() was introduced and the plain versions of + * start/startDetached() have been deprecated. + * The cleanest solution would be to have parsecmd() produce a + * QStringList for arguments, instead of transforming the string + * into something that the QProcess splitter accepts. + * + * Another reason for doing that is that the Qt parser ignores + * empty "" arguments, which are needed in some instances (see + * e.g. the work around for modules in Converter:convert. See + * QTBUG-80640 for a discussion. + */ + QStringList arguments = QProcess::splitCommand(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_); + QString command = (arguments.empty()) ? QString() : arguments.first(); + if (arguments.size() == 1) + arguments.clear(); + else if (!arguments.empty()) + arguments.removeFirst(); +#endif + if (detached) { + state = SystemcallPrivate::Running; +#ifdef Q_OS_WIN32 + // Avoid opening a console window when a viewer is started + if (in_file_.empty()) + process_->setStandardInputFile(QProcess::nullDevice()); + if (out_file_.empty()) + process_->setStandardOutputFile(QProcess::nullDevice()); + if (err_file_.empty()) + process_->setStandardErrorFile(QProcess::nullDevice()); +#endif +#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) + if (!QProcess::startDetached(command, arguments)) { +#else + if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) { +#endif + state = SystemcallPrivate::Error; + return; + } + QProcess* released = releaseProcess(); + delete released; + } else if (process_) { + state = SystemcallPrivate::Starting; +#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) + process_->start(command, arguments); +#else + process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_); +#endif + } +} + + +bool SystemcallPrivate::waitAndCheck() +{ + Sleep::millisec(100); + if (kill_script) { + // is there a better place to reset this? + process_->kill(); + state = Killed; + kill_script = false; + LYXERR0("Export Canceled!!"); + return false; + } + QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/); + return true; +} + + +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; +} + +} // namespace + + +bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout) +{ + if (!process_) + return false; + + bool timedout = false; + process_events_ = process_events; + + // Block GUI while waiting, + // relay on QProcess' wait functions + if (!process_events_) { + if (waitwhile == Starting) + return process_->waitForStarted(timeout); + if (waitwhile == Running) { + int bump = 2; + while (!timedout) { + if (process_->waitForFinished(timeout)) + return true; + bool const 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; + } + + // process events while waiting, no timeout + if (timeout == -1) { + while (state == waitwhile && state != Error) { + // check for cancellation of background process + if (!waitAndCheck()) + return false; + } + return state != Error; + } + + // process events while waiting with timeout + QElapsedTimer timer; + timer.start(); + while (state == waitwhile && state != Error && !timedout) { + // check for cancellation of background process + if (!waitAndCheck()) + return false; + + if (timer.elapsed() > timeout) { + bool const 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) && !timedout; +} + + +SystemcallPrivate::~SystemcallPrivate() +{ + if (out_index_) { + out_data_[out_index_] = '\0'; + out_index_ = 0; + cout << out_data_; + } + cout.flush(); + if (err_index_) { + err_data_[err_index_] = '\0'; + err_index_ = 0; + cerr << err_data_; + } + cerr.flush(); + + killProcess(); +} + + +void SystemcallPrivate::stdOut() +{ + if (process_) { + char c; + 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_; + } + } + } +} + + +void SystemcallPrivate::stdErr() +{ + if (process_) { + char c; + 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_; + } + } + } +} + + +void SystemcallPrivate::processStarted() +{ + if (state != Running) { + state = Running; + ProgressInterface::instance()->processStarted(cmd_); + } +} + + +void SystemcallPrivate::processFinished(int, QProcess::ExitStatus) +{ + if (state != Finished) { + state = Finished; + ProgressInterface::instance()->processFinished(cmd_); + } +} + + +void SystemcallPrivate::processError(QProcess::ProcessError) +{ + state = Error; + ProgressInterface::instance()->appendError(errorMessage()); +} + + +QString SystemcallPrivate::errorMessage() const +{ + if (!process_) + return "No QProcess available"; + + QString message; + 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."; + break; + case QProcess::Crashed: + message = "The process crashed some time after starting successfully."; + break; + case QProcess::Timedout: + message = "The process timed out. It might be restarted automatically."; + break; + case QProcess::WriteError: + message = "An error occurred when attempting to write to the process-> For example, " + "the process may not be running, or it may have closed its input channel."; + break; + case QProcess::ReadError: + message = "An error occurred when attempting to read from the process-> For example, " + "the process may not be running."; + break; + case QProcess::UnknownError: + default: + message = "An unknown error occurred."; + break; + } + return message; +} + + +QString SystemcallPrivate::exitStatusMessage() const +{ + if (!process_) + return "No QProcess available"; + + QString message; + switch (process_->exitStatus()) { + case QProcess::NormalExit: + message = "The process exited normally."; + break; + case QProcess::CrashExit: + message = "The process crashed."; + break; + default: + message = "Unknown exit state."; + break; + } + return message; +} + + +int SystemcallPrivate::exitCode() +{ + // From Qt's documentation, in regards to QProcess::exitCode(), + // "This value is not valid unless exitStatus() returns NormalExit" + if (!process_ || process_->exitStatus() != QProcess::NormalExit) + return -1; + + return process_->exitCode(); +} + + +QProcess* SystemcallPrivate::releaseProcess() +{ + QProcess* released = process_; + process_ = nullptr; + return released; +} + + +void SystemcallPrivate::killProcess() +{ + killProcess(process_); +} + + +void SystemcallPrivate::killProcess(QProcess * p) +{ + if (p) { + p->disconnect(); + p->closeReadChannel(QProcess::StandardOutput); + p->closeReadChannel(QProcess::StandardError); + p->close(); + delete p; + } +} + + + +#include "moc_SystemcallPrivate.cpp" #endif } // namespace support