class NetAccess

Public Static Methods

• static bool  download (const KURL& src, QString & target)
• static void  removeTempFile (const QString& name)
• static bool  upload (const QString& src, const KURL& target)
• static bool  copy ( const KURL& src, const KURL& target )
• static bool  dircopy ( const KURL& src, const KURL& target )
• static bool  exists (const KURL& url)
• static bool  stat (const KURL& url, KIO::UDSEntry & entry)
• static bool  del ( const KURL & url )
• static bool  mkdir ( const KURL & url, int permissions = -1 )
• static QString  mimetype ( const KURL & url )
• static QString  lastErrorString ()

Detailed Description

Net Transparency, formerly provided by kfmlib, but now done with KIO::Jobs.

This class isn't meant to be used as a class but only as a simple namespace for static functions, though an instance of the class is built for internal purposes. Whereas a kiojob is asynchronous, meaning that the developer has to connect slots for it, KIO::NetAccess provides synchronous downloads and uploads, as well as temporary file creation and removal.

Port to kio done by David Faure, faure@kde.org

[static]

Download a file from an arbitrary URL (src) to a temporary file on the local filesystem (target).

If the argument for target is an empty string, download will generate a unique temporary filename in /tmp. Since target is a reference to QString you can access this filename easily. Download will return true if the download was successful, otherwise false.

Special case: If the URL is of kind file: then no downloading is processed but the full filename is returned in target. That means you have to take care about the target argument. (This is very easy to do, please see the example below.)

Download is synchronous. That means you can use it like this, (assuming u is a string which represents a URL and your application has a loadFile() function):

 QString tmpFile;
 if( KIO::NetAccess::download( u, tmpFile ) )
 {
   loadFile( tmpFile );
   KIO::NetAccess::removeTempFile( tmpFile );
   }

Of course, your user interface will still process exposure/repaint events during the download.

Parameters:

src	URL Reference to the file to download.
target	String containing the final local location of the file. If you insert an empty string, it will return a location in a temporary spot.

[static]

Remove the specified file if and only if it was created by KIO::NetAccess as a temporary file for a former download.

Note: This means that if you created your temporary with KTempFile, use KTempFile::unlink() or KTempFile::setAutoDelete() to have it removed.

Parameters:

name	Path to temporary file to remove. May not be empty.

[static]

Upload file src to URL target.

Both must be specified, unlike download. Note that this is assumed to be used for saving a file over the network, so overwriting is set to true. This is not the case with copy.

Parameters:

src	URL Referencing the file to upload.
target	URL containing the final location of the file.

[static]

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::file_copy (not KIO::copy!).

[static]

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::copy!.

[static]

Test whether a URL exists.

This is a convenience function for KIO::stat (it saves creating a slot and testing for the job result).

Parameters:

url	the url we are testing

[static]

Test whether a URL exists and return information on it.

This is a convenience function for KIO::stat (it saves creating a slot and testing for the job result).

Parameters:

url	The URL we are testing.
entry	The result of the stat. Iterate over the list of atoms to get hold of name, type, size, etc., or use KFileItem.

[static]

Delete a file or a directory in an synchronous way.

This is a convenience function for KIO::del (it saves creating a slot and testing for the job result).

Parameters:

url	The file or directory to delete.

Returns: true on success, false on failure.

[static]

Create a directory in an synchronous way.

This is a convenience function for KIO::mkdir (it saves creating a slot and testing for the job result).

Parameters:

url	The directory to create.

Returns: true on success, false on failure.

[static]

Determine the mimetype of a given URL.

This is a convenience function for KIO::mimetype. You should call this only when really necessary. KMimeType::findByURL can determine extension a lot faster, but less reliably for remote files. Only when findByURL() returns unknown (application/octet-stream) then this one should be used.

Parameters:

url	The URL whose mimetype we are interested in.

Returns: The mimetype name.

[static]

Return error string for the last job, in case it failed