crashpad/util/net/http_multipart_builder.h
Mark Mentovai 0c322ecc3f Use zlib to gzip-compress uploads
This adds zlib to Crashpad. By default in standalone Crashpad builds,
the system zlib will be used where available. A copy of Chromium’s zlib
(currently a slightly patched 1.2.11) is checked out via DEPS into
third_party for use on Windows, which does not have a system zlib.

zlib is used to produce gzip streams for HTTP upload request bodies sent
by crashpad_handler by default. The Content-Encoding: gzip header is set
for these compressed request bodies. Compression can be disabled for
upload to servers without corresponding decompression support by
starting crashpad_handler with the --no-upload-gzip option.

Most minidumps compress quite well with zlib. A size reduction of 90% is
not uncommon.

BUG=crashpad:157
TEST=crashpad_util_test GzipHTTPBodyStream.*:HTTPTransport.*

Change-Id: I99b86db3952c3685cd78f5dc858a60b54399c513
Reviewed-on: https://chromium-review.googlesource.com/438585
Reviewed-by: Robert Sesek <rsesek@chromium.org>
2017-02-16 16:26:19 +00:00

104 lines
3.8 KiB
C++

// Copyright 2014 The Crashpad Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CRASHPAD_UTIL_NET_HTTP_MULTIPART_BUILDER_H_
#define CRASHPAD_UTIL_NET_HTTP_MULTIPART_BUILDER_H_
#include <map>
#include <memory>
#include <string>
#include "base/files/file_path.h"
#include "base/macros.h"
#include "util/net/http_headers.h"
namespace crashpad {
class HTTPBodyStream;
//! \brief This class is used to build a MIME multipart message, conforming to
//! RFC 2046, for use as a HTTP request body.
class HTTPMultipartBuilder {
public:
HTTPMultipartBuilder();
~HTTPMultipartBuilder();
//! \brief Enables or disables `gzip` compression.
//!
//! \param[in] gzip_enabled Whether to enable or disable `gzip` compression.
//!
//! When `gzip` compression is enabled, the body stream returned by
//! GetBodyStream() will be `gzip`-compressed, and the content headers set by
//! PopulateContentHeaders() will contain `Content-Encoding: gzip`.
void SetGzipEnabled(bool gzip_enabled);
//! \brief Sets a `Content-Disposition: form-data` key-value pair.
//!
//! \param[in] key The key of the form data, specified as the `name` in the
//! multipart message. Any data previously set on this class with this
//! key will be overwritten.
//! \param[in] value The value to set at the \a key.
void SetFormData(const std::string& key, const std::string& value);
//! \brief Specifies the file at \a path to have its contents uploaded as
//! multipart data, available at `name` of \a upload_file_name.
//!
//! \param[in] key The key of the form data, specified as the `name` in the
//! multipart message. Any data previously set on this class with this
//! key will be overwritten.
//! \param[in] upload_file_name The `filename` to specify for this multipart
//! data attachment.
//! \param[in] path The path of the file whose contents will be uploaded.
//! \param[in] content_type The `Content-Type` to specify for the attachment.
//! If this is empty, `"application/octet-stream"` will be used.
void SetFileAttachment(const std::string& key,
const std::string& upload_file_name,
const base::FilePath& path,
const std::string& content_type);
//! \brief Generates the HTTPBodyStream for the data currently supplied to
//! the builder.
//!
//! \return A caller-owned HTTPBodyStream object.
std::unique_ptr<HTTPBodyStream> GetBodyStream();
//! \brief Adds the appropriate content headers to \a http_headers.
//!
//! Any headers that this method adds will replace existing headers by the
//! same name in \a http_headers.
void PopulateContentHeaders(HTTPHeaders* http_headers) const;
private:
struct FileAttachment {
std::string filename;
std::string content_type;
base::FilePath path;
};
// Removes elements from both data maps at the specified |key|, to ensure
// uniqueness across the entire HTTP body.
void EraseKey(const std::string& key);
std::string boundary_;
std::map<std::string, std::string> form_data_;
std::map<std::string, FileAttachment> file_attachments_;
bool gzip_enabled_;
DISALLOW_COPY_AND_ASSIGN(HTTPMultipartBuilder);
};
} // namespace crashpad
#endif // CRASHPAD_UTIL_NET_HTTP_MULTIPART_BUILDER_H_