-/* ====================================================================
- * The Apache Software License, Version 1.1
+/* 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
*
- * Copyright (c) 2000 The Apache Software Foundation. All rights
- * reserved.
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Apache" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation. For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
+ * 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.
+ */
+
+/**
+ * @file util_script.h
+ * @brief Apache script tools
*
- * Portions of this software are based upon public domain software
- * originally written at the National Center for Supercomputing Applications,
- * University of Illinois, Urbana-Champaign.
+ * @defgroup APACHE_CORE_SCRIPT Script Tools
+ * @ingroup APACHE_CORE
+ * @{
*/
#ifndef APACHE_UTIL_SCRIPT_H
#define APACHE_UTIL_SCRIPT_H
+#include "apr_buckets.h"
+
#ifdef __cplusplus
extern "C" {
#endif
-/**
- * @package Apache script tools
- */
-
#ifndef APACHE_ARG_MAX
#ifdef _POSIX_ARG_MAX
#define APACHE_ARG_MAX _POSIX_ARG_MAX
* @param t Apache table of key-value pairs
* @return An array containing the same key-value pairs suitable for
* use with an exec call.
- * @deffunc char **ap_create_environment(apr_pool_t *p, apr_table_t *t)
+ * @fn char **ap_create_environment(apr_pool_t *p, apr_table_t *t)
*/
-API_EXPORT(char **) ap_create_environment(apr_pool_t *p, apr_table_t *t);
+AP_DECLARE(char **) ap_create_environment(apr_pool_t *p, apr_table_t *t);
/**
* This "cute" little function comes about because the path info on
* @param uri The uri we are currently parsing
* @param path_info The current path info
* @return The length of the path info
- * @deffunc int ap_fine_path_info(const char *uri, const char *path_info)
+ * @fn int ap_find_path_info(const char *uri, const char *path_info)
*/
-API_EXPORT(int) ap_find_path_info(const char *uri, const char *path_info);
+AP_DECLARE(int) ap_find_path_info(const char *uri, const char *path_info);
/**
* Add CGI environment variables required by HTTP/1.1 to the request's
* environment table
* @param r the current request
- * @deffunc void ap_add_cgi_vars(request_rec *r)
+ * @fn void ap_add_cgi_vars(request_rec *r)
*/
-API_EXPORT(void) ap_add_cgi_vars(request_rec *r);
+AP_DECLARE(void) ap_add_cgi_vars(request_rec *r);
/**
* Add common CGI environment variables to the requests environment table
* @param r The current request
- * @deffunc void ap_add_common_vars(request_rec *r)
+ * @fn void ap_add_common_vars(request_rec *r)
*/
-API_EXPORT(void) ap_add_common_vars(request_rec *r);
+AP_DECLARE(void) ap_add_common_vars(request_rec *r);
/**
* Read headers output from a script, ensuring that the output is valid. If
* @param buffer Empty when calling the function. On output, if there was an
* error, the string that cause the error is stored here.
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer)
+ * @fn int ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer)
*/
-API_EXPORT(int) ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer);
+AP_DECLARE(int) ap_scan_script_header_err(request_rec *r, apr_file_t *f, char *buffer);
/**
* Read headers output from a script, ensuring that the output is valid. If
* the output is valid, then the headers are added to the headers out of the
* current request
* @param r The current request
- * @param f The BUFF to read from
+ * @param bb The brigade from which to read
* @param buffer Empty when calling the function. On output, if there was an
* error, the string that cause the error is stored here.
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err_buff(request_rec *r, BUFF *f, char *buffer)
+ * @fn int ap_scan_script_header_err_brigade(request_rec *r, apr_bucket_brigade *bb, char *buffer)
*/
-API_EXPORT(int) ap_scan_script_header_err_buff(request_rec *r, BUFF *f,
- char *buffer);
+AP_DECLARE(int) ap_scan_script_header_err_brigade(request_rec *r,
+ apr_bucket_brigade *bb,
+ char *buffer);
+
+/**
+ * Read headers strings from a script, ensuring that the output is valid. If
+ * the output is valid, then the headers are added to the headers out of the
+ * current request
+ * @param r The current request
+ * @param buffer Empty when calling the function. On output, if there was an
+ * error, the string that cause the error is stored here.
+ * @param termch Pointer to the last character parsed.
+ * @param termarg Pointer to an int to capture the last argument parsed.
+ *
+ * The varargs are string arguments to parse consecutively for headers,
+ * with a NULL argument to terminate the list.
+ *
+ * @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
+ */
+AP_DECLARE_NONSTD(int) ap_scan_script_header_err_strs(request_rec *r,
+ char *buffer,
+ const char **termch,
+ int *termarg, ...);
/**
* Read headers output from a script, ensuring that the output is valid. If
act like gets()
* @param getsfunc_data The place to read from
* @return HTTP_OK on success, HTTP_INTERNAL_SERVER_ERROR otherwise
- * @deffunc int ap_scan_script_header_err_core(request_rec *r, char *buffer, int (*getsfunc)(char *, int, void *), void *getsfunc_data)
*/
-API_EXPORT(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
+AP_DECLARE(int) ap_scan_script_header_err_core(request_rec *r, char *buffer,
int (*getsfunc) (char *, int, void *),
void *getsfunc_data);
-/**
- * Convert the file size given in size into a formatted string and send the
- * string to the client. The size should always be in bytes, although the
- * string sent to the client may be in bytes, kb, or MB, depending on the size
- * of the file.
- * @param size The size of the file
- * @param r The currnt request
- * @deffunc void ap_send_size(apr_ssize_t size, request_rec *r)
- */
-API_EXPORT(void) ap_send_size(apr_ssize_t size, request_rec *r);
+AP_DECLARE(void) ap_args_to_table(request_rec *r, apr_table_t **table);
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_UTIL_SCRIPT_H */
+/** @} */
projects / apache / blobdiff