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 #include "wx/wxprec.h"
28 #include "wx/volume.h"
35 #include "wx/hashmap.h"
39 #include "wx/dynlib.h"
40 #include "wx/arrimpl.cpp"
44 #include "wx/msw/missing.h"
48 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
49 // Dynamic library function defs.
50 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
52 #if wxUSE_DYNLIB_CLASS
53 static wxDynamicLibrary s_mprLib
;
56 typedef DWORD (WINAPI
* WNetOpenEnumPtr
)(DWORD
, DWORD
, DWORD
, LPNETRESOURCE
, LPHANDLE
);
57 typedef DWORD (WINAPI
* WNetEnumResourcePtr
)(HANDLE
, LPDWORD
, LPVOID
, LPDWORD
);
58 typedef DWORD (WINAPI
* WNetCloseEnumPtr
)(HANDLE
);
60 static WNetOpenEnumPtr s_pWNetOpenEnum
;
61 static WNetEnumResourcePtr s_pWNetEnumResource
;
62 static WNetCloseEnumPtr s_pWNetCloseEnum
;
64 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
67 static long s_cancelSearch
= FALSE
;
71 FileInfo(unsigned flag
=0, wxFSVolumeKind type
=wxFS_VOL_OTHER
) :
72 m_flags(flag
), m_type(type
) {}
74 FileInfo(const FileInfo
& other
) { *this = other
; }
75 FileInfo
& operator=(const FileInfo
& other
)
77 m_flags
= other
.m_flags
;
78 m_type
= other
.m_type
;
83 wxFSVolumeKind m_type
;
85 WX_DECLARE_STRING_HASH_MAP(FileInfo
, FileInfoMap
);
86 // Cygwin bug (?) destructor for global s_fileInfo is called twice...
87 static FileInfoMap
& GetFileInfoMap()
89 static FileInfoMap
s_fileInfo(25);
93 #define s_fileInfo (GetFileInfoMap())
95 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
96 // Local helper functions.
97 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
99 //=============================================================================
100 // Function: GetBasicFlags
101 // Purpose: Set basic flags, primarily wxFS_VOL_REMOTE and wxFS_VOL_REMOVABLE.
102 // Notes: - Local and mapped drives are mounted by definition. We have no
103 // way to determine mounted status of network drives, so assume that
104 // all drives are mounted, and let the caller decide otherwise.
105 // - Other flags are 'best guess' from type of drive. The system will
106 // not report the file attributes with any degree of accuracy.
107 //=============================================================================
108 static unsigned GetBasicFlags(const wxChar
* filename
)
110 unsigned flags
= wxFS_VOL_MOUNTED
;
112 //----------------------------------
113 // 'Best Guess' based on drive type.
114 //----------------------------------
116 switch(GetDriveType(filename
))
119 type
= wxFS_VOL_DISK
;
122 case DRIVE_REMOVABLE
:
123 flags
|= wxFS_VOL_REMOVABLE
;
124 type
= wxFS_VOL_FLOPPY
;
128 flags
|= wxFS_VOL_REMOVABLE
| wxFS_VOL_READONLY
;
129 type
= wxFS_VOL_CDROM
;
133 flags
|= wxFS_VOL_REMOTE
;
134 type
= wxFS_VOL_NETWORK
;
137 case DRIVE_NO_ROOT_DIR
:
138 flags
&= ~wxFS_VOL_MOUNTED
;
139 type
= wxFS_VOL_OTHER
;
143 type
= wxFS_VOL_OTHER
;
147 //-----------------------------------------------------------------------
148 // The following most likely will not modify anything not set above,
149 // and will not work at all for network shares or empty CD ROM drives.
150 // But it is a good check if the Win API ever gets better about reporting
152 //-----------------------------------------------------------------------
154 long rc
= SHGetFileInfo(filename
, 0, &fi
, sizeof(fi
), SHGFI_ATTRIBUTES
);
157 // this error is not fatal, so don't show a message to the user about
158 // it, otherwise it would appear every time a generic directory picker
159 // dialog is used and there is a connected network drive
160 wxLogLastError(_T("SHGetFileInfo"));
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
);
267 // if the drive is unavailable, FilteredAdd() can hang for
268 // a long time and, moreover, its failure appears to be not
269 // cached so this will happen every time we use it, so try
270 // a much quicker wxDirExists() test (which still hangs but
271 // for much shorter time) for locally mapped drives first
272 // to try to avoid this
273 if ( pRes
->lpLocalName
&&
274 *pRes
->lpLocalName
&&
275 !wxDirExists(pRes
->lpLocalName
) )
278 if (!filename
.empty())
280 if (filename
.Last() != '\\')
281 filename
.Append('\\');
283 // The filter function will not know mounted from unmounted, and neither do we unless
284 // we are iterating using RESOURCE_CONNECTED, in which case they all are mounted.
285 // Volumes on disconnected servers, however, will correctly show as unmounted.
286 FilteredAdd(list
, filename
.wx_str(), flagsSet
, flagsUnset
&~wxFS_VOL_MOUNTED
);
287 if (scope
== RESOURCE_GLOBALNET
)
288 s_fileInfo
[filename
].m_flags
&= ~wxFS_VOL_MOUNTED
;
296 s_pWNetCloseEnum(hEnum
);
300 //=============================================================================
301 // Function: CompareFcn
302 // Purpose: Used to sort the NN list alphabetically, case insensitive.
303 //=============================================================================
304 static int CompareFcn(const wxString
& first
, const wxString
& second
)
306 return wxStricmp(first
.c_str(), second
.c_str());
309 //=============================================================================
310 // Function: BuildRemoteList
311 // Purpose: Append Network Neighborhood items to the list.
312 // Notes: - Mounted gets transalated into Connected. FilteredAdd is told
313 // to ignore the Mounted flag since we need to handle it in a weird
315 // - The resulting list is sorted alphabetically.
316 //=============================================================================
317 static bool BuildRemoteList(wxArrayString
& list
, NETRESOURCE
* pResSrc
,
318 unsigned flagsSet
, unsigned flagsUnset
)
320 // NN query depends on dynamically loaded library.
321 if (!s_pWNetOpenEnum
|| !s_pWNetEnumResource
|| !s_pWNetCloseEnum
)
323 wxLogError(_("Failed to load mpr.dll."));
327 // Don't waste time doing the work if the flags conflict.
328 if (flagsSet
& wxFS_VOL_MOUNTED
&& flagsUnset
& wxFS_VOL_MOUNTED
)
331 //----------------------------------------------
332 // Generate the list according to the flags set.
333 //----------------------------------------------
334 BuildListFromNN(list
, pResSrc
, flagsSet
, flagsUnset
);
335 list
.Sort(CompareFcn
);
337 //-------------------------------------------------------------------------
338 // If mounted only is requested, then we only need one simple pass.
339 // Otherwise, we need to build a list of all NN volumes and then apply the
340 // list of mounted drives to it.
341 //-------------------------------------------------------------------------
342 if (!(flagsSet
& wxFS_VOL_MOUNTED
))
345 wxArrayString mounted
;
346 BuildListFromNN(mounted
, pResSrc
, flagsSet
| wxFS_VOL_MOUNTED
, flagsUnset
& ~wxFS_VOL_MOUNTED
);
347 mounted
.Sort(CompareFcn
);
349 // apply list from bottom to top to preserve indexes if removing items.
350 ssize_t iList
= list
.GetCount()-1;
351 for (ssize_t iMounted
= mounted
.GetCount()-1; iMounted
>= 0 && iList
>= 0; iMounted
--)
354 wxString
all(list
[iList
]);
355 wxString
mount(mounted
[iMounted
]);
358 wxStricmp(list
[iList
].c_str(), mounted
[iMounted
].c_str()),
359 compare
> 0 && iList
>= 0)
368 // Found the element. Remove it or mark it mounted.
369 if (flagsUnset
& wxFS_VOL_MOUNTED
)
370 list
.RemoveAt(iList
);
372 s_fileInfo
[list
[iList
]].m_flags
|= wxFS_VOL_MOUNTED
;
383 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
385 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
387 //=============================================================================
388 // Function: GetVolumes
389 // Purpose: Generate and return a list of all volumes (drives) available.
391 //=============================================================================
392 wxArrayString
wxFSVolumeBase::GetVolumes(int flagsSet
, int flagsUnset
)
394 ::InterlockedExchange(&s_cancelSearch
, FALSE
); // reset
396 #if wxUSE_DYNLIB_CLASS
397 if (!s_mprLib
.IsLoaded() && s_mprLib
.Load(_T("mpr.dll")))
400 s_pWNetOpenEnum
= (WNetOpenEnumPtr
)s_mprLib
.GetSymbol(_T("WNetOpenEnumW"));
401 s_pWNetEnumResource
= (WNetEnumResourcePtr
)s_mprLib
.GetSymbol(_T("WNetEnumResourceW"));
403 s_pWNetOpenEnum
= (WNetOpenEnumPtr
)s_mprLib
.GetSymbol(_T("WNetOpenEnumA"));
404 s_pWNetEnumResource
= (WNetEnumResourcePtr
)s_mprLib
.GetSymbol(_T("WNetEnumResourceA"));
406 s_pWNetCloseEnum
= (WNetCloseEnumPtr
)s_mprLib
.GetSymbol(_T("WNetCloseEnum"));
412 //-------------------------------
413 // Local and mapped drives first.
414 //-------------------------------
415 // Allocate the required space for the API call.
416 const DWORD chars
= GetLogicalDriveStrings(0, NULL
);
417 TCHAR
* buf
= new TCHAR
[chars
+1];
419 // Get the list of drives.
420 GetLogicalDriveStrings(chars
, buf
);
422 // Parse the list into an array, applying appropriate filters.
427 FilteredAdd(list
, pVol
, flagsSet
, flagsUnset
);
428 pVol
= pVol
+ wxStrlen(pVol
) + 1;
434 //---------------------------
435 // Network Neighborhood next.
436 //---------------------------
438 // not exclude remote and not removable
439 if (!(flagsUnset
& wxFS_VOL_REMOTE
) &&
440 !(flagsSet
& wxFS_VOL_REMOVABLE
)
443 // The returned list will be sorted alphabetically. We don't pass
444 // our in since we don't want to change to order of the local drives.
446 if (BuildRemoteList(nn
, 0, flagsSet
, flagsUnset
))
448 for (size_t idx
= 0; idx
< nn
.GetCount(); idx
++)
456 //=============================================================================
457 // Function: CancelSearch
458 // Purpose: Instruct an active search to stop.
459 // Notes: - This will only sensibly be called by a thread other than the one
460 // performing the search. This is the only thread-safe function
461 // provided by the class.
462 //=============================================================================
463 void wxFSVolumeBase::CancelSearch()
465 ::InterlockedExchange(&s_cancelSearch
, TRUE
);
468 //=============================================================================
469 // Function: constructor
470 // Purpose: default constructor
471 //=============================================================================
472 wxFSVolumeBase::wxFSVolumeBase()
477 //=============================================================================
478 // Function: constructor
479 // Purpose: constructor that calls Create
480 //=============================================================================
481 wxFSVolumeBase::wxFSVolumeBase(const wxString
& name
)
486 //=============================================================================
488 // Purpose: Finds, logs in, etc. to the request volume.
489 //=============================================================================
490 bool wxFSVolumeBase::Create(const wxString
& name
)
500 long rc
= SHGetFileInfo(m_volName
.wx_str(), 0, &fi
, sizeof(fi
), SHGFI_DISPLAYNAME
);
503 wxLogError(_("Cannot read typename from '%s'!"), m_volName
.c_str());
506 m_dispName
= fi
.szDisplayName
;
509 return m_isOk
= true;
512 //=============================================================================
514 // Purpose: returns true if the volume is legal.
515 // Notes: For fixed disks, it must exist. For removable disks, it must also
516 // be present. For Network Shares, it must also be logged in, etc.
517 //=============================================================================
518 bool wxFSVolumeBase::IsOk() const
523 //=============================================================================
525 // Purpose: Return the type of the volume.
526 //=============================================================================
527 wxFSVolumeKind
wxFSVolumeBase::GetKind() const
530 return wxFS_VOL_OTHER
;
532 FileInfoMap::iterator itr
= s_fileInfo
.find(m_volName
);
533 if (itr
== s_fileInfo
.end())
534 return wxFS_VOL_OTHER
;
536 return itr
->second
.m_type
;
539 //=============================================================================
540 // Function: GetFlags
541 // Purpose: Return the caches flags for this volume.
542 // Notes: - Returns -1 if no flags were cached.
543 //=============================================================================
544 int wxFSVolumeBase::GetFlags() const
549 FileInfoMap::iterator itr
= s_fileInfo
.find(m_volName
);
550 if (itr
== s_fileInfo
.end())
553 return itr
->second
.m_flags
;
558 // ============================================================================
560 // ============================================================================
564 void wxFSVolume::InitIcons()
566 m_icons
.Alloc(wxFS_VOL_ICO_MAX
);
568 for (int idx
= 0; idx
< wxFS_VOL_ICO_MAX
; idx
++)
572 //=============================================================================
574 // Purpose: return the requested icon.
575 //=============================================================================
577 wxIcon
wxFSVolume::GetIcon(wxFSIconType type
) const
579 wxCHECK_MSG( type
>= 0 && (size_t)type
< m_icons
.GetCount(), wxNullIcon
,
580 _T("wxFSIconType::GetIcon(): invalid icon index") );
583 if (m_icons
[type
].IsNull())
585 UINT flags
= SHGFI_ICON
;
588 case wxFS_VOL_ICO_SMALL
:
589 flags
|= SHGFI_SMALLICON
;
592 case wxFS_VOL_ICO_LARGE
:
593 flags
|= SHGFI_SHELLICONSIZE
;
596 case wxFS_VOL_ICO_SEL_SMALL
:
597 flags
|= SHGFI_SMALLICON
| SHGFI_OPENICON
;
600 case wxFS_VOL_ICO_SEL_LARGE
:
601 flags
|= SHGFI_SHELLICONSIZE
| SHGFI_OPENICON
;
604 case wxFS_VOL_ICO_MAX
:
605 wxFAIL_MSG(_T("wxFS_VOL_ICO_MAX is not valid icon type"));
610 long rc
= SHGetFileInfo(m_volName
.wx_str(), 0, &fi
, sizeof(fi
), flags
);
611 m_icons
[type
].SetHICON((WXHICON
)fi
.hIcon
);
612 if (!rc
|| !fi
.hIcon
)
613 wxLogError(_("Cannot load icon from '%s'."), m_volName
.c_str());
616 return m_icons
[type
];
621 #endif // wxUSE_FSVOLUME