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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html *
// * Copyright (C) 2008-2011 ZenJu (zhnmju123 AT gmx.de) *
// **************************************************************************
//
#include "recycler.h"
#include <stdexcept>
#include <iterator>
#include "i18n.h"
#ifdef FFS_WIN
#include "dll_loader.h"
#include <wx/msw/wrapwin.h> //includes "windows.h"
#include "build_info.h"
#include "assert_static.h"
#include <algorithm>
#include <functional>
#include <vector>
#include "long_path_prefix.h"
#include "IFileOperation/file_op.h"
#elif defined FFS_LINUX
#include <sys/stat.h>
#include <giomm/file.h>
#endif
using namespace zen;
namespace
{
#ifdef FFS_WIN
inline
std::wstring getRecyclerDllName()
{
assert_static(util::is32BitBuild || util::is64BitBuild);
return util::is64BitBuild ?
L"FileOperation_x64.dll":
L"FileOperation_Win32.dll";
}
bool vistaOrLater()
{
OSVERSIONINFO osvi = {};
ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
//IFileOperation is supported with Vista and later
if (GetVersionEx(&osvi))
return osvi.dwMajorVersion > 5;
//XP has majorVersion == 5, minorVersion == 1
//Vista has majorVersion == 6, minorVersion == 0
//version overview: http://msdn.microsoft.com/en-us/library/ms724834(VS.85).aspx
return false;
}
/*
Performance test: delete 1000 files
------------------------------------
SHFileOperation - single file 33s
SHFileOperation - multiple files 2,1s
IFileOperation - single file 33s
IFileOperation - multiple files 2,1s
=> SHFileOperation and IFileOperation have nearly IDENTICAL performance characteristics!
Nevertheless, let's use IFileOperation for better error reporting!
*/
void moveToWindowsRecycler(const std::vector<Zstring>& filesToDelete) //throw (FileError)
{
using zen::FileError;
if (filesToDelete.empty())
return;
static const bool useIFileOperation = vistaOrLater();
if (useIFileOperation) //new recycle bin usage: available since Vista
{
std::vector<const wchar_t*> fileNames;
std::transform(filesToDelete.begin(), filesToDelete.end(),
std::back_inserter(fileNames), std::mem_fun_ref(&Zstring::c_str));
using namespace fileop;
static MoveToRecycleBinFct moveToRecycler = NULL;
if (!moveToRecycler)
moveToRecycler = util::getDllFun<MoveToRecycleBinFct>(getRecyclerDllName(), moveToRecycleBinFctName);
static GetLastErrorFct getLastError = NULL;
if (!getLastError)
getLastError = util::getDllFun<GetLastErrorFct>(getRecyclerDllName(), getLastErrorFctName);
if (moveToRecycler == NULL || getLastError == NULL)
throw FileError(_("Error moving to Recycle Bin:") + "\n\"" + fileNames[0] + "\"" + //report first file only... better than nothing
"\n\n" + _("Could not load a required DLL:") + " \"" + getRecyclerDllName() + "\"");
//#warning moving long file paths to recycler does not work! clarify!
// std::vector<Zstring> temp;
// std::transform(filesToDelete.begin(), filesToDelete.end(),
// std::back_inserter(temp), std::ptr_fun(zen::removeLongPathPrefix)); //::IFileOperation() can't handle \\?\-prefix!
if (!moveToRecycler(&fileNames[0], //array must not be empty
fileNames.size()))
{
wchar_t errorMessage[2000];
getLastError(errorMessage, 2000);
throw FileError(_("Error moving to Recycle Bin:") + "\n\"" + fileNames[0] + "\"" + //report first file only... better than nothing
"\n\n" + "(" + errorMessage + ")");
}
}
else //regular recycle bin usage: available since XP
{
Zstring filenameDoubleNull;
for (std::vector<Zstring>::const_iterator i = filesToDelete.begin(); i != filesToDelete.end(); ++i)
{
//#warning moving long file paths to recycler does not work! clarify!
//filenameDoubleNull += removeLongPathPrefix(*i); //::SHFileOperation() can't handle \\?\-prefix!
//You should use fully-qualified path names with this function. Using it with relative path names is not thread safe.
filenameDoubleNull += *i; //::SHFileOperation() can't handle \\?\-prefix!
filenameDoubleNull += Zchar(0);
}
SHFILEOPSTRUCT fileOp = {};
fileOp.hwnd = NULL;
fileOp.wFunc = FO_DELETE;
fileOp.pFrom = filenameDoubleNull.c_str();
fileOp.pTo = NULL;
fileOp.fFlags = FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_SILENT | FOF_NOERRORUI;
fileOp.fAnyOperationsAborted = false;
fileOp.hNameMappings = NULL;
fileOp.lpszProgressTitle = NULL;
if (::SHFileOperation(&fileOp) != 0 || fileOp.fAnyOperationsAborted)
{
throw FileError(_("Error moving to Recycle Bin:") + "\n\"" + filenameDoubleNull.c_str() + "\""); //report first file only... better than nothing
}
}
}
#endif
}
bool zen::moveToRecycleBin(const Zstring& fileToDelete) //throw (FileError)
{
#ifdef FFS_WIN
const Zstring filenameFmt = applyLongPathPrefix(fileToDelete);
const DWORD attr = ::GetFileAttributes(filenameFmt.c_str());
if (attr == INVALID_FILE_ATTRIBUTES)
return false; //neither file nor any other object with that name existing: no error situation, manual deletion relies on it!
//::SetFileAttributes(filenameFmt.c_str(), FILE_ATTRIBUTE_NORMAL);
//both SHFileOperation and useIFileOperation are not able to delete a folder named "System Volume Information" with normal attributes but shamelessly report success
std::vector<Zstring> fileNames;
fileNames.push_back(fileToDelete);
::moveToWindowsRecycler(fileNames); //throw (FileError)
#elif defined FFS_LINUX
struct stat fileInfo = {};
if (::lstat(fileToDelete.c_str(), &fileInfo) != 0)
return false; //neither file nor any other object with that name existing: no error situation, manual deletion relies on it!
Glib::RefPtr<Gio::File> fileObj = Gio::File::create_for_path(fileToDelete.c_str()); //never fails
try
{
if (!fileObj->trash())
throw FileError(_("Error moving to Recycle Bin:") + "\n\"" + fileToDelete + "\"" +
"\n\n" + "(unknown error)");
}
catch (const Glib::Error& errorObj)
{
//assemble error message
const std::wstring errorMessage = L"Glib Error Code " + toString<std::wstring>(errorObj.code()) + ", " +
g_quark_to_string(errorObj.domain()) + ": " + errorObj.what();
throw FileError(_("Error moving to Recycle Bin:") + "\n\"" + fileToDelete + "\"" +
"\n\n" + "(" + errorMessage + ")");
}
#endif
return true;
}
#ifdef FFS_WIN
zen::StatusRecycler zen::recycleBinExists(const Zstring& pathName)
{
std::vector<wchar_t> buffer(MAX_PATH + 1);
if (::GetVolumePathName(applyLongPathPrefix(pathName).c_str(), //__in LPCTSTR lpszFileName,
&buffer[0], //__out LPTSTR lpszVolumePathName,
static_cast<DWORD>(buffer.size()))) //__in DWORD cchBufferLength
{
Zstring rootPath =&buffer[0];
if (!rootPath.EndsWith(FILE_NAME_SEPARATOR)) //a trailing backslash is required
rootPath += FILE_NAME_SEPARATOR;
SHQUERYRBINFO recInfo = {};
recInfo.cbSize = sizeof(recInfo);
HRESULT rv = ::SHQueryRecycleBin(rootPath.c_str(), //__in_opt LPCTSTR pszRootPath,
&recInfo); //__inout LPSHQUERYRBINFO pSHQueryRBInfo
return rv == S_OK ? STATUS_REC_EXISTS : STATUS_REC_MISSING;
}
return STATUS_REC_UNKNOWN;
}
#endif
|
