#include <slavebase.h>

Inheritance diagram for KIO::SlaveBase:

Public Types
enum	MessageBoxType { QuestionYesNo = 1, WarningYesNo = 2, WarningContinueCancel = 3, WarningYesNoCancel = 4, Information = 5, SSLMessageBox = 6 }

Public Member Functions
	SlaveBase (const QByteArray &protocol, const QByteArray &pool_socket, const QByteArray &app_socket)

virtual	~SlaveBase ()

MetaData	allMetaData () const

bool	cacheAuthentication (const AuthInfo &info)

bool	canResume (KIO::filesize_t offset)

void	canResume ()

bool	checkCachedAuthentication (AuthInfo &info)

virtual void	chmod (const KUrl &url, int permissions)

virtual void	chown (const KUrl &url, const QString &owner, const QString &group)

virtual void	close ()

virtual void	closeConnection ()

KConfigGroup *	config ()

void	connected ()

void	connectSlave (const QString &path)

int	connectTimeout ()

virtual void	copy (const KUrl &src, const KUrl &dest, int permissions, JobFlags flags)

void	data (const QByteArray &data)

void	dataReq ()

virtual void	del (const KUrl &url, bool isfile)

void	disconnectSlave ()

virtual void	dispatch (int command, const QByteArray &data)

void	dispatchLoop ()

virtual void	dispatchOpenCommand (int command, const QByteArray &data)

void	dropNetwork (const QString &host=QString())

void	error (int _errid, const QString &_text)

void	errorPage ()

void	exit ()

void	finished ()

virtual void	get (const KUrl &url)

bool	hasMetaData (const QString &key) const

void	infoMessage (const QString &msg)

virtual void	listDir (const KUrl &url)

void	listEntries (const UDSEntryList &_entry)

void	listEntry (const UDSEntry &_entry, bool ready)

void	lookupHost (const QString &host)

int	messageBox (MessageBoxType type, const QString &text, const QString &caption=QString(), const QString &buttonYes=i18n("&Yes"), const QString &buttonNo=i18n("&No"))

int	messageBox (const QString &text, MessageBoxType type, const QString &caption=QString(), const QString &buttonYes=i18n("&Yes"), const QString &buttonNo=i18n("&No"), const QString &dontAskAgainName=QString())

QString	metaData (const QString &key) const

void	mimeType (const QString &_type)

virtual void	mimetype (const KUrl &url)

virtual void	mkdir (const KUrl &url, int permissions)

virtual void	multiGet (const QByteArray &data)

void	needSubUrlData ()

virtual void	open (const KUrl &url, QIODevice::OpenMode mode)

virtual void	openConnection ()

void	opened ()

bool	openPasswordDialog (KIO::AuthInfo &info, const QString &errorMsg=QString())

void	position (KIO::filesize_t _pos)

void	processedPercent (float percent)

void	processedSize (KIO::filesize_t _bytes)

int	proxyConnectTimeout ()

virtual void	put (const KUrl &url, int permissions, JobFlags flags)

virtual void	read (KIO::filesize_t size)

int	readData (QByteArray &buffer)

int	readTimeout ()

void	redirection (const KUrl &_url)

KRemoteEncoding *	remoteEncoding ()

virtual void	rename (const KUrl &src, const KUrl &dest, JobFlags flags)

virtual void	reparseConfiguration ()

bool	requestNetwork (const QString &host=QString())

int	responseTimeout ()

virtual void	seek (KIO::filesize_t offset)

void	sendAndKeepMetaData ()

void	sendMetaData ()

virtual void	setHost (const QString &host, quint16 port, const QString &user, const QString &pass)

void	setKillFlag ()

virtual void	setLinkDest (const KUrl &url, const QString &target)

void	setMetaData (const QString &key, const QString &value)

virtual void	setModificationTime (const KUrl &url, const QDateTime &mtime)

virtual void	setSubUrl (const KUrl &url)

void	setTimeoutSpecialCommand (int timeout, const QByteArray &data=QByteArray())

virtual void	slave_status ()

void	slaveStatus (const QString &host, bool connected)

virtual void	special (const QByteArray &data)

void	speed (unsigned long _bytes_per_second)

virtual void	stat (const KUrl &url)

