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

chrome/common/extensions/api/web_request.json

 // 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.
 
 [
   {
     "namespace": "webRequest",
     "types": [
       {
         "id": "RequestFilter",
@@ skipping 88 matching lines @@
         "parameters": [
           {
             "type": "object",
             "name": "details",
             "properties": {
               "requestId": {"type": "string", "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
               "url": {"type": "string"},
               "method": {"type": "string", "description": "Standard HTTP method."},
               "frameId": {"type": "integer", "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab."},
               "parentFrameId": {"type": "integer", "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists."},
+              "body": {

[Matt Perry, 2012/08/06 21:06:45]

I think we should go with requestBody, because it's otherwise easy to confuse
with the response body.

[vabr (Chromium), 2012/08/10 17:12:55]

Done, changed both the entry name from 'details', and the corresponding
extraInfoSpec item.

+                "type": "object",
+                "optional": true,
+                "description": "Experimental feature, only available in DEV or CANARY channels. Container for request body data. Only provided if extraInfoSpec contains 'body'.",
+                "properties": {
+                  "error": {"type": "string", "optional": true, "description": "Errors when obtaining request body data."},

[Aaron Boodman, 2012/08/06 03:56:49]

This is a bit abnormal for our APIs. What types of errors would go here?

[vabr (Chromium), 2012/08/10 17:12:55]

Right now the only errors can be chunked elements in the request body.
Some other might be added, like failed base::Base64Encode.

I'm open to suggestions about how to report an error:
 * free-text string as currently, or
 * an error code (short enum-string) as before, or
 * something more appropriate?

This is not an error-message for an error in WebRequest or event-handling. This
is a part of a normal callback data, and it is used to inform the handler that
the request body could not be passed; but the request itself is still OK and can
be blocked.

[Aaron Boodman, 2012/08/10 21:47:12]

I see. Makes sense.

+                  "parsedForm": {

[Aaron Boodman, 2012/08/06 03:56:49]

How about 'formData'?

[vabr (Chromium), 2012/08/10 17:12:55]

I have no preference on parsedForm vs. formData, but I remember that at some
point parsedForm was chosen to include the word "parsed" explicitly.

Does anybody else from the reviewers have a strong preference on the naming? If
nobody then I will rename it to formData in the next update.

+                    "type": "object",
+                    "optional": true,
+                    "description": "If the request method is POST and the body is a sequence of key-value pairs, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. It is also not present if the form upload is chunked. Example value of this dictionary is {'key': ['value1', 'value2']}.",
+                    "properties": {},
+                    "additionalProperties": {
+                      "type": "array",
+                      "items": { "type": "string" }
+                    }
+                  },
+                  "raw" : {"type": "string", "optional": true, "description": "If the request method is PUT or POST then the unparsed request body is contained here, unless it already is parsed in parsedForm or some error occurred. Files from the request body are replaced by filenames."}
+                }
+              },
               "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab."},
               "type": {"type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description": "How the requested resource will be used."},
               "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}
             }
           }
         ],
         "extraParameters": [
           {
             "$ref": "RequestFilter",
             "name": "filter",
             "description": "A set of filters that restricts the events that will be sent to this listener."
           },
           {
             "type": "array",
             "optional": true,
             "name": "extraInfoSpec",
             "description": "Array of extra information that should be passed to the listener function.",
             "items": {
               "type": "string",
-              "enum": ["blocking"]
+              "enum": ["blocking", "body"]
             }
           }
         ],
         "returns": {
           "$ref": "BlockingResponse",
           "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
           "optional": true
         }
       },
       {
@@ skipping 338 matching lines @@
           {
             "$ref": "RequestFilter",
             "name": "filter",
             "description": "A set of filters that restricts the events that will be sent to this listener."
           }
         ]
       }
     ]
   }
 ]