mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 02:42:48 +00:00
136 lines
7.1 KiB
Text
136 lines
7.1 KiB
Text
METADATA
|
|
========
|
|
|
|
Applications can provide "metadata" to the slaves. Metadata can influence
|
|
the behavior of a slave and is usally protocol dependent. MetaData consists
|
|
of two strings: a "key" and a "value".
|
|
|
|
Any meta data whose "key" starts with the keywords {internal~currenthost} and
|
|
"{internal~allhosts}" will be treated as internal metadata and will not be made
|
|
available to client applications. Instead all such meta-data will be stored and
|
|
sent back to the appropriate ioslaves along with the other regular metadata values.
|
|
|
|
Use "{internal~currenthost}" to make the internal metadata available to all
|
|
ioslaves of the same protocol and host as the ioslave that generated it. If
|
|
you do not want to restrict the availability of the internal metadata to only
|
|
the current host, then use {internal~allhosts}. In either case the internal
|
|
metadata follows the rules of the regular metadata and therefore cannot be sent
|
|
from one protocol such as "http" to a completely different one like "ftp".
|
|
|
|
Please note that when internal meta-data values are sent back to ioslaves, the
|
|
keyword used to mark them internal will be stripped from the key name.
|
|
|
|
The following keys are currently in use:
|
|
|
|
Key Value(s) Description
|
|
---- -------- -----------
|
|
|
|
referrer string The URL from which the request originates. (read by http)
|
|
|
|
modified string The modification date of the document (set by http and by kio before put)
|
|
|
|
accept string List of mimetypes to accept separated by a ", ". (read by http)
|
|
|
|
responsecode string Original response code of the web server. (set by http)
|
|
|
|
SendUserAgent bool Whether to send a User-Agent (read by http)
|
|
UserAgent string The user agent name to send to remote host (read by http)
|
|
|
|
content-type string The content type of the data to be uploaded (read and set by http)
|
|
media-* string Media-Parameter attributes (e.g. media-boundary)
|
|
media-*-kio-quoted bool The corresponding media- attribute's value was quoted. (set by http)
|
|
|
|
cache "cache" Use entry from cache if available.
|
|
"cacheonly" Do not do any remote lookups, fail if not in cache. (read by http)
|
|
"verify" Use entry from cache, verify with remote server if expired
|
|
"refresh" Use entry from cache after verifying with remote server
|
|
"reload" Do not do any cache lookups.
|
|
|
|
window-id number winId() of the window the request is associated with.
|
|
|
|
resume number Try to get the file starting at the given offset (set by file_copy when finding a .part file,
|
|
but can also be set by apps.)
|
|
|
|
resume_until number Try to get the file until at the given offset (not set in kdelibs; handled by kio_http).
|
|
|
|
charset string Charset of the current content as returned by a HTTP Header Response.
|
|
|
|
Charsets string Charset(s) send in the "Accept-Charset:" HTTP Request Header.
|
|
|
|
Languages string Language(s) send in the "Accept-Language:" HTTP Request Header.
|
|
|
|
content-disposition-type string Type of Content-Disposition from a HTTP Header Response.
|
|
content-disposition-* any other valid value sent in a Content-Disposition header (e.g. filename)
|
|
|
|
request-id number Sequence number to identify requests in a MultiGet command.
|
|
|
|
expire-date number Date on which a cache entry needs validation.
|
|
|
|
cache-creation-date number Date on which a cache entry has been created.
|
|
|
|
http-refresh string Passes HTTP Refresh meta-data back to the application.
|
|
|
|
cookies "auto" Use kcookiejar to lookup and collect cookies (default)
|
|
"manual" Cookies set in "setcookies" are send, received cookies are reported
|
|
via "setcookies".
|
|
"none" No cookies are sent, received cookies are discarded.
|
|
|
|
setcookies string Used to send/receive HTTP cookies when "cookies" is set to "manual".
|
|
|
|
errorPage bool Flag that indicates that an errorPage() is preferred over an error(). (default:true)
|
|
|
|
no-auth bool Flag that indicates that no authentication (neither WWW nor proxy) attempts should be made.
|
|
no-www-auth bool Flag that indicates that no HTTP WWW authentication attempts should be made.
|
|
no-proxy-auth bool Flag that indicates that no HTTP proxy authentication attempts should be made.
|
|
no-auth-prompt bool Flag that indicates that only cached authentication tokens should be used.
|
|
no-preemptive-auth-reuse bool Flag that indicates whether cached credentials should be preemptively sent to the server.
|
|
|
|
HTTP-Version string The HTTP version in use for kio_http (set by http)
|
|
|
|
PropagateHttpHeader bool Whether HTTP headers should be send back (read by http)
|
|
|
|
HTTP-Headers string The HTTP headers, concatenated, \n delimited (set by http)
|
|
Requires PropagateHttpHeader to be set.
|
|
|
|
customHTTPHeader string Custom HTTP headers to add to the request (read by http)
|
|
|
|
CustomHTTPMethod string Overrides the method string sent by kio_http
|
|
without changing the behavior (read by http)
|
|
|
|
UseProxy string URL representing the proxy settings (read by http)
|
|
ProxyUrls string a comma separated list of proxy urls. The first url in this list matches one set in "UseProxy".
|
|
|
|
PrivacyPolicy stringlist \n delimited URIs referring to P3P privacy
|
|
policies presented by the HTTP server
|
|
|
|
PrivacyCompactPolicy stringlist \n delimited P3P compact tag policies
|
|
presented by the HTTP server
|
|
|
|
textmode bool When true, switches FTP up/downloads to ascii transfer mode (read by ftp)
|
|
|
|
recurse bool When true, del() will be able to delete non-empty directories. (read by file)
|
|
Otherwise, del() is supposed to give an error on non-empty directories.
|
|
|
|
DefaultRemoteProtocol string Protocol to redirect file://<hostname>/ URLs to, default is "smb" (read by file)
|
|
no-spoof-check bool Flag to indicate whether a username spoofing check should be performed, default is FALSE.(read by http)
|
|
redirect-to-get bool If "true", changes a redrirection request to a GET operation regardless of the original operation.
|
|
|
|
** NOTE: Anything in quotes ("") under Value(s) indicates literal value.
|
|
|
|
|
|
Examples:
|
|
|
|
E.g. the following disables cookies:
|
|
job = KIO::get( KUrl("http://www.kde.org") );
|
|
job->addMetaData("cookies", "none");
|
|
|
|
If you want to handle cookies yourself, you can do:
|
|
job = KIO::get( KUrl("http://www.kde.org") );
|
|
job->addMetaData("cookies", "manual");
|
|
job->addMetaData("setcookies", "Cookie: foo=bar; gnat=gnork");
|
|
|
|
The above sends two cookies along with the request, any cookies send back by
|
|
the server can be retrieved with job->queryMetaData("cookies") after
|
|
receiving the mimetype() signal or when the job is finished.
|
|
|
|
The cookiejar is not used in this case.
|