kgpgtransaction.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008,2009,2012,2013 Rolf Eike Beer <kde@opensource.sf-tec.de>
 */

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KGPGTRANSACTION_H
#define KGPGTRANSACTION_H

#include <QObject>
#include <QString>

class GPGProc;
class KGpgSignTransactionHelper;
class KGpgTransactionPrivate;
class KUrl;
class QByteArray;
class QProcess;

class KGpgTransaction: public QObject {
    Q_OBJECT

    friend class KGpgTransactionPrivate;
    friend class KGpgSignTransactionHelper;

    Q_DISABLE_COPY(KGpgTransaction)

public:
    enum ts_transaction {
        TS_OK = 0,          
        TS_BAD_PASSPHRASE = 1,      
        TS_MSG_SEQUENCE = 2,        
        TS_USER_ABORTED = 3,        
        TS_INVALID_EMAIL = 4,       
        TS_INPUT_PROCESS_ERROR = 5, 
        TS_COMMON_END = 100     
    };
    enum ts_boolanswer {
        BA_UNKNOWN = 0,         
        BA_YES = 1,         
        BA_NO = 2           
    };
    enum ts_hintType {
        HT_KEYEXPIRED = 0,  
        HT_SIGEXPIRED = 1,  
        HT_NOSECKEY = 2,    
        HT_ENCTO = 3        
    };

    explicit KGpgTransaction(QObject *parent = 0, const bool allowChaining = false);
    virtual ~KGpgTransaction();

    void start();

    void setGnuPGHome(const QString &home);

    int waitForFinished(const int msecs = -1);

    const QString &getDescription() const;

    void setInputTransaction(KGpgTransaction *ta);

    void clearInputTransaction();

    bool hasInputTransaction() const;

    void kill();

signals:
    void done(int result);

    void statusMessage(const QString &msg);

    void infoProgress(qulonglong processedAmount, qulonglong totalAmount);

protected:
    virtual bool preStart();
    virtual void postStart();
    virtual bool nextLine(const QString &line) = 0;
    virtual ts_boolanswer boolQuestion(const QString &line);

    virtual ts_boolanswer confirmOverwrite(KUrl &currentFile);

    virtual bool hintLine(const ts_hintType hint, const QString &args);
    virtual void finish();
    virtual void newPassphraseEntered();
    void setDescription(const QString &description);

    void waitForInputTransaction();

    void unexpectedLine(const QString &line);

    virtual bool passphraseRequested();

    virtual bool passphraseReceived();

private:
    KGpgTransactionPrivate* const d;

    Q_PRIVATE_SLOT(d, void slotReadReady())
    Q_PRIVATE_SLOT(d, void slotProcessExited())
    Q_PRIVATE_SLOT(d, void slotProcessStarted())
    Q_PRIVATE_SLOT(d, void slotInputTransactionDone(int))
    Q_PRIVATE_SLOT(d, void slotPassphraseEntered(const QString &))
    Q_PRIVATE_SLOT(d, void slotPassphraseAborted())

protected:
    void askNewPassphrase(const QString &text);

    int getSuccess() const;
    void setSuccess(const int v);

    void addIdHint(QString txt);
    QString getIdHints() const;

    GPGProc *getProcess();
    int addArgument(const QString &arg);
    int addArguments(const QStringList &args);
    void replaceArgument(const int pos, const QString &arg);
    void insertArgument(const int pos, const QString &arg);
    void insertArguments(const int pos, const QStringList &args);
    void addArgumentRef(int *ref);
    void write(const QByteArray &a, const bool lf = true);
    void write(const int i);
     bool askPassphrase(const QString &message = QString());
};

#endif // KGPGTRANSACTION_H