gnupgprocessbase.cpp

/*
    gnupgprocessbase.cpp
 
    This file is part of libkleopatra, the KDE keymanagement library
    Copyright (c) 2004 Klarälvdalens Datakonsult AB
 
    Libkleopatra 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.
 
    Libkleopatra 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 TQt library by Trolltech AS, Norway (or with modified versions
    of TQt that use the same license as TQt), 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
    TQt.  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 "gnupgprocessbase.h"
 
#include <kdebug.h>
#include <kurl.h>
 
#include <tqsocketnotifier.h>
#include <tqtextcodec.h>
#include <tqstringlist.h>
 
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <assert.h>
 
struct Kleo::GnuPGProcessBase::Private {
  Private() : usetStatusFD( false ), statnot( 0 ) {
    statusFD[0] = statusFD[1] = -1;
  }
 
  bool usetStatusFD;
  int statusFD[2];
  TQSocketNotifier * statnot;
  TQCString statusBuffer;
};
 
 
Kleo::GnuPGProcessBase::GnuPGProcessBase( TQObject * parent, const char * name )
  : TDEProcess( parent, name )
{
  d = new Private();
}
 
Kleo::GnuPGProcessBase::~GnuPGProcessBase() {
  delete d; d = 0;
}
 
void Kleo::GnuPGProcessBase::setUsetStatusFD( bool use ) {
  assert( d );
  d->usetStatusFD = use;
}
 
bool Kleo::GnuPGProcessBase::start( RunMode runmode, Communication comm ) {
  if ( d->usetStatusFD ) {
    // set up the status-fd. This should be in setupCommunication(),
    // but then it's too late: we need the fd of the pipe to pass it
    // as argument to the --status-fd option:
    // PENDING(marc) find out why TDEProcess uses both pipe() and socketpair()...
    if ( ::pipe( d->statusFD ) < 0 ) {
      kdDebug( 5150 ) << "Kleo::GnuPGProcessBase::start: pipe(2) failed: " << perror << endl;
      return false;
    }
    ::fcntl( d->statusFD[0], F_SETFD, FD_CLOEXEC );
    ::fcntl( d->statusFD[1], F_SETFD, FD_CLOEXEC );
    if ( !arguments.empty() ) {
      TQValueList<TQCString>::iterator it = arguments.begin();
      ++it;
      arguments.insert( it, "--status-fd" );
      char buf[25];
      sprintf( buf, "%d", d->statusFD[1] );
      arguments.insert( it, buf );
      arguments.insert( it, "--no-tty" );
      //arguments.insert( it, "--enable-progress-filter" ); // gpgsm doesn't know this
    }
  }
  return TDEProcess::start( runmode, comm );
}
 
int Kleo::GnuPGProcessBase::setupCommunication( Communication comm ) {
  if ( int ok = TDEProcess::setupCommunication( comm ) )
    return ok;
  if ( d->usetStatusFD ) {
    // base class impl returned error, so close our fd's, too
    ::close( d->statusFD[0] );
    ::close( d->statusFD[1] );
    d->statusFD[0] = d->statusFD[1] = -1;
  }
  return 0; // Error
}
 
int Kleo::GnuPGProcessBase::commSetupDoneP() {
  if ( d->usetStatusFD ) {
    ::close( d->statusFD[1] ); // close the input end of the pipe, we're the reader
    d->statnot = new TQSocketNotifier( d->statusFD[0], TQSocketNotifier::Read, this );
    connect( d->statnot, TQ_SIGNAL(activated(int)), TQ_SLOT(slotChildStatus(int)) );
  }
  return TDEProcess::commSetupDoneP();
}
 
int Kleo::GnuPGProcessBase::commSetupDoneC() {
  if ( d->usetStatusFD )
    ::fcntl( d->statusFD[1], F_SETFD, 0 );
  return TDEProcess::commSetupDoneC();
}
 
void Kleo::GnuPGProcessBase::slotChildStatus( int fd ) {
  if ( !childStatus(fd) )
    closetStatus();
}
 
bool Kleo::GnuPGProcessBase::closetStatus() {
  if ( !d->usetStatusFD )
    return false;
  d->usetStatusFD = false;
  delete d->statnot; d->statnot = 0;
  ::close( d->statusFD[0] ); d->statusFD[0] = -1;
  return true;
}
 
int Kleo::GnuPGProcessBase::childStatus( int fd ) {
  char buf[1024];
  const int len = ::read( fd, buf, sizeof(buf)-1 );
  if ( len > 0 ) {
    buf[len] = 0;
    d->statusBuffer += buf;
    parsetStatusOutput();
  }
  return len;
}
 
static TQString fromHexEscapedUtf8( const TQCString & str ) {
  return KURL::decode_string( str.data(), 106 /* utf-8 */ );
}
 
void Kleo::GnuPGProcessBase::parsetStatusOutput() {
  static const char startToken[] = "[GNUPG:] ";
  static const int startTokenLen = sizeof startToken / sizeof *startToken - 1;
 
  int lineStart = 0;
  for ( int lineEnd = d->statusBuffer.find( '\n' ) ; lineEnd >= 0 ; lineEnd = d->statusBuffer.find( '\n', lineStart = lineEnd+1 ) ) {
    // get next line:
    const TQCString line = d->statusBuffer.mid( lineStart, lineEnd - lineStart ).stripWhiteSpace();
    if ( line.isEmpty() )
      continue;
    // check status token
    if ( line.left( startTokenLen ) != startToken ) {
      kdDebug( 5150 ) << "Kleo::GnuPGProcessBase::childStatus: status-fd protocol error: line doesn't begin with \""
              << startToken << "\"" << endl;
      continue;
    }
    // remove status token:
    const TQCString command = line.mid( startTokenLen ).simplifyWhiteSpace() + ' ';
    if ( command == " " ) {
      kdDebug( 5150 ) << "Kleo::GnuPGProcessBase::childStatus: status-fd protocol error: line without content." << endl;
      continue;
    }
    // split into base and args
    TQString cmd;
    TQStringList args;
    int tagStart = 0;
    for ( int tagEnd = command.find( ' ' ) ; tagEnd >= 0 ; tagEnd = command.find( ' ', tagStart = tagEnd+1 ) ) {
      const TQCString tag = command.mid( tagStart, tagEnd - tagStart );
      if ( cmd.isNull() )
    cmd = fromHexEscapedUtf8( tag );
      else
    args.push_back( fromHexEscapedUtf8( tag ) );
    }
    emit status( this, cmd, args );
  }
  d->statusBuffer = d->statusBuffer.mid( lineStart );
}
 
void Kleo::GnuPGProcessBase::virtual_hook( int id, void * data ) {
  TDEProcess::virtual_hook( id, data );
}
 
#include "gnupgprocessbase.moc"