1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/dialup.cpp
3 // Purpose: MSW implementation of network/dialup classes and functions
4 // Author: Vadim Zeitlin
8 // Copyright: (c) Vadim Zeitlin
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #if wxUSE_DIALUP_MANAGER
29 #include "wx/dialup.h"
37 #include "wx/module.h"
40 #include "wx/generic/choicdgg.h"
42 #include "wx/dynlib.h"
44 DEFINE_EVENT_TYPE(wxEVT_DIALUP_CONNECTED
)
45 DEFINE_EVENT_TYPE(wxEVT_DIALUP_DISCONNECTED
)
47 // Doesn't yet compile under VC++ 4, BC++, Watcom C++,
49 #if (!defined(__BORLANDC__) || (__BORLANDC__>=0x550)) && \
50 (!defined(__GNUWIN32__) || wxCHECK_W32API_VERSION(0, 5)) && \
51 !defined(__GNUWIN32_OLD__) && \
52 !defined(__WINE__) && \
53 (!defined(__VISUALC__) || (__VISUALC__ >= 1020))
61 #ifndef INTERNET_CONNECTION_LAN
62 #define INTERNET_CONNECTION_LAN 2
64 #ifndef INTERNET_CONNECTION_PROXY
65 #define INTERNET_CONNECTION_PROXY 4
68 // implemented in utils.cpp
69 extern "C" WXDLLIMPEXP_BASE HWND
70 wxCreateHiddenWindow(LPCTSTR
*pclassname
, LPCTSTR classname
, WNDPROC wndproc
);
73 wxMSWDIALUP_WNDCLASSNAME
= wxT("_wxDialUpManager_Internal_Class");
74 static const wxChar
*gs_classForDialUpWindow
= NULL
;
76 // ----------------------------------------------------------------------------
78 // ----------------------------------------------------------------------------
80 // this message is sent by the secondary thread when RAS status changes
81 #define wxWM_RAS_STATUS_CHANGED (WM_USER + 10010)
82 #define wxWM_RAS_DIALING_PROGRESS (WM_USER + 10011)
84 // ----------------------------------------------------------------------------
86 // ----------------------------------------------------------------------------
88 // the signatures of RAS functions: all this is quite heavy, but we must do it
89 // to allow running wxWin programs on machine which don't have RAS installed
90 // (this does exist) - if we link with rasapi32.lib, the program will fail on
91 // startup because of the missing DLL...
94 typedef DWORD (APIENTRY
* RASDIAL
)( LPRASDIALEXTENSIONS
, LPCSTR
, LPRASDIALPARAMSA
, DWORD
, LPVOID
, LPHRASCONN
);
95 typedef DWORD (APIENTRY
* RASENUMCONNECTIONS
)( LPRASCONNA
, LPDWORD
, LPDWORD
);
96 typedef DWORD (APIENTRY
* RASENUMENTRIES
)( LPCSTR
, LPCSTR
, LPRASENTRYNAMEA
, LPDWORD
, LPDWORD
);
97 typedef DWORD (APIENTRY
* RASGETCONNECTSTATUS
)( HRASCONN
, LPRASCONNSTATUSA
);
98 typedef DWORD (APIENTRY
* RASGETERRORSTRING
)( UINT
, LPSTR
, DWORD
);
99 typedef DWORD (APIENTRY
* RASHANGUP
)( HRASCONN
);
100 typedef DWORD (APIENTRY
* RASGETPROJECTIONINFO
)( HRASCONN
, RASPROJECTION
, LPVOID
, LPDWORD
);
101 typedef DWORD (APIENTRY
* RASCREATEPHONEBOOKENTRY
)( HWND
, LPCSTR
);
102 typedef DWORD (APIENTRY
* RASEDITPHONEBOOKENTRY
)( HWND
, LPCSTR
, LPCSTR
);
103 typedef DWORD (APIENTRY
* RASSETENTRYDIALPARAMS
)( LPCSTR
, LPRASDIALPARAMSA
, BOOL
);
104 typedef DWORD (APIENTRY
* RASGETENTRYDIALPARAMS
)( LPCSTR
, LPRASDIALPARAMSA
, LPBOOL
);
105 typedef DWORD (APIENTRY
* RASENUMDEVICES
)( LPRASDEVINFOA
, LPDWORD
, LPDWORD
);
106 typedef DWORD (APIENTRY
* RASGETCOUNTRYINFO
)( LPRASCTRYINFOA
, LPDWORD
);
107 typedef DWORD (APIENTRY
* RASGETENTRYPROPERTIES
)( LPCSTR
, LPCSTR
, LPRASENTRYA
, LPDWORD
, LPBYTE
, LPDWORD
);
108 typedef DWORD (APIENTRY
* RASSETENTRYPROPERTIES
)( LPCSTR
, LPCSTR
, LPRASENTRYA
, DWORD
, LPBYTE
, DWORD
);
109 typedef DWORD (APIENTRY
* RASRENAMEENTRY
)( LPCSTR
, LPCSTR
, LPCSTR
);
110 typedef DWORD (APIENTRY
* RASDELETEENTRY
)( LPCSTR
, LPCSTR
);
111 typedef DWORD (APIENTRY
* RASVALIDATEENTRYNAME
)( LPCSTR
, LPCSTR
);
112 typedef DWORD (APIENTRY
* RASCONNECTIONNOTIFICATION
)( HRASCONN
, HANDLE
, DWORD
);
114 static const wxChar gs_funcSuffix
= _T('A');
116 typedef DWORD (APIENTRY
* RASDIAL
)( LPRASDIALEXTENSIONS
, LPCWSTR
, LPRASDIALPARAMSW
, DWORD
, LPVOID
, LPHRASCONN
);
117 typedef DWORD (APIENTRY
* RASENUMCONNECTIONS
)( LPRASCONNW
, LPDWORD
, LPDWORD
);
118 typedef DWORD (APIENTRY
* RASENUMENTRIES
)( LPCWSTR
, LPCWSTR
, LPRASENTRYNAMEW
, LPDWORD
, LPDWORD
);
119 typedef DWORD (APIENTRY
* RASGETCONNECTSTATUS
)( HRASCONN
, LPRASCONNSTATUSW
);
120 typedef DWORD (APIENTRY
* RASGETERRORSTRING
)( UINT
, LPWSTR
, DWORD
);
121 typedef DWORD (APIENTRY
* RASHANGUP
)( HRASCONN
);
122 typedef DWORD (APIENTRY
* RASGETPROJECTIONINFO
)( HRASCONN
, RASPROJECTION
, LPVOID
, LPDWORD
);
123 typedef DWORD (APIENTRY
* RASCREATEPHONEBOOKENTRY
)( HWND
, LPCWSTR
);
124 typedef DWORD (APIENTRY
* RASEDITPHONEBOOKENTRY
)( HWND
, LPCWSTR
, LPCWSTR
);
125 typedef DWORD (APIENTRY
* RASSETENTRYDIALPARAMS
)( LPCWSTR
, LPRASDIALPARAMSW
, BOOL
);
126 typedef DWORD (APIENTRY
* RASGETENTRYDIALPARAMS
)( LPCWSTR
, LPRASDIALPARAMSW
, LPBOOL
);
127 typedef DWORD (APIENTRY
* RASENUMDEVICES
)( LPRASDEVINFOW
, LPDWORD
, LPDWORD
);
128 typedef DWORD (APIENTRY
* RASGETCOUNTRYINFO
)( LPRASCTRYINFOW
, LPDWORD
);
129 typedef DWORD (APIENTRY
* RASGETENTRYPROPERTIES
)( LPCWSTR
, LPCWSTR
, LPRASENTRYW
, LPDWORD
, LPBYTE
, LPDWORD
);
130 typedef DWORD (APIENTRY
* RASSETENTRYPROPERTIES
)( LPCWSTR
, LPCWSTR
, LPRASENTRYW
, DWORD
, LPBYTE
, DWORD
);
131 typedef DWORD (APIENTRY
* RASRENAMEENTRY
)( LPCWSTR
, LPCWSTR
, LPCWSTR
);
132 typedef DWORD (APIENTRY
* RASDELETEENTRY
)( LPCWSTR
, LPCWSTR
);
133 typedef DWORD (APIENTRY
* RASVALIDATEENTRYNAME
)( LPCWSTR
, LPCWSTR
);
134 typedef DWORD (APIENTRY
* RASCONNECTIONNOTIFICATION
)( HRASCONN
, HANDLE
, DWORD
);
136 static const wxChar gs_funcSuffix
= _T('W');
137 #endif // ASCII/Unicode
139 // structure passed to the secondary thread
140 struct WXDLLEXPORT wxRasThreadData
147 dialUpManager
= NULL
;
156 CloseHandle(hEventQuit
);
159 CloseHandle(hEventRas
);
162 HWND hWnd
; // window to send notifications to
163 HANDLE hEventRas
, // automatic event which RAS signals when status changes
164 hEventQuit
; // manual event which we signal when we terminate
166 class WXDLLIMPEXP_FWD_CORE wxDialUpManagerMSW
*dialUpManager
; // the owner
169 // ----------------------------------------------------------------------------
170 // wxDialUpManager class for MSW
171 // ----------------------------------------------------------------------------
173 class WXDLLEXPORT wxDialUpManagerMSW
: public wxDialUpManager
177 wxDialUpManagerMSW();
178 virtual ~wxDialUpManagerMSW();
180 // implement base class pure virtuals
181 virtual bool IsOk() const;
182 virtual size_t GetISPNames(wxArrayString
& names
) const;
183 virtual bool Dial(const wxString
& nameOfISP
,
184 const wxString
& username
,
185 const wxString
& password
,
187 virtual bool IsDialing() const;
188 virtual bool CancelDialing();
189 virtual bool HangUp();
190 virtual bool IsAlwaysOnline() const;
191 virtual bool IsOnline() const;
192 virtual void SetOnlineStatus(bool isOnline
= true);
193 virtual bool EnableAutoCheckOnlineStatus(size_t nSeconds
);
194 virtual void DisableAutoCheckOnlineStatus();
195 virtual void SetWellKnownHost(const wxString
& hostname
, int port
);
196 virtual void SetConnectCommand(const wxString
& commandDial
,
197 const wxString
& commandHangup
);
200 void CheckRasStatus();
202 // for wxRasStatusWindowProc
203 void OnConnectStatusChange();
204 void OnDialProgress(RASCONNSTATE rasconnstate
, DWORD dwError
);
207 static HWND
GetRasWindow() { return ms_hwndRas
; }
208 static void ResetRasWindow() { ms_hwndRas
= NULL
; }
209 static wxDialUpManagerMSW
*GetDialer() { return ms_dialer
; }
212 // return the error string for the given RAS error code
213 static wxString
GetErrorString(DWORD error
);
215 // find the (first) handle of the active connection
216 static HRASCONN
FindActiveConnection();
218 // notify the application about status change
219 void NotifyApp(bool connected
, bool fromOurselves
= false) const;
221 // destroy the thread data and the thread itself
222 void CleanUpThreadData();
224 // number of times EnableAutoCheckOnlineStatus() had been called minus the
225 // number of times DisableAutoCheckOnlineStatus() had been called
226 int m_autoCheckLevel
;
228 // timer used for polling RAS status
229 class WXDLLEXPORT RasTimer
: public wxTimer
232 RasTimer(wxDialUpManagerMSW
*dialUpManager
)
233 { m_dialUpManager
= dialUpManager
; }
235 virtual void Notify() { m_dialUpManager
->CheckRasStatus(); }
238 wxDialUpManagerMSW
*m_dialUpManager
;
240 DECLARE_NO_COPY_CLASS(RasTimer
)
241 } m_timerStatusPolling
;
243 // thread handle for the thread sitting on connection change event
246 // data used by this thread and our hidden window to send messages between
248 wxRasThreadData
*m_data
;
250 // the handle of rasapi32.dll when it's loaded
251 wxDynamicLibrary m_dllRas
;
253 // the hidden window we use for passing messages between threads
254 static HWND ms_hwndRas
;
256 // the handle of the connection we initiated or 0 if none
257 static HRASCONN ms_hRasConnection
;
259 // the pointers to RAS functions
260 static RASDIAL ms_pfnRasDial
;
261 static RASENUMCONNECTIONS ms_pfnRasEnumConnections
;
262 static RASENUMENTRIES ms_pfnRasEnumEntries
;
263 static RASGETCONNECTSTATUS ms_pfnRasGetConnectStatus
;
264 static RASGETERRORSTRING ms_pfnRasGetErrorString
;
265 static RASHANGUP ms_pfnRasHangUp
;
266 static RASGETPROJECTIONINFO ms_pfnRasGetProjectionInfo
;
267 static RASCREATEPHONEBOOKENTRY ms_pfnRasCreatePhonebookEntry
;
268 static RASEDITPHONEBOOKENTRY ms_pfnRasEditPhonebookEntry
;
269 static RASSETENTRYDIALPARAMS ms_pfnRasSetEntryDialParams
;
270 static RASGETENTRYDIALPARAMS ms_pfnRasGetEntryDialParams
;
271 static RASENUMDEVICES ms_pfnRasEnumDevices
;
272 static RASGETCOUNTRYINFO ms_pfnRasGetCountryInfo
;
273 static RASGETENTRYPROPERTIES ms_pfnRasGetEntryProperties
;
274 static RASSETENTRYPROPERTIES ms_pfnRasSetEntryProperties
;
275 static RASRENAMEENTRY ms_pfnRasRenameEntry
;
276 static RASDELETEENTRY ms_pfnRasDeleteEntry
;
277 static RASVALIDATEENTRYNAME ms_pfnRasValidateEntryName
;
279 // this function is not supported by Win95
280 static RASCONNECTIONNOTIFICATION ms_pfnRasConnectionNotification
;
282 // if this flag is different from -1, it overrides IsOnline()
283 static int ms_userSpecifiedOnlineStatus
;
285 // this flag tells us if we're online
286 static int ms_isConnected
;
288 // this flag tells us whether a call to RasDial() is in progress
289 static wxDialUpManagerMSW
*ms_dialer
;
291 DECLARE_NO_COPY_CLASS(wxDialUpManagerMSW
)
294 // module to destroy helper window created by wxDialUpManagerMSW
295 class wxDialUpManagerModule
: public wxModule
298 bool OnInit() { return true; }
301 HWND hwnd
= wxDialUpManagerMSW::GetRasWindow();
304 ::DestroyWindow(hwnd
);
305 wxDialUpManagerMSW::ResetRasWindow();
308 if ( gs_classForDialUpWindow
)
310 ::UnregisterClass(wxMSWDIALUP_WNDCLASSNAME
, wxGetInstance());
311 gs_classForDialUpWindow
= NULL
;
316 DECLARE_DYNAMIC_CLASS(wxDialUpManagerModule
)
319 IMPLEMENT_DYNAMIC_CLASS(wxDialUpManagerModule
, wxModule
)
321 // ----------------------------------------------------------------------------
323 // ----------------------------------------------------------------------------
325 static LRESULT WINAPI
wxRasStatusWindowProc(HWND hWnd
, UINT message
,
326 WPARAM wParam
, LPARAM lParam
);
328 static DWORD
wxRasMonitorThread(wxRasThreadData
*data
);
330 static void WINAPI
wxRasDialFunc(UINT unMsg
,
331 RASCONNSTATE rasconnstate
,
334 // ============================================================================
336 // ============================================================================
338 // ----------------------------------------------------------------------------
339 // init the static variables
340 // ----------------------------------------------------------------------------
342 HRASCONN
wxDialUpManagerMSW::ms_hRasConnection
= 0;
344 HWND
wxDialUpManagerMSW::ms_hwndRas
= 0;
346 RASDIAL
wxDialUpManagerMSW::ms_pfnRasDial
= 0;
347 RASENUMCONNECTIONS
wxDialUpManagerMSW::ms_pfnRasEnumConnections
= 0;
348 RASENUMENTRIES
wxDialUpManagerMSW::ms_pfnRasEnumEntries
= 0;
349 RASGETCONNECTSTATUS
wxDialUpManagerMSW::ms_pfnRasGetConnectStatus
= 0;
350 RASGETERRORSTRING
wxDialUpManagerMSW::ms_pfnRasGetErrorString
= 0;
351 RASHANGUP
wxDialUpManagerMSW::ms_pfnRasHangUp
= 0;
352 RASGETPROJECTIONINFO
wxDialUpManagerMSW::ms_pfnRasGetProjectionInfo
= 0;
353 RASCREATEPHONEBOOKENTRY
wxDialUpManagerMSW::ms_pfnRasCreatePhonebookEntry
= 0;
354 RASEDITPHONEBOOKENTRY
wxDialUpManagerMSW::ms_pfnRasEditPhonebookEntry
= 0;
355 RASSETENTRYDIALPARAMS
wxDialUpManagerMSW::ms_pfnRasSetEntryDialParams
= 0;
356 RASGETENTRYDIALPARAMS
wxDialUpManagerMSW::ms_pfnRasGetEntryDialParams
= 0;
357 RASENUMDEVICES
wxDialUpManagerMSW::ms_pfnRasEnumDevices
= 0;
358 RASGETCOUNTRYINFO
wxDialUpManagerMSW::ms_pfnRasGetCountryInfo
= 0;
359 RASGETENTRYPROPERTIES
wxDialUpManagerMSW::ms_pfnRasGetEntryProperties
= 0;
360 RASSETENTRYPROPERTIES
wxDialUpManagerMSW::ms_pfnRasSetEntryProperties
= 0;
361 RASRENAMEENTRY
wxDialUpManagerMSW::ms_pfnRasRenameEntry
= 0;
362 RASDELETEENTRY
wxDialUpManagerMSW::ms_pfnRasDeleteEntry
= 0;
363 RASVALIDATEENTRYNAME
wxDialUpManagerMSW::ms_pfnRasValidateEntryName
= 0;
364 RASCONNECTIONNOTIFICATION
wxDialUpManagerMSW::ms_pfnRasConnectionNotification
= 0;
366 int wxDialUpManagerMSW::ms_userSpecifiedOnlineStatus
= -1;
367 int wxDialUpManagerMSW::ms_isConnected
= -1;
368 wxDialUpManagerMSW
*wxDialUpManagerMSW::ms_dialer
= NULL
;
370 // ----------------------------------------------------------------------------
371 // ctor and dtor: the dynamic linking happens here
372 // ----------------------------------------------------------------------------
374 // the static creator function is implemented here
375 wxDialUpManager
*wxDialUpManager::Create()
377 return new wxDialUpManagerMSW
;
381 // warning about "'this' : used in base member initializer list" - so what?
382 #pragma warning(disable:4355)
385 wxDialUpManagerMSW::wxDialUpManagerMSW()
386 : m_timerStatusPolling(this),
387 m_dllRas(_T("RASAPI32"))
389 // initialize our data
390 m_autoCheckLevel
= 0;
392 m_data
= new wxRasThreadData
;
394 if ( !m_dllRas
.IsLoaded() )
396 wxLogError(_("Dial up functions are unavailable because the remote access service (RAS) is not installed on this machine. Please install it."));
398 else if ( !ms_pfnRasDial
)
400 // resolve the functions we need
402 // this will contain the name of the function we failed to resolve
404 const char *funcName
= NULL
;
406 // get the function from rasapi32.dll and abort if it's not found
407 #define RESOLVE_RAS_FUNCTION(type, name) \
408 ms_pfn##name = (type)m_dllRas.GetSymbol( wxString(_T(#name)) \
410 if ( !ms_pfn##name ) \
416 // a variant of above macro which doesn't abort if the function is
417 // not found in the DLL
418 #define RESOLVE_OPTIONAL_RAS_FUNCTION(type, name) \
419 ms_pfn##name = (type)m_dllRas.GetSymbol( wxString(_T(#name)) \
422 RESOLVE_RAS_FUNCTION(RASDIAL
, RasDial
);
423 RESOLVE_RAS_FUNCTION(RASENUMCONNECTIONS
, RasEnumConnections
);
424 RESOLVE_RAS_FUNCTION(RASENUMENTRIES
, RasEnumEntries
);
425 RESOLVE_RAS_FUNCTION(RASGETCONNECTSTATUS
, RasGetConnectStatus
);
426 RESOLVE_RAS_FUNCTION(RASGETERRORSTRING
, RasGetErrorString
);
427 RESOLVE_RAS_FUNCTION(RASHANGUP
, RasHangUp
);
428 RESOLVE_RAS_FUNCTION(RASGETENTRYDIALPARAMS
, RasGetEntryDialParams
);
430 // suppress error messages about missing (non essential) functions
434 RESOLVE_OPTIONAL_RAS_FUNCTION(RASGETPROJECTIONINFO
, RasGetProjectionInfo
);
435 RESOLVE_OPTIONAL_RAS_FUNCTION(RASCREATEPHONEBOOKENTRY
, RasCreatePhonebookEntry
);
436 RESOLVE_OPTIONAL_RAS_FUNCTION(RASEDITPHONEBOOKENTRY
, RasEditPhonebookEntry
);
437 RESOLVE_OPTIONAL_RAS_FUNCTION(RASSETENTRYDIALPARAMS
, RasSetEntryDialParams
);
438 RESOLVE_OPTIONAL_RAS_FUNCTION(RASGETENTRYPROPERTIES
, RasGetEntryProperties
);
439 RESOLVE_OPTIONAL_RAS_FUNCTION(RASSETENTRYPROPERTIES
, RasSetEntryProperties
);
440 RESOLVE_OPTIONAL_RAS_FUNCTION(RASRENAMEENTRY
, RasRenameEntry
);
441 RESOLVE_OPTIONAL_RAS_FUNCTION(RASDELETEENTRY
, RasDeleteEntry
);
442 RESOLVE_OPTIONAL_RAS_FUNCTION(RASVALIDATEENTRYNAME
, RasValidateEntryName
);
443 RESOLVE_OPTIONAL_RAS_FUNCTION(RASGETCOUNTRYINFO
, RasGetCountryInfo
);
444 RESOLVE_OPTIONAL_RAS_FUNCTION(RASENUMDEVICES
, RasEnumDevices
);
445 RESOLVE_OPTIONAL_RAS_FUNCTION(RASCONNECTIONNOTIFICATION
, RasConnectionNotification
);
448 // keep your preprocessor name space clean
449 #undef RESOLVE_RAS_FUNCTION
450 #undef RESOLVE_OPTIONAL_RAS_FUNCTION
455 wxLogError(_("The version of remote access service (RAS) installed "
456 "on this machine is too old, please upgrade (the "
457 "following required function is missing: %s)."),
464 // enable auto check by default
465 EnableAutoCheckOnlineStatus(0);
468 wxDialUpManagerMSW::~wxDialUpManagerMSW()
473 // ----------------------------------------------------------------------------
475 // ----------------------------------------------------------------------------
477 wxString
wxDialUpManagerMSW::GetErrorString(DWORD error
)
479 wxChar buffer
[512]; // this should be more than enough according to MS docs
480 DWORD dwRet
= ms_pfnRasGetErrorString(error
, buffer
, WXSIZEOF(buffer
));
483 case ERROR_INVALID_PARAMETER
:
484 // this was a standard Win32 error probably
485 return wxString(wxSysErrorMsg(error
));
490 _("Failed to retrieve text of RAS error message"));
493 msg
.Printf(_("unknown error (error code %08x)."), error
);
498 // we want the error message to start from a lower case letter
499 buffer
[0] = (wxChar
)wxTolower(buffer
[0]);
501 return wxString(buffer
);
505 HRASCONN
wxDialUpManagerMSW::FindActiveConnection()
507 // enumerate connections
508 DWORD cbBuf
= sizeof(RASCONN
);
509 LPRASCONN lpRasConn
= (LPRASCONN
)malloc(cbBuf
);
516 lpRasConn
->dwSize
= sizeof(RASCONN
);
518 DWORD nConnections
= 0;
519 DWORD dwRet
= ERROR_BUFFER_TOO_SMALL
;
521 while ( dwRet
== ERROR_BUFFER_TOO_SMALL
)
523 dwRet
= ms_pfnRasEnumConnections(lpRasConn
, &cbBuf
, &nConnections
);
525 if ( dwRet
== ERROR_BUFFER_TOO_SMALL
)
527 LPRASCONN lpRasConnOld
= lpRasConn
;
528 lpRasConn
= (LPRASCONN
)realloc(lpRasConn
, cbBuf
);
537 else if ( dwRet
== 0 )
545 wxLogError(_("Cannot find active dialup connection: %s"),
546 GetErrorString(dwRet
).c_str());
553 switch ( nConnections
)
561 // more than 1 connection - we don't know what to do with this
562 // case, so give a warning but continue (taking the first
563 // connection) - the warning is really needed because this function
564 // is used, for example, to select the connection to hang up and so
565 // we may hang up the wrong connection here...
566 wxLogWarning(_("Several active dialup connections found, choosing one randomly."));
570 // exactly 1 connection, great
571 hrasconn
= lpRasConn
->hrasconn
;
579 void wxDialUpManagerMSW::CleanUpThreadData()
583 if ( !SetEvent(m_data
->hEventQuit
) )
585 wxLogLastError(_T("SetEvent(RasThreadQuit)"));
587 else // sent quit request to the background thread
589 // the thread still needs m_data so we can't free it here, rather
590 // let the thread do it itself
594 CloseHandle(m_hThread
);
606 // ----------------------------------------------------------------------------
608 // ----------------------------------------------------------------------------
610 void wxDialUpManagerMSW::CheckRasStatus()
612 // use int, not bool to compare with -1
613 int isConnected
= FindActiveConnection() != 0;
614 if ( isConnected
!= ms_isConnected
)
616 if ( ms_isConnected
!= -1 )
618 // notify the program
619 NotifyApp(isConnected
!= 0);
621 // else: it's the first time we're called, just update the flag
623 ms_isConnected
= isConnected
;
627 void wxDialUpManagerMSW::NotifyApp(bool connected
, bool fromOurselves
) const
629 wxDialUpEvent
event(connected
, fromOurselves
);
630 (void)wxTheApp
->ProcessEvent(event
);
633 // this function is called whenever the status of any RAS connection on this
634 // machine changes by RAS itself
635 void wxDialUpManagerMSW::OnConnectStatusChange()
637 // we know that status changed, but we don't know whether we're connected
638 // or not - so find it out
642 // this function is called by our callback which we give to RasDial() when
643 // calling it asynchronously
644 void wxDialUpManagerMSW::OnDialProgress(RASCONNSTATE rasconnstate
,
649 // this probably means that CancelDialing() was called and we get
650 // "disconnected" notification
654 // we're only interested in 2 events: connected and disconnected
657 wxLogError(_("Failed to establish dialup connection: %s"),
658 GetErrorString(dwError
).c_str());
660 // we should still call RasHangUp() if we got a non 0 connection
661 if ( ms_hRasConnection
)
663 ms_pfnRasHangUp(ms_hRasConnection
);
664 ms_hRasConnection
= 0;
669 NotifyApp(false /* !connected */, true /* we dialed ourselves */);
671 else if ( rasconnstate
== RASCS_Connected
)
673 ms_isConnected
= true;
676 NotifyApp(true /* connected */, true /* we dialed ourselves */);
680 // ----------------------------------------------------------------------------
681 // implementation of wxDialUpManager functions
682 // ----------------------------------------------------------------------------
684 bool wxDialUpManagerMSW::IsOk() const
686 return m_dllRas
.IsLoaded();
689 size_t wxDialUpManagerMSW::GetISPNames(wxArrayString
& names
) const
692 DWORD size
= sizeof(RASENTRYNAME
);
693 RASENTRYNAME
*rasEntries
= (RASENTRYNAME
*)malloc(size
);
694 rasEntries
->dwSize
= sizeof(RASENTRYNAME
);
700 dwRet
= ms_pfnRasEnumEntries
703 NULL
, // default phone book (or all)
704 rasEntries
, // [out] buffer for the entries
705 &size
, // [in/out] size of the buffer
706 &nEntries
// [out] number of entries fetched
709 if ( dwRet
== ERROR_BUFFER_TOO_SMALL
)
711 // reallocate the buffer
712 void *n
= realloc(rasEntries
, size
);
718 rasEntries
= (RASENTRYNAME
*)n
;
720 else if ( dwRet
!= 0 )
722 // some other error - abort
723 wxLogError(_("Failed to get ISP names: %s"),
724 GetErrorString(dwRet
).c_str());
731 while ( dwRet
!= 0 );
735 for ( size_t n
= 0; n
< (size_t)nEntries
; n
++ )
737 names
.Add(rasEntries
[n
].szEntryName
);
742 // return the number of entries
743 return names
.GetCount();
746 bool wxDialUpManagerMSW::Dial(const wxString
& nameOfISP
,
747 const wxString
& username
,
748 const wxString
& password
,
751 // check preconditions
752 wxCHECK_MSG( IsOk(), false, wxT("using uninitialized wxDialUpManager") );
754 if ( ms_hRasConnection
)
756 wxFAIL_MSG(wxT("there is already an active connection"));
761 // get the default ISP if none given
762 wxString
entryName(nameOfISP
);
766 size_t count
= GetISPNames(names
);
770 // no known ISPs, abort
771 wxLogError(_("Failed to connect: no ISP to dial."));
776 // only one ISP, choose it
777 entryName
= names
[0u];
781 // several ISPs, let the user choose
783 wxString
*strings
= new wxString
[count
];
784 for ( size_t i
= 0; i
< count
; i
++ )
786 strings
[i
] = names
[i
];
789 entryName
= wxGetSingleChoice
791 _("Choose ISP to dial"),
792 _("Please choose which ISP do you want to connect to"),
808 RASDIALPARAMS rasDialParams
;
809 rasDialParams
.dwSize
= sizeof(rasDialParams
);
810 wxStrlcpy(rasDialParams
.szEntryName
, entryName
, RAS_MaxEntryName
);
812 // do we have the username and password?
813 if ( !username
|| !password
)
816 DWORD dwRet
= ms_pfnRasGetEntryDialParams
818 NULL
, // default phonebook
819 &rasDialParams
, // [in/out] the params of this entry
820 &gotPassword
// [out] did we get password?
825 wxLogError(_("Failed to connect: missing username/password."));
832 wxStrlcpy(rasDialParams
.szUserName
, username
, UNLEN
);
833 wxStrlcpy(rasDialParams
.szPassword
, password
, PWLEN
);
836 // default values for other fields
837 rasDialParams
.szPhoneNumber
[0] = '\0';
838 rasDialParams
.szCallbackNumber
[0] = '\0';
839 rasDialParams
.szCallbackNumber
[0] = '\0';
841 rasDialParams
.szDomain
[0] = '*';
842 rasDialParams
.szDomain
[1] = '\0';
844 // apparently, this is not really necessary - passing NULL instead of the
845 // phone book has the same effect
848 if ( wxGetOsVersion() == wxWINDOWS_NT
)
850 // first get the length
851 UINT nLen
= ::GetSystemDirectory(NULL
, 0);
854 if ( !::GetSystemDirectory(phoneBook
.GetWriteBuf(nLen
), nLen
) )
856 wxLogSysError(_("Cannot find the location of address book file"));
859 phoneBook
.UngetWriteBuf();
861 // this is the default phone book
862 phoneBook
<< "\\ras\\rasphone.pbk";
866 // TODO may be we should disable auto check while async dialing is in
871 DWORD dwRet
= ms_pfnRasDial
873 NULL
, // no extended features
874 NULL
, // default phone book file (NT only)
876 0, // use callback for notifications
877 async
? (void *)wxRasDialFunc
// cast needed for gcc 3.1
878 : 0, // no notifications, sync operation
884 // can't pass a wxWCharBuffer through ( ... )
886 wxLogError(_("Failed to initiate dialup connection: %s"),
887 GetErrorString(dwRet
).c_str());
889 wxLogError(_("Failed to establish dialup connection: %s"),
890 GetErrorString(dwRet
).c_str());
892 // we should still call RasHangUp() if we got a non 0 connection
893 if ( ms_hRasConnection
)
895 ms_pfnRasHangUp(ms_hRasConnection
);
896 ms_hRasConnection
= 0;
904 // for async dialing, we're not yet connected
907 ms_isConnected
= true;
913 bool wxDialUpManagerMSW::IsDialing() const
915 return GetDialer() != NULL
;
918 bool wxDialUpManagerMSW::CancelDialing()
926 wxASSERT_MSG( ms_hRasConnection
, wxT("dialing but no connection?") );
933 bool wxDialUpManagerMSW::HangUp()
935 wxCHECK_MSG( IsOk(), false, wxT("using uninitialized wxDialUpManager") );
937 // we may terminate either the connection we initiated or another one which
940 if ( ms_hRasConnection
)
942 hRasConn
= ms_hRasConnection
;
944 ms_hRasConnection
= 0;
948 hRasConn
= FindActiveConnection();
953 wxLogError(_("Cannot hang up - no active dialup connection."));
958 // note that it's not an error if the connection had been already
960 const DWORD dwRet
= ms_pfnRasHangUp(hRasConn
);
961 if ( dwRet
!= 0 && dwRet
!= ERROR_NO_CONNECTION
)
963 wxLogError(_("Failed to terminate the dialup connection: %s"),
964 GetErrorString(dwRet
).c_str());
967 ms_isConnected
= false;
972 bool wxDialUpManagerMSW::IsAlwaysOnline() const
974 // assume no permanent connection by default
975 bool isAlwaysOnline
= false;
977 // try to use WinInet functions
979 // NB: we could probably use wxDynamicLibrary here just as well,
980 // but we allow multiple instances of wxDialUpManagerMSW so
981 // we might as well use the ref counted version here too.
983 wxDynamicLibrary
hDll(_T("WININET"));
984 if ( hDll
.IsLoaded() )
986 typedef BOOL (WINAPI
*INTERNETGETCONNECTEDSTATE
)(LPDWORD
, DWORD
);
987 INTERNETGETCONNECTEDSTATE pfnInternetGetConnectedState
;
989 #define RESOLVE_FUNCTION(type, name) \
990 pfn##name = (type)hDll.GetSymbol(_T(#name))
992 RESOLVE_FUNCTION(INTERNETGETCONNECTEDSTATE
, InternetGetConnectedState
);
994 if ( pfnInternetGetConnectedState
)
997 if ( pfnInternetGetConnectedState(&flags
, 0 /* reserved */) )
999 // there is some connection to the net, see of which type
1000 isAlwaysOnline
= (flags
& (INTERNET_CONNECTION_LAN
|
1001 INTERNET_CONNECTION_PROXY
)) != 0;
1003 //else: no Internet connection at all
1007 return isAlwaysOnline
;
1010 bool wxDialUpManagerMSW::IsOnline() const
1012 wxCHECK_MSG( IsOk(), false, wxT("using uninitialized wxDialUpManager") );
1014 if ( IsAlwaysOnline() )
1020 if ( ms_userSpecifiedOnlineStatus
!= -1 )
1022 // user specified flag overrides our logic
1023 return ms_userSpecifiedOnlineStatus
!= 0;
1027 // return true if there is at least one active connection
1028 return FindActiveConnection() != 0;
1032 void wxDialUpManagerMSW::SetOnlineStatus(bool isOnline
)
1034 wxCHECK_RET( IsOk(), wxT("using uninitialized wxDialUpManager") );
1036 ms_userSpecifiedOnlineStatus
= isOnline
;
1039 bool wxDialUpManagerMSW::EnableAutoCheckOnlineStatus(size_t nSeconds
)
1041 wxCHECK_MSG( IsOk(), false, wxT("using uninitialized wxDialUpManager") );
1043 if ( m_autoCheckLevel
++ )
1049 bool ok
= ms_pfnRasConnectionNotification
!= 0;
1053 // we're running under NT 4.0, Windows 98 or later and can use
1054 // RasConnectionNotification() to be notified by a secondary thread
1056 // first, see if we don't have this thread already running
1057 if ( m_hThread
!= 0 )
1059 if ( ::ResumeThread(m_hThread
) != (DWORD
)-1 )
1062 // we're leaving a zombie thread... but what else can we do?
1063 wxLogLastError(wxT("ResumeThread(RasThread)"));
1069 // create all the stuff we need to be notified about RAS connection
1074 // first create an event to wait on
1075 m_data
->hEventRas
= ::CreateEvent
1077 NULL
, // security attribute (default)
1078 FALSE
, // manual reset (no, it is automatic)
1079 FALSE
, // initial state (not signaled)
1082 if ( !m_data
->hEventRas
)
1084 wxLogLastError(wxT("CreateEvent(RasStatus)"));
1092 // create the event we use to quit the thread: using a manual event
1093 // here avoids problems with missing the event if wxDialUpManagerMSW
1094 // is created and destroyed immediately, before wxRasStatusWindowProc
1095 // starts waiting on the event
1096 m_data
->hEventQuit
= ::CreateEvent
1098 NULL
, // default security
1099 TRUE
, // manual event
1100 FALSE
, // initially non signalled
1103 if ( !m_data
->hEventQuit
)
1105 wxLogLastError(wxT("CreateEvent(RasThreadQuit)"));
1107 CleanUpThreadData();
1113 if ( ok
&& !ms_hwndRas
)
1115 // create a hidden window to receive notification about connections
1117 ms_hwndRas
= wxCreateHiddenWindow
1119 &gs_classForDialUpWindow
,
1120 wxMSWDIALUP_WNDCLASSNAME
,
1121 wxRasStatusWindowProc
1125 wxLogLastError(wxT("CreateWindow(RasHiddenWindow)"));
1127 CleanUpThreadData();
1133 m_data
->hWnd
= ms_hwndRas
;
1137 // start the secondary thread
1138 m_data
->dialUpManager
= this;
1141 m_hThread
= CreateThread
1145 (LPTHREAD_START_ROUTINE
)wxRasMonitorThread
,
1153 wxLogLastError(wxT("CreateThread(RasStatusThread)"));
1155 CleanUpThreadData();
1161 // start receiving RAS notifications
1162 DWORD dwRet
= ms_pfnRasConnectionNotification
1164 (HRASCONN
)INVALID_HANDLE_VALUE
,
1166 3 /* RASCN_Connection | RASCN_Disconnection */
1171 wxLogDebug(wxT("RasConnectionNotification() failed: %s"),
1172 GetErrorString(dwRet
).c_str());
1174 CleanUpThreadData();
1182 // we're running under Windows 95 and have to poll ourselves
1183 // (or, alternatively, the code above for NT/98 failed)
1184 m_timerStatusPolling
.Stop();
1185 if ( nSeconds
== 0 )
1190 m_timerStatusPolling
.Start(nSeconds
* 1000);
1195 void wxDialUpManagerMSW::DisableAutoCheckOnlineStatus()
1197 wxCHECK_RET( IsOk(), wxT("using uninitialized wxDialUpManager") );
1199 if ( --m_autoCheckLevel
!= 0 )
1207 // we have running secondary thread, it's just enough to suspend it
1208 if ( SuspendThread(m_hThread
) == (DWORD
)-1 )
1210 wxLogLastError(wxT("SuspendThread(RasThread)"));
1215 // even simpler - just stop the timer
1216 m_timerStatusPolling
.Stop();
1220 // ----------------------------------------------------------------------------
1221 // stubs which don't do anything in MSW version
1222 // ----------------------------------------------------------------------------
1224 void wxDialUpManagerMSW::SetWellKnownHost(const wxString
& WXUNUSED(hostname
),
1227 wxCHECK_RET( IsOk(), wxT("using uninitialized wxDialUpManager") );
1229 // nothing to do - we don't use this
1232 void wxDialUpManagerMSW::SetConnectCommand(const wxString
& WXUNUSED(dial
),
1233 const wxString
& WXUNUSED(hangup
))
1235 wxCHECK_RET( IsOk(), wxT("using uninitialized wxDialUpManager") );
1237 // nothing to do - we don't use this
1240 // ----------------------------------------------------------------------------
1242 // ----------------------------------------------------------------------------
1244 static DWORD
wxRasMonitorThread(wxRasThreadData
*data
)
1247 handles
[0] = data
->hEventRas
;
1248 handles
[1] = data
->hEventQuit
;
1253 DWORD dwRet
= ::WaitForMultipleObjects(2, handles
, FALSE
, INFINITE
);
1258 // RAS connection status changed
1259 SendMessage(data
->hWnd
, wxWM_RAS_STATUS_CHANGED
,
1263 case WAIT_OBJECT_0
+ 1:
1268 wxFAIL_MSG( _T("unexpected return of WaitForMultipleObjects()") );
1273 // using wxLogLastError() from here is dangerous: we risk to
1274 // deadlock the main thread if wxLog sends output to GUI
1275 DWORD err
= GetLastError();
1276 wxMessageOutputDebug dbg
;
1279 wxT("WaitForMultipleObjects(RasMonitor) failed: 0x%08lx (%s)"),
1283 #endif // __WXDEBUG__
1285 // no sense in continuing, who knows if the handles we're
1286 // waiting for even exist yet...
1291 // we don't need it any more now and if this thread ran, it is our
1292 // responsability to free the data
1298 static LRESULT APIENTRY
wxRasStatusWindowProc(HWND hWnd
, UINT message
,
1299 WPARAM wParam
, LPARAM lParam
)
1303 case wxWM_RAS_STATUS_CHANGED
:
1305 wxRasThreadData
*data
= (wxRasThreadData
*)lParam
;
1306 data
->dialUpManager
->OnConnectStatusChange();
1310 case wxWM_RAS_DIALING_PROGRESS
:
1312 wxDialUpManagerMSW
*dialMan
= wxDialUpManagerMSW::GetDialer();
1314 dialMan
->OnDialProgress((RASCONNSTATE
)wParam
, lParam
);
1319 return ::DefWindowProc(hWnd
, message
, wParam
, lParam
);
1325 static void WINAPI
wxRasDialFunc(UINT
WXUNUSED(unMsg
),
1326 RASCONNSTATE rasconnstate
,
1329 wxDialUpManagerMSW
*dialUpManager
= wxDialUpManagerMSW::GetDialer();
1331 wxCHECK_RET( dialUpManager
, wxT("who started to dial then?") );
1333 SendMessage(wxDialUpManagerMSW::GetRasWindow(), wxWM_RAS_DIALING_PROGRESS
,
1334 rasconnstate
, dwError
);
1337 #endif // __BORLANDC__
1339 #endif // wxUSE_DIALUP_MANAGER