Member Function Documentation

void WorkerBase::addTemporaryAuthorization(const QString &action)

Adds action to the list of PolicyKit actions which the worker is authorized to perform.

action the PolicyKit action

[virtual] void WorkerBase::appConnectionMade()

Application connected to the worker.

Called when an application has connected to the worker. Mostly only useful when you want to e.g. send metadata to the application once it connects.

bool WorkerBase::cacheAuthentication(const KIO::AuthInfo &info)

Caches info in a persistent storage like KWallet.

Note that calling openPasswordDialogV2 does not store passwords automatically for you (and has not since kdelibs 4.7).

Here is a simple example of how to use cacheAuthentication:

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

info See AuthInfo. Returns true if info was successfully cached.

void WorkerBase::canResume()

Call this at the beginning of get(), if the "range-start" metadata was set and returning byte ranges is implemented by this protocol.

bool WorkerBase::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)

bool WorkerBase::checkCachedAuthentication(KIO::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 = QUrl("https://www.foobar.org/foo/bar");
info.username = "somename";
info.verifyPath = true;
if ( !checkCachedAuthentication( info ) )
{
   int errorCode = openPasswordDialogV2(info);
    ....
}

info see AuthInfo. Returns true if cached Authorization is found, false otherwise.

[virtual] KIO::WorkerResult WorkerBase::chmod(const QUrl &url, int permissions)

Change permissions on url. The worker emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHMOD

[virtual] KIO::WorkerResult WorkerBase::chown(const QUrl &url, const QString &owner, const QString &group)

Change ownership of url. The worker emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHOWN

[virtual] KIO::WorkerResult WorkerBase::close()

close.

See also KIO::FileJob::close().

[virtual] void WorkerBase::closeConnection()

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

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

KConfigGroup *WorkerBase::config()

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

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

bool WorkerBase::configValue(const QString &key, bool defaultValue) const

Returns a bool from the config/meta-data information.

QString WorkerBase::configValue(const QString &key, const QString &defaultValue = QString()) const

Returns a QString from the config/meta-data information.

int WorkerBase::configValue(const QString &key, int defaultValue) const

Returns an int from the config/meta-data information.

int WorkerBase::connectTimeout()

Returns timeout value for connecting to remote host.

void WorkerBase::connectWorker(const QString &path)

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

[virtual] KIO::WorkerResult WorkerBase::copy(const QUrl &src, const QUrl &dest, int permissions, KIO::JobFlags flags)

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 worker returns an error ERR_UNSUPPORTED_ACTION, the job will ask for get + put instead.

If the worker returns an error ERR_FILE_ALREADY_EXIST, the job will ask for a different destination filename.

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, and the owner and group permissions are not preserved.

flags We support Overwrite here

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

void WorkerBase::data(const QByteArray &data)

Sends data in the worker to the job (i.e. in get).

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

data the data read by the worker

void WorkerBase::dataReq()

Asks for data from the job.

See also readData.

[virtual] KIO::WorkerResult WorkerBase::del(const QUrl &url, bool isfile)

Delete a file or directory.

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 worker can do a recursive deletion. This behavior is only invoked if the worker specifies deleteRecursive=true in its protocol file.

void WorkerBase::disconnectWorker()

[virtual] KIO::WorkerResult WorkerBase::fileSystemFreeSpace(const QUrl &url)

Get a filesystem's total and available space.

url Url to the filesystem

[virtual] KIO::WorkerResult WorkerBase::get(const QUrl &url)

get, aka read.

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 worker should first "emit" the MIME type by calling mimeType(), and then "emit" the data using the data() method.

The reason why we need get() to emit the MIME type is: when pasting a URL in krunner, or konqueror's location bar, we have to find out what is the MIME type 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 MIME type, the job is put on hold and the right app or part is launched. When that app or part calls get(), the worker is magically reused, and the download can now happen. All with a single call to get() in the worker. This mechanism is also described in KIO::get().

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

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

void WorkerBase::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.

[virtual] KIO::WorkerResult WorkerBase::listDir(const QUrl &url)

Lists the contents of url. The worker should emit ERR_CANNOT_ENTER_DIRECTORY if it doesn't exist, if we don't have enough permissions. You should not list files if the path in url is empty, but redirect to a non-empty path instead.

void WorkerBase::listEntries(const KIO::UDSEntryList &_entry)

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

_entry The UDSEntry containing all of the object attributes.

void WorkerBase::listEntry(const KIO::UDSEntry &entry)

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).

