toolkit/crashreporter/google-breakpad/src/common/linux/http_upload.h@b8a032363ba2 (annotated)
toolkit/crashreporter/google-breakpad/src/common/linux/http_upload.h
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | // Copyright (c) 2006, Google Inc. |
| michael@0 | 2 | // All rights reserved. |
| michael@0 | 3 | // |
| michael@0 | 4 | // Redistribution and use in source and binary forms, with or without |
| michael@0 | 5 | // modification, are permitted provided that the following conditions are |
| michael@0 | 6 | // met: |
| michael@0 | 7 | // |
| michael@0 | 8 | // * Redistributions of source code must retain the above copyright |
| michael@0 | 9 | // notice, this list of conditions and the following disclaimer. |
| michael@0 | 10 | // * Redistributions in binary form must reproduce the above |
| michael@0 | 11 | // copyright notice, this list of conditions and the following disclaimer |
| michael@0 | 12 | // in the documentation and/or other materials provided with the |
| michael@0 | 13 | // distribution. |
| michael@0 | 14 | // * Neither the name of Google Inc. nor the names of its |
| michael@0 | 15 | // contributors may be used to endorse or promote products derived from |
| michael@0 | 16 | // this software without specific prior written permission. |
| michael@0 | 17 | // |
| michael@0 | 18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| michael@0 | 22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@0 | 24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| michael@0 | 25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| michael@0 | 26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| michael@0 | 27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| michael@0 | 28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 29 | |
| michael@0 | 30 | // HTTPUpload provides a "nice" API to send a multipart HTTP(S) POST |
| michael@0 | 31 | // request using libcurl. It currently supports requests that contain |
| michael@0 | 32 | // a set of string parameters (key/value pairs), and a file to upload. |
| michael@0 | 33 | |
| michael@0 | 34 | #ifndef COMMON_LINUX_HTTP_UPLOAD_H__ |
| michael@0 | 35 | #define COMMON_LINUX_HTTP_UPLOAD_H__ |
| michael@0 | 36 | |
| michael@0 | 37 | #include <map> |
| michael@0 | 38 | #include <string> |
| michael@0 | 39 | |
| michael@0 | 40 | #include "common/using_std_string.h" |
| michael@0 | 41 | |
| michael@0 | 42 | namespace google_breakpad { |
| michael@0 | 43 | |
| michael@0 | 44 | using std::map; |
| michael@0 | 45 | |
| michael@0 | 46 | class HTTPUpload { |
| michael@0 | 47 | public: |
| michael@0 | 48 | // Sends the given set of parameters, along with the contents of |
| michael@0 | 49 | // upload_file, as a multipart POST request to the given URL. |
| michael@0 | 50 | // file_part_name contains the name of the file part of the request |
| michael@0 | 51 | // (i.e. it corresponds to the name= attribute on an <input type="file">. |
| michael@0 | 52 | // Parameter names must contain only printable ASCII characters, |
| michael@0 | 53 | // and may not contain a quote (") character. |
| michael@0 | 54 | // Only HTTP(S) URLs are currently supported. Returns true on success. |
| michael@0 | 55 | // If the request is successful and response_body is non-NULL, |
| michael@0 | 56 | // the response body will be returned in response_body. |
| michael@0 | 57 | // If response_code is non-NULL, it will be set to the HTTP response code |
| michael@0 | 58 | // received (or 0 if the request failed before getting an HTTP response). |
| michael@0 | 59 | // If the send fails, a description of the error will be |
| michael@0 | 60 | // returned in error_description. |
| michael@0 | 61 | static bool SendRequest(const string &url, |
| michael@0 | 62 | const map<string, string> ¶meters, |
| michael@0 | 63 | const string &upload_file, |
| michael@0 | 64 | const string &file_part_name, |
| michael@0 | 65 | const string &proxy, |
| michael@0 | 66 | const string &proxy_user_pwd, |
| michael@0 | 67 | const string &ca_certificate_file, |
| michael@0 | 68 | string *response_body, |
| michael@0 | 69 | long *response_code, |
| michael@0 | 70 | string *error_description); |
| michael@0 | 71 | |
| michael@0 | 72 | private: |
| michael@0 | 73 | // Checks that the given list of parameters has only printable |
| michael@0 | 74 | // ASCII characters in the parameter name, and does not contain |
| michael@0 | 75 | // any quote (") characters. Returns true if so. |
| michael@0 | 76 | static bool CheckParameters(const map<string, string> ¶meters); |
| michael@0 | 77 | |
| michael@0 | 78 | // No instances of this class should be created. |
| michael@0 | 79 | // Disallow all constructors, destructors, and operator=. |
| michael@0 | 80 | HTTPUpload(); |
| michael@0 | 81 | explicit HTTPUpload(const HTTPUpload &); |
| michael@0 | 82 | void operator=(const HTTPUpload &); |
| michael@0 | 83 | ~HTTPUpload(); |
| michael@0 | 84 | }; |
| michael@0 | 85 | |
| michael@0 | 86 | } // namespace google_breakpad |
| michael@0 | 87 | |
| michael@0 | 88 | #endif // COMMON_LINUX_HTTP_UPLOAD_H__ |
