Add read-only access to POST data for webRequest's onBeforeRequest

chrome/browser/extensions/api/web_request/web_request_api.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/web_request/web_request_api.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
 #include "base/json/json_writer.h"
 #include "base/metrics/histogram.h"
 #include "base/string_number_conversions.h"
 #include "base/string_util.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/chrome_content_browser_client.h"
 #include "chrome/browser/extensions/api/declarative_webrequest/webrequest_rule.h"
 #include "chrome/browser/extensions/api/declarative_webrequest/webrequest_rules_registry.h"
 #include "chrome/browser/extensions/api/web_navigation/web_navigation_api_helpers.h"
+#include "chrome/browser/extensions/api/web_request/post_data_parser.h"
 #include "chrome/browser/extensions/api/web_request/web_request_api_constants.h"
 #include "chrome/browser/extensions/api/web_request/web_request_api_helpers.h"
 #include "chrome/browser/extensions/api/web_request/web_request_time_tracker.h"
 #include "chrome/browser/extensions/event_router.h"
 #include "chrome/browser/extensions/extension_info_map.h"
 #include "chrome/browser/extensions/extension_prefs.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_tab_id_map.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/renderer_host/chrome_render_message_filter.h"
 #include "chrome/browser/renderer_host/web_cache_manager.h"
+#include "chrome/common/chrome_version_info.h"
 #include "chrome/common/extensions/event_filtering_info.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/extensions/extension_constants.h"
 #include "chrome/common/extensions/extension_error_utils.h"
 #include "chrome/common/extensions/extension_messages.h"
 #include "chrome/common/extensions/url_pattern.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/browser_message_filter.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_process_host.h"
@@ skipping 106 matching lines @@
                  base::Uint64ToString(request->identifier()));
   out->SetString(keys::kUrlKey, request->url().spec());
   out->SetString(keys::kMethodKey, request->method());
   out->SetInteger(keys::kFrameIdKey, frame_id_for_extension);
   out->SetInteger(keys::kParentFrameIdKey, parent_frame_id_for_extension);
   out->SetInteger(keys::kTabIdKey, tab_id);
   out->SetString(keys::kTypeKey, helpers::ResourceTypeToString(resource_type));
   out->SetDouble(keys::kTimeStampKey, base::Time::Now().ToDoubleT() * 1000);
 }
 
