- removed a the obsolete KShellProcess class

- added a few methods to OProcess to make it easier to port programs using
  QProcess

2 files changed, 56 insertions, 110 deletions

diff --git a/libopie/oprocess.cpp b/libopie/oprocess.cpp
index f3e52bd..5db2b6c 100644
--- a/libopie/oprocess.cpp
+++ b/libopie/oprocess.cpp
@@ -33,144 +33,164 @@
 //  e9025461@student.tuwien.ac.at
 //
 // Changes:
 //
 // March 2nd, 1998: Changed parameter list for KShellProcess:
 //   Arguments are now placed in a single string so that
 //   <shell> -c <commandstring> is passed to the shell
 //   to make the use of "operator<<" consistent with KProcess
 //
 //
 //  Ported by Holger Freyther
 //   <zekce> Harlekin: oprocess and say it was ported to Qt by the Opie developers an Qt 2
 
 
 
 #include "oprocess.h"
 #define _MAY_INCLUDE_KPROCESSCONTROLLER_
 #include "oprocctrl.h"
 
 //#include <config.h>
 
 #include <qfile.h>
 #include <qsocketnotifier.h>
 #include <qregexp.h>
 
 #include <sys/time.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <sys/socket.h>
 
 #include <errno.h>
 #include <fcntl.h>
 #include <stdlib.h>
 #include <signal.h>
 #include <stdio.h>
 #include <string.h>
 #include <unistd.h>
 #ifdef HAVE_SYS_SELECT_H
 #include <sys/select.h>
 #endif
 #ifdef HAVE_INITGROUPS
 #include <grp.h>
 #endif
 #include <pwd.h>
 
 #include <qapplication.h>
 #include <qmap.h>
 //#include <kdebug.h>
 
 /////////////////////////////
 // public member functions //
 /////////////////////////////
 
 class OProcessPrivate {
 public:
    OProcessPrivate() : useShell(false) { }
 
    bool useShell;
    QMap<QString,QString> env;
    QString wd;
    QCString shell;
 };
 
 