entry The UDSEntry containing all of the object attributes.

QMap<QString, QVariant> WorkerBase::mapConfig() const

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

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

Use configValue() as shortcut.

int WorkerBase::messageBox(KIO::WorkerBase::MessageBoxType type, const QString &text, const QString &title = QString(), const QString &primaryActionText = QString(), const QString &secondaryActionText = QString())

Call this to show a message box from the worker

type type of message box

text Message string. May contain newlines.

title Message box title.

primaryActionText the text for the first button. Ignored for type Information.

secondaryActionText the text for the second button. Ignored for type WarningContinueCancel, WarningContinueCancelDetailed, Information.

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

int WorkerBase::messageBox(const QString &text, KIO::WorkerBase::MessageBoxType type, const QString &title = QString(), const QString &primaryActionText = QString(), const QString &secondaryActionText = QString(), const QString &dontAskAgainName = QString())

Call this to show a message box from the worker

text Message string. May contain newlines.

type type of message box

title Message box title.

primaryActionText the text for the first button. Ignored for type Information.

secondaryActionText the text for the second button. Ignored for type WarningContinueCancel, WarningContinueCancelDetailed, Information.

dontAskAgainName the name used to store result from 'Do not ask again' checkbox. Returns a button code, as defined in ButtonCode, or 0 on communication error.

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

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

See also setMetaData().

void WorkerBase::mimeType(const QString &_type)

Call this in mimetype() and in get(), when you know the MIME type. See mimetype() about other ways to implement it.

[virtual] KIO::WorkerResult WorkerBase::mimetype(const QUrl &url)

Finds MIME type 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 MIME type.

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

[virtual] KIO::WorkerResult WorkerBase::mkdir(const QUrl &url, int permissions)

Create a directory

url path to the directory to create

permissions the permissions to set after creating the directory (-1 if no permissions to be set)

The worker emits ERR_CANNOT_MKDIR if failure.

[virtual] KIO::WorkerResult WorkerBase::open(const QUrl &url, QIODeviceBase::OpenMode mode)

open.

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

[virtual] KIO::WorkerResult WorkerBase::openConnection()

Opens the connection (forced). When this function gets called the worker is operating in connection-oriented mode. When a connection gets lost while the worker operates in connection oriented mode, the worker should report ERR_CONNECTION_BROKEN instead of reconnecting. The user is expected to disconnect the worker in the error handler.

int WorkerBase::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;
int errorCode = openPasswordDialogV2(authInfo);
if (!errorCode) {
   qDebug() << QLatin1String("User: ") << authInfo.username;
   qDebug() << QLatin1String("Password: not displayed here!");
} else {
   error(errorCode, QString());
}

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

KIO::AuthInfo authInfo;
authInfo.caption = i18n("Acme Password Dialog");
authInfo.username = "Wile E. Coyote";
QString errorMsg = i18n("You entered an incorrect password.");
int errorCode = openPasswordDialogV2(authInfo, errorMsg);
[...]

info See AuthInfo.

errorMsg Error message to show

Returns a KIO error code: NoError (0), KIO::USER_CANCELED, or other error codes.

See also checkCachedAuthentication.

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

void WorkerBase::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.

int WorkerBase::proxyConnectTimeout()

Returns timeout value for connecting to proxy in secs.

[virtual] KIO::WorkerResult WorkerBase::put(const QUrl &url, int permissions, KIO::JobFlags flags)

put, i.e. write data into a file.

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 worker 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().

[virtual] KIO::WorkerResult WorkerBase::read(KIO::filesize_t size)

