1 // -*- c++ -*- ////////////////////////////////////////////////////////////////
2 // Name: src/unix/dialup.cpp
3 // Purpose: Network related wxWidgets classes and functions
4 // Author: Karsten Ballüder
8 // Copyright: (c) Karsten Ballüder
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // for compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
15 #if wxUSE_DIALUP_MANAGER
17 #include "wx/dialup.h"
20 #include "wx/string.h"
29 #include "wx/filename.h"
31 #include "wx/process.h"
39 #define __STRICT_ANSI__
40 #include <sys/socket.h>
42 #include <netinet/in.h>
43 #include <arpa/inet.h>
46 wxDEFINE_EVENT( wxEVT_DIALUP_CONNECTED
, wxDialUpEvent
);
47 wxDEFINE_EVENT( wxEVT_DIALUP_DISCONNECTED
, wxDialUpEvent
);
49 // ----------------------------------------------------------------------------
50 // A class which groups functions dealing with connecting to the network from a
51 // workstation using dial-up access to the net. There is at most one instance
52 // of this class in the program accessed via GetDialUpManager().
53 // ----------------------------------------------------------------------------
57 * 1. more configurability for Unix: i.e. how to initiate the connection, how
58 * to check for online status, &c.
59 * 2. add a "long Dial(long connectionId = -1)" function which asks the user
60 * about which connection to dial (this may be done using native dialogs
61 * under NT, need generic dialogs for all others) and returns the identifier
62 * of the selected connection (it's opaque to the application) - it may be
63 * reused later to dial the same connection later (or use strings instead of
65 * 3. add an async version of dialing functions which notify the caller about
66 * the progress (or may be even start another thread to monitor it)
67 * 4. the static creation/accessor functions are not MT-safe - but is this
68 * really crucial? I think we may suppose they're always called from the
72 class WXDLLEXPORT wxDialUpManagerImpl
: public wxDialUpManager
75 wxDialUpManagerImpl();
76 virtual ~wxDialUpManagerImpl();
78 /** Could the dialup manager be initialized correctly? If this function
79 returns false, no other functions will work neither, so it's a good idea
80 to call this function and check its result before calling any other
81 wxDialUpManager methods.
83 virtual bool IsOk() const
86 /** The simplest way to initiate a dial up: this function dials the given
87 ISP (exact meaning of the parameter depends on the platform), returns
88 true on success or false on failure and logs the appropriate error
89 message in the latter case.
90 @param nameOfISP optional paramater for dial program
91 @param username unused
92 @param password unused
94 virtual bool Dial(const wxString
& nameOfISP
,
95 const wxString
& WXUNUSED(username
),
96 const wxString
& WXUNUSED(password
),
99 // Hang up the currently active dial up connection.
100 virtual bool HangUp();
102 // returns true if the computer is connected to the network: under Windows,
103 // this just means that a RAS connection exists, under Unix we check that
104 // the "well-known host" (as specified by SetWellKnownHost) is reachable
105 virtual bool IsOnline() const
108 return m_IsOnline
== Net_Connected
;
111 // do we have a constant net connection?
112 virtual bool IsAlwaysOnline() const;
114 // returns true if (async) dialing is in progress
115 virtual bool IsDialing() const
116 { return m_DialProcess
!= NULL
; }
118 // cancel dialing the number initiated with Dial(async = true)
119 // NB: this won't result in DISCONNECTED event being sent
120 virtual bool CancelDialing();
122 size_t GetISPNames(class wxArrayString
&) const
125 // sometimes the built-in logic for determining the online status may fail,
126 // so, in general, the user should be allowed to override it. This function
127 // allows to forcefully set the online status - whatever our internal
128 // algorithm may think about it.
129 virtual void SetOnlineStatus(bool isOnline
= true)
130 { m_IsOnline
= isOnline
? Net_Connected
: Net_No
; }
132 // set misc wxDialUpManager options
133 // --------------------------------
135 // enable automatical checks for the connection status and sending of
136 // wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED events. The interval
137 // parameter is only for Unix where we do the check manually: under
138 // Windows, the notification about the change of connection status is
141 // Returns false if couldn't set up automatic check for online status.
142 virtual bool EnableAutoCheckOnlineStatus(size_t nSeconds
);
144 // disable automatic check for connection status change - notice that the
145 // wxEVT_DIALUP_XXX events won't be sent any more neither.
146 virtual void DisableAutoCheckOnlineStatus();
148 // under Unix, the value of well-known host is used to check whether we're
149 // connected to the internet. It's unused under Windows, but this function
150 // is always safe to call. The default value is www.yahoo.com.
151 virtual void SetWellKnownHost(const wxString
& hostname
,
153 /** Sets the commands to start up the network and to hang up
154 again. Used by the Unix implementations only.
156 virtual void SetConnectCommand(const wxString
&command
, const wxString
&hupcmd
)
157 { m_ConnectCommand
= command
; m_HangUpCommand
= hupcmd
; }
159 //private: -- Sun CC 4.2 objects to using NetConnection enum as the return
160 // type if it is declared private
162 // the possible results of testing for Online() status
165 Net_Unknown
= -1, // we couldn't learn anything
166 Net_No
, // no network connection [currently]
167 Net_Connected
// currently connected
170 // the possible net connection types
173 NetDevice_None
= 0x0000, // no network devices (authoritative)
174 NetDevice_Unknown
= 0x0001, // test doesn't work on this OS
175 NetDevice_Modem
= 0x0002, // we have a modem
176 NetDevice_LAN
= 0x0004 // a network card
180 // the current status
181 NetConnection m_IsOnline
;
183 // the connection we have with the network card
184 NetConnection m_connCard
;
186 // Can we use ifconfig to list active devices?
187 int m_CanUseIfconfig
;
189 // The path to ifconfig
190 wxString m_IfconfigPath
;
192 // Can we use ping to find hosts?
194 // The path to ping program
198 wxString m_BeaconHost
;
199 // beacon host portnumber for connect:
202 // command to connect to network
203 wxString m_ConnectCommand
;
204 // command to hang up
205 wxString m_HangUpCommand
;
208 // a timer for regular testing
209 class AutoCheckTimer
*m_timer
;
210 friend class AutoCheckTimer
;
212 // a wxProcess for dialling in background
213 class wxDialProcess
*m_DialProcess
;
214 // pid of dial process
216 friend class wxDialProcess
;
219 void CheckStatus(bool fromAsync
= false) const;
222 void CheckStatusInternal();
224 // check /proc/net (Linux only) for ppp/eth interfaces, returns the bit
225 // mask of NetDeviceType constants
228 // check output of ifconfig command for PPP/SLIP/PLIP devices, returns the
229 // bit mask of NetDeviceType constants
232 // combines the 2 possible checks for determining the connection status
233 NetConnection
CheckConnectAndPing();
236 NetConnection
CheckPing();
238 // check by connecting to host on given port.
239 NetConnection
CheckConnect();
243 class AutoCheckTimer
: public wxTimer
246 AutoCheckTimer(wxDialUpManagerImpl
*dupman
)
251 virtual void Notify()
253 wxLogTrace(wxT("dialup"), wxT("Checking dial up network status."));
255 m_dupman
->CheckStatus();
259 wxDialUpManagerImpl
*m_dupman
;
262 class wxDialProcess
: public wxProcess
265 wxDialProcess(wxDialUpManagerImpl
*dupman
)
269 void Disconnect() { m_DupMan
= NULL
; }
270 virtual void OnTerminate(int WXUNUSED(pid
), int WXUNUSED(status
))
274 m_DupMan
->m_DialProcess
= NULL
;
275 m_DupMan
->CheckStatus(true);
279 wxDialUpManagerImpl
*m_DupMan
;
283 wxDialUpManagerImpl::wxDialUpManagerImpl()
286 m_connCard
= Net_Unknown
;
287 m_DialProcess
= NULL
;
289 m_CanUseIfconfig
= -1; // unknown
290 m_CanUsePing
= -1; // unknown
291 m_BeaconHost
= WXDIALUP_MANAGER_DEFAULT_BEACONHOST
;
295 m_ConnectCommand
= wxT("/usr/etc/ppp");
296 #elif defined(__LINUX__)
297 // default values for Debian/GNU linux
298 m_ConnectCommand
= wxT("pon");
299 m_HangUpCommand
= wxT("poff");
302 wxChar
* dial
= wxGetenv(wxT("WXDIALUP_DIALCMD"));
303 wxChar
* hup
= wxGetenv(wxT("WXDIALUP_HUPCMD"));
304 SetConnectCommand(dial
? wxString(dial
) : m_ConnectCommand
,
305 hup
? wxString(hup
) : m_HangUpCommand
);
308 wxDialUpManagerImpl::~wxDialUpManagerImpl()
310 if(m_timer
) delete m_timer
;
313 m_DialProcess
->Disconnect();
314 m_DialProcess
->Detach();
319 wxDialUpManagerImpl::Dial(const wxString
&isp
,
320 const wxString
& WXUNUSED(username
),
321 const wxString
& WXUNUSED(password
),
324 if(m_IsOnline
== Net_Connected
)
328 if(m_ConnectCommand
.Find(wxT("%s")))
329 cmd
.Printf(m_ConnectCommand
,m_ISPname
.c_str());
331 cmd
= m_ConnectCommand
;
335 m_DialProcess
= new wxDialProcess(this);
336 m_DialPId
= (int)wxExecute(cmd
, false, m_DialProcess
);
339 wxDELETE(m_DialProcess
);
346 return wxExecute(cmd
, /* sync */ true) == 0;
349 bool wxDialUpManagerImpl::HangUp()
351 if(m_IsOnline
== Net_No
)
355 wxLogError(_("Already dialling ISP."));
359 if(m_HangUpCommand
.Find(wxT("%s")))
360 cmd
.Printf(m_HangUpCommand
,m_ISPname
.c_str(), m_DialProcess
);
362 cmd
= m_HangUpCommand
;
363 return wxExecute(cmd
, /* sync */ true) == 0;
367 bool wxDialUpManagerImpl::CancelDialing()
371 return kill(m_DialPId
, SIGTERM
) > 0;
374 bool wxDialUpManagerImpl::EnableAutoCheckOnlineStatus(size_t nSeconds
)
376 DisableAutoCheckOnlineStatus();
377 m_timer
= new AutoCheckTimer(this);
378 bool rc
= m_timer
->Start(nSeconds
*1000);
386 void wxDialUpManagerImpl::DisableAutoCheckOnlineStatus()
396 void wxDialUpManagerImpl::SetWellKnownHost(const wxString
& hostname
, int portno
)
398 if(hostname
.length() == 0)
400 m_BeaconHost
= WXDIALUP_MANAGER_DEFAULT_BEACONHOST
;
405 // does hostname contain a port number?
406 wxString port
= hostname
.After(wxT(':'));
409 m_BeaconHost
= hostname
.Before(wxT(':'));
410 m_BeaconPort
= wxAtoi(port
);
414 m_BeaconHost
= hostname
;
415 m_BeaconPort
= portno
;
420 void wxDialUpManagerImpl::CheckStatus(bool fromAsync
) const
422 // This function calls the CheckStatusInternal() helper function
423 // which is OS - specific and then sends the events.
425 NetConnection oldIsOnline
= m_IsOnline
;
426 ( /* non-const */ (wxDialUpManagerImpl
*)this)->CheckStatusInternal();
428 // now send the events as appropriate: i.e. if the status changed and
429 // if we're in defined state
430 if(m_IsOnline
!= oldIsOnline
431 && m_IsOnline
!= Net_Unknown
432 && oldIsOnline
!= Net_Unknown
)
434 wxDialUpEvent
event(m_IsOnline
== Net_Connected
, ! fromAsync
);
435 (void)wxTheApp
->ProcessEvent(event
);
440 We first try to find out if ppp interface is active. If it is, we assume
441 that we're online but don't have a permanent connection (this is false if a
442 networked machine uses modem to connect to somewhere else, but we can't do
443 anything in this case anyhow).
445 If no ppp interface is detected, we check for eth interface. If it is
446 found, we check that we can, indeed, connect to an Internet host. The logic
447 here is that connection check should be fast enough in this case and we
448 don't want to give false positives in a (common) case of a machine on a LAN
449 which is not connected to the outside.
451 If we didn't find either ppp or eth interfaces, we stop here and decide
452 that we're connected. However, if couldn't check for this, we try to ping a
453 remote host just in case.
455 NB1: Checking for the interface presence can be done in 2 ways
456 a) reading /proc/net/dev under Linux
457 b) spawning ifconfig under any OS
459 The first method is faster but only works under Linux.
461 NB2: pinging, actually, means that we first try to connect "manually" to
462 a port on remove machine and if it fails, we run ping.
465 void wxDialUpManagerImpl::CheckStatusInternal()
467 m_IsOnline
= Net_Unknown
;
469 // first do quick checks to determine what kind of network devices do we
471 int netDeviceType
= CheckProcNet();
472 if ( netDeviceType
== NetDevice_Unknown
)
474 // nothing found, try ifconfig too
475 netDeviceType
= CheckIfconfig();
478 switch ( netDeviceType
)
481 // no network devices, no connection
486 // we still do ping to confirm that we're connected but we only do
487 // it once and hope that the purpose of the network card (i.e.
488 // whether it used for connecting to the Internet or just to a
489 // LAN) won't change during the program lifetime
490 if ( m_connCard
== Net_Unknown
)
492 m_connCard
= CheckConnectAndPing();
494 m_IsOnline
= m_connCard
;
497 case NetDevice_Unknown
:
498 // try to ping just in case
499 m_IsOnline
= CheckConnectAndPing();
502 case NetDevice_LAN
+ NetDevice_Modem
:
503 case NetDevice_Modem
:
504 // assume we're connected
505 m_IsOnline
= Net_Connected
;
509 wxFAIL_MSG(wxT("Unexpected netDeviceType"));
513 bool wxDialUpManagerImpl::IsAlwaysOnline() const
515 wxDialUpManagerImpl
*self
= wxConstCast(this, wxDialUpManagerImpl
);
517 int netDeviceType
= self
->CheckProcNet();
518 if ( netDeviceType
== NetDevice_Unknown
)
520 // nothing found, try ifconfig too
521 netDeviceType
= self
->CheckIfconfig();
524 if ( netDeviceType
== NetDevice_Unknown
)
526 // this is the only thing we can do unfortunately...
532 // we are only permanently online if we have a network card
533 return (netDeviceType
& NetDevice_LAN
) != 0;
537 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckConnectAndPing()
541 // first try connecting - faster
542 conn
= CheckConnect();
543 if ( conn
== Net_Unknown
)
552 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckConnect()
554 // second method: try to connect to a well known host:
555 // This can be used under Win 9x, too!
557 struct sockaddr_in serv_addr
;
559 if((hp
= gethostbyname(m_BeaconHost
.mb_str())) == NULL
)
560 return Net_No
; // no DNS no net
562 serv_addr
.sin_family
= hp
->h_addrtype
;
563 memcpy(&serv_addr
.sin_addr
,hp
->h_addr
, hp
->h_length
);
564 serv_addr
.sin_port
= htons(m_BeaconPort
);
567 if( ( sockfd
= socket(hp
->h_addrtype
, SOCK_STREAM
, 0)) < 0)
569 return Net_Unknown
; // no info
572 if( connect(sockfd
, (struct sockaddr
*) &serv_addr
,
573 sizeof(serv_addr
)) >= 0)
576 return Net_Connected
; // we can connect, so we have a network!
578 else // failed to connect
581 if(errno
== ENETUNREACH
)
582 return Net_No
; // network is unreachable
585 return Net_Unknown
; // connect failed, but don't know why
591 wxDialUpManagerImpl::CheckProcNet()
593 // assume that the test doesn't work
594 int netDevice
= NetDevice_Unknown
;
597 if (wxFileExists(wxT("/proc/net/route")))
599 // cannot use wxFile::Length because file doesn't support seeking, so
600 // use stdio directly
601 FILE *f
= fopen("/proc/net/route", "rt");
604 // now we know that we will find all devices we may have
605 netDevice
= NetDevice_None
;
609 while (fgets(output
, 256, f
) != NULL
)
611 if ( strstr(output
, "eth") ) // network card
613 netDevice
|= NetDevice_LAN
;
615 else if (strstr(output
,"ppp") // ppp
616 || strstr(output
,"sl") // slip
617 || strstr(output
,"pl")) // plip
619 netDevice
|= NetDevice_Modem
;
633 wxDialUpManagerImpl::CheckIfconfig()
636 m_CanUseIfconfig
= 0;
639 // assume that the test doesn't work
640 int netDevice
= NetDevice_Unknown
;
642 // first time check for ifconfig location
643 if ( m_CanUseIfconfig
== -1 ) // unknown
645 static const wxChar
*const ifconfigLocations
[] =
647 wxT("/sbin"), // Linux, FreeBSD, Darwin
648 wxT("/usr/sbin"), // SunOS, Solaris, AIX, HP-UX
649 wxT("/usr/etc"), // IRIX
650 wxT("/etc"), // AIX 5
653 for ( size_t n
= 0; n
< WXSIZEOF(ifconfigLocations
); n
++ )
655 wxString
path(ifconfigLocations
[n
]);
656 path
<< wxT("/ifconfig");
658 if ( wxFileExists(path
) )
660 m_IfconfigPath
= path
;
666 if ( m_CanUseIfconfig
!= 0 ) // unknown or yes
668 wxLogNull ln
; // suppress all error messages
670 wxASSERT_MSG( m_IfconfigPath
.length(),
671 wxT("can't use ifconfig if it wasn't found") );
673 wxString tmpfile
= wxFileName::CreateTempFileName( wxT("_wxdialuptest") );
674 wxString cmd
= wxT("/bin/sh -c \'");
675 cmd
<< m_IfconfigPath
;
676 #if defined(__AIX__) || \
677 defined(__NETBSD__) || \
678 defined(__OSF__) || \
679 defined(__SOLARIS__) || defined (__SUNOS__)
680 // need to add -a flag
682 #elif defined(__LINUX__) || defined(__SGI__)
683 // nothing to be added to ifconfig
684 #elif defined(__FREEBSD__) || defined(__DARWIN__) || defined(__QNX__)
687 #elif defined(__HPUX__)
688 // VZ: a wild guess (but without it, ifconfig fails completely)
691 #if defined(__GNUG__)
692 #warning "No ifconfig information for this OS."
694 #pragma warning "No ifconfig information for this OS."
697 m_CanUseIfconfig
= 0;
700 cmd
<< wxT(" >") << tmpfile
<< wxT('\'');
701 /* I tried to add an option to wxExecute() to not close stdout,
702 so we could let ifconfig write directly to the tmpfile, but
703 this does not work. That should be faster, as it doesn't call
704 the shell first. I have no idea why. :-( (KB) */
705 if ( wxExecute(cmd
,true /* sync */) == 0 )
707 m_CanUseIfconfig
= 1;
709 if( file
.Open(tmpfile
) )
712 if ( file
.ReadAll(&output
) )
714 // FIXME shouldn't we grep for "^ppp"? (VZ)
716 bool hasModem
= false,
719 #if defined(__SOLARIS__) || defined (__SUNOS__)
720 // dialup device under SunOS/Solaris
721 hasModem
= strstr(output
.fn_str(),"ipdptp") != NULL
;
722 hasLAN
= strstr(output
.fn_str(), "hme") != NULL
;
723 #elif defined(__LINUX__) || defined (__FREEBSD__) || defined (__QNX__)
724 hasModem
= strstr(output
.fn_str(),"ppp") // ppp
725 || strstr(output
.fn_str(),"sl") // slip
726 || strstr(output
.fn_str(),"pl"); // plip
727 hasLAN
= strstr(output
.fn_str(), "eth") != NULL
;
728 #elif defined(__SGI__) // IRIX
729 hasModem
= strstr(output
.fn_str(), "ppp") != NULL
; // PPP
730 #elif defined(__HPUX__)
731 // if could run ifconfig on interface, then it exists
735 netDevice
= NetDevice_None
;
737 netDevice
|= NetDevice_Modem
;
739 netDevice
|= NetDevice_LAN
;
741 //else: error reading the file
743 //else: error opening the file
745 else // could not run ifconfig correctly
747 m_CanUseIfconfig
= 0; // don't try again
750 (void) wxRemoveFile(tmpfile
);
757 wxDialUpManagerImpl::NetConnection
wxDialUpManagerImpl::CheckPing()
759 // First time check for ping location. We only use the variant
760 // which does not take arguments, a la GNU.
761 if(m_CanUsePing
== -1) // unknown
764 if (wxFileExists( wxT("SYS$SYSTEM:TCPIP$PING.EXE") ))
765 m_PingPath
= wxT("$SYS$SYSTEM:TCPIP$PING");
766 #elif defined(__AIX__)
767 m_PingPath
= wxT("/etc/ping");
768 #elif defined(__SGI__)
769 m_PingPath
= wxT("/usr/etc/ping");
771 if (wxFileExists( wxT("/bin/ping") ))
772 m_PingPath
= wxT("/bin/ping");
773 else if (wxFileExists( wxT("/usr/sbin/ping") ))
774 m_PingPath
= wxT("/usr/sbin/ping");
784 // we didn't find ping
788 wxLogNull ln
; // suppress all error messages
789 wxASSERT(m_PingPath
.length());
791 cmd
<< m_PingPath
<< wxT(' ');
792 #if defined(__SOLARIS__) || defined (__SUNOS__)
793 // nothing to add to ping command
794 #elif defined(__AIX__) || \
795 defined (__BSD__) || \
796 defined(__LINUX__) || \
797 defined(__OSF__) || \
798 defined(__SGI__) || \
801 cmd
<< wxT("-c 1 "); // only ping once
802 #elif defined(__HPUX__)
803 cmd
<< wxT("64 1 "); // only ping once (need also specify the packet size)
805 #if defined(__GNUG__)
806 #warning "No Ping information for this OS."
808 #pragma warning "No Ping information for this OS."
815 if(wxExecute(cmd
, true /* sync */) == 0)
816 return Net_Connected
;
822 wxDialUpManager
*wxDialUpManager::Create()
824 return new wxDialUpManagerImpl
;
827 #endif // wxUSE_DIALUP_MANAGER