-OProcess::OProcess()
-  : QObject(),
-    run_mode(NotifyOnExit),
-    runs(false),
-    pid_(0),
-    status(0),
-    keepPrivs(false),
-    innot(0),
-    outnot(0),
-    errnot(0),
-    communication(NoCommunication),
-    input_data(0),
-    input_sent(0),
-    input_total(0),
-    d(0)
+OProcess::OProcess(QObject *parent, const char *name)
+  : QObject(parent, name)
 {
+  init ( );
+}
+
+OProcess::OProcess(const QString &arg0, QObject *parent, const char *name)
+  : QObject(parent, name)
+{
+  init ( );
+  *this << arg0;
+}
+
+OProcess::OProcess(const QStringList &args, QObject *parent, const char *name)
+  : QObject(parent, name)
+{
+  init ( );
+  *this << args;
+}
+
+void OProcess::init ( )
+{
+  run_mode = NotifyOnExit;
+  runs = false;
+  pid_ = 0;
+  status = 0;
+  keepPrivs = false;
+  innot = 0;
+  outnot = 0;
+  errnot = 0;
+  communication = NoCommunication;
+  input_data = 0;
+  input_sent = 0;
+  input_total = 0;
+  d = 0;
+
   if (0 == OProcessController::theOProcessController) {
         (void) new OProcessController();
         CHECK_PTR(OProcessController::theOProcessController);
   }
 
   OProcessController::theOProcessController->addOProcess(this);
   out[0] = out[1] = -1;
   in[0] = in[1] = -1;
   err[0] = err[1] = -1;
 }
 
 void
 OProcess::setEnvironment(const QString &name, const QString &value)
 {
    if (!d)
       d = new OProcessPrivate;
    d->env.insert(name, value);
 }
 
 void
 OProcess::setWorkingDirectory(const QString &dir)
 {
    if (!d)
       d = new OProcessPrivate;
    d->wd = dir;   
 } 
 
 void 
 OProcess::setupEnvironment()
 {
    if (d)
    {
       QMap<QString,QString>::Iterator it;
       for(it = d->env.begin(); it != d->env.end(); ++it)
          setenv(QFile::encodeName(it.key()).data(),
                 QFile::encodeName(it.data()).data(), 1);
       if (!d->wd.isEmpty())
          chdir(QFile::encodeName(d->wd).data());
    }
 }
 
 void
 OProcess::setRunPrivileged(bool keepPrivileges)
 {
    keepPrivs = keepPrivileges;
 }
 
 bool
 OProcess::runPrivileged() const
 {
    return keepPrivs;
 }
 
 
 OProcess::~OProcess()
 {
   // destroying the OProcess instance sends a SIGKILL to the
   // child process (if it is running) after removing it from the
   // list of valid processes (if the process is not started as
   // "DontCare")
 
   OProcessController::theOProcessController->removeOProcess(this);
   // this must happen before we kill the child
   // TODO: block the signal while removing the current process from the process list
@@ -411,128 +431,142 @@ bool OProcess::start(RunMode runmode, Communication comm)
 bool OProcess::kill(int signo)
 {
   bool rv=false;
 
   if (0 != pid_)
     rv= (-1 != ::kill(pid_, signo));
   // probably store errno somewhere...
   return rv;
 }
 
 
 
 bool OProcess::isRunning() const
 {
   return runs;
 }
 
 
 
 pid_t OProcess::pid() const
 {
   return pid_;
 }
 
 
 
 bool OProcess::normalExit() const
 {
   int _status = status;
   return (pid_ != 0) && (!runs) && (WIFEXITED((_status)));
 }
 
 
 
 int OProcess::exitStatus() const
 {
   int _status = status;
   return WEXITSTATUS((_status));
 }
 
 
 
 bool OProcess::writeStdin(const char *buffer, int buflen)
 {
   bool rv;
 
   // if there is still data pending, writing new data
   // to stdout is not allowed (since it could also confuse
   // kprocess...
   if (0 != input_data)
     return false;
 
   if (runs && (communication & Stdin)) {
     input_data = buffer;
     input_sent = 0;
     input_total = buflen;
     slotSendData(0);
     innot->setEnabled(true);
     rv = true;
   } else
     rv = false;
   return rv;
 }
 
+void OProcess::flushStdin ( )
+{
+	if ( !input_data || ( input_sent == input_total ))
+		return;
+
+	int d1, d2;
+	
+	do {
+		d1 = input_total - input_sent;
+		slotSendData ( 0 );
+		d2 = input_total - input_sent;
+	} while ( d2 <= d1 );
+}
+
 void OProcess::suspend()
 {
   if ((communication & Stdout) && outnot)
      outnot->setEnabled(false);
 }
 
 void OProcess::resume()
 {
   if ((communication & Stdout) && outnot)
      outnot->setEnabled(true);
 }
 
 bool OProcess::closeStdin()
 {
   bool rv;
 
   if (communication & Stdin) {
     communication = (Communication) (communication & ~Stdin);
     delete innot;
     innot = 0;
     close(in[1]);
     rv = true;
   } else
     rv = false;
   return rv;
 }
 
 bool OProcess::closeStdout()
 {
   bool rv;
 
   if (communication & Stdout) {
     communication = (Communication) (communication & ~Stdout);
     delete outnot;
     outnot = 0;
     close(out[0]);
     rv = true;
   } else
     rv = false;
   return rv;
 }
 
 bool OProcess::closeStderr()
 {
   bool rv;
 
   if (communication & Stderr) {
     communication = static_cast<Communication>(communication & ~Stderr);
     delete errnot;
     errnot = 0;
     close(err[0]);
     rv = true;
   } else
     rv = false;
   return rv;
 }
 
 
 /////////////////////////////
 // protected slots         //
 /////////////////////////////
 
 
 
@@ -827,96 +861,66 @@ void OProcess::commClose()
 }
 
 void OProcess::setUseShell(bool useShell, const char *shell)
 {
   if (!d)
     d = new OProcessPrivate;
   d->useShell = useShell;
   d->shell = shell;
   if (d->shell.isEmpty())
      d->shell = searchShell();
 }
 
 QString OProcess::quote(const QString &arg)
 {
     QString res = arg;
     res.replace(QRegExp(QString::fromLatin1("\'")),
                 QString::fromLatin1("'\"'\"'"));
     res.prepend('\'');
     res.append('\'');
     return res;
 }
 
 QCString OProcess::searchShell()
 {
   QCString tmpShell = QCString(getenv("SHELL")).stripWhiteSpace();
   if (!isExecutable(tmpShell))
   {
      tmpShell = "/bin/sh";
   }
 
   return tmpShell;
 }
 
 bool OProcess::isExecutable(const QCString &filename)
 {
   struct stat fileinfo;
 
   if (filename.isEmpty()) return false;
 
   // CC: we've got a valid filename, now let's see whether we can execute that file
 
   if (-1 == stat(filename.data(), &fileinfo)) return false;
   // CC: return false if the file does not exist
 
   // CC: anyway, we cannot execute directories, block/character devices, fifos or sockets
   if ( (S_ISDIR(fileinfo.st_mode))  ||
        (S_ISCHR(fileinfo.st_mode))  ||
        (S_ISBLK(fileinfo.st_mode))  ||
 #ifdef S_ISSOCK
        // CC: SYSVR4 systems don't have that macro
        (S_ISSOCK(fileinfo.st_mode)) ||
 #endif
        (S_ISFIFO(fileinfo.st_mode)) ||
        (S_ISDIR(fileinfo.st_mode)) ) {
     return false;
   }
 
   // CC: now check for permission to execute the file
   if (access(filename.data(), X_OK) != 0) return false;
 
   // CC: we've passed all the tests...
   return true;
 }
 