read.

size the requested amount of data to read

See also KIO::FileJob::read().

int WorkerBase::readData(QByteArray &buffer)

Read data sent by the job, after a dataReq

buffer buffer where data is stored

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

int WorkerBase::readTimeout()

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

void WorkerBase::redirection(const QUrl &_url)

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

KRemoteEncoding *WorkerBase::remoteEncoding()

Returns an object that can translate remote filenames into proper Unicode forms. This encoding can be set by the user.

[virtual] KIO::WorkerResult WorkerBase::rename(const QUrl &src, const QUrl &dest, KIO::JobFlags flags)

Rename oldname into newname.

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

Important: the worker 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 worker 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.

src where to move the file from

dest where to move the file to

flags We support Overwrite here

[virtual] void WorkerBase::reparseConfiguration()

Called by the scheduler to tell the worker that the configuration changed (i.e. proxy settings) .

KIO::PrivilegeOperationStatus WorkerBase::requestPrivilegeOperation(const QString &operationDetails)

Checks with job if privilege operation is allowed. Returns privilege operation status.

See also PrivilegeOperationStatus.

int WorkerBase::responseTimeout()

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

[virtual] KIO::WorkerResult WorkerBase::seek(KIO::filesize_t offset)

seek.

offset the requested amount of data to read

See also KIO::FileJob::read().

void WorkerBase::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 worker is connected to its final job.

void WorkerBase::sendMetaData()

Internal function to transmit meta data to the application.

m_outgoingMetaData will be cleared; this means that if the worker 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/worker.

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

Set the host

Called directly by createWorker and not via the interface.

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

[since 5.99] void WorkerBase::setIncomingMetaData(const KIO::MetaData &metaData)

Set the Incoming Meta Data This is only really useful if your worker wants to overwrite the metadata for consumption in other worker functions; this overwrites existing metadata set by the client!

metaData metadata to set

This function was introduced in 5.99.

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

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

See also metaData().

[virtual] KIO::WorkerResult WorkerBase::setModificationTime(const QUrl &url, const QDateTime &mtime)

Sets the modification time for url.

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 worker emits ERR_DOES_NOT_EXIST or ERR_CANNOT_SETTIME

void WorkerBase::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 worker 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.

[virtual] KIO::WorkerResult WorkerBase::special(const QByteArray &data)

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

data packed data; the meaning is completely dependent on the worker, but usually starts with an int for the command number.

Document your worker's commands, at least in its header file.

void WorkerBase::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)

int WorkerBase::sslError(const QVariantMap &sslData)

[virtual] KIO::WorkerResult WorkerBase::stat(const QUrl &url)

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".

void WorkerBase::statEntry(const KIO::UDSEntry &_entry)

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

_entry The UDSEntry containing all of the object attributes.

[virtual] KIO::WorkerResult WorkerBase::symlink(const QString &target, const QUrl &dest, KIO::JobFlags flags)

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

target The string that will become the "target" of the link (can be relative)

dest The symlink to create.

flags We support Overwrite here

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

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

[virtual] KIO::WorkerResult WorkerBase::truncate(KIO::filesize_t size)

truncate

size size to truncate the file to

See also KIO::FileJob::truncate().

void WorkerBase::truncated(KIO::filesize_t _length)

int WorkerBase::waitForAnswer(int expected1, int expected2, QByteArray &data, int *pCmd = nullptr)

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

void WorkerBase::warning(const QString &msg)

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

bool WorkerBase::wasKilled() const

If your ioworker 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 worker destructor will be called correctly.

void WorkerBase::workerStatus(const QString &host, bool connected)

Used to report the status of the worker.

host the worker is currently connected to. (Should be empty if not connected)

connected Whether an actual network connection exists.

[virtual] void WorkerBase::worker_status()

Called to get the status of the worker. Worker should respond by calling workerStatus(...)

[virtual] KIO::WorkerResult WorkerBase::write(const QByteArray &data)

write.

data the data to write

See also KIO::FileJob::write().

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