1 2 Apache HTTP Server Request Library 3 4 What is it? 5 ----------- 6 httpd-apreq is subproject of the Apache HTTP Server Project 7 whose committers develop and maintain the libapreq C library 8 and its language bindings for Perl (contributions for additional 9 language bindings are most welcome). 10 11 libapreq is a safe, standards-compliant, high-performance library 12 used for parsing HTTP cookies, query-strings and POST data. The 13 original version (libapreq-1.X) was designed by Lincoln Stein and Doug 14 MacEachern. The perl APIs Apache::Request and Apache::Cookie are the 15 lightweight mod_perl analogs of the CGI and CGI::Cookie perl modules. 16 17 Version 2 of libapreq is an improved codebase designed around APR 18 and Apache-2's input filter API. The C codebase is separated into 19 two independent components: 20 21 1) libapreq2, a shared library which is based on 22 libapr and libaprutil. 23 24 2) A collection of modules: 25 26 - mod_apreq2, a filter module for the Apache 2.X webserver, 27 - a CGI module included in libapreq2 itself, 28 - a custom module for general applications. 29 30 Version 2 also includes the perl APIs for libapreq2- Apache2::Request, 31 Apache2::Upload and Apache2::Cookie. The corresponding XS modules 32 are generated by ExtUtils::XSBuilder, which is based on the new build 33 system created specifically for mod_perl2. 34 35 36 The Latest Version 37 ------------------ 38 39 Details of the latest version can be found on the libapreq 40 project page at 41 42 http://httpd.apache.org/apreq 43 44 45 Documentation 46 ------------- 47 48 The documentation is in the docs/ directory. It is 49 based on Doxygen, and can be regenerated by typing 50 51 % make docs 52 53 in the main directory. 54 55 56 Installation 57 ------------ 58 59 For full details please consult the INSTALL file. Briefly, 60 to install just the C API (libapreq2 + environment modules) 61 on a Unix-like system: 62 63 % ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs 64 % make 65 % make test 66 % make install 67 68 To build and install the perl API as well, either add 69 the "--enable-perl-glue" configure option, or let Makefile.PL 70 enable it for you: 71 72 % perl Makefile.PL --with-apache2-apxs=/path/to/apache2/bin/apxs 73 % make 74 % make test 75 % make install 76 77 Licensing 78 --------- 79 80 Please see the file called LICENSE. 81 82 83 Contacts 84 -------- 85 86 o Project homepage: 87 88 http://httpd.apache.org/apreq/ 89 90 o Mailing Lists: 91 92 user lists: 93 C/C++ API - modules-dev@httpd.apache.org 94 Perl API - modperl@perl.apache.org 95 Tcl API - XXX 96 Java API - XXX 97 Python API - XXX 98 99 developer list (bugs, patches, code contributions, etc.): 100 apreq-dev@httpd.apache.org 101 102 103 Acknowledgments 104 ---------------- 105 106 We wish to acknowledge the following copyrighted works that 107 make up portions of the Apache software: 108 109 libapreq2 relies heavily on the use of the GNU auto-tools 110 to provide a build environment. The tests are based on 111 the Apache::Test, Test::Harness and Test::Inline. 112 113 Doxygen generates the documentation for libapreq2. The perl glue 114 and pods are generated by ExtUtils::XSBuilder. 115