-void OProcess::virtual_hook( int, void* )
-{ /*BASE::virtual_hook( id, data );*/ }
-
-
-///////////////////////////
-// CC: Class KShellProcess
-///////////////////////////
-
-KShellProcess::KShellProcess(const char *shellname):
-  OProcess()
-{
-  setUseShell(true, shellname);
-}
-
-
-KShellProcess::~KShellProcess() {
-}
-
-QString KShellProcess::quote(const QString &arg)
-{
-    return OProcess::quote(arg);
-}
-
-bool KShellProcess::start(RunMode runmode, Communication comm)
-{
-  return OProcess::start(runmode, comm);
-}
 
-void KShellProcess::virtual_hook( int id, void* data )
-{ OProcess::virtual_hook( id, data ); }
 
-//#include "kprocess.moc"
diff --git a/libopie/oprocess.h b/libopie/oprocess.h
index fd726b4..bf5fe0e 100644
--- a/libopie/oprocess.h
+++ b/libopie/oprocess.h
@@ -126,129 +126,131 @@ class OProcessPrivate;
  *@li -- Closes the child process's stderr.
  *Returns false if you try to close stderr for a process that has been started
  *without a communication channel to stderr.
  *
  *
  *@sect QT signals:
  *
  *@li void @ref receivedStdout(OProcess  *proc, char  *buffer, int  buflen);
  *@li  void @ref receivedStderr(OProcess  *proc, char  *buffer, int  buflen);
  *@li  -- Indicates that new data has arrived from either the
  *child process's stdout or stderr.
  *
  *@li  void @ref wroteStdin(OProcess  *proc);
  *@li  -- Indicates that all data that has been sent to the child process
  *by a prior call to @ref writeStdin() has actually been transmitted to the
  *client .
  *
  *@author Christian Czezakte e9025461@student.tuwien.ac.at
  *
  *
  **/
 class OProcess : public QObject
 {
   Q_OBJECT
 
 public:
 
   /**
    * Modes in which the communication channel can be opened.
    *
    * If communication for more than one channel is required,
    * the values have to be or'ed together, for example to get
    * communication with stdout as well as with stdin, you would
    * specify @p Stdin @p | @p Stdout
    *
    * If @p NoRead is specified in conjunction with @p Stdout,
    * no data is actually read from @p Stdout but only
    * the signal @ref childOutput(int fd) is emitted.
    */
   enum Communication { NoCommunication = 0, Stdin = 1, Stdout = 2, Stderr = 4,
 					   AllOutput = 6, All = 7,
 					   NoRead };
 
   /**
    * Run-modes for a child process.
    */
   enum RunMode {
       /**
        * The application does not receive notifications from the subprocess when
        * it is finished or aborted.
        */
        DontCare,
        /**
         * The application is notified when the subprocess dies.
         */
        NotifyOnExit,
        /**
         * The application is suspended until the started process is finished.
         */
        Block };
 
   /**
    * Constructor
    */
-  OProcess();
+  OProcess(QObject *parent = 0, const char *name = 0);
+  OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0);
+  OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0);
 
   /**
    *Destructor:
    *
    *  If the process is running when the destructor for this class
    *  is called, the child process is killed with a SIGKILL, but
    *  only if the run mode is not of type @p DontCare.
    *  Processes started as @p DontCare keep running anyway.
   */
   virtual ~OProcess();
 
   /**
    @deprecated
 
          The use of this function is now deprecated. -- Please use the
 	 "operator<<" instead of "setExecutable".
 
 	 Sets the executable to be started with this OProcess object.
 	 Returns false if the process is currently running (in that
 	 case the executable remains unchanged.)
 
 	 @see operator<<
 
   */
   bool setExecutable(const QString& proc);
 
 
   /**
    * Sets the executable and the command line argument list for this process.
    *
    * For example, doing an "ls -l /usr/local/bin" can be achieved by:
    *  <pre>
    *  OProcess p;
    *  ...
    *  p << "ls" << "-l" << "/usr/local/bin"
    *  </pre>
    *
    **/
   OProcess &operator<<(const QString& arg);
   /**
    * Similar to previous method, takes a char *, supposed to be in locale 8 bit already.
    */
   OProcess &operator<<(const char * arg);
   /**
    * Similar to previous method, takes a QCString, supposed to be in locale 8 bit already.
    */
   OProcess &operator<<(const QCString & arg);
 
   /**
    * Sets the executable and the command line argument list for this process,
    * in a single method call, or add a list of arguments.
    **/
   OProcess &operator<<(const QStringList& args);
 
   /**
    * Clear a command line argument list that has been set by using
    * the "operator<<".
   */
   void clearArguments();
 
   /**
    *  Starts the process.
    *  For a detailed description of the
    *  various run modes and communication semantics, have a look at the
@@ -299,128 +301,130 @@ public:
 
   /**
    * Use pid().
    * @deprecated
    */
   pid_t getPid() const { return pid(); }
 
   /**
    * Suspend processing of data from stdout of the child process.
    */
   void suspend();
 
   /**
    * Resume processing of data from stdout of the child process.
    */
   void resume();
 
   /**
    * @return @p true if the process has already finished and has exited
    *  "voluntarily", ie: it has not been killed by a signal.
    *
    * Note that you should check @ref OProcess::exitStatus() to determine
    * whether the process completed its task successful or not.
    */
   bool normalExit() const;
 
   /**
    * Returns the exit status of the process.
    *
    * Please use
    * @ref OProcess::normalExit() to check whether the process has exited
    * cleanly (i.e., @ref OProcess::normalExit() returns @p true) before calling
    * this function because if the process did not exit normally,
    * it does not have a valid exit status.
   */
   int  exitStatus() const;
 
 
   /**
    *	 Transmit data to the child process's stdin.
    *
    * OProcess::writeStdin may return false in the following cases:
    *
    *     @li The process is not currently running.
    *
    *     @li Communication to stdin has not been requested in the @ref start() call.
    *
    *     @li Transmission of data to the child process by a previous call to
    * @ref writeStdin() is still in progress.
    *
    * Please note that the data is sent to the client asynchronously,
    * so when this function returns, the data might not have been
    * processed by the child process.
    *
    * If all the data has been sent to the client, the signal
    * @ref wroteStdin() will be emitted.
    *
    * Please note that you must not free "buffer" or call @ref writeStdin()
    * again until either a @ref wroteStdin() signal indicates that the
    * data has been sent or a @ref processHasExited() signal shows that
    * the child process is no longer alive...
    **/
   bool writeStdin(const char *buffer, int buflen);
 
