VFSExplorerImpl.cpp@ 63378

Last change on this file since 63378 was 63378, checked in by vboxsync, 8 years ago
Main: warnings (gcc)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 14.2 KB

Line
1	/* $Id: VFSExplorerImpl.cpp 63378 2016-08-12 18:29:33Z vboxsync $ */
2	/** @file
3	* IVFSExplorer COM class implementations.
4	*/
5
6	/*
7	* Copyright (C) 2009-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#include <iprt/dir.h>
19	#include <iprt/path.h>
20	#include <iprt/file.h>
21	#include <iprt/s3.h>
22	#include <iprt/cpp/utils.h>
23
24	#include <VBox/com/array.h>
25
26	#include <VBox/param.h>
27	#include <VBox/version.h>
28
29	#include "VFSExplorerImpl.h"
30	#include "VirtualBoxImpl.h"
31	#include "ProgressImpl.h"
32
33	#include "AutoCaller.h"
34	#include "Logging.h"
35	#include "ThreadTask.h"
36
37	#include <memory>
38
39	struct VFSExplorer::Data
40	{
41	struct DirEntry
42	{
43	DirEntry(Utf8Str strName, FsObjType_T fileType, uint64_t cbSize, uint32_t fMode)
44	: name(strName)
45	, type(fileType)
46	, size(cbSize)
47	, mode(fMode) {}
48
49	Utf8Str name;
50	FsObjType_T type;
51	uint64_t size;
52	uint32_t mode;
53	};
54
55	VFSType_T storageType;
56	Utf8Str strUsername;
57	Utf8Str strPassword;
58	Utf8Str strHostname;
59	Utf8Str strPath;
60	Utf8Str strBucket;
61	std::list<DirEntry> entryList;
62	};
63
64
65	VFSExplorer::VFSExplorer()
66	: mVirtualBox(NULL)
67	{
68	}
69
70	VFSExplorer::~VFSExplorer()
71	{
72	}
73
74
75	/**
76	* VFSExplorer COM initializer.
77	* @param
78	* @return
79	*/
80	HRESULT VFSExplorer::init(VFSType_T aType, Utf8Str aFilePath, Utf8Str aHostname, Utf8Str aUsername,
81	Utf8Str aPassword, VirtualBox *aVirtualBox)
82	{
83	/* Enclose the state transition NotReady->InInit->Ready */
84	AutoInitSpan autoInitSpan(this);
85	AssertReturn(autoInitSpan.isOk(), E_FAIL);
86
87	/* Weak reference to a VirtualBox object */
88	unconst(mVirtualBox) = aVirtualBox;
89
90	/* initialize data */
91	m = new Data;
92
93	m->storageType = aType;
94	m->strPath = aFilePath;
95	m->strHostname = aHostname;
96	m->strUsername = aUsername;
97	m->strPassword = aPassword;
98
99	if (m->storageType == VFSType_S3)
100	{
101	size_t bpos = aFilePath.find("/", 1);
102	if (bpos != Utf8Str::npos)
103	{
104	m->strBucket = aFilePath.substr(1, bpos - 1); /* The bucket without any slashes */
105	aFilePath = aFilePath.substr(bpos); /* The rest of the file path */
106	}
107	}
108
109	/* Confirm a successful initialization */
110	autoInitSpan.setSucceeded();
111
112	return S_OK;
113	}
114
115	/**
116	* VFSExplorer COM uninitializer.
117	* @return
118	*/
119	void VFSExplorer::uninit()
120	{
121	delete m;
122	m = NULL;
123	}
124
125	/**
126	* Public method implementation.
127	* @param
128	* @return
129	*/
130	HRESULT VFSExplorer::getPath(com::Utf8Str &aPath)
131	{
132	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
133
134	aPath = m->strPath;
135
136	return S_OK;
137	}
138
139
140	HRESULT VFSExplorer::getType(VFSType_T *aType)
141	{
142	if (!aType)
143	return E_POINTER;
144
145	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
146
147	*aType = m->storageType;
148
149	return S_OK;
150	}
151
152	class VFSExplorer::TaskVFSExplorer : public ThreadTask
153	{
154	public:
155	enum TaskType
156	{
157	Update,
158	Delete
159	};
160
161	TaskVFSExplorer(TaskType aTaskType, VFSExplorer aThat, Progress aProgress)
162	: m_taskType(aTaskType),
163	m_pVFSExplorer(aThat),
164	m_ptrProgress(aProgress),
165	m_rc(S_OK)
166	{
167	m_strTaskName = "Explorer::Task";
168	}
169	~TaskVFSExplorer() {}
170
171	private:
172	void handler();
173
174	#if 0 /* unused */
175	static DECLCALLBACK(int) uploadProgress(unsigned uPercent, void *pvUser);
176	#endif
177
178	TaskType m_taskType;
179	VFSExplorer *m_pVFSExplorer;
180
181	ComObjPtr<Progress> m_ptrProgress;
182	HRESULT m_rc;
183
184	/* task data */
185	std::list<Utf8Str> m_lstFilenames;
186
187	friend class VFSExplorer;
188	};
189
190	/* static */
191	void VFSExplorer::TaskVFSExplorer::handler()
192	{
193	VFSExplorer *pVFSExplorer = this->m_pVFSExplorer;
194
195	LogFlowFuncEnter();
196	LogFlowFunc(("VFSExplorer %p\n", pVFSExplorer));
197
198	HRESULT rc = S_OK;
199
200	switch (this->m_taskType)
201	{
202	case TaskVFSExplorer::Update:
203	{
204	if (pVFSExplorer->m->storageType == VFSType_File)
205	rc = pVFSExplorer->i_updateFS(this);
206	else if (pVFSExplorer->m->storageType == VFSType_S3)
207	rc = VERR_NOT_IMPLEMENTED;
208	break;
209	}
210	case TaskVFSExplorer::Delete:
211	{
212	if (pVFSExplorer->m->storageType == VFSType_File)
213	rc = pVFSExplorer->i_deleteFS(this);
214	else if (pVFSExplorer->m->storageType == VFSType_S3)
215	rc = VERR_NOT_IMPLEMENTED;
216	break;
217	}
218	default:
219	AssertMsgFailed(("Invalid task type %u specified!\n", this->m_taskType));
220	break;
221	}
222
223	LogFlowFunc(("rc=%Rhrc\n", rc)); NOREF(rc);
224	LogFlowFuncLeave();
225	}
226
227	#if 0 /* unused */
228	/* static */
229	DECLCALLBACK(int) VFSExplorer::TaskVFSExplorer::uploadProgress(unsigned uPercent, void *pvUser)
230	{
231	VFSExplorer::TaskVFSExplorer* pTask = (VFSExplorer::TaskVFSExplorer*)pvUser;
232
233	if (pTask &&
234	!pTask->m_ptrProgress.isNull())
235	{
236	BOOL fCanceled;
237	pTask->m_ptrProgress->COMGETTER(Canceled)(&fCanceled);
238	if (fCanceled)
239	return -1;
240	pTask->m_ptrProgress->SetCurrentOperationProgress(uPercent);
241	}
242	return VINF_SUCCESS;
243	}
244	#endif
245
246	FsObjType_T VFSExplorer::i_iprtToVfsObjType(RTFMODE aType) const
247	{
248	int a = aType & RTFS_TYPE_MASK;
249	FsObjType_T t = FsObjType_Unknown;
250	if ((a & RTFS_TYPE_DIRECTORY) == RTFS_TYPE_DIRECTORY)
251	t = FsObjType_Directory;
252	else if ((a & RTFS_TYPE_FILE) == RTFS_TYPE_FILE)
253	t = FsObjType_File;
254	else if ((a & RTFS_TYPE_SYMLINK) == RTFS_TYPE_SYMLINK)
255	t = FsObjType_Symlink;
256	else if ((a & RTFS_TYPE_FIFO) == RTFS_TYPE_FIFO)
257	t = FsObjType_Fifo;
258	else if ((a & RTFS_TYPE_DEV_CHAR) == RTFS_TYPE_DEV_CHAR)
259	t = FsObjType_DevChar;
260	else if ((a & RTFS_TYPE_DEV_BLOCK) == RTFS_TYPE_DEV_BLOCK)
261	t = FsObjType_DevBlock;
262	else if ((a & RTFS_TYPE_SOCKET) == RTFS_TYPE_SOCKET)
263	t = FsObjType_Socket;
264	else if ((a & RTFS_TYPE_WHITEOUT) == RTFS_TYPE_WHITEOUT)
265	t = FsObjType_WhiteOut;
266
267	return t;
268	}
269
270	HRESULT VFSExplorer::i_updateFS(TaskVFSExplorer *aTask)
271	{
272	LogFlowFuncEnter();
273
274	AutoCaller autoCaller(this);
275	if (FAILED(autoCaller.rc())) return autoCaller.rc();
276
277	AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
278
279	HRESULT rc = S_OK;
280
281	std::list<VFSExplorer::Data::DirEntry> fileList;
282	char *pszPath = NULL;
283	PRTDIR pDir = NULL;
284	try
285	{
286	int vrc = RTDirOpen(&pDir, m->strPath.c_str());
287	if (RT_FAILURE(vrc))
288	throw setError(VBOX_E_FILE_ERROR, tr ("Can't open directory '%s' (%Rrc)"), pszPath, vrc);
289
290	if (aTask->m_ptrProgress)
291	aTask->m_ptrProgress->SetCurrentOperationProgress(33);
292	RTDIRENTRYEX entry;
293	while (RT_SUCCESS(vrc))
294	{
295	vrc = RTDirReadEx(pDir, &entry, NULL, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
296	if (RT_SUCCESS(vrc))
297	{
298	Utf8Str name(entry.szName);
299	if ( name != "."
300	&& name != "..")
301	fileList.push_back(VFSExplorer::Data::DirEntry(name, i_iprtToVfsObjType(entry.Info.Attr.fMode),
302	entry.Info.cbObject,
303	entry.Info.Attr.fMode & (RTFS_UNIX_IRWXU \| RTFS_UNIX_IRWXG \| RTFS_UNIX_IRWXO)));
304	}
305	}
306	if (aTask->m_ptrProgress)
307	aTask->m_ptrProgress->SetCurrentOperationProgress(66);
308	}
309	catch(HRESULT aRC)
310	{
311	rc = aRC;
312	}
313
314	/* Clean up */
315	if (pszPath)
316	RTStrFree(pszPath);
317	if (pDir)
318	RTDirClose(pDir);
319
320	if (aTask->m_ptrProgress)
321	aTask->m_ptrProgress->SetCurrentOperationProgress(99);
322
323	/* Assign the result on success (this clears the old list) */
324	if (rc == S_OK)
325	m->entryList.assign(fileList.begin(), fileList.end());
326
327	aTask->m_rc = rc;
328
329	if (!aTask->m_ptrProgress.isNull())
330	aTask->m_ptrProgress->i_notifyComplete(rc);
331
332	LogFlowFunc(("rc=%Rhrc\n", rc));
333	LogFlowFuncLeave();
334
335	return VINF_SUCCESS;
336	}
337
338	HRESULT VFSExplorer::i_deleteFS(TaskVFSExplorer *aTask)
339	{
340	LogFlowFuncEnter();
341
342	AutoCaller autoCaller(this);
343	if (FAILED(autoCaller.rc())) return autoCaller.rc();
344
345	AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
346
347	HRESULT rc = S_OK;
348
349	float fPercentStep = 100.0f / (float)aTask->m_lstFilenames.size();
350	try
351	{
352	char szPath[RTPATH_MAX];
353	std::list<Utf8Str>::const_iterator it;
354	size_t i = 0;
355	for (it = aTask->m_lstFilenames.begin();
356	it != aTask->m_lstFilenames.end();
357	++it, ++i)
358	{
359	int vrc = RTPathJoin(szPath, sizeof(szPath), m->strPath.c_str(), (*it).c_str());
360	if (RT_FAILURE(vrc))
361	throw setError(E_FAIL, tr("Internal Error (%Rrc)"), vrc);
362	vrc = RTFileDelete(szPath);
363	if (RT_FAILURE(vrc))
364	throw setError(VBOX_E_FILE_ERROR, tr("Can't delete file '%s' (%Rrc)"), szPath, vrc);
365	if (aTask->m_ptrProgress)
366	aTask->m_ptrProgress->SetCurrentOperationProgress((ULONG)(fPercentStep * (float)i));
367	}
368	}
369	catch (HRESULT aRC)
370	{
371	rc = aRC;
372	}
373
374	aTask->m_rc = rc;
375
376	if (aTask->m_ptrProgress.isNotNull())
377	aTask->m_ptrProgress->i_notifyComplete(rc);
378
379	LogFlowFunc(("rc=%Rhrc\n", rc));
380	LogFlowFuncLeave();
381
382	return VINF_SUCCESS;
383	}
384
385	HRESULT VFSExplorer::update(ComPtr<IProgress> &aProgress)
386	{
387	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
388
389	HRESULT rc = S_OK;
390
391	ComObjPtr<Progress> progress;
392	try
393	{
394	Bstr progressDesc = BstrFmt(tr("Update directory info for '%s'"),
395	m->strPath.c_str());
396	/* Create the progress object */
397	progress.createObject();
398
399	rc = progress->init(mVirtualBox,
400	static_cast<IVFSExplorer*>(this),
401	progressDesc.raw(),
402	TRUE /* aCancelable */);
403	if (FAILED(rc)) throw rc;
404
405	/* Initialize our worker task */
406	TaskVFSExplorer* pTask = new TaskVFSExplorer(TaskVFSExplorer::Update, this, progress);
407
408	//this function delete task in case of exceptions, so there is no need in the call of delete operator
409	rc = pTask->createThreadWithType(RTTHREADTYPE_MAIN_HEAVY_WORKER);
410	}
411	catch (HRESULT aRC)
412	{
413	rc = aRC;
414	}
415
416	if (SUCCEEDED(rc))
417	/* Return progress to the caller */
418	progress.queryInterfaceTo(aProgress.asOutParam());
419
420	return rc;
421	}
422
423	HRESULT VFSExplorer::cd(const com::Utf8Str &aDir, ComPtr<IProgress> &aProgress)
424	{
425	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
426	m->strPath = aDir;
427	return update(aProgress);
428	}
429
430	HRESULT VFSExplorer::cdUp(ComPtr<IProgress> &aProgress)
431	{
432	Utf8Str strUpPath;
433	{
434	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
435	/* Remove lowest dir entry in a platform neutral way. */
436	char *pszNewPath = RTStrDup(m->strPath.c_str());
437	RTPathStripTrailingSlash(pszNewPath);
438	RTPathStripFilename(pszNewPath);
439	strUpPath = pszNewPath;
440	RTStrFree(pszNewPath);
441	}
442
443	return cd(strUpPath, aProgress);
444	}
445
446	HRESULT VFSExplorer::entryList(std::vector<com::Utf8Str> &aNames,
447	std::vector<ULONG> &aTypes,
448	std::vector<LONG64> &aSizes,
449	std::vector<ULONG> &aModes)
450	{
451	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
452	aNames.resize(m->entryList.size());
453	aTypes.resize(m->entryList.size());
454	aSizes.resize(m->entryList.size());
455	aModes.resize(m->entryList.size());
456
457	std::list<VFSExplorer::Data::DirEntry>::const_iterator it;
458	size_t i = 0;
459	for (it = m->entryList.begin();
460	it != m->entryList.end();
461	++it, ++i)
462	{
463	const VFSExplorer::Data::DirEntry &entry = (*it);
464	aNames[i] = entry.name;
465	aTypes[i] = entry.type;
466	aSizes[i] = entry.size;
467	aModes[i] = entry.mode;
468	}
469
470	return S_OK;
471	}
472
473	HRESULT VFSExplorer::exists(const std::vector<com::Utf8Str> &aNames,
474	std::vector<com::Utf8Str> &aExists)
475	{
476
477	AutoCaller autoCaller(this);
478	if (FAILED(autoCaller.rc())) return autoCaller.rc();
479
480	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
481	aExists.resize(0);
482	for (size_t i=0; i < aNames.size(); ++i)
483	{
484	std::list<VFSExplorer::Data::DirEntry>::const_iterator it;
485	for (it = m->entryList.begin();
486	it != m->entryList.end();
487	++it)
488	{
489	const VFSExplorer::Data::DirEntry &entry = (*it);
490	if (entry.name == RTPathFilename(aNames[i].c_str()))
491	aExists.push_back(aNames[i]);
492	}
493	}
494
495	return S_OK;
496	}
497
498	HRESULT VFSExplorer::remove(const std::vector<com::Utf8Str> &aNames,
499	ComPtr<IProgress> &aProgress)
500	{
501	AutoCaller autoCaller(this);
502	if (FAILED(autoCaller.rc())) return autoCaller.rc();
503
504	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
505
506	HRESULT rc = S_OK;
507
508	ComObjPtr<Progress> progress;
509	try
510	{
511	/* Create the progress object */
512	progress.createObject();
513
514	rc = progress->init(mVirtualBox, static_cast<IVFSExplorer*>(this),
515	Bstr(tr("Delete files")).raw(),
516	TRUE /* aCancelable */);
517	if (FAILED(rc)) throw rc;
518
519	/* Initialize our worker task */
520	TaskVFSExplorer* pTask = new TaskVFSExplorer(TaskVFSExplorer::Delete, this, progress);
521
522	/* Add all filenames to delete as task data */
523	for (size_t i = 0; i < aNames.size(); ++i)
524	pTask->m_lstFilenames.push_back(aNames[i]);
525
526	//this function delete task in case of exceptions, so there is no need in the call of delete operator
527	rc = pTask->createThreadWithType(RTTHREADTYPE_MAIN_HEAVY_WORKER);
528	}
529	catch (HRESULT aRC)
530	{
531	rc = aRC;
532	}
533
534	if (SUCCEEDED(rc))
535	/* Return progress to the caller */
536	progress.queryInterfaceTo(aProgress.asOutParam());
537
538	return rc;
539	}
540

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-server/VFSExplorerImpl.cpp@ 63378

Download in other formats: