1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/volume.cpp
3 // Purpose: wxFSVolume - encapsulates system volume information
4 // Author: George Policello
8 // Copyright: (c) 2002 George Policello
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "fsvolume.h"
24 #include "wx/wxprec.h"
40 #include "wx/hashmap.h"
41 #include "wx/dynlib.h"
42 #include "wx/arrimpl.cpp"
44 #include "wx/volume.h"
48 #include "wx/msw/missing.h"
52 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
53 // Dynamic library function defs.
54 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
56 static wxDynamicLibrary s_mprLib
;
58 typedef DWORD (WINAPI
* WNetOpenEnumPtr
)(DWORD
, DWORD
, DWORD
, LPNETRESOURCE
, LPHANDLE
);
59 typedef DWORD (WINAPI
* WNetEnumResourcePtr
)(HANDLE
, LPDWORD
, LPVOID
, LPDWORD
);
60 typedef DWORD (WINAPI
* WNetCloseEnumPtr
)(HANDLE
);
62 static WNetOpenEnumPtr s_pWNetOpenEnum
;
63 static WNetEnumResourcePtr s_pWNetEnumResource
;
64 static WNetCloseEnumPtr s_pWNetCloseEnum
;
66 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
68 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
69 static long s_cancelSearch
= FALSE
;
73 FileInfo(unsigned flag
=0, wxFSVolumeKind type
=wxFS_VOL_OTHER
) :
74 m_flags(flag
), m_type(type
) {}
76 FileInfo(const FileInfo
& other
) { *this = other
; }
77 FileInfo
& operator=(const FileInfo
& other
)
79 m_flags
= other
.m_flags
;
80 m_type
= other
.m_type
;
85 wxFSVolumeKind m_type
;
87 WX_DECLARE_STRING_HASH_MAP(FileInfo
, FileInfoMap
);
88 // Cygwin bug (?) destructor for global s_fileInfo is called twice...
89 static FileInfoMap
& GetFileInfoMap()
91 static FileInfoMap
s_fileInfo(25);
95 #define s_fileInfo (GetFileInfoMap())
97 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
98 // Local helper functions.
99 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
101 //=============================================================================
102 // Function: GetBasicFlags
103 // Purpose: Set basic flags, primarily wxFS_VOL_REMOTE and wxFS_VOL_REMOVABLE.
104 // Notes: - Local and mapped drives are mounted by definition. We have no
105 // way to determine mounted status of network drives, so assume that
106 // all drives are mounted, and let the caller decide otherwise.
107 // - Other flags are 'best guess' from type of drive. The system will
108 // not report the file attributes with any degree of accuracy.
109 //=============================================================================
110 static unsigned GetBasicFlags(const wxChar
* filename
)
112 unsigned flags
= wxFS_VOL_MOUNTED
;
114 //----------------------------------
115 // 'Best Guess' based on drive type.
116 //----------------------------------
118 switch(GetDriveType(filename
))
121 type
= wxFS_VOL_DISK
;
124 case DRIVE_REMOVABLE
:
125 flags
|= wxFS_VOL_REMOVABLE
;
126 type
= wxFS_VOL_FLOPPY
;
130 flags
|= wxFS_VOL_REMOVABLE
| wxFS_VOL_READONLY
;
131 type
= wxFS_VOL_CDROM
;
135 flags
|= wxFS_VOL_REMOTE
;
136 type
= wxFS_VOL_NETWORK
;
139 case DRIVE_NO_ROOT_DIR
:
140 flags
&= ~wxFS_VOL_MOUNTED
;
141 type
= wxFS_VOL_OTHER
;
145 type
= wxFS_VOL_OTHER
;
149 //-----------------------------------------------------------------------
150 // The following will most likely will not modify anything not set above,
151 // and will not work at all for network shares or empty CD ROM drives.
152 // But it is a good check if the Win API ever gets better about reporting
154 //-----------------------------------------------------------------------
157 rc
= SHGetFileInfo(filename
, 0, &fi
, sizeof(fi
), SHGFI_ATTRIBUTES
);
160 wxLogError(_("Cannot read typename from '%s'!"), filename
);
164 if (fi
.dwAttributes
& SFGAO_READONLY
)
165 flags
|= wxFS_VOL_READONLY
;
166 if (fi
.dwAttributes
& SFGAO_REMOVABLE
)
167 flags
|= wxFS_VOL_REMOVABLE
;
173 s_fileInfo
[filename
] = FileInfo(flags
, type
);
178 //=============================================================================
179 // Function: FilteredAdd
180 // Purpose: Add a file to the list if it meets the filter requirement.
181 // Notes: - See GetBasicFlags for remarks about the Mounted flag.
182 //=============================================================================
183 static bool FilteredAdd(wxArrayString
& list
, const wxChar
* filename
,
184 unsigned flagsSet
, unsigned flagsUnset
)
187 unsigned flags
= GetBasicFlags(filename
);
189 if (flagsSet
& wxFS_VOL_MOUNTED
&& !(flags
& wxFS_VOL_MOUNTED
))
191 else if (flagsUnset
& wxFS_VOL_MOUNTED
&& (flags
& wxFS_VOL_MOUNTED
))
193 else if (flagsSet
& wxFS_VOL_REMOVABLE
&& !(flags
& wxFS_VOL_REMOVABLE
))
195 else if (flagsUnset
& wxFS_VOL_REMOVABLE
&& (flags
& wxFS_VOL_REMOVABLE
))
197 else if (flagsSet
& wxFS_VOL_READONLY
&& !(flags
& wxFS_VOL_READONLY
))
199 else if (flagsUnset
& wxFS_VOL_READONLY
&& (flags
& wxFS_VOL_READONLY
))
201 else if (flagsSet
& wxFS_VOL_REMOTE
&& !(flags
& wxFS_VOL_REMOTE
))
203 else if (flagsUnset
& wxFS_VOL_REMOTE
&& (flags
& wxFS_VOL_REMOTE
))
206 // Add to the list if passed the filter.
213 //=============================================================================
214 // Function: BuildListFromNN
215 // Purpose: Append or remove items from the list
216 // Notes: - There is no way to find all disconnected NN items, or even to find
217 // all items while determining which are connected and not. So this
218 // function will find either all items or connected items.
219 //=============================================================================
220 static void BuildListFromNN(wxArrayString
& list
, NETRESOURCE
* pResSrc
,
221 unsigned flagsSet
, unsigned flagsUnset
)
226 //-----------------------------------------------
227 // Scope may be all drives or all mounted drives.
228 //-----------------------------------------------
229 unsigned scope
= RESOURCE_GLOBALNET
;
230 if (flagsSet
& wxFS_VOL_MOUNTED
)
231 scope
= RESOURCE_CONNECTED
;
233 //----------------------------------------------------------------------
234 // Enumerate all items, adding only non-containers (ie. network shares).
235 // Containers cause a recursive call to this function for their own
237 //----------------------------------------------------------------------
238 if (rc
= s_pWNetOpenEnum(scope
, RESOURCETYPE_DISK
, 0, pResSrc
, &hEnum
), rc
== NO_ERROR
)
242 NETRESOURCE
* pRes
= (NETRESOURCE
*)malloc(size
);
243 memset(pRes
, 0, sizeof(NETRESOURCE
));
244 while (rc
= s_pWNetEnumResource(hEnum
, &count
, pRes
, &size
), rc
== NO_ERROR
|| rc
== ERROR_MORE_DATA
)
249 if (rc
== ERROR_MORE_DATA
)
251 pRes
= (NETRESOURCE
*)realloc(pRes
, size
);
256 // Enumerate the container.
257 if (pRes
->dwUsage
& RESOURCEUSAGE_CONTAINER
)
259 BuildListFromNN(list
, pRes
, flagsSet
, flagsUnset
);
262 // Add the network share.
265 wxString
filename(pRes
->lpRemoteName
);
269 if (filename
.Last() != '\\')
270 filename
.Append('\\');
272 // The filter function will not know mounted from unmounted, and neither do we unless
273 // we are iterating using RESOURCE_CONNECTED, in which case they all are mounted.
274 // Volumes on disconnected servers, however, will correctly show as unmounted.
275 FilteredAdd(list
, filename
, flagsSet
, flagsUnset
&~wxFS_VOL_MOUNTED
);
276 if (scope
== RESOURCE_GLOBALNET
)
277 s_fileInfo
[filename
].m_flags
&= ~wxFS_VOL_MOUNTED
;
285 s_pWNetCloseEnum(hEnum
);
289 //=============================================================================
290 // Function: CompareFcn
291 // Purpose: Used to sort the NN list alphabetically, case insensitive.
292 //=============================================================================
293 static int CompareFcn(const wxString
& first
, const wxString
& second
)
295 return wxStricmp(first
.c_str(), second
.c_str());
298 //=============================================================================
299 // Function: BuildRemoteList
300 // Purpose: Append Network Neighborhood items to the list.
301 // Notes: - Mounted gets transalated into Connected. FilteredAdd is told
302 // to ignore the Mounted flag since we need to handle it in a weird
304 // - The resulting list is sorted alphabetically.
305 //=============================================================================
306 static bool BuildRemoteList(wxArrayString
& list
, NETRESOURCE
* pResSrc
,
307 unsigned flagsSet
, unsigned flagsUnset
)
309 // NN query depends on dynamically loaded library.
310 if (!s_pWNetOpenEnum
|| !s_pWNetEnumResource
|| !s_pWNetCloseEnum
)
312 wxLogError(_("Failed to load mpr.dll."));
316 // Don't waste time doing the work if the flags conflict.
317 if (flagsSet
& wxFS_VOL_MOUNTED
&& flagsUnset
& wxFS_VOL_MOUNTED
)
320 //----------------------------------------------
321 // Generate the list according to the flags set.
322 //----------------------------------------------
323 BuildListFromNN(list
, pResSrc
, flagsSet
, flagsUnset
);
324 list
.Sort(CompareFcn
);
326 //-------------------------------------------------------------------------
327 // If mounted only is requested, then we only need one simple pass.
328 // Otherwise, we need to build a list of all NN volumes and then apply the
329 // list of mounted drives to it.
330 //-------------------------------------------------------------------------
331 if (!(flagsSet
& wxFS_VOL_MOUNTED
))
334 wxArrayString mounted
;
335 BuildListFromNN(mounted
, pResSrc
, flagsSet
| wxFS_VOL_MOUNTED
, flagsUnset
& ~wxFS_VOL_MOUNTED
);
336 mounted
.Sort(CompareFcn
);
338 // apply list from bottom to top to preserve indexes if removing items.
339 size_t iList
= list
.GetCount()-1;
340 for (size_t iMounted
= mounted
.GetCount()-1; iMounted
>= 0 && iList
>= 0; iMounted
--)
343 wxString
all(list
[iList
]);
344 wxString
mount(mounted
[iMounted
]);
347 wxStricmp(list
[iList
].c_str(), mounted
[iMounted
].c_str()),
348 compare
> 0 && iList
>= 0)
357 // Found the element. Remove it or mark it mounted.
358 if (flagsUnset
& wxFS_VOL_MOUNTED
)
359 list
.RemoveAt(iList
);
361 s_fileInfo
[list
[iList
]].m_flags
|= wxFS_VOL_MOUNTED
;
372 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
374 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
376 //=============================================================================
377 // Function: GetVolumes
378 // Purpose: Generate and return a list of all volumes (drives) available.
380 //=============================================================================
381 wxArrayString
wxFSVolumeBase::GetVolumes(int flagsSet
, int flagsUnset
)
383 ::InterlockedExchange(&s_cancelSearch
, FALSE
); // reset
385 if (!s_mprLib
.IsLoaded() && s_mprLib
.Load(_T("mpr.dll")))
388 s_pWNetOpenEnum
= (WNetOpenEnumPtr
)s_mprLib
.GetSymbol(_T("WNetOpenEnumW"));
389 s_pWNetEnumResource
= (WNetEnumResourcePtr
)s_mprLib
.GetSymbol(_T("WNetEnumResourceW"));
391 s_pWNetOpenEnum
= (WNetOpenEnumPtr
)s_mprLib
.GetSymbol(_T("WNetOpenEnumA"));
392 s_pWNetEnumResource
= (WNetEnumResourcePtr
)s_mprLib
.GetSymbol(_T("WNetEnumResourceA"));
394 s_pWNetCloseEnum
= (WNetCloseEnumPtr
)s_mprLib
.GetSymbol(_T("WNetCloseEnum"));
399 //-------------------------------
400 // Local and mapped drives first.
401 //-------------------------------
402 // Allocate the required space for the API call.
403 const DWORD chars
= GetLogicalDriveStrings(0, NULL
);
404 TCHAR
* buf
= new TCHAR
[chars
+1];
406 // Get the list of drives.
407 GetLogicalDriveStrings(chars
, buf
);
409 // Parse the list into an array, applying appropriate filters.
414 FilteredAdd(list
, pVol
, flagsSet
, flagsUnset
);
415 pVol
= pVol
+ wxStrlen(pVol
) + 1;
421 //---------------------------
422 // Network Neighborhood next.
423 //---------------------------
425 // not exclude remote and not removable
426 if (!(flagsUnset
& wxFS_VOL_REMOTE
) &&
427 !(flagsSet
& wxFS_VOL_REMOVABLE
)
430 // The returned list will be sorted alphabetically. We don't pass
431 // our in since we don't want to change to order of the local drives.
433 if (BuildRemoteList(nn
, 0, flagsSet
, flagsUnset
))
435 for (size_t idx
= 0; idx
< nn
.GetCount(); idx
++)
443 //=============================================================================
444 // Function: CancelSearch
445 // Purpose: Instruct an active search to stop.
446 // Notes: - This will only sensibly be called by a thread other than the one
447 // performing the search. This is the only thread-safe function
448 // provided by the class.
449 //=============================================================================
450 void wxFSVolumeBase::CancelSearch()
452 ::InterlockedExchange(&s_cancelSearch
, TRUE
);
455 //=============================================================================
456 // Function: constructor
457 // Purpose: default constructor
458 //=============================================================================
459 wxFSVolumeBase::wxFSVolumeBase()
464 //=============================================================================
465 // Function: constructor
466 // Purpose: constructor that calls Create
467 //=============================================================================
468 wxFSVolumeBase::wxFSVolumeBase(const wxString
& name
)
473 //=============================================================================
475 // Purpose: Finds, logs in, etc. to the request volume.
476 //=============================================================================
477 bool wxFSVolumeBase::Create(const wxString
& name
)
487 long rc
= SHGetFileInfo(m_volName
, 0, &fi
, sizeof(fi
), SHGFI_DISPLAYNAME
);
490 wxLogError(_("Cannot read typename from '%s'!"), m_volName
.c_str());
493 m_dispName
= fi
.szDisplayName
;
496 return m_isOk
= true;
499 //=============================================================================
501 // Purpose: returns true if the volume is legal.
502 // Notes: For fixed disks, it must exist. For removable disks, it must also
503 // be present. For Network Shares, it must also be logged in, etc.
504 //=============================================================================
505 bool wxFSVolumeBase::IsOk() const
510 //=============================================================================
512 // Purpose: Return the type of the volume.
513 //=============================================================================
514 wxFSVolumeKind
wxFSVolumeBase::GetKind() const
517 return wxFS_VOL_OTHER
;
519 FileInfoMap::iterator itr
= s_fileInfo
.find(m_volName
);
520 if (itr
== s_fileInfo
.end())
521 return wxFS_VOL_OTHER
;
523 return itr
->second
.m_type
;
526 //=============================================================================
527 // Function: GetFlags
528 // Purpose: Return the caches flags for this volume.
529 // Notes: - Returns -1 if no flags were cached.
530 //=============================================================================
531 int wxFSVolumeBase::GetFlags() const
536 FileInfoMap::iterator itr
= s_fileInfo
.find(m_volName
);
537 if (itr
== s_fileInfo
.end())
540 return itr
->second
.m_flags
;
545 // ============================================================================
547 // ============================================================================
551 void wxFSVolume::InitIcons()
553 m_icons
.Alloc(wxFS_VOL_ICO_MAX
);
555 for (int idx
= 0; idx
< wxFS_VOL_ICO_MAX
; idx
++)
559 //=============================================================================
561 // Purpose: return the requested icon.
562 //=============================================================================
564 wxIcon
wxFSVolume::GetIcon(wxFSIconType type
) const
566 wxCHECK_MSG( type
>= 0 && (size_t)type
< m_icons
.GetCount(), wxNullIcon
,
567 _T("wxFSIconType::GetIcon(): invalid icon index") );
570 if (m_icons
[type
].IsNull())
572 UINT flags
= SHGFI_ICON
;
575 case wxFS_VOL_ICO_SMALL
:
576 flags
|= SHGFI_SMALLICON
;
579 case wxFS_VOL_ICO_LARGE
:
580 flags
|= SHGFI_SHELLICONSIZE
;
583 case wxFS_VOL_ICO_SEL_SMALL
:
584 flags
|= SHGFI_SMALLICON
| SHGFI_OPENICON
;
587 case wxFS_VOL_ICO_SEL_LARGE
:
588 flags
|= SHGFI_SHELLICONSIZE
| SHGFI_OPENICON
;
591 case wxFS_VOL_ICO_MAX
:
592 wxFAIL_MSG(_T("wxFS_VOL_ICO_MAX is not valid icon type"));
597 long rc
= SHGetFileInfo(m_volName
, 0, &fi
, sizeof(fi
), flags
);
598 m_icons
[type
].SetHICON((WXHICON
)fi
.hIcon
);
599 if (!rc
|| !fi
.hIcon
)
600 wxLogError(_("Cannot load icon from '%s'."), m_volName
.c_str());
603 return m_icons
[type
];
608 #endif // wxUSE_FSVOLUME