+  void flushStdin();
+
   /**
    * This causes the stdin file descriptor of the child process to be
    * closed indicating an "EOF" to the child.
    *
    * @return @p false if no communication to the process's stdin
    *  had been specified in the call to @ref start().
   */
   bool closeStdin();
 
   /**
    * This causes the stdout file descriptor of the child process to be
    * closed.
    *
    * @return @p false if no communication to the process's stdout
    *  had been specified in the call to @ref start().
   */
   bool closeStdout();
 
   /**
    * This causes the stderr file descriptor of the child process to be
    * closed.
    *
    * @return @p false if no communication to the process's stderr
    *  had been specified in the call to @ref start().
   */
   bool closeStderr();
 
   /**
    * Lets you see what your arguments are for debugging.
    */
 
   const QValueList<QCString> &args() { return arguments; }
 
   /**
    * Controls whether the started process should drop any
    * setuid/segid privileges or whether it should keep them
    *
    * The default is @p false : drop privileges
    */
   void setRunPrivileged(bool keepPrivileges);
 
   /**
    * Returns whether the started process will drop any
    * setuid/segid privileges or whether it will keep them
    */
   bool runPrivileged() const;
   
   /**
    * Modifies the environment of the process to be started.
    * This function must be called before starting the process.
    */
   void setEnvironment(const QString &name, const QString &value);
 
   /**
    * Changes the current working directory (CWD) of the process 
    * to be started.
    * This function must be called before starting the process.
    */
   void setWorkingDirectory(const QString &dir);
 
   /**
    * Specify whether to start the command via a shell or directly.
    * The default is to start the command directly.
    * If @p useShell is true @p shell will be used as shell, or
@@ -670,136 +674,74 @@ protected:
    * The socket notifiers for the above socket descriptors.
    */
   QSocketNotifier *innot;
   QSocketNotifier *outnot;
   QSocketNotifier *errnot;
 
   /**
    * Lists the communication links that are activated for the child
    * process.  Should not be modified from derived classes.
    */
   Communication communication;
 
   /**
    * Called by "slotChildOutput" this function copies data arriving from the
    * child process's stdout to the respective buffer and emits the signal
    * "@ref receivedStderr".
    */
   int childOutput(int fdno);
 
   /**
    * Called by "slotChildOutput" this function copies data arriving from the
    * child process's stdout to the respective buffer and emits the signal
    * "@ref receivedStderr"
    */
   int childError(int fdno);
 
   // information about the data that has to be sent to the child:
 
   const char *input_data;  // the buffer holding the data
   int input_sent;    // # of bytes already transmitted
   int input_total;   // total length of input_data
 
   /**
    * @ref OProcessController is a friend of OProcess because it has to have
    * access to various data members.
    */
   friend class OProcessController;
 
 
 private:
   /**
    * Searches for a valid shell. 
    * Here is the algorithm used for finding an executable shell:
    *
    *    @li Try the executable pointed to by the "SHELL" environment
    *    variable with white spaces stripped off
    *
    *    @li If your process runs with uid != euid or gid != egid, a shell
    *    not listed in /etc/shells will not used.
    *
    *    @li If no valid shell could be found, "/bin/sh" is used as a last resort.
    */
   QCString searchShell();
 
   /**
    * Used by @ref searchShell in order to find out whether the shell found
    * is actually executable at all.
    */
   bool isExecutable(const QCString &filename);
 
   // Disallow assignment and copy-construction
   OProcess( const OProcess& );
   OProcess& operator= ( const OProcess& );
 
