summaryrefslogtreecommitdiffstats
path: root/kdecore/ktempdir.h
diff options
context:
space:
mode:
Diffstat (limited to 'kdecore/ktempdir.h')
-rw-r--r--kdecore/ktempdir.h172
1 files changed, 0 insertions, 172 deletions
diff --git a/kdecore/ktempdir.h b/kdecore/ktempdir.h
deleted file mode 100644
index 491a14c4c..000000000
--- a/kdecore/ktempdir.h
+++ /dev/null
@@ -1,172 +0,0 @@
-/*
- This file is part of the KDE libraries
- Copyright (c) 2003 Joseph Wenninger <jowenn@kde.org>
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License version 2 as published by the Free Software Foundation.
-
- 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., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
-*/
-
-#ifndef _KTEMPDIR_H_
-#define _KTEMPDIR_H_
-
-#include <tqstring.h>
-#include <stdio.h>
-#include <errno.h>
-#include "kdelibs_export.h"
-
-class TQDir;
-class KTempDirPrivate;
-
-/**
- * The KTempDir class creates a unique directory for temporary use.
- *
- * This is especially useful if you need to create a directory in a world
- * writable directory like /tmp without being vulnerable to so called
- * symlink attacks.
- *
- * KDE applications, however, shouldn't create files or directories in /tmp in the first
- * place but use the "tmp" resource instead. The standard KTempDir
- * constructor will do that by default.
- *
- * To create a temporary directory that starts with a certain name
- * in the "tmp" resource, one should use:
- * KTempDir(locateLocal("tmp", prefix));
- *
- * KTempFile does not create any missing directories, but locateLocal() does.
- *
- * See also KStandardDirs
- *
- * @since 3.2
- * @author Joseph Wenninger <jowenn@kde.org>
- */
-class KDECORE_EXPORT KTempDir
-{
-public:
- /**
- * Creates a temporary directory with the name:
- * \p \<directoryPrefix\>\<six letters\>
- *
- * The default \p directoryPrefix is "$KDEHOME/tmp-$HOST/appname"
- * @param directoryPrefix the prefix of the file name, or
- * TQString::null for the default value
- * @param mode the file permissions,
- * almost always in octal. The first digit selects permissions for
- * the user who owns the file: read (4), write (2), and execute
- * (1); the second selects permissions for other users in the
- * file's group, with the same values; and the fourth for other
- * users not in the file's group, with the same values.
- *
- **/
- KTempDir(TQString directoryPrefix=TQString::null,
- int mode = 0700 );
-
-
- /**
- * The destructor deletes the directory and it's contents if autoDelete is enabled
- **/
- ~KTempDir();
-
- /**
- * Turn automatic deletion on or off.
- * Automatic deletion is off by default.
- * @param autoDelete true to turn automatic deletion on
- **/
- void setAutoDelete(bool autoDelete) { bAutoDelete = autoDelete; }
-
- /**
- * Returns the status of the directory creation based on errno. (see errno.h)
- * 0 means OK.
- *
- * You should check the status after object creation to check
- * whether a directory could be created in the first place.
- *
- * @return the errno status, 0 means ok
- **/
- int status() const;
-
- /**
- * Returns the full path and name of the directory, including a trailing '/'.
- * @return The name of the directory, or TQString::null if creating the
- * directory has failed or the directory has been unlinked
- **/
- TQString name() const;
-
-
- /**
- * Returns the TQDir* of the temporary directory.
- * @return TQDir directory information of the directory or 0 if their is no managed directory
- * The caller has to free the pointer open for writing to the
- **/
- TQDir *qDir();
-
- /**
- * Deletes the directory recursively
- **/
- void unlink();
-
- /**
- * @return true if a temporary directory has successfully been created and not been unlinked yet
- */
- bool existing() const;
-
- /**
- * @brief Remove a directory and all its contents
- *
- * Remove recursively a directory, even if it is not empty
- * or contains other directories.
- *
- * However the function works too when the @p path given
- * is a non-directory file. In that case it simply remove that file.
- *
- * The function stops on the first error.
- *
- * @note This function is more meant for removing a directory
- * not created by the user. For user-created directories,
- * using KIO::NetAccess::del is recommended instead,
- * especially as it has user feedback for long operations.
- *
- * @param path Path of the directory to delete
- * @return true if successful, otherwise false
- * (Use errno for more details about the error.)
- * @since 3.5.2
- */
- static bool removeDir( const TQString& path );
-
-protected:
-
- /**
- * Creates a "random" directory with specified mode
- * @param directoryPrefix to use when creating temp directory
- * (the rest is generated randomly)
- * @param mode directory permissions
- * @return bool true upon sucess
- */
- bool create(const TQString &directoryPrefix, int mode);
-
- /**
- * Sets the errno value
- * @param error the value to set the status to.
- */
- void setError(int error) { mError = error; }
-
-private:
- int mError;
- TQString mTmpName;
- bool bExisting;
- bool bAutoDelete;
-
- KTempDirPrivate *d;
-};
-
-#endif