1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* This file is part of the KDE project
Copyright (C) 2004 David Faure <[email protected]>
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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef TRASHIMPL_H
#define TRASHIMPL_H
#include <kio/jobclasses.h>
#include <ksimpleconfig.h>
#include <qstring.h>
#include <qdatetime.h>
#include <qmap.h>
#include <qvaluelist.h>
#include <qstrlist.h>
#include <assert.h>
/**
* Implementation of all low-level operations done by kio_trash
* The structure of the trash directory follows the freedesktop.org standard <TODO URL>
*/
class TrashImpl : public QObject
{
Q_OBJECT
public:
TrashImpl();
/// Check the "home" trash directory
/// This MUST be called before doing anything else
bool init();
/// Create info for a file to be trashed
/// Returns trashId and fileId
/// The caller is then responsible for actually trashing the file
bool createInfo( const QString& origPath, int& trashId, QString& fileId );
/// Delete info file for a file to be trashed
/// Usually used for undoing what createInfo did if trashing failed
bool deleteInfo( int trashId, const QString& fileId );
/// Moving a file or directory into the trash. The ids come from createInfo.
bool moveToTrash( const QString& origPath, int trashId, const QString& fileId );
/// Moving a file or directory out of the trash. The ids come from createInfo.
bool moveFromTrash( const QString& origPath, int trashId, const QString& fileId, const QString& relativePath );
/// Copying a file or directory into the trash. The ids come from createInfo.
bool copyToTrash( const QString& origPath, int trashId, const QString& fileId );
/// Copying a file or directory out of the trash. The ids come from createInfo.
bool copyFromTrash( const QString& origPath, int trashId, const QString& fileId, const QString& relativePath );
/// Create a top-level trashed directory
//bool mkdir( int trashId, const QString& fileId, int permissions );
/// Get rid of a trashed file
bool del( int trashId, const QString& fileId );
/// Empty trash, i.e. delete all trashed files
bool emptyTrash();
/// Return true if the trash is empty
bool isEmpty() const;
struct TrashedFileInfo {
int trashId; // for the url
QString fileId; // for the url
QString physicalPath; // for stat'ing etc.
QString origPath; // from info file
QDateTime deletionDate; // from info file
};
/// List trashed files
typedef QValueList<TrashedFileInfo> TrashedFileInfoList;
TrashedFileInfoList list();
/// Return the info for a given trashed file
bool infoForFile( int trashId, const QString& fileId, TrashedFileInfo& info );
/// Return the physicalPath for a given trashed file - helper method which
/// encapsulates the call to infoForFile. Don't use if you need more info from TrashedFileInfo.
QString physicalPath( int trashId, const QString& fileId, const QString& relativePath );
/// Move data from the old trash system to the new one
void migrateOldTrash();
/// KIO error code
int lastErrorCode() const { return m_lastErrorCode; }
QString lastErrorMessage() const { return m_lastErrorMessage; }
QStrList listDir( const QString& physicalPath );
static KURL makeURL( int trashId, const QString& fileId, const QString& relativePath );
static bool parseURL( const KURL& url, int& trashId, QString& fileId, QString& relativePath );
typedef QMap<int, QString> TrashDirMap;
/// @internal This method is for TestTrash only. Home trash is included (id 0).
TrashDirMap trashDirectories() const;
/// @internal This method is for TestTrash only. No entry with id 0.
TrashDirMap topDirectories() const;
private:
/// Helper method. Moves a file or directory using the appropriate method.
bool move( const QString& src, const QString& dest );
bool copy( const QString& src, const QString& dest );
/// Helper method. Tries to call ::rename(src,dest) and does error handling.
bool directRename( const QString& src, const QString& dest );
void fileAdded();
void fileRemoved();
// Warning, returns error code, not a bool
int testDir( const QString& name ) const;
void error( int e, const QString& s );
bool readInfoFile( const QString& infoPath, TrashedFileInfo& info, int trashId );
QString infoPath( int trashId, const QString& fileId ) const;
QString filesPath( int trashId, const QString& fileId ) const;
/// Find the trash dir to use for a given file to delete, based on original path
int findTrashDirectory( const QString& origPath );
QString trashDirectoryPath( int trashId ) const;
QString topDirectoryPath( int trashId ) const;
bool synchronousDel( const QString& path, bool setLastErrorCode, bool isDir );
void scanTrashDirectories() const;
int idForTrashDirectory( const QString& trashDir ) const;
bool initTrashDirectory( const QCString& trashDir_c ) const;
bool checkTrashSubdirs( const QCString& trashDir_c ) const;
QString trashForMountPoint( const QString& topdir, bool createIfNeeded ) const;
static QString makeRelativePath( const QString& topdir, const QString& path );
private slots:
void jobFinished(KIO::Job *job);
private:
/// Last error code stored in class to simplify API.
/// Note that this means almost no method can be const.
int m_lastErrorCode;
QString m_lastErrorMessage;
enum { InitToBeDone, InitOK, InitError } m_initStatus;
// A "trash directory" is a physical directory on disk,
// e.g. $HOME/.local/share/Trash/$uid or /mnt/foo/.Trash/$uid
// It has an id (number) and a path.
// The home trash has id 0.
mutable TrashDirMap m_trashDirectories; // id -> path of trash directory
mutable TrashDirMap m_topDirectories; // id -> $topdir of partition
mutable int m_lastId;
dev_t m_homeDevice;
mutable bool m_trashDirectoriesScanned;
int m_mibEnum;
KSimpleConfig m_config;
// We don't cache any data related to the trashed files.
// Another kioslave could change that behind our feet.
// If we want to start caching data - and avoiding some race conditions -,
// we should turn this class into a kded module and use DCOP to talk to it
// from the kioslave.
};
#endif
|