void	statEntry (const UDSEntry &_entry)

virtual void	symlink (const QString &target, const KUrl &dest, JobFlags flags)

void	totalSize (KIO::filesize_t _bytes)

int	waitForAnswer (int expected1, int expected2, QByteArray &data, int *pCmd=0)

int	waitForHostInfo (QHostInfo &info)

void	warning (const QString &msg)

bool	wasKilled () const

virtual void	write (const QByteArray &data)

void	written (KIO::filesize_t _bytes)

Protected Types
enum	VirtualFunctionId { AppConnectionMade = 0 }

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Protected Attributes
MetaData	mIncomingMetaData

MetaData	mOutgoingMetaData

QByteArray	mProtocol

Detailed Description

There are two classes that specifies the protocol between application (job) and kioslave.

SlaveInterface is the class to use on the application end, SlaveBase is the one to use on the slave end.

Slave implementations should simply inherit SlaveBase

A call to foo() results in a call to slotFoo() on the other end.

Definition at line 50 of file slavebase.h.

Member Enumeration Documentation

enum KIO::SlaveBase::MessageBoxType

Enumerator
QuestionYesNo
WarningYesNo
WarningContinueCancel
WarningYesNoCancel
Information
SSLMessageBox

Definition at line 248 of file slavebase.h.

enum KIO::SlaveBase::VirtualFunctionId

protected

Enumerator
AppConnectionMade

Definition at line 896 of file slavebase.h.

Constructor & Destructor Documentation

SlaveBase::SlaveBase	(	const QByteArray &	protocol,
		const QByteArray &	pool_socket,
		const QByteArray &	app_socket
	)

Definition at line 179 of file slavebase.cpp.

SlaveBase::~SlaveBase ( )

virtual

Definition at line 253 of file slavebase.cpp.

Member Function Documentation

MetaData SlaveBase::allMetaData ( ) const

for ForwardingSlaveBase Contains all metadata (but no config) sent by the application to the slave.

Definition at line 355 of file slavebase.cpp.

bool SlaveBase::cacheAuthentication ( const AuthInfo & info )

Caches info in a persistent storage like KWallet.

Starting with KDE 4.7, calling openPasswordDialog will no longer store passwords automatically for you. This was done to avoid accidental storage of incorrect or invalid password information.

Here is a simple example of how to use cacheAuthentication:

AuthInfo info;
info.url = KUrl("http://www.foobar.org/foo/bar");
info.username = "somename";
info.verifyPath = true;
if ( !checkCachedAuthentication( info ) ) {
   if ( openPasswordDialog(info) ) {
       if (info.keepPassword)  {  // user asked password be save/remembered
            cacheAuthentication(info);
       }
   }
}

Parameters

info	See AuthInfo.

Returns: true if info was successfully cached.

Definition at line 1215 of file slavebase.cpp.

bool SlaveBase::canResume ( KIO::filesize_t offset )

Call this at the beginning of put(), to give the size of the existing partial file, if there is one.

The offset argument notifies the other job (the one that gets the data) about the offset to use. In this case, the boolean returns whether we can indeed resume or not (we can't if the protocol doing the get() doesn't support setting an offset)

Definition at line 875 of file slavebase.cpp.

void SlaveBase::canResume ( )

Call this at the beginning of get(), if the "resume" metadata was set and resuming is implemented by this protocol.

Definition at line 492 of file slavebase.cpp.

bool SlaveBase::checkCachedAuthentication ( AuthInfo & info )

Checks for cached authentication based on parameters given by info.

Use this function to check if any cached password exists for the URL given by info. If AuthInfo::realmValue and/or AuthInfo::verifyPath flag is specified, then they will also be factored in determining the presence of a cached password. Note that Auth::url is a required parameter when attempting to check for cached authorization info. Here is a simple example:

AuthInfo info;
info.url = KUrl("http://www.foobar.org/foo/bar");
info.username = "somename";
info.verifyPath = true;
if ( !checkCachedAuthentication( info ) )
{
   if ( !openPasswordDialog(info) )
    ....
}

Parameters

info	See AuthInfo.

Returns: true if cached Authorization is found, false otherwise.

Definition at line 1175 of file slavebase.cpp.

