RESTinio

content-disposition.hpp
Go to the documentation of this file.
1/*
2 * RESTinio
3 */
4
12#pragma once
13
14#include <restinio/helpers/http_field_parsers/basics.hpp>
15
16#include <restinio/helpers/http_field_parsers/details/pct_encoded_symbols.hpp>
17
18 namespace restinio
19{
20
21 namespace http_field_parsers
22{
23
24 namespace content_disposition_details
25{
26
27 namespace ep_impl = restinio::easy_parser::impl;
28 namespace hfp_impl = restinio::http_field_parsers::impl;
29 namespace hfp_details = restinio::http_field_parsers::details;
30
31//
32// regular_token_producer_t
33//
45 class regular_token_producer_t
46 : public hfp_impl::token_producer_t
47{
48 public:
49 RESTINIO_NODISCARD
50 expected_t< result_type, parse_error_t >
51 try_parse( ep_impl::source_t & from ) const
52 {
53 ep_impl::source_t::content_consumer_t consumer{ from };
54 const auto result = hfp_impl::token_producer_t::try_parse( from );
55 if( result )
56 {
57 if( '*' == *(result->rbegin()) )
58 {
59 // Regular token can't have the trailing '*'.
60 return make_unexpected( parse_error_t{
61 consumer.started_at() + result->size() - 1,
62 error_reason_t::unexpected_character
63 } );
64 }
65
66 consumer.commit();
67 }
68
69 return result;
70 }
71};
72
73//
74// ext_token_producer_t
75//
87 class ext_token_producer_t
88 : public hfp_impl::token_producer_t
89{
90 public:
91 RESTINIO_NODISCARD
92 expected_t< result_type, parse_error_t >
93 try_parse( ep_impl::source_t & from ) const
94 {
95 ep_impl::source_t::content_consumer_t consumer{ from };
96 const auto result = hfp_impl::token_producer_t::try_parse( from );
97 if( result )
98 {
99 if( '*' != *(result->rbegin()) )
100 {
101 // Extended token should have the trailing '*'.
102 return make_unexpected( parse_error_t{
103 consumer.started_at(),
104 error_reason_t::pattern_not_found
105 } );
106 }
107
108 consumer.commit();
109 }
110
111 return result;
112 }
113};
114
115//
116// mime_charsetc_predicate_t
117//
126 struct mime_charsetc_predicate_t
127{
128 RESTINIO_NODISCARD
129 bool
130 operator()( const char actual ) const noexcept
131 {
132 return hfp_impl::is_alpha(actual)
133 || hfp_impl::is_digit(actual)
134 || '!' == actual
135 || '#' == actual
136 || '$' == actual
137 || '%' == actual
138 || '&' == actual
139 || '+' == actual
140 || '-' == actual
141 || '^' == actual
142 || '_' == actual
143 || '`' == actual
144 || '{' == actual
145 || '}' == actual
146 || '~' == actual
147 ;
148 }
149};
150
151//
152// mime_charsetc_symbol_producer
153//
161 RESTINIO_NODISCARD
162 inline auto
163 mime_charsetc_symbol_p()
164{
165 return ep_impl::symbol_producer_template_t< mime_charsetc_predicate_t >{};
166}
167
168//
169// language_predicate_t
170//
184 struct language_predicate_t
185{
186 RESTINIO_NODISCARD
187 bool
188 operator()( const char actual ) const noexcept
189 {
190 return hfp_impl::is_alpha(actual)
191 || hfp_impl::is_digit(actual)
192 || '-' == actual
193 ;
194 }
195};
196
197//
198// language_symbol_producer
199//
205 RESTINIO_NODISCARD
206 inline auto
207 language_symbol_p()
208{
209 return ep_impl::symbol_producer_template_t< language_predicate_t >{};
210}
211
212//
213// attr_char_predicate_t
214//
223 struct attr_char_predicate_t
224{
225 RESTINIO_NODISCARD
226 bool
227 operator()( const char actual ) const noexcept
228 {
229 return hfp_impl::is_alpha(actual)
230 || hfp_impl::is_digit(actual)
231 || '!' == actual
232 || '#' == actual
233 || '$' == actual
234 || '&' == actual
235 || '+' == actual
236 || '-' == actual
237 || '.' == actual
238 || '^' == actual
239 || '_' == actual
240 || '`' == actual
241 || '|' == actual
242 || '~' == actual
243 ;
244 }
245};
246
247//
248// attr_char_symbol_producer
249//
257 RESTINIO_NODISCARD
258 inline auto
259 attr_char_symbol_p()
260{
261 return ep_impl::symbol_producer_template_t< attr_char_predicate_t >{};
262}
263
264//
265// ext_parameter_value_producer
266//
297 RESTINIO_NODISCARD
298 inline auto
299 ext_parameter_value_p()
300{
301 return produce< std::string >(
302 repeat( 1, N, mime_charsetc_symbol_p() >> to_container() ),
303 symbol_p( '\'' ) >> to_container(),
304 repeat( 0, N, language_symbol_p() >> to_container() ),
305 symbol_p( '\'' ) >> to_container(),
306 repeat( 0, N,
307 alternatives(
308 attr_char_symbol_p() >> to_container(),
309 hfp_details::pct_encoded_symbols_p() >>
310 hfp_details::pct_encoded_symbols_consumer_t{} )
311 )
312 );
313}
314
315} /* namespace content_disposition_details */
316
317//
318// content_disposition_value_t
319//
336 struct content_disposition_value_t
337{
338 using parameter_t = parameter_with_mandatory_value_t;
339
340 using parameter_container_t = parameter_with_mandatory_value_container_t;
341
342 std::string value;
343 parameter_container_t parameters;
344
350 RESTINIO_NODISCARD
351 static auto
352 make_parser()
353 {
354 using namespace content_disposition_details;
355
356 return produce< content_disposition_value_t >(
357 token_p() >> to_lower()
358 >> &content_disposition_value_t::value,
359 produce< parameter_container_t >(
360 repeat( 0, N,
361 produce< parameter_t >(
362 ows(),
363 symbol(';'),
364 ows(),
365 alternatives(
366 sequence(
367 regular_token_producer_t{}
368 >> to_lower() >> &parameter_t::first,
369 symbol('='),
370 alternatives(
371 token_p() >> &parameter_t::second,
372 quoted_string_p() >> &parameter_t::second
373 )
374 ),
375 sequence(
376 ext_token_producer_t{}
377 >> to_lower() >> &parameter_t::first,
378 symbol('='),
379 ext_parameter_value_p() >> &parameter_t::second
380 )
381 )
382 ) >> to_container()
383 )
384 ) >> &content_disposition_value_t::parameters
385 );
386 }
387
393 RESTINIO_NODISCARD
394 static expected_t< content_disposition_value_t, restinio::easy_parser::parse_error_t >
395 try_parse( string_view_t what )
396 {
397 return restinio::easy_parser::try_parse( what, make_parser() );
398 }
399};
400
401} /* namespace http_field_parsers */
402
403} /* namespace restinio */
404
basics.hpp
Utilities for parsing values of http-fields.
restinio::easy_parser::impl::source_t
The class that implements "input stream".
Definition: easy_parser.hpp:740
restinio::easy_parser::impl::symbol_producer_template_t
A template for producer of charachers that satisfy some predicate.
Definition: easy_parser.hpp:2133
restinio::easy_parser::parse_error_t
Information about parsing error.
Definition: easy_parser.hpp:93
restinio::http_field_parsers::content_disposition_details::ext_token_producer_t
A producer for token that is an "extended parameter name" in sense of RCF6266 and RCF5987.
Definition: content-disposition.hpp:89
restinio::http_field_parsers::content_disposition_details::ext_token_producer_t::try_parse
RESTINIO_NODISCARD expected_t< result_type, parse_error_t > try_parse(ep_impl::source_t &from) const
Definition: content-disposition.hpp:93
restinio::http_field_parsers::content_disposition_details::regular_token_producer_t
A producer for token that is a "regular parameter name" in sense of RCF6266 and RCF5987.
Definition: content-disposition.hpp:47
restinio::http_field_parsers::content_disposition_details::regular_token_producer_t::try_parse
RESTINIO_NODISCARD expected_t< result_type, parse_error_t > try_parse(ep_impl::source_t &from) const
Definition: content-disposition.hpp:51
restinio::http_field_parsers::impl::token_producer_t
A producer for token.
Definition: basics.hpp:523
restinio::http_field_parsers::impl::token_producer_t::try_parse
RESTINIO_NODISCARD expected_t< result_type, parse_error_t > try_parse(source_t &from) const
Definition: basics.hpp:568
RESTINIO_NODISCARD
#define RESTINIO_NODISCARD
Definition: compiler_features.hpp:33
restinio::easy_parser::impl
Definition: easy_parser.hpp:280
restinio::easy_parser::impl::is_digit
RESTINIO_NODISCARD constexpr bool is_digit(const char ch) noexcept
Is a character a decimal digit?
Definition: easy_parser.hpp:669
restinio::easy_parser::symbol
RESTINIO_NODISCARD auto symbol(char expected) noexcept
A factory function to create a clause that expects the speficied symbol, extracts it and then skips i...
Definition: easy_parser.hpp:4032
restinio::easy_parser::sequence
RESTINIO_NODISCARD auto sequence(Clauses &&... clauses)
A factory function to create a sequence of subclauses.
Definition: easy_parser.hpp:3758
restinio::easy_parser::try_parse
RESTINIO_NODISCARD expected_t< typename Producer::result_type, parse_error_t > try_parse(string_view_t from, Producer producer)
Perform the parsing of the specified content by using specified value producer.
Definition: easy_parser.hpp:5042
restinio::easy_parser::repeat
RESTINIO_NODISCARD auto repeat(std::size_t min_occurences, std::size_t max_occurences, Clauses &&... clauses)
A factory function to create repetitor of subclauses.
Definition: easy_parser.hpp:3876
restinio::easy_parser::N
constexpr std::size_t N
A special marker that means infinite repetitions.
Definition: easy_parser.hpp:455
restinio::easy_parser::to_container
RESTINIO_NODISCARD auto to_container()
A factory function to create a to_container_consumer.
Definition: easy_parser.hpp:4583
restinio::easy_parser::symbol_p
RESTINIO_NODISCARD auto symbol_p(char expected) noexcept
A factory function to create a symbol_producer.
Definition: easy_parser.hpp:3955
restinio::easy_parser::to_lower
RESTINIO_NODISCARD auto to_lower() noexcept
A factory function to create a to_lower_transformer.
Definition: easy_parser.hpp:4610
restinio::easy_parser::alternatives
RESTINIO_NODISCARD auto alternatives(Clauses &&... clauses)
A factory function to create an alternatives clause.
Definition: easy_parser.hpp:3595
restinio::http_field_parsers::content_disposition_details::mime_charsetc_symbol_p
RESTINIO_NODISCARD auto mime_charsetc_symbol_p()
A factory for producer that extracts mime-charsetc symbols.
Definition: content-disposition.hpp:163
restinio::http_field_parsers::content_disposition_details::language_symbol_p
RESTINIO_NODISCARD auto language_symbol_p()
A factory for producer that extracts language symbols.
Definition: content-disposition.hpp:207
restinio::http_field_parsers::content_disposition_details::attr_char_symbol_p
RESTINIO_NODISCARD auto attr_char_symbol_p()
A factory for producer that extracts attr-char symbols.
Definition: content-disposition.hpp:259
restinio::http_field_parsers::content_disposition_details::ext_parameter_value_p
RESTINIO_NODISCARD auto ext_parameter_value_p()
A producer for an "extended parameter value" in sense of RCF6266 and RCF5987.
Definition: content-disposition.hpp:299
restinio::http_field_parsers::details
Definition: pct_encoded_symbols.hpp:23
restinio::http_field_parsers::details::pct_encoded_symbols_p
RESTINIO_NODISCARD auto pct_encoded_symbols_p()
A producer that extract a sequence of symbols represented a percent-encoded character.
Definition: pct_encoded_symbols.hpp:57
restinio::http_field_parsers::impl
Definition: basics.hpp:247
restinio::http_field_parsers::impl::is_alpha
RESTINIO_NODISCARD constexpr bool is_alpha(const char ch) noexcept
Is a character an ALPHA?
Definition: basics.hpp:263
restinio::http_field_parsers::parameter_with_mandatory_value_container_t
std::vector< parameter_with_mandatory_value_t > parameter_with_mandatory_value_container_t
A type of container for parameters with mandatory values.
Definition: basics.hpp:1532
restinio::http_field_parsers::ows
RESTINIO_NODISCARD auto ows() noexcept
A factory function to create an OWS clause.
Definition: basics.hpp:939
restinio::http_field_parsers::token_p
RESTINIO_NODISCARD auto token_p() noexcept
A factory function to create a token_producer.
Definition: basics.hpp:985
restinio::http_field_parsers::quoted_string_p
RESTINIO_NODISCARD auto quoted_string_p() noexcept
A factory function to create a quoted_string_producer.
Definition: basics.hpp:1012
restinio::http_field_parsers::parameter_with_mandatory_value_t
std::pair< std::string, std::string > parameter_with_mandatory_value_t
A type that describes a parameter with mandatory value.
Definition: basics.hpp:1521
restinio
Definition: asio_include.hpp:21
restinio::string_view_t
nonstd::string_view string_view_t
Definition: string_view.hpp:19
restinio::expected_t
nonstd::expected< T, E > expected_t
Definition: expected.hpp:22
pct_encoded_symbols.hpp
Stuff related to percent-encoded symbols.
restinio::http_field_parsers::content_disposition_details::attr_char_predicate_t
A preducate for symbol_producer_template that checks that a symbol is attr-char symbol from RCF5987.
Definition: content-disposition.hpp:224
restinio::http_field_parsers::content_disposition_details::attr_char_predicate_t::operator()
RESTINIO_NODISCARD bool operator()(const char actual) const noexcept
Definition: content-disposition.hpp:227
restinio::http_field_parsers::content_disposition_details::language_predicate_t
A preducate for symbol_producer_template that checks that a symbol is language symbol from RCF5646.
Definition: content-disposition.hpp:185
restinio::http_field_parsers::content_disposition_details::language_predicate_t::operator()
RESTINIO_NODISCARD bool operator()(const char actual) const noexcept
Definition: content-disposition.hpp:188
restinio::http_field_parsers::content_disposition_details::mime_charsetc_predicate_t
A preducate for symbol_producer_template that checks that a symbol is mime-charsetc symbol from RCF59...
Definition: content-disposition.hpp:127
restinio::http_field_parsers::content_disposition_details::mime_charsetc_predicate_t::operator()
RESTINIO_NODISCARD bool operator()(const char actual) const noexcept
Definition: content-disposition.hpp:130
restinio::http_field_parsers::content_disposition_value_t
Tools for working with the value of Content-Disposition HTTP-field.
Definition: content-disposition.hpp:337
restinio::http_field_parsers::content_disposition_value_t::try_parse
static RESTINIO_NODISCARD expected_t< content_disposition_value_t, restinio::easy_parser::parse_error_t > try_parse(string_view_t what)
An attempt to parse Content-Disposition HTTP-field.
Definition: content-disposition.hpp:395
restinio::http_field_parsers::content_disposition_value_t::parameter_container_t
parameter_with_mandatory_value_container_t parameter_container_t
Definition: content-disposition.hpp:340
restinio::http_field_parsers::content_disposition_value_t::parameters
parameter_container_t parameters
Definition: content-disposition.hpp:343
restinio::http_field_parsers::content_disposition_value_t::parameter_t
parameter_with_mandatory_value_t parameter_t
Definition: content-disposition.hpp:338
restinio::http_field_parsers::content_disposition_value_t::value
std::string value
Definition: content-disposition.hpp:342
restinio::http_field_parsers::content_disposition_value_t::make_parser
static RESTINIO_NODISCARD auto make_parser()
A factory function for a parser of Content-Disposition value.
Definition: content-disposition.hpp:352
restinio::http_field_parsers::details::pct_encoded_symbols_consumer_t
A special consumer that inserts an extracted sequence of symbols into the result string.
Definition: pct_encoded_symbols.hpp:80