HTTPProtocol Class Reference

#include <http.h>

Inheritance diagram for HTTPProtocol:

List of all members.

Classes
struct	CacheTag
struct	DAVRequest
	DAV-specific request elements for the current connection. More...
struct	HTTPRequest
	The request for the current connection. More...
struct	HTTPServerState
	State of the current connection to the server. More...
Public Types
enum	AUTH_SCHEME {   AUTH_None, AUTH_Basic, AUTH_NTLM, AUTH_Digest,   AUTH_Negotiate }
enum	CacheIOMode { NoCache = 0, ReadFromCache = 1, WriteToCache = 2 }
enum	HTTP_REV {   HTTP_None, HTTP_Unknown, HTTP_10, HTTP_11,   SHOUTCAST }
Public Member Functions
	HTTPProtocol (const QByteArray &protocol, const QByteArray &pool, const QByteArray &app)
virtual	~HTTPProtocol ()
virtual void	closeConnection ()
virtual void	copy (const KUrl &src, const KUrl &dest, int _permissions, KIO::JobFlags flags)
QString	davError (int code=-1, const QString &url=QString())
void	davFinished ()
void	davGeneric (const KUrl &url, KIO::HTTP_METHOD method)
bool	davHostOk ()
void	davLock (const KUrl &url, const QString &scope, const QString &type, const QString &owner)
void	davUnlock (const KUrl &url)
virtual void	del (const KUrl &url, bool _isfile)
virtual void	get (const KUrl &url)
void	httpPutError ()
bool	isOffline ()
virtual void	listDir (const KUrl &url)
bool	maybeSetRequestUrl (const KUrl &)
virtual void	mimetype (const KUrl &url)
virtual void	mkdir (const KUrl &url, int _permissions)
void	multiGet (const QByteArray &data)
void	post (const KUrl &url)
virtual void	put (const KUrl &url, int _mode, KIO::JobFlags flags)
virtual void	rename (const KUrl &src, const KUrl &dest, KIO::JobFlags flags)
virtual void	reparseConfiguration ()
bool	sendErrorPageNotification ()
virtual void	setHost (const QString &host, quint16 port, const QString &user, const QString &pass)
virtual void	slave_status ()
virtual void	special (const QByteArray &data)
virtual void	stat (const KUrl &url)
Protected Slots
void	error (int errid, const QString &text)
void	proxyAuthenticationForSocket (const QNetworkProxy &, QAuthenticator *)
void	saveProxyAuthenticationForSocket ()
void	slotData (const QByteArray &)
void	slotFilterError (const QString &text)
Protected Member Functions
void	addCookies (const QString &url, const QByteArray &cookieHeader)
void	addEncoding (const QString &, QStringList &)
QString	authenticationHeader ()
void	cacheFileClose ()
bool	cacheFileOpenRead ()
bool	cacheFileOpenWrite ()
QString	cacheFilePathFromUrl (const KUrl &url) const
QByteArray	cacheFileReadPayload (int maxLength)
bool	cacheFileReadTextHeader1 (const KUrl &desiredUrl)
bool	cacheFileReadTextHeader2 ()
void	cacheFileWritePayload (const QByteArray &d)
void	cacheFileWriteTextHeader ()
void	cacheParseResponseHeader (const HeaderTokenizer &tokenizer)
void	clearUnreadBuffer ()
int	codeFromResponse (const QString &response)
void	davParseActiveLocks (const QDomNodeList &activeLocks, uint &lockCount)
void	davParsePropstats (const QDomNodeList &propstats, KIO::UDSEntry &entry)
QString	davProcessLocks ()
void	davSetRequest (const QByteArray &requestXML)
void	davStatList (const KUrl &url, bool stat=true)
quint16	defaultPort () const
QString	findCookies (const QString &url)
void	fixupResponseContentEncoding ()
void	fixupResponseMimetype ()
QString	formatRequestUri () const
void	forwardHttpResponseHeader (bool forwardImmediately=true)
void	httpClose (bool keepAlive)
void	httpCloseConnection ()
bool	httpOpenConnection ()
bool	httpShouldCloseConnection ()
void	parseContentDisposition (const QString &disposition)
long	parseDateTime (const QString &input, const QString &type)
bool	parseHeaderFromCache ()
void	proceedUntilResponseContent (bool dataInternal=false)
bool	proceedUntilResponseHeader ()
bool	readBody (bool dataInternal=false)
size_t	readBuffered (char *buf, size_t size, bool unlimited=true)
int	readChunked ()
bool	readDelimitedText (char *buf, int *idx, int end, int numNewlines)
int	readLimited ()
bool	readResponseHeader ()
int	readUnlimited ()
void	resetConnectionSettings ()
void	resetResponseParsing ()
void	resetSessionSettings ()
bool	satisfyRequestFromCache (bool *cacheHasPage)
bool	sendBody ()
void	sendCacheCleanerCommand (const QByteArray &command)
bool	sendQuery ()
void	setCacheabilityMetadata (bool cachingAllowed)
void	unread (char *buf, size_t size)
ssize_t	write (const void *buf, size_t nbytes)
Protected Attributes
QLocalSocket	m_cacheCleanerConnection
QStringList	m_contentEncodings
QString	m_contentMD5
bool	m_cpMimeBuffer
bool	m_dataInternal
QStringList	m_davCapabilities
bool	m_davHostOk
bool	m_davHostUnsupported
KIO::filesize_t	m_iBytesLeft
KIO::filesize_t	m_iContentLeft
bool	m_isBusy
bool	m_isChunked
bool	m_isEOD
bool	m_isEOF
bool	m_isError
KIO::filesize_t	m_iSize
bool	m_isLoadingErrorPage
bool	m_isRedirection
int	m_maxCacheAge
long	m_maxCacheSize
QString	m_mimeType
QByteArray	m_mimeTypeBuffer
QByteArray	m_POSTbuf
QByteArray	m_protocol
KAbstractHttpAuthentication *	m_proxyAuth
QByteArray	m_receiveBuf
int	m_remoteRespTimeout
HTTPRequest	m_request
QList< HTTPRequest >	m_requestQueue
QStringList	m_responseHeaders
HTTPServerState	m_server
QAuthenticator *	m_socketProxyAuth
QString	m_strCacheDir
QStringList	m_transferEncodings
QByteArray	m_unreadBuf
QByteArray	m_webDavDataBuf
KAbstractHttpAuthentication *	m_wwwAuth