void SlaveBase::chmod	(	const KUrl &	url,
		int	permissions
	)

virtual

Change permissions on url The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHMOD.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 794 of file slavebase.cpp.

void SlaveBase::chown	(	const KUrl &	url,
		const QString &	owner,
		const QString &	group
	)

virtual

Change ownership of url The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHOWN.

Definition at line 798 of file slavebase.cpp.

void SlaveBase::close ( )

virtual

Definition at line 778 of file slavebase.cpp.

void SlaveBase::closeConnection ( void )

virtual

Closes the connection (forced) Called when the application disconnects the slave to close any open network connections.

When the slave was operating in connection-oriented mode, it should reset itself to connectionless (default) mode.

Definition at line 758 of file slavebase.cpp.

KConfigGroup * SlaveBase::config ( )

Returns a configuration object to query config/meta-data information from.

The application provides the slave with all configuration information relevant for the current protocol and host.

Definition at line 369 of file slavebase.cpp.

void SlaveBase::connected ( )

Call in openConnection, if you reimplement it, when you're done.

Definition at line 442 of file slavebase.cpp.

void SlaveBase::connectSlave ( const QString & path )

internal function to connect a slave to/ disconnect from either the slave pool or the application

Definition at line 321 of file slavebase.cpp.

int SlaveBase::connectTimeout ( )

Returns: timeout value for connecting to remote host.

Definition at line 1227 of file slavebase.cpp.

void SlaveBase::copy	(	const KUrl &	src,
		const KUrl &	dest,
		int	permissions,
		JobFlags	flags
	)

virtual

Copy src into dest.

By default, copy() is only called when copying a file from yourproto://host/path to yourproto://host/otherpath.

If you set copyFromFile=true then copy() will also be called when moving a file from file:///path to yourproto://host/otherpath. Otherwise such a copy would have to be done the slow way (get+put). See also KProtocolManager::canCopyFromFile().

If you set copyToFile=true then copy() will also be called when moving a file from yourproto: to file:. See also KProtocolManager::canCopyToFile().

If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will ask for get + put instead.

Parameters

src	where to copy the file from (decoded)
dest	where to copy the file to (decoded)
permissions	may be -1. In this case no special permission mode is set.
flags	We support Overwrite here

Don't forget to set the modification time of dest to be the modification time of src.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 786 of file slavebase.cpp.

void SlaveBase::data ( const QByteArray & data )

Sends data in the slave to the job (i.e.

in get).

To signal end of data, simply send an empty QByteArray().

Parameters

data	the data read by the slave

Definition at line 398 of file slavebase.cpp.

void SlaveBase::dataReq ( )

Asks for data from the job.

See also: readData

Definition at line 404 of file slavebase.cpp.

void SlaveBase::del	(	const KUrl &	url,
		bool	isfile
	)

virtual

Delete a file or directory.

Parameters

url	file/directory to delete
isfile	if true, a file should be deleted. if false, a directory should be deleted.

By default, del() on a directory should FAIL if the directory is not empty. However, if metadata("recurse") == "true", then the slave can do a recursive deletion. This behavior is only invoked if the slave specifies deleteRecursive=true in its protocol file.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 788 of file slavebase.cpp.

void SlaveBase::disconnectSlave ( )

Definition at line 336 of file slavebase.cpp.

void SlaveBase::dispatch	(	int	command,
		const QByteArray &	data
	)

virtual

Definition at line 946 of file slavebase.cpp.

void SlaveBase::dispatchLoop ( )

Definition at line 262 of file slavebase.cpp.

void SlaveBase::dispatchOpenCommand	(	int	command,
		const QByteArray &	data
	)

virtual

Definition at line 1183 of file slavebase.cpp.

void SlaveBase::dropNetwork ( const QString & host = QString() )

Used by the slave to withdraw a connection requested by requestNetwork.

This function cancels the last call to requestNetwork. If a client uses more than one internet connection, it must use dropNetwork(host) to stop each request.

If KNetMgr is not running, then this is a no-op.

Parameters

host	the host passed to requestNetwork

A slave should call this function every time it disconnect from a host.

Definition at line 665 of file slavebase.cpp.

void SlaveBase::error	(	int	_errid,
		const QString &	_text
	)

Call to signal an error.

