+
+
+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"