You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
140 lines
5.9 KiB
140 lines
5.9 KiB
/*
|
|
* shellprocess.h - execute a process through the shell
|
|
* Program: kalarm
|
|
* Copyright © 2004-2006 by David Jarvie <software@astrojar.org.uk>
|
|
*
|
|
* 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
|
|
|
|
/** @file shellprocess.h - execute a process through the shell */
|
|
|
|
#include <kprocess.h>
|
|
|
|
|
|
/**
|
|
* @short Enhanced KShellProcess.
|
|
*
|
|
* The ShellProcess class runs a shell command and interprets the shell exit status
|
|
* as far as possible. It blocks execution if shell access is prohibited. It buffers
|
|
* data written to the process's stdin.
|
|
*
|
|
* Before executing any command, ShellProcess checks whether shell commands are
|
|
* allowed at all. If not (e.g. if the user is running in kiosk mode), it blocks
|
|
* execution.
|
|
*
|
|
* Derived from KShellProcess, this class additionally tries to interpret the shell
|
|
* exit status. Different shells use different exit codes. Currently, if bash or ksh
|
|
* report that the command could not be found or could not be executed, the NOT_FOUND
|
|
* status is returned.
|
|
*
|
|
* Writes to the process's stdin are buffered, so that unlike with KShellProcess, there
|
|
* is no need to wait for the write to complete before writing again.
|
|
*
|
|
* @author David Jarvie <software@astrojar.org.uk>
|
|
*/
|
|
class ShellProcess : public KShellProcess
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/** Current status of the shell process.
|
|
* @li INACTIVE - start() has not yet been called to run the command.
|
|
* @li RUNNING - the command is currently running.
|
|
* @li SUCCESS - the command appears to have exited successfully.
|
|
* @li UNAUTHORISED - shell commands are not authorised for this user.
|
|
* @li DIED - the command didn't exit cleanly, i.e. was killed or died.
|
|
* @li NOT_FOUND - the command was either not found or not executable.
|
|
* @li START_FAIL - the command couldn't be started for other reasons.
|
|
*/
|
|
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
|
|
};
|
|
/** Constructor.
|
|
* @param command The command line to be run when start() is called.
|
|
*/
|
|
explicit ShellProcess(const TQString& command);
|
|
/** Executes the configured command.
|
|
* @param comm Which communication links should be established to the child process
|
|
* (stdin/stdout/stderr).
|
|
*/
|
|
bool start(Communication comm = NoCommunication);
|
|
/** Returns the current status of the shell process. */
|
|
Status status() const { return mStatus; }
|
|
/** Returns whether the command was run successfully.
|
|
* @return True if the command has been run and appears to have exited successfully.
|
|
*/
|
|
bool normalExit() const { return mStatus == SUCCESS; }
|
|
/** Returns the command configured to be run. */
|
|
const TQString& command() const { return mCommand; }
|
|
/** Returns the error message corresponding to the command exit status.
|
|
* @return Error message if an error occurred. Null string if the command has not yet
|
|
* exited, or if the command ran successfully.
|
|
*/
|
|
TQString errorMessage() const;
|
|
/** Writes a string to the process's STDIN. */
|
|
void writeStdin(const char* buffer, int bufflen);
|
|
/** Tell the process to exit once any outstanding STDIN strings have been written. */
|
|
void stdinExit();
|
|
/** Returns whether the user is authorised to run shell commands. Shell commands may
|
|
* be prohibited in kiosk mode, for example.
|
|
*/
|
|
static bool authorised();
|
|
/** Determines which shell to use.
|
|
* @return file name of shell, excluding path.
|
|
*/
|
|
static const TQCString& shellName() { shellPath(); return mShellName; }
|
|
/** Determines which shell to use.
|
|
* @return path name of shell.
|
|
*/
|
|
static const TQCString& shellPath();
|
|
|
|
signals:
|
|
/** Signal emitted when the shell process execution completes. It is not emitted
|
|
* if start() did not attempt to start the command execution, e.g. in kiosk mode.
|
|
*/
|
|
void shellExited(ShellProcess*);
|
|
|
|
private slots:
|
|
void writtenStdin(KProcess*);
|
|
void slotExited(KProcess*);
|
|
|
|
private:
|
|
// Prohibit the following inherited methods
|
|
ShellProcess& operator<<(const TQString&);
|
|
ShellProcess& operator<<(const TQCString&);
|
|
ShellProcess& operator<<(const TQStringList&);
|
|
ShellProcess& operator<<(const char*);
|
|
|
|
static TQCString mShellName; // name of shell to be used
|
|
static TQCString 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
|
|
TQString mCommand; // copy of command to be executed
|
|
TQValueList<TQCString> mStdinQueue; // queued strings to send to STDIN
|
|
Status mStatus; // current execution status
|
|
bool mStdinExit; // exit once STDIN queue has been written
|
|
};
|
|
|
|
#endif // SHELLPROCESS_H
|