This also finishes the job, so you must not call finished() after calling this.

If the error code is KIO::ERR_SLAVE_DEFINED then the _text should contain the complete translated text of of the error message.

For all other error codes, _text should match the corresponding error code. Usually,, _text is a file or host name, or the error which was passed from the server.
For example, for KIO::ERR_DOES_NOT_EXIST, _text may only be the file or folder which does not exist, nothing else. Otherwise, this would break error strings generated by KIO::buildErrorString().
If you have to add more details than what the standard error codes provide, you'll need to use KIO::ERR_SLAVE_DEFINED. For a complete list of what _text should contain for each error code, look at the source of KIO::buildErrorString().

You can add rich text markup to the message, the places where the error message will be displayed are rich text aware.

See also: KIO::Error; KIO::buildErrorString

Parameters

_errid	the error code from KIO::Error
_text	the rich text error message

Definition at line 419 of file slavebase.cpp.

void SlaveBase::errorPage ( )

Tell that we will only get an error page here.

This means: the data you'll get isn't the data you requested, but an error page (usually HTML) that describes an error.

Definition at line 571 of file slavebase.cpp.

void SlaveBase::exit ( )

Terminate the slave by calling the destructor and then ::exit()

Definition at line 628 of file slavebase.cpp.

void SlaveBase::finished ( )

Call to signal successful completion of any command besides openConnection and closeConnection.

Do not call this after calling error().

Definition at line 447 of file slavebase.cpp.

void SlaveBase::get ( const KUrl & url )

virtual

get, aka read.

Parameters

url	the full url for this request. Host, port and user of the URL can be assumed to be the same as in the last setHost() call.

The slave should first "emit" the mimetype by calling mimeType(), and then "emit" the data using the data() method.

The reason why we need get() to emit the mimetype is: when pasting a URL in krunner, or konqueror's location bar, we have to find out what is the mimetype of that URL. Rather than doing it with a call to mimetype(), then the app or part would have to do a second request to the same server, this is done like this: get() is called, and when it emits the mimetype, the job is put on hold and the right app or part is launched. When that app or part calls get(), the slave is magically reused, and the download can now happen. All with a single call to get() in the slave. This mechanism is also described in KIO::get().

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 768 of file slavebase.cpp.

bool SlaveBase::hasMetaData ( const QString & key ) const

Queries for the existence of a certain config/meta-data entry send by the application to the slave.

Definition at line 360 of file slavebase.cpp.

void SlaveBase::infoMessage ( const QString & msg )

Call to signal a message, to be displayed if the application wants to, for instance in a status bar.

Usual examples are "connecting to host xyz", etc.

Definition at line 644 of file slavebase.cpp.

void SlaveBase::listDir ( const KUrl & url )

virtual

Lists the contents of url.

The slave should emit ERR_CANNOT_ENTER_DIRECTORY if it doesn't exist, if we don't have enough permissions. It should also emit totalFiles as soon as it knows how many files it will list. You should not list files if the path in url is empty, but redirect to a non-empty path instead.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 766 of file slavebase.cpp.

void SlaveBase::listEntries ( const UDSEntryList & _entry )

Call this in listDir, each time you have a bunch of entries to report.

Parameters

_entry The UDSEntry containing all of the object attributes.

Definition at line 704 of file slavebase.cpp.

void SlaveBase::listEntry	(	const UDSEntry &	_entry,
		bool	ready
	)

internal function to be called by the slave.

It collects entries and emits them via listEntries when enough of them are there or a certain time frame exceeded (to make sure the app gets some items in time but not too many items one by one as this will cause a drastic performance penalty)

Parameters

_entry	The UDSEntry containing all of the object attributes.
ready	set to true after emitting all items. `_entry` is not used in this case

Definition at line 677 of file slavebase.cpp.

void SlaveBase::lookupHost ( const QString & host )

Internally used.

Definition at line 1291 of file slavebase.cpp.

int SlaveBase::messageBox	(	MessageBoxType	type,
		const QString &	text,
		const QString &	caption = `QString()`,
		const QString &	buttonYes = `i18n("&Yes")`,
		const QString &	buttonNo = `i18n("&No")`
	)

Call this to show a message box from the slave.

Parameters

