ProcessInfo.h

Go to the documentation of this file.

/*
    Copyright 2007-2008 by Robert Knight <robertknight@gmail.com>

    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 PROCESSINFO_H
#define PROCESSINFO_H

// Qt
#include <QtCore/QFile>
#include <QtCore/QMap>
#include <QtCore/QString>
#include <QtCore/QVector>

namespace Konsole
{
class ProcessInfo
{
public:
    static ProcessInfo* newInstance(int pid, bool readEnvironment = false);

    virtual ~ProcessInfo() {}

    void update();

    bool isValid() const;
    int pid(bool* ok) const;
    int parentPid(bool* ok) const;

    int foregroundPid(bool* ok) const;

    /* Returns the user id of the process */
    int userId(bool* ok) const;

    QString userName() const;

    QString userHomeDir() const;

    static QString localHost();

    QString name(bool* ok) const;

    QVector<QString> arguments(bool* ok) const;
    QMap<QString, QString> environment(bool* ok) const;

    QString currentDir(bool* ok) const;

    QString validCurrentDir() const;

    void setUserHomeDir();

    QString format(const QString& text) const;

    enum Error {
        NoError,
        UnknownError,
        PermissionsError
    };

    Error error() const;

protected:
    explicit ProcessInfo(int pid , bool readEnvironment = false);

    virtual bool readProcessInfo(int pid , bool readEnvironment) = 0;

    /* Read the user name */
    virtual void readUserName(void) = 0;

    void setPid(int pid);
    void setParentPid(int pid);
    void setForegroundPid(int pid);
    void setUserId(int uid);
    void setUserName(const QString& name);
    void setName(const QString& name);
    void setCurrentDir(const QString& dir);

    void setError(Error error);

    void setFileError(QFile::FileError error);

    void addArgument(const QString& argument);

    void clearArguments();

    void addEnvironmentBinding(const QString& name , const QString& value);

private:
    // takes a full directory path and returns a
    // shortened version suitable for display in
    // space-constrained UI elements (eg. tabs)
    QString formatShortDir(const QString& dirPath) const;

    // valid bits for _fields variable, ensure that
    // _fields is changed to an int if more than 8 fields are added
    enum FIELD_BITS {
        PROCESS_ID          = 1,
        PARENT_PID          = 2,
        FOREGROUND_PID      = 4,
        ARGUMENTS           = 8,
        ENVIRONMENT         = 16,
        NAME                = 32,
        CURRENT_DIR         = 64,
        UID                 = 128
    };

    char _fields; // a bitmap indicating which fields are valid
    // used to set the "ok" parameters for the public
    // accessor functions

    bool _enableEnvironmentRead; // specifies whether to read the environment
    // bindings when update() is called
    int _pid;
    int _parentPid;
    int _foregroundPid;
    int _userId;

    Error _lastError;

    QString _name;
    QString _userName;
    QString _userHomeDir;
    QString _currentDir;

    QVector<QString> _arguments;
    QMap<QString, QString> _environment;

    static QSet<QString> commonDirNames();
    static QSet<QString> _commonDirNames;
};

class NullProcessInfo : public ProcessInfo
{
public:
    explicit NullProcessInfo(int pid, bool readEnvironment = false);
protected:
    virtual bool readProcessInfo(int pid, bool readEnvironment);
    virtual void readUserName(void);
};

#if !defined(Q_OS_WIN)

class UnixProcessInfo : public ProcessInfo
{
public:
    explicit UnixProcessInfo(int pid, bool readEnvironment = false);

protected:
    virtual bool readProcessInfo(int pid , bool readEnvironment);

    virtual void readUserName(void);

private:
    virtual bool readProcInfo(int pid) = 0;

    virtual bool readEnvironment(int pid) = 0;

    virtual bool readArguments(int pid) = 0;

    virtual bool readCurrentDir(int pid) = 0;
};
#endif

class SSHProcessInfo
{
public:
    explicit SSHProcessInfo(const ProcessInfo& process);

    QString userName() const;

    QString host() const;

    QString port() const;

    QString command() const;

    QString format(const QString& input) const;

private:
    const ProcessInfo& _process;
    QString _user;
    QString _host;
    QString _port;
    QString _command;
};
}
#endif //PROCESSINFO_H