---

Detailed Description

Definition at line 56 of file http.h.

---

Member Enumeration Documentation

enum HTTPProtocol::AUTH_SCHEME

Authorization method used.

Enumerator:

AUTH_None
AUTH_Basic
AUTH_NTLM
AUTH_Digest
AUTH_Negotiate

Definition at line 68 of file http.h.

enum HTTPProtocol::CacheIOMode

Enumerator:

NoCache
ReadFromCache
WriteToCache

Definition at line 84 of file http.h.

enum HTTPProtocol::HTTP_REV

HTTP version.

Enumerator:

HTTP_None
HTTP_Unknown
HTTP_10
HTTP_11
SHOUTCAST

Definition at line 65 of file http.h.

---

Constructor & Destructor Documentation

HTTPProtocol::HTTPProtocol	(	const QByteArray &	protocol,
		const QByteArray &	pool,
		const QByteArray &	app
	)

Definition at line 331 of file http.cpp.

HTTPProtocol::~HTTPProtocol

(

)

[virtual]

Definition at line 352 of file http.cpp.

---

Member Function Documentation

void HTTPProtocol::addCookies	(	const QString &	url,
		const QByteArray &	cookieHeader
	)		[protected]

Send a cookie to the cookiejar.

Definition at line 4478 of file http.cpp.

void HTTPProtocol::addEncoding	(	const QString &	_encoding,
		QStringList &	encs
	)		[protected]

Add an encoding on to the appropriate stack this is nececesary because transfer encodings and content encodings must be handled separately.

Definition at line 3564 of file http.cpp.

QString HTTPProtocol::authenticationHeader

(

)

[protected]

Definition at line 4977 of file http.cpp.

void HTTPProtocol::cacheFileClose

(

)

[protected]

Definition at line 4843 of file http.cpp.

bool HTTPProtocol::cacheFileOpenRead