type	type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel...
text	Message string. May contain newlines.
caption	Message box title.
buttonYes	The text for the first button. The default is i18n("&Yes").
buttonNo	The text for the second button. The default is i18n("&No"). Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused. and for Information, none is used.

Returns: a button code, as defined in KMessageBox, or 0 on communication error.

Definition at line 851 of file slavebase.cpp.

int SlaveBase::messageBox	(	const QString &	text,
		MessageBoxType	type,
		const QString &	caption = `QString()`,
		const QString &	buttonYes = `i18n("&Yes")`,
		const QString &	buttonNo = `i18n("&No")`,
		const QString &	dontAskAgainName = `QString()`
	)

Call this to show a message box from the slave.

Parameters

text	Message string. May contain newlines.
type	type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel...
caption	Message box title.
buttonYes	The text for the first button. The default is i18n("&Yes").
buttonNo	The text for the second button. The default is i18n("&No"). Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused. and for Information, none is used.
dontAskAgain	A checkbox is added with which further confirmation can be turned off. If the checkbox was ticked *dontAskAgain will be set to true, otherwise false.

Returns: a button code, as defined in KMessageBox, or 0 on communication error.

Definition at line 857 of file slavebase.cpp.

QString SlaveBase::metaData ( const QString & key ) const

Queries for config/meta-data send by the application to the slave.

Definition at line 346 of file slavebase.cpp.

void SlaveBase::mimeType ( const QString & _type )

Call this in mimetype() and in get(), when you know the mimetype.

See mimetype about other ways to implement it.

Definition at line 588 of file slavebase.cpp.

void SlaveBase::mimetype ( const KUrl & url )

virtual

Finds mimetype for one file or directory.

This method should either emit 'mimeType' or it should send a block of data big enough to be able to determine the mimetype.

If the slave doesn't reimplement it, a get will be issued, i.e. the whole file will be downloaded before determining the mimetype on it - this is obviously not a good thing in most cases.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 780 of file slavebase.cpp.

void SlaveBase::mkdir	(	const KUrl &	url,
		int	permissions
	)

virtual

Create a directory.

Parameters

url	path to the directory to create
permissions	the permissions to set after creating the directory (-1 if no permissions to be set) The slave emits ERR_COULD_NOT_MKDIR if failure.

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 792 of file slavebase.cpp.

void SlaveBase::multiGet ( const QByteArray & data )

virtual

Used for multiple get.

Currently only used foir HTTP pielining support.

Parameters

data	packed data; Contains number of URLs to fetch, and for each URL the URL itself and its associated MetaData.

Definition at line 802 of file slavebase.cpp.

void SlaveBase::needSubUrlData ( )

Call to signal that data from the sub-URL is needed.

Definition at line 469 of file slavebase.cpp.

void SlaveBase::open	(	const KUrl &	url,
		QIODevice::OpenMode	mode
	)

virtual

open.

Parameters

url	the full url for this request. Host, port and user of the URL can be assumed to be the same as in the last setHost() call.
mode	see QIODevice::OpenMode

Definition at line 770 of file slavebase.cpp.

void SlaveBase::openConnection ( void )

virtual

Opens the connection (forced) When this function gets called the slave is operating in connection-oriented mode.

When a connection gets lost while the slave operates in connection oriented mode, the slave should report ERR_CONNECTION_BROKEN instead of reconnecting. The user is expected to disconnect the slave in the error handler.

Definition at line 756 of file slavebase.cpp.

void SlaveBase::opened ( )

open succedes

See also: open

Definition at line 412 of file slavebase.cpp.

bool SlaveBase::openPasswordDialog	(	KIO::AuthInfo &	info,
		const QString &	errorMsg = `QString()`
	)

Prompt the user for Authorization info (login & password).

Use this function to request authorization information from the end user. You can also pass an error message which explains why a previous authorization attempt failed. Here is a very simple example:

KIO::AuthInfo authInfo;
if ( openPasswordDialog( authInfo ) )
{
   kDebug() << QLatin1String("User: ")
             << authInfo.username << endl;
   kDebug() << QLatin1String("Password: ")
             << QLatin1String("Not displayed here!") << endl;
}

You can also preset some values like the username, caption or comment as follows:

