Cleanup: Address some of the todos in net_log.h...

net/socket/socks5_client_socket.cc

 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/socket/socks5_client_socket.h"
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/format_macros.h"
 #include "base/string_util.h"
 #include "base/trace_event.h"
 #include "net/base/io_buffer.h"
 #include "net/base/net_log.h"
 #include "net/base/net_util.h"
 #include "net/base/sys_addrinfo.h"
 #include "net/socket/client_socket_handle.h"
 
 namespace net {
 
-namespace {
-
-// Returns a string description of |socks_error|, or NULL if |socks_error| is
-// not a valid SOCKS reply.
-const char* MapSOCKSReplyToErrorString(char socks_error) {
-  switch(socks_error) {
-    case 1: return "(1) General SOCKS server failure";
-    case 2: return "(2) Connection not allowed by ruleset";
-    case 3: return "(3) Network unreachable";
-    case 4: return "(4) Host unreachable";
-    case 5: return "(5) Connection refused";
-    case 6: return "(6) TTL expired";
-    case 7: return "(7) Command not supported";
-    case 8: return "(8) Address type not supported";
-    default: return NULL;
-  }
-}
-
-}  // namespace
-
 const unsigned int SOCKS5ClientSocket::kGreetReadHeaderSize = 2;
 const unsigned int SOCKS5ClientSocket::kWriteHeaderSize = 10;
 const unsigned int SOCKS5ClientSocket::kReadHeaderSize = 5;
 const uint8 SOCKS5ClientSocket::kSOCKS5Version = 0x05;
 const uint8 SOCKS5ClientSocket::kTunnelCommand = 0x01;
 const uint8 SOCKS5ClientSocket::kNullByte = 0x00;
 
 COMPILE_ASSERT(sizeof(struct in_addr) == 4, incorrect_system_size_of_IPv4);
 COMPILE_ASSERT(sizeof(struct in6_addr) == 16, incorrect_system_size_of_IPv6);
 
@@ skipping 179 matching lines @@
   return rv;
 }
 
 const char kSOCKS5GreetWriteData[] = { 0x05, 0x01, 0x00 };  // no authentication
 const char kSOCKS5GreetReadData[] = { 0x05, 0x00 };
 
 int SOCKS5ClientSocket::DoGreetWrite() {
   // Since we only have 1 byte to send the hostname length in, if the
   // URL has a hostname longer than 255 characters we can't send it.
   if (0xFF < host_request_info_.hostname().size()) {
-    net_log_.AddStringLiteral("Failed sending request because hostname is "
-        "longer than 255 characters");
+    net_log_.AddEvent(NetLog::TYPE_SOCKS_HOSTNAME_TOO_BIG);
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   if (buffer_.empty()) {
     buffer_ = std::string(kSOCKS5GreetWriteData,
                           arraysize(kSOCKS5GreetWriteData));
     bytes_sent_ = 0;
   }
 
   next_state_ = STATE_GREET_WRITE_COMPLETE;
@@ skipping 26 matching lines @@
   handshake_buf_ = new IOBuffer(handshake_buf_len);
   return transport_->socket()->Read(handshake_buf_, handshake_buf_len,
                                     &io_callback_);
 }
 
 int SOCKS5ClientSocket::DoGreetReadComplete(int result) {
   if (result < 0)
     return result;
 
   if (result == 0) {
-    net_log_.AddStringLiteral(
-        "Connection unexpected closed while reading greeting.");
+    net_log_.AddEvent(NetLog::TYPE_SOCKS_UNEXPECTEDLY_CLOSED_DURING_GREETING);
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   bytes_received_ += result;
   buffer_.append(handshake_buf_->data(), result);
   if (bytes_received_ < kGreetReadHeaderSize) {
     next_state_ = STATE_GREET_READ;
     return OK;
   }
 
   // Got the greet data.
   if (buffer_[0] != kSOCKS5Version) {
-    net_log_.AddStringLiteral("Unexpected SOCKS version");
-    net_log_.AddString(StringPrintf(
-        "buffer_[0] = 0x%x", static_cast<int>(buffer_[0])));
+    net_log_.AddEventWithInteger(NetLog::TYPE_SOCKS_UNEXPECTED_VERSION,
+                                 "version", buffer_[0]);
     return ERR_SOCKS_CONNECTION_FAILED;
   }
   if (buffer_[1] != 0x00) {
-    net_log_.AddStringLiteral("Unexpected authentication method");
-    net_log_.AddString(StringPrintf(
-        "buffer_[1] = 0x%x", static_cast<int>(buffer_[1])));
+    net_log_.AddEventWithInteger(NetLog::TYPE_SOCKS_UNEXPECTED_AUTH,
+                                 "method", buffer_[1]);
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   buffer_.clear();
   next_state_ = STATE_HANDSHAKE_WRITE;
   return OK;
 }
 
 int SOCKS5ClientSocket::BuildHandshakeWriteBuffer(std::string* handshake)
     const {
@@ skipping 70 matching lines @@
   return transport_->socket()->Read(handshake_buf_, handshake_buf_len,
                                     &io_callback_);
 }
 
 int SOCKS5ClientSocket::DoHandshakeReadComplete(int result) {
   if (result < 0)
     return result;
 
   // The underlying socket closed unexpectedly.
   if (result == 0) {
-    net_log_.AddStringLiteral(
-        "Connection unexpected closed while reading handshake.");
+    net_log_.AddEvent(NetLog::TYPE_SOCKS_UNEXPECTEDLY_CLOSED_DURING_HANDSHAKE);
     return ERR_SOCKS_CONNECTION_FAILED;
   }
 
   buffer_.append(handshake_buf_->data(), result);
   bytes_received_ += result;
 
   // When the first few bytes are read, check how many more are required
   // and accordingly increase them
   if (bytes_received_ == kReadHeaderSize) {
     if (buffer_[0] != kSOCKS5Version || buffer_[2] != kNullByte) {
-      net_log_.AddStringLiteral("Unexpected SOCKS version.");
-      net_log_.AddString(StringPrintf(
-          "buffer_[0] = 0x%x; buffer_[2] = 0x%x",
-          static_cast<int>(buffer_[0]),
-          static_cast<int>(buffer_[2])));
+      net_log_.AddEventWithInteger(NetLog::TYPE_SOCKS_UNEXPECTED_VERSION,
+                                   "version", buffer_[0]);
       return ERR_SOCKS_CONNECTION_FAILED;
     }
     if (buffer_[1] != 0x00) {
-      net_log_.AddStringLiteral("SOCKS server returned a failure code:");
-      const char* error_string = MapSOCKSReplyToErrorString(buffer_[1]);
-      if (error_string) {
-        net_log_.AddStringLiteral(error_string);
-      } else {
-        net_log_.AddString(StringPrintf(
-            "buffer_[1] = 0x%x", static_cast<int>(buffer_[1])));
-      }
+      net_log_.AddEventWithInteger(NetLog::TYPE_SOCKS_SERVER_ERROR,
+                                   "error_code", buffer_[1]);
       return ERR_SOCKS_CONNECTION_FAILED;
     }
 
     // We check the type of IP/Domain the server returns and accordingly
     // increase the size of the response. For domains, we need to read the
     // size of the domain, so the initial request size is upto the domain
     // size. Since for IPv4/IPv6 the size is fixed and hence no 'size' is
     // read, we substract 1 byte from the additional request size.
     SocksEndPointAddressType address_type =
         static_cast<SocksEndPointAddressType>(buffer_[3]);
     if (address_type == kEndPointDomain)
       read_header_size += static_cast<uint8>(buffer_[4]);
     else if (address_type == kEndPointResolvedIPv4)
       read_header_size += sizeof(struct in_addr) - 1;
     else if (address_type == kEndPointResolvedIPv6)
       read_header_size += sizeof(struct in6_addr) - 1;
     else {
-      net_log_.AddStringLiteral("Unknown address type in response");
-      net_log_.AddString(StringPrintf(
-          "buffer_[3] = 0x%x", static_cast<int>(buffer_[3])));
+      net_log_.AddEventWithInteger(NetLog::TYPE_SOCKS_UNKNOWN_ADDRESS_TYPE,
+                                   "address_type", buffer_[3]);
       return ERR_SOCKS_CONNECTION_FAILED;
     }
 
     read_header_size += 2;  // for the port.
     next_state_ = STATE_HANDSHAKE_READ;
     return OK;
   }
 
   // When the final bytes are read, setup handshake. We ignore the rest
   // of the response since they represent the SOCKSv5 endpoint and have
   // no use when doing a tunnel connection.
   if (bytes_received_ == read_header_size) {
     completed_handshake_ = true;
     buffer_.clear();
     next_state_ = STATE_NONE;
     return OK;
   }
 
   next_state_ = STATE_HANDSHAKE_READ;
   return OK;
 }
 
 int SOCKS5ClientSocket::GetPeerAddress(AddressList* address) const {
   return transport_->socket()->GetPeerAddress(address);
 }
 
 }  // namespace net