src/MuleUDPSocket.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2005-2011 aMule Team ( admin@amule.org / http://www.amule.org )
   5 //
   6 // Any parts of this program derived from the xMule, lMule or eMule project,
   7 // or contributed by third-party developers are copyrighted by their
   8 // respective authors.
   9 //
  10 // This program is free software; you can redistribute it and/or modify
  11 // it under the terms of the GNU General Public License as published by
  12 // the Free Software Foundation; either version 2 of the License, or
  13 // (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 // GNU General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  23 //
  24
  25 #include <wx/wx.h>
  26 #include <algorithm>
  27
  28 #include "MuleUDPSocket.h"              // Interface declarations
  29
  30 #include <protocol/ed2k/Constants.h>
  31
  32 #include "amule.h"                      // Needed for theApp
  33 #include "GetTickCount.h"               // Needed for GetTickCount()
  34 #include "Packet.h"                     // Needed for CPacket
  35 #include <common/StringFunctions.h>     // Needed for unicode2char
  36 #include "Proxy.h"                      // Needed for CDatagramSocketProxy
  37 #include "Logger.h"                     // Needed for AddDebugLogLine{C,N}
  38 #include "UploadBandwidthThrottler.h"
  39 #include "EncryptedDatagramSocket.h"
  40 #include "OtherFunctions.h"
  41 #include "kademlia/kademlia/Prefs.h"
  42 #include "ClientList.h"
  43 #include "Preferences.h"
  44
  45
  46 CMuleUDPSocket::CMuleUDPSocket(const wxString& name, int id, const amuleIPV4Address& address, const CProxyData* ProxyData)
  47 :
  48 m_busy(false),
  49 m_name(name),
  50 m_id(id),
  51 m_addr(address),
  52 m_proxy(ProxyData),
  53 m_socket(NULL)
  54 {
  55 }
  56
  57
  58 CMuleUDPSocket::~CMuleUDPSocket()
  59 {
  60         theApp->uploadBandwidthThrottler->RemoveFromAllQueues(this);
  61
  62         wxMutexLocker lock(m_mutex);
  63         DestroySocket();
  64 }
  65
  66
  67 void CMuleUDPSocket::CreateSocket()
  68 {
  69         wxCHECK_RET(!m_socket, wxT("Socket already opened."));
  70
  71         m_socket = new CEncryptedDatagramSocket(m_addr, wxSOCKET_NOWAIT, m_proxy);
  72         m_socket->SetClientData(this);
  73         m_socket->SetEventHandler(*theApp, m_id);
  74         m_socket->SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_OUTPUT_FLAG | wxSOCKET_LOST_FLAG);
  75         m_socket->Notify(true);
  76
  77         if (!m_socket->Ok()) {
  78                 AddDebugLogLineC(logMuleUDP, wxT("Failed to create valid ") + m_name);
  79                 DestroySocket();
  80         } else {
  81                 AddLogLineN(wxString(wxT("Created ")) << m_name << wxT(" at port ") << m_addr.Service());
  82         }
  83 }
  84
  85
  86 void CMuleUDPSocket::DestroySocket()
  87 {
  88         if (m_socket) {
  89                 AddDebugLogLineN(logMuleUDP, wxT("Shutting down ") + m_name);
  90                 m_socket->SetNotify(0);
  91                 m_socket->Notify(false);
  92                 m_socket->Close();
  93                 m_socket->Destroy();
  94                 m_socket = NULL;
  95         }
  96 }
  97
  98
  99 void CMuleUDPSocket::Open()
 100 {
 101         wxMutexLocker lock(m_mutex);
 102
 103         CreateSocket();
 104 }
 105
 106
 107 void CMuleUDPSocket::Close()
 108 {
 109         wxMutexLocker lock(m_mutex);
 110
 111         DestroySocket();
 112 }
 113
 114
 115 void CMuleUDPSocket::OnSend(int errorCode)
 116 {
 117         if (errorCode) {
 118                 return;
 119         }
 120
 121         {
 122                 wxMutexLocker lock(m_mutex);
 123                 m_busy = false;
 124                 if (m_queue.empty()) {
 125                         return;
 126                 }
 127         }
 128
 129         theApp->uploadBandwidthThrottler->QueueForSendingControlPacket(this);
 130 }
 131
 132
 133 const unsigned UDP_BUFFER_SIZE = 16384;
 134
 135
 136 void CMuleUDPSocket::OnReceive(int errorCode)
 137 {
 138         AddDebugLogLineN(logMuleUDP, CFormat(wxT("Got UDP callback for read: Error %i Socket state %i"))
 139                 % errorCode % Ok());
 140
 141         char buffer[UDP_BUFFER_SIZE];
 142         wxIPV4address addr;
 143         unsigned length = 0;
 144         bool error = false;
 145         int lastError = 0;
 146
 147         {
 148                 wxMutexLocker lock(m_mutex);
 149
 150                 if (errorCode || (m_socket == NULL) || !m_socket->Ok()) {
 151                         DestroySocket();
 152                         CreateSocket();
 153
 154                         return;
 155                 }
 156
 157
 158                 length = m_socket->RecvFrom(addr, buffer, UDP_BUFFER_SIZE).LastCount();
 159                 error = m_socket->Error();
 160                 lastError = m_socket->LastError();
 161         }
 162
 163         const uint32 ip = StringIPtoUint32(addr.IPAddress());
 164         const uint16 port = addr.Service();
 165         if (error) {
 166                 OnReceiveError(lastError, ip, port);
 167         } else if (length < 2) {
 168                 // 2 bytes (protocol and opcode) is the smallets possible packet.
 169                 AddDebugLogLineN(logMuleUDP, m_name + wxT(": Invalid Packet received"));
 170         } else if (!ip) {
 171                 // wxFAIL;
 172                 AddLogLineNS(wxT("Unknown ip receiving a UDP packet! Ignoring: '") + addr.IPAddress() + wxT("'"));
 173         } else if (!port) {
 174                 // wxFAIL;
 175                 AddLogLineNS(wxT("Unknown port receiving a UDP packet! Ignoring"));
 176         } else if (theApp->clientlist->IsBannedClient(ip)) {
 177                 AddDebugLogLineN(logMuleUDP, m_name + wxT(": Dropped packet from banned IP ") + addr.IPAddress());
 178         } else {
 179                 AddDebugLogLineN(logMuleUDP, (m_name + wxT(": Packet received ("))
 180                         << addr.IPAddress() << wxT(":") << port << wxT("): ")
 181                         << length << wxT("b"));
 182                 OnPacketReceived(ip, port, (byte*)buffer, length);
 183         }
 184 }
 185
 186
 187 void CMuleUDPSocket::OnReceiveError(int DEBUG_ONLY(errorCode), uint32 WXUNUSED(ip), uint16 WXUNUSED(port))
 188 {
 189         AddDebugLogLineN(logMuleUDP, (m_name + wxT(": Error while reading: ")) << errorCode);
 190 }
 191
 192
 193 void CMuleUDPSocket::OnDisconnected(int WXUNUSED(errorCode))
 194 {
 195         /* Due to bugs in wxWidgets, UDP sockets will sometimes
 196          * be closed. This is caused by the fact that wx treats
 197          * zero-length datagrams as EOF, which is only the case
 198          * when dealing with streaming sockets.
 199          *
 200          * This has been reported as patch #1885472:
 201          * http://sourceforge.net/tracker/index.php?func=detail&aid=1885472&group_id=9863&atid=309863
 202          */
 203         AddDebugLogLineC(logMuleUDP, m_name + wxT("Socket died, recreating."));
 204         DestroySocket();
 205         CreateSocket();
 206 }
 207
 208
 209 void CMuleUDPSocket::SendPacket(CPacket* packet, uint32 IP, uint16 port, bool bEncrypt, const uint8* pachTargetClientHashORKadID, bool bKad, uint32 nReceiverVerifyKey)
 210 {
 211         wxCHECK_RET(packet, wxT("Invalid packet."));
 212         /*wxCHECK_RET(port, wxT("Invalid port."));
 213         wxCHECK_RET(IP, wxT("Invalid IP."));
 214         */
 215
 216         if (!port || !IP) {
 217                 return;
 218         }
 219
 220         if (!Ok()) {
 221                 AddDebugLogLineN(logMuleUDP, (m_name + wxT(": Packet discarded, socket not Ok ("))
 222                         << Uint32_16toStringIP_Port(IP, port) << wxT("): ") << packet->GetPacketSize() << wxT("b"));
 223                 delete packet;
 224
 225                 return;
 226         }
 227
 228         AddDebugLogLineN(logMuleUDP, (m_name + wxT(": Packet queued ("))
 229                 << Uint32_16toStringIP_Port(IP, port) << wxT("): ") << packet->GetPacketSize() << wxT("b"));
 230
 231         UDPPack newpending;
 232         newpending.IP = IP;
 233         newpending.port = port;
 234         newpending.packet = packet;
 235         newpending.time = GetTickCount();
 236         newpending.bEncrypt = bEncrypt && (pachTargetClientHashORKadID != NULL || (bKad && nReceiverVerifyKey != 0))
 237                                                         && thePrefs::IsClientCryptLayerSupported();
 238         newpending.bKad = bKad;
 239         newpending.nReceiverVerifyKey = nReceiverVerifyKey;
 240         if (newpending.bEncrypt && pachTargetClientHashORKadID != NULL) {
 241                 md4cpy(newpending.pachTargetClientHashORKadID, pachTargetClientHashORKadID);
 242         } else {
 243                 md4clr(newpending.pachTargetClientHashORKadID);
 244         }
 245
 246         {
 247                 wxMutexLocker lock(m_mutex);
 248                 m_queue.push_back(newpending);
 249         }
 250
 251         theApp->uploadBandwidthThrottler->QueueForSendingControlPacket(this);
 252 }
 253
 254
 255 bool CMuleUDPSocket::Ok()
 256 {
 257         wxMutexLocker lock(m_mutex);
 258
 259         return m_socket && m_socket->Ok();
 260 }
 261
 262
 263 SocketSentBytes CMuleUDPSocket::SendControlData(uint32 maxNumberOfBytesToSend, uint32 WXUNUSED(minFragSize))
 264 {
 265         wxMutexLocker lock(m_mutex);
 266         uint32 sentBytes = 0;
 267         while (!m_queue.empty() && !m_busy && (sentBytes < maxNumberOfBytesToSend)) {
 268                 UDPPack item = m_queue.front();
 269                 CPacket* packet = item.packet;
 270                 if (GetTickCount() - item.time < UDPMAXQUEUETIME) {
 271                         uint32_t len = packet->GetPacketSize() + 2;
 272                         uint8_t *sendbuffer = new uint8_t [len];
 273                         memcpy(sendbuffer, packet->GetUDPHeader(), 2);
 274                         memcpy(sendbuffer + 2, packet->GetDataBuffer(), packet->GetPacketSize());
 275
 276                         if (item.bEncrypt && (theApp->GetPublicIP() > 0 || item.bKad)) {
 277                                 len = CEncryptedDatagramSocket::EncryptSendClient(&sendbuffer, len, item.pachTargetClientHashORKadID, item.bKad, item.nReceiverVerifyKey, (item.bKad ? Kademlia::CPrefs::GetUDPVerifyKey(item.IP) : 0));
 278                         }
 279
 280                         if (SendTo(sendbuffer, len, item.IP, item.port)) {
 281                                 sentBytes += len;
 282                                 m_queue.pop_front();
 283                                 delete packet;
 284                                 delete [] sendbuffer;
 285                         } else {
 286                                 // TODO: Needs better error handling, see SentTo
 287                                 delete [] sendbuffer;
 288                                 break;
 289                         }
 290                 } else {
 291                         m_queue.pop_front();
 292                         delete packet;
 293                 }
 294         }
 295         if (!m_busy && !m_queue.empty()) {
 296                 theApp->uploadBandwidthThrottler->QueueForSendingControlPacket(this);
 297         }
 298         SocketSentBytes returnVal = { true, 0, sentBytes };
 299
 300         return returnVal;
 301 }
 302
 303
 304 bool CMuleUDPSocket::SendTo(uint8_t *buffer, uint32_t length, uint32_t ip, uint16_t port)
 305 {
 306         // Just pretend that we sent the packet in order to avoid infinite loops.
 307         if (!(m_socket && m_socket->Ok())) {
 308                 return true;
 309         }
 310
 311         amuleIPV4Address addr;
 312         addr.Hostname(ip);
 313         addr.Service(port);
 314
 315         // We better clear this flag here, status might have been changed
 316         // between the U.B.T. addition and the real sending happening later
 317         m_busy = false;
 318         bool sent = false;
 319         m_socket->SendTo(addr, buffer, length);
 320         if (m_socket->Error()) {
 321                 wxSocketError error = m_socket->LastError();
 322
 323                 if (error == wxSOCKET_WOULDBLOCK) {
 324                         // Socket is busy and can't send this data right now,
 325                         // so we just return not sent and set the wouldblock
 326                         // flag so it gets resent when socket is ready.
 327                         m_busy = true;
 328                 } else {
 329                         // An error which we can't handle happended, so we drop
 330                         // the packet rather than risk entering an infinite loop.
 331                         AddLogLineN((wxT("WARNING! ") + m_name + wxT(": Packet to "))
 332                                 << Uint32_16toStringIP_Port(ip, port)
 333                                 << wxT(" discarded due to error (") << error << wxT(") while sending."));
 334                         sent = true;
 335                 }
 336         } else {
 337                 AddDebugLogLineN(logMuleUDP, (m_name + wxT(": Packet sent ("))
 338                         << Uint32_16toStringIP_Port(ip, port) << wxT("): ")
 339                         << length << wxT("b"));
 340                 sent = true;
 341         }
 342
 343         return sent;
 344 }
 345
 346 // File_checked_for_headers