KIO::AuthInfo authInfo;
authInfo.caption= "Acme Password Dialog";
authInfo.username= "Wile E. Coyote";
QString errorMsg = "You entered an incorrect password.";
if ( openPasswordDialog( authInfo, errorMsg ) )
{
   kDebug() << QLatin1String("User: ")
             << authInfo.username << endl;
   kDebug() << QLatin1String("Password: ")
             << QLatin1String("Not displayed here!") << endl;
}

Note: You should consider using checkCachedAuthentication() to see if the password is available in kpasswdserver before calling this function.; A call to this function can fail and return false, if the UIServer could not be started for whatever reason.; Starting with KDE 4.7, this function will no longer store the password information automatically. If you want to store the password information in a persistent storage like KWallet, then you MUST call cacheAuthentication.

See also: checkCachedAuthentication

Parameters

info	See AuthInfo.
errorMsg	Error message to show

Returns: true if user clicks on "OK", false otherwsie.

Definition at line 815 of file slavebase.cpp.

void SlaveBase::position ( KIO::filesize_t _pos )

Definition at line 547 of file slavebase.cpp.

void SlaveBase::processedPercent ( float percent )

Only use this if you can't know in advance the size of the copied data.

For example, if you're doing variable bitrate compression of the source.

STUB ! Currently unimplemented. Here now for binary compatibility.

Call this during get and copy, once in a while, to give some info about the current state. Don't emit it in listDir, listEntries speaks for itself.

Definition at line 553 of file slavebase.cpp.

void SlaveBase::processedSize ( KIO::filesize_t _bytes )

Call this during get and copy, once in a while, to give some info about the current state.

Don't emit it in listDir, listEntries speaks for itself.

Definition at line 507 of file slavebase.cpp.

int SlaveBase::proxyConnectTimeout ( )

Returns: timeout value for connecting to proxy in secs.

Definition at line 1237 of file slavebase.cpp.

void SlaveBase::put	(	const KUrl &	url,
		int	permissions,
		JobFlags	flags
	)

virtual

put, i.e.

write data into a file.

Parameters

url	where to write the file
permissions	may be -1. In this case no special permission mode is set.
flags	We support Overwrite here. Hopefully, we're going to support Resume in the future, too. If the file indeed already exists, the slave should NOT apply the permissions change to it. The support for resuming using .part files is done by calling canResume().

IMPORTANT: Use the "modified" metadata in order to set the modification time of the file.

See also: canResume()

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 762 of file slavebase.cpp.

void SlaveBase::read ( KIO::filesize_t size )

virtual

Definition at line 772 of file slavebase.cpp.

int SlaveBase::readData ( QByteArray & buffer )

Read data sent by the job, after a dataReq.

Parameters

buffer buffer where data is stored

Returns: 0 on end of data, > 0 bytes read < 0 error

Definition at line 927 of file slavebase.cpp.

int SlaveBase::readTimeout ( )

Returns: timeout value for read from subsequent data from remote host in secs.

Definition at line 1259 of file slavebase.cpp.

void SlaveBase::redirection ( const KUrl & _url )

Call this to signal a redirection The job will take care of going to that url.

Definition at line 565 of file slavebase.cpp.

KRemoteEncoding * SlaveBase::remoteEncoding ( )

Returns an object that can translate remote filenames into proper Unicode forms.

This encoding can be set by the user.

Definition at line 389 of file slavebase.cpp.

void SlaveBase::rename	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags
	)

virtual

Rename oldname into newname.

If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will ask for copy + del instead.

Important: the slave must implement the logic "if the destination already exists, error ERR_DIR_ALREADY_EXIST or ERR_FILE_ALREADY_EXIST". For performance reasons no stat is done in the destination before hand, the slave must do it.

By default, rename() is only called when renaming (moving) from yourproto://host/path to yourproto://host/otherpath.

If you set renameFromFile=true then rename() will also be called when moving a file from file:///path to yourproto://host/otherpath. Otherwise such a move would have to be done the slow way (copy+delete). See KProtocolManager::canRenameFromFile() for more details.

If you set renameToFile=true then rename() will also be called when moving a file from yourproto: to file:. See KProtocolManager::canRenameToFile() for more details.

Parameters

