dumpcrlcachecommand.cpp

Go to the documentation of this file.

/* -*- mode: c++; c-basic-offset:4 -*-
    commands/dumpcrlcachecommand.cpp

    This file is part of Kleopatra, the KDE keymanager
    Copyright (c) 2008 Klarälvdalens Datakonsult AB

    Kleopatra 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.

    Kleopatra 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

    In addition, as a special exception, the copyright holders give
    permission to link the code of this program with any edition of
    the Qt library by Trolltech AS, Norway (or with modified versions
    of Qt that use the same license as Qt), and distribute linked
    combinations including the two.  You must obey the GNU General
    Public License in all respects for all of the code used other than
    Qt.  If you modify this file, you may extend this exception to
    your version of the file, but you are not obligated to do so.  If
    you do not wish to do so, delete this exception statement from
    your version.
*/

#include <config-kleopatra.h>

#include "dumpcrlcachecommand.h"

#include "command_p.h"

#include <utils/kdlogtextwidget.h>
#include <utils/gnupg-helper.h>

#include <KProcess>
#include <KMessageBox>
#include <KLocalizedString>
#include <KPushButton>
#include <KStandardGuiItem>
#include <KGlobalSettings>
#include <KConfigGroup>

#include <QString>
#include <QByteArray>
#include <QTimer>
#include <QHBoxLayout>
#include <QVBoxLayout>

static const int PROCESS_TERMINATE_TIMEOUT = 5000; // milliseconds

namespace {
    class DumpCrlCacheDialog : public QDialog {
        Q_OBJECT
    public:
        explicit DumpCrlCacheDialog( QWidget * parent=0 )
            : QDialog( parent ), ui( this )
        {
            readConfig();
        }
        ~DumpCrlCacheDialog()
        {
            writeConfig();
        }

    Q_SIGNALS:
        void updateRequested();

    public Q_SLOTS:
        void append( const QString & line ) {
            ui.logTextWidget.message( line );
        }
        void clear() {
            ui.logTextWidget.clear();
        }

    private:
        void readConfig()
        {
            KConfigGroup dialog( KGlobal::config(), "DumpCrlCacheDialog" );
            const QSize size = dialog.readEntry( "Size", QSize(600, 400) );
            if ( size.isValid() ) {
                resize( size );
            }
        }

        void writeConfig()
        {
            KConfigGroup dialog( KGlobal::config(), "DumpCrlCacheDialog" );
            dialog.writeEntry( "Size", size() );
            dialog.sync();
        }

        struct Ui {
            KDLogTextWidget logTextWidget;
            KPushButton     updateButton, closeButton;
            QVBoxLayout vlay;
            QHBoxLayout  hlay;

            explicit Ui( DumpCrlCacheDialog * q )
                : logTextWidget( q ),
                  updateButton( i18nc("@action:button Update the log text widget", "&Update"), q ),
                  closeButton( KStandardGuiItem::close(), q ),
                  vlay( q ),
                  hlay()
            {
                KDAB_SET_OBJECT_NAME( logTextWidget );
                KDAB_SET_OBJECT_NAME( updateButton );
                KDAB_SET_OBJECT_NAME( closeButton );
                KDAB_SET_OBJECT_NAME( vlay );
                KDAB_SET_OBJECT_NAME( hlay );

                logTextWidget.setFont( KGlobalSettings::fixedFont() );
                logTextWidget.setMinimumVisibleLines( 25 );
                logTextWidget.setMinimumVisibleColumns( 80 );

                vlay.addWidget( &logTextWidget, 1 );
                vlay.addLayout( &hlay );

                hlay.addWidget( &updateButton );
                hlay.addStretch( 1 );
                hlay.addWidget( &closeButton );

                connect( &updateButton, SIGNAL(clicked()),
                         q, SIGNAL(updateRequested()) );
                connect( &closeButton, SIGNAL(clicked()),
                         q, SLOT(close()) );
            }
        } ui;
    };
}

using namespace Kleo;
using namespace Kleo::Commands;

static QByteArray chomped( QByteArray ba ) {
    while ( ba.endsWith( '\n' ) || ba.endsWith( '\r' ) )
        ba.chop( 1 );
    return ba;
}

class DumpCrlCacheCommand::Private : Command::Private {
    friend class ::Kleo::Commands::DumpCrlCacheCommand;
    DumpCrlCacheCommand * q_func() const { return static_cast<DumpCrlCacheCommand*>( q ); }
public:
    explicit Private( DumpCrlCacheCommand * qq, KeyListController * c );
    ~Private();

    QString errorString() const {
        return QString::fromLocal8Bit( errorBuffer );
    }

private:
    void init();
    void refreshView();

private:
    void slotProcessFinished( int, QProcess::ExitStatus );

