1 // -*- c++ -*- ////////////////////////////////////////////////////////////////
2 // Name: unix/dialup.cpp
3 // Purpose: Network related wxWindows classes and functions
4 // Author: Karsten Ballüder
8 // Copyright: (c) Karsten Ballüder
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 # pragma implementation "dialup.h"
16 // for compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
21 #if wxUSE_DIALUP_MANAGER
27 #include "wx/string.h"
29 #include "wx/dialup.h"
31 #include "wx/filefn.h"
35 #include "wx/process.h"
38 #include "wx/wxchar.h"
45 #define __STRICT_ANSI__
46 #include <sys/socket.h>
48 #include <netinet/in.h>
49 #include <arpa/inet.h>
52 DEFINE_EVENT_TYPE(wxEVT_DIALUP_CONNECTED
)
53 DEFINE_EVENT_TYPE(wxEVT_DIALUP_DISCONNECTED
)
55 // ----------------------------------------------------------------------------
56 // A class which groups functions dealing with connecting to the network from a
57 // workstation using dial-up access to the net. There is at most one instance
58 // of this class in the program accessed via GetDialUpManager().
59 // ----------------------------------------------------------------------------
63 * 1. more configurability for Unix: i.e. how to initiate the connection, how
64 * to check for online status, &c.
65 * 2. add a "long Dial(long connectionId = -1)" function which asks the user
66 * about which connection to dial (this may be done using native dialogs
67 * under NT, need generic dialogs for all others) and returns the identifier
68 * of the selected connection (it's opaque to the application) - it may be
69 * reused later to dial the same connection later (or use strings instead of
71 * 3. add an async version of dialing functions which notify the caller about
72 * the progress (or may be even start another thread to monitor it)
73 * 4. the static creation/accessor functions are not MT-safe - but is this
74 * really crucial? I think we may suppose they're always called from the
78 class WXDLLEXPORT wxDialUpManagerImpl
: public wxDialUpManager
81 wxDialUpManagerImpl();
82 ~wxDialUpManagerImpl();
84 /** Could the dialup manager be initialized correctly? If this function
85 returns FALSE, no other functions will work neither, so it's a good idea
86 to call this function and check its result before calling any other
87 wxDialUpManager methods.
89 virtual bool IsOk() const
92 /** The simplest way to initiate a dial up: this function dials the given
93 ISP (exact meaning of the parameter depends on the platform), returns
94 TRUE on success or FALSE on failure and logs the appropriate error
95 message in the latter case.
96 @param nameOfISP optional paramater for dial program
97 @param username unused
98 @param password unused
100 virtual bool Dial(const wxString
& nameOfISP
,
101 const wxString
& WXUNUSED(username
),
102 const wxString
& WXUNUSED(password
),
105 // Hang up the currently active dial up connection.
106 virtual bool HangUp();
108 // returns TRUE if the computer is connected to the network: under Windows,
109 // this just means that a RAS connection exists, under Unix we check that
110 // the "well-known host" (as specified by SetWellKnownHost) is reachable
111 virtual bool IsOnline() const
114 return m_IsOnline
== Net_Connected
;
117 // do we have a constant net connection?
118 virtual bool IsAlwaysOnline() const;
120 // returns TRUE if (async) dialing is in progress
121 virtual bool IsDialing() const
122 { return m_DialProcess
!= NULL
; }
124 // cancel dialing the number initiated with Dial(async = TRUE)
125 // NB: this won't result in DISCONNECTED event being sent
126 virtual bool CancelDialing();
128 size_t GetISPNames(class wxArrayString
&) const
131 // sometimes the built-in logic for determining the online status may fail,
132 // so, in general, the user should be allowed to override it. This function
133 // allows to forcefully set the online status - whatever our internal
134 // algorithm may think about it.
135 virtual void SetOnlineStatus(bool isOnline
= TRUE
)
136 { m_IsOnline
= isOnline
? Net_Connected
: Net_No
; }
138 // set misc wxDialUpManager options
139 // --------------------------------
141 // enable automatical checks for the connection status and sending of
142 // wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED events. The interval
143 // parameter is only for Unix where we do the check manually: under
144 // Windows, the notification about the change of connection status is
147 // Returns FALSE if couldn't set up automatic check for online status.
148 virtual bool EnableAutoCheckOnlineStatus(size_t nSeconds
);
150 // disable automatic check for connection status change - notice that the
151 // wxEVT_DIALUP_XXX events won't be sent any more neither.
152 virtual void DisableAutoCheckOnlineStatus();
154 // under Unix, the value of well-known host is used to check whether we're
155 // connected to the internet. It's unused under Windows, but this function
156 // is always safe to call. The default value is www.yahoo.com.
157 virtual void SetWellKnownHost(const wxString
& hostname
,
159 /** Sets the commands to start up the network and to hang up
160 again. Used by the Unix implementations only.
162 virtual void SetConnectCommand(const wxString
&command
, const wxString
&hupcmd
)
163 { m_ConnectCommand
= command
; m_HangUpCommand
= hupcmd
; }
165 //private: -- Sun CC 4.2 objects to using NetConnection enum as the return
166 // type if it is declared private
168 // the possible results of testing for Online() status
171 Net_Unknown
= -1, // we couldn't learn anything
172 Net_No
, // no network connection [currently]
173 Net_Connected
// currently connected
176 // the possible net connection types
179 NetDevice_None
= 0x0000, // no network devices (authoritative)
180 NetDevice_Unknown
= 0x0001, // test doesn't work on this OS
181 NetDevice_Modem
= 0x0002, // we have a modem
182 NetDevice_LAN
= 0x0004 // a network card
186 // the current status
187 NetConnection m_IsOnline
;
189 // the connection we have with the network card
190 NetConnection m_connCard
;
192 // Can we use ifconfig to list active devices?
193 int m_CanUseIfconfig
;
195 // The path to ifconfig
196 wxString m_IfconfigPath
;
198 // Can we use ping to find hosts?
200 // The path to ping program
204 wxString m_BeaconHost
;
205 // beacon host portnumber for connect:
208 // command to connect to network
209 wxString m_ConnectCommand
;
210 // command to hang up
211 wxString m_HangUpCommand
;
214 // a timer for regular testing
215 class AutoCheckTimer
*m_timer
;
216 friend class AutoCheckTimer
;
218 // a wxProcess for dialling in background
219 class wxDialProcess
*m_DialProcess
;
220 // pid of dial process
222 friend class wxDialProcess
;
225 void CheckStatus(bool fromAsync
= FALSE
) const;
228 void CheckStatusInternal();
230 // check /proc/net (Linux only) for ppp/eth interfaces, returns the bit
231 // mask of NetDeviceType constants
234 // check output of ifconfig command for PPP/SLIP/PLIP devices, returns the
235 // bit mask of NetDeviceType constants
238 // combines the 2 possible checks for determining the connection status
239 NetConnection
CheckConnectAndPing();
242 NetConnection
CheckPing();
244 // check by connecting to host on given port.
245 NetConnection
CheckConnect();
249 class AutoCheckTimer
: public wxTimer
252 AutoCheckTimer(wxDialUpManagerImpl
*dupman
)
258 virtual bool Start( int millisecs
= -1, bool WXUNUSED(one_shot
) = FALSE
)
259 { m_started
= TRUE
; return wxTimer::Start(millisecs
, FALSE
); }
261 virtual void Notify()
262 { wxLogTrace(wxT("Checking dial up network status.")); m_dupman
->CheckStatus(); }
265 { if ( m_started
) wxTimer::Stop(); }
268 wxDialUpManagerImpl
*m_dupman
;
271 class wxDialProcess
: public wxProcess
274 wxDialProcess(wxDialUpManagerImpl
*dupman
)
278 void Disconnect() { m_DupMan
= NULL
; }
279 virtual void OnTerminate(int WXUNUSED(pid
), int WXUNUSED(status
))
283 m_DupMan
->m_DialProcess
= NULL
;
284 m_DupMan
->CheckStatus(TRUE
);
288 wxDialUpManagerImpl
*m_DupMan
;
292 wxDialUpManagerImpl::wxDialUpManagerImpl()
295 m_connCard
= Net_Unknown
;
296 m_DialProcess
= NULL
;
298 m_CanUseIfconfig
= -1; // unknown
299 m_CanUsePing
= -1; // unknown
300 m_BeaconHost
= WXDIALUP_MANAGER_DEFAULT_BEACONHOST
;
304 m_ConnectCommand
= _T("/usr/etc/ppp");
305 #elif defined(__LINUX__)
306 // default values for Debian/GNU linux
307 m_ConnectCommand
= _T("pon");
308 m_HangUpCommand
= _T("poff");
311 wxChar
* dial
= wxGetenv(_T("WXDIALUP_DIALCMD"));
312 wxChar
* hup
= wxGetenv(_T("WXDIALUP_HUPCMD"));
313 SetConnectCommand(dial
? wxString(dial
) : m_ConnectCommand
,
314 hup
? wxString(hup
) : m_HangUpCommand
);
317 wxDialUpManagerImpl::~wxDialUpManagerImpl()
319 if(m_timer
) delete m_timer
;
322 m_DialProcess
->Disconnect();
323 m_DialProcess
->Detach();
328 wxDialUpManagerImpl::Dial(const wxString
&isp
,
329 const wxString
& WXUNUSED(username
),
330 const wxString
& WXUNUSED(password
),
333 if(m_IsOnline
== Net_Connected
)
337 if(m_ConnectCommand
.Find(wxT("%s")))
338 cmd
.Printf(m_ConnectCommand
,m_ISPname
.c_str());
340 cmd
= m_ConnectCommand
;
344 m_DialProcess
= new wxDialProcess(this);
345 m_DialPId
= (int)wxExecute(cmd
, FALSE
, m_DialProcess
);
348 delete m_DialProcess
;
349 m_DialProcess
= NULL
;
356 return wxExecute(cmd
, /* sync */ TRUE
) == 0;
359 bool wxDialUpManagerImpl::HangUp()
361 if(m_IsOnline
== Net_No
)
365 wxLogError(_("Already dialling ISP."));
369 if(m_HangUpCommand
.Find(wxT("%s")))
370 cmd
.Printf(m_HangUpCommand
,m_ISPname
.c_str(), m_DialProcess
);
372 cmd
= m_HangUpCommand
;
373 return wxExecute(cmd
, /* sync */ TRUE
) == 0;
377 bool wxDialUpManagerImpl::CancelDialing()
381 return kill(m_DialPId
, SIGTERM
) > 0;
384 bool wxDialUpManagerImpl::EnableAutoCheckOnlineStatus(size_t nSeconds
)
386 DisableAutoCheckOnlineStatus();
387 m_timer
= new AutoCheckTimer(this);
388 bool rc
= m_timer
->Start(nSeconds
*1000);
397 void wxDialUpManagerImpl::DisableAutoCheckOnlineStatus()
408 void wxDialUpManagerImpl::SetWellKnownHost(const wxString
& hostname
, int portno
)
410 if(hostname
.Length() == 0)
412 m_BeaconHost
= WXDIALUP_MANAGER_DEFAULT_BEACONHOST
;
417 // does hostname contain a port number?
418 wxString port
= hostname
.After(wxT(':'));
421 m_BeaconHost
= hostname
.Before(wxT(':'));
422 m_BeaconPort
= wxAtoi(port
);
426 m_BeaconHost
= hostname
;
427 m_BeaconPort
= portno
;
432 void wxDialUpManagerImpl::CheckStatus(bool fromAsync
) const
434 // This function calls the CheckStatusInternal() helper function
435 // which is OS - specific and then sends the events.
437 NetConnection oldIsOnline
= m_IsOnline
;
438 ( /* non-const */ (wxDialUpManagerImpl
*)this)->CheckStatusInternal();
440 // now send the events as appropriate: i.e. if the status changed and
441 // if we're in defined state
442 if(m_IsOnline
!= oldIsOnline
443 && m_IsOnline
!= Net_Unknown
444 && oldIsOnline
!= Net_Unknown
)
446 wxDialUpEvent
event(m_IsOnline
== Net_Connected
, ! fromAsync
);
447 (void)wxTheApp
->ProcessEvent(event
);
452 We first try to find out if ppp interface is active. If it is, we assume
453 that we're online but don't have a permanent connection (this is false if a
454 networked machine uses modem to connect to somewhere else, but we can't do
455 anything in this case anyhow).
457 If no ppp interface is detected, we check for eth interface. If it is
458 found, we check that we can, indeed, connect to an Internet host. The logic
459 here is that connection check should be fast enough in this case and we
460 don't want to give false positives in a (common) case of a machine on a LAN
461 which is not connected to the outside.
463 If we didn't find either ppp or eth interfaces, we stop here and decide
464 that we're connected. However, if couldn't check for this, we try to ping a
465 remote host just in case.
467 NB1: Checking for the interface presence can be done in 2 ways
468 a) reading /proc/net/dev under Linux
469 b) spawning ifconfig under any OS
471 The first method is faster but only works under Linux.
473 NB2: pinging, actually, means that we first try to connect "manually" to
474 a port on remove machine and if it fails, we run ping.
477 void wxDialUpManagerImpl::CheckStatusInternal()
479 m_IsOnline
= Net_Unknown
;
481 // first do quick checks to determine what kind of network devices do we
483 int netDeviceType
= CheckProcNet();
484 if ( netDeviceType
== NetDevice_Unknown
)
486 // nothing found, try ifconfig too
487 netDeviceType
= CheckIfconfig();
490 switch ( netDeviceType
)
493 // no network devices, no connection
498 // we still do ping to confirm that we're connected but we only do
499 // it once and hope that the purpose of the network card (i.e.
500 // whether it used for connecting to the Internet or just to a
501 // LAN) won't change during the program lifetime
502 if ( m_connCard
== Net_Unknown
)
504 m_connCard
= CheckConnectAndPing();
506 m_IsOnline
= m_connCard
;
509 case NetDevice_Unknown
:
510 // try to ping just in case
511 m_IsOnline
= CheckConnectAndPing();
514 case NetDevice_LAN
+ NetDevice_Modem
:
515 case NetDevice_Modem
:
516 // assume we're connected
517 m_IsOnline
= Net_Connected
;
521 wxFAIL_MSG(_T("Unexpected netDeviceType"));
525 bool wxDialUpManagerImpl::IsAlwaysOnline() const
527 wxDialUpManagerImpl
*self
= wxConstCast(this, wxDialUpManagerImpl
);
529 int netDeviceType
= self
->CheckProcNet();
530 if ( netDeviceType
== NetDevice_Unknown
)
532 // nothing found, try ifconfig too
533 netDeviceType
= self
->CheckIfconfig();
536 if ( netDeviceType
== NetDevice_Unknown
)
538 // this is the only thing we can do unfortunately...
544 // we are only permanently online if we have a network card
545 return (netDeviceType
& NetDevice_LAN
) != 0;
549 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckConnectAndPing()
553 // first try connecting - faster
554 conn
= CheckConnect();
555 if ( conn
== Net_Unknown
)
564 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckConnect()
566 // second method: try to connect to a well known host:
567 // This can be used under Win 9x, too!
569 struct sockaddr_in serv_addr
;
571 if((hp
= gethostbyname(m_BeaconHost
.mb_str())) == NULL
)
572 return Net_No
; // no DNS no net
574 serv_addr
.sin_family
= hp
->h_addrtype
;
575 memcpy(&serv_addr
.sin_addr
,hp
->h_addr
, hp
->h_length
);
576 serv_addr
.sin_port
= htons(m_BeaconPort
);
579 if( ( sockfd
= socket(hp
->h_addrtype
, SOCK_STREAM
, 0)) < 0)
581 return Net_Unknown
; // no info
584 if( connect(sockfd
, (struct sockaddr
*) &serv_addr
,
585 sizeof(serv_addr
)) >= 0)
588 return Net_Connected
; // we can connect, so we have a network!
590 else // failed to connect
592 if(errno
== ENETUNREACH
)
593 return Net_No
; // network is unreachable
595 return Net_Unknown
; // connect failed, but don't know why
601 wxDialUpManagerImpl::CheckProcNet()
603 // assume that the test doesn't work
604 int netDevice
= NetDevice_Unknown
;
607 if (wxFileExists(_T("/proc/net/route")))
609 // cannot use wxFile::Length because file doesn't support seeking, so
610 // use stdio directly
611 FILE *f
= fopen("/proc/net/route", "rt");
614 // now we know that we will find all devices we may have
615 netDevice
= NetDevice_None
;
619 while (fgets(output
, 256, f
) != NULL
)
621 if ( strstr(output
, "eth") ) // network card
623 netDevice
|= NetDevice_LAN
;
625 else if (strstr(output
,"ppp") // ppp
626 || strstr(output
,"sl") // slip
627 || strstr(output
,"pl")) // plip
629 netDevice
|= NetDevice_Modem
;
643 wxDialUpManagerImpl::CheckIfconfig()
646 m_CanUseIfconfig
= 0;
649 // assume that the test doesn't work
650 int netDevice
= NetDevice_Unknown
;
652 // first time check for ifconfig location
653 if ( m_CanUseIfconfig
== -1 ) // unknown
655 static const wxChar
*ifconfigLocations
[] =
657 _T("/sbin"), // Linux, FreeBSD, Darwin
658 _T("/usr/sbin"), // SunOS, Solaris, AIX, HP-UX
659 _T("/usr/etc"), // IRIX
662 for ( size_t n
= 0; n
< WXSIZEOF(ifconfigLocations
); n
++ )
664 wxString
path(ifconfigLocations
[n
]);
665 path
<< _T("/ifconfig");
667 if ( wxFileExists(path
) )
669 m_IfconfigPath
= path
;
675 if ( m_CanUseIfconfig
!= 0 ) // unknown or yes
677 wxLogNull ln
; // suppress all error messages
679 wxASSERT_MSG( m_IfconfigPath
.length(),
680 _T("can't use ifconfig if it wasn't found") );
682 wxString tmpfile
= wxGetTempFileName( wxT("_wxdialuptest") );
683 wxString cmd
= wxT("/bin/sh -c \'");
684 cmd
<< m_IfconfigPath
;
685 #if defined(__SOLARIS__) || defined (__SUNOS__)
686 // need to add -a flag
688 #elif defined(__LINUX__) || defined(__SGI__)
689 // nothing to be added to ifconfig
690 #elif defined(__FREEBSD__) || defined(__DARWIN__)
693 #elif defined(__HPUX__)
694 // VZ: a wild guess (but without it, ifconfig fails completely)
697 # pragma warning "No ifconfig information for this OS."
698 m_CanUseIfconfig
= 0;
701 cmd
<< wxT(" >") << tmpfile
<< wxT('\'');
702 /* I tried to add an option to wxExecute() to not close stdout,
703 so we could let ifconfig write directly to the tmpfile, but
704 this does not work. That should be faster, as it doesn´t call
705 the shell first. I have no idea why. :-( (KB) */
706 if ( wxExecute(cmd
,TRUE
/* sync */) == 0 )
708 m_CanUseIfconfig
= 1;
710 if( file
.Open(tmpfile
) )
713 if ( file
.ReadAll(&output
) )
715 // FIXME shouldn't we grep for "^ppp"? (VZ)
717 bool hasModem
= FALSE
,
720 #if defined(__SOLARIS__) || defined (__SUNOS__)
721 // dialup device under SunOS/Solaris
722 hasModem
= strstr(output
,"ipdptp") != (char *)NULL
;
723 hasLAN
= strstr(output
, "hme") != (char *)NULL
;
724 #elif defined(__LINUX__) || defined (__FREEBSD__)
725 hasModem
= strstr(output
.fn_str(),"ppp") // ppp
726 || strstr(output
.fn_str(),"sl") // slip
727 || strstr(output
.fn_str(),"pl"); // plip
728 hasLAN
= strstr(output
.fn_str(), "eth") != NULL
;
729 #elif defined(__SGI__) // IRIX
730 hasModem
= strstr(output
, "ppp") != NULL
; // PPP
731 #elif defined(__HPUX__)
732 // if could run ifconfig on interface, then it exists
736 netDevice
= NetDevice_None
;
738 netDevice
|= NetDevice_Modem
;
740 netDevice
|= NetDevice_LAN
;
742 //else: error reading the file
744 //else: error opening the file
746 else // could not run ifconfig correctly
748 m_CanUseIfconfig
= 0; // don´t try again
751 (void) wxRemoveFile(tmpfile
);
758 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckPing()
760 // First time check for ping location. We only use the variant
761 // which does not take arguments, a la GNU.
762 if(m_CanUsePing
== -1) // unknown
765 if (wxFileExists( wxT("SYS$SYSTEM:TCPIP$PING.EXE") ))
766 m_PingPath
= wxT("$SYS$SYSTEM:TCPIP$PING");
768 if (wxFileExists( wxT("/bin/ping") ))
769 m_PingPath
= wxT("/bin/ping");
770 else if (wxFileExists( wxT("/usr/sbin/ping") ))
771 m_PingPath
= wxT("/usr/sbin/ping");
781 // we didn't find ping
785 wxLogNull ln
; // suppress all error messages
786 wxASSERT(m_PingPath
.length());
788 cmd
<< m_PingPath
<< wxT(' ');
789 #if defined(__SOLARIS__) || defined (__SUNOS__)
790 // nothing to add to ping command
791 #elif defined(__LINUX__) || defined (__BSD__) || defined( __VMS )
792 cmd
<< wxT("-c 1 "); // only ping once
793 #elif defined(__HPUX__)
794 cmd
<< wxT("64 1 "); // only ping once (need also specify the packet size)
796 # pragma warning "No Ping information for this OS."
801 if(wxExecute(cmd
, TRUE
/* sync */) == 0)
802 return Net_Connected
;
808 wxDialUpManager
*wxDialUpManager::Create()
810 return new wxDialUpManagerImpl
;
813 #endif // wxUSE_DIALUP_MANAGER