-protected:
-  virtual void virtual_hook( int id, void* data );
 private:
-  OProcessPrivate *d;
-};
-
-class KShellProcessPrivate;
-
-/**
-* @obsolete
-*
-* This class is obsolete. Use OProcess and OProcess::setUseShell(true)
-* instead.
-*
-*   @short A class derived from @ref OProcess to start child
-*   	processes through a shell.
-*   @author Christian Czezakte <e9025461@student.tuwien.ac.at>
-*   @version $Id$
-*/
-class KShellProcess: public OProcess
-{
-  Q_OBJECT
-
-public:
-
-  /**
-   * Constructor
-   *
-   * By specifying the name of a shell (like "/bin/bash") you can override
-   * the mechanism for finding a valid shell as described in OProcess::searchShell()
-   */
-  KShellProcess(const char *shellname=0);
-
-  /**
-   * Destructor.
-   */
-  ~KShellProcess();
+  void init ( );
 
-  /**
-   * Starts up the process. -- For a detailed description
-   * have a look at the "start" member function and the detailed
-   * description of @ref OProcess .
-   */
-  virtual bool start(RunMode  runmode = NotifyOnExit,
-		  Communication comm = NoCommunication);
-
-  /**
-   * This function can be used to quote an argument string such that
-   * the shell processes it properly. This is e. g. necessary for
-   * user-provided file names which may contain spaces or quotes.
-   * It also prevents expansion of wild cards and environment variables.
-   */
-  static QString quote(const QString &arg);
-
-private:
-
-  QCString shell;
-
-  // Disallow assignment and copy-construction
-  KShellProcess( const KShellProcess& );
-  KShellProcess& operator= ( const KShellProcess& );
-
-protected:
-  virtual void virtual_hook( int id, void* data );
-private:
-  KShellProcessPrivate *d;
+  OProcessPrivate *d;
 };
 
 
 
 #endif