Q3FtpPI Class Reference

Inheritance diagram for Q3FtpPI:

[legend]Collaboration diagram for Q3FtpPI:

[legend]List of all members.

---

Detailed Description

Definition at line 145 of file q3ftp.cpp.

Signals
void	connectState (int)
void	finished (const QString &)
void	error (int, const QString &)
void	rawFtpReply (int, const QString &)
Public Member Functions
	Q3FtpPI (QObject *parent=0)
void	connectToHost (const QString &host, Q_UINT16 port)
bool	sendCommands (const QStringList &cmds)
bool	sendCommand (const QString &cmd)
void	clearPendingCommands ()
void	abort ()
QString	currentCommand () const
Public Attributes
bool	rawCommand
Q3FtpDTP	dtp
Private Types
enum	State
enum	AbortState
Private Slots
void	hostFound ()
void	connected ()
void	connectionClosed ()
void	delayedCloseFinished ()
void	readyRead ()
void	error (int)
void	dtpConnectState (int)
Private Member Functions
bool	processReply ()
bool	startNextCmd ()
Private Attributes
Q3Socket	commandSocket
QString	replyText
signed char	replyCode [3]
State	state
AbortState	abortState
QStringList	pendingCommands
QString	currentCmd
bool	waitForDtpToConnect
bool	waitForDtpToClose

---

Member Enumeration Documentation

enum Q3FtpPI::State [private]

Definition at line 187 of file q3ftp.cpp.

               {
  Begin,
  Idle,
  Waiting,
  Success,
  Failure
    };

enum Q3FtpPI::AbortState [private]

Definition at line 195 of file q3ftp.cpp.

                    {
  None,
  AbortStarted,
  WaitForAbortToFinish
    };

---

Constructor & Destructor Documentation

Q3FtpPI::Q3FtpPI

(

QObject *

parent = 0

)

Definition at line 616 of file q3ftp.cpp.

References commandSocket, QObject::connect(), connected(), connectionClosed(), connectState(), delayedCloseFinished(), dtp, dtpConnectState(), error(), hostFound(), readyRead(), SIGNAL, and SLOT.

                                  :
    QObject( parent ),
    rawCommand(false),
    dtp( this ),
    commandSocket( 0, "Q3FtpPI_socket" ),
    state( Begin ), abortState( None ),
    currentCmd( QString() ),
    waitForDtpToConnect( false ),
    waitForDtpToClose( false )
{
    connect( &commandSocket, SIGNAL(hostFound()),
      SLOT(hostFound()) );
    connect( &commandSocket, SIGNAL(connected()),
      SLOT(connected()) );
    connect( &commandSocket, SIGNAL(connectionClosed()),
      SLOT(connectionClosed()) );
    connect( &commandSocket, SIGNAL(delayedCloseFinished()),
      SLOT(delayedCloseFinished()) );
    connect( &commandSocket, SIGNAL(readyRead()),
      SLOT(readyRead()) );
    connect( &commandSocket, SIGNAL(error(int)),
      SLOT(error(int)) );

    connect( &dtp, SIGNAL(connectState(int)),
       SLOT(dtpConnectState(int)) );
}

Here is the call graph for this function:

---

Member Function Documentation

void Q3FtpPI::connectToHost	(	const QString &	host,
		Q_UINT16	port
	)

Definition at line 643 of file q3ftp.cpp.

References commandSocket, connectState(), Q3Socket::connectToHost(), emit, and Q3Ftp::HostLookup.

{
    emit connectState( Q3Ftp::HostLookup );
    commandSocket.connectToHost( host, port );
}

Here is the call graph for this function:

bool Q3FtpPI::sendCommands

(

const QStringList &

cmds

)

Definition at line 657 of file q3ftp.cpp.

References commandSocket, Q3Socket::Connected, emit, error(), Idle, QList< T >::isEmpty(), Q3Ftp::NotConnected, pendingCommands, startNextCmd(), state, and Q3Socket::state().

Referenced by sendCommand().

{
    if ( !pendingCommands.isEmpty() )
  return false;

    if ( commandSocket.state()!=Q3Socket::Connected || state!=Idle ) {
  emit error( Q3Ftp::NotConnected, QFtp::tr( "Not connected" ) );
  return true; // there are no pending commands
    }

    pendingCommands = cmds;
    startNextCmd();
    return true;
}

Here is the call graph for this function:

bool Q3FtpPI::sendCommand

