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"
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 &) {}
63 void processFinished(QString const &) {}
64 void appendMessage(QString const &) {}
65 void appendError(QString const &) {}
66 void clearMessages() {}
69 void lyxerrConnect() {}
70 void lyxerrDisconnect() {}
72 void warning(QString const &, QString const &) {}
73 void toggleWarning(QString const &, QString const &, QString const &) {}
74 void error(QString const &, QString const &, QString const &) {}
75 void information(QString const &, QString const &) {}
76 int prompt(docstring const &, docstring const &, int default_but, int,
77 docstring const &, docstring const &) { return default_but; }
81 static ProgressInterface * progress_instance = 0;
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 = "python -tt";
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)) {
221 if (escaped && in_double_quote)
227 infile = trim(outcmd[3], " \"");
228 outfile = trim(outcmd[1], " \"");
229 errfile = trim(outcmd[2], " \"");
230 return trim(outcmd[0]);
236 void Systemcall::killscript()
238 SystemcallPrivate::kill_script = true;
242 int Systemcall::startscript(Starttype how, string const & what,
243 string const & path, string const & lpath,
246 string const what_ss = commandPrep(what);
248 lyxerr << "\nRunning: " << what_ss << endl;
250 LYXERR(Debug::INFO,"Running: " << what_ss);
255 QString const cmd = QString::fromLocal8Bit(
256 parsecmd(what_ss, infile, outfile, errfile).c_str());
258 SystemcallPrivate d(infile, outfile, errfile);
259 bool do_events = process_events || how == WaitLoop;
262 // QProcess::startDetached cannot provide environment variables. When the
263 // environment variables are set using the latexEnvCmdPrefix and the process
264 // is started with QProcess::startDetached, a console window is shown every
265 // time a viewer is started. To avoid this, we fall back on Windows to the
266 // original implementation that creates a QProcess object.
267 d.startProcess(cmd, path, lpath, false);
268 if (!d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) {
269 if (d.state == SystemcallPrivate::Error) {
270 LYXERR0("Systemcall: '" << cmd << "' did not start!");
271 LYXERR0("error " << d.errorMessage());
273 } else if (d.state == SystemcallPrivate::Killed) {
274 LYXERR0("Killed: " << cmd);
278 if (how == DontWait) {
283 d.startProcess(cmd, path, lpath, how == DontWait);
284 if (how == DontWait && d.state == SystemcallPrivate::Running)
287 if (d.state == SystemcallPrivate::Error
288 || !d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) {
289 if (d.state == SystemcallPrivate::Error) {
290 LYXERR0("Systemcall: '" << cmd << "' did not start!");
291 LYXERR0("error " << d.errorMessage());
293 } else if (d.state == SystemcallPrivate::Killed) {
294 LYXERR0("Killed: " << cmd);
300 if (!d.waitWhile(SystemcallPrivate::Running, do_events,
301 os::timeout_min() * 60 * 1000)) {
302 if (d.state == SystemcallPrivate::Killed) {
303 LYXERR0("Killed: " << cmd);
306 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
307 LYXERR0("error " << d.errorMessage());
308 LYXERR0("status " << d.exitStatusMessage());
312 int const exit_code = d.exitCode();
314 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
321 bool SystemcallPrivate::kill_script = false;
324 SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of,
325 std::string const & ef)
326 : state(Error), process_(new QProcess), out_index_(0), err_index_(0),
327 in_file_(sf), out_file_(of), err_file_(ef), process_events_(false)
329 if (!in_file_.empty())
330 process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
331 if (!out_file_.empty()) {
332 if (out_file_[0] == '&') {
333 if (subst(out_file_, " ", "") == "&2"
334 && err_file_[0] != '&') {
335 out_file_ = err_file_;
336 process_->setProcessChannelMode(
337 QProcess::MergedChannels);
339 if (err_file_[0] == '&') {
340 // Leave alone things such as
341 // "1>&2 2>&1". Should not be harmful,
342 // but let's give anyway a warning.
343 LYXERR0("Unsupported stdout/stderr redirect.");
346 LYXERR0("Ambiguous stdout redirect: "
349 out_file_ = os::nulldev();
352 // Check whether we have to set the output file.
353 if (out_file_ != os::nulldev()) {
354 process_->setStandardOutputFile(QString::fromLocal8Bit(
358 if (!err_file_.empty()) {
359 if (err_file_[0] == '&') {
360 if (subst(err_file_, " ", "") == "&1"
361 && out_file_[0] != '&') {
362 process_->setProcessChannelMode(
363 QProcess::MergedChannels);
365 LYXERR0("Ambiguous stderr redirect: "
368 // In MergedChannels mode stderr goes to stdout.
369 err_file_ = os::nulldev();
371 // Check whether we have to set the error file.
372 if (err_file_ != os::nulldev()) {
373 process_->setStandardErrorFile(QString::fromLocal8Bit(
378 connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
379 connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
380 #if QT_VERSION >= 0x050600
381 connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
383 connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
385 connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
386 connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
390 void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
391 string const & lpath, bool detached)
395 state = SystemcallPrivate::Running;
396 if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
397 state = SystemcallPrivate::Error;
400 QProcess* released = releaseProcess();
402 } else if (process_) {
403 state = SystemcallPrivate::Starting;
404 process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
409 bool SystemcallPrivate::waitAndCheck()
411 Sleep::millisec(100);
413 // is there a better place to reset this?
417 LYXERR0("Export Canceled!!");
420 QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
427 bool queryStopCommand(QString const & cmd)
429 docstring text = bformat(_(
430 "The command\n%1$s\nhas not yet completed.\n\n"
431 "Do you want to stop it?"), qstring_to_ucs4(cmd));
432 return ProgressInterface::instance()->prompt(_("Stop command?"), text,
433 1, 1, _("&Stop it"), _("Let it &run")) == 0;
439 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
444 bool timedout = false;
445 process_events_ = process_events;
447 // Block GUI while waiting,
448 // relay on QProcess' wait functions
449 if (!process_events_) {
450 if (waitwhile == Starting)
451 return process_->waitForStarted(timeout);
452 if (waitwhile == Running) {
455 if (process_->waitForFinished(timeout))
457 bool stop = queryStopCommand(cmd_);
458 // The command may have finished in the meantime
459 if (process_->state() == QProcess::NotRunning)
473 // process events while waiting, no timeout
475 while (state == waitwhile && state != Error) {
476 // check for cancellation of background process
480 return state != Error;
483 // process events while waiting with timeout
486 while (state == waitwhile && state != Error && !timedout) {
487 // check for cancellation of background process
491 if (timer.elapsed() > timeout) {
492 bool stop = queryStopCommand(cmd_);
493 // The command may have finished in the meantime
494 if (process_->state() == QProcess::NotRunning)
503 return (state != Error) && !timedout;
507 SystemcallPrivate::~SystemcallPrivate()
510 out_data_[out_index_] = '\0';
516 err_data_[err_index_] = '\0';
526 void SystemcallPrivate::stdOut()
530 process_->setReadChannel(QProcess::StandardOutput);
531 while (process_->getChar(&c)) {
532 out_data_[out_index_++] = c;
533 if (c == '\n' || out_index_ + 1 == buffer_size_) {
534 out_data_[out_index_] = '\0';
536 ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
544 void SystemcallPrivate::stdErr()
548 process_->setReadChannel(QProcess::StandardError);
549 while (process_->getChar(&c)) {
550 err_data_[err_index_++] = c;
551 if (c == '\n' || err_index_ + 1 == buffer_size_) {
552 err_data_[err_index_] = '\0';
554 ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
562 void SystemcallPrivate::processStarted()
564 if (state != Running) {
566 ProgressInterface::instance()->processStarted(cmd_);
571 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
573 if (state != Finished) {
575 ProgressInterface::instance()->processFinished(cmd_);
580 void SystemcallPrivate::processError(QProcess::ProcessError)
583 ProgressInterface::instance()->appendError(errorMessage());
587 QString SystemcallPrivate::errorMessage() const
590 return "No QProcess available";
593 switch (process_->error()) {
594 case QProcess::FailedToStart:
595 message = "The process failed to start. Either the invoked program is missing, "
596 "or you may have insufficient permissions to invoke the program.";
598 case QProcess::Crashed:
599 message = "The process crashed some time after starting successfully.";
601 case QProcess::Timedout:
602 message = "The process timed out. It might be restarted automatically.";
604 case QProcess::WriteError:
605 message = "An error occurred when attempting to write to the process-> For example, "
606 "the process may not be running, or it may have closed its input channel.";
608 case QProcess::ReadError:
609 message = "An error occurred when attempting to read from the process-> For example, "
610 "the process may not be running.";
612 case QProcess::UnknownError:
614 message = "An unknown error occurred.";
621 QString SystemcallPrivate::exitStatusMessage() const
624 return "No QProcess available";
627 switch (process_->exitStatus()) {
628 case QProcess::NormalExit:
629 message = "The process exited normally.";
631 case QProcess::CrashExit:
632 message = "The process crashed.";
635 message = "Unknown exit state.";
642 int SystemcallPrivate::exitCode()
644 // From Qt's documentation, in regards to QProcess::exitCode(),
645 // "This value is not valid unless exitStatus() returns NormalExit"
646 if (!process_ || process_->exitStatus() != QProcess::NormalExit)
649 return process_->exitCode();
653 QProcess* SystemcallPrivate::releaseProcess()
655 QProcess* released = process_;
661 void SystemcallPrivate::killProcess()
663 killProcess(process_);
667 void SystemcallPrivate::killProcess(QProcess * p)
671 p->closeReadChannel(QProcess::StandardOutput);
672 p->closeReadChannel(QProcess::StandardError);
680 #include "moc_SystemcallPrivate.cpp"
683 } // namespace support