src/common/sckipc.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/sckipc.cpp
   3 // Purpose:     Interprocess communication implementation (wxSocket version)
   4 // Author:      Julian Smart
   5 // Modified by: Guilhem Lavaux (big rewrite) May 1997, 1998
   6 //              Guillermo Rodriguez (updated for wxSocket v2) Jan 2000
   7 //                                  (callbacks deprecated)    Mar 2000
   8 //              Vadim Zeitlin (added support for Unix sockets) Apr 2002
   9 // Created:     1993
  10 // RCS-ID:      $Id$
  11 // Copyright:   (c) Julian Smart 1993
  12 //              (c) Guilhem Lavaux 1997, 1998
  13 //              (c) 2000 Guillermo Rodriguez <guille@iies.es>
  14 // Licence:     wxWindows licence
  15 /////////////////////////////////////////////////////////////////////////////
  16
  17 // ==========================================================================
  18 // declarations
  19 // ==========================================================================
  20
  21 // --------------------------------------------------------------------------
  22 // headers
  23 // --------------------------------------------------------------------------
  24
  25 // For compilers that support precompilation, includes "wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29     #pragma hdrstop
  30 #endif
  31
  32 #if wxUSE_SOCKETS && wxUSE_IPC && wxUSE_STREAMS
  33
  34 #include "wx/sckipc.h"
  35
  36 #ifndef WX_PRECOMP
  37     #include "wx/log.h"
  38     #include "wx/event.h"
  39     #include "wx/module.h"
  40 #endif
  41
  42 #include <stdlib.h>
  43 #include <stdio.h>
  44 #include <errno.h>
  45
  46 #include "wx/socket.h"
  47
  48 // --------------------------------------------------------------------------
  49 // macros and constants
  50 // --------------------------------------------------------------------------
  51
  52 // It seems to be already defined somewhere in the Xt includes.
  53 #ifndef __XT__
  54 // Message codes
  55 enum
  56 {
  57   IPC_EXECUTE = 1,
  58   IPC_REQUEST,
  59   IPC_POKE,
  60   IPC_ADVISE_START,
  61   IPC_ADVISE_REQUEST,
  62   IPC_ADVISE,
  63   IPC_ADVISE_STOP,
  64   IPC_REQUEST_REPLY,
  65   IPC_FAIL,
  66   IPC_CONNECT,
  67   IPC_DISCONNECT
  68 };
  69 #endif
  70
  71 // All sockets will be created with the following flags
  72 #define SCKIPC_FLAGS (wxSOCKET_WAITALL)
  73
  74 // headers needed for umask()
  75 #ifdef __UNIX_LIKE__
  76     #include <sys/types.h>
  77     #include <sys/stat.h>
  78 #endif // __UNIX_LIKE__
  79
  80 // ----------------------------------------------------------------------------
  81 // private functions
  82 // ----------------------------------------------------------------------------
  83
  84 // get the address object for the given server name, the caller must delete it
  85 static wxSockAddress *
  86 GetAddressFromName(const wxString& serverName, const wxString& host = wxEmptyString)
  87 {
  88     // we always use INET sockets under non-Unix systems
  89 #if defined(__UNIX__) && !defined(__WINDOWS__) && !defined(__WINE__) && (!defined(__WXMAC__) || defined(__DARWIN__))
  90     // under Unix, if the server name looks like a path, create a AF_UNIX
  91     // socket instead of AF_INET one
  92     if ( serverName.Find(_T('/')) != wxNOT_FOUND )
  93     {
  94         wxUNIXaddress *addr = new wxUNIXaddress;
  95         addr->Filename(serverName);
  96
  97         return addr;
  98     }
  99 #endif // Unix/!Unix
 100     {
 101         wxIPV4address *addr = new wxIPV4address;
 102         addr->Service(serverName);
 103         if ( !host.empty() )
 104         {
 105             addr->Hostname(host);
 106         }
 107
 108         return addr;
 109     }
 110 }
 111
 112 // --------------------------------------------------------------------------
 113 // wxTCPEventHandler stuff (private class)
 114 // --------------------------------------------------------------------------
 115
 116 class wxTCPEventHandler : public wxEvtHandler
 117 {
 118 public:
 119   wxTCPEventHandler() : wxEvtHandler() {}
 120
 121   void Client_OnRequest(wxSocketEvent& event);
 122   void Server_OnRequest(wxSocketEvent& event);
 123
 124   DECLARE_EVENT_TABLE()
 125   DECLARE_NO_COPY_CLASS(wxTCPEventHandler)
 126 };
 127
 128 enum
 129 {
 130   _CLIENT_ONREQUEST_ID = 1000,
 131   _SERVER_ONREQUEST_ID
 132 };
 133
 134 static wxTCPEventHandler *gs_handler = NULL;
 135
 136 // ==========================================================================
 137 // implementation
 138 // ==========================================================================
 139
 140 IMPLEMENT_DYNAMIC_CLASS(wxTCPServer, wxServerBase)
 141 IMPLEMENT_DYNAMIC_CLASS(wxTCPClient, wxClientBase)
 142 IMPLEMENT_CLASS(wxTCPConnection, wxConnectionBase)
 143
 144 // --------------------------------------------------------------------------
 145 // wxTCPClient
 146 // --------------------------------------------------------------------------
 147
 148 wxTCPClient::wxTCPClient () : wxClientBase()
 149 {
 150 }
 151
 152 wxTCPClient::~wxTCPClient ()
 153 {
 154 }
 155
 156 bool wxTCPClient::ValidHost(const wxString& host)
 157 {
 158   wxIPV4address addr;
 159
 160   return addr.Hostname(host);
 161 }
 162
 163 wxConnectionBase *wxTCPClient::MakeConnection (const wxString& host,
 164                                                const wxString& serverName,
 165                                                const wxString& topic)
 166 {
 167   wxSockAddress *addr = GetAddressFromName(serverName, host);
 168   if ( !addr )
 169       return NULL;
 170
 171   wxSocketClient *client = new wxSocketClient(SCKIPC_FLAGS);
 172   wxSocketStream *stream = new wxSocketStream(*client);
 173   wxDataInputStream *data_is = new wxDataInputStream(*stream);
 174   wxDataOutputStream *data_os = new wxDataOutputStream(*stream);
 175
 176   bool ok = client->Connect(*addr);
 177   delete addr;
 178
 179   if ( ok )
 180   {
 181     unsigned char msg;
 182
 183     // Send topic name, and enquire whether this has succeeded
 184     data_os->Write8(IPC_CONNECT);
 185     data_os->WriteString(topic);
 186
 187     msg = data_is->Read8();
 188
 189     // OK! Confirmation.
 190     if (msg == IPC_CONNECT)
 191     {
 192       wxTCPConnection *connection = (wxTCPConnection *)OnMakeConnection ();
 193
 194       if (connection)
 195       {
 196         if (connection->IsKindOf(CLASSINFO(wxTCPConnection)))
 197         {
 198           connection->m_topic = topic;
 199           connection->m_sock  = client;
 200           connection->m_sockstrm = stream;
 201           connection->m_codeci = data_is;
 202           connection->m_codeco = data_os;
 203           client->SetEventHandler(*gs_handler, _CLIENT_ONREQUEST_ID);
 204           client->SetClientData(connection);
 205           client->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
 206           client->Notify(true);
 207           return connection;
 208         }
 209         else
 210         {
 211           delete connection;
 212           // and fall through to delete everything else
 213         }
 214       }
 215     }
 216   }
 217
 218   // Something went wrong, delete everything
 219   delete data_is;
 220   delete data_os;
 221   delete stream;
 222   client->Destroy();
 223
 224   return NULL;
 225 }
 226
 227 wxConnectionBase *wxTCPClient::OnMakeConnection()
 228 {
 229   return new wxTCPConnection();
 230 }
 231
 232 // --------------------------------------------------------------------------
 233 // wxTCPServer
 234 // --------------------------------------------------------------------------
 235
 236 wxTCPServer::wxTCPServer () : wxServerBase()
 237 {
 238   m_server = NULL;
 239 }
 240
 241 bool wxTCPServer::Create(const wxString& serverName)
 242 {
 243   // Destroy previous server, if any
 244   if (m_server)
 245   {
 246     m_server->SetClientData(NULL);
 247     m_server->Destroy();
 248     m_server = NULL;
 249   }
 250
 251   wxSockAddress *addr = GetAddressFromName(serverName);
 252   if ( !addr )
 253       return false;
 254
 255 #ifdef __UNIX_LIKE__
 256   mode_t umaskOld;
 257   if ( addr->Type() == wxSockAddress::UNIX )
 258   {
 259       // ensure that the file doesn't exist as otherwise calling socket() would
 260       // fail
 261       int rc = remove(serverName.fn_str());
 262       if ( rc < 0 && errno != ENOENT )
 263       {
 264           delete addr;
 265
 266           return false;
 267       }
 268
 269       // also set the umask to prevent the others from reading our file
 270       umaskOld = umask(077);
 271   }
 272   else
 273   {
 274       // unused anyhow but shut down the compiler warnings
 275       umaskOld = 0;
 276   }
 277 #endif // __UNIX_LIKE__
 278
 279   // Create a socket listening on the specified port
 280   m_server = new wxSocketServer(*addr, SCKIPC_FLAGS);
 281
 282 #ifdef __UNIX_LIKE__
 283   if ( addr->Type() == wxSockAddress::UNIX )
 284   {
 285       // restore the umask
 286       umask(umaskOld);
 287
 288       // save the file name to remove it later
 289       m_filename = serverName;
 290   }
 291 #endif // __UNIX_LIKE__
 292
 293   delete addr;
 294
 295   if (!m_server->Ok())
 296   {
 297     m_server->Destroy();
 298     m_server = NULL;
 299
 300     return false;
 301   }
 302
 303   m_server->SetEventHandler(*gs_handler, _SERVER_ONREQUEST_ID);
 304   m_server->SetClientData(this);
 305   m_server->SetNotify(wxSOCKET_CONNECTION_FLAG);
 306   m_server->Notify(true);
 307
 308   return true;
 309 }
 310
 311 wxTCPServer::~wxTCPServer()
 312 {
 313     if (m_server)
 314     {
 315         m_server->SetClientData(NULL);
 316         m_server->Destroy();
 317     }
 318
 319 #ifdef __UNIX_LIKE__
 320     if ( !m_filename.empty() )
 321     {
 322         if ( remove(m_filename.fn_str()) != 0 )
 323         {
 324             wxLogDebug(_T("Stale AF_UNIX file '%s' left."), m_filename.c_str());
 325         }
 326     }
 327 #endif // __UNIX_LIKE__
 328 }
 329
 330 wxConnectionBase *wxTCPServer::OnAcceptConnection( const wxString& WXUNUSED(topic) )
 331 {
 332   return new wxTCPConnection();
 333 }
 334
 335 // --------------------------------------------------------------------------
 336 // wxTCPConnection
 337 // --------------------------------------------------------------------------
 338
 339 wxTCPConnection::wxTCPConnection () : wxConnectionBase()
 340 {
 341   m_sock     = NULL;
 342   m_sockstrm = NULL;
 343   m_codeci   = NULL;
 344   m_codeco   = NULL;
 345 }
 346
 347 wxTCPConnection::wxTCPConnection(void *buffer, size_t size)
 348        : wxConnectionBase(buffer, size)
 349 {
 350   m_sock     = NULL;
 351   m_sockstrm = NULL;
 352   m_codeci   = NULL;
 353   m_codeco   = NULL;
 354 }
 355
 356 wxTCPConnection::~wxTCPConnection ()
 357 {
 358   Disconnect();
 359
 360   if (m_sock)
 361   {
 362     m_sock->SetClientData(NULL);
 363     m_sock->Destroy();
 364   }
 365
 366   /* Delete after destroy */
 367   wxDELETE(m_codeci);
 368   wxDELETE(m_codeco);
 369   wxDELETE(m_sockstrm);
 370 }
 371
 372 void wxTCPConnection::Compress(bool WXUNUSED(on))
 373 {
 374   // Use wxLZWStream
 375 }
 376
 377 // Calls that CLIENT can make.
 378 bool wxTCPConnection::Disconnect ()
 379 {
 380   if ( !GetConnected() )
 381       return true;
 382   // Send the the disconnect message to the peer.
 383   m_codeco->Write8(IPC_DISCONNECT);
 384
 385   if ( m_sock )
 386   {
 387       m_sock->Notify(false);
 388       m_sock->Close();
 389   }
 390
 391   SetConnected(false);
 392
 393   return true;
 394 }
 395
 396 bool wxTCPConnection::DoExecute(const void *data, size_t size, wxIPCFormat format)
 397 {
 398   if (!m_sock->IsConnected())
 399     return false;
 400
 401   // Prepare EXECUTE message
 402   m_codeco->Write8(IPC_EXECUTE);
 403   m_codeco->Write8(format);
 404
 405   m_codeco->Write32(size);
 406   m_sockstrm->Write(data, size);
 407
 408   return true;
 409 }
 410
 411 const void *wxTCPConnection::Request (const wxString& item, size_t *size, wxIPCFormat format)
 412 {
 413   if (!m_sock->IsConnected())
 414     return NULL;
 415
 416   m_codeco->Write8(IPC_REQUEST);
 417   m_codeco->WriteString(item);
 418   m_codeco->Write8(format);
 419
 420   // If Unpack doesn't initialize it.
 421   int ret;
 422
 423   ret = m_codeci->Read8();
 424   if (ret == IPC_FAIL)
 425     return NULL;
 426   else
 427   {
 428     size_t s = m_codeci->Read32();
 429
 430     void *data = GetBufferAtLeast( s );
 431     wxASSERT_MSG(data != NULL,
 432                  _T("Buffer too small in wxTCPConnection::Request") );
 433     m_sockstrm->Read(data, s);
 434
 435     if (size)
 436       *size = s;
 437     return data;
 438   }
 439 }
 440
 441 bool wxTCPConnection::DoPoke (const wxString& item, const void *data, size_t size, wxIPCFormat format)
 442 {
 443   if (!m_sock->IsConnected())
 444     return false;
 445
 446   m_codeco->Write8(IPC_POKE);
 447   m_codeco->WriteString(item);
 448   m_codeco->Write8(format);
 449
 450   m_codeco->Write32(size);
 451   m_sockstrm->Write(data, size);
 452
 453   return true;
 454 }
 455
 456 bool wxTCPConnection::StartAdvise (const wxString& item)
 457 {
 458   int ret;
 459
 460   if (!m_sock->IsConnected())
 461     return false;
 462
 463   m_codeco->Write8(IPC_ADVISE_START);
 464   m_codeco->WriteString(item);
 465
 466   ret = m_codeci->Read8();
 467
 468   if (ret != IPC_FAIL)
 469     return true;
 470   else
 471     return false;
 472 }
 473
 474 bool wxTCPConnection::StopAdvise (const wxString& item)
 475 {
 476   int msg;
 477
 478   if (!m_sock->IsConnected())
 479     return false;
 480
 481   m_codeco->Write8(IPC_ADVISE_STOP);
 482   m_codeco->WriteString(item);
 483
 484   msg = m_codeci->Read8();
 485
 486   if (msg != IPC_FAIL)
 487     return true;
 488   else
 489     return false;
 490 }
 491
 492 // Calls that SERVER can make
 493 bool wxTCPConnection::DoAdvise (const wxString& item,
 494                                 const void *data, size_t size, wxIPCFormat format)
 495 {
 496   if (!m_sock->IsConnected())
 497     return false;
 498
 499   m_codeco->Write8(IPC_ADVISE);
 500   m_codeco->WriteString(item);
 501   m_codeco->Write8(format);
 502
 503   m_codeco->Write32(size);
 504   m_sockstrm->Write(data, size);
 505
 506   return true;
 507 }
 508
 509 // --------------------------------------------------------------------------
 510 // wxTCPEventHandler (private class)
 511 // --------------------------------------------------------------------------
 512
 513 BEGIN_EVENT_TABLE(wxTCPEventHandler, wxEvtHandler)
 514   EVT_SOCKET(_CLIENT_ONREQUEST_ID, wxTCPEventHandler::Client_OnRequest)
 515   EVT_SOCKET(_SERVER_ONREQUEST_ID, wxTCPEventHandler::Server_OnRequest)
 516 END_EVENT_TABLE()
 517
 518 void wxTCPEventHandler::Client_OnRequest(wxSocketEvent &event)
 519 {
 520   wxSocketBase *sock = event.GetSocket();
 521   if (!sock) {          /* No socket, no glory */
 522     return ;
 523   }
 524   wxSocketNotify evt = event.GetSocketEvent();
 525   wxTCPConnection *connection = (wxTCPConnection *)(sock->GetClientData());
 526
 527   // This socket is being deleted; skip this event
 528   if (!connection)
 529     return;
 530
 531   wxDataInputStream *codeci;
 532   wxDataOutputStream *codeco;
 533   wxSocketStream *sockstrm;
 534   wxString topic_name = connection->m_topic;
 535   wxString item;
 536
 537   // We lost the connection: destroy everything
 538   if (evt == wxSOCKET_LOST)
 539   {
 540     sock->Notify(false);
 541     sock->Close();
 542     connection->OnDisconnect();
 543     return;
 544   }
 545
 546   // Receive message number.
 547   codeci = connection->m_codeci;
 548   codeco = connection->m_codeco;
 549   sockstrm = connection->m_sockstrm;
 550   int msg = codeci->Read8();
 551
 552   switch (msg)
 553   {
 554   case IPC_EXECUTE:
 555   {
 556     void *data;
 557     size_t size;
 558     wxIPCFormat format;
 559
 560     format = (wxIPCFormat)codeci->Read8();
 561     size = codeci->Read32();
 562
 563     data = connection->GetBufferAtLeast( size );
 564     wxASSERT_MSG(data != NULL,
 565                  _T("Buffer too small in wxTCPEventHandler::Client_OnRequest") );
 566     sockstrm->Read(data, size);
 567
 568     connection->OnExecute (topic_name, data, size, format);
 569
 570     break;
 571   }
 572   case IPC_ADVISE:
 573   {
 574     item = codeci->ReadString();
 575     wxIPCFormat format = (wxIPCFormat)codeci->Read8();
 576     size_t size = codeci->Read32();
 577     void *data = connection->GetBufferAtLeast( size );
 578     wxASSERT_MSG(data != NULL,
 579                  _T("Buffer too small in wxTCPEventHandler::Client_OnRequest") );
 580     sockstrm->Read(data, size);
 581
 582     connection->OnAdvise (topic_name, item, data, size, format);
 583
 584     break;
 585   }
 586   case IPC_ADVISE_START:
 587   {
 588     item = codeci->ReadString();
 589
 590     bool ok = connection->OnStartAdvise (topic_name, item);
 591     if (ok)
 592       codeco->Write8(IPC_ADVISE_START);
 593     else
 594       codeco->Write8(IPC_FAIL);
 595
 596     break;
 597   }
 598   case IPC_ADVISE_STOP:
 599   {
 600     item = codeci->ReadString();
 601
 602     bool ok = connection->OnStopAdvise (topic_name, item);
 603     if (ok)
 604       codeco->Write8(IPC_ADVISE_STOP);
 605     else
 606       codeco->Write8(IPC_FAIL);
 607
 608     break;
 609   }
 610   case IPC_POKE:
 611   {
 612     item = codeci->ReadString();
 613     wxIPCFormat format = (wxIPCFormat)codeci->Read8();
 614     size_t size = codeci->Read32();
 615     void *data = connection->GetBufferAtLeast( size );
 616     wxASSERT_MSG(data != NULL,
 617                  _T("Buffer too small in wxTCPEventHandler::Client_OnRequest") );
 618     sockstrm->Read(data, size);
 619
 620     connection->OnPoke (topic_name, item, data, size, format);
 621
 622     break;
 623   }
 624   case IPC_REQUEST:
 625   {
 626     wxIPCFormat format;
 627
 628     item = codeci->ReadString();
 629     format = (wxIPCFormat)codeci->Read8();
 630
 631     size_t user_size = wxNO_LEN;
 632     const void *user_data = connection->OnRequest (topic_name, item, &user_size, format);
 633
 634     if (user_data)
 635     {
 636       codeco->Write8(IPC_REQUEST_REPLY);
 637
 638       if (user_size == wxNO_LEN)
 639       {
 640         switch (format)
 641         {
 642           case wxIPC_TEXT:
 643           case wxIPC_UTF8TEXT:
 644             user_size = strlen((const char *)user_data) + 1;  // includes final NUL
 645             break;
 646           case wxIPC_UNICODETEXT:
 647             user_size = (wcslen((const wchar_t *)user_data) + 1) * sizeof(wchar_t);  // includes final NUL
 648             break;
 649           default:
 650             user_size = 0;
 651         }
 652       }
 653
 654       codeco->Write32(user_size);
 655       sockstrm->Write(user_data, user_size);
 656     }
 657     else
 658       codeco->Write8(IPC_FAIL);
 659
 660     break;
 661   }
 662   case IPC_DISCONNECT:
 663   {
 664     sock->Notify(false);
 665     sock->Close();
 666     connection->SetConnected(false);
 667     connection->OnDisconnect();
 668     break;
 669   }
 670   default:
 671     codeco->Write8(IPC_FAIL);
 672     break;
 673   }
 674 }
 675
 676 void wxTCPEventHandler::Server_OnRequest(wxSocketEvent &event)
 677 {
 678   wxSocketServer *server = (wxSocketServer *) event.GetSocket();
 679   if (!server) {                /* No server, Then exit */
 680           return ;
 681   }
 682   wxTCPServer *ipcserv = (wxTCPServer *) server->GetClientData();
 683
 684   // This socket is being deleted; skip this event
 685   if (!ipcserv)
 686     return;
 687
 688   if (event.GetSocketEvent() != wxSOCKET_CONNECTION)
 689     return;
 690
 691   // Accept the connection, getting a new socket
 692   wxSocketBase *sock = server->Accept();
 693   if (!sock) {          /* No socket, no glory */
 694           return ;
 695   }
 696   if (!sock->Ok())
 697   {
 698     sock->Destroy();
 699     return;
 700   }
 701
 702   wxSocketStream *stream     = new wxSocketStream(*sock);
 703   wxDataInputStream *codeci  = new wxDataInputStream(*stream);
 704   wxDataOutputStream *codeco = new wxDataOutputStream(*stream);
 705
 706   int msg;
 707   msg = codeci->Read8();
 708
 709   if (msg == IPC_CONNECT)
 710   {
 711     wxString topic_name;
 712     topic_name = codeci->ReadString();
 713
 714     wxTCPConnection *new_connection =
 715          (wxTCPConnection *)ipcserv->OnAcceptConnection (topic_name);
 716
 717     if (new_connection)
 718     {
 719       if (new_connection->IsKindOf(CLASSINFO(wxTCPConnection)))
 720       {
 721         // Acknowledge success
 722         codeco->Write8(IPC_CONNECT);
 723         new_connection->m_topic = topic_name;
 724         new_connection->m_sock = sock;
 725         new_connection->m_sockstrm = stream;
 726         new_connection->m_codeci = codeci;
 727         new_connection->m_codeco = codeco;
 728         sock->SetEventHandler(*gs_handler, _CLIENT_ONREQUEST_ID);
 729         sock->SetClientData(new_connection);
 730         sock->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
 731         sock->Notify(true);
 732         return;
 733       }
 734       else
 735       {
 736         delete new_connection;
 737         // and fall through to delete everything else
 738       }
 739     }
 740   }
 741
 742   // Something went wrong, send failure message and delete everything
 743   codeco->Write8(IPC_FAIL);
 744
 745   delete codeco;
 746   delete codeci;
 747   delete stream;
 748   sock->Destroy();
 749 }
 750
 751 // --------------------------------------------------------------------------
 752 // wxTCPEventHandlerModule (private class)
 753 // --------------------------------------------------------------------------
 754
 755 class wxTCPEventHandlerModule: public wxModule
 756 {
 757   DECLARE_DYNAMIC_CLASS(wxTCPEventHandlerModule)
 758
 759 public:
 760   bool OnInit() { gs_handler = new wxTCPEventHandler(); return true; }
 761   void OnExit() { wxDELETE(gs_handler); }
 762 };
 763
 764 IMPLEMENT_DYNAMIC_CLASS(wxTCPEventHandlerModule, wxModule)
 765
 766
 767 #endif
 768    // wxUSE_SOCKETS && wxUSE_IPC && wxUSE_STREAMS