(

const QString &

cmd

)

[inline]

Definition at line 155 of file q3ftp.cpp.

References sendCommands().

    { return sendCommands( QStringList( cmd ) ); }

Here is the call graph for this function:

void Q3FtpPI::clearPendingCommands

(

)

Definition at line 672 of file q3ftp.cpp.

References Q3FtpDTP::abortConnection(), QString::clear(), QList< T >::clear(), currentCmd, dtp, Idle, pendingCommands, and state.

{
    pendingCommands.clear();
    dtp.abortConnection();
    currentCmd.clear();
    state = Idle;
}

Here is the call graph for this function:

void Q3FtpPI::abort

(

)

Definition at line 680 of file q3ftp.cpp.

References Q3FtpDTP::abortConnection(), AbortStarted, abortState, QList< T >::clear(), commandSocket, currentCmd, dtp, None, pendingCommands, qDebug(), and QString::startsWith().

{
    pendingCommands.clear();

    if ( abortState != None )
  // ABOR already sent
  return;

    abortState = AbortStarted;
#if defined(Q3FTPPI_DEBUG)
    qDebug( "Q3FtpPI send: ABOR" );
#endif
    commandSocket.writeBlock( "ABOR\r\n", 6 );

    if ( currentCmd.startsWith("STOR ") )
  dtp.abortConnection();
}

Here is the call graph for this function:

QString Q3FtpPI::currentCommand

(

)

const [inline]

Definition at line 161 of file q3ftp.cpp.

References currentCmd.

Referenced by Q3FtpDTP::socketReadyRead().

    { return currentCmd; }

void Q3FtpPI::connectState

(

int

)

[signal]

Referenced by connected(), connectionClosed(), connectToHost(), delayedCloseFinished(), error(), hostFound(), processReply(), and Q3FtpPI().

void Q3FtpPI::finished

(

const QString &

)

[signal]

Referenced by processReply(), and startNextCmd().

void Q3FtpPI::error	(	int	,
		const QString &
	)			[signal]

Referenced by dtpConnectState(), error(), processReply(), Q3FtpPI(), and sendCommands().

void Q3FtpPI::rawFtpReply	(	int	,
		const QString &
	)			[signal]

Referenced by processReply().

void Q3FtpPI::hostFound

(

)

[private, slot]

Definition at line 698 of file q3ftp.cpp.

References Q3Ftp::Connecting, connectState(), and emit.

Referenced by Q3FtpPI().

{
    emit connectState( Q3Ftp::Connecting );
}

void Q3FtpPI::connected

(

)

[private, slot]

Definition at line 703 of file q3ftp.cpp.

References Begin, Q3Ftp::Connected, connectState(), emit, and state.

Referenced by Q3FtpPI().

{
    state = Begin;
#if defined(Q3FTPPI_DEBUG)
//    qDebug( "Q3FtpPI state: %d [connected()]", state );
#endif
    emit connectState( Q3Ftp::Connected );
}

void Q3FtpPI::connectionClosed

(

)

[private, slot]

Definition at line 712 of file q3ftp.cpp.

References Q3Socket::close(), commandSocket, connectState(), emit, and Q3Ftp::Unconnected.

Referenced by Q3FtpPI().

{
    commandSocket.close();
    emit connectState( Q3Ftp::Unconnected );
}

void Q3FtpPI::delayedCloseFinished

(

)

[private, slot]

Definition at line 718 of file q3ftp.cpp.

References connectState(), emit, and Q3Ftp::Unconnected.

Referenced by Q3FtpPI().

{
    emit connectState( Q3Ftp::Unconnected );
}

void Q3FtpPI::readyRead

(

)

[private, slot]

Definition at line 736 of file q3ftp.cpp.

References Q3Socket::canReadLine(), commandSocket, QUnicodeTables::digitValue(), QString::endsWith(), i, QString::isEmpty(), QString::left(), QString::length(), QString::mid(), processReply(), QIODevice::readLine(), replyCode, replyText, QString::truncate(), and waitForDtpToClose.

Referenced by dtpConnectState(), and Q3FtpPI().

