3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Angus Leeming
8 * \author Enrico Forestieri
9 * \author Peter Kuemmel
11 * Full author contact details are available in file CREDITS.
16 #include "support/debug.h"
17 #include "support/filetools.h"
18 #include "support/gettext.h"
19 #include "support/lstrings.h"
20 #include "support/qstring_helpers.h"
21 #include "support/Systemcall.h"
22 #include "support/SystemcallPrivate.h"
23 #include "support/os.h"
24 #include "support/ProgressInterface.h"
32 #include <QElapsedTimer>
34 #include <QCoreApplication>
40 struct Sleep : QThread
42 static void millisec(unsigned long ms)
44 QThread::usleep(ms * 1000);
57 class ProgressDummy : public ProgressInterface
62 void processStarted(QString const &) override {}
63 void processFinished(QString const &) override {}
64 void appendMessage(QString const &) override {}
65 void appendError(QString const &) override {}
66 void clearMessages() override {}
67 void lyxerrFlush() override {}
69 void lyxerrConnect() override {}
70 void lyxerrDisconnect() override {}
72 void warning(QString const &, QString const &) override {}
73 void toggleWarning(QString const &, QString const &, QString const &) override {}
74 void error(QString const &, QString const &, QString const &) override {}
75 void information(QString const &, QString const &) override {}
76 int prompt(docstring const &, docstring const &, int default_but, int,
77 docstring const &, docstring const &) override { return default_but; }
81 static ProgressInterface * progress_instance = nullptr;
83 void ProgressInterface::setInstance(ProgressInterface* p)
85 progress_instance = p;
89 ProgressInterface * ProgressInterface::instance()
91 if (!progress_instance) {
92 static ProgressDummy dummy;
95 return progress_instance;
103 int Systemcall::startscript(Starttype how, string const & what,
104 string const & path, string const & lpath,
105 bool /*process_events*/)
108 to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
111 if (how == DontWait) {
112 switch (os::shell()) {
117 command = "start /min " + command;
120 } else if (os::shell() == os::CMD_EXE)
121 command = subst(command, "cmd /d /c ", "");
123 return ::system(command.c_str());
131 * This is a parser that (mostly) mimics the behavior of a posix shell as
132 * regards quoting, but its output is tailored for being processed by QProcess.
133 * Note that shell metacharacters are not parsed.
135 * The escape character is the backslash.
136 * A backslash that is not quoted preserves the literal value of the following
137 * character, with the exception of a double-quote '"'. If a double-quote
138 * follows a backslash, it will be replaced by three consecutive double-quotes
139 * (this is how the QProcess parser recognizes a '"' as a simple character
140 * instead of a quoting character). Thus, for example:
146 * Characters enclosed in single-quotes ('') have their literal value preserved.
147 * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
148 * be used to escape a single-quote in a single-quoted string. In other words,
149 * anything enclosed in single-quotes is passed as is, but the single-quotes
150 * themselves are eliminated. Thus, for example:
157 * Characters enclosed in double-quotes ("") have their literal value preserved,
158 * with the exception of the backslash. The backslash retains its special
159 * meaning as an escape character only when followed by a double-quote.
160 * Contrarily to the behavior of a posix shell, the double-quotes themselves
161 * are *not* eliminated. Thus, for example:
166 string const parsecmd(string const & incmd, string & infile, string & outfile,
169 bool in_single_quote = false;
170 bool in_double_quote = false;
171 bool escaped = false;
172 string const python_call = os::python();
173 vector<string> outcmd(4);
176 if (prefixIs(incmd, python_call)) {
177 outcmd[0] = os::python();
178 start = python_call.length();
181 for (size_t i = start, o = 0; i < incmd.length(); ++i) {
184 if (in_double_quote || escaped) {
185 if (in_double_quote && escaped)
189 in_single_quote = !in_single_quote;
193 if (in_single_quote) {
199 // Don't triple double-quotes for redirection
200 // files as these won't be parsed by QProcess
201 outcmd[o] += string(o ? "\"" : "\"\"\"");
205 in_double_quote = !in_double_quote;
207 } else if (c == '\\' && !escaped) {
209 } else if (c == '>' && !(in_double_quote || escaped)) {
210 if (suffixIs(outcmd[o], " 2")) {
211 outcmd[o] = rtrim(outcmd[o], "2");
214 if (suffixIs(outcmd[o], " 1"))
215 outcmd[o] = rtrim(outcmd[o], "1");
218 } else if (c == '<' && !(in_double_quote || escaped)) {
220 #if defined (USE_MACOSX_PACKAGING)
221 } else if (o == 0 && i > 4 && c == ' ' && !(in_double_quote || escaped)) {
222 // if a macOS app is detected with an additional argument
223 // use open command as prefix to get it work
224 const size_t apos = outcmd[o].rfind(".app");
225 const size_t len = outcmd[o].length();
226 const bool quoted = outcmd[o].at(len - 1) == '"' && outcmd[o].at(0) == '"';
227 const string & ocmd = "open -a ";
228 if (apos != string::npos &&
229 (apos == (len - 4) || (apos == (len - 5) && quoted)) &&
230 !prefixIs(trim(outcmd[o]), ocmd)) {
231 outcmd[o] = ocmd + outcmd[o];
236 if (escaped && in_double_quote)
242 infile = trim(outcmd[3], " \"");
243 outfile = trim(outcmd[1], " \"");
244 errfile = trim(outcmd[2], " \"");
245 return trim(outcmd[0]);
251 void Systemcall::killscript()
253 SystemcallPrivate::kill_script = true;
257 int Systemcall::startscript(Starttype how, string const & what,
258 string const & path, string const & lpath,
261 string const what_ss = commandPrep(what);
263 lyxerr << "\nRunning: " << what_ss << endl;
265 LYXERR(Debug::INFO,"Running: " << what_ss);
270 QString const cmd = QString::fromLocal8Bit(
271 parsecmd(what_ss, infile, outfile, errfile).c_str());
273 SystemcallPrivate d(infile, outfile, errfile);
274 bool do_events = process_events || how == WaitLoop;
276 d.startProcess(cmd, path, lpath, how == DontWait);
277 if (how == DontWait && d.state == SystemcallPrivate::Running)
280 if (d.state == SystemcallPrivate::Error
281 || !d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) {
282 if (d.state == SystemcallPrivate::Error) {
283 LYXERR0("Systemcall: '" << cmd << "' did not start!");
284 LYXERR0("error " << d.errorMessage());
286 } else if (d.state == SystemcallPrivate::Killed) {
287 LYXERR0("Killed: " << cmd);
292 if (!d.waitWhile(SystemcallPrivate::Running, do_events,
293 os::timeout_min() * 60 * 1000)) {
294 if (d.state == SystemcallPrivate::Killed) {
295 LYXERR0("Killed: " << cmd);
298 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
299 LYXERR0("error " << d.errorMessage());
300 LYXERR0("status " << d.exitStatusMessage());
304 int const exit_code = d.exitCode();
306 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
313 bool SystemcallPrivate::kill_script = false;
316 SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of,
317 std::string const & ef)
318 : state(Error), process_(new QProcess), out_index_(0), err_index_(0),
319 in_file_(sf), out_file_(of), err_file_(ef), process_events_(false)
321 if (!in_file_.empty())
322 process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
323 if (!out_file_.empty()) {
324 if (out_file_[0] == '&') {
325 if (subst(out_file_, " ", "") == "&2"
326 && err_file_[0] != '&') {
327 out_file_ = err_file_;
328 process_->setProcessChannelMode(
329 QProcess::MergedChannels);
331 if (err_file_[0] == '&') {
332 // Leave alone things such as
333 // "1>&2 2>&1". Should not be harmful,
334 // but let's give anyway a warning.
335 LYXERR0("Unsupported stdout/stderr redirect.");
338 LYXERR0("Ambiguous stdout redirect: "
341 out_file_ = os::nulldev();
344 // Check whether we have to set the output file.
345 if (out_file_ != os::nulldev()) {
346 process_->setStandardOutputFile(QString::fromLocal8Bit(
350 if (!err_file_.empty()) {
351 if (err_file_[0] == '&') {
352 if (subst(err_file_, " ", "") == "&1"
353 && out_file_[0] != '&') {
354 process_->setProcessChannelMode(
355 QProcess::MergedChannels);
357 LYXERR0("Ambiguous stderr redirect: "
360 // In MergedChannels mode stderr goes to stdout.
361 err_file_ = os::nulldev();
363 // Check whether we have to set the error file.
364 if (err_file_ != os::nulldev()) {
365 process_->setStandardErrorFile(QString::fromLocal8Bit(
370 connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
371 connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
372 #if QT_VERSION >= 0x050600
373 connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
375 connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
377 connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
378 connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
382 void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
383 string const & lpath, bool detached)
386 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
387 // FIXME pass command and arguments separated in the first place
388 /* The versions of startDetached() and start() that accept a
389 * QStringList object exist since Qt4, but it is only in Qt 5.15
390 * that splitCommand() was introduced and the plain versions of
391 * start/startDetached() have been deprecated.
392 * The cleanest solution would be to have parsecmd() produce a
393 * QStringList for arguments, instead of transforming the string
394 * into something that the QProcess splitter accepts.
396 QStringList arguments = QProcess::splitCommand(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
397 QString command = (arguments.empty()) ? QString() : arguments.first();
398 if (arguments.size() == 1)
400 else if (!arguments.empty())
401 arguments.removeFirst();
404 state = SystemcallPrivate::Running;
406 // Avoid opening a console window when a viewer is started
407 if (in_file_.empty())
408 process_->setStandardInputFile(QProcess::nullDevice());
409 if (out_file_.empty())
410 process_->setStandardOutputFile(QProcess::nullDevice());
411 if (err_file_.empty())
412 process_->setStandardErrorFile(QProcess::nullDevice());
414 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
415 if (!QProcess::startDetached(command, arguments)) {
417 if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
419 state = SystemcallPrivate::Error;
422 QProcess* released = releaseProcess();
424 } else if (process_) {
425 state = SystemcallPrivate::Starting;
426 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
427 process_->start(command, arguments);
429 process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
435 bool SystemcallPrivate::waitAndCheck()
437 Sleep::millisec(100);
439 // is there a better place to reset this?
443 LYXERR0("Export Canceled!!");
446 QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
453 bool queryStopCommand(QString const & cmd)
455 docstring text = bformat(_(
456 "The command\n%1$s\nhas not yet completed.\n\n"
457 "Do you want to stop it?"), qstring_to_ucs4(cmd));
458 return ProgressInterface::instance()->prompt(_("Stop command?"), text,
459 1, 1, _("&Stop it"), _("Let it &run")) == 0;
465 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
470 bool timedout = false;
471 process_events_ = process_events;
473 // Block GUI while waiting,
474 // relay on QProcess' wait functions
475 if (!process_events_) {
476 if (waitwhile == Starting)
477 return process_->waitForStarted(timeout);
478 if (waitwhile == Running) {
481 if (process_->waitForFinished(timeout))
483 bool const stop = queryStopCommand(cmd_);
484 // The command may have finished in the meantime
485 if (process_->state() == QProcess::NotRunning)
499 // process events while waiting, no timeout
501 while (state == waitwhile && state != Error) {
502 // check for cancellation of background process
506 return state != Error;
509 // process events while waiting with timeout
512 while (state == waitwhile && state != Error && !timedout) {
513 // check for cancellation of background process
517 if (timer.elapsed() > timeout) {
518 bool const stop = queryStopCommand(cmd_);
519 // The command may have finished in the meantime
520 if (process_->state() == QProcess::NotRunning)
529 return (state != Error) && !timedout;
533 SystemcallPrivate::~SystemcallPrivate()
536 out_data_[out_index_] = '\0';
542 err_data_[err_index_] = '\0';
552 void SystemcallPrivate::stdOut()
556 process_->setReadChannel(QProcess::StandardOutput);
557 while (process_->getChar(&c)) {
558 out_data_[out_index_++] = c;
559 if (c == '\n' || out_index_ + 1 == buffer_size_) {
560 out_data_[out_index_] = '\0';
562 ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
570 void SystemcallPrivate::stdErr()
574 process_->setReadChannel(QProcess::StandardError);
575 while (process_->getChar(&c)) {
576 err_data_[err_index_++] = c;
577 if (c == '\n' || err_index_ + 1 == buffer_size_) {
578 err_data_[err_index_] = '\0';
580 ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
588 void SystemcallPrivate::processStarted()
590 if (state != Running) {
592 ProgressInterface::instance()->processStarted(cmd_);
597 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
599 if (state != Finished) {
601 ProgressInterface::instance()->processFinished(cmd_);
606 void SystemcallPrivate::processError(QProcess::ProcessError)
609 ProgressInterface::instance()->appendError(errorMessage());
613 QString SystemcallPrivate::errorMessage() const
616 return "No QProcess available";
619 switch (process_->error()) {
620 case QProcess::FailedToStart:
621 message = "The process failed to start. Either the invoked program is missing, "
622 "or you may have insufficient permissions to invoke the program.";
624 case QProcess::Crashed:
625 message = "The process crashed some time after starting successfully.";
627 case QProcess::Timedout:
628 message = "The process timed out. It might be restarted automatically.";
630 case QProcess::WriteError:
631 message = "An error occurred when attempting to write to the process-> For example, "
632 "the process may not be running, or it may have closed its input channel.";
634 case QProcess::ReadError:
635 message = "An error occurred when attempting to read from the process-> For example, "
636 "the process may not be running.";
638 case QProcess::UnknownError:
640 message = "An unknown error occurred.";
647 QString SystemcallPrivate::exitStatusMessage() const
650 return "No QProcess available";
653 switch (process_->exitStatus()) {
654 case QProcess::NormalExit:
655 message = "The process exited normally.";
657 case QProcess::CrashExit:
658 message = "The process crashed.";
661 message = "Unknown exit state.";
668 int SystemcallPrivate::exitCode()
670 // From Qt's documentation, in regards to QProcess::exitCode(),
671 // "This value is not valid unless exitStatus() returns NormalExit"
672 if (!process_ || process_->exitStatus() != QProcess::NormalExit)
675 return process_->exitCode();
679 QProcess* SystemcallPrivate::releaseProcess()
681 QProcess* released = process_;
687 void SystemcallPrivate::killProcess()
689 killProcess(process_);
693 void SystemcallPrivate::killProcess(QProcess * p)
697 p->closeReadChannel(QProcess::StandardOutput);
698 p->closeReadChannel(QProcess::StandardError);
706 #include "moc_SystemcallPrivate.cpp"
709 } // namespace support