#include <qnetworkaccessftpbackend_p.h>

Inheritance diagram for QNetworkAccessFtpBackend:

Public Types
enum	State { Idle, LoggingIn, CheckingFeatures, Statting, Transferring, Disconnecting }

Public Slots
void	ftpConnectionReady (QNetworkAccessCache::CacheableObject *object)

void	ftpDone ()

void	ftpRawCommandReply (int code, const QString &text)

void	ftpReadyRead ()

Public Slots inherited from QNetworkAccessBackend
void	writeDownstreamData (QIODevice *data)

Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

Public Functions
virtual void	closeDownstreamChannel ()

void	disconnectFromFtp ()

virtual void	downstreamReadyWrite ()

virtual void	open ()

	QNetworkAccessFtpBackend ()

virtual	~QNetworkAccessFtpBackend ()

Public Functions inherited from QNetworkAccessBackend
QVariant	attribute (QNetworkRequest::Attribute code) const

virtual bool	canResume () const

virtual void	copyFinished (QIODevice *)

virtual void	emitReadBufferFreed (qint64 size)

virtual QNetworkCacheMetaData	fetchCacheMetaData (const QNetworkCacheMetaData &metaData) const

virtual void	fetchSslConfiguration (QSslConfiguration &configuration) const

bool	hasRawHeader (const QByteArray &headerName) const

QVariant	header (QNetworkRequest::KnownHeaders header) const

virtual void	ignoreSslErrors ()

virtual void	ignoreSslErrors (const QList< QSslError > &errors)

bool	isCachingEnabled () const

bool	isSynchronous ()

virtual bool	needsResetableUploadData ()

QAbstractNetworkCache *	networkCache () const

QNetworkAccessManager::Operation	operation () const

virtual bool	processRequestSynchronously ()

QList< QNetworkProxy >	proxyList () const

	QNetworkAccessBackend ()

QByteArray	rawHeader (const QByteArray &headerName) const

QList< QByteArray >	rawHeaderList () const

QNetworkRequest	request () const

void	setAttribute (QNetworkRequest::Attribute code, const QVariant &value)

void	setCachingEnabled (bool enable)

virtual void	setDownstreamLimited (bool b)

void	setHeader (QNetworkRequest::KnownHeaders header, const QVariant &value)

void	setRawHeader (const QByteArray &headerName, const QByteArray &value)

virtual void	setReadBufferSize (qint64 size)

virtual void	setResumeOffset (quint64 offset)

virtual void	setSslConfiguration (const QSslConfiguration &configuration)

void	setSynchronous (bool sync)

void	setUrl (const QUrl &url)

virtual bool	start ()
	Starts the backend. More...

QUrl	url () const

virtual	~QNetworkAccessBackend ()

Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...

const QObjectList &	children () const
	Returns a list of child objects. More...

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...

virtual bool	eventFilter (QObject , QEvent )
	Filters events if this object has been installed as an event filter for the watched object. More...

template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...

void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...

bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...

void	killTimer (int id)
	Kills the timer with timer identifier, id. More...

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...

QString	objectName () const

QObject *	parent () const
	Returns a pointer to the parent object. More...

QVariant	property (const char *name) const
	Returns the value of the object's name property. More...

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...

void	setObjectName (const QString &name)

void	setParent (QObject *)
	Makes the object a child of parent. More...

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...

void	setUserData (uint id, QObjectUserData *data)

bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

QThread *	thread () const
	Returns the thread in which the object lives. More...

QObjectUserData *	userData (uint id) const

virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Properties
QPointer< QNetworkAccessCachedFtpConnection >	ftp

int	helpId

int	mdtmId

int	sizeId

State	state

bool	supportsMdtm

bool	supportsSize

qint64	totalBytes

QIODevice *	uploadDevice

Friends
class	QNetworkAccessFtpIODevice

Additional Inherited Members
Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Slots inherited from QNetworkAccessBackend
void	authenticationRequired (QAuthenticator *auth)

void	emitReplyUploadProgress (qint64 bytesSent, qint64 bytesTotal)

void	error (QNetworkReply::NetworkError code, const QString &errorString)

void	finished ()

void	metaDataChanged ()

void	proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *auth)