{
    if ( waitForDtpToClose )
  return;

    while ( commandSocket.canReadLine() ) {
  // read line with respect to line continuation
  QString line = commandSocket.readLine();
  if ( replyText.isEmpty() ) {
      if ( line.length() < 3 ) {
    // ### protocol error
    return;
      }
      const int lowerLimit[3] = {1,0,0};
      const int upperLimit[3] = {5,5,9};
      for ( int i=0; i<3; i++ ) {
    replyCode[i] = line[i].digitValue();
    if ( replyCode[i]<lowerLimit[i] || replyCode[i]>upperLimit[i] ) {
        // ### protocol error
        return;
    }
      }
  }
  QString endOfMultiLine;
  endOfMultiLine[0] = '0' + replyCode[0];
  endOfMultiLine[1] = '0' + replyCode[1];
  endOfMultiLine[2] = '0' + replyCode[2];
  endOfMultiLine[3] = ' ';
  QString lineCont( endOfMultiLine );
  lineCont[3] = '-';
  QString lineLeft4 = line.left(4);

  while ( lineLeft4 != endOfMultiLine ) {
      if ( lineLeft4 == lineCont )
    replyText += line.mid( 4 ); // strip 'xyz-'
      else
    replyText += line;
      if ( !commandSocket.canReadLine() )
    return;
      line = commandSocket.readLine();
      lineLeft4 = line.left(4);
  }
  replyText += line.mid( 4 ); // strip reply code 'xyz '
  if ( replyText.endsWith("\r\n") )
      replyText.truncate( replyText.length()-2 );

  if ( processReply() )
      replyText = "";
    }
}

void Q3FtpPI::error

(

int

)

[private, slot]

Definition at line 723 of file q3ftp.cpp.

References commandSocket, Q3Ftp::ConnectionRefused, connectState(), emit, Q3Socket::ErrConnectionRefused, Q3Socket::ErrHostNotFound, error(), Q3Ftp::HostNotFound, Q3Socket::peerName(), and Q3Ftp::Unconnected.

{
    if ( e == Q3Socket::ErrHostNotFound ) {
  emit connectState( Q3Ftp::Unconnected );
  emit error( Q3Ftp::HostNotFound,
        QFtp::tr( "Host %1 not found" ).arg( commandSocket.peerName() ) );
    } else if ( e == Q3Socket::ErrConnectionRefused ) {
  emit connectState( Q3Ftp::Unconnected );
  emit error( Q3Ftp::ConnectionRefused,
        QFtp::tr( "Connection refused to host %1" ).arg( commandSocket.peerName() ) );
    }
}

void Q3FtpPI::dtpConnectState

(

int

)

[private, slot]

Definition at line 974 of file q3ftp.cpp.

References Q3Ftp::ConnectionRefused, Q3FtpDTP::CsClosed, Q3FtpDTP::CsConnected, Q3FtpDTP::CsConnectionRefused, Q3FtpDTP::CsHostNotFound, emit, error(), processReply(), readyRead(), replyText, startNextCmd(), waitForDtpToClose, and waitForDtpToConnect.

Referenced by Q3FtpPI().

{
    switch ( s ) {
  case Q3FtpDTP::CsClosed:
      if ( waitForDtpToClose ) {
    // there is an unprocessed reply
    if ( processReply() )
        replyText = "";
    else
        return;
      }
      waitForDtpToClose = false;
      readyRead();
      return;
  case Q3FtpDTP::CsConnected:
      waitForDtpToConnect = false;
      startNextCmd();
      return;
  case Q3FtpDTP::CsHostNotFound:
  case Q3FtpDTP::CsConnectionRefused:
      emit error( Q3Ftp::ConnectionRefused,
      QFtp::tr( "Connection refused for data connection" ) );
      startNextCmd();
      return;
  default:
      return;
    }
}

bool Q3FtpPI::processReply

(

)

[private]

Definition at line 793 of file q3ftp.cpp.

References AbortStarted, abortState, Begin, QRegExp::capturedTexts(), Q3FtpDTP::clearError(), commandSocket, connectState(), Q3FtpDTP::connectToHost(), QList< T >::count(), currentCmd, dtp, emit, error(), Q3FtpDTP::errorMessage(), Failure, finished(), QList< T >::first(), Q3FtpDTP::hasError(), Idle, Q3Socket::Idle, QString::length(), Q3Ftp::LoggedIn, None, Q3Socket::peerName(), pendingCommands, QList< T >::pop_front(), qDebug(), rawCommand, rawFtpReply(), replyCode, replyText, Q3FtpDTP::setBytesTotal(), Q3FtpDTP::socketState(), startNextCmd(), QString::startsWith(), state, Success, t, QString::toInt(), Q3Ftp::UnknownError, WaitForAbortToFinish, waitForDtpToClose, waitForDtpToConnect, Waiting, and Q3FtpDTP::writeData().