+// Extracts the POST data from |request| and writes the data into |out|.
+// This can be expensive, so it's separated from ExtractRequestInfo().
+void ExtractRequestInfoPost(const net::URLRequest* request,
+                            DictionaryValue* out) {
+  if (request->method() != "POST")

[wtc, 2012/08/01 17:24:41]

If you want to support the PUT method, add
  && request->method() != "PUT"
here.

+    return;  // Need to exit without "out->Set(keys::kPostDataKey, ...);" .
+
+  DictionaryValue* post_data = new DictionaryValue();
+  out->Set(keys::kPostDataKey, post_data);
+
+  // Chunked encoding (defined in RFC 2616) is currently not supported.
+  std::string transfer_encoding;
+  if (request->extra_request_headers().GetHeader(
+      net::HttpRequestHeaders::kTransferEncoding, &transfer_encoding)) {
+    if (base::strcasecmp(transfer_encoding.c_str(), "chunked") == 0) {
+      post_data->SetString(keys::kPostDataErrorKey, "chunked_encoding");
+      return;
+    }
+  }
+
+  scoped_ptr<DictionaryValue> form_data =
+      extensions::PostDataParser::ParseURLRequestData(request);
+  if (form_data.get() != NULL)
+    post_data->Set(keys::kFormDataKey, form_data.release());
+}
+
 // Converts a HttpHeaders dictionary to a |name|, |value| pair. Returns
 // true if successful.
 bool FromHeaderDictionary(const DictionaryValue* header_value,
                           std::string* name,
                           std::string* value) {
   if (!header_value->GetString(keys::kHeaderNameKey, name))
     return false;
 
   // We require either a "value" or a "binaryValue" entry.
   if (!(header_value->HasKey(keys::kHeaderValueKey) ^
@@ skipping 232 matching lines @@
       return false;
 
     if (str == "requestHeaders")
       *extra_info_spec |= REQUEST_HEADERS;
     else if (str == "responseHeaders")
       *extra_info_spec |= RESPONSE_HEADERS;
     else if (str == "blocking")
       *extra_info_spec |= BLOCKING;
     else if (str == "asyncBlocking")
       *extra_info_spec |= ASYNC_BLOCKING;
+    else if (str == "postData")
+      *extra_info_spec |= (IsPostDataEnabled()) ? POST_DATA : 0;

[wtc, 2012/08/01 17:24:41]

Nit: you can also write this as

  else if (str == "postData" && IsPostDataEnabled())
    *extra_info_spec |= POST_DATA;

[vabr (Chromium), 2012/08/02 09:15:15]

Actually, that would be different. The current code means that "postData" is
silently ignored in beta/stable, because InitFromValue returns true. If I did it
as suggested, asking for postData in beta/stable would cause InitFromValue to
return false, and result in an error during registering the listener.

Dominic prefers the silent ignoring, so that extensions experimenting with
postData on dev are not broken on beta/stable (of course they will still not be
able to use POST data, but at least their listeners will get registered for
doing other stuff).

Matt, do you have an opinion on this?

[Matt Perry, 2012/08/02 10:11:03]

I'm torn, so let's just go with what you have.

[wtc, 2012/08/02 21:58:49]

You're right.  My suggested change was wrong.  Please ignore it.

     else
       return false;
 
     // BLOCKING and ASYNC_BLOCKING are mutually exclusive.
     if ((*extra_info_spec & BLOCKING) && (*extra_info_spec & ASYNC_BLOCKING))
       return false;
   }
   return true;
 }
 
@@ skipping 69 matching lines @@
 
   int extra_info_spec = 0;
   std::vector<const EventListener*> listeners =
       GetMatchingListeners(profile, extension_info_map, keys::kOnBeforeRequest,
                            request, &extra_info_spec);
   if (!listeners.empty() &&
       !GetAndSetSignaled(request->identifier(), kOnBeforeRequest)) {
     ListValue args;
     DictionaryValue* dict = new DictionaryValue();
     ExtractRequestInfo(request, dict);
+    if (extra_info_spec & ExtraInfoSpec::POST_DATA)
+      ExtractRequestInfoPost(request, dict);
     args.Append(dict);
 
     initialize_blocked_requests |=
         DispatchEvent(profile, request, listeners, args);
   }
 
   if (!initialize_blocked_requests)
     return net::OK;  // Nobody saw a reason for modifying the request.
 
   blocked_requests_[request->identifier()].event = kOnBeforeRequest;
@@ skipping 1309 matching lines @@
       } else if ((*it)->name().find("AdBlock") != std::string::npos) {
         adblock = true;
       } else {
         other = true;
       }
     }
   }
 
   host->Send(new ExtensionMsg_UsingWebRequestAPI(adblock, adblock_plus, other));
 }
+
+bool IsPostDataEnabled() {
+  static bool cached = false;
+  static bool enabled = false;
+  if (!cached) {
+    chrome::VersionInfo::Channel channel = chrome::VersionInfo::GetChannel();

[Matt Perry, 2012/08/01 09:46:31]

channel is a POD (it's just an enum), so you can make it a static variable.
Doing

bool IsEnabled() {
  static chrome::VersionInfo::Channel channel =
chrome::VersionInfo::GetChannel();
  return channel <= Dev;
}

works fine, because GetChannel() will only be invoked the first time this method
is called.

[wtc, 2012/08/01 17:24:41]

mpcomplete's suggestion is correct.  Note that neither form
is thread-safe, so you need to document that IsPostDataEnabled()
can only be called on a single thread, unless the single-thread
requirement is obvious to people using this function.

[vabr (Chromium), 2012/08/01 18:03:22]

Thanks, I learned something new! :)

However, due to adding the channel switcher, those static variables had to go
out of the function, where non-constant initialisation is forbidden by the style
guide even by POD, so this is no more relevant.

+    enabled = channel == chrome::VersionInfo::CHANNEL_UNKNOWN ||
+              channel == chrome::VersionInfo::CHANNEL_CANARY ||
+              channel == chrome::VersionInfo::CHANNEL_DEV;
+    cached = true;
+  }
+  return enabled;
+}