src/support/Systemcall.cpp

   1 /**
   2  * \file Systemcall.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Angus Leeming
   8  * \author Enrico Forestieri
   9  * \author Peter Kuemmel
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  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"
  25
  26 #include "LyX.h"
  27
  28 #include <cstdlib>
  29 #include <iostream>
  30
  31 #include <QProcess>
  32 #include <QElapsedTimer>
  33 #include <QThread>
  34 #include <QCoreApplication>
  35 #include <QDebug>
  36
  37 #define USE_QPROCESS
  38
  39
  40 struct Sleep : QThread
  41 {
  42         static void millisec(unsigned long ms)
  43         {
  44                 QThread::usleep(ms * 1000);
  45         }
  46 };
  47
  48
  49
  50
  51 using namespace std;
  52
  53 namespace lyx {
  54 namespace support {
  55
  56
  57 class ProgressDummy : public ProgressInterface
  58 {
  59 public:
  60         ProgressDummy() {}
  61
  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 {}
  68
  69         void lyxerrConnect() override {}
  70         void lyxerrDisconnect() override {}
  71
  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; }
  78 };
  79
  80
  81 static ProgressInterface * progress_instance = nullptr;
  82
  83 void ProgressInterface::setInstance(ProgressInterface* p)
  84 {
  85         progress_instance = p;
  86 }
  87
  88
  89 ProgressInterface * ProgressInterface::instance()
  90 {
  91         if (!progress_instance) {
  92                 static ProgressDummy dummy;
  93                 return &dummy;
  94         }
  95         return progress_instance;
  96 }
  97
  98
  99
 100
 101 // Reuse of instance
 102 #ifndef USE_QPROCESS
 103 int Systemcall::startscript(Starttype how, string const & what,
 104                             string const & path, string const & lpath,
 105                             bool /*process_events*/)
 106 {
 107         string command =
 108                 to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
 109                        + commandPrep(what);
 110
 111         if (how == DontWait) {
 112                 switch (os::shell()) {
 113                 case os::UNIX:
 114                         command += " &";
 115                         break;
 116                 case os::CMD_EXE:
 117                         command = "start /min " + command;
 118                         break;
 119                 }
 120         } else if (os::shell() == os::CMD_EXE)
 121                 command = subst(command, "cmd /d /c ", "");
 122
 123         return ::system(command.c_str());
 124 }
 125
 126 #else
 127
 128 namespace {
 129
 130 /*
 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.
 134  *
 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:
 141  *     \\  ->  \
 142  *     \a  ->  a
 143  *     \"  ->  """
 144  *
 145  * Single-quotes.
 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:
 151  *    '\'    ->  \
 152  *    '\\'   ->  \\
 153  *    '\a'   ->  \a
 154  *    'a\"b' ->  a\"b
 155  *
 156  * Double-quotes.
 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:
 162  *    "\\"   ->  "\\"
 163  *    "\a"   ->  "\a"
 164  *    "a\"b" ->  "a"""b"
 165  */
 166 string const parsecmd(string const & incmd, string & infile, string & outfile,
 167                      string & errfile)
 168 {
 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);
 174         size_t start = 0;
 175
 176         if (prefixIs(incmd, python_call)) {
 177                 outcmd[0] = os::python();
 178                 start = python_call.length();
 179         }
 180
 181         for (size_t i = start, o = 0; i < incmd.length(); ++i) {
 182                 char c = incmd[i];
 183                 if (c == '\'') {
 184                         if (in_double_quote || escaped) {
 185                                 if (in_double_quote && escaped)
 186                                         outcmd[o] += '\\';
 187                                 outcmd[o] += c;
 188                         } else
 189                                 in_single_quote = !in_single_quote;
 190                         escaped = false;
 191                         continue;
 192                 }
 193                 if (in_single_quote) {
 194                         outcmd[o] += c;
 195                         continue;
 196                 }
 197                 if (c == '"') {
 198                         if (escaped) {
 199                                 // Don't triple double-quotes for redirection
 200                                 // files as these won't be parsed by QProcess
 201                                 outcmd[o] += string(o ? "\"" : "\"\"\"");
 202                                 escaped = false;
 203                         } else {
 204                                 outcmd[o] += c;
 205                                 in_double_quote = !in_double_quote;
 206                         }
 207                 } else if (c == '\\' && !escaped) {
 208                         escaped = true;
 209                 } else if (c == '>' && !(in_double_quote || escaped)) {
 210                         if (suffixIs(outcmd[o], " 2")) {
 211                                 outcmd[o] = rtrim(outcmd[o], "2");
 212                                 o = 2;
 213                         } else {
 214                                 if (suffixIs(outcmd[o], " 1"))
 215                                         outcmd[o] = rtrim(outcmd[o], "1");
 216                                 o = 1;
 217                         }
 218                 } else if (c == '<' && !(in_double_quote || escaped)) {
 219                         o = 3;
 220                 } else {
 221                         if (escaped && in_double_quote)
 222                                 outcmd[o] += '\\';
 223                         outcmd[o] += c;
 224                         escaped = false;
 225                 }
 226         }
 227         infile  = trim(outcmd[3], " \"");
 228         outfile = trim(outcmd[1], " \"");
 229         errfile = trim(outcmd[2], " \"");
 230         return trim(outcmd[0]);
 231 }
 232
 233 } // namespace
 234
 235
 236 void Systemcall::killscript()
 237 {
 238         SystemcallPrivate::kill_script = true;
 239 }
 240
 241
 242 int Systemcall::startscript(Starttype how, string const & what,
 243                             string const & path, string const & lpath,
 244                             bool process_events)
 245 {
 246         string const what_ss = commandPrep(what);
 247         if (verbose)
 248                 lyxerr << "\nRunning: " << what_ss << endl;
 249         else
 250                 LYXERR(Debug::INFO,"Running: " << what_ss);
 251
 252         string infile;
 253         string outfile;
 254         string errfile;
 255         QString const cmd = QString::fromLocal8Bit(
 256                         parsecmd(what_ss, infile, outfile, errfile).c_str());
 257
 258         SystemcallPrivate d(infile, outfile, errfile);
 259         bool do_events = process_events || how == WaitLoop;
 260
 261         d.startProcess(cmd, path, lpath, how == DontWait);
 262         if (how == DontWait && d.state == SystemcallPrivate::Running)
 263                 return OK;
 264
 265         if (d.state == SystemcallPrivate::Error
 266                         || !d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) {
 267                 if (d.state == SystemcallPrivate::Error) {
 268                         LYXERR0("Systemcall: '" << cmd << "' did not start!");
 269                         LYXERR0("error " << d.errorMessage());
 270                         return NOSTART;
 271                 } else if (d.state == SystemcallPrivate::Killed) {
 272                         LYXERR0("Killed: " << cmd);
 273                         return KILLED;
 274                 }
 275         }
 276
 277         if (!d.waitWhile(SystemcallPrivate::Running, do_events,
 278                          os::timeout_min() * 60 * 1000)) {
 279                 if (d.state == SystemcallPrivate::Killed) {
 280                         LYXERR0("Killed: " << cmd);
 281                         return KILLED;
 282                 }
 283                 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
 284                 LYXERR0("error " << d.errorMessage());
 285                 LYXERR0("status " << d.exitStatusMessage());
 286                 return TIMEOUT;
 287         }
 288
 289         int const exit_code = d.exitCode();
 290         if (exit_code) {
 291                 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
 292         }
 293
 294         return exit_code;
 295 }
 296
 297
 298 bool SystemcallPrivate::kill_script = false;
 299
 300
 301 SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of,
 302                                      std::string const & ef)
 303         : state(Error), process_(new QProcess), out_index_(0), err_index_(0),
 304           in_file_(sf), out_file_(of), err_file_(ef), process_events_(false)
 305 {
 306         if (!in_file_.empty())
 307                 process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
 308         if (!out_file_.empty()) {
 309                 if (out_file_[0] == '&') {
 310                         if (subst(out_file_, " ", "") == "&2"
 311                             && err_file_[0] != '&') {
 312                                 out_file_ = err_file_;
 313                                 process_->setProcessChannelMode(
 314                                                 QProcess::MergedChannels);
 315                         } else {
 316                                 if (err_file_[0] == '&') {
 317                                         // Leave alone things such as
 318                                         // "1>&2 2>&1". Should not be harmful,
 319                                         // but let's give anyway a warning.
 320                                         LYXERR0("Unsupported stdout/stderr redirect.");
 321                                         err_file_.erase();
 322                                 } else {
 323                                         LYXERR0("Ambiguous stdout redirect: "
 324                                                 << out_file_);
 325                                 }
 326                                 out_file_ = os::nulldev();
 327                         }
 328                 }
 329                 // Check whether we have to set the output file.
 330                 if (out_file_ != os::nulldev()) {
 331                         process_->setStandardOutputFile(QString::fromLocal8Bit(
 332                                                         out_file_.c_str()));
 333                 }
 334         }
 335         if (!err_file_.empty()) {
 336                 if (err_file_[0] == '&') {
 337                         if (subst(err_file_, " ", "") == "&1"
 338                             && out_file_[0] != '&') {
 339                                 process_->setProcessChannelMode(
 340                                                 QProcess::MergedChannels);
 341                         } else {
 342                                 LYXERR0("Ambiguous stderr redirect: "
 343                                         << err_file_);
 344                         }
 345                         // In MergedChannels mode stderr goes to stdout.
 346                         err_file_ = os::nulldev();
 347                 }
 348                 // Check whether we have to set the error file.
 349                 if (err_file_ != os::nulldev()) {
 350                         process_->setStandardErrorFile(QString::fromLocal8Bit(
 351                                                         err_file_.c_str()));
 352                 }
 353         }
 354
 355         connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
 356         connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
 357 #if QT_VERSION >= 0x050600
 358         connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
 359 #else
 360         connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
 361 #endif
 362         connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
 363         connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
 364 }
 365
 366
 367 void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
 368                                      string const & lpath, bool detached)
 369 {
 370         cmd_ = cmd;
 371 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
 372         // FIXME pass command and arguments separated in the first place
 373         /* The versions of startDetached() and start() that accept a
 374          * QStringList object exist since Qt4, but it is only in Qt 5.15
 375          * that splitCommand() was introduced and the plain versions of
 376          * start/startDetached() have been deprecated.
 377          * The cleanest solution would be to have parsecmd() produce a
 378          * QStringList for arguments, instead of transforming the string
 379          * into something that the QProcess splitter accepts.
 380         */
 381         QStringList arguments = QProcess::splitCommand(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
 382         QString command = (arguments.empty()) ? QString() : arguments.first();
 383         if (arguments.size() == 1)
 384                 arguments.clear();
 385         else if (!arguments.empty())
 386                 arguments.removeFirst();
 387 #endif
 388         if (detached) {
 389                 state = SystemcallPrivate::Running;
 390 #ifdef Q_OS_WIN32
 391                 // Avoid opening a console window when a viewer is started
 392                 if (in_file_.empty())
 393                         process_->setStandardInputFile(QProcess::nullDevice());
 394                 if (out_file_.empty())
 395                         process_->setStandardOutputFile(QProcess::nullDevice());
 396                 if (err_file_.empty())
 397                         process_->setStandardErrorFile(QProcess::nullDevice());
 398 #endif
 399 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
 400                 if (!QProcess::startDetached(command, arguments)) {
 401 #else
 402                 if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
 403 #endif
 404                         state = SystemcallPrivate::Error;
 405                         return;
 406                 }
 407                 QProcess* released = releaseProcess();
 408                 delete released;
 409         } else if (process_) {
 410                 state = SystemcallPrivate::Starting;
 411 #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
 412                 process_->start(command, arguments);
 413 #else
 414                 process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
 415 #endif
 416         }
 417 }
 418
 419
 420 bool SystemcallPrivate::waitAndCheck()
 421 {
 422         Sleep::millisec(100);
 423         if (kill_script) {
 424                 // is there a better place to reset this?
 425                 process_->kill();
 426                 state = Killed;
 427                 kill_script = false;
 428                 LYXERR0("Export Canceled!!");
 429                 return false;
 430         }
 431         QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
 432         return true;
 433 }
 434
 435
 436 namespace {
 437
 438 bool queryStopCommand(QString const & cmd)
 439 {
 440         docstring text = bformat(_(
 441                 "The command\n%1$s\nhas not yet completed.\n\n"
 442                 "Do you want to stop it?"), qstring_to_ucs4(cmd));
 443         return ProgressInterface::instance()->prompt(_("Stop command?"), text,
 444                         1, 1, _("&Stop it"), _("Let it &run")) == 0;
 445 }
 446
 447 } // namespace
 448
 449
 450 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
 451 {
 452         if (!process_)
 453                 return false;
 454
 455         bool timedout = false;
 456         process_events_ = process_events;
 457
 458         // Block GUI while waiting,
 459         // relay on QProcess' wait functions
 460         if (!process_events_) {
 461                 if (waitwhile == Starting)
 462                         return process_->waitForStarted(timeout);
 463                 if (waitwhile == Running) {
 464                         int bump = 2;
 465                         while (!timedout) {
 466                                 if (process_->waitForFinished(timeout))
 467                                         return true;
 468                                 bool const stop = queryStopCommand(cmd_);
 469                                 // The command may have finished in the meantime
 470                                 if (process_->state() == QProcess::NotRunning)
 471                                         return true;
 472                                 if (stop) {
 473                                         timedout = true;
 474                                         process_->kill();
 475                                 } else {
 476                                         timeout *= bump;
 477                                         bump = 3;
 478                                 }
 479                         }
 480                 }
 481                 return false;
 482         }
 483
 484         // process events while waiting, no timeout
 485         if (timeout == -1) {
 486                 while (state == waitwhile && state != Error) {
 487                         // check for cancellation of background process
 488                         if (!waitAndCheck())
 489                                 return false;
 490                 }
 491                 return state != Error;
 492         }
 493
 494         // process events while waiting with timeout
 495         QElapsedTimer timer;
 496         timer.start();
 497         while (state == waitwhile && state != Error && !timedout) {
 498                 // check for cancellation of background process
 499                 if (!waitAndCheck())
 500                         return false;
 501
 502                 if (timer.elapsed() > timeout) {
 503                         bool const stop = queryStopCommand(cmd_);
 504                         // The command may have finished in the meantime
 505                         if (process_->state() == QProcess::NotRunning)
 506                                 break;
 507                         if (stop) {
 508                                 timedout = true;
 509                                 process_->kill();
 510                         } else
 511                                 timeout *= 3;
 512                 }
 513         }
 514         return (state != Error) && !timedout;
 515 }
 516
 517
 518 SystemcallPrivate::~SystemcallPrivate()
 519 {
 520         if (out_index_) {
 521                 out_data_[out_index_] = '\0';
 522                 out_index_ = 0;
 523                 cout << out_data_;
 524         }
 525         cout.flush();
 526         if (err_index_) {
 527                 err_data_[err_index_] = '\0';
 528                 err_index_ = 0;
 529                 cerr << err_data_;
 530         }
 531         cerr.flush();
 532
 533         killProcess();
 534 }
 535
 536
 537 void SystemcallPrivate::stdOut()
 538 {
 539         if (process_) {
 540                 char c;
 541                 process_->setReadChannel(QProcess::StandardOutput);
 542                 while (process_->getChar(&c)) {
 543                         out_data_[out_index_++] = c;
 544                         if (c == '\n' || out_index_ + 1 == buffer_size_) {
 545                                 out_data_[out_index_] = '\0';
 546                                 out_index_ = 0;
 547                                 ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
 548                                 cout << out_data_;
 549                         }
 550                 }
 551         }
 552 }
 553
 554
 555 void SystemcallPrivate::stdErr()
 556 {
 557         if (process_) {
 558                 char c;
 559                 process_->setReadChannel(QProcess::StandardError);
 560                 while (process_->getChar(&c)) {
 561                         err_data_[err_index_++] = c;
 562                         if (c == '\n' || err_index_ + 1 == buffer_size_) {
 563                                 err_data_[err_index_] = '\0';
 564                                 err_index_ = 0;
 565                                 ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
 566                                 cerr << err_data_;
 567                         }
 568                 }
 569         }
 570 }
 571
 572
 573 void SystemcallPrivate::processStarted()
 574 {
 575         if (state != Running) {
 576                 state = Running;
 577                 ProgressInterface::instance()->processStarted(cmd_);
 578         }
 579 }
 580
 581
 582 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
 583 {
 584         if (state != Finished) {
 585                 state = Finished;
 586                 ProgressInterface::instance()->processFinished(cmd_);
 587         }
 588 }
 589
 590
 591 void SystemcallPrivate::processError(QProcess::ProcessError)
 592 {
 593         state = Error;
 594         ProgressInterface::instance()->appendError(errorMessage());
 595 }
 596
 597
 598 QString SystemcallPrivate::errorMessage() const
 599 {
 600         if (!process_)
 601                 return "No QProcess available";
 602
 603         QString message;
 604         switch (process_->error()) {
 605                 case QProcess::FailedToStart:
 606                         message = "The process failed to start. Either the invoked program is missing, "
 607                                       "or you may have insufficient permissions to invoke the program.";
 608                         break;
 609                 case QProcess::Crashed:
 610                         message = "The process crashed some time after starting successfully.";
 611                         break;
 612                 case QProcess::Timedout:
 613                         message = "The process timed out. It might be restarted automatically.";
 614                         break;
 615                 case QProcess::WriteError:
 616                         message = "An error occurred when attempting to write to the process-> For example, "
 617                                       "the process may not be running, or it may have closed its input channel.";
 618                         break;
 619                 case QProcess::ReadError:
 620                         message = "An error occurred when attempting to read from the process-> For example, "
 621                                       "the process may not be running.";
 622                         break;
 623                 case QProcess::UnknownError:
 624                 default:
 625                         message = "An unknown error occurred.";
 626                         break;
 627         }
 628         return message;
 629 }
 630
 631
 632 QString SystemcallPrivate::exitStatusMessage() const
 633 {
 634         if (!process_)
 635                 return "No QProcess available";
 636
 637         QString message;
 638         switch (process_->exitStatus()) {
 639                 case QProcess::NormalExit:
 640                         message = "The process exited normally.";
 641                         break;
 642                 case QProcess::CrashExit:
 643                         message = "The process crashed.";
 644                         break;
 645                 default:
 646                         message = "Unknown exit state.";
 647                         break;
 648         }
 649         return message;
 650 }
 651
 652
 653 int SystemcallPrivate::exitCode()
 654 {
 655         // From Qt's documentation, in regards to QProcess::exitCode(),
 656         // "This value is not valid unless exitStatus() returns NormalExit"
 657         if (!process_ || process_->exitStatus() != QProcess::NormalExit)
 658                 return -1;
 659
 660         return process_->exitCode();
 661 }
 662
 663
 664 QProcess* SystemcallPrivate::releaseProcess()
 665 {
 666         QProcess* released = process_;
 667         process_ = nullptr;
 668         return released;
 669 }
 670
 671
 672 void SystemcallPrivate::killProcess()
 673 {
 674         killProcess(process_);
 675 }
 676
 677
 678 void SystemcallPrivate::killProcess(QProcess * p)
 679 {
 680         if (p) {
 681                 p->disconnect();
 682                 p->closeReadChannel(QProcess::StandardOutput);
 683                 p->closeReadChannel(QProcess::StandardError);
 684                 p->close();
 685                 delete p;
 686         }
 687 }
 688
 689
 690
 691 #include "moc_SystemcallPrivate.cpp"
 692 #endif
 693
 694 } // namespace support
 695 } // namespace lyx