Referenced by dtpConnectState(), and readyRead().

{
#if defined(Q3FTPPI_DEBUG)
//    qDebug( "Q3FtpPI state: %d [processReply() begin]", state );
    if ( replyText.length() < 400 )
  qDebug( "Q3FtpPI recv: %d %s", 100*replyCode[0]+10*replyCode[1]+replyCode[2], replyText.latin1() );
    else
  qDebug( "Q3FtpPI recv: %d (text skipped)", 100*replyCode[0]+10*replyCode[1]+replyCode[2] );
#endif

    // process 226 replies ("Closing Data Connection") only when the data
    // connection is really closed to avoid short reads of the DTP
    if ( 100*replyCode[0]+10*replyCode[1]+replyCode[2] == 226 ) {
  if ( dtp.socketState() != Q3Socket::Idle ) {
      waitForDtpToClose = true;
      return false;
  }
    }

    switch ( abortState ) {
  case AbortStarted:
      abortState = WaitForAbortToFinish;
      break;
  case WaitForAbortToFinish:
      abortState = None;
      return true;
  default:
      break;
    }

    // get new state
    static const State table[5] = {
  /* 1yz   2yz      3yz   4yz      5yz */
  Waiting, Success, Idle, Failure, Failure
    };
    switch ( state ) {
  case Begin:
      if ( replyCode[0] == 1 ) {
    return true;
      } else if ( replyCode[0] == 2 ) {
    state = Idle;
    emit finished( QFtp::tr( "Connected to host %1" ).arg( commandSocket.peerName() ) );
    break;
      }
      // ### error handling
      return true;
  case Waiting:
      if ( replyCode[0]<0 || replyCode[0]>5 )
    state = Failure;
      else
#if defined(Q_OS_IRIX) && defined(Q_CC_GNU)
            {
                // work around a crash on 64 bit gcc IRIX
                State *t = (State *) table;
                state = t[replyCode[0] - 1];
            }
#else
            state = table[replyCode[0] - 1];
#endif
      break;
  default:
      // ### spontaneous message
      return true;
    }
#if defined(Q3FTPPI_DEBUG)
//    qDebug( "Q3FtpPI state: %d [processReply() intermediate]", state );
#endif

    // special actions on certain replies
    int replyCodeInt = 100*replyCode[0] + 10*replyCode[1] + replyCode[2];
    emit rawFtpReply( replyCodeInt, replyText );
    if ( rawCommand ) {
  rawCommand = false;
    } else if ( replyCodeInt == 227 ) {
  // 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2)
        // rfc959 does not define this response precisely, and gives
        // both examples where the parenthesis are used, and where
        // they are missing. We need to scan for the address and host
        // info.
  QRegExp addrPortPattern("(\\d+),(\\d+),(\\d+),(\\d+),(\\d+),(\\d+)");
  if (addrPortPattern.search(replyText) == -1) {
#if defined(Q3FTPPI_DEBUG)
      qDebug( "Q3Ftp: bad 227 response -- address and port information missing" );
#endif
      // ### error handling
  } else {
      QStringList lst = addrPortPattern.capturedTexts();
      QString host = lst[1] + "." + lst[2] + "." + lst[3] + "." + lst[4];
      Q_UINT16 port = ( lst[5].toUInt() << 8 ) + lst[6].toUInt();
      waitForDtpToConnect = true;
      dtp.connectToHost( host, port );
  }
    } else if ( replyCodeInt == 230 ) {
  if ( currentCmd.startsWith("USER ") && pendingCommands.count()>0 &&
    pendingCommands.first().startsWith("PASS ") ) {
      // no need to send the PASS -- we are already logged in
      pendingCommands.pop_front();
  }
  // 230 User logged in, proceed.
  emit connectState( Q3Ftp::LoggedIn );
    } else if ( replyCodeInt == 213 ) {
  // 213 File status.
  if ( currentCmd.startsWith("SIZE ") )
      dtp.setBytesTotal( replyText.simplifyWhiteSpace().toInt() );
    } else if ( replyCode[0]==1 && currentCmd.startsWith("STOR ") ) {
  dtp.writeData();
    }

    // react on new state
    switch ( state ) {
  case Begin:
      // ### should never happen
      break;
  case Success:
      // ### success handling
      state = Idle;
      // no break!
  case Idle:
      if ( dtp.hasError() ) {
    emit error( Q3Ftp::UnknownError, dtp.errorMessage() );
    dtp.clearError();
      }
      startNextCmd();
      break;
  case Waiting:
      // ### do nothing
      break;
  case Failure:
      emit error( Q3Ftp::UnknownError, replyText );
      state = Idle;
      startNextCmd();
      break;
    }
#if defined(Q3FTPPI_DEBUG)
//    qDebug( "Q3FtpPI state: %d [processReply() end]", state );
#endif
    return true;
}