void	redirectionRequested (const QUrl &destination)

void	sslErrors (const QList< QSslError > &errors)

Protected Functions inherited from QNetworkAccessBackend
QNonContiguousByteDevice *	createUploadByteDevice ()

char *	getDownloadBuffer (qint64)

qint64	nextDownstreamBlockSize () const

void	writeDownstreamData (QByteDataBuffer &list)

void	writeDownstreamDataDownloadBuffer (qint64, qint64)

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

	QObject (QObjectPrivate &dd, QObject *parent=0)

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...

QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *)
	This event handler can be reimplemented in a subclass to receive timer events for the object. More...

Protected Variables inherited from QNetworkAccessBackend
QNetworkAccessManagerPrivate *	manager

QNetworkReplyImplPrivate *	reply

QSharedPointer< QNonContiguousByteDevice >	uploadByteDevice

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

Definition at line 71 of file qnetworkaccessftpbackend_p.h.

Enumerations

◆ State

enum QNetworkAccessFtpBackend::State

Enumerator
Idle
LoggingIn
CheckingFeatures
Statting
Transferring
Disconnecting

Definition at line 75 of file qnetworkaccessftpbackend_p.h.

                {
         Idle,
         //Connecting,
         LoggingIn,
         CheckingFeatures,
         Statting,
         Transferring,
         Disconnecting
     };

Constructors and Destructors

◆ QNetworkAccessFtpBackend()

QNetworkAccessFtpBackend::QNetworkAccessFtpBackend ( )

Definition at line 102 of file qnetworkaccessftpbackend.cpp.

     : ftp(0), uploadDevice(0), totalBytes(0), helpId(-1), sizeId(-1), mdtmId(-1),
     supportsSize(false), supportsMdtm(false), state(Idle)
 {
 }

◆ ~QNetworkAccessFtpBackend()

QNetworkAccessFtpBackend::~QNetworkAccessFtpBackend ( )

virtual

Definition at line 108 of file qnetworkaccessftpbackend.cpp.

 {
     //if backend destroyed while in use, then abort (this is the code path from QNetworkReply::abort)
     if (ftp && state != Disconnecting)
         ftp->abort();
     disconnectFromFtp();
 }

Functions

◆ closeDownstreamChannel()

void QNetworkAccessFtpBackend::closeDownstreamChannel ( )

virtual

Implements QNetworkAccessBackend.

Definition at line 181 of file qnetworkaccessftpbackend.cpp.

 {
     state = Disconnecting;
     if (operation() == QNetworkAccessManager::GetOperation)
         ftp->abort();
 }

◆ disconnectFromFtp()

void QNetworkAccessFtpBackend::disconnectFromFtp ( )

Definition at line 208 of file qnetworkaccessftpbackend.cpp.

Referenced by ftpDone(), and ~QNetworkAccessFtpBackend().

 {
     state = Disconnecting;
 
     if (ftp) {
         disconnect(ftp, 0, this, 0);
 
         QByteArray key = makeCacheKey(url());
         QNetworkAccessManagerPrivate::getObjectCache(this)->releaseEntry(key);
 
         ftp = 0;
     }
 }

◆ downstreamReadyWrite()

void QNetworkAccessFtpBackend::downstreamReadyWrite ( )

virtual

Reimplemented from QNetworkAccessBackend.

Definition at line 188 of file qnetworkaccessftpbackend.cpp.

 {
     if (state == Transferring && ftp && ftp->bytesAvailable())
         ftpReadyRead();
 }

◆ ftpConnectionReady

void QNetworkAccessFtpBackend::ftpConnectionReady ( QNetworkAccessCache::CacheableObject * object )

slot

Definition at line 194 of file qnetworkaccessftpbackend.cpp.

Referenced by open().

 {
     ftp = static_cast<QNetworkAccessCachedFtpConnection *>(o);
     connect(ftp, SIGNAL(done(bool)), SLOT(ftpDone()));
     connect(ftp, SIGNAL(rawCommandReply(int,QString)), SLOT(ftpRawCommandReply(int,QString)));
     connect(ftp, SIGNAL(readyRead()), SLOT(ftpReadyRead()));
 
     // is the login process done already?
     if (ftp->state() == QFtp::LoggedIn)
         ftpDone();
 
     // no, defer the actual operation until after we've logged in
 }