src	where to move the file from
dest	where to move the file to
flags	We support Overwrite here

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 782 of file slavebase.cpp.

void SlaveBase::reparseConfiguration ( )

virtual

Called by the scheduler to tell the slave that the configuration changed (i.e.

proxy settings) .

Definition at line 809 of file slavebase.cpp.

bool SlaveBase::requestNetwork ( const QString & host = QString() )

Used by the slave to check if it can connect to a given host.

This should be called where the slave is ready to do a ::connect() on a socket. For each call to requestNetwork must exist a matching call to dropNetwork, or the system will stay online until KNetMgr gets closed (or the SlaveBase gets destructed)!

If KNetMgr is not running, then this is a no-op and returns true

Parameters

host	tells the netmgr the host the slave wants to connect to. As this could also be a proxy, we can't just take the host currenctly connected to (but that's the default value)

Returns: true in theorie, the host is reachable false the system is offline and the host is in a remote network.

Definition at line 650 of file slavebase.cpp.

int SlaveBase::responseTimeout ( )

Returns: timeout value for read from first data from remote host in seconds.

Definition at line 1248 of file slavebase.cpp.

void SlaveBase::seek ( KIO::filesize_t offset )

virtual

Definition at line 776 of file slavebase.cpp.

void SlaveBase::sendAndKeepMetaData ( )

Internal function to transmit meta data to the application.

Like sendMetaData() but m_outgoingMetaData will not be cleared. This method is mainly useful in code that runs before the slave is connected to its final job.

Definition at line 380 of file slavebase.cpp.

void SlaveBase::sendMetaData ( )

Internal function to transmit meta data to the application.

m_outgoingMetaData will be cleared; this means that if the slave is for example put on hold and picked up by a different KIO::Job later the new job will not see the metadata sent before. See kio/DESIGN.krun for an overview of the state progression of a job/slave.

Warning: calling this method may seriously interfere with the operation of KIO which relies on the presence of some metadata at some points in time. You should not use it if you are not familiar with KIO and not before the slave is connected to the last job before returning to idle state.

Definition at line 374 of file slavebase.cpp.

void SlaveBase::setHost	(	const QString &	host,
		quint16	port,
		const QString &	user,
		const QString &	pass
	)

virtual

Set the host.

Parameters

host
port
user
pass	Called directly by createSlave, this is why there is no equivalent in SlaveInterface, unlike the other methods.

This method is called whenever a change in host, port or user occurs.

Definition at line 752 of file slavebase.cpp.

void SlaveBase::setKillFlag ( )

Internally used.

Definition at line 1274 of file slavebase.cpp.

void SlaveBase::setLinkDest	(	const KUrl &	url,
		const QString &	target
	)

virtual

Change the destination of a symlink.

Parameters

url	the url of the symlink to modify
target	the new destination (target) of the symlink

Definition at line 790 of file slavebase.cpp.

void SlaveBase::setMetaData	(	const QString &	key,
		const QString &	value
	)

Sets meta-data to be send to the application before the first data() or finished() signal.

Definition at line 341 of file slavebase.cpp.

void SlaveBase::setModificationTime	(	const KUrl &	url,
		const QDateTime &	mtime
	)

virtual

Sets the modification time for For instance this is what CopyJob uses to set mtime on dirs at the end of a copy.

It could also be used to set the mtime on any file, in theory. The usual implementation on unix is to call utime(path, &myutimbuf). The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_SETTIME

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 796 of file slavebase.cpp.

void SlaveBase::setSubUrl ( const KUrl & url )

virtual

Prepare slave for streaming operation.

Definition at line 800 of file slavebase.cpp.

void SlaveBase::setTimeoutSpecialCommand	(	int	timeout,
		const QByteArray &	data = `QByteArray()`
	)

This function sets a timeout of timeout seconds and calls special(data) when the timeout occurs as if it was called by the application.

A timeout can only occur when the slave is waiting for a command from the application.

Specifying a negative timeout cancels a pending timeout.

Only one timeout at a time is supported, setting a timeout cancels any pending timeout.

Definition at line 934 of file slavebase.cpp.

void SlaveBase::slave_status ( )

virtual

Called to get the status of the slave.

Slave should respond by calling slaveStatus(...)

Definition at line 806 of file slavebase.cpp.

