OLD | NEW |
(Empty) | |
| 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
| 2 // |
| 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 // you may not use this file except in compliance with the License. |
| 5 // You may obtain a copy of the License at |
| 6 // |
| 7 // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 // |
| 9 // Unless required by applicable law or agreed to in writing, software |
| 10 // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 // See the License for the specific language governing permissions and |
| 13 // limitations under the License. |
| 14 |
| 15 #ifndef CRASHPAD_UTIL_NET_HTTP_BODY_H_ |
| 16 #define CRASHPAD_UTIL_NET_HTTP_BODY_H_ |
| 17 |
| 18 #include <stdint.h> |
| 19 #include <sys/types.h> |
| 20 |
| 21 #include <string> |
| 22 #include <vector> |
| 23 |
| 24 #include "base/basictypes.h" |
| 25 #include "base/files/file_path.h" |
| 26 |
| 27 namespace crashpad { |
| 28 |
| 29 //! \brief An interface to a stream that can be used for an HTTP request body. |
| 30 class HTTPBodyStream { |
| 31 public: |
| 32 virtual ~HTTPBodyStream() {} |
| 33 |
| 34 //! \brief Copies up to \a max_len bytes into the user-supplied buffer. |
| 35 //! |
| 36 //! \param[out] buffer A user-supplied buffer into which this method will copy |
| 37 //! bytes from the stream. |
| 38 //! \param[in] max_len The length (or size) of \a buffer. At most this many |
| 39 //! bytes will be copied. |
| 40 //! |
| 41 //! \return On success, a positive number indicating the number of bytes |
| 42 //! actually copied to \a buffer. On failure, a negative number. When |
| 43 //! the stream has no more data, returns `0`. |
| 44 virtual ssize_t GetBytesBuffer(uint8_t* buffer, size_t max_len) = 0; |
| 45 |
| 46 protected: |
| 47 HTTPBodyStream() {} |
| 48 }; |
| 49 |
| 50 //! \brief An implementation of HTTPBodyStream that turns a fixed string into |
| 51 //! a stream. |
| 52 class StringHTTPBodyStream : public HTTPBodyStream { |
| 53 public: |
| 54 //! \brief Creates a stream with the specified string. |
| 55 //! |
| 56 //! \param[in] string The string to turn into a stream. |
| 57 explicit StringHTTPBodyStream(const std::string& string); |
| 58 |
| 59 ~StringHTTPBodyStream() override; |
| 60 |
| 61 // HTTPBodyStream: |
| 62 ssize_t GetBytesBuffer(uint8_t* buffer, size_t max_len) override; |
| 63 |
| 64 private: |
| 65 std::string string_; |
| 66 size_t bytes_read_; |
| 67 |
| 68 DISALLOW_COPY_AND_ASSIGN(StringHTTPBodyStream); |
| 69 }; |
| 70 |
| 71 //! \brief An implementation of HTTPBodyStream that reads from the specified |
| 72 //! file and provides its contents for an HTTP body. |
| 73 class FileHTTPBodyStream : public HTTPBodyStream { |
| 74 public: |
| 75 //! \brief Creates a stream for reading the file at the specified \a path. |
| 76 //! |
| 77 //! \param[in] path The file from which this HTTPBodyStream will read. |
| 78 explicit FileHTTPBodyStream(const base::FilePath& path); |
| 79 |
| 80 ~FileHTTPBodyStream() override; |
| 81 |
| 82 // HTTPBodyStream: |
| 83 ssize_t GetBytesBuffer(uint8_t* buffer, size_t max_len) override; |
| 84 |
| 85 private: |
| 86 enum InvalidFD { |
| 87 kUnopenedFile = -1, |
| 88 kFileOpenError = -2, |
| 89 kClosedAtEOF = -3, |
| 90 }; |
| 91 |
| 92 base::FilePath path_; |
| 93 |
| 94 // If |fd_| is greater than or equal to zero, it is an opened descriptor |
| 95 // from which an instance of this class is reading. If |fd_| is less than |
| 96 // zero, the value corresponds to an InvalidFD value. |
| 97 int fd_; |
| 98 |
| 99 DISALLOW_COPY_AND_ASSIGN(FileHTTPBodyStream); |
| 100 }; |
| 101 |
| 102 //! \brief An implementation of HTTPBodyStream that combines an array of |
| 103 //! several other HTTPBodyStream objects into a single, unified stream. |
| 104 class CompositeHTTPBodyStream : public HTTPBodyStream { |
| 105 public: |
| 106 using PartsList = std::vector<HTTPBodyStream*>; |
| 107 |
| 108 //! \brief Creates a stream from an array of other stream parts. |
| 109 //! |
| 110 //! \param[in] parts A vector of HTTPBodyStream objects, of which this object |
| 111 //! takes ownership, that will be represented as a single unified stream. |
| 112 //! Callers should not mutate the stream objects after passing them to |
| 113 //! an instance of this class. |
| 114 explicit CompositeHTTPBodyStream(const PartsList& parts); |
| 115 |
| 116 ~CompositeHTTPBodyStream() override; |
| 117 |
| 118 // HTTPBodyStream: |
| 119 ssize_t GetBytesBuffer(uint8_t* buffer, size_t max_len) override; |
| 120 |
| 121 private: |
| 122 PartsList parts_; |
| 123 PartsList::iterator current_part_; |
| 124 |
| 125 DISALLOW_COPY_AND_ASSIGN(CompositeHTTPBodyStream); |
| 126 }; |
| 127 |
| 128 } // namespace crashpad |
| 129 |
| 130 #endif // CRASHPAD_UTIL_NET_HTTP_BODY_H_ |
OLD | NEW |