// -*- c++ -*-
/* This file is part of the KDE libraries
Copyright (C) 2000 Stephan Kulow
David Faure
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __kio_job_h__
#define __kio_job_h__
#include
namespace KIO {
#ifdef CACHE_INFO
class CacheInfo
{
public:
/**
* @param url
*/
CacheInfo(const KURL& url);
/**
* Null if not cached
*/
QFile *cachedFile();
/**
* Null if not cached
*/
QString &cachedFileName();
/**
* delete the Cache file
*/
void flush();
/**
*
*/
int creationDate();
// set creation date to current local machine time
void touch();
// the local machine time when the cache entry will be / was expired
int expireDate();
void setExpireDate(int);
bool expired() { return difftime(time(0),expireDate())>=0; };
// the duration the cache entry is/was valid.
int expireTimeout();
void setExpireTimeout();
private:
QFile *cef;
}
#endif
/**
* Creates a single directory.
*
*
*
*
* @param url The URL of the directory to create.
* @param permissions The permissions to set after creating the directory.
* @return A pointer to the job handling the operation.
*/
SimpleJob * mkdir( const KURL& url, int permissions = -1 );
/**
* Removes a single directory.
*
* The directory is assumed to be empty.
*
*
*
* @param url The URL of the directory to remove.
* @return A pointer to the job handling the operation.
*/
SimpleJob * rmdir( const KURL& url );
/**
* Changes permissions on a file or directory.
* See the other @ref chmod below for changing many files
* or directories.
*
* @param url The URL of file or directory.
* @param permissions The permissions to set.
* @return The job handling the operation.
*/
SimpleJob * chmod( const KURL& url, int permissions );
/**
* Rename a file or directory.
* Warning: this operation fails if a direct renaming is not
* possible (like with files or dirs on separate partitions)
* Use move or file_move in this case.
*
* @param src The original URL
* @param dest The final URL
* @param overwrite whether to automatically overwrite if the dest exists
* @return The job handling the operation.
*/
SimpleJob * rename( const KURL& src, const KURL & dest, bool overwrite );
/**
* Create or move a symlink.
* This is the lowlevel operation, similar to file_copy and file_move.
* It doesn't do any check (other than those the slave does)
* and it doesn't show rename and skip dialogs - use KIO::link for that.
* @param target The string that will become the "target" of the link (can be relative)
* @param dest The symlink to create.
* @param overwrite whether to automatically overwrite if the dest exists
* @return The job handling the operation.
*/
SimpleJob * symlink( const QString & target, const KURL& dest, bool overwrite, bool showProgressInfo = true );
/**
* Execute any command that is specific to one slave (protocol).
*
* Examples are : HTTP POST, mount and unmount (kio_file)
*
* @param url The URL isn't passed to the slave, but is used to know
* which slave to send it to :-)
* @param data Packed data. The meaning is completely dependent on the
* slave, but usually starts with an int for the command number.
*/
SimpleJob * special( const KURL& url, const QByteArray & data, bool showProgressInfo = true );
/**
* Mount filesystem.
*
* Special job for @p kio_file.
*
* @param ro Mount read-only if @p true.
* @param fstype File system type (e.g. "ext2", can be 0L).
* @param dev Device (e.g. /dev/sda0).
* @param point Mount point, can be @p null.
*/
SimpleJob *mount( bool ro, const char *fstype, const QString& dev, const QString& point, bool showProgressInfo = true );
/**
* Unmount filesystem.
*
* Special job for @p kio_file.
*
* @param mount Point to unmount.
*/
SimpleJob *unmount( const QString & point, bool showProgressInfo = true );
/**
* HTTP cache update
*
* @param url Url to update, protocol must be "http".
* @param no_cache If true, cache entry for @p url is deleted.
* @param expireDate Local machine time indicating when the entry is
* supposed to expire.
*/
SimpleJob *http_update_cache( const KURL& url, bool no_cache, time_t expireDate);
#ifdef CACHE_INFO
/**
* @param url Url to be checked.
*/
CacheInfo* getCacheInfo(const KURL& url);
#endif
/**
* Find all details for one file or directory.
*/
StatJob * stat( const KURL& url, bool showProgressInfo = true );
/**
* Find all details for one file or directory.
* This version of the call includes two additional booleans, @p sideIsSource and @p details.
*
* @param sideIsSource is true when stating a source file (we will do a get on it if
* the stat works) and false when stating a destination file (target of a copy).
*
* @param details selects the level of details we want.
* By default this is 2 (all details wanted, including modification time, size, etc.),
* setDetails(1) is used when deleting: we don't need all the information if it takes
* too much time, no need to follow symlinks etc.
* setDetails(0) is used for very simple probing: we'll only get the answer
* "it's a file or a directory, or it doesn't exist". This is used by KRun.
*/
StatJob * stat( const KURL& url, bool sideIsSource, short int details, bool showProgressInfo = true );
/**
* Get (a.k.a. read).
*
* The slave emits the data through @ref data().
*/
TransferJob *get( const KURL& url, bool reload=false, bool showProgressInfo = true );
/**
* Put (a.k.a. write)
*
* @param url Where to write data.
* @param permissions May be -1. In this case no special permission mode is set.
* @param overwrite If @p true, any existing file will be overwritten.
* @param resume
*/
TransferJob *put( const KURL& url, int permissions,
bool overwrite, bool resume, bool showProgressInfo = true );
/**
* HTTP POST (for form data).
*
* @param url Where to write data.
* @param postData Encoded data to post.
*
* Example:
*
* job = KIO::http_post( url, postData, false );
* job->addMetaData("content-type", contentType );
* job->addMetaData("referrer", referrerURL);
*
*
* @param postData is the data that you want to send and
* @param contentType is the format of that data.
*
* You MUST specify content-type!
*
* Often @p contentType is "application/x-www-form-urlencoded" and
* the @p postData is then an ASCII string (without null-termination!)
* with characters like space, linefeed and percent escaped like %20,
* %0A and %25.
*/
TransferJob *http_post( const KURL& url, const QByteArray &postData,
bool showProgressInfo = true );
MultiGetJob *multi_get( long id, const KURL &url, const MetaData &metaData);
/**
* Find mimetype for one file or directory.
*/
MimetypeJob * mimetype( const KURL& url,
bool showProgressInfo = true );
/**
* Copy a single file.
*
* Uses either @ref SlaveBase::copy() if the slave supports that
* or @ref get() and @ref put() otherwise.
* @param src Where to get the file.
* @param dest Where to put the file.
* @param permissions May be -1. In this case no special permission mode is set.
* @param overwrite If @p true, any existing file will be overwritten.
* @param resume
*/
FileCopyJob *file_copy( const KURL& src, const KURL& dest, int permissions=-1,
bool overwrite=false, bool resume=false,
bool showProgressInfo = true);
/**
* Move a single file.
*
* Use either @ref SlaveBase::rename() if the slave supports that,
* or @ref copy() and @ref del() otherwise, or eventually get() & put() & del()
* @param src Where to get the file.
* @param dest Where to put the file.
* @param permissions May be -1. In this case no special permission mode is set.
* @param overwrite If @p true, any existing file will be overwritten.
* @param resume
*/
FileCopyJob *file_move( const KURL& src, const KURL& dest, int permissions=-1,
bool overwrite=false, bool resume=false,
bool showProgressInfo = true);
/**
* Delete a single file.
*
* @param src File to delete.
*/
SimpleJob *file_delete( const KURL& src, bool showProgressInfo = true);
/**
* List the contents of @p url, which is assumed to be a directory.
*
* "." and ".." are returned, filter them out if you don't want them.
*
* pass includeHidden = false to cull out UNIX hidden files/dirs
* (whose names start with .)
*/
ListJob *listDir( const KURL& url, bool showProgressInfo = true,
bool includeHidden = true );
/**
* The same as the previous method, but recurses subdirectories.
*
* "." and ".." are returned but only for the toplevel directory.
* Filter them out if you don't want them.
*
* pass includeHidden = false to cull out UNIX hidden files/dirs
* (whose names start with .)
*/
ListJob *listRecursive( const KURL& url, bool showProgressInfo = true,
bool includeHidden = true );
/**
* Copy a file or directory @p src into the destination @dest,
* which can be a file (including the final filename) or a directory
* (into which @p src will be copied).
*
* This emulates the @p cp command completely.
*/
CopyJob *copy( const KURL& src, const KURL& dest, bool showProgressInfo = true );
/**
* Copy a file or directory @p src into the destination @dest,
* which is the destination name in any case, even for a directory.
*
* As opposed to @ref copy, this doesn't emulate @p cp, but is the only
* way to copy a directory, giving it a new name and getting an error
* box if a directory already exists with the same name.
*/
CopyJob *copyAs( const KURL& src, const KURL& dest, bool showProgressInfo = true );
/**
* Copy a list of file/dirs @p src into a destination directory @p dest.
*/
CopyJob *copy( const KURL::List& src, const KURL& dest, bool showProgressInfo = true );
/**
* @see copy
*/
CopyJob *move( const KURL& src, const KURL& dest, bool showProgressInfo = true );
/**
* @see copyAs
*/
CopyJob *moveAs( const KURL& src, const KURL& dest, bool showProgressInfo = true );
/**
* @see copy
*/
CopyJob *move( const KURL::List& src, const KURL& dest, bool showProgressInfo = true );
/**
* Create a link.
*
* @param src The existing file or directory, 'target' of the link.
* @param destDir Destination directory where the link will be created.
* If the protocols and hosts are the same, a Unix symlink will be created.
* Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
*/
CopyJob *link( const KURL& src, const KURL& destDir, bool showProgressInfo = true );
/**
* @see link
*/
CopyJob *link( const KURL::List& src, const KURL& destDir, bool showProgressInfo = true );
/**
* @see link and copyAs
*/
CopyJob *linkAs( const KURL& src, const KURL& dest, bool showProgressInfo = true );
/**
* Delete a file or directory.
*
* @param src file to delete
* @param shred If @p true, delete in a way that makes recovery impossible
* (only supported for local files currently)
*/
DeleteJob *del( const KURL& src, bool shred = false, bool showProgressInfo = true );
DeleteJob *del( const KURL::List& src, bool shred = false, bool showProgressInfo = true );
}
#endif
| Generated by: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53. |