void SlaveBase::slaveStatus	(	const QString &	host,
		bool	connected
	)

Used to report the status of the slave.

Parameters

host	the slave is currently connected to. (Should be empty if not connected)
connected	Whether an actual network connection exists.

Definition at line 482 of file slavebase.cpp.

void SlaveBase::special ( const QByteArray & data )

virtual

Used for any command that is specific to this slave (protocol) Examples are : HTTP POST, mount and unmount (kio_file)

Parameters

data	packed data; the meaning is completely dependent on the slave, but usually starts with an int for the command number. Document your slave's commands, at least in its header file.

Definition at line 764 of file slavebase.cpp.

void SlaveBase::speed ( unsigned long _bytes_per_second )

Call this in get and copy, to give the current transfer speed, but only if it can't be calculated out of the size you passed to processedSize (in most cases you don't want to call it)

Definition at line 559 of file slavebase.cpp.

void SlaveBase::stat ( const KUrl & url )

virtual

Finds all details for one file or directory.

The information returned is the same as what listDir returns, but only for one file or directory. Call statEntry() after creating the appropriate UDSEntry for this url.

You can use the "details" metadata to optimize this method to only do as much work as needed by the application. By default details is 2 (all details wanted, including modification time, size, etc.), details==1 is used when deleting: we don't need all the information if it takes too much time, no need to follow symlinks etc. details==0 is used for very simple probing: we'll only get the answer "it's a file or a directory (or a symlink), or it doesn't exist".

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 760 of file slavebase.cpp.

void SlaveBase::statEntry ( const UDSEntry & _entry )

Call this from stat() to express details about an object, the UDSEntry customarily contains the atoms describing file name, size, mimetype, etc.

Parameters

_entry The UDSEntry containing all of the object attributes.

Definition at line 671 of file slavebase.cpp.

void SlaveBase::symlink	(	const QString &	target,
		const KUrl &	dest,
		JobFlags	flags
	)

virtual

Creates a symbolic link named dest, pointing to target, which may be a relative or an absolute path.

Parameters

target	The string that will become the "target" of the link (can be relative)
dest	The symlink to create.
flags	We support Overwrite here

Reimplemented in KIO::ForwardingSlaveBase.

Definition at line 784 of file slavebase.cpp.

void SlaveBase::totalSize ( KIO::filesize_t _bytes )

Call this in get and copy, to give the total size of the file.

Definition at line 497 of file slavebase.cpp.

void SlaveBase::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Reimplemented in KIO::TCPSlaveBase.

Definition at line 1288 of file slavebase.cpp.

int SlaveBase::waitForAnswer	(	int	expected1,
		int	expected2,
		QByteArray &	data,
		int *	pCmd = `0`
	)

Wait for an answer to our request, until we get expected1 or expected2.

Returns: the result from readData, as well as the cmd in *pCmd if set, and the data in data

Definition at line 897 of file slavebase.cpp.

int SlaveBase::waitForHostInfo ( QHostInfo & info )

Internally used.

Definition at line 1297 of file slavebase.cpp.

void SlaveBase::warning ( const QString & msg )

Call to signal a warning, to be displayed in a dialog box.

Definition at line 638 of file slavebase.cpp.

bool SlaveBase::wasKilled ( ) const

If your ioslave was killed by a signal, wasKilled() returns true.

Check it regularly in lengthy functions (e.g. in get();) and return as fast as possible from this function if wasKilled() returns true. This will ensure that your slave destructor will be called correctly.

Definition at line 1269 of file slavebase.cpp.

void SlaveBase::write ( const QByteArray & data )

virtual

Definition at line 774 of file slavebase.cpp.

void SlaveBase::written ( KIO::filesize_t _bytes )

Definition at line 541 of file slavebase.cpp.

Member Data Documentation

MetaData KIO::SlaveBase::mIncomingMetaData

protected

Definition at line 894 of file slavebase.h.

MetaData KIO::SlaveBase::mOutgoingMetaData

protected

Definition at line 893 of file slavebase.h.

QByteArray KIO::SlaveBase::mProtocol

protected

Name of the protocol supported by this slave.

Definition at line 891 of file slavebase.h.

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

KIO

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KIO

kdelibs API Reference

Search