(

)

[protected]

Definition at line 4752 of file http.cpp.

bool HTTPProtocol::cacheFileOpenWrite

(

)

[protected]

Definition at line 4786 of file http.cpp.

QString HTTPProtocol::cacheFilePathFromUrl

(

const KUrl &

url

)

const [protected]

Definition at line 4742 of file http.cpp.

QByteArray HTTPProtocol::cacheFileReadPayload

(

int

maxLength

)

[protected]

Definition at line 4926 of file http.cpp.

bool HTTPProtocol::cacheFileReadTextHeader1

(

const KUrl &

desiredUrl

)

[protected]

Definition at line 4684 of file http.cpp.

bool HTTPProtocol::cacheFileReadTextHeader2

(

)

[protected]

Definition at line 4703 of file http.cpp.

void HTTPProtocol::cacheFileWritePayload

(

const QByteArray &

d

)

[protected]

Definition at line 4939 of file http.cpp.

void HTTPProtocol::cacheFileWriteTextHeader

(

)

[protected]

Definition at line 4656 of file http.cpp.

void HTTPProtocol::cacheParseResponseHeader

(

const HeaderTokenizer &

tokenizer

)

[protected]

Definition at line 3590 of file http.cpp.

void HTTPProtocol::clearUnreadBuffer

(

)

[protected]

Definition at line 1968 of file http.cpp.

void HTTPProtocol::closeConnection

