ReactOS  0.4.15-dev-439-g292f67a
hotplug.cpp
Go to the documentation of this file.
1 /*
2  * PROJECT: ReactOS system libraries
3  * LICENSE: GPL - See COPYING in the top level directory
4  * FILE: dll/shellext/stobject/hotplug.cpp
5  * PURPOSE: Removable devices notification icon handler
6  * PROGRAMMERS: Shriraj Sawant a.k.a SR13 <sr.official@hotmail.com>
7  */
8 
9 #include "precomp.h"
10 
11 #include <atlsimpcoll.h>
12 #include <dbt.h>
13 #include <cfgmgr32.h>
14 #include <shlwapi.h>
15 
16 #define DISPLAY_NAME_LEN 40
17 
23 
24 /*++
25 * @name EnumHotpluggedDevices
26 *
27 * Enumerates the connected safely removable devices.
28 *
29 * @param devList
30 * List of device instances, representing the currently attached devices.
31 *
32 * @return The error code.
33 *
34 *--*/
36 {
37  devList.RemoveAll(); // Clear current devList
40  return E_HANDLE;
41  SP_DEVINFO_DATA did = { 0 };
42  did.cbSize = sizeof(did);
43 
44  // Enumerate all the attached devices.
45  for (int idev = 0; SetupDiEnumDeviceInfo(hdev, idev, &did); idev++)
46  {
47  DWORD dwCapabilities = 0, dwSize = sizeof(dwCapabilities);
48  ULONG ulStatus = 0, ulProblem = 0;
49  CONFIGRET cr = CM_Get_DevNode_Status(&ulStatus, &ulProblem, did.DevInst, 0);
50  if (cr != CR_SUCCESS)
51  continue;
52 
54  if (cr != CR_SUCCESS)
55  continue;
56 
57  // Filter and make list of only the appropriate safely removable devices.
58  if ( (dwCapabilities & CM_DEVCAP_REMOVABLE) &&
59  !(dwCapabilities & CM_DEVCAP_DOCKDEVICE) &&
60  !(dwCapabilities & CM_DEVCAP_SURPRISEREMOVALOK) &&
61  ((dwCapabilities & CM_DEVCAP_EJECTSUPPORTED) || (ulStatus & DN_DISABLEABLE)) &&
62  !ulProblem)
63  {
64  devList.Add(did.DevInst);
65  }
66  }
68 
70  {
71  return E_UNEXPECTED;
72  }
73 
74  return S_OK;
75 }
76 
77 /*++
78 * @name NotifyBalloon
79 *
80 * Pops the balloon notification of the given notification icon.
81 *
82 * @param pSysTray
83 * Provides interface for acquiring CSysTray information as required.
84 * @param szTitle
85 * Title for the balloon notification.
86 * @param szInfo
87 * Main content for the balloon notification.
88 * @param uId
89 * Represents the particular notification icon.
90 *
91 * @return The error code.
92 *
93 *--*/
95 {
96  NOTIFYICONDATA nim = { 0 };
97 
98  nim.cbSize = sizeof(nim);
99  nim.uID = uId;
100  nim.hWnd = pSysTray->GetHWnd();
101 
102  nim.uFlags = NIF_INFO;
103  nim.uTimeout = 10;
104  nim.dwInfoFlags = NIIF_INFO;
105 
107  StringCchCopy(nim.szInfo, _countof(nim.szInfo), szInfo);
109 
110  Sleep(10000); /* As per windows, the balloon notification remains visible for atleast 10 sec.
111  This timer maintains the same condition.
112  Also it is required so that the icon doesn't hide instantly after last device is removed,
113  as that will prevent popping of notification.
114  */
116  StringCchCopy(nim.szInfo, _countof(nim.szInfo), L"");
118  g_IsRemoving = FALSE; /* This flag is used to prevent instant icon hiding after last device is removed.
119  The above timer maintains the required state for the same.
120  */
121  return ret ? S_OK : E_FAIL;
122 }
123 
125 {
126  TRACE("Hotplug_Init\n");
127 
130 
132 
133  if (g_devList.GetSize() > 0)
134  return pSysTray->NotifyIcon(NIM_ADD, ID_ICON_HOTPLUG, g_hIconHotplug, g_strHotplugTooltip);
135  else
136  return pSysTray->NotifyIcon(NIM_ADD, ID_ICON_HOTPLUG, g_hIconHotplug, g_strHotplugTooltip, NIS_HIDDEN);
137 }
138 
140 {
141  TRACE("Hotplug_Update\n");
142  return S_OK;
143 }
144 
146 {
147  TRACE("Hotplug_Shutdown\n");
148 
151 
152  return pSysTray->NotifyIcon(NIM_DELETE, ID_ICON_HOTPLUG, NULL, NULL);
153 }
154 
155 static void _RunHotplug(CSysTray * pSysTray)
156 {
157  ShellExecuteW(pSysTray->GetHWnd(),
158  L"open",
159  L"rundll32.exe",
160  L"shell32.dll,Control_RunDLL hotplug.dll",
161  NULL,
162  SW_SHOWNORMAL);
163 }
164 
165 static void _ShowContextMenu(CSysTray * pSysTray)
166 {
167  HMENU hPopup = CreatePopupMenu();
168  ULONG ulLength = DISPLAY_NAME_LEN * sizeof(WCHAR);
169 
170  for (INT index = 0; index < g_devList.GetSize(); index++)
171  {
172  WCHAR dispName[DISPLAY_NAME_LEN];
173  CString menuName;
175  if (cr != CR_SUCCESS)
176  StrCpyW(dispName, L"Unknown Device");
177 
178  menuName.Format(IDS_HOTPLUG_REMOVE_3, dispName);
179  AppendMenuW(hPopup, MF_STRING, index+1, menuName);
180  }
181 
182  SetForegroundWindow(pSysTray->GetHWnd());
184  POINT pt;
185  GetCursorPos(&pt);
186 
187  DWORD id = TrackPopupMenuEx(hPopup, flags,
188  pt.x, pt.y,
189  pSysTray->GetHWnd(), NULL);
190 
191  if (id > 0)
192  {
193  id--; // since array indices starts from zero.
195  if (cr != CR_SUCCESS)
196  StrCpyW(g_strMenuSel, L"Unknown Device");
197 
198  cr = CM_Request_Device_Eject_Ex(g_devList[id], 0, 0, 0, 0, 0);
199  if (cr != CR_SUCCESS)
200  {
201  WCHAR strInfo[128];
202  swprintf(strInfo, L"Problem Ejecting %wS", g_strMenuSel);
203  MessageBox(0, L"The device cannot be stopped right now! Try stopping it again later!", strInfo, MB_OK | MB_ICONEXCLAMATION);
204  }
205  else
206  {
207  //MessageBox(0, L"Device ejected successfully!! You can safely remove the device now!", L"Safely Remove Hardware", MB_OK | MB_ICONINFORMATION);
208  g_IsRemoving = TRUE;
209  g_devList.RemoveAt(id); /* thing is.. even after removing id at this point, the devnode_change occurs after some seconds of sucessful removal
210  and since pendrive is still plugged in it gets enumerated, if problem number is not filtered.
211  */
212  }
213  }
214 
215  DestroyMenu(hPopup);
216 }
217 
218 static void _ShowContextMenuR(CSysTray * pSysTray)
219 {
221  HMENU hPopup = CreatePopupMenu();
222  AppendMenuW(hPopup, MF_STRING, IDS_HOTPLUG_REMOVE_2, strMenu);
224 
225  SetForegroundWindow(pSysTray->GetHWnd());
227  POINT pt;
228  GetCursorPos(&pt);
229 
230  DWORD id = TrackPopupMenuEx(hPopup, flags,
231  pt.x, pt.y,
232  pSysTray->GetHWnd(), NULL);
233 
234  if (id == IDS_HOTPLUG_REMOVE_2)
235  {
236  _RunHotplug(pSysTray);
237  }
238 
239  DestroyMenu(hPopup);
240 }
241 
242 
243 VOID
245  _In_ CSysTray *pSysTray)
246 {
247  TRACE("HotplugDeviceTimer()\n");
248 
250 
251  if (g_devList.GetSize() > 0)
253  else
254  pSysTray->NotifyIcon(NIM_MODIFY, ID_ICON_HOTPLUG, g_hIconHotplug, g_strHotplugTooltip, NIS_HIDDEN);
255 }
256 
257 
259 {
260  TRACE("Hotplug_Message uMsg=%d, wParam=%x, lParam=%x\n", uMsg, wParam, lParam);
261 
262  switch (uMsg)
263  {
264  case WM_USER + 220:
265  TRACE("Hotplug_Message: WM_USER+220\n");
267  {
268  if (lParam)
269  {
270  pSysTray->EnableService(HOTPLUG_SERVICE_FLAG, TRUE);
271  return Hotplug_Init(pSysTray);
272  }
273  else
274  {
275  pSysTray->EnableService(HOTPLUG_SERVICE_FLAG, FALSE);
276  return Hotplug_Shutdown(pSysTray);
277  }
278  }
279  return S_FALSE;
280 
281  case WM_USER + 221:
282  TRACE("Hotplug_Message: WM_USER+221\n");
284  {
285  lResult = (LRESULT)pSysTray->IsServiceEnabled(HOTPLUG_SERVICE_FLAG);
286  return S_OK;
287  }
288  return S_FALSE;
289 
290  case WM_TIMER:
291  if (wParam == HOTPLUG_TIMER_ID)
292  {
293  KillTimer(pSysTray->GetHWnd(), HOTPLUG_TIMER_ID);
294  _ShowContextMenu(pSysTray);
295  }
296  else if (wParam == HOTPLUG_DEVICE_TIMER_ID)
297  {
298  KillTimer(pSysTray->GetHWnd(), HOTPLUG_DEVICE_TIMER_ID);
299  HotplugDeviceTimer(pSysTray);
300  }
301  break;
302 
303  case ID_ICON_HOTPLUG:
304  switch (lParam)
305  {
306  case WM_LBUTTONDOWN:
307  SetTimer(pSysTray->GetHWnd(), HOTPLUG_TIMER_ID, GetDoubleClickTime(), NULL);
308  break;
309 
310  case WM_LBUTTONUP:
311  break;
312 
313  case WM_LBUTTONDBLCLK:
314  KillTimer(pSysTray->GetHWnd(), HOTPLUG_TIMER_ID);
315  _RunHotplug(pSysTray);
316  break;
317 
318  case WM_RBUTTONDOWN:
319  break;
320 
321  case WM_RBUTTONUP:
322  _ShowContextMenuR(pSysTray);
323  break;
324 
325  case WM_RBUTTONDBLCLK:
326  break;
327 
328  case WM_MOUSEMOVE:
329  break;
330  }
331  return S_OK;
332 
333  case WM_DEVICECHANGE:
334  switch (wParam)
335  {
337  TRACE("WM_DEVICECHANGE : DBT_DEVNODES_CHANGED\n");
338  SetTimer(pSysTray->GetHWnd(), HOTPLUG_DEVICE_TIMER_ID, 100, NULL);
339  lResult = true;
340  break;
341 
342  case DBT_DEVICEARRIVAL:
343  break;
345  break;
347  break;
349  WCHAR strInfo[128];
350  swprintf(strInfo, L"The %wS can now be safely removed from the system.", g_strMenuSel);
351  NotifyBalloon(pSysTray, L"Safe to Remove Hardware", strInfo);
352 
353  lResult = true;
354  break;
356  break;
357  }
358  return S_OK;
359 
360  default:
361  TRACE("Hotplug_Message received for unknown ID %d, ignoring.\n");
362  return S_FALSE;
363  }
364 
365  return S_FALSE;
366 }
BOOL WINAPI SetupDiEnumDeviceInfo(HDEVINFO devinfo, DWORD index, PSP_DEVINFO_DATA info)
Definition: devinst.c:1792
#define HOTPLUG_SERVICE_FLAG
Definition: precomp.h:38
static void _RunHotplug(CSysTray *pSysTray)
Definition: hotplug.cpp:155
static void _ShowContextMenu(CSysTray *pSysTray)
Definition: hotplug.cpp:165
#define MAKEINTRESOURCE
Definition: winuser.h:591
static HICON
Definition: imagelist.c:84
#define TRUE
Definition: types.h:120
#define CM_Get_DevNode_Registry_Property
Definition: cfgmgr32.h:1733
VOID WINAPI DECLSPEC_HOTPATCH Sleep(IN DWORD dwMilliseconds)
Definition: synch.c:790
#define CM_DEVCAP_REMOVABLE
Definition: cfgmgr32.h:737
#define E_HANDLE
Definition: winerror.h:2850
BOOL Add(const T &t)
Definition: atlsimpcoll.h:58
#define WM_LBUTTONDOWN
Definition: winuser.h:1758
#define DBT_DEVNODES_CHANGED
Definition: dbt.h:28
const WCHAR * LPCWSTR
Definition: xmlstorage.h:185
#define CM_DEVCAP_EJECTSUPPORTED
Definition: cfgmgr32.h:736
#define ERROR_NO_MORE_ITEMS
Definition: compat.h:95
#define IDS_HOTPLUG_REMOVE_3
Definition: resource.h:20
BOOL WINAPI DestroyIcon(_In_ HICON)
Definition: cursoricon.c:2022
#define pt(x, y)
Definition: drawing.c:79
#define IDS_HOTPLUG_REMOVE_2
Definition: resource.h:19
#define TPM_RETURNCMD
Definition: winuser.h:2362
#define IDS_HOTPLUG_REMOVE_1
Definition: resource.h:18
static HICON g_hIconHotplug
Definition: hotplug.cpp:20
#define ID_ICON_HOTPLUG
Definition: precomp.h:34
BOOL WINAPI TrackPopupMenuEx(_In_ HMENU, _In_ UINT, _In_ int, _In_ int, _In_ HWND, _In_opt_ LPTPMPARAMS)
#define MF_STRING
Definition: winuser.h:138
#define DN_DISABLEABLE
Definition: cfg.h:131
DWORD dwInfoFlags
Definition: shellapi.h:244
#define INVALID_HANDLE_VALUE
Definition: compat.h:400
DWORD WINAPI GetLastError(VOID)
Definition: except.c:1059
void __cdecl Format(UINT nFormatID,...)
Definition: cstringt.h:688
UINT_PTR WPARAM
Definition: windef.h:207
BOOL WINAPI GetCursorPos(_Out_ LPPOINT)
Definition: cursoricon.c:2635
#define NO_ERROR
Definition: dderror.h:5
#define E_FAIL
Definition: ddrawi.h:102
int32_t INT
Definition: typedefs.h:57
WPARAM wParam
Definition: combotst.c:138
BOOL WINAPI AppendMenuW(_In_ HMENU, _In_ UINT, _In_ UINT_PTR, _In_opt_ LPCWSTR)
#define MB_ICONEXCLAMATION
Definition: winuser.h:779
unsigned int BOOL
Definition: ntddk_ex.h:94
#define DBT_DEVICEREMOVECOMPLETE
Definition: dbt.h:16
HRESULT STDMETHODCALLTYPE Hotplug_Init(_In_ CSysTray *pSysTray)
Definition: hotplug.cpp:124
#define CR_SUCCESS
Definition: cfgmgr32.h:842
#define S_FALSE
Definition: winerror.h:2357
#define TPM_BOTTOMALIGN
Definition: winuser.h:2360
smooth NULL
Definition: ftsmooth.c:416
#define HOTPLUG_DEVICE_TIMER_ID
Definition: precomp.h:80
LONG_PTR LPARAM
Definition: windef.h:208
GLuint index
Definition: glext.h:6031
UINT_PTR WINAPI SetTimer(_In_opt_ HWND, _In_ UINT_PTR, _In_ UINT, _In_opt_ TIMERPROC)
#define WM_RBUTTONDOWN
Definition: winuser.h:1761
HRESULT STDMETHODCALLTYPE Hotplug_Message(_In_ CSysTray *pSysTray, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT &lResult)
Definition: hotplug.cpp:258
#define TRACE(s)
Definition: solgame.cpp:4
HRESULT STDMETHODCALLTYPE Hotplug_Shutdown(_In_ CSysTray *pSysTray)
Definition: hotplug.cpp:145
CString g_strHotplugTooltip
Definition: hotplug.cpp:19
__wchar_t WCHAR
Definition: xmlstorage.h:180
LONG HRESULT
Definition: typedefs.h:78
#define _countof(array)
Definition: sndvol32.h:68
#define WM_TIMER
Definition: winuser.h:1724
#define DBT_DEVICEQUERYREMOVE
Definition: dbt.h:13
BOOL WINAPI SetupDiDestroyDeviceInfoList(HDEVINFO devinfo)
Definition: devinst.c:2898
HRESULT EnumHotpluggedDevices(CSimpleArray< DEVINST > &devList)
Definition: hotplug.cpp:35
#define swprintf(buf, format,...)
Definition: sprintf.c:56
#define STDMETHODCALLTYPE
Definition: bdasup.h:9
unsigned long DWORD
Definition: ntddk_ex.h:95
#define NIM_DELETE
Definition: shellapi.h:93
#define WM_RBUTTONUP
Definition: winuser.h:1762
VOID HotplugDeviceTimer(_In_ CSysTray *pSysTray)
Definition: hotplug.cpp:244
#define TPM_NONOTIFY
Definition: winuser.h:2361
TCHAR szTitle[MAX_LOADSTRING]
Definition: magnifier.c:35
GLbitfield flags
Definition: glext.h:7161
#define DIGCF_ALLCLASSES
Definition: setupapi.h:172
BOOL WINAPI KillTimer(_In_opt_ HWND, _In_ UINT_PTR)
int ret
#define DBT_DEVICEQUERYREMOVEFAILED
Definition: dbt.h:14
static const WCHAR L[]
Definition: oid.c:1250
#define CM_DRP_DEVICEDESC
Definition: cfgmgr32.h:676
#define StringCchCopy
Definition: strsafe.h:139
#define WM_LBUTTONDBLCLK
Definition: winuser.h:1760
#define LRESULT
Definition: ole.h:14
#define SetupDiGetClassDevs
Definition: setupapi.h:2588
#define MessageBox
Definition: winuser.h:5797
LPWSTR WINAPI StrCpyW(LPWSTR lpszStr, LPCWSTR lpszSrc)
Definition: string.c:514
#define WM_USER
Definition: winuser.h:1877
BOOL WINAPI DestroyMenu(_In_ HMENU)
#define CM_Request_Device_Eject_Ex
Definition: cfgmgr32.h:2878
#define _In_
Definition: no_sal2.h:204
#define S_OK
Definition: intsafe.h:59
#define SW_SHOWNORMAL
Definition: winuser.h:764
static BOOL g_IsRemoving
Definition: hotplug.cpp:22
CSimpleArray< DEVINST > g_devList
Definition: hotplug.cpp:18
static WCHAR g_strMenuSel[DISPLAY_NAME_LEN]
Definition: hotplug.cpp:21
HRESULT STDMETHODCALLTYPE Hotplug_Update(_In_ CSysTray *pSysTray)
Definition: hotplug.cpp:139
#define WM_LBUTTONUP
Definition: winuser.h:1759
#define DBT_DEVICEARRIVAL
Definition: dbt.h:12
HWND GetHWnd()
Definition: csystray.h:53
unsigned int UINT
Definition: ndis.h:50
#define WM_MOUSEMOVE
Definition: winuser.h:1757
#define MB_OK
Definition: winuser.h:784
RETURN_TYPE CONFIGRET
Definition: cfgmgr32.h:74
BOOL WINAPI SetMenuDefaultItem(_In_ HMENU, _In_ UINT, _In_ UINT)
CHAR szInfo[256]
Definition: shellapi.h:238
#define WM_DEVICECHANGE
Definition: winuser.h:1793
#define E_UNEXPECTED
Definition: winerror.h:2456
#define NIM_ADD
Definition: shellapi.h:91
CONFIGRET WINAPI CM_Get_DevNode_Status(_Out_ PULONG pulStatus, _Out_ PULONG pulProblemNumber, _In_ DEVINST dnDevInst, _In_ ULONG ulFlags)
Definition: cfgmgr.c:3565
HMENU WINAPI CreatePopupMenu(void)
Definition: menu.c:846
UINT WINAPI GetDoubleClickTime(void)
Definition: ntwrapper.h:314
#define DBT_DEVICEREMOVEPENDING
Definition: dbt.h:15
#define Shell_NotifyIcon
Definition: shellapi.h:687
#define WM_RBUTTONDBLCLK
Definition: winuser.h:1763
HINSTANCE WINAPI ShellExecuteW(HWND hwnd, LPCWSTR lpVerb, LPCWSTR lpFile, LPCWSTR lpParameters, LPCWSTR lpDirectory, INT nShowCmd)
Definition: shlexec.cpp:2274
#define HOTPLUG_TIMER_ID
Definition: precomp.h:79
unsigned int ULONG
Definition: retypes.h:1
BOOL WINAPI SetForegroundWindow(_In_ HWND)
HRESULT NotifyBalloon(CSysTray *pSysTray, LPCWSTR szTitle=NULL, LPCWSTR szInfo=NULL, UINT uId=ID_ICON_HOTPLUG)
Definition: hotplug.cpp:94
#define CM_DEVCAP_SURPRISEREMOVALOK
Definition: cfgmgr32.h:742
#define LoadIcon
Definition: winuser.h:5788
HINSTANCE g_hInstance
Definition: MainWindow.cpp:18
#define CM_DEVCAP_DOCKDEVICE
Definition: cfgmgr32.h:738
WCHAR * LPWSTR
Definition: xmlstorage.h:184
LONG_PTR LRESULT
Definition: windef.h:209
static const CLSID *static CLSID *static const GUID VARIANT VARIANT *static IServiceProvider DWORD *static HMENU
Definition: ordinal.c:60
CHAR szInfoTitle[64]
Definition: shellapi.h:243
LPARAM lParam
Definition: combotst.c:139
_In_ HDEV hdev
Definition: winddi.h:3449
static void _ShowContextMenuR(CSysTray *pSysTray)
Definition: hotplug.cpp:218
#define CM_DRP_CAPABILITIES
Definition: cfgmgr32.h:691
PSDBQUERYRESULT_VISTA PVOID DWORD * dwSize
Definition: env.c:54
#define TPM_RIGHTALIGN
Definition: winuser.h:2353
#define NIM_MODIFY
Definition: shellapi.h:92
#define IDI_HOTPLUG_OK
Definition: resource.h:57
#define DIGCF_PRESENT
Definition: setupapi.h:171
#define DISPLAY_NAME_LEN
Definition: hotplug.cpp:16