    void slotProcessReadyReadStandardOutput() {
        while ( process.canReadLine() ) {
            const QByteArray line = chomped( process.readLine() );
            if ( dialog )
                dialog->append( QString::fromLocal8Bit( line ) );
        }
    }

    void slotProcessReadyReadStandardError() {
        errorBuffer += process.readAllStandardError();
    }

    void slotUpdateRequested() {
        if ( process.state() == QProcess::NotRunning )
            refreshView();
    }

    void slotDialogDestroyed() {
        dialog = 0;
        if ( process.state() != QProcess::NotRunning )
            q->cancel();
        else
            finished();
    }

private:
    DumpCrlCacheDialog * dialog;
    KProcess process;
    QByteArray errorBuffer;
    bool canceled;
};

DumpCrlCacheCommand::Private * DumpCrlCacheCommand::d_func() { return static_cast<Private*>( d.get() ); }
const DumpCrlCacheCommand::Private * DumpCrlCacheCommand::d_func() const { return static_cast<const Private*>( d.get() ); }

#define d d_func()
#define q q_func()

DumpCrlCacheCommand::Private::Private( DumpCrlCacheCommand * qq, KeyListController * c )
    : Command::Private( qq, c ),
      dialog(0),
      process(),
      errorBuffer(),
      canceled( false )
{
    process.setOutputChannelMode( KProcess::SeparateChannels );
    process.setReadChannel( KProcess::StandardOutput );
    process << gpgSmPath() << QLatin1String("--call-dirmngr") << QLatin1String("listcrls");
}

DumpCrlCacheCommand::Private::~Private() {
    if ( dialog && !dialog->isVisible() )
        delete dialog;
}

DumpCrlCacheCommand::DumpCrlCacheCommand( KeyListController * c )
    : Command( new Private( this, c ) )
{
    d->init();
}

DumpCrlCacheCommand::DumpCrlCacheCommand( QAbstractItemView * v, KeyListController * c )
    : Command( v, new Private( this, c ) )
{
    d->init();
}

void DumpCrlCacheCommand::Private::init() {
    connect( &process, SIGNAL(finished(int,QProcess::ExitStatus)),
             q, SLOT(slotProcessFinished(int,QProcess::ExitStatus)) );
    connect( &process, SIGNAL(readyReadStandardError()),
             q, SLOT(slotProcessReadyReadStandardError()) );
    connect( &process, SIGNAL(readyReadStandardOutput()),
             q, SLOT(slotProcessReadyReadStandardOutput()) );
}

DumpCrlCacheCommand::~DumpCrlCacheCommand() {}

void DumpCrlCacheCommand::doStart() {

    d->dialog = new DumpCrlCacheDialog;
    d->dialog->setAttribute( Qt::WA_DeleteOnClose );
    d->dialog->setWindowTitle( i18n("CRL Cache Dump") );

    connect( d->dialog, SIGNAL(updateRequested()),
             this, SLOT(slotUpdateRequested()) );
    connect( d->dialog, SIGNAL(destroyed()),
             this, SLOT(slotDialogDestroyed()) );

    d->refreshView();
}

void DumpCrlCacheCommand::Private::refreshView() {

    dialog->clear();

    process.start();

    if ( process.waitForStarted() ) {
        dialog->show();
    } else {
        KMessageBox::error( dialog ? static_cast<QWidget*>( dialog ) : parentWidgetOrView(),
                            i18n( "Unable to start process gpgsm. "
                                  "Please check your installation." ),
                            i18n( "Dump CRL Cache Error" ) );
        finished();
    }
}

void DumpCrlCacheCommand::doCancel() {
    d->canceled = true;
    if ( d->process.state() != QProcess::NotRunning ) {
        d->process.terminate();
        QTimer::singleShot( PROCESS_TERMINATE_TIMEOUT, &d->process, SLOT(kill()) );
    }
    if ( d->dialog )
        d->dialog->close();
    d->dialog = 0;
}

void DumpCrlCacheCommand::Private::slotProcessFinished( int code, QProcess::ExitStatus status ) {
    if ( !canceled ) {
        if ( status == QProcess::CrashExit )
            KMessageBox::error( dialog,
                                i18n( "The GpgSM process that tried to dump the CRL cache "
                                      "ended prematurely because of an unexpected error. "
                                      "Please check the output of gpgsm --call-dirmngr listcrls for details." ),
                                i18n( "Dump CRL Cache Error" ) );
        else if ( code )
            KMessageBox::error( dialog,
                                i18n( "An error occurred while trying to dump the CRL cache. "
                                      "The output from GpgSM was:\n%1", errorString() ),
                                i18n( "Dump CRL Cache Error" ) );
    }
}

#undef d
#undef q

#include "moc_dumpcrlcachecommand.cpp"
#include "dumpcrlcachecommand.moc"