◆ ftpDone

void QNetworkAccessFtpBackend::ftpDone ( )

slot

Definition at line 222 of file qnetworkaccessftpbackend.cpp.

Referenced by ftpConnectionReady().

 {
     // the last command we sent is done
     if (state == LoggingIn && ftp->state() != QFtp::LoggedIn) {
         if (ftp->state() == QFtp::Connected) {
             // the login did not succeed
             QUrl newUrl = url();
             newUrl.setUserInfo(QString());
             setUrl(newUrl);
 
             QAuthenticator auth;
             authenticationRequired(&auth);
 
             if (!auth.isNull()) {
                 // try again:
                 newUrl.setUserName(auth.user());
                 ftp->login(auth.user(), auth.password());
                 return;
             }
 
             error(QNetworkReply::AuthenticationRequiredError,
                   tr("Logging in to %1 failed: authentication required")
                   .arg(url().host()));
         } else {
             // we did not connect
             QNetworkReply::NetworkError code;
             switch (ftp->error()) {
             case QFtp::HostNotFound:
                 code = QNetworkReply::HostNotFoundError;
                 break;
 
             case QFtp::ConnectionRefused:
                 code = QNetworkReply::ConnectionRefusedError;
                 break;
 
             default:
                 code = QNetworkReply::ProtocolFailure;
                 break;
             }
 
             error(code, ftp->errorString());
         }
 
         // we're not connected, so remove the cache entry:
         QByteArray key = makeCacheKey(url());
         QNetworkAccessManagerPrivate::getObjectCache(this)->removeEntry(key);
 
         disconnect(ftp, 0, this, 0);
         ftp->dispose();
         ftp = 0;
 
         state = Disconnecting;
         finished();
         return;
     }
 
     // check for errors:
     if (ftp->error() != QFtp::NoError) {
         QString msg;
         if (operation() == QNetworkAccessManager::GetOperation)
             msg = tr("Error while downloading %1: %2");
         else
             msg = tr("Error while uploading %1: %2");
         msg = msg.arg(url().toString(), ftp->errorString());
 
         if (state == Statting)
             // file probably doesn't exist
             error(QNetworkReply::ContentNotFoundError,  msg);
         else
             error(QNetworkReply::ContentAccessDenied, msg);
 
         disconnectFromFtp();
         finished();
     }
 
     if (state == LoggingIn) {
         state = CheckingFeatures;
         if (operation() == QNetworkAccessManager::GetOperation) {
             // send help command to find out if server supports "SIZE" and "MDTM"
             QString command = url().path();
             command.prepend(QLatin1String("%1 "));
             helpId = ftp->rawCommand(QLatin1String("HELP")); // get supported commands
         } else {
             ftpDone();
         }
     } else if (state == CheckingFeatures) {
         state = Statting;
         if (operation() == QNetworkAccessManager::GetOperation) {
             // logged in successfully, send the stat requests (if supported)
             QString command = url().path();
             command.prepend(QLatin1String("%1 "));
             if (supportsSize) {
                 ftp->rawCommand(QLatin1String("TYPE I"));
                 sizeId = ftp->rawCommand(command.arg(QLatin1String("SIZE"))); // get size
             }
             if (supportsMdtm)
                 mdtmId = ftp->rawCommand(command.arg(QLatin1String("MDTM"))); // get modified time
             if (!supportsSize && !supportsMdtm)
                 ftpDone();      // no commands sent, move to the next state
         } else {
             ftpDone();
         }
     } else if (state == Statting) {
         // statted successfully, send the actual request
         emit metaDataChanged();
         state = Transferring;
 
         QFtp::TransferType type = QFtp::Binary;
         if (operation() == QNetworkAccessManager::GetOperation) {
             setCachingEnabled(true);
             ftp->get(url().path(), 0, type);
         } else {
             ftp->put(uploadDevice, url().path(), type);
         }
 
     } else if (state == Transferring) {
         // upload or download finished
         disconnectFromFtp();
         finished();
     }
 }

◆ ftpRawCommandReply

void QNetworkAccessFtpBackend::ftpRawCommandReply	(	int	code,
		const QString &	text
	)

slot

Definition at line 353 of file qnetworkaccessftpbackend.cpp.

Referenced by ftpConnectionReady().

 {
     //qDebug() << "FTP reply:" << code << text;
     int id = ftp->currentId();
 
     if ((id == helpId) && ((code == 200) || (code == 214))) {     // supported commands
         // the "FEAT" ftp command would be nice here, but it is not part of the
         // initial FTP RFC 959, neither ar "SIZE" nor "MDTM" (they are all specified
         // in RFC 3659)
         if (text.contains(QLatin1String("SIZE"), Qt::CaseSensitive))
             supportsSize = true;
         if (text.contains(QLatin1String("MDTM"), Qt::CaseSensitive))
             supportsMdtm = true;
     } else if (code == 213) {          // file status
         if (id == sizeId) {
             // reply to the size command
             setHeader(QNetworkRequest::ContentLengthHeader, text.toLongLong());
 #ifndef QT_NO_DATESTRING
         } else if (id == mdtmId) {
             QDateTime dt = QDateTime::fromString(text, QLatin1String("yyyyMMddHHmmss"));
             setHeader(QNetworkRequest::LastModifiedHeader, dt);
 #endif
         }
     }
 }

◆ ftpReadyRead

void QNetworkAccessFtpBackend::ftpReadyRead ( )

slot

Definition at line 344 of file qnetworkaccessftpbackend.cpp.

Referenced by downstreamReadyWrite(), and ftpConnectionReady().

 {
     QByteArray data = ftp->readAll();
     QByteDataBuffer list;
     list.append(data);
     data.clear(); // important because of implicit sharing!
     writeDownstreamData(list);
 }

◆ open()

void QNetworkAccessFtpBackend::open ( )

virtual

Implements QNetworkAccessBackend.

Definition at line 116 of file qnetworkaccessftpbackend.cpp.

 {
 #ifndef QT_NO_NETWORKPROXY
     QNetworkProxy proxy;
     foreach (const QNetworkProxy &p, proxyList()) {
         // use the first FTP proxy
         // or no proxy at all
         if (p.type() == QNetworkProxy::FtpCachingProxy
             || p.type() == QNetworkProxy::NoProxy) {
             proxy = p;
             break;
         }
     }
 
     // did we find an FTP proxy or a NoProxy?
     if (proxy.type() == QNetworkProxy::DefaultProxy) {
         // unsuitable proxies
         error(QNetworkReply::ProxyNotFoundError,
               tr("No suitable proxy found"));
         finished();
         return;
     }
 
 #endif
 
     QUrl url = this->url();
     if (url.path().isEmpty()) {
         url.setPath(QLatin1String("/"));
         setUrl(url);
     }
     if (url.path().endsWith(QLatin1Char('/'))) {
         error(QNetworkReply::ContentOperationNotPermittedError,
               tr("Cannot open %1: is a directory").arg(url.toString()));
         finished();
         return;
     }
     state = LoggingIn;
 
     QNetworkAccessCache* objectCache = QNetworkAccessManagerPrivate::getObjectCache(this);
     QByteArray cacheKey = makeCacheKey(url);
     if (!objectCache->requestEntry(cacheKey, this,
                              SLOT(ftpConnectionReady(QNetworkAccessCache::CacheableObject*)))) {
         ftp = new QNetworkAccessCachedFtpConnection;
 #ifndef QT_NO_BEARERMANAGEMENT
         //copy network session down to the QFtp
         ftp->setProperty("_q_networksession", property("_q_networksession"));
 #endif
 #ifndef QT_NO_NETWORKPROXY
         if (proxy.type() == QNetworkProxy::FtpCachingProxy)
             ftp->setProxy(proxy.hostName(), proxy.port());
 #endif
         ftp->connectToHost(url.host(), url.port(DefaultFtpPort));
         ftp->login(url.userName(), url.password());
 
         objectCache->addEntry(cacheKey, ftp);
         ftpConnectionReady(ftp);
     }
 
     // Put operation
     if (operation() == QNetworkAccessManager::PutOperation) {
         uploadDevice = QNonContiguousByteDeviceFactory::wrap(createUploadByteDevice());
         uploadDevice->setParent(this);
     }
 }