Implement chrome.socket.bind/listen/accept for TCP server socket.

chrome/browser/extensions/api/socket/tcp_socket.cc

 // Copyright (c) 2012 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 "chrome/browser/extensions/api/socket/tcp_socket.h"
 
 #include "chrome/browser/extensions/api/api_resource.h"
 #include "chrome/browser/extensions/api/api_resource_event_notifier.h"
 #include "net/base/address_list.h"
 #include "net/base/ip_endpoint.h"
 #include "net/base/net_errors.h"
 #include "net/base/rand_callback.h"
 #include "net/socket/tcp_client_socket.h"
 
 namespace extensions {
 
+const char kTCPSocketTypeInvalidError[] =
+    "Cannot call both connect and listen on the same socket.";
+const char kSocketListenError[] = "Could not listen on the specified port.";
+const char kSocketRebindError[] = "Rebinding a listening socket not supported";
+
 TCPSocket::TCPSocket(const std::string& owner_extension_id,
                      ApiResourceEventNotifier* event_notifier)
-    : Socket(owner_extension_id, event_notifier) {
+    : Socket(owner_extension_id, event_notifier),
+      socket_mode_(UNKNOWN) {
 }
 
-// For testing.
 TCPSocket::TCPSocket(net::TCPClientSocket* tcp_client_socket,
                      const std::string& owner_extension_id,
-                     ApiResourceEventNotifier* event_notifier)
+                     ApiResourceEventNotifier* event_notifier,
+                     bool is_connected)
     : Socket(owner_extension_id, event_notifier),
-      socket_(tcp_client_socket) {
+      socket_(tcp_client_socket),
+      socket_mode_(CLIENT) {
+  this->is_connected_ = is_connected;
+}
+
+TCPSocket::TCPSocket(net::TCPServerSocket* tcp_server_socket,
+                     const std::string& owner_extension_id)
+    : Socket(owner_extension_id, NULL),
+      server_socket_(tcp_server_socket),
+      socket_mode_(SERVER) {
 }
 
 // static
 TCPSocket* TCPSocket::CreateSocketForTesting(
     net::TCPClientSocket* tcp_client_socket,
     const std::string& owner_extension_id,
     ApiResourceEventNotifier* event_notifier) {
   return new TCPSocket(tcp_client_socket, owner_extension_id, event_notifier);
 }
 
+// static
+TCPSocket* TCPSocket::CreateServerSocketForTesting(
+    net::TCPServerSocket* tcp_server_socket,
+    const std::string& owner_extension_id) {
+  return new TCPSocket(tcp_server_socket, owner_extension_id);
+}
+
 TCPSocket::~TCPSocket() {
   if (is_connected_) {
     Disconnect();
   }
+  server_socket_.reset(NULL);
 }
 
 void TCPSocket::Connect(const std::string& address,
                         int port,
                         const CompletionCallback& callback) {
   DCHECK(!callback.is_null());
 
-  if (!connect_callback_.is_null()) {
+  if (socket_mode_ == SERVER || !connect_callback_.is_null()) {
     callback.Run(net::ERR_CONNECTION_FAILED);
     return;
   }
+  DCHECK(!server_socket_.get());
+  socket_mode_ = CLIENT;
   connect_callback_ = callback;
 
   int result = net::ERR_CONNECTION_FAILED;
   do {
     if (is_connected_)
       break;
 
     net::AddressList address_list;
     if (!StringAndPortToAddressList(address, port, &address_list)) {
       result = net::ERR_ADDRESS_INVALID;
       break;
     }
 
     socket_.reset(new net::TCPClientSocket(address_list, NULL,
                                            net::NetLog::Source()));
+
     connect_callback_ = callback;
     result = socket_->Connect(base::Bind(
         &TCPSocket::OnConnectComplete, base::Unretained(this)));
   } while (false);
 
   if (result != net::ERR_IO_PENDING)
     OnConnectComplete(result);
 }
 
 void TCPSocket::Disconnect() {
   is_connected_ = false;
   socket_->Disconnect();
 }
 
 int TCPSocket::Bind(const std::string& address, int port) {
-  // TODO(penghuang): Supports bind for tcp?
   return net::ERR_FAILED;
 }
 
 void TCPSocket::Read(int count,
                      const ReadCompletionCallback& callback) {
   DCHECK(!callback.is_null());
 
+  if (socket_mode_ != CLIENT) {
+    callback.Run(net::ERR_FAILED, NULL);
+    return;
+  }
+
   if (!read_callback_.is_null()) {
     callback.Run(net::ERR_IO_PENDING, NULL);
     return;
   } else {
     read_callback_ = callback;
   }
 
   int result = net::ERR_FAILED;
   scoped_refptr<net::IOBuffer> io_buffer;
   do {
@@ skipping 35 matching lines @@
     return false;
   return socket_->SetKeepAlive(enable, delay);
 }
 
 bool TCPSocket::SetNoDelay(bool no_delay) {
   if (!socket_.get())
     return false;
   return socket_->SetNoDelay(no_delay);
 }
 
+int TCPSocket::Listen(const std::string& address, int port, int backlog,
+                      std::string* error_msg) {
+  if (socket_mode_ == CLIENT) {
+    *error_msg = kTCPSocketTypeInvalidError;
+    return net::ERR_NOT_IMPLEMENTED;
+  }
+  DCHECK(!socket_.get());
+  socket_mode_ = SERVER;
+
+  scoped_ptr<net::IPEndPoint> bind_address(new net::IPEndPoint());
+  if (!StringAndPortToIPEndPoint(address, port, bind_address.get()))
+    return net::ERR_INVALID_ARGUMENT;
+
+  if (server_socket_.get()) {
+    *error_msg = kSocketRebindError;
+    return net::ERR_ADDRESS_IN_USE;
+  }
+  server_socket_.reset(new net::TCPServerSocket(NULL,
+                                                net::NetLog::Source()));
+  server_socket_->AllowAddressReuse();
+  int result = server_socket_->Listen(*bind_address, backlog);
+  if (result) {
+    *error_msg = kSocketListenError;

[miket_OOO, 2012/09/24 18:14:21]

No braces.

[justinlin, 2012/09/26 08:59:59]

Done.

+  }
+  return result;
+}
+
+void TCPSocket::Accept(const AcceptCompletionCallback &callback) {
+  if (socket_mode_ != SERVER || !server_socket_.get()) {
+    callback.Run(net::ERR_FAILED, NULL);
+    return;
+  }
+
+  // Limits to only 1 blocked accept call.
+  if (!accept_callback_.is_null()) {
+    callback.Run(net::ERR_FAILED, NULL);
+    return;
+  }
+
+  int result = server_socket_->Accept(&accept_socket_, base::Bind(
+          &TCPSocket::OnAccept, base::Unretained(this)));

[miket_OOO, 2012/09/24 18:14:21]

This indentation is nonstandard.

[justinlin, 2012/09/26 08:59:59]

Done.

+  if (result == net::ERR_IO_PENDING) {
+    accept_callback_ = callback;
+    return;

[miket_OOO, 2012/09/24 18:14:21]

Are the returns necessary?

[justinlin, 2012/09/26 08:59:59]

Done.

+  } else if (result == net::OK) {
+    accept_callback_ = callback;
+    this->OnAccept(result);
+    return;
+  } else {
+    callback.Run(result, NULL);
+    return;
+  }
+}
+
 bool TCPSocket::GetPeerAddress(net::IPEndPoint* address) {
   if (!socket_.get())
     return false;
   return !socket_->GetPeerAddress(address);
 }
 
 bool TCPSocket::GetLocalAddress(net::IPEndPoint* address) {
-  if (!socket_.get())
+  if (socket_.get()) {
+    return !socket_->GetLocalAddress(address);
+  } else if (server_socket_.get()) {
+    return !server_socket_->GetLocalAddress(address);
+  } else {
     return false;
-  return !socket_->GetLocalAddress(address);
+  }
 }
 
 Socket::SocketType TCPSocket::GetSocketType() const {
   return Socket::TYPE_TCP;
 }
 
 int TCPSocket::WriteImpl(net::IOBuffer* io_buffer,
                          int io_buffer_size,
                          const net::CompletionCallback& callback) {
-  if (!socket_.get() || !socket_->IsConnected())
+  if (socket_mode_ != CLIENT)

[miket_OOO, 2012/09/24 18:14:21]

If this can actually happen (i.e., an application programming error can cause
it), then please set the error message.

[justinlin, 2012/09/26 08:59:59]

This is actually tricky. I think to do this, we would need to know at the
socket_api.cc level whether this is a Client or Server socket, and I had
prefered to keep this information local to tcp_socket. I already documented in
the IDL file that read,write and connect will always fail after calling listen()
on a socket. Do you think the error message is necessary?

+    return net::ERR_FAILED;
+  else if (!socket_.get() || !socket_->IsConnected())
     return net::ERR_SOCKET_NOT_CONNECTED;
   else
     return socket_->Write(io_buffer, io_buffer_size, callback);
 }
 
 void TCPSocket::OnConnectComplete(int result) {
   DCHECK(!connect_callback_.is_null());
   DCHECK(!is_connected_);
   is_connected_ = result == net::OK;
   connect_callback_.Run(result);
   connect_callback_.Reset();
 }
 
 void TCPSocket::OnReadComplete(scoped_refptr<net::IOBuffer> io_buffer,
                                int result) {
   DCHECK(!read_callback_.is_null());
   read_callback_.Run(result, io_buffer);
   read_callback_.Reset();
 }
 
+void TCPSocket::OnAccept(int result) {
+  DCHECK(!accept_callback_.is_null());
+  if (result == net::OK) {
+    DCHECK(accept_socket_.get() != NULL);
+
+    accept_callback_.Run(
+        result, static_cast<net::TCPClientSocket*>(accept_socket_.release()));
+  } else {
+    accept_callback_.Run(result, NULL);
+  }
+  accept_callback_.Reset();
+}
+
 }  // namespace extensions