apreq_parser.h

Go to the documentation of this file.

/*
**  Licensed to the Apache Software Foundation (ASF) under one or more
** contributor license agreements.  See the NOTICE file distributed with
** this work for additional information regarding copyright ownership.
** The ASF licenses this file to You 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 APREQ_PARSERS_H
#define APREQ_PARSERS_H
/* These structs are defined below */
 
#include "apreq_param.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct apreq_hook_t apreq_hook_t;
 
typedef struct apreq_parser_t apreq_parser_t;
 
#define APREQ_PARSER_ARGS  apreq_parser_t *parser,     \
                           apr_table_t *t,             \
                           apr_bucket_brigade *bb
 
#define APREQ_HOOK_ARGS    apreq_hook_t *hook,         \
                           apreq_param_t *param,       \
                           apr_bucket_brigade *bb
 
typedef apr_status_t (*apreq_parser_function_t)(APREQ_PARSER_ARGS);
 
typedef apr_status_t (*apreq_hook_function_t)(APREQ_HOOK_ARGS);
 
#define APREQ_DECLARE_PARSER(f) APREQ_DECLARE_NONSTD(apr_status_t) \
                                f (APREQ_PARSER_ARGS)
 
#define APREQ_DECLARE_HOOK(f)   APREQ_DECLARE_NONSTD(apr_status_t) \
                                f (APREQ_HOOK_ARGS)
 
struct apreq_hook_t {
    apreq_hook_function_t hook; 
    apreq_hook_t         *next; 
    apr_pool_t           *pool; 
    void *ctx; 
};
 
struct apreq_parser_t {
    apreq_parser_function_t parser;
    const char             *content_type;
    apr_pool_t             *pool;
    apr_bucket_alloc_t     *bucket_alloc;
    apr_size_t              brigade_limit;
    const char             *temp_dir;
    apreq_hook_t           *hook;
    void                   *ctx;
};
 
 
static APR_INLINE
apr_status_t apreq_parser_run(struct apreq_parser_t *psr, apr_table_t *t,
                              apr_bucket_brigade *bb)
{
    return psr->parser(psr, t, bb);
}
 
static APR_INLINE
apr_status_t apreq_hook_run(struct apreq_hook_t *h, apreq_param_t *param,
                            apr_bucket_brigade *bb)
{
    return h->hook(h, param, bb);
}
 
 
APREQ_DECLARE_PARSER(apreq_parse_headers);
 
APREQ_DECLARE_PARSER(apreq_parse_urlencoded);
 
APREQ_DECLARE_PARSER(apreq_parse_multipart);
 
APREQ_DECLARE_PARSER(apreq_parse_generic);
 
APREQ_DECLARE_HOOK(apreq_hook_apr_xml_parser);
 
APREQ_DECLARE(apreq_parser_t *) apreq_parser_make(apr_pool_t *pool,
                                                  apr_bucket_alloc_t *ba,
                                                  const char *content_type,
                                                  apreq_parser_function_t pfn,
                                                  apr_size_t brigade_limit,
                                                  const char *temp_dir,
                                                  apreq_hook_t *hook,
                                                  void *ctx);
 
APREQ_DECLARE(apreq_hook_t *) apreq_hook_make(apr_pool_t *pool,
                                              apreq_hook_function_t hook,
                                              apreq_hook_t *next,
                                              void *ctx);
 
 
APREQ_DECLARE(apr_status_t) apreq_parser_add_hook(apreq_parser_t *p,
                                                  apreq_hook_t *h);
 
 
APREQ_DECLARE(apreq_parser_function_t)apreq_parser(const char *enctype);
 
 
APREQ_DECLARE(apr_status_t) apreq_register_parser(const char *enctype,
                                                  apreq_parser_function_t pfn);
 
 
APREQ_DECLARE_HOOK(apreq_hook_disable_uploads);
 
APREQ_DECLARE_HOOK(apreq_hook_discard_brigade);
 
typedef struct apreq_hook_find_param_ctx_t {
    const char    *name;
    apreq_param_t *param;
    apreq_hook_t  *prev;
} apreq_hook_find_param_ctx_t;
 
 
APREQ_DECLARE_HOOK(apreq_hook_find_param);
 
 
#ifdef __cplusplus
}
 
#endif
#endif /* APREQ_PARSERS_H */