(

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 3893 of file http.cpp.

int HTTPProtocol::codeFromResponse

(

const QString &

response

)

[protected]

Returns the error code from a "HTTP/1.1 code Code Name" string.

Definition at line 881 of file http.cpp.

void HTTPProtocol::copy	(	const KUrl &	src,
		const KUrl &	dest,
		int	_permissions,
		KIO::JobFlags	flags
	)		[virtual]

Definition at line 88 of file file_unix.cpp.

QString HTTPProtocol::davError	(	int	code = -1,
		const QString &	url = QString()
	)

Definition at line 1560 of file http.cpp.

void HTTPProtocol::davFinished

(

)

Definition at line 1235 of file http.cpp.

void HTTPProtocol::davGeneric	(	const KUrl &	url,
		KIO::HTTP_METHOD	method
	)

Definition at line 861 of file http.cpp.

bool HTTPProtocol::davHostOk

(

)

Definition at line 1181 of file http.cpp.

void HTTPProtocol::davLock	(	const KUrl &	url,
		const QString &	scope,
		const QString &	type,
		const QString &	owner
	)

Definition at line 1476 of file http.cpp.

void HTTPProtocol::davParseActiveLocks	(	const QDomNodeList &	activeLocks,
		uint &	lockCount
	)		[protected]

Definition at line 1067 of file http.cpp.

void HTTPProtocol::davParsePropstats	(	const QDomNodeList &	propstats,
		KIO::UDSEntry &	entry
	)		[protected]

Definition at line 888 of file http.cpp.

QString HTTPProtocol::davProcessLocks

(

)

[protected]

Extracts locks from metadata Returns the appropriate If: header.

Definition at line 1132 of file http.cpp.

void HTTPProtocol::davSetRequest

(

const QByteArray &

requestXML

)

[protected]

Performs a WebDAV stat or list.

Definition at line 717 of file http.cpp.

void HTTPProtocol::davStatList	(	const KUrl &	url,
		bool	stat = true
	)		[protected]

Definition at line 723 of file http.cpp.

void HTTPProtocol::davUnlock

(

const KUrl &

url

)

Definition at line 1540 of file http.cpp.

quint16 HTTPProtocol::defaultPort

(

)

const [protected]

Definition at line 375 of file http.cpp.

void HTTPProtocol::del	(	const KUrl &	url,
		bool	_isfile
	)		[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 1418 of file http.cpp.

void HTTPProtocol::error	(	int	errid,
		const QString &	text
	)		[protected, slot]

Reimplemented from KIO::SlaveBase.

Definition at line 4460 of file http.cpp.

QString HTTPProtocol::findCookies

(

const QString &

url

)

[protected]

Look for cookies in the cookiejar.

Definition at line 4486 of file http.cpp.

void HTTPProtocol::fixupResponseContentEncoding

(

)

[protected]

Definition at line 2651 of file http.cpp.

void HTTPProtocol::fixupResponseMimetype

(

)

[protected]

Definition at line 2602 of file http.cpp.

QString HTTPProtocol::formatRequestUri

(

)

const [protected]

Definition at line 2174 of file http.cpp.

void HTTPProtocol::forwardHttpResponseHeader

(

bool

forwardImmediately = true

)

[protected]

Definition at line 2551 of file http.cpp.

void HTTPProtocol::get

(

const KUrl &

url

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 1262 of file http.cpp.

void HTTPProtocol::httpClose

(

bool

keepAlive

)

[protected]

Definition at line 3865 of file http.cpp.

void HTTPProtocol::httpCloseConnection

(

)

[protected]

Definition at line 3899 of file http.cpp.

bool HTTPProtocol::httpOpenConnection

(

)

[protected]

Definition at line 2098 of file http.cpp.

void HTTPProtocol::httpPutError

(

)

Definition at line 1768 of file http.cpp.

bool HTTPProtocol::httpShouldCloseConnection

(

)

[protected]

Definition at line 2077 of file http.cpp.

bool HTTPProtocol::isOffline

(

)

Definition at line 1845 of file http.cpp.

void HTTPProtocol::listDir

(

const KUrl &

url

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 706 of file http.cpp.

bool HTTPProtocol::maybeSetRequestUrl

(

const KUrl &

u

)

Definition at line 574 of file http.cpp.

void HTTPProtocol::mimetype

(

const KUrl &

url

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 3919 of file http.cpp.

void HTTPProtocol::mkdir	(	const KUrl &	url,
		int	_permissions
	)		[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 1242 of file http.cpp.

void HTTPProtocol::multiGet

(

const QByteArray &

data

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 1859 of file http.cpp.

void HTTPProtocol::parseContentDisposition

(

const QString &

disposition

)

[protected]

Definition at line 3552 of file http.cpp.

long HTTPProtocol::parseDateTime	(	const QString &	input,
		const QString &	type
	)		[protected]

Parses a date & time string.

Definition at line 1113 of file http.cpp.

bool HTTPProtocol::parseHeaderFromCache

(

)

[protected]

Definition at line 2563 of file http.cpp.

void HTTPProtocol::post

(

const KUrl &

url

)

Definition at line 1462 of file http.cpp.

void HTTPProtocol::proceedUntilResponseContent

(

bool

dataInternal = false

)

[protected]

Do everything proceedUntilResponseHeader does, and also get the response body.

This is being used as a replacement for proceedUntilResponseHeader() in situations where we actually expect the response to have a body / payload data.

Definition at line 597 of file http.cpp.

bool HTTPProtocol::proceedUntilResponseHeader

(

)

[protected]

Ensure we are connected, send our query, and get the response header.

Definition at line 618 of file http.cpp.

void HTTPProtocol::proxyAuthenticationForSocket	(	const QNetworkProxy &	proxy,
		QAuthenticator *	authenticator
	)		[protected, slot]

Definition at line 5042 of file http.cpp.

void HTTPProtocol::put	(	const KUrl &	url,
		int	_mode,
		KIO::JobFlags	flags
	)		[virtual]

Definition at line 1282 of file http.cpp.

bool HTTPProtocol::readBody

(

bool

dataInternal = false

)

[protected]

This function is our "receive" function.

It is responsible for downloading the message (not the header) from the HTTP server. It is called either as a response to a client's KIOJob::dataEnd() (meaning that the client is done sending data) or by 'sendQuery()' (if we are in the process of a PUT/POST request). It can also be called by a webDAV function, to receive stat/list/property/etc. data; in this case the data is stored in m_webDavDataBuf.

Definition at line 4217 of file http.cpp.

size_t HTTPProtocol::readBuffered	(	char *	buf,
		size_t	size,
		bool	unlimited = true
	)		[protected]

Definition at line 1989 of file http.cpp.

int HTTPProtocol::readChunked

(

)

[protected]

Read a chunk from the data stream.

Definition at line 4019 of file http.cpp.

bool HTTPProtocol::readDelimitedText	(	char *	buf,
		int *	idx,
		int	end,
		int	numNewlines
	)		[protected]

Definition at line 2023 of file http.cpp.

int HTTPProtocol::readLimited

(

)

[protected]

Definition at line 4090 of file http.cpp.

bool HTTPProtocol::readResponseHeader

(

)

[protected]

This function will read in the return header from the server.

It will not read in the body of the return message. It will also not transmit the header to our client as the client doesn't need to know the gory details of HTTP headers.

Definition at line 2702 of file http.cpp.

int HTTPProtocol::readUnlimited

(

)

[protected]

Definition at line 4112 of file http.cpp.

void HTTPProtocol::rename	(	const KUrl &	src,
		const KUrl &	dest,
		KIO::JobFlags	flags
	)		[virtual]

Definition at line 1372 of file http.cpp.

void HTTPProtocol::reparseConfiguration

(

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 357 of file http.cpp.

void HTTPProtocol::resetConnectionSettings

(

)

[protected]

Resets any per connection settings.

These are different from per-session settings in that they must be invalidated every time a request is made, e.g. a retry to re-send the header to the server, as compared to only when a new request arrives.

Definition at line 368 of file http.cpp.

void HTTPProtocol::resetResponseParsing

(

)

[protected]

Resets variables related to parsing a response.

Definition at line 380 of file http.cpp.

void HTTPProtocol::resetSessionSettings

(

)

[protected]

Resets any per session settings.

Definition at line 396 of file http.cpp.

bool HTTPProtocol::satisfyRequestFromCache

(

bool *

cacheHasPage

)

[protected]

Definition at line 2133 of file http.cpp.

void HTTPProtocol::saveProxyAuthenticationForSocket

(

)

[protected, slot]

Definition at line 5090 of file http.cpp.

bool HTTPProtocol::sendBody

(

)

[protected]

Definition at line 3796 of file http.cpp.

void HTTPProtocol::sendCacheCleanerCommand

(

const QByteArray &

command

)

[protected]

Definition at line 4902 of file http.cpp.

bool HTTPProtocol::sendErrorPageNotification

(

)

Definition at line 1832 of file http.cpp.

bool HTTPProtocol::sendQuery

(

)

[protected]

This function is responsible for opening up the connection to the remote HTTP server and sending the header.

If this requires special authentication or other such fun stuff, then it will handle it. This function will NOT receive anything from the server, however. This is in contrast to previous incarnations of 'httpOpen' as this method used to be called.

The basic process now is this:

1) Open up the socket and port 2) Format our request/header 3) Send the header to the remote server 4) Call sendBody() if the HTTP method requires sending body data

Definition at line 2215 of file http.cpp.

void HTTPProtocol::setCacheabilityMetadata

(

bool

cachingAllowed

)

[protected]

Definition at line 3781 of file http.cpp.

void HTTPProtocol::setHost	(	const QString &	host,
		quint16	port,
		const QString &	user,
		const QString &	pass
	)		[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 544 of file http.cpp.

void HTTPProtocol::slave_status

(

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 3909 of file http.cpp.

void HTTPProtocol::slotData

(

const QByteArray &

_d

)

[protected, slot]

Definition at line 4131 of file http.cpp.

void HTTPProtocol::slotFilterError

(

const QString &

text

)

[protected, slot]

Definition at line 4455 of file http.cpp.

void HTTPProtocol::special

(

const QByteArray &

data

)

[virtual]

Special commands supported by this slave : 1 - HTTP POST 2 - Cache has been updated 3 - SSL Certificate Cache has been updated 4 - HTTP multi get 5 - DAV LOCK (see 6 - DAV UNLOCK README.webdav)

Reimplemented from KIO::SlaveBase.

Definition at line 3937 of file http.cpp.

void HTTPProtocol::stat

(

const KUrl &

url

)

[virtual]

Reimplemented from KIO::SlaveBase.

Definition at line 674 of file http.cpp.

void HTTPProtocol::unread	(	char *	buf,
		size_t	size
	)		[protected]

Definition at line 1975 of file http.cpp.

ssize_t HTTPProtocol::write	(	const void *	buf,
		size_t	nbytes
	)		[protected]

A thin wrapper around TCPSlaveBase::write() that will retry writing as long as no error occurs.

Definition at line 1949 of file http.cpp.

---

Member Data Documentation

QLocalSocket HTTPProtocol::m_cacheCleanerConnection [protected]

Definition at line 486 of file http.h.

QStringList HTTPProtocol::m_contentEncodings [protected]

Definition at line 458 of file http.h.

QString HTTPProtocol::m_contentMD5 [protected]

Definition at line 459 of file http.h.

bool HTTPProtocol::m_cpMimeBuffer [protected]

Definition at line 473 of file http.h.

bool HTTPProtocol::m_dataInternal [protected]

Definition at line 444 of file http.h.

QStringList HTTPProtocol::m_davCapabilities [protected]

Definition at line 466 of file http.h.

bool HTTPProtocol::m_davHostOk [protected]

Definition at line 468 of file http.h.

bool HTTPProtocol::m_davHostUnsupported [protected]

Definition at line 469 of file http.h.

KIO::filesize_t HTTPProtocol::m_iBytesLeft [protected]

Definition at line 441 of file http.h.

KIO::filesize_t HTTPProtocol::m_iContentLeft [protected]

Definition at line 442 of file http.h.

bool HTTPProtocol::m_isBusy [protected]

Definition at line 447 of file http.h.

bool HTTPProtocol::m_isChunked [protected]

Definition at line 445 of file http.h.

bool HTTPProtocol::m_isEOD [protected]

Definition at line 449 of file http.h.

bool HTTPProtocol::m_isEOF [protected]

Definition at line 448 of file http.h.

bool HTTPProtocol::m_isError [protected]

Definition at line 497 of file http.h.

KIO::filesize_t HTTPProtocol::m_iSize [protected]

Definition at line 440 of file http.h.

bool HTTPProtocol::m_isLoadingErrorPage [protected]

Definition at line 499 of file http.h.

bool HTTPProtocol::m_isRedirection [protected]

Definition at line 452 of file http.h.

int HTTPProtocol::m_maxCacheAge [protected]

Definition at line 483 of file http.h.

long HTTPProtocol::m_maxCacheSize [protected]

Definition at line 484 of file http.h.

QString HTTPProtocol::m_mimeType [protected]

Definition at line 460 of file http.h.

QByteArray HTTPProtocol::m_mimeTypeBuffer [protected]

Definition at line 474 of file http.h.

QByteArray HTTPProtocol::m_POSTbuf [protected]

Definition at line 480 of file http.h.

QByteArray HTTPProtocol::m_protocol [protected]

Definition at line 489 of file http.h.

KAbstractHttpAuthentication* HTTPProtocol::m_proxyAuth [protected]

Definition at line 492 of file http.h.

QByteArray HTTPProtocol::m_receiveBuf [protected]

Definition at line 443 of file http.h.

int HTTPProtocol::m_remoteRespTimeout [protected]

Definition at line 502 of file http.h.

HTTPRequest HTTPProtocol::m_request [protected]

Definition at line 436 of file http.h.

QList<HTTPRequest> HTTPProtocol::m_requestQueue [protected]

Definition at line 437 of file http.h.

QStringList HTTPProtocol::m_responseHeaders [protected]

Definition at line 453 of file http.h.

HTTPServerState HTTPProtocol::m_server [protected]

Definition at line 435 of file http.h.

QAuthenticator* HTTPProtocol::m_socketProxyAuth [protected]

Definition at line 494 of file http.h.

QString HTTPProtocol::m_strCacheDir [protected]

Definition at line 485 of file http.h.

QStringList HTTPProtocol::m_transferEncodings [protected]

Definition at line 457 of file http.h.

QByteArray HTTPProtocol::m_unreadBuf [protected]

Definition at line 504 of file http.h.

QByteArray HTTPProtocol::m_webDavDataBuf [protected]

Definition at line 465 of file http.h.

KAbstractHttpAuthentication* HTTPProtocol::m_wwwAuth [protected]

Definition at line 491 of file http.h.

---

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

• http.h
• file_unix.cpp
• file_win.cpp
• http.cpp