org.kde.koala
Class KTempFile
public
class
KTempFile
extends Object
implements QtSupport
The KTempFile class creates and opens a unique file for temporary use.
This is especially useful if you need to create a file in a world
writable directory like /tmp without being vulnerable to so called
symlink attacks.
KDE applications, however, shouldn't create files in /tmp in the first
place but use the "tmp" resource instead. The standard KTempFile
constructor will do that by default.
To create a temporary file that starts with a certain name
in the "tmp" resource, one should use:
KTempFile(locateLocal("tmp", prefix), extension);
KTempFile does not create any missing directories, but locateLocal() does.
See also KStandardDirs
Author: Waldo Bastian
UNKNOWN: The KTempFile class creates and opens a unique file for temporary use.
Constructor Summary |
protected | KTempFile(Class dummy) |
| KTempFile(String filePrefix, String fileExtension, int mode)
Creates a temporary file with the name:
\\\
The default filePrefix is "$KDEHOME/tmp-$HOST/appname/"
The default fileExtension is ".tmp" |
| KTempFile(String filePrefix, String fileExtension) |
| KTempFile(String filePrefix) |
| KTempFile() |
| KTempFile(boolean arg1)
Constructor used by KSaveFile |
Method Summary |
boolean | close()
Closes the file.
|
protected boolean | create(String filePrefix, String fileExtension, int mode)
Create function used internally by KTempFile and KSaveFile |
QDataStream | dataStream()
Returns a QDataStream for writing. |
void | dispose() Delete the wrapped C++ instance ahead of finalize() |
QFile | file()
Returns a QFile. |
protected void | finalize() Deletes the wrapped C++ instance |
int | handle()
An integer file descriptor open for writing to the file |
boolean | isDisposed() Has the wrapped C++ instance been deleted? |
String | name()
Returns the full path and name of the file.
|
void | setAutoDelete(boolean autoDelete)
Turn automatic deletion on or off.
|
protected void | setError(int error) |
int | status()
Returns the status of the file based on errno. (see errno.h)
0 means OK.
|
boolean | sync()
Flushes file to disk (fsync).
|
QTextStream | textStream()
Returns the QTextStream for writing. |
void | unlink()
Unlinks the file from the directory. |
protected KTempFile(Class dummy)
public KTempFile(String filePrefix, String fileExtension, int mode)
Creates a temporary file with the name:
\
\\
The default filePrefix
is "$KDEHOME/tmp-$HOST/appname/"
The default fileExtension
is ".tmp"Parameters: filePrefix the prefix of the file name, or null
for the default value fileExtension the extension of the prefix, or null for the
default value mode the file permissions
UNKNOWN: Creates a temporary file with the name: \\\
public KTempFile(String filePrefix, String fileExtension)
public KTempFile(String filePrefix)
public KTempFile()
public KTempFile(boolean arg1)
Constructor used by KSaveFile
UNKNOWN: Constructor used by KSaveFile
public boolean close()
Closes the file.
See status() for details about errors.
Returns: true if successful, or false if an error has occurred.
UNKNOWN: Closes the file.
protected boolean create(String filePrefix, String fileExtension, int mode)
Create function used internally by KTempFile and KSaveFile
UNKNOWN:
public QDataStream dataStream()
Returns a QDataStream for writing.
Returns: QDataStream open for writing to the file, or 0
if opening the file failed
UNKNOWN: Returns a QDataStream for writing.
public void dispose()
Delete the wrapped C++ instance ahead of finalize()
public QFile file()
Returns a QFile.
Returns: A QFile open for writing to the file, or 0 if
opening the file failed.
UNKNOWN: Returns a QFile.
protected void finalize()
Deletes the wrapped C++ instance
public int handle()
An integer file descriptor open for writing to the file
Returns: The file descriptor, or a negative number if opening
the file failed
UNKNOWN: An integer file descriptor open for writing to the file
public boolean isDisposed()
Has the wrapped C++ instance been deleted?
public String name()
Returns the full path and name of the file.
Note that in most circumstances the file needs to be closed
before you use it by name.
In particular, if another process or software part needs to write data
to the file based on the filename, the file should be closed before doing
so. Otherwise the act of closing the file later on may cause the file to
get truncated to a zero-size, resulting in an unexpected loss of the data.
In some cases there is only interest in the filename itself but where the
actual presence of a file with such name is a problem. In that case the
file should first be both closed and unlinked. Such usage is not recommended
since it may lead to the kind of symlink vulnerabilities that the KTempFile
design attempts to prevent.
Returns: The name of the file, or null if opening the
file has failed or the file has been unlinked already.
UNKNOWN: Returns the full path and name of the file.
public void setAutoDelete(boolean autoDelete)
Turn automatic deletion on or off.
Automatic deletion is off by default.
Parameters: autoDelete true to turn automatic deletion on
UNKNOWN: Turn automatic deletion on or off.
protected void setError(int error)
public int status()
Returns the status of the file based on errno. (see errno.h)
0 means OK.
You should check the status after object creation to check
whether a file could be created in the first place.
You may check the status after closing the file to verify that
the file has indeed been written correctly.
Returns: the errno status, 0 means ok
UNKNOWN: Returns the status of the file based on errno.
public boolean sync()
Flushes file to disk (fsync).
If you want to be as sure as possible that the file data has
actually been physically stored on disk you need to call sync().
See status() for details about errors.
Returns: true if successful, or false if an error has occurred.
UNKNOWN: Flushes file to disk (fsync).
public QTextStream textStream()
Returns the QTextStream for writing.
Returns: QTextStream open for writing to the file, or 0
if opening the file failed
UNKNOWN: Returns the QTextStream for writing.
public void unlink()
Unlinks the file from the directory. The file is
deleted once the last reader/writer closes it.
UNKNOWN: Unlinks the file from the directory.