Here is the call graph for this function:

bool Q3FtpPI::startNextCmd

(

)

[private]

Definition at line 940 of file q3ftp.cpp.

References QString::clear(), commandSocket, currentCmd, QByteArray::data(), emit, finished(), QList< T >::first(), QTextCodec::fromUnicode(), Idle, QList< T >::isEmpty(), QString::left(), len, QString::length(), pendingCommands, QList< T >::pop_front(), qDebug(), qt_ftp_filename_codec, replyText, state, waitForDtpToConnect, and Waiting.

Referenced by dtpConnectState(), processReply(), and sendCommands().

{
    if ( waitForDtpToConnect )
  // don't process any new commands until we are connected
  return true;

#if defined(Q3FTPPI_DEBUG)
    if ( state != Idle )
  qDebug( "Q3FtpPI startNextCmd: Internal error! Q3FtpPI called in non-Idle state %d", state );
#endif
    if ( pendingCommands.isEmpty() ) {
  currentCmd.clear();
  emit finished( replyText );
  return false;
    }
    currentCmd = pendingCommands.first();
    pendingCommands.pop_front();
#if defined(Q3FTPPI_DEBUG)
    qDebug( "Q3FtpPI send: %s", currentCmd.left( currentCmd.length()-2 ).latin1() );
#endif
    state = Waiting;
#ifndef QT_NO_TEXTCODEC
    if ( qt_ftp_filename_codec ) {
  int len;
  Q3CString enc = qt_ftp_filename_codec->fromUnicode(currentCmd,len);
  commandSocket.writeBlock( enc.data(), len );
    } else
#endif
    {
  commandSocket.writeBlock( currentCmd.latin1(), currentCmd.length() );
    }
    return true;
}

Here is the call graph for this function:

---

Member Data Documentation

bool Q3FtpPI::rawCommand

Definition at line 164 of file q3ftp.cpp.

Referenced by processReply().

Q3FtpDTP Q3FtpPI::dtp

Definition at line 166 of file q3ftp.cpp.

Referenced by abort(), clearPendingCommands(), processReply(), and Q3FtpPI().

Q3Socket Q3FtpPI::commandSocket [private]

Definition at line 204 of file q3ftp.cpp.

Referenced by abort(), connectionClosed(), connectToHost(), error(), processReply(), Q3FtpPI(), readyRead(), sendCommands(), and startNextCmd().

QString Q3FtpPI::replyText [private]

Definition at line 205 of file q3ftp.cpp.

Referenced by dtpConnectState(), processReply(), readyRead(), and startNextCmd().

signed char Q3FtpPI::replyCode[3] [private]

Definition at line 206 of file q3ftp.cpp.

Referenced by processReply(), and readyRead().

State Q3FtpPI::state [private]

Definition at line 207 of file q3ftp.cpp.

Referenced by clearPendingCommands(), connected(), processReply(), sendCommands(), and startNextCmd().

AbortState Q3FtpPI::abortState [private]

Definition at line 208 of file q3ftp.cpp.

Referenced by abort(), and processReply().

QStringList Q3FtpPI::pendingCommands [private]

Definition at line 209 of file q3ftp.cpp.

Referenced by abort(), clearPendingCommands(), processReply(), sendCommands(), and startNextCmd().

QString Q3FtpPI::currentCmd [private]

Definition at line 210 of file q3ftp.cpp.

Referenced by abort(), clearPendingCommands(), currentCommand(), processReply(), and startNextCmd().

bool Q3FtpPI::waitForDtpToConnect [private]

Definition at line 212 of file q3ftp.cpp.

Referenced by dtpConnectState(), processReply(), and startNextCmd().

bool Q3FtpPI::waitForDtpToClose [private]

Definition at line 213 of file q3ftp.cpp.

Referenced by dtpConnectState(), processReply(), and readyRead().

---

The documentation for this class was generated from the following file:

• src/qt3support/network/q3ftp.cpp

---