shellprocess.h

Go to the documentation of this file.

/*
 *  shellprocess.h  -  execute a process through the shell
 *  Program:  kalarm
 *  Copyright © 2004-2008 by David Jarvie <djarvie@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef SHELLPROCESS_H
#define SHELLPROCESS_H

#include <kprocess.h>
#include <QQueue>
#include <QByteArray>


class ShellProcess : public KProcess
{
        Q_OBJECT
    public:
        enum Status {
            INACTIVE,     // start() has not yet been called to run the command
            RUNNING,      // command is currently running
            SUCCESS,      // command appears to have exited successfully
            UNAUTHORISED, // shell commands are not authorised for this user
            DIED,         // command didn't exit cleanly, i.e. was killed or died
            NOT_FOUND,    // command either not found or not executable
            START_FAIL    // command couldn't be started for other reasons
        };
        explicit ShellProcess(const QString& command);
        bool            start(OpenMode = ReadWrite);
        Status          status() const       { return mStatus; }
        int             exitCode() const     { return mExitCode; }
        bool            normalExit() const   { return mStatus == SUCCESS; }
        const QString&  command() const      { return mCommand; }
        QString         errorMessage() const;
        void            writeStdin(const char* buffer, int bufflen);
        void            stdinExit();
        static bool     authorised();
        static const QByteArray& shellName()   { shellPath();  return mShellName; }
        static const QByteArray& shellPath();

    signals:
        void  shellExited(ShellProcess*);
        void  receivedStdout(ShellProcess*);
        void  receivedStderr(ShellProcess*);

    private slots:
        void  writtenStdin(qint64 bytes);
        void  stdoutReady()         { emit receivedStdout(this); }
        void  stderrReady()         { emit receivedStderr(this); }
        void  slotExited(int exitCode, QProcess::ExitStatus);

    private:
        // Prohibit the following inherited methods
        ShellProcess&  operator<<(const QString&);
        ShellProcess&  operator<<(const QStringList&);

        static QByteArray  mShellName;    // name of shell to be used
        static QByteArray  mShellPath;    // path of shell to be used
        static bool        mInitialised;  // true once static data has been initialised
        static bool        mAuthorised;   // true if shell commands are authorised
        QString            mCommand;      // copy of command to be executed
        QQueue<QByteArray> mStdinQueue;   // queued strings to send to STDIN
        qint64             mStdinBytes;   // bytes still to be written from first queued string
        int                mExitCode;     // shell exit value (if mStatus == SUCCESS or NOT_FOUND)
        Status             mStatus;       // current execution status
        bool               mStdinExit;    // exit once STDIN queue has been written
};

#endif // SHELLPROCESS_H

// vim: et sw=4: