From: (no author) <(no author)@unknown> Date: Mon, 20 Nov 2000 20:10:50 +0000 (+0000) Subject: This commit was manufactured by cvs2svn to create tag X-Git-Tag: APACHE_2_0_ALPHA_8^0 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=173652fa551881f22ca9a5e62ec587ea63df83c2;p=thirdparty%2Fapache%2Fhttpd.git This commit was manufactured by cvs2svn to create tag 'APACHE_2_0_ALPHA_8'. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/tags/APACHE_2_0_ALPHA_8@87038 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/build/binbuild.sh b/build/binbuild.sh deleted file mode 100755 index 53aa80ff1a9..00000000000 --- a/build/binbuild.sh +++ /dev/null @@ -1,300 +0,0 @@ -#!/bin/sh -# -# binbuild.sh - Builds an Apache binary distribution. -# Initially written by Lars Eilebrecht . -# -# This script falls under the Apache License. -# See http://www.apache.org/docs/LICENSE - -OS=`src/helpers/GuessOS` -case "x$OS" in - x*390*) CONFIGPARAM="--with-layout=BinaryDistribution --enable-module=most";; - *) CONFIGPARAM="--with-layout=BinaryDistribution --enable-module=most --enable-shared=max";; -esac -APDIR=`pwd` -APDIR=`basename $APDIR` -VER=`echo $APDIR |sed s/apache_//` -TAR="`src/helpers/PrintPath tar`" -GTAR="`src/helpers/PrintPath gtar`" -GZIP="`src/helpers/PrintPath gzip`" - -if [ x$1 != x ] -then - USER=$1 -else - USER="`src/helpers/buildinfo.sh -n %u@%h%d`" -fi - -if [ ! -f ./ABOUT_APACHE ] -then - echo "ERROR: The current directory contains no valid Apache distribution." - echo "Please change the directory to the top level directory of a freshly" - echo "unpacked Apache 1.3 source distribution and re-execute the script" - echo "'./src/helpers/bindbuild.sh'." - exit 1; -fi - -if [ -d ./CVS ] -then - echo "ERROR: The current directory is a CVS checkout of Apache." - echo "Only a standard Apache 1.3 source distribution should be used to" - echo "create a binary distribution." - exit 1; -fi - -echo "Building Apache $VER binary distribution..." -echo "Platform is \"$OS\"..." - -( echo "Build log for Apache binary distribution" && \ - echo "----------------------------------------------------------------------" && \ - ./configure $CONFIGPARAM && \ - echo "----------------------------------------------------------------------" && \ - make clean && \ - rm -rf bindist install-bindist.sh *.bindist - echo "----------------------------------------------------------------------" && \ - make && \ - echo "----------------------------------------------------------------------" && \ - make install-quiet root="bindist/" && \ - echo "----------------------------------------------------------------------" && \ - make clean && \ - echo "----------------------------------------------------------------------" && \ - echo "[EOF]" \ -) > build.log 2>&1 - -if [ ! -f ./bindist/bin/httpd ] -then - echo "ERROR: Failed to build Apache. See \"build.log\" for details." - exit 1; -fi - -echo "Binary image successfully created..." - -./bindist/bin/httpd -v - -echo "Creating supplementary files..." - -( echo " " && \ - echo "Apache $VER binary distribution" && \ - echo "================================" && \ - echo " " && \ - echo "This binary distribution is usable on a \"$OS\"" && \ - echo "system and was built by \"$USER\"." && \ - echo "" && \ - echo "The distribution contains all standard Apache modules as shared" && \ - echo "objects. This allows you to enable or disable particular modules" && \ - echo "with the LoadModule/AddModule directives in the configuration file" && \ - echo "without the need to re-compile Apache." && \ - echo "" && \ - echo "See \"INSTALL.bindist\" on how to install the distribution." && \ - echo " " && \ - echo "NOTE: Please do not send support-related mails to the address mentioned" && \ - echo " above or to any member of the Apache Group! Support questions" && \ - echo " should be directed to the \"comp.infosystems.www.servers.unix\"" && \ - echo " or \"comp.infosystems.www.servers.ms-windows\" newsgroup" && \ - echo " (as appropriate for the platform you use), where some of the" && \ - echo " Apache team lurk, in the company of many other Apache gurus" && \ - echo " who should be able to help." && \ - echo " If you think you found a bug in Apache or have a suggestion please" && \ - echo " visit the bug report page at http://www.apache.org/bug_report.html" && \ - echo " " && \ - echo "----------------------------------------------------------------------" && \ - ./bindist/bin/httpd -V && \ - echo "----------------------------------------------------------------------" \ -) > README.bindist -cp README.bindist ../apache_$VER-$OS.README - -( echo " " && \ - echo "Apache $VER binary installation" && \ - echo "================================" && \ - echo " " && \ - echo "To install this binary distribution you have to execute the installation" && \ - echo "script \"install-bindist.sh\" in the top-level directory of the distribution." && \ - echo " " && \ - echo "The script takes the ServerRoot directory into which you want to install" && \ - echo "Apache as an option. If you ommit the option the default path" && \ - echo "\"/usr/local/apache\" is used." && \ - echo "Make sure you have write permissions in the target directory, e.g. switch" && \ - echo "to user \"root\" before you execute the script." && \ - echo " " && \ - echo "See \"README.bindist\" for further details about this distribution." && \ - echo " " && \ - echo "Please note that this distribution includes the complete Apache source code." && \ - echo "Therefore you may compile Apache yourself at any time if you have a compiler" && \ - echo "installation on your system." && \ - echo "See \"INSTALL\" for details on how to accomplish this." && \ - echo " " \ -) > INSTALL.bindist - -( echo "#!/bin/sh" && \ - echo "#" && \ - echo "# Usage: install-bindist.sh [ServerRoot]" && \ - echo "# This script installs the Apache binary distribution and" && \ - echo "# was automatically created by binbuild.sh." && \ - echo " " && \ - echo "lmkdir()" && \ - echo "{" && \ - echo " path=\"\"" && \ - echo " dirs=\`echo \$1 | sed -e 's%/% %g'\`" && \ - echo " mode=\$2" && \ - echo " " && \ - echo " set -- \${dirs}" && \ - echo " " && \ - echo " for d in \${dirs}" && \ - echo " do" && \ - echo " path=\"\${path}/\$d\"" && \ - echo " if test ! -d \"\${path}\" ; then" && \ - echo " mkdir \${path}" && \ - echo " if test \$? -ne 0 ; then" && \ - echo " echo \"Failed to create directory: \${path}\"" && \ - echo " exit 1" && \ - echo " fi" && \ - echo " chmod \${mode} \${path}" && \ - echo " fi" && \ - echo " done" && \ - echo "}" && \ - echo " " && \ - echo "lcopy()" && \ - echo "{" && \ - echo " from=\$1" && \ - echo " to=\$2" && \ - echo " dmode=\$3" && \ - echo " fmode=\$4" && \ - echo " " && \ - echo " test -d \${to} || lmkdir \${to} \${dmode}" && \ - echo " (cd \${from} && tar -cf - *) | (cd \${to} && tar -xf -)" && \ - echo " " && \ - echo " if test \"X\${fmode}\" != X ; then" && \ - echo " find \${to} -type f -print | xargs chmod \${fmode}" && \ - echo " fi" && \ - echo " if test \"X\${dmode}\" != X ; then" && \ - echo " find \${to} -type d -print | xargs chmod \${dmode}" && \ - echo " fi" && \ - echo "}" && \ - echo " " && \ - echo "##" && \ - echo "## determine path to (optional) Perl interpreter" && \ - echo "##" && \ - echo "PERL=no-perl5-on-this-system" && \ - echo "perls='perl5 perl'" && \ - echo "path=\`echo \$PATH | sed -e 's/:/ /g'\`" && \ - echo " " && \ - echo "for dir in \${path} ; do" && \ - echo " for pperl in \${perls} ; do" && \ - echo " if test -f \"\${dir}/\${pperl}\" ; then" && \ - echo " if \`\${dir}/\${pperl} -v | grep 'version 5\.' >/dev/null 2>&1\` ; then" && \ - echo " PERL=\"\${dir}/\${pperl}\"" && \ - echo " break" && \ - echo " fi" && \ - echo " fi" && \ - echo " done" && \ - echo "done" && \ - echo " " && \ - echo "if [ .\$1 = . ]" && \ - echo "then" && \ - echo " SR=/usr/local/apache" && \ - echo "else" && \ - echo " SR=\$1" && \ - echo "fi" && \ - echo "echo \"Installing binary distribution for platform $OS\"" && \ - echo "echo \"into directory \$SR ...\"" && \ - echo "lmkdir \$SR 755" && \ - echo "lmkdir \$SR/proxy 750" && \ - echo "lmkdir \$SR/logs 750" && \ - echo "lcopy bindist/man \$SR/man 755 644" && \ - echo "lcopy bindist/libexec \$SR/libexec 750 644" && \ - echo "lcopy bindist/include \$SR/include 755 644" && \ - echo "lcopy bindist/icons \$SR/icons 755 644" && \ - echo "lcopy bindist/cgi-bin \$SR/cgi-bin 750 750" && \ - echo "lcopy bindist/bin \$SR/bin 750 750" && \ - echo "if [ -d \$SR/conf ]" && \ - echo "then" && \ - echo " echo \"[Preserving existing configuration files.]\"" && \ - echo " cp bindist/conf/*.default \$SR/conf/" && \ - echo "else" && \ - echo " lcopy bindist/conf \$SR/conf 750 640" && \ - echo "fi" && \ - echo "if [ -d \$SR/htdocs ]" && \ - echo "then" && \ - echo " echo \"[Preserving existing htdocs directory.]\"" && \ - echo "else" && \ - echo " lcopy bindist/htdocs \$SR/htdocs 755 644" && \ - echo "fi" && \ - echo " " && \ - echo "sed -e \"s;^#!/.*;#!\$PERL;\" -e \"s;\@prefix\@;\$SR;\" -e \"s;\@sbindir\@;\$SR/bin;\" \\" && \ - echo " -e \"s;\@libexecdir\@;\$SR/libexec;\" -e \"s;\@includedir\@;\$SR/include;\" \\" && \ - echo " -e \"s;\@sysconfdir\@;\$SR/conf;\" bindist/bin/apxs > \$SR/bin/apxs" && \ - echo "sed -e \"s;^#!/.*;#!\$PERL;\" bindist/bin/dbmmanage > \$SR/bin/dbmmanage" && \ - echo "sed -e \"s%/usr/local/apache%\$SR%\" \$SR/conf/httpd.conf.default > \$SR/conf/httpd.conf" && \ - echo "sed -e \"s%PIDFILE=%PIDFILE=\$SR/%\" -e \"s%HTTPD=%HTTPD=\\\"\$SR/%\" -e \"s%httpd\$%httpd -d \$SR -R \$SR/libexec\\\"%\" bindist/bin/apachectl > \$SR/bin/apachectl" && \ - echo " " && \ - echo "echo \"Ready.\"" && \ - echo "echo \" +--------------------------------------------------------+\"" && \ - echo "echo \" | You now have successfully installed the Apache $VER |\"" && \ - echo "echo \" | HTTP server. To verify that Apache actually works |\"" && \ - echo "echo \" | correctly you should first check the (initially |\"" && \ - echo "echo \" | created or preserved) configuration files: |\"" && \ - echo "echo \" | |\"" && \ - echo "echo \" | \$SR/conf/httpd.conf\"" && \ - echo "echo \" | |\"" && \ - echo "echo \" | You should then be able to immediately fire up |\"" && \ - echo "echo \" | Apache the first time by running: |\"" && \ - echo "echo \" | |\"" && \ - echo "echo \" | \$SR/bin/apachectl start \"" &&\ - echo "echo \" | |\"" && \ - echo "echo \" | Thanks for using Apache. The Apache Group |\"" && \ - echo "echo \" | http://www.apache.org/ |\"" && \ - echo "echo \" +--------------------------------------------------------+\"" && \ - echo "echo \" \"" \ -) > install-bindist.sh -chmod 755 install-bindist.sh - -sed -e "s%\"htdocs%\"/usr/local/apache/htdocs%" \ - -e "s%\"icons%\"/usr/local/apache/icons%" \ - -e "s%\"cgi-bin%\"/usr/local/apache/cgi-bin%" \ - -e "s%\"proxy%\"/usr/local/apache/proxy%" \ - -e "s%^ServerAdmin.*%ServerAdmin you@your.address%" \ - -e "s%#ServerName.*%#ServerName localhost%" \ - -e "s%Port 8080%Port 80%" \ - bindist/conf/httpd.conf.default > bindist/conf/httpd.conf -cp bindist/conf/httpd.conf bindist/conf/httpd.conf.default - -echo "Creating distribution archive and readme file..." - -if [ ".`grep -i error build.log > /dev/null`" != . ] -then - echo "ERROR: Failed to build Apache. See \"build.log\" for details." - exit 1; -else - if [ "x$GTAR" != "x" ] - then - $GTAR -zcf ../apache_$VER-$OS.tar.gz -C .. apache_$VER - else - if [ "x$TAR" != "x" ] - then - case "x$OS" in - x*390*) $TAR -cfU ../apache_$VER-$OS.tar -C .. apache_$VER;; - *) (cd .. && $TAR -cf apache_$VER-$OS.tar apache_$VER);; - esac - if [ "x$GZIP" != "x" ] - then - $GZIP ../apache_$VER-$OS.tar - fi - else - echo "ERROR: Could not find a 'tar' program!" - echo " Please execute the following commands manually:" - echo " tar -cf ../apache_$VER-$OS.tar ." - echo " gzip ../apache_$VER-$OS.tar" - fi - fi - - if [ -f ../apache_$VER-$OS.tar.gz ] && [ -f ../apache_$VER-$OS.README ] - then - echo "Ready." - echo "You can find the binary archive (apache_$VER-$OS.tar.gz)" - echo "and the readme file (apache_$VER-$OS.README) in the" - echo "parent directory." - exit 0; - else - exit 1; - fi -fi diff --git a/docs/docroot/apache_pb.gif b/docs/docroot/apache_pb.gif deleted file mode 100644 index 3a1c139fc42..00000000000 Binary files a/docs/docroot/apache_pb.gif and /dev/null differ diff --git a/docs/manual/bind.html.en b/docs/manual/bind.html.en deleted file mode 100644 index 75bacbb2536..00000000000 --- a/docs/manual/bind.html.en +++ /dev/null @@ -1,135 +0,0 @@ - - -Setting which addresses and ports Apache uses - - - - - -

Setting which addresses and ports Apache uses

- -
- -When Apache starts, it connects to some port and address on the -local machine and waits for incoming requests. By default, it -listens to all addresses on the machine, and to the port -as specified by the Port directive in the server configuration. -However, it can be told to listen to more the one port, or to listen -to only selected addresses, or a combination. This is often combined -with the Virtual Host feature which determines how Apache -responds to different IP addresses, hostnames and ports.

- -There are two directives used to restrict or specify which addresses -and ports Apache listens to. - -

- -

BindAddress

-Syntax: BindAddress [ * | IP-address - | hostname ]
-Default: BindAddress *
-Context: server config
-Status: Core

- -Makes the server listen to just the specified address. If the argument -is *, the server listens to all addresses. The port listened to -is set with the Port directive. Only one BindAddress -should be used. - -

Listen

-Syntax: Listen [ port | IP-address:port ]
-Default: none
-Context: server config
-Status: Core

- -Listen can be used instead of BindAddress and -Port. It tells the server to accept incoming requests on the -specified port or address-and-port combination. If the first format is -used, with a port number only, the server listens to the given port on -all interfaces, instead of the port given by the Port -directive. If an IP address is given as well as a port, the server -will listen on the given port and interface.

Multiple Listen -directives may be used to specify a number of addresses and ports to -listen to. The server will respond to requests from any of the listed -addresses and ports.

- -For example, to make the server accept connections on both port -80 and port 8000, use: -

-   Listen 80
-   Listen 8000
-
- -To make the server accept connections on two specified -interfaces and port numbers, use -
-   Listen 192.170.2.1:80
-   Listen 192.170.2.5:8000
-
- -

How this works with Virtual Hosts

- -BindAddress and Listen do not implement Virtual Hosts. They tell the -main server what addresses and ports to listen to. If no -<VirtualHost> directives are used, the server will behave the -same for all accepted requests. However, <VirtualHost> can be -used to specify a different behavior for one or more of the addresses -and ports. To implement a VirtualHost, the server must first be told -to listen to the address and port to be used. Then a -<VirtualHost> section should be created for a specified address -and port to set the behavior of this virtual host. Note that if the -<VirtualHost> is set for an address and port that the server is -not listening to, it cannot be accessed. - -

See also

- -See also the documentation on -Virtual Hosts, -BindAddress directive, -Port directive, -DNS Issues -and -<VirtualHost> section. - - - - - diff --git a/docs/manual/cgi_path.html.en b/docs/manual/cgi_path.html.en deleted file mode 100644 index 2b7bd963b15..00000000000 --- a/docs/manual/cgi_path.html.en +++ /dev/null @@ -1,93 +0,0 @@ - - -PATH_INFO Changes in the CGI Environment - - - - - -

PATH_INFO Changes in the CGI Environment

- -
- -

Overview

- -

As implemented in Apache 1.1.1 and earlier versions, the method -Apache used to create PATH_INFO in the CGI environment was -counterintuitive, and could result in crashes in certain cases. In -Apache 1.2 and beyond, this behavior has changed. Although this -results in some compatibility problems with certain legacy CGI -applications, the Apache 1.2 behavior is still compatible with the -CGI/1.1 specification, and CGI scripts can be easily modified (see below). - -

The Problem

- -

Apache 1.1.1 and earlier implemented the PATH_INFO and SCRIPT_NAME -environment variables by looking at the filename, not the URL. While -this resulted in the correct values in many cases, when the filesystem -path was overloaded to contain path information, it could result in -errant behavior. For example, if the following appeared in a config -file: -

-     Alias /cgi-ralph /usr/local/httpd/cgi-bin/user.cgi/ralph
-
-

In this case, user.cgi is the CGI script, the "/ralph" -is information to be passed onto the CGI. If this configuration was in -place, and a request came for "/cgi-ralph/script/", the -code would set PATH_INFO to "/ralph/script", and -SCRIPT_NAME to "/cgi-". Obviously, the latter is -incorrect. In certain cases, this could even cause the server to -crash.

- -

The Solution

- -

Apache 1.2 and later now determine SCRIPT_NAME and PATH_INFO by -looking directly at the URL, and determining how much of the URL is -client-modifiable, and setting PATH_INFO to it. To use the above -example, PATH_INFO would be set to "/script", and -SCRIPT_NAME to "/cgi-ralph". This makes sense and results -in no server behavior problems. It also permits the script to be -guaranteed that -"http://$SERVER_NAME:$SERVER_PORT$SCRIPT_NAME$PATH_INFO" -will always be an accessible URL that points to the current script, -something which was not necessarily true with previous versions of -Apache. - -

However, the "/ralph" -information from the Alias directive is lost. This is -unfortunate, but we feel that using the filesystem to pass along this -sort of information is not a recommended method, and a script making -use of it "deserves" not to work. Apache 1.2b3 and later, however, do -provide a workaround. - -

Compatibility with Previous Servers

- -

It may be necessary for a script that was designed for earlier -versions of Apache or other servers to need the information that the -old PATH_INFO variable provided. For this purpose, Apache 1.2 (1.2b3 -and later) sets an additional variable, FILEPATH_INFO. This -environment variable contains the value that PATH_INFO would have had -with Apache 1.1.1.

- -

A script that wishes to work with both Apache 1.2 and earlier -versions can simply test for the existence of FILEPATH_INFO, and use -it if available. Otherwise, it can use PATH_INFO. For example, in -Perl, one might use: -

-    $path_info = $ENV{'FILEPATH_INFO'} || $ENV{'PATH_INFO'};
-
- -

By doing this, a script can work with all servers supporting the -CGI/1.1 specification, including all versions of Apache.

- - - - - diff --git a/docs/manual/configuring.html.en b/docs/manual/configuring.html.en deleted file mode 100644 index 88d65eaae6d..00000000000 --- a/docs/manual/configuring.html.en +++ /dev/null @@ -1,242 +0,0 @@ - - - -Configuration Files - - - - - -

Configuration Files

- - - -
- -

Main Configuration Files

- - - -
-Related Modules

-mod_mime
-		 -Related Directives

-AccessConfig
-<IfDefine>
-Include
-ResourceConfig
-TypesConfig
-
- -

Apache is configured by placing directives in plain text configuration files. The main -configuration file is usually called httpd.conf. The -location of this file is set at compile-time, but may be overridden -with the -f command line flag. Some sites also have -srm.conf and access.conf files for historical -reasons. In addition, other configuration files may be added using -the Include -directive. Any directive may be placed in any of these configuration -files. Changes to the main configuration files are only recognized by -Apache when it is started or restarted.

- -

-The server also reads a file containing mime document types; the -filename is set by the TypesConfig directive, and is mime.types by default. - -

- -

Syntax of the Configuration Files

- -

Apache configuration files contain one directive per line. The -back-slash "\" may be used as the last character on a line to indicate -that the directive continues onto the next line. There must be no -other characters or white space between the back-slash and the end of -the line. - -

Directives in the configuration files are case-insensitive, but -arguments to directives are often case sensitive. Lines which begin -with the hash character "#" are considered comments, and are ignored. -Comments may not be included on a line after a -configuration directive. Blank lines and white space occurring before -a directive are ignored, so you may indent directives for clarity. - -

You can check your configuration files for syntax errors without -starting the server by using apachectl configtest -or the -t command line option. - -

- -

Modules

- - -
-Related Modules

-mod_so
-		 -Related Directives

-AddModule
-ClearModuleList
-<IfModule>
-LoadModule
-
- -

Apache is a modular server. This implies that only the most basic -functionality is included in the core server. Extended features are -available through modules which -can be loaded into Apache. By default, a base set of modules is -included in the server at compile-time. If the server is compiled to -use dynamically loaded modules, then modules -can be compiled separately and added at any time using the LoadModule directive. -Otherwise, Apache must be recompiled to add or remove modules. -Configuration directives may be included conditional on a presence of -a particular module by enclosing them in an <IfModule> block. - -

To see which modules are currently compiled into the server, -you can use the -l command line option. - -

- -

Scope of Directives

- -
-Related Directives

-<Directory>
-<DirectoryMatch>
-<Files>
-<FilesMatch>
-<Location>
-<LocationMatch>
-<VirtualHost>
-
- -

Directives placed in the main configuration files apply to the entire -server. If you wish to change the configuration for only a part of -the server, you can scope your directives by placing them in -<Directory>, -<DirectoryMatch>, -<Files>, -<FilesMatch>, -<Location>, - and -<LocationMatch> - -sections. These sections limit the application of the directives -which they enclose to particular filesystem locations or URLs. They -can also be nested, allowing for very fine grained configuration. - -

Apache has the capability to serve many different websites -simultaneously. This is called Virtual Hosting. -Directives can also be scoped by placing them inside -<VirtualHost> -sections, so that they will only apply to requests for a particular -website. - -

Although most directives can be placed in any of these sections, -some directives do not make sense in some contexts. For example, -directives controlling process creation can only be placed in the main -server context. To find which directives can be placed in which -sections, check the Context of the directive. -For further information, we provide details on How Directory, Location and Files sections -work. - -

- -

.htaccess Files

- -
-Related Directives

-AccessFileName
-AllowOverride
-
- -

Apache allows for decentralized management of configuration via -special files placed inside the web tree. The special files are -usually called .htaccess, but any name can be specified -in the AccessFileName directive. Directives placed in -.htaccess files apply to the directory where you place -the file, and all sub-directories. The .htaccess files -follow the same syntax as the main configuration files. Since -.htaccess files are read on every request, changes made -in these files take immediate effect. - -

To find which directives can be placed in .htaccess -files, check the Context -of the directive. The server administrator further controls what -directives may be placed in .htaccess files by -configuring the AllowOverride -directive in the main configuration files. - -

- -

Log files

- -

security warning

-Anyone who can write to the directory where Apache is writing a -log file can almost certainly gain access to the uid that the server is -started as, which is normally root. Do NOT give people write -access to the directory the logs are stored in without being aware of -the consequences; see the security tips -document for details. - -

pid file

- -

On startup, Apache saves the process id of the parent httpd process to -the file logs/httpd.pid. This filename can be changed -with the PidFile directive. The -process-id is for use by the administrator in restarting and -terminating the daemon: on Unix, a HUP or USR1 signal causes the -daemon to re-read its configuration files and a TERM signal causes it -to die gracefully; on Windows, use the -k command line option instead. -For more information see the Stopping and -Restarting page. - -

-If the process dies (or is killed) abnormally, then it will be necessary to -kill the children httpd processes. - -

Error log

- -

The server will log error messages to a log file, by default -logs/error_log on Unix or logs/error.log on -Windows and OS/2. The filename can be set using the ErrorLog directive; different error -logs can be set for different virtual hosts. - -

Transfer log

- -

The server will typically log each request to a transfer file, by -default logs/access_log on Unix or -logs/access.log on Windows and OS/2. The filename can be -set using a CustomLog -directive; different transfer logs can be set for different virtual hosts. - - - - - diff --git a/docs/manual/content-negotiation.html.en b/docs/manual/content-negotiation.html.en deleted file mode 100644 index 7bfaee5afa9..00000000000 --- a/docs/manual/content-negotiation.html.en +++ /dev/null @@ -1,588 +0,0 @@ - - - -Apache Content Negotiation - - - - - -

Content Negotiation

- -

-Apache's support for content negotiation has been updated to meet the -HTTP/1.1 specification. It can choose the best representation of a -resource based on the browser-supplied preferences for media type, -languages, character set and encoding. It is also implements a -couple of features to give more intelligent handling of requests from -browsers which send incomplete negotiation information.

- -Content negotiation is provided by the -mod_negotiation module, -which is compiled in by default. - -

- -

About Content Negotiation

- -

-A resource may be available in several different representations. For -example, it might be available in different languages or different -media types, or a combination. One way of selecting the most -appropriate choice is to give the user an index page, and let them -select. However it is often possible for the server to choose -automatically. This works because browsers can send as part of each -request information about what representations they prefer. For -example, a browser could indicate that it would like to see -information in French, if possible, else English will do. Browsers -indicate their preferences by headers in the request. To request only -French representations, the browser would send - -

-  Accept-Language: fr
-
- -

-Note that this preference will only be applied when there is a choice -of representations and they vary by language. -

- -As an example of a more complex request, this browser has been -configured to accept French and English, but prefer French, and to -accept various media types, preferring HTML over plain text or other -text types, and preferring GIF or JPEG over other media types, but also -allowing any other media type as a last resort: - -

-  Accept-Language: fr; q=1.0, en; q=0.5
-  Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6,
-        image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1
-
- -Apache 1.2 supports 'server driven' content negotiation, as defined in -the HTTP/1.1 specification. It fully supports the Accept, -Accept-Language, Accept-Charset and Accept-Encoding request headers. -Apache 1.3.4 also supports 'transparent' content negotiation, which is -an experimental negotiation protocol defined in RFC 2295 and RFC 2296. -It does not offer support for 'feature negotiation' as defined in -these RFCs. -

- -A resource is a conceptual entity identified by a URI -(RFC 2396). An HTTP server like Apache provides access to -representations of the resource(s) within its namespace, -with each representation in the form of a sequence of bytes with a -defined media type, character set, encoding, etc. Each resource may be -associated with zero, one, or more than one representation -at any given time. If multiple representations are available, -the resource is referred to as negotiable and each of its -representations is termed a variant. The ways in which the -variants for a negotiable resource vary are called the -dimensions of negotiation. - -

Negotiation in Apache

- -

-In order to negotiate a resource, the server needs to be given -information about each of the variants. This is done in one of two -ways: - -

- -

Using a type-map file

- -

-A type map is a document which is associated with the handler -named type-map (or, for backwards-compatibility with -older Apache configurations, the mime type -application/x-type-map). Note that to use this feature, -you must have a handler set in the configuration that defines a -file suffix as type-map; this is best done with a - -

-  AddHandler type-map var
-
- -in the server configuration file. See the comments in the sample config -file for more details.

- -Type map files have an entry for each available variant; these entries -consist of contiguous HTTP-format header lines. Entries for -different variants are separated by blank lines. Blank lines are -illegal within an entry. It is conventional to begin a map file with -an entry for the combined entity as a whole (although this -is not required, and if present will be ignored). An example -map file is: - -

-  URI: foo
-
-  URI: foo.en.html
-  Content-type: text/html
-  Content-language: en
-
-  URI: foo.fr.de.html
-  Content-type: text/html;charset=iso-8859-2
-  Content-language: fr, de
-
- -If the variants have different source qualities, that may be indicated -by the "qs" parameter to the media type, as in this picture (available -as jpeg, gif, or ASCII-art): - -
-  URI: foo
-
-  URI: foo.jpeg
-  Content-type: image/jpeg; qs=0.8
-
-  URI: foo.gif
-  Content-type: image/gif; qs=0.5
-
-  URI: foo.txt
-  Content-type: text/plain; qs=0.01
-
-

- -qs values can vary in the range 0.000 to 1.000. Note that any variant with -a qs value of 0.000 will never be chosen. Variants with no 'qs' -parameter value are given a qs factor of 1.0. The qs parameter indicates -the relative 'quality' of this variant compared to the other available -variants, independent of the client's capabilities. For example, a jpeg -file is usually of higher source quality than an ascii file if it is -attempting to represent a photograph. However, if the resource being -represented is an original ascii art, then an ascii representation would -have a higher source quality than a jpeg representation. A qs value -is therefore specific to a given variant depending on the nature of -the resource it represents. - -

-The full list of headers recognized is: - -

-
URI: -
uri of the file containing the variant (of the given media - type, encoded with the given content encoding). These are - interpreted as URLs relative to the map file; they must be on - the same server (!), and they must refer to files to which the - client would be granted access if they were to be requested - directly. -
Content-Type: -
media type --- charset, level and "qs" parameters may be given. These - are often referred to as MIME types; typical media types are - image/gif, text/plain, or - text/html; level=3. -
Content-Language: -
The languages of the variant, specified as an Internet standard - language tag from RFC 1766 (e.g., en for English, - kr for Korean, etc.). -
Content-Encoding: -
If the file is compressed, or otherwise encoded, rather than - containing the actual raw data, this says how that was done. - Apache only recognizes encodings that are defined by an - AddEncoding directive. - This normally includes the encodings x-compress - for compress'd files, and x-gzip for gzip'd files. - The x- prefix is ignored for encoding comparisons. -
Content-Length: -
The size of the file. Specifying content - lengths in the type-map allows the server to compare file sizes - without checking the actual files. -
Description: -
A human-readable textual description of the variant. If Apache cannot - find any appropriate variant to return, it will return an error - response which lists all available variants instead. Such a variant - list will include the human-readable variant descriptions. -
- -

Multiviews

- -

-MultiViews is a per-directory option, meaning it can be set with -an Options directive within a <Directory>, -<Location> or <Files> -section in access.conf, or (if AllowOverride -is properly set) in .htaccess files. Note that -Options All does not set MultiViews; you -have to ask for it by name. - -

-The effect of MultiViews is as follows: if the server -receives a request for /some/dir/foo, if -/some/dir has MultiViews enabled, and -/some/dir/foo does not exist, then the server reads the -directory looking for files named foo.*, and effectively fakes up a -type map which names all those files, assigning them the same media -types and content-encodings it would have if the client had asked for -one of them by name. It then chooses the best match to the client's -requirements. - -

-MultiViews may also apply to searches for the file named by the -DirectoryIndex directive, if the server is trying to -index a directory. If the configuration files specify - -

-  DirectoryIndex index
-
- -then the server will arbitrate between index.html -and index.html3 if both are present. If neither are -present, and index.cgi is there, the server will run it. - -

-If one of the files found when reading the directive is a CGI script, -it's not obvious what should happen. The code gives that case -special treatment --- if the request was a POST, or a GET with -QUERY_ARGS or PATH_INFO, the script is given an extremely high quality -rating, and generally invoked; otherwise it is given an extremely low -quality rating, which generally causes one of the other views (if any) -to be retrieved. - -

The Negotiation Methods

- -After Apache has obtained a list of the variants for a given resource, -either from a type-map file or from the filenames in the directory, it -invokes one of two methods to decide on the 'best' variant to -return, if any. It is not necessary to know any of the details of how -negotiation actually takes place in order to use Apache's content -negotiation features. However the rest of this document explains the -methods used for those interested. -

- -There are two negotiation methods: - -

    - -
  1. Server driven negotiation with the Apache -algorithm is used in the normal case. The Apache algorithm is -explained in more detail below. When this algorithm is used, Apache -can sometimes 'fiddle' the quality factor of a particular dimension to -achieve a better result. The ways Apache can fiddle quality factors is -explained in more detail below. - -
  2. Transparent content negotiation is used when the -browser specifically requests this through the mechanism defined in RFC -2295. This negotiation method gives the browser full control over -deciding on the 'best' variant, the result is therefore dependent on -the specific algorithms used by the browser. As part of the -transparent negotiation process, the browser can ask Apache to run the -'remote variant selection algorithm' defined in RFC 2296. - - -

    Dimensions of Negotiation

    - - - - - - - -
    Dimension -Notes -
    Media Type -Browser indicates preferences with the Accept header field. Each item -can have an associated quality factor. Variant description can also -have a quality factor (the "qs" parameter). -
    Language -Browser indicates preferences with the Accept-Language header field. -Each item can have a quality factor. Variants can be associated with none, one -or more than one language. -
    Encoding -Browser indicates preference with the Accept-Encoding header field. -Each item can have a quality factor. -
    Charset -Browser indicates preference with the Accept-Charset header field. -Each item can have a quality factor. -Variants can indicate a charset as a parameter of the media type. -
    - -

    Apache Negotiation Algorithm

    - -

    -Apache can use the following algorithm to select the 'best' variant -(if any) to return to the browser. This algorithm is not -further configurable. It operates as follows: - -

      -
    1. First, for each dimension of the negotiation, check the appropriate -Accept* header field and assign a quality to each -variant. If the Accept* header for any dimension implies that this -variant is not acceptable, eliminate it. If no variants remain, go -to step 4. - -
    2. Select the 'best' variant by a process of elimination. Each of the -following tests is applied in order. Any variants not selected at each -test are eliminated. After each test, if only one variant remains, -select it as the best match and proceed to step 3. If more than one -variant remains, move on to the next test. - -
        -
      1. Multiply the quality factor from the Accept header with the - quality-of-source factor for this variant's media type, and select - the variants with the highest value. - -
      2. Select the variants with the highest language quality factor. - -
      3. Select the variants with the best language match, using either the - order of languages in the Accept-Language header (if present), or else - else the order of languages in the LanguagePriority - directive (if present). - -
      4. Select the variants with the highest 'level' media parameter - (used to give the version of text/html media types). - -
      5. Select variants with the best charset media parameters, - as given on the Accept-Charset header line. Charset ISO-8859-1 - is acceptable unless explicitly excluded. Variants with a - text/* media type but not explicitly associated - with a particular charset are assumed to be in ISO-8859-1. - -
      6. Select those variants which have associated - charset media parameters that are not ISO-8859-1. - If there are no such variants, select all variants instead. - -
      7. Select the variants with the best encoding. If there are - variants with an encoding that is acceptable to the user-agent, - select only these variants. Otherwise if there is a mix of encoded - and non-encoded variants, select only the unencoded variants. - If either all variants are encoded or all variants are not encoded, - select all variants. - -
      8. Select the variants with the smallest content length. - -
      9. Select the first variant of those remaining. This will be either the - first listed in the type-map file, or when variants are read from - the directory, the one whose file name comes first when sorted using - ASCII code order. - -
      - -
    3. The algorithm has now selected one 'best' variant, so return - it as the response. The HTTP response header Vary is set to indicate the - dimensions of negotiation (browsers and caches can use this - information when caching the resource). End. - -
    4. To get here means no variant was selected (because none are acceptable - to the browser). Return a 406 status (meaning "No acceptable representation") - with a response body consisting of an HTML document listing the - available variants. Also set the HTTP Vary header to indicate the - dimensions of variance. - -
    - -

    Fiddling with Quality Values

    - -

    -Apache sometimes changes the quality values from what would be -expected by a strict interpretation of the Apache negotiation -algorithm above. This is to get a better result from the algorithm for -browsers which do not send full or accurate information. Some of the -most popular browsers send Accept header information which would -otherwise result in the selection of the wrong variant in many -cases. If a browser sends full and correct information these fiddles -will not be applied. -

    - -

    Media Types and Wildcards

    - -

    -The Accept: request header indicates preferences for media types. It -can also include 'wildcard' media types, such as "image/*" or "*/*" -where the * matches any string. So a request including: -

    -  Accept: image/*, */*
-
    - -would indicate that any type starting "image/" is acceptable, -as is any other type (so the first "image/*" is redundant). Some -browsers routinely send wildcards in addition to explicit types they -can handle. For example: -
    -  Accept: text/html, text/plain, image/gif, image/jpeg, */*
-
    - -The intention of this is to indicate that the explicitly -listed types are preferred, but if a different representation is -available, that is ok too. However under the basic algorithm, as given -above, the */* wildcard has exactly equal preference to all the other -types, so they are not being preferred. The browser should really have -sent a request with a lower quality (preference) value for *.*, such -as: -
    -  Accept: text/html, text/plain, image/gif, image/jpeg, */*; q=0.01
-
    - -The explicit types have no quality factor, so they default to a -preference of 1.0 (the highest). The wildcard */* is given -a low preference of 0.01, so other types will only be returned if -no variant matches an explicitly listed type. -

    - -If the Accept: header contains no q factors at all, Apache sets -the q value of "*/*", if present, to 0.01 to emulate the desired -behavior. It also sets the q value of wildcards of the format -"type/*" to 0.02 (so these are preferred over matches against -"*/*". If any media type on the Accept: header contains a q factor, -these special values are not applied, so requests from browsers -which send the correct information to start with work as expected. - -

    Variants with no Language

    - -

    -If some of the variants for a particular resource have a language -attribute, and some do not, those variants with no language -are given a very low language quality factor of 0.001.

    - -The reason for setting this language quality factor for -variant with no language to a very low value is to allow -for a default variant which can be supplied if none of the -other variants match the browser's language preferences. - -For example, consider the situation with three variants: - -

      -
    • foo.en.html, language en -
    • foo.fr.html, language en -
    • foo.html, no language -
    - -

    -The meaning of a variant with no language is that it is -always acceptable to the browser. If the request Accept-Language -header includes either en or fr (or both) one of foo.en.html -or foo.fr.html will be returned. If the browser does not list -either en or fr as acceptable, foo.html will be returned instead. - -

    Extensions to Transparent Content Negotiation

    - -Apache extends the transparent content negotiation protocol (RFC 2295) -as follows. A new {encoding ..} element is used in -variant lists to label variants which are available with a specific -content-encoding only. The implementation of the -RVSA/1.0 algorithm (RFC 2296) is extended to recognize encoded -variants in the list, and to use them as candidate variants whenever -their encodings are acceptable according to the Accept-Encoding -request header. The RVSA/1.0 implementation does not round computed -quality factors to 5 decimal places before choosing the best variant. - -

    Note on hyperlinks and naming conventions

    - -

    -If you are using language negotiation you can choose between -different naming conventions, because files can have more than one -extension, and the order of the extensions is normally irrelevant -(see mod_mime documentation for details). -

    -A typical file has a MIME-type extension (e.g., html), -maybe an encoding extension (e.g., gz), and of course a -language extension (e.g., en) when we have different -language variants of this file. - -

    -Examples: -

      -
    • foo.en.html -
    • foo.html.en -
    • foo.en.html.gz -
    - -

    -Here some more examples of filenames together with valid and invalid -hyperlinks: -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FilenameValid hyperlinkInvalid hyperlink
    foo.html.enfoo
    - foo.html    		-
    foo.en.htmlfoofoo.html
    foo.html.en.gzfoo
    - foo.html    		foo.gz
    - foo.html.gz
    foo.en.html.gzfoofoo.html
    - foo.html.gz
    - foo.gz
    foo.gz.html.enfoo
    - foo.gz
    - foo.gz.html    		foo.html
    foo.html.gz.enfoo
    - foo.html
    - foo.html.gz    		foo.gz
    - -

    -Looking at the table above you will notice that it is always possible to -use the name without any extensions in an hyperlink (e.g., foo). -The advantage is that you can hide the actual type of a -document rsp. file and can change it later, e.g., from html -to shtml or cgi without changing any -hyperlink references. - -

    -If you want to continue to use a MIME-type in your hyperlinks (e.g. -foo.html) the language extension (including an encoding extension -if there is one) must be on the right hand side of the MIME-type extension -(e.g., foo.html.en). - - -

    Note on Caching

    - -

    -When a cache stores a representation, it associates it with the request URL. -The next time that URL is requested, the cache can use the stored -representation. But, if the resource is negotiable at the server, -this might result in only the first requested variant being cached and -subsequent cache hits might return the wrong response. To prevent this, -Apache normally marks all responses that are returned after content negotiation -as non-cacheable by HTTP/1.0 clients. Apache also supports the HTTP/1.1 -protocol features to allow caching of negotiated responses.

    - -For requests which come from a HTTP/1.0 compliant client (either a -browser or a cache), the directive CacheNegotiatedDocs can be -used to allow caching of responses which were subject to negotiation. -This directive can be given in the server config or virtual host, and -takes no arguments. It has no effect on requests from HTTP/1.1 clients. - - - - diff --git a/docs/manual/custom-error.html.en b/docs/manual/custom-error.html.en deleted file mode 100644 index 09604ea972b..00000000000 --- a/docs/manual/custom-error.html.en +++ /dev/null @@ -1,177 +0,0 @@ - - - -Custom error responses - - - - - -

    Custom error responses

    - -
    - -
    Purpose - -
    Additional functionality. Allows webmasters to configure the response of - Apache to some error or problem. - -

    Customizable responses can be defined to be activated in the - event of a server detected error or problem. - -

    e.g. if a script crashes and produces a "500 Server Error" - response, then this response can be replaced with either some - friendlier text or by a redirection to another URL (local or - external). -

    - -

    Old behavior - -
    NCSA httpd 1.3 would return some boring old error/problem message - which would often be meaningless to the user, and would provide no - means of logging the symptoms which caused it.
    - -

    - -

    New behavior - -
    The server can be asked to; -
      -
    1. Display some other text, instead of the NCSA hard coded messages, or -
    2. redirect to a local URL, or -
    3. redirect to an external URL. -
    - -

    Redirecting to another URL can be useful, but only if some information - can be passed which can then be used to explain and/or log the - error/problem - more clearly. - -

    To achieve this, Apache will define new CGI-like environment - variables, e.g. - -

    -REDIRECT_HTTP_ACCEPT=*/*, image/gif, image/x-xbitmap, image/jpeg
    -REDIRECT_HTTP_USER_AGENT=Mozilla/1.1b2 (X11; I; HP-UX A.09.05 9000/712)
    -REDIRECT_PATH=.:/bin:/usr/local/bin:/etc
    -REDIRECT_QUERY_STRING=
    -REDIRECT_REMOTE_ADDR=121.345.78.123
    -REDIRECT_REMOTE_HOST=ooh.ahhh.com
    -REDIRECT_SERVER_NAME=crash.bang.edu
    -REDIRECT_SERVER_PORT=80
    -REDIRECT_SERVER_SOFTWARE=Apache/0.8.15
    -REDIRECT_URL=/cgi-bin/buggy.pl
    -
    - -

    note the REDIRECT_ prefix. - -

    At least REDIRECT_URL and REDIRECT_QUERY_STRING - will - be passed to the new URL (assuming it's a cgi-script or a cgi-include). - The - other variables will exist only if they existed prior to the - error/problem. - None of these will be set if your ErrorDocument is an - external redirect (i.e., anything starting with a - scheme name - like http:, even if it refers to the same host as the - server).

    - -

    Configuration - -
    Use of "ErrorDocument" is enabled for .htaccess files when the - "FileInfo" override is - allowed. - -

    Here are some examples... - -

    -ErrorDocument 500 /cgi-bin/crash-recover
    -ErrorDocument 500 "Sorry, our script crashed. Oh dear
    -ErrorDocument 500 http://xxx/
    -ErrorDocument 404 /Lame_excuses/not_found.html
    -ErrorDocument 401 /Subscription/how_to_subscribe.html -
    - -

    The syntax is, - -

    ErrorDocument -<3-digit-code> action - -

    where the action can be, - -

      -
    1. Text to be displayed. Prefix the text with a quote ("). Whatever - follows the quote is displayed. Note: the (") prefix isn't - displayed. - -
    2. An external URL to redirect to. - -
    3. A local URL to redirect to. - -
    -
    - -

    - -

    Custom error responses and redirects

    - -
    - -
    Purpose - -
    Apache's behavior to redirected URLs has been modified so that additional - environment variables are available to a script/server-include.

    - -

    Old behavior - -
    Standard CGI vars were made available to a script which has been - redirected to. No indication of where the redirection came from was - provided. - -

    - -

    New behavior -
    - -A new batch of environment variables will be initialized for use by a -script which has been redirected to. Each new variable will have the -prefix REDIRECT_. REDIRECT_ environment -variables are created from the CGI environment variables which existed -prior to the redirect, they are renamed with a REDIRECT_ -prefix, i.e., HTTP_USER_AGENT becomes -REDIRECT_HTTP_USER_AGENT. In addition to these new -variables, Apache will define REDIRECT_URL and -REDIRECT_STATUS to help the script trace its origin. -Both the original URL and the URL being redirected to can be logged in -the access log. - -
    -

    -If the ErrorDocument specifies a local redirect to a CGI script, the script -should include a "Status:" header field in its output -in order to ensure the propagation all the way back to the client -of the error condition that caused it to be invoked. For instance, a Perl -ErrorDocument script might include the following: -

    -
    -      :
-    print  "Content-type: text/html\n";
-    printf "Status: %s Condition Intercepted\n", $ENV{"REDIRECT_STATUS"};
-      :
-
    -

    -If the script is dedicated to handling a particular error condition, such as -404 Not Found, it can use the specific code and -error text instead. -

    - - - - diff --git a/docs/manual/developer/API.html b/docs/manual/developer/API.html deleted file mode 100644 index bf0fb77d7a1..00000000000 --- a/docs/manual/developer/API.html +++ /dev/null @@ -1,1153 +0,0 @@ - - -Apache API notes - - - - -

    Apache API notes

    - -These are some notes on the Apache API and the data structures you -have to deal with, etc. They are not yet nearly complete, but -hopefully, they will help you get your bearings. Keep in mind that -the API is still subject to change as we gain experience with it. -(See the TODO file for what might be coming). However, -it will be easy to adapt modules to any changes that are made. -(We have more modules to adapt than you do). -

    - -A few notes on general pedagogical style here. In the interest of -conciseness, all structure declarations here are incomplete --- the -real ones have more slots that I'm not telling you about. For the -most part, these are reserved to one component of the server core or -another, and should be altered by modules with caution. However, in -some cases, they really are things I just haven't gotten around to -yet. Welcome to the bleeding edge.

    - -Finally, here's an outline, to give you some bare idea of what's -coming up, and in what order: - -

    - -

    Basic concepts.

    - -We begin with an overview of the basic concepts behind the -API, and how they are manifested in the code. - -

    Handlers, Modules, and Requests

    - -Apache breaks down request handling into a series of steps, more or -less the same way the Netscape server API does (although this API has -a few more stages than NetSite does, as hooks for stuff I thought -might be useful in the future). These are: - -
      -
    • URI -> Filename translation -
    • Auth ID checking [is the user who they say they are?] -
    • Auth access checking [is the user authorized here?] -
    • Access checking other than auth -
    • Determining MIME type of the object requested -
    • `Fixups' --- there aren't any of these yet, but the phase is - intended as a hook for possible extensions like - SetEnv, which don't really fit well elsewhere. -
    • Actually sending a response back to the client. -
    • Logging the request -
    - -These phases are handled by looking at each of a succession of -modules, looking to see if each of them has a handler for the -phase, and attempting invoking it if so. The handler can typically do -one of three things: - -
      -
    • Handle the request, and indicate that it has done so - by returning the magic constant OK. -
    • Decline to handle the request, by returning the magic - integer constant DECLINED. In this case, the - server behaves in all respects as if the handler simply hadn't - been there. -
    • Signal an error, by returning one of the HTTP error codes. - This terminates normal handling of the request, although an - ErrorDocument may be invoked to try to mop up, and it will be - logged in any case. -
    - -Most phases are terminated by the first module that handles them; -however, for logging, `fixups', and non-access authentication -checking, all handlers always run (barring an error). Also, the -response phase is unique in that modules may declare multiple handlers -for it, via a dispatch table keyed on the MIME type of the requested -object. Modules may declare a response-phase handler which can handle -any request, by giving it the key */* (i.e., a -wildcard MIME type specification). However, wildcard handlers are -only invoked if the server has already tried and failed to find a more -specific response handler for the MIME type of the requested object -(either none existed, or they all declined).

    - -The handlers themselves are functions of one argument (a -request_rec structure. vide infra), which returns an -integer, as above.

    - -

    A brief tour of a module

    - -At this point, we need to explain the structure of a module. Our -candidate will be one of the messier ones, the CGI module --- this -handles both CGI scripts and the ScriptAlias config file -command. It's actually a great deal more complicated than most -modules, but if we're going to have only one example, it might as well -be the one with its fingers in every place.

    - -Let's begin with handlers. In order to handle the CGI scripts, the -module declares a response handler for them. Because of -ScriptAlias, it also has handlers for the name -translation phase (to recognize ScriptAliased URIs), the -type-checking phase (any ScriptAliased request is typed -as a CGI script).

    - -The module needs to maintain some per (virtual) -server information, namely, the ScriptAliases in effect; -the module structure therefore contains pointers to a functions which -builds these structures, and to another which combines two of them (in -case the main server and a virtual server both have -ScriptAliases declared).

    - -Finally, this module contains code to handle the -ScriptAlias command itself. This particular module only -declares one command, but there could be more, so modules have -command tables which declare their commands, and describe -where they are permitted, and how they are to be invoked.

    - -A final note on the declared types of the arguments of some of these -commands: a pool is a pointer to a resource pool -structure; these are used by the server to keep track of the memory -which has been allocated, files opened, etc., either to service a -particular request, or to handle the process of configuring itself. -That way, when the request is over (or, for the configuration pool, -when the server is restarting), the memory can be freed, and the files -closed, en masse, without anyone having to write explicit code to -track them all down and dispose of them. Also, a -cmd_parms structure contains various information about -the config file being read, and other status information, which is -sometimes of use to the function which processes a config-file command -(such as ScriptAlias). - -With no further ado, the module itself: - -

    -/* Declarations of handlers. */
-
-int translate_scriptalias (request_rec *);
-int type_scriptalias (request_rec *);
-int cgi_handler (request_rec *);
-
-/* Subsidiary dispatch table for response-phase handlers, by MIME type */
-
-handler_rec cgi_handlers[] = {
-{ "application/x-httpd-cgi", cgi_handler },
-{ NULL }
-};
-
-/* Declarations of routines to manipulate the module's configuration
- * info.  Note that these are returned, and passed in, as void *'s;
- * the server core keeps track of them, but it doesn't, and can't,
- * know their internal structure.
- */
-
-void *make_cgi_server_config (pool *);
-void *merge_cgi_server_config (pool *, void *, void *);
-
-/* Declarations of routines to handle config-file commands */
-
-extern char *script_alias(cmd_parms *, void *per_dir_config, char *fake,
-                          char *real);
-
-command_rec cgi_cmds[] = {
-{ "ScriptAlias", script_alias, NULL, RSRC_CONF, TAKE2,
-    "a fakename and a realname"},
-{ NULL }
-};
-
-module cgi_module = {
-   STANDARD_MODULE_STUFF,
-   NULL,                     /* initializer */
-   NULL,                     /* dir config creator */
-   NULL,                     /* dir merger --- default is to override */
-   make_cgi_server_config,   /* server config */
-   merge_cgi_server_config,  /* merge server config */
-   cgi_cmds,                 /* command table */
-   cgi_handlers,             /* handlers */
-   translate_scriptalias,    /* filename translation */
-   NULL,                     /* check_user_id */
-   NULL,                     /* check auth */
-   NULL,                     /* check access */
-   type_scriptalias,         /* type_checker */
-   NULL,                     /* fixups */
-   NULL,                     /* logger */
-   NULL                      /* header parser */
-};
-
    - -

    How handlers work

    - -The sole argument to handlers is a request_rec structure. -This structure describes a particular request which has been made to -the server, on behalf of a client. In most cases, each connection to -the client generates only one request_rec structure.

    - -

    A brief tour of the request_rec

    - -The request_rec contains pointers to a resource pool -which will be cleared when the server is finished handling the -request; to structures containing per-server and per-connection -information, and most importantly, information on the request itself.

    - -The most important such information is a small set of character -strings describing attributes of the object being requested, including -its URI, filename, content-type and content-encoding (these being filled -in by the translation and type-check handlers which handle the -request, respectively).

    - -Other commonly used data items are tables giving the MIME headers on -the client's original request, MIME headers to be sent back with the -response (which modules can add to at will), and environment variables -for any subprocesses which are spawned off in the course of servicing -the request. These tables are manipulated using the -ap_table_get and ap_table_set routines.

    -

    - Note that the Content-type header value cannot be - set by module content-handlers using the ap_table_*() - routines. Rather, it is set by pointing the content_type - field in the request_rec structure to an appropriate - string. E.g., - 
    -  r->content_type = "text/html";
-
    -
    -Finally, there are pointers to two data structures which, in turn, -point to per-module configuration structures. Specifically, these -hold pointers to the data structures which the module has built to -describe the way it has been configured to operate in a given -directory (via .htaccess files or -<Directory> sections), for private data it has -built in the course of servicing the request (so modules' handlers for -one phase can pass `notes' to their handlers for other phases). There -is another such configuration vector in the server_rec -data structure pointed to by the request_rec, which -contains per (virtual) server configuration data.

    - -Here is an abridged declaration, giving the fields most commonly used:

    - -

    -struct request_rec {
-
-  pool *pool;
-  conn_rec *connection;
-  server_rec *server;
-
-  /* What object is being requested */
-
-  char *uri;
-  char *filename;
-  char *path_info;
-  char *args;           /* QUERY_ARGS, if any */
-  struct stat finfo;    /* Set by server core;
-                         * st_mode set to zero if no such file */
-
-  char *content_type;
-  char *content_encoding;
-
-  /* MIME header environments, in and out.  Also, an array containing
-   * environment variables to be passed to subprocesses, so people can
-   * write modules to add to that environment.
-   *
-   * The difference between headers_out and err_headers_out is that
-   * the latter are printed even on error, and persist across internal
-   * redirects (so the headers printed for ErrorDocument handlers will
-   * have them).
-   */
-
-  table *headers_in;
-  table *headers_out;
-  table *err_headers_out;
-  table *subprocess_env;
-
-  /* Info about the request itself... */
-
-  int header_only;     /* HEAD request, as opposed to GET */
-  char *protocol;      /* Protocol, as given to us, or HTTP/0.9 */
-  char *method;        /* GET, HEAD, POST, etc. */
-  int method_number;   /* M_GET, M_POST, etc. */
-
-  /* Info for logging */
-
-  char *the_request;
-  int bytes_sent;
-
-  /* A flag which modules can set, to indicate that the data being
-   * returned is volatile, and clients should be told not to cache it.
-   */
-
-  int no_cache;
-
-  /* Various other config info which may change with .htaccess files
-   * These are config vectors, with one void* pointer for each module
-   * (the thing pointed to being the module's business).
-   */
-
-  void *per_dir_config;   /* Options set in config files, etc. */
-  void *request_config;   /* Notes on *this* request */
-
-};
-
-
    - -

    Where request_rec structures come from

    - -Most request_rec structures are built by reading an HTTP -request from a client, and filling in the fields. However, there are -a few exceptions: - -
      -
    • If the request is to an imagemap, a type map (i.e., a - *.var file), or a CGI script which returned a - local `Location:', then the resource which the user requested - is going to be ultimately located by some URI other than what - the client originally supplied. In this case, the server does - an internal redirect, constructing a new - request_rec for the new URI, and processing it - almost exactly as if the client had requested the new URI - directly.

      - -

    • If some handler signaled an error, and an - ErrorDocument is in scope, the same internal - redirect machinery comes into play.

      - -

    • Finally, a handler occasionally needs to investigate `what - would happen if' some other request were run. For instance, - the directory indexing module needs to know what MIME type - would be assigned to a request for each directory entry, in - order to figure out what icon to use.

      - - Such handlers can construct a sub-request, using the - functions ap_sub_req_lookup_file, - ap_sub_req_lookup_uri, and - ap_sub_req_method_uri; these construct a new - request_rec structure and processes it as you - would expect, up to but not including the point of actually - sending a response. (These functions skip over the access - checks if the sub-request is for a file in the same directory - as the original request).

      - - (Server-side includes work by building sub-requests and then - actually invoking the response handler for them, via the - function ap_run_sub_req). -

    - -

    Handling requests, declining, and returning error - codes

    - -As discussed above, each handler, when invoked to handle a particular -request_rec, has to return an int to -indicate what happened. That can either be - -
      -
    • OK --- the request was handled successfully. This may or may - not terminate the phase. -
    • DECLINED --- no erroneous condition exists, but the module - declines to handle the phase; the server tries to find another. -
    • an HTTP error code, which aborts handling of the request. -
    - -Note that if the error code returned is REDIRECT, then -the module should put a Location in the request's -headers_out, to indicate where the client should be -redirected to.

    - -

    Special considerations for response - handlers

    - -Handlers for most phases do their work by simply setting a few fields -in the request_rec structure (or, in the case of access -checkers, simply by returning the correct error code). However, -response handlers have to actually send a request back to the client.

    - -They should begin by sending an HTTP response header, using the -function ap_send_http_header. (You don't have to do -anything special to skip sending the header for HTTP/0.9 requests; the -function figures out on its own that it shouldn't do anything). If -the request is marked header_only, that's all they should -do; they should return after that, without attempting any further -output.

    - -Otherwise, they should produce a request body which responds to the -client as appropriate. The primitives for this are ap_rputc -and ap_rprintf, for internally generated output, and -ap_send_fd, to copy the contents of some FILE * -straight to the client.

    - -At this point, you should more or less understand the following piece -of code, which is the handler which handles GET requests -which have no more specific handler; it also shows how conditional -GETs can be handled, if it's desirable to do so in a -particular response handler --- ap_set_last_modified checks -against the If-modified-since value supplied by the -client, if any, and returns an appropriate code (which will, if -nonzero, be USE_LOCAL_COPY). No similar considerations apply for -ap_set_content_length, but it returns an error code for -symmetry.

    - -

    -int default_handler (request_rec *r)
-{
-    int errstatus;
-    FILE *f;
-
-    if (r->method_number != M_GET) return DECLINED;
-    if (r->finfo.st_mode == 0) return NOT_FOUND;
-
-    if ((errstatus = ap_set_content_length (r, r->finfo.st_size))
-	|| (errstatus = ap_set_last_modified (r, r->finfo.st_mtime)))
-        return errstatus;
-
-    f = fopen (r->filename, "r");
-
-    if (f == NULL) {
-        log_reason("file permissions deny server access",
-                   r->filename, r);
-        return FORBIDDEN;
-    }
-
-    register_timeout ("send", r);
-    ap_send_http_header (r);
-
-    if (!r->header_only) send_fd (f, r);
-    ap_pfclose (r->pool, f);
-    return OK;
-}
-
    - -Finally, if all of this is too much of a challenge, there are a few -ways out of it. First off, as shown above, a response handler which -has not yet produced any output can simply return an error code, in -which case the server will automatically produce an error response. -Secondly, it can punt to some other handler by invoking -ap_internal_redirect, which is how the internal redirection -machinery discussed above is invoked. A response handler which has -internally redirected should always return OK.

    - -(Invoking ap_internal_redirect from handlers which are -not response handlers will lead to serious confusion). - -

    Special considerations for authentication - handlers

    - -Stuff that should be discussed here in detail: - -
      -
    • Authentication-phase handlers not invoked unless auth is - configured for the directory. -
    • Common auth configuration stored in the core per-dir - configuration; it has accessors ap_auth_type, - ap_auth_name, and ap_requires. -
    • Common routines, to handle the protocol end of things, at least - for HTTP basic authentication (ap_get_basic_auth_pw, - which sets the connection->user structure field - automatically, and ap_note_basic_auth_failure, which - arranges for the proper WWW-Authenticate: header - to be sent back). -
    - -

    Special considerations for logging handlers

    - -When a request has internally redirected, there is the question of -what to log. Apache handles this by bundling the entire chain of -redirects into a list of request_rec structures which are -threaded through the r->prev and r->next -pointers. The request_rec which is passed to the logging -handlers in such cases is the one which was originally built for the -initial request from the client; note that the bytes_sent field will -only be correct in the last request in the chain (the one for which a -response was actually sent). - -

    Resource allocation and resource pools

    -

    -One of the problems of writing and designing a server-pool server is -that of preventing leakage, that is, allocating resources (memory, -open files, etc.), without subsequently releasing them. The resource -pool machinery is designed to make it easy to prevent this from -happening, by allowing resource to be allocated in such a way that -they are automatically released when the server is done with -them. -

    -

    -The way this works is as follows: the memory which is allocated, file -opened, etc., to deal with a particular request are tied to a -resource pool which is allocated for the request. The pool -is a data structure which itself tracks the resources in question. -

    -

    -When the request has been processed, the pool is cleared. At -that point, all the memory associated with it is released for reuse, -all files associated with it are closed, and any other clean-up -functions which are associated with the pool are run. When this is -over, we can be confident that all the resource tied to the pool have -been released, and that none of them have leaked. -

    -

    -Server restarts, and allocation of memory and resources for per-server -configuration, are handled in a similar way. There is a -configuration pool, which keeps track of resources which were -allocated while reading the server configuration files, and handling -the commands therein (for instance, the memory that was allocated for -per-server module configuration, log files and other files that were -opened, and so forth). When the server restarts, and has to reread -the configuration files, the configuration pool is cleared, and so the -memory and file descriptors which were taken up by reading them the -last time are made available for reuse. -

    -

    -It should be noted that use of the pool machinery isn't generally -obligatory, except for situations like logging handlers, where you -really need to register cleanups to make sure that the log file gets -closed when the server restarts (this is most easily done by using the -function ap_pfopen, which also -arranges for the underlying file descriptor to be closed before any -child processes, such as for CGI scripts, are execed), or -in case you are using the timeout machinery (which isn't yet even -documented here). However, there are two benefits to using it: -resources allocated to a pool never leak (even if you allocate a -scratch string, and just forget about it); also, for memory -allocation, ap_palloc is generally faster than -malloc. -

    -

    -We begin here by describing how memory is allocated to pools, and then -discuss how other resources are tracked by the resource pool -machinery. -

    -

    Allocation of memory in pools

    -

    -Memory is allocated to pools by calling the function -ap_palloc, which takes two arguments, one being a pointer to -a resource pool structure, and the other being the amount of memory to -allocate (in chars). Within handlers for handling -requests, the most common way of getting a resource pool structure is -by looking at the pool slot of the relevant -request_rec; hence the repeated appearance of the -following idiom in module code: -

    -
    -int my_handler(request_rec *r)
-{
-    struct my_structure *foo;
-    ...
-
-    foo = (foo *)ap_palloc (r->pool, sizeof(my_structure));
-}
-
    -

    -Note that there is no ap_pfree --- -ap_palloced memory is freed only when the associated -resource pool is cleared. This means that ap_palloc does not -have to do as much accounting as malloc(); all it does in -the typical case is to round up the size, bump a pointer, and do a -range check. -

    -

    -(It also raises the possibility that heavy use of ap_palloc -could cause a server process to grow excessively large. There are -two ways to deal with this, which are dealt with below; briefly, you -can use malloc, and try to be sure that all of the memory -gets explicitly freed, or you can allocate a sub-pool of -the main pool, allocate your memory in the sub-pool, and clear it out -periodically. The latter technique is discussed in the section on -sub-pools below, and is used in the directory-indexing code, in order -to avoid excessive storage allocation when listing directories with -thousands of files). -

    -

    Allocating initialized memory

    -

    -There are functions which allocate initialized memory, and are -frequently useful. The function ap_pcalloc has the same -interface as ap_palloc, but clears out the memory it -allocates before it returns it. The function ap_pstrdup -takes a resource pool and a char * as arguments, and -allocates memory for a copy of the string the pointer points to, -returning a pointer to the copy. Finally ap_pstrcat is a -varargs-style function, which takes a pointer to a resource pool, and -at least two char * arguments, the last of which must be -NULL. It allocates enough memory to fit copies of each -of the strings, as a unit; for instance: -

    -
    -     ap_pstrcat (r->pool, "foo", "/", "bar", NULL);
-
    -

    -returns a pointer to 8 bytes worth of memory, initialized to -"foo/bar". -

    -

    Commonly-used pools in the Apache Web server

    -

    -A pool is really defined by its lifetime more than anything else. There -are some static pools in http_main which are passed to various -non-http_main functions as arguments at opportune times. Here they are: -

    -
    -
    permanent_pool -
    -
    -
      -
    • never passed to anything else, this is the ancestor of all pools -
      • -
    -
    -
    pconf -
    -
    -
      -
    • subpool of permanent_pool -
      • -
    • created at the beginning of a config "cycle"; exists until the - server is terminated or restarts; passed to all config-time - routines, either via cmd->pool, or as the "pool *p" argument on - those which don't take pools -
      • -
    • passed to the module init() functions -
      • -
    -
    -
    ptemp -
    -
    -
      -
    • sorry I lie, this pool isn't called this currently in 1.3, I - renamed it this in my pthreads development. I'm referring to - the use of ptrans in the parent... contrast this with the later - definition of ptrans in the child. -
      • -
    • subpool of permanent_pool -
      • -
    • created at the beginning of a config "cycle"; exists until the - end of config parsing; passed to config-time routines via - cmd->temp_pool. Somewhat of a "bastard child" because it isn't - available everywhere. Used for temporary scratch space which - may be needed by some config routines but which is deleted at - the end of config. -
      • -
    -
    -
    pchild -
    -
    -
      -
    • subpool of permanent_pool -
      • -
    • created when a child is spawned (or a thread is created); lives - until that child (thread) is destroyed -
      • -
    • passed to the module child_init functions -
      • -
    • destruction happens right after the child_exit functions are - called... (which may explain why I think child_exit is redundant - and unneeded) -
      • -
    -
    -
    ptrans -
    -
    -
      -
    • should be a subpool of pchild, but currently is a subpool of - permanent_pool, see above -
      • -
    • cleared by the child before going into the accept() loop to receive - a connection -
      • -
    • used as connection->pool -
      • -
    -
    -
    r->pool -
    -
    -
      -
    • for the main request this is a subpool of connection->pool; for - subrequests it is a subpool of the parent request's pool. -
      • -
    • exists until the end of the request (i.e., - ap_destroy_sub_req, or - in child_main after process_request has finished) -
      • -
    • note that r itself is allocated from r->pool; i.e., - r->pool is - first created and then r is the first thing palloc()d from it -
      • -
    -
    -
    -

    -For almost everything folks do, r->pool is the pool to use. But you -can see how other lifetimes, such as pchild, are useful to some -modules... such as modules that need to open a database connection once -per child, and wish to clean it up when the child dies. -

    -

    -You can also see how some bugs have manifested themself, such as setting -connection->user to a value from r->pool -- in this case -connection exists -for the lifetime of ptrans, which is longer than r->pool (especially if -r->pool is a subrequest!). So the correct thing to do is to allocate -from connection->pool. -

    -

    -And there was another interesting bug in mod_include/mod_cgi. You'll see -in those that they do this test to decide if they should use r->pool -or r->main->pool. In this case the resource that they are registering -for cleanup is a child process. If it were registered in r->pool, -then the code would wait() for the child when the subrequest finishes. -With mod_include this could be any old #include, and the delay can be up -to 3 seconds... and happened quite frequently. Instead the subprocess -is registered in r->main->pool which causes it to be cleaned up when -the entire request is done -- i.e., after the output has been sent to -the client and logging has happened. -

    -

    Tracking open files, etc.

    -

    -As indicated above, resource pools are also used to track other sorts -of resources besides memory. The most common are open files. The -routine which is typically used for this is ap_pfopen, which -takes a resource pool and two strings as arguments; the strings are -the same as the typical arguments to fopen, e.g., -

    -
    -     ...
-     FILE *f = ap_pfopen (r->pool, r->filename, "r");
-
-     if (f == NULL) { ... } else { ... }
-
    -

    -There is also a ap_popenf routine, which parallels the -lower-level open system call. Both of these routines -arrange for the file to be closed when the resource pool in question -is cleared. -

    -

    -Unlike the case for memory, there are functions to close -files allocated with ap_pfopen, and ap_popenf, -namely ap_pfclose and ap_pclosef. (This is -because, on many systems, the number of files which a single process -can have open is quite limited). It is important to use these -functions to close files allocated with ap_pfopen and -ap_popenf, since to do otherwise could cause fatal errors on -systems such as Linux, which react badly if the same -FILE* is closed more than once. -

    -

    -(Using the close functions is not mandatory, since the -file will eventually be closed regardless, but you should consider it -in cases where your module is opening, or could open, a lot of files). -

    -

    Other sorts of resources --- cleanup functions

    -
    -More text goes here. Describe the the cleanup primitives in terms of -which the file stuff is implemented; also, spawn_process. -
    -

    -Pool cleanups live until clear_pool() is called: clear_pool(a) recursively -calls destroy_pool() on all subpools of a; then calls all the cleanups for a; -then releases all the memory for a. destroy_pool(a) calls clear_pool(a) -and then releases the pool structure itself. i.e., clear_pool(a) doesn't -delete a, it just frees up all the resources and you can start using it -again immediately. -

    -

    Fine control --- creating and dealing with sub-pools, with a note -on sub-requests

    - -On rare occasions, too-free use of ap_palloc() and the -associated primitives may result in undesirably profligate resource -allocation. You can deal with such a case by creating a -sub-pool, allocating within the sub-pool rather than the main -pool, and clearing or destroying the sub-pool, which releases the -resources which were associated with it. (This really is a -rare situation; the only case in which it comes up in the standard -module set is in case of listing directories, and then only with -very large directories. Unnecessary use of the primitives -discussed here can hair up your code quite a bit, with very little -gain).

    - -The primitive for creating a sub-pool is ap_make_sub_pool, -which takes another pool (the parent pool) as an argument. When the -main pool is cleared, the sub-pool will be destroyed. The sub-pool -may also be cleared or destroyed at any time, by calling the functions -ap_clear_pool and ap_destroy_pool, respectively. -(The difference is that ap_clear_pool frees resources -associated with the pool, while ap_destroy_pool also -deallocates the pool itself. In the former case, you can allocate new -resources within the pool, and clear it again, and so forth; in the -latter case, it is simply gone).

    - -One final note --- sub-requests have their own resource pools, which -are sub-pools of the resource pool for the main request. The polite -way to reclaim the resources associated with a sub request which you -have allocated (using the ap_sub_req_... functions) -is ap_destroy_sub_req, which frees the resource pool. -Before calling this function, be sure to copy anything that you care -about which might be allocated in the sub-request's resource pool into -someplace a little less volatile (for instance, the filename in its -request_rec structure).

    - -(Again, under most circumstances, you shouldn't feel obliged to call -this function; only 2K of memory or so are allocated for a typical sub -request, and it will be freed anyway when the main request pool is -cleared. It is only when you are allocating many, many sub-requests -for a single main request that you should seriously consider the -ap_destroy_... functions). - -

    Configuration, commands and the like

    - -One of the design goals for this server was to maintain external -compatibility with the NCSA 1.3 server --- that is, to read the same -configuration files, to process all the directives therein correctly, -and in general to be a drop-in replacement for NCSA. On the other -hand, another design goal was to move as much of the server's -functionality into modules which have as little as possible to do with -the monolithic server core. The only way to reconcile these goals is -to move the handling of most commands from the central server into the -modules.

    - -However, just giving the modules command tables is not enough to -divorce them completely from the server core. The server has to -remember the commands in order to act on them later. That involves -maintaining data which is private to the modules, and which can be -either per-server, or per-directory. Most things are per-directory, -including in particular access control and authorization information, -but also information on how to determine file types from suffixes, -which can be modified by AddType and -DefaultType directives, and so forth. In general, the -governing philosophy is that anything which can be made -configurable by directory should be; per-server information is -generally used in the standard set of modules for information like -Aliases and Redirects which come into play -before the request is tied to a particular place in the underlying -file system.

    - -Another requirement for emulating the NCSA server is being able to -handle the per-directory configuration files, generally called -.htaccess files, though even in the NCSA server they can -contain directives which have nothing at all to do with access -control. Accordingly, after URI -> filename translation, but before -performing any other phase, the server walks down the directory -hierarchy of the underlying filesystem, following the translated -pathname, to read any .htaccess files which might be -present. The information which is read in then has to be -merged with the applicable information from the server's own -config files (either from the <Directory> sections -in access.conf, or from defaults in -srm.conf, which actually behaves for most purposes almost -exactly like <Directory />).

    - -Finally, after having served a request which involved reading -.htaccess files, we need to discard the storage allocated -for handling them. That is solved the same way it is solved wherever -else similar problems come up, by tying those structures to the -per-transaction resource pool.

    - -

    Per-directory configuration structures

    - -Let's look out how all of this plays out in mod_mime.c, -which defines the file typing handler which emulates the NCSA server's -behavior of determining file types from suffixes. What we'll be -looking at, here, is the code which implements the -AddType and AddEncoding commands. These -commands can appear in .htaccess files, so they must be -handled in the module's private per-directory data, which in fact, -consists of two separate tables for MIME types and -encoding information, and is declared as follows: - -
    -typedef struct {
-    table *forced_types;      /* Additional AddTyped stuff */
-    table *encoding_types;    /* Added with AddEncoding... */
-} mime_dir_config;
-
    - -When the server is reading a configuration file, or -<Directory> section, which includes one of the MIME -module's commands, it needs to create a mime_dir_config -structure, so those commands have something to act on. It does this -by invoking the function it finds in the module's `create per-dir -config slot', with two arguments: the name of the directory to which -this configuration information applies (or NULL for -srm.conf), and a pointer to a resource pool in which the -allocation should happen.

    - -(If we are reading a .htaccess file, that resource pool -is the per-request resource pool for the request; otherwise it is a -resource pool which is used for configuration data, and cleared on -restarts. Either way, it is important for the structure being created -to vanish when the pool is cleared, by registering a cleanup on the -pool if necessary).

    - -For the MIME module, the per-dir config creation function just -ap_pallocs the structure above, and a creates a couple of -tables to fill it. That looks like this: - -

    -void *create_mime_dir_config (pool *p, char *dummy)
-{
-    mime_dir_config *new =
-      (mime_dir_config *) ap_palloc (p, sizeof(mime_dir_config));
-
-    new->forced_types = ap_make_table (p, 4);
-    new->encoding_types = ap_make_table (p, 4);
-
-    return new;
-}
-
    - -Now, suppose we've just read in a .htaccess file. We -already have the per-directory configuration structure for the next -directory up in the hierarchy. If the .htaccess file we -just read in didn't have any AddType or -AddEncoding commands, its per-directory config structure -for the MIME module is still valid, and we can just use it. -Otherwise, we need to merge the two structures somehow.

    - -To do that, the server invokes the module's per-directory config merge -function, if one is present. That function takes three arguments: -the two structures being merged, and a resource pool in which to -allocate the result. For the MIME module, all that needs to be done -is overlay the tables from the new per-directory config structure with -those from the parent: - -

    -void *merge_mime_dir_configs (pool *p, void *parent_dirv, void *subdirv)
-{
-    mime_dir_config *parent_dir = (mime_dir_config *)parent_dirv;
-    mime_dir_config *subdir = (mime_dir_config *)subdirv;
-    mime_dir_config *new =
-      (mime_dir_config *)ap_palloc (p, sizeof(mime_dir_config));
-
-    new->forced_types = ap_overlay_tables (p, subdir->forced_types,
-                                        parent_dir->forced_types);
-    new->encoding_types = ap_overlay_tables (p, subdir->encoding_types,
-                                          parent_dir->encoding_types);
-
-    return new;
-}
-
    - -As a note --- if there is no per-directory merge function present, the -server will just use the subdirectory's configuration info, and ignore -the parent's. For some modules, that works just fine (e.g., for the -includes module, whose per-directory configuration information -consists solely of the state of the XBITHACK), and for -those modules, you can just not declare one, and leave the -corresponding structure slot in the module itself NULL.

    - -

    Command handling

    - -Now that we have these structures, we need to be able to figure out -how to fill them. That involves processing the actual -AddType and AddEncoding commands. To find -commands, the server looks in the module's command table. -That table contains information on how many arguments the commands -take, and in what formats, where it is permitted, and so forth. That -information is sufficient to allow the server to invoke most -command-handling functions with pre-parsed arguments. Without further -ado, let's look at the AddType command handler, which -looks like this (the AddEncoding command looks basically -the same, and won't be shown here): - -
    -char *add_type(cmd_parms *cmd, mime_dir_config *m, char *ct, char *ext)
-{
-    if (*ext == '.') ++ext;
-    ap_table_set (m->forced_types, ext, ct);
-    return NULL;
-}
-
    - -This command handler is unusually simple. As you can see, it takes -four arguments, two of which are pre-parsed arguments, the third being -the per-directory configuration structure for the module in question, -and the fourth being a pointer to a cmd_parms structure. -That structure contains a bunch of arguments which are frequently of -use to some, but not all, commands, including a resource pool (from -which memory can be allocated, and to which cleanups should be tied), -and the (virtual) server being configured, from which the module's -per-server configuration data can be obtained if required.

    - -Another way in which this particular command handler is unusually -simple is that there are no error conditions which it can encounter. -If there were, it could return an error message instead of -NULL; this causes an error to be printed out on the -server's stderr, followed by a quick exit, if it is in -the main config files; for a .htaccess file, the syntax -error is logged in the server error log (along with an indication of -where it came from), and the request is bounced with a server error -response (HTTP error status, code 500).

    - -The MIME module's command table has entries for these commands, which -look like this: - -

    -command_rec mime_cmds[] = {
-{ "AddType", add_type, NULL, OR_FILEINFO, TAKE2,
-    "a mime type followed by a file extension" },
-{ "AddEncoding", add_encoding, NULL, OR_FILEINFO, TAKE2,
-    "an encoding (e.g., gzip), followed by a file extension" },
-{ NULL }
-};
-
    - -The entries in these tables are: - -
      -
    • The name of the command -
    • The function which handles it -
    • a (void *) pointer, which is passed in the - cmd_parms structure to the command handler --- - this is useful in case many similar commands are handled by the - same function. -
    • A bit mask indicating where the command may appear. There are - mask bits corresponding to each AllowOverride - option, and an additional mask bit, RSRC_CONF, - indicating that the command may appear in the server's own - config files, but not in any .htaccess - file. -
    • A flag indicating how many arguments the command handler wants - pre-parsed, and how they should be passed in. - TAKE2 indicates two pre-parsed arguments. Other - options are TAKE1, which indicates one pre-parsed - argument, FLAG, which indicates that the argument - should be On or Off, and is passed in - as a boolean flag, RAW_ARGS, which causes the - server to give the command the raw, unparsed arguments - (everything but the command name itself). There is also - ITERATE, which means that the handler looks the - same as TAKE1, but that if multiple arguments are - present, it should be called multiple times, and finally - ITERATE2, which indicates that the command handler - looks like a TAKE2, but if more arguments are - present, then it should be called multiple times, holding the - first argument constant. -
    • Finally, we have a string which describes the arguments that - should be present. If the arguments in the actual config file - are not as required, this string will be used to help give a - more specific error message. (You can safely leave this - NULL). -
    - -Finally, having set this all up, we have to use it. This is -ultimately done in the module's handlers, specifically for its -file-typing handler, which looks more or less like this; note that the -per-directory configuration structure is extracted from the -request_rec's per-directory configuration vector by using -the ap_get_module_config function. - -
    -int find_ct(request_rec *r)
-{
-    int i;
-    char *fn = ap_pstrdup (r->pool, r->filename);
-    mime_dir_config *conf = (mime_dir_config *)
-             ap_get_module_config(r->per_dir_config, &mime_module);
-    char *type;
-
-    if (S_ISDIR(r->finfo.st_mode)) {
-        r->content_type = DIR_MAGIC_TYPE;
-        return OK;
-    }
-
-    if((i=ap_rind(fn,'.')) < 0) return DECLINED;
-    ++i;
-
-    if ((type = ap_table_get (conf->encoding_types, &fn[i])))
-    {
-        r->content_encoding = type;
-
-        /* go back to previous extension to try to use it as a type */
-
-        fn[i-1] = '\0';
-        if((i=ap_rind(fn,'.')) < 0) return OK;
-        ++i;
-    }
-
-    if ((type = ap_table_get (conf->forced_types, &fn[i])))
-    {
-        r->content_type = type;
-    }
-
-    return OK;
-}
-
-
    - -

    Side notes --- per-server configuration, virtual - servers, etc.

    - -The basic ideas behind per-server module configuration are basically -the same as those for per-directory configuration; there is a creation -function and a merge function, the latter being invoked where a -virtual server has partially overridden the base server configuration, -and a combined structure must be computed. (As with per-directory -configuration, the default if no merge function is specified, and a -module is configured in some virtual server, is that the base -configuration is simply ignored).

    - -The only substantial difference is that when a command needs to -configure the per-server private module data, it needs to go to the -cmd_parms data to get at it. Here's an example, from the -alias module, which also indicates how a syntax error can be returned -(note that the per-directory configuration argument to the command -handler is declared as a dummy, since the module doesn't actually have -per-directory config data): - -

    -char *add_redirect(cmd_parms *cmd, void *dummy, char *f, char *url)
-{
-    server_rec *s = cmd->server;
-    alias_server_conf *conf = (alias_server_conf *)
-            ap_get_module_config(s->module_config,&alias_module);
-    alias_entry *new = ap_push_array (conf->redirects);
-
-    if (!ap_is_url (url)) return "Redirect to non-URL";
-
-    new->fake = f; new->real = url;
-    return NULL;
-}
-
    - - diff --git a/docs/manual/developer/modules.html.en b/docs/manual/developer/modules.html.en deleted file mode 100644 index b066223466f..00000000000 --- a/docs/manual/developer/modules.html.en +++ /dev/null @@ -1,200 +0,0 @@ - - - -Converting Modules from Apache 1.3 to Apache 2.0 - - - - - -

    From Apache 1.3 to Apache 2.0
    Modules

    - -

    -This is a first attempt at writing the lessons I learned when trying to convert the mod_mmap_static module to Apache 2.0. It's by no means definitive and probably won't even be correct in some ways, but it's a start. -

    -
    -

    The easier changes... -

    - -

    Cleanup Routines

    -

    -These now need to be of type ap_status_t and return a value of that type. Normally the return value will be APR_SUCCESS unless there is some need to signal an error in the cleanup. Be aware that even though you signal an error not all code yet checks and acts upon the error. -

    - -

    Initialisation Routines

    - -

    -These should now be renamed to better signify where they sit in the overall process. So the name gets a small change from mmap_init to mmap_post_config. The arguments passed have undergone a radical change and now look like -

    -
      -
    • ap_context_t *p,
      • -
    • ap_context_t *plog,
      • -
    • ap_context_t *ptemp,
      • -
    • server_rec *s
      • -
    -

    -Throughout Apache the old pools have been replced by the ap_context_t, though their use remains remarkably similar. -

    - -

    Data Types

    -

    -A lot of the data types have been moved into the APR. This means that some have had a name change, such as the one shown above. The following is a brief list of some of the changes that you are likely to have to make. -

      -
    • pool becomes ap_context_t
      • -
    • table becomes ap_table_t
      • -
    -
    - -

    -The messier changes... -

    -

    Register Hooks

    -

    -The new architecture uses a series of hooks to provide for calling your functions. These you'll need to add to your module by way of a new function, static void register_hooks(void). The function is really reasonably straightforward once you understand what needs to be done. Each function that needs calling at some stage in the processing of a request needs to be registered, handlers do not. There are a number of phases where functions can be added, and for each you can specify with a high degree of control the relative order that the function will be called in. -

    -

    -This is the code that was added to mod_mmap_static -

    -
    -static void register_hooks(void)
-{
-    static const char * const aszPre[]={ "http_core.c",NULL };
-    ap_hook_post_config(mmap_post_config,NULL,NULL,HOOK_MIDDLE);
-    ap_hook_translate_name(mmap_static_xlat,aszPre,NULL,HOOK_LAST);
-};
-
    -

    -This registers 2 functions that need to be called, one in the post_config stage (virtually every module will need this one) and one for the translate_name phase. note that while there are different function names the format of each is identical. So what is the format? -

    -

    -ap_hook_[phase_name](function_name, predecessors, successors, position); -

    -

    -There are 3 hook positions defined... -

    -
      -
    • HOOK_FIRST
      • -
    • HOOK_MIDDLE
      • -
    • HOOK_LAST
      • -
    -

    -To define the position you use the position and then modify it with the predecessors and successors. each of the modifiers can be a list of functions that should be called, either before the function is run (predecessors) or after the function has run (successors). -

    -

    -In the mod_mmap_static case I didn't care about the post_config stage, but the mmap_static_xlat MUST be called after the core module had done it's name translation, hence the use of the aszPre to define a modifier to the position HOOK_LAST. -

    -

    Module Definition

    - -

    -There are now a lot fewer stages to worry about when creating your module definition. The old defintion looked like -

    -
    -module MODULE_VAR_EXPORT [module_name]_module =
-{
-    STANDARD_MODULE_STUFF,
-    /* initializer */
-    /* dir config creater */
-    /* dir merger --- default is to override */
-    /* server config */
-    /* merge server config */
-    /* command handlers */
-    /* handlers */
-    /* filename translation */
-    /* check_user_id */
-    /* check auth */
-    /* check access */
-    /* type_checker */
-    /* fixups */
-    /* logger */
-    /* header parser */
-    /* child_init */
-    /* child_exit */
-    /* post read-request */
-};
-
    -

    -The new structure is a great deal simpler... -

    -
    -module MODULE_VAR_EXPORT [module_name]_module =
-{
-    STANDARD20_MODULE_STUFF,
-    /* create per-directory config structures */
-    /* merge per-directory config structures  */
-    /* create per-server config structures    */
-    /* merge per-server config structures     */
-    /* command handlers */
-    /* handlers */
-    /* register hooks */
- };
-
    -

    -Some of these read directly across, some don't. I'll try to summarise what should be done below. -

    -

    -The stages that read directly across : -

    -
      -
    • -/* dir config creater */ ==> /* create per-directory config structures */ -
      • -
    • -/* server config */ ==> /* create per-server config structures */ -
      • -
    • -/* dir merger */ ==> /* merge per-directory config structures */ -
      • -
    • -/* merge server config */ ==> /* merge per-server config structures */ -
      • -
    • -/* command table */ ==> /* command ap_table_t */ -
      • -
    • -/* handlers */ ==> /* handlers */ -
      • -
    -

    -The remainder of the old functions should be registered as hooks. There are the following hook stages defined so far... -

    - -
      -
    • -ap_hook_post_config (this is where the old _init routines get registered) -
      • -
    • -ap_hook_http_method -
      • -
    • -ap_hook_open_logs -
      • -
    • -ap_hook_auth_checker -
      • -
    • -ap_hook_default_port -
      • -
    • -ap_hook_access_checker -
      • -
    • -ap_hook_process_connection -
      • -
    • -ap_hook_child_init_hook -
      • - - - - - - - - - diff --git a/docs/manual/dso.html.en b/docs/manual/dso.html.en deleted file mode 100644 index 66e6fc98412..00000000000 --- a/docs/manual/dso.html.en +++ /dev/null @@ -1,393 +0,0 @@ - - -Apache 1.3 Dynamic Shared Object (DSO) support - - - - -
      - - -
      - -

      -Apache 1.3
      -Dynamic Shared Object (DSO)
      -Support -

      - -
      Originally written by
      -Ralf S. Engelschall <rse@apache.org>, April 1998
      - -
      - -

      Background

      - -

      On modern Unix derivatives there exists a nifty mechanism usually called -dynamic linking/loading of Dynamic Shared Objects (DSO) which -provides a way to build a piece of program code in a special format for -loading it at run-time into the address space of an executable program. - -

      This loading can usually be done in two ways: Automatically by a system -program called ld.so when an executable program is started or -manually from within the executing program via a programmatic system interface -to the Unix loader through the system calls dlopen()/dlsym(). - -

      In the first way the DSO's are usually called shared libraries or -DSO libraries and named libfoo.so or -libfoo.so.1.2. They reside in a system directory (usually -/usr/lib) and the link to the executable program is established -at build-time by specifying -lfoo to the linker command. This -hard-codes library references into the executable program file so that at -start-time the Unix loader is able to locate libfoo.so in -/usr/lib, in paths hard-coded via linker-options like --R or in paths configured via the environment variable -LD_LIBRARY_PATH. It then resolves any (yet unresolved) symbols in -the executable program which are available in the DSO. - -

      Symbols in the executable program are usually not referenced by the DSO -(because it's a reusable library of general code) and hence no further -resolving has to be done. The executable program has no need to do anything on -its own to use the symbols from the DSO because the complete resolving is done -by the Unix loader. (In fact, the code to invoke ld.so is part of -the run-time startup code which is linked into every executable program which -has been bound non-static). The advantage of dynamic loading of common library -code is obvious: the library code needs to be stored only once, in a system -library like libc.so, saving disk space for every program. - -

      In the second way the DSO's are usually called shared objects or -DSO files and can be named with an arbitrary extension (although the -canonical name is foo.so). These files usually stay inside a -program-specific directory and there is no automatically established link to -the executable program where they are used. Instead the executable program -manually loads the DSO at run-time into its address space via -dlopen(). At this time no resolving of symbols from the DSO for -the executable program is done. But instead the Unix loader automatically -resolves any (yet unresolved) symbols in the DSO from the set of symbols -exported by the executable program and its already loaded DSO libraries -(especially all symbols from the ubiquitous libc.so). This way -the DSO gets knowledge of the executable program's symbol set as if it had -been statically linked with it in the first place. - -

      Finally, to take advantage of the DSO's API the executable program has to -resolve particular symbols from the DSO via dlsym() for later use -inside dispatch tables etc. In other words: The executable program has to -manually resolve every symbol it needs to be able to use it. The advantage of -such a mechanism is that optional program parts need not be loaded (and thus -do not spend memory) until they are needed by the program in question. When -required, these program parts can be loaded dynamically to extend the base -program's functionality. - -

      Although this DSO mechanism sounds straightforward there is at least one -difficult step here: The resolving of symbols from the executable program for -the DSO when using a DSO to extend a program (the second way). Why? Because -"reverse resolving" DSO symbols from the executable program's symbol set is -against the library design (where the library has no knowledge about the -programs it is used by) and is neither available under all platforms nor -standardized. In practice the executable program's global symbols are often -not re-exported and thus not available for use in a DSO. Finding a way to -force the linker to export all global symbols is the main problem one has to -solve when using DSO for extending a program at run-time. - -

      Practical Usage

      - -

      The shared library approach is the typical one, because it is what the DSO -mechanism was designed for, hence it is used for nearly all types of libraries -the operating system provides. On the other hand using shared objects for -extending a program is not used by a lot of programs. - -

      As of 1998 there are only a few software packages available which use the -DSO mechanism to actually extend their functionality at run-time: Perl 5 (via -its XS mechanism and the DynaLoader module), Netscape Server, etc. Starting -with version 1.3, Apache joined the crew, because Apache already uses a module -concept to extend its functionality and internally uses a dispatch-list-based -approach to link external modules into the Apache core functionality. So, -Apache is really predestined for using DSO to load its modules at run-time. - -

      As of Apache 1.3, the configuration system supports two optional features -for taking advantage of the modular DSO approach: compilation of the Apache -core program into a DSO library for shared usage and compilation of the -Apache modules into DSO files for explicit loading at run-time. - -

      Implementation

      - -

      The DSO support for loading individual Apache modules is based on a module -named mod_so.c which has to be -statically compiled into the Apache core. It is the only module besides -http_core.c which cannot be put into a DSO itself -(bootstrapping!). Practically all other distributed Apache modules then can -then be placed into a DSO by individually enabling the DSO build for them via -configure's --enable-shared option (see top-level -INSTALL file) or by changing the AddModule command -in your src/Configuration into a SharedModule -command (see src/INSTALL file). After a module is compiled into -a DSO named mod_foo.so you can use mod_so's LoadModule command in your -httpd.conf file to load this module at server startup or restart. - -

      To simplify this creation of DSO files for Apache modules (especially for -third-party modules) a new support program named apxs (APache -eXtenSion) is available. It can be used to build DSO based modules -outside of the Apache source tree. The idea is simple: When -installing Apache the configure's make install -procedure installs the Apache C header files and puts the platform-dependent -compiler and linker flags for building DSO files into the apxs -program. This way the user can use apxs to compile his Apache -module sources without the Apache distribution source tree and without having -to fiddle with the platform-dependent compiler and linker flags for DSO -support. - -

      To place the complete Apache core program into a DSO library (only required -on some of the supported platforms to force the linker to export the apache -core symbols -- a prerequisite for the DSO modularization) the rule -SHARED_CORE has to be enabled via configure's ---enable-rule=SHARED_CORE option (see top-level -INSTALL file) or by changing the Rule command in -your Configuration file to Rule SHARED_CORE=yes (see -src/INSTALL file). The Apache core code is then placed into a DSO -library named libhttpd.so. Because one cannot link a DSO against -static libraries on all platforms, an additional executable program named -libhttpd.ep is created which both binds this static code and -provides a stub for the main() function. Finally the -httpd executable program itself is replaced by a bootstrapping -code which automatically makes sure the Unix loader is able to load and start -libhttpd.ep by providing the LD_LIBRARY_PATH to -libhttpd.so. - -

      Supported Platforms

      - -

      Apache's src/Configure script currently has only limited but -adequate built-in knowledge on how to compile DSO files, because as already -mentioned this is heavily platform-dependent. Nevertheless all major Unix -platforms are supported. The definitive current state (May 1999) is this: - -

      -

        -
      • Out-of-the-box supported platforms:
        -(actually tested versions in parenthesis) - -
        -o  FreeBSD            (2.1.5, 2.2.x, 3.x, 4.x)
-o  OpenBSD            (2.x)
-o  NetBSD             (1.3.1)
-o  BSDI               (3.x, 4.x)
-o  Linux              (Debian/1.3.1, RedHat/4.2)
-o  Solaris            (2.4, 2.5, 2.6, 2.7)
-o  SunOS              (4.1.3)
-o  Digital UNIX       (4.0)
-o  IRIX               (5.3, 6.2)
-o  HP/UX              (10.20)
-o  UnixWare           (2.01, 2.1.2)
-o  SCO                (5.0.4)
-o  AIX                (3.2, 4.1.5, 4.2, 4.3)
-o  ReliantUNIX/SINIX  (5.43)
-o  SVR4               (-)
-o  Mac OS X Server    (1.0)
-o  Mac OS             (10.0 preview 1)
-o  OpenStep/Mach      (4.2)
-o  DGUX               (??)
-o  NetWare            (5.1)
-
        - -

        -

      • Explicitly unsupported platforms: - -
        -o  Ultrix             (no dlopen-style interface under this platform)
-
        - -
      - -

      Usage Summary

      - -

      To give you an overview of the DSO features of Apache 1.3, here is a short -and concise summary: - -

        - -
      1. Placing the Apache core code (all the stuff which usually forms the -httpd binary) into a DSO libhttpd.so, an executable -program libhttpd.ep and a bootstrapping executable program -httpd (Notice: this is only required on some of the supported -platforms to force the linker to export the Apache core symbols, which in turn -is a prerequisite for the DSO modularization): - -

        -

          -
        • Build and install via configure (preferred): -
          -
          -$ ./configure --prefix=/path/to/install
-              --enable-rule=SHARED_CORE ...
-$ make install
-
          -
          - -
        • Build and install manually: -
          -
          -- Edit src/Configuration:
-  << Rule SHARED_CORE=default
-  >> Rule SHARED_CORE=yes
-  << EXTRA_CFLAGS= 
-  >> EXTRA_CFLAGS= -DSHARED_CORE_DIR=\"/path/to/install/libexec\"
-$ make 
-$ cp src/libhttpd.so* /path/to/install/libexec/
-$ cp src/libhttpd.ep  /path/to/install/libexec/
-$ cp src/httpd        /path/to/install/bin/
-
          -
          -
        - -
      2. Build and install a distributed Apache module, say -mod_foo.c, into its own DSO mod_foo.so: - -

        -

          -
        • Build and install via configure (preferred): -
          -
          -$ ./configure --prefix=/path/to/install
-        --enable-shared=foo
-$ make install
-
          -
          - -
        • Build and install manually: -
          -
          -- Edit src/Configuration:
-  << AddModule    modules/xxxx/mod_foo.o
-  >> SharedModule modules/xxxx/mod_foo.so
-$ make
-$ cp src/xxxx/mod_foo.so /path/to/install/libexec
-- Edit /path/to/install/etc/httpd.conf
-  >> LoadModule foo_module /path/to/install/libexec/mod_foo.so
-
          -
          -
        - -
      3. Build and install a third-party Apache module, say -mod_foo.c, into its own DSO mod_foo.so - -

        -

          -
        • Build and install via configure (preferred): -
          -
          -$ ./configure --add-module=/path/to/3rdparty/mod_foo.c 
-        --enable-shared=foo
-$ make install
-
          -
          - -
        • Build and install manually: -
          -
          -$ cp /path/to/3rdparty/mod_foo.c /path/to/apache-1.3/src/modules/extra/
-- Edit src/Configuration:
-  >> SharedModule modules/extra/mod_foo.so
-$ make
-$ cp src/xxxx/mod_foo.so /path/to/install/libexec
-- Edit /path/to/install/etc/httpd.conf
-  >> LoadModule foo_module /path/to/install/libexec/mod_foo.so
-
          -
          -
        - -

        -

      4. Build and install a third-party Apache module, say -mod_foo.c, into its own DSO mod_foo.so outside -of the Apache source tree: - -

        -

          -
        • Build and install via apxs: -
          -
          -$ cd /path/to/3rdparty
-$ apxs -c mod_foo.c
-$ apxs -i -a -n foo mod_foo.so
-
          -
          -
        - -
      - -

      Advantages & Disadvantages

      - -

      The above DSO based features of Apache 1.3 have the following advantages: - -

        -
      • The server package is more flexible at run-time because the actual server - process can be assembled at run-time via LoadModule - httpd.conf configuration commands instead of - Configuration AddModule commands at build-time. - For instance this way one is able to run different server instances - (standard & SSL version, minimalistic & powered up version - [mod_perl, PHP3], etc.) with only one Apache installation. -

        -

      • The server package can be easily extended with third-party modules even - after installation. This is at least a great benefit for vendor package - maintainers who can create a Apache core package and additional packages - containing extensions like PHP3, mod_perl, mod_fastcgi, etc. -

        -

      • Easier Apache module prototyping because with the DSO/apxs - pair you can both work outside the Apache source tree and only need an - apxs -i command followed by an apachectl - restart to bring a new version of your currently developed module - into the running Apache server. -
      - -

      DSO has the following disadvantages: - -

        -
      • The DSO mechanism cannot be used on every platform because not all - operating systems support dynamic loading of code into the address space - of a program. -

        -

      • The server is approximately 20% slower at startup time because of the - symbol resolving overhead the Unix loader now has to do. -

        -

      • The server is approximately 5% slower at execution time under some - platforms because position independent code (PIC) sometimes needs - complicated assembler tricks for relative addressing which are not - necessarily as fast as absolute addressing. -

        -

      • Because DSO modules cannot be linked against other DSO-based libraries - (ld -lfoo) on all platforms (for instance a.out-based - platforms usually don't provide this functionality while ELF-based - platforms do) you cannot use the DSO mechanism for all types of modules. - Or in other words, modules compiled as DSO files are restricted to only - use symbols from the Apache core, from the C library (libc) - and all other dynamic or static libraries used by the Apache core, or - from static library archives (libfoo.a) containing position - independent code. The only chances to use other code is to either make - sure the Apache core itself already contains a reference to it, loading - the code yourself via dlopen() or enabling the - SHARED_CHAIN rule while building Apache when your platform - supports linking DSO files against DSO libraries. -

        -

      • Under some platforms (many SVR4 systems) there is no way to force the - linker to export all global symbols for use in DSO's when linking the - Apache httpd executable program. But without the visibility of the Apache - core symbols no standard Apache module could be used as a DSO. The only - chance here is to use the SHARED_CORE feature because this - way the global symbols are forced to be exported. As a consequence the - Apache src/Configure script automatically enforces - SHARED_CORE on these platforms when DSO features are used in - the Configuration file or on the configure command line. -
      - - -
      - - diff --git a/docs/manual/handler.html.en b/docs/manual/handler.html.en deleted file mode 100644 index 1dbad4256ea..00000000000 --- a/docs/manual/handler.html.en +++ /dev/null @@ -1,156 +0,0 @@ - - - -Apache's Handler Use - - - - - -

      Apache's Handler Use

      - - - -
      -

      What is a Handler

      - - - - -
      -Related Modules

      - -mod_actions
      -mod_asis
      -mod_cgi
      -mod_imap
      -mod_info
      -mod_include
      -mod_mime
      -mod_negotiation
      -mod_status
      -      		 -Related Directives

      - -Action
      -AddHandler
      -RemoveHandler
      -SetHandler
      -
      - - -

      A "handler" is an internal Apache representation of the action to be -performed when a file is called. Generally, files have implicit -handlers, based on the file type. Normally, all files are simply -served by the server, but certain file types are "handled" -separately.

      - -

      Apache 1.1 adds the ability to use handlers explicitly. Based on -either filename extensions or on location, handlers can be specified -without relation to file type. This is advantageous both because it is -a more elegant solution, and because it also allows for both a type -and a handler to be associated with a file. (See also -Files with Multiple -Extensions.)

      - -

      Handlers can either be built into the server or included in a module, -or they can be added with the Action directive. The built-in -handlers in the standard distribution are as follows:

      - -
        -
      • default-handler: - Send the file using the default_handler(), which is the - handler used by default to handle static content. - (core) -
      • send-as-is: - Send file with HTTP headers as is. - (mod_asis) -
      • cgi-script: - Treat the file as a CGI script. - (mod_cgi) -
      • imap-file: - Parse as an imagemap rule file. - (mod_imap) -
      • server-info: - Get the server's configuration information. - (mod_info) -
      • server-parsed: - Parse for server-side includes. - (mod_include) -
      • server-status: - Get the server's status report. - (mod_status) -
      • type-map: - Parse as a type map file for content negotiation. - (mod_negotiation) -
      - -
      - -

      Examples

      - -

      Modifying static content using a CGI script

      - -

      The following directives will cause requests for files with the -html extension to trigger the launch of the -footer.pl CGI script.

      - -
      -     Action add-footer /cgi-bin/footer.pl
-     AddHandler add-footer html
-
      - -

      Then the CGI script is responsible for sending the originally -requested document (pointed to by the PATH_TRANSLATED -environment variable) and making whatever modifications or additions -are desired.

      - -

      Files with HTTP headers

      - -

      The following directives will enable the send-as-is -handler, which is used for files which contain their own HTTP headers. -All files in the /web/htdocs/asis/ directory will be -processed by the send-as-is handler, regardless of their -filename extensions.

      - -
      -    <Directory /web/htdocs/asis>
-    SetHandler send-as-is
-    </Directory>
-
      - -
      - -

      Programmer's Note

      - -

      In order to implement the handler features, an addition has been -made to the Apache API that you may wish to -make use of. Specifically, a new record has been added to the -request_rec structure:

      -
      -    char *handler
-
      -

      If you wish to have your module engage a handler, you need only to -set r->handler to the name of the handler at any time -prior to the invoke_handler stage of the -request. Handlers are implemented as they were before, albeit using -the handler name instead of a content type. While it is not -necessary, the naming convention for handlers is to use a -dash-separated word, with no slashes, so as to not invade the media -type name-space.

      - - - - - diff --git a/docs/manual/index.html.en b/docs/manual/index.html.en deleted file mode 100644 index 6c1525fa4bd..00000000000 --- a/docs/manual/index.html.en +++ /dev/null @@ -1,174 +0,0 @@ - - -Apache HTTP Server Version 2.0 Documentation - - -
      - - - - - - - - - - - - -
      - [Apache Documentation]
      - - - - - - -
      - FAQ - - Directives - - Modules - - Search -
      -
       
      -

      Apache HTTP Server Version 2.0

      -
      -
      - -
      - - -
      -
      - - - - -
      -
      - - - - - - - - - -
      - - -
      - Release Notes -
      -New Features in Version 2.0 -
      -Upgrading to Version 2.0 -
      -Apache License -
      - -

      - -
      -Reference Manual -
      -Compiling and Installing -
      -Starting -
      -Stopping or Restarting -
      -Run-time Configuration Directives -
      -Modules: By Type or - Alphabetical -
      -Dynamic Shared Object (DSO) Support -
      -The Apache API -
      - -

      - -
      -Platform Specific Notes -
      -Microsoft Windows -
      -Novell Netware 5 -
      -HP MPE/iX -
      -UnixWare -
      -TPF -
      - -

      		 -
      .
      -      		 - -
      -Using the Apache HTTP Server -
      -Configuration Files -
      -Server-Wide Configuration -
      -Virtual Hosts -
      -Handlers -
      -Content negotiation -
      -Environment Variables -
      -Using SetUserID Execution for CGI -
      -General Performance hints -
      -Security tips -
      -URL Rewriting Guide -
      - -

      - -
      -Other Topics -
      -Frequently Asked Questions -
      -Tutorials -
      -Documentation for Developers -
      -Other Notes -
      -

      - -
      - - - - - diff --git a/docs/manual/install.html.en b/docs/manual/install.html.en deleted file mode 100644 index b8f5047e002..00000000000 --- a/docs/manual/install.html.en +++ /dev/null @@ -1,270 +0,0 @@ - - - -Compiling and Installing Apache - - - - - - -

      Compiling and Installing Apache 1.3

      - -This document covers compilation and installation of Apache on Unix -systems only. For compiling and installation on Windows, see Using Apache with Microsoft Windows and for -TPF see Installing the Apache 1.3 HTTP -Server on TPF. - -

      - -UnixWare users will want to consult build notes -for various UnixWare versions before compiling. - -

      Downloading Apache

      - -Information on the latest version of Apache can be found on the Apache -web server at http://www.apache.org/. This will -list the current release, any more recent beta-test release, together -with details of mirror web and anonymous ftp sites. - -

      - -If you downloaded a binary distribution, skip to Installing Apache. Otherwise read the next section -for how to compile the server. - -

      Compiling Apache

      - -Compiling Apache consists of three steps: Firstly select which Apache -modules you want to include into the server. Secondly create a -configuration for your operating system. Thirdly compile the -executable. -

      - -All configuration of Apache is performed in the src -directory of the Apache distribution. Change into this directory. - -

        -
      1. - Select modules to compile into Apache in the - Configuration file. Uncomment lines corresponding to - those optional modules you wish to include (among the AddModule lines - at the bottom of the file), or add new lines corresponding to - additional modules you have downloaded or written. (See API.html for preliminary docs on how to - write Apache modules). Advanced users can comment out some of the - default modules if they are sure they will not need them (be careful - though, since many of the default modules are vital for the correct - operation and security of the server). -

        - - You should also read the instructions in the Configuration - file to see if you need to set any of the Rule lines. - - -

      2. - Configure Apache for your operating system. Normally you can just - type run the Configure script as given below. However - if this fails or you have any special requirements (e.g., to include - an additional library required by an optional module) you might need - to edit one or more of the following options in the - Configuration file: - EXTRA_CFLAGS, LIBS, LDFLAGS, INCLUDES. -

        - - Run the Configure script: -

        - 
        -    % Configure
-    Using 'Configuration' as config file
-     + configured for <whatever> platform
-     + setting C compiler to <whatever> *
-     + setting C compiler optimization-level to <whatever> *
-     + Adding selected modules
-     + doing sanity check on compiler and options
-    Creating Makefile in support
-    Creating Makefile in main
-    Creating Makefile in os/unix
-    Creating Makefile in modules/standard
-
        -
        - - (*: Depending on Configuration and your system, Configure - might not print these lines. That's OK).

        - - This generates a Makefile for use in stage 3. It also creates a - Makefile in the support directory, for compilation of the optional - support programs. -

        - - (If you want to maintain multiple configurations, you can give a - option to Configure to tell it to read an alternative - Configuration file, such as Configure -file - Configuration.ai). -

        - -

      3. - Type make. -
      - -The modules we place in the Apache distribution are the ones we have -tested and are used regularly by various members of the Apache -development group. Additional modules contributed by members or third -parties with specific needs or functions are available at -<http://www.apache.org/dist/contrib/modules/>. -There are instructions on that page for linking these modules into the -core Apache code. - -

      Installing Apache

      - -You will have a binary file called httpd in the -src directory. A binary distribution of Apache will -supply this file.

      - -The next step is to install the program and configure it. Apache is -designed to be configured and run from the same set of directories -where it is compiled. If you want to run it from somewhere else, make -a directory and copy the conf, logs and -icons directories into it. In either case you should -read the security tips -describing how to set the permissions on the server root directory.

      - -The next step is to edit the configuration files for the server. This -consists of setting up various directives in up to three -central configuration files. By default, these files are located in -the conf directory and are called srm.conf, -access.conf and httpd.conf. To help you get -started there are same files in the conf directory of the -distribution, called srm.conf-dist, -access.conf-dist and httpd.conf-dist. Copy -or rename these files to the names without the -dist. -Then edit each of the files. Read the comments in each file carefully. -Failure to setup these files correctly could lead to your server not -working or being insecure. You should also have an additional file in -the conf directory called mime.types. This -file usually does not need editing. - -

      - -First edit httpd.conf. This sets up general attributes -about the server: the port number, the user it runs as, etc. Next -edit the srm.conf file; this sets up the root of the -document tree, special functions like server-parsed HTML or internal -imagemap parsing, etc. Finally, edit the access.conf -file to at least set the base cases of access. - -

      - -In addition to these three files, the server behavior can be configured -on a directory-by-directory basis by using .htaccess -files in directories accessed by the server. - -

      Set your system time properly!

      - -Proper operation of a public web server requires accurate time -keeping, since elements of the HTTP protocol are expressed as the time -of day. So, it's time to investigate setting up NTP or some other -time synchronization system on your Unix box, or whatever the -equivalent on NT would be. - -

      Starting and Stopping the Server

      - -To start the server, simply run httpd. This will look for -httpd.conf in the location compiled into the code (by -default /usr/local/apache/conf/httpd.conf). If -this file is somewhere else, you can give the real -location with the -f argument. For example: - -
      -    /usr/local/apache/httpd -f /usr/local/apache/conf/httpd.conf
-
      - -If all goes well this will return to the command prompt almost -immediately. This indicates that the server is now up and running. If -anything goes wrong during the initialization of the server you will -see an error message on the screen. - -If the server started ok, you can now use your browser to -connect to the server and read the documentation. If you are running -the browser on the same machine as the server and using the default -port of 80, a suitable URL to enter into your browser is - -
      -    http://localhost/
-
      - -

      - -Note that when the server starts it will create a number of -child processes to handle the requests. If you started Apache -as the root user, the parent process will continue to run as root -while the children will change to the user as given in the httpd.conf -file. - -

      - -If when you run httpd it complained about being unable to -"bind" to an address, then either some other process is already using -the port you have configured Apache to use, or you are running httpd -as a normal user but trying to use a port below 1024 (such as the -default port 80). - -

      - -If the server is not running, read the error message displayed -when you run httpd. You should also check the server -error_log for additional information (with the default configuration, -this will be located in the file error_log in the -logs directory). - -

      - -If you want your server to continue running after a system reboot, you -should add a call to httpd to your system startup files -(typically rc.local or a file in an -rc.N directory). This will start Apache as root. -Before doing this ensure that your server is properly configured -for security and access restrictions. - -

      - -To stop Apache send the parent process a TERM signal. The PID of this -process is written to the file httpd.pid in the -logs directory (unless configured otherwise). Do not -attempt to kill the child processes because they will be renewed by -the parent. A typical command to stop the server is: - -

      -    kill -TERM `cat /usr/local/apache/logs/httpd.pid`
-
      - -

      - -For more information about Apache command line options, configuration -and log files, see Starting Apache. For a -reference guide to all Apache directives supported by the distributed -modules, see the Apache directives. - -

      Compiling Support Programs

      - -In addition to the main httpd server which is compiled -and configured as above, Apache includes a number of support programs. -These are not compiled by default. The support programs are in the -support directory of the distribution. To compile -the support programs, change into this directory and type -
      -    make
-
      - - - - diff --git a/docs/manual/invoking.html.en b/docs/manual/invoking.html.en deleted file mode 100644 index 4309e1d6feb..00000000000 --- a/docs/manual/invoking.html.en +++ /dev/null @@ -1,144 +0,0 @@ - - - -Starting Apache - - - - - -

      Starting Apache

      - -

      Invoking Apache

      - -On Unix, the httpd program is usually run as a daemon -which executes continuously, handling requests. It is possible to -invoke Apache by the Internet daemon inetd each time a -connection to the HTTP service is made (use the ServerType directive) but this is -not recommended. - -

      - -On Windows, Apache is normally run as a service on Windows NT, or as a -console application on Windows 95. See also running Apache for Windows. - -

      Command line options

      -The following options are recognized on the httpd command line: -
      -
      -d serverroot -
      Set the initial value for the -ServerRoot variable to -serverroot. This can be overridden by the ServerRoot command -in the configuration file. The default is -/usr/local/apache on Unix, /apache on -Windows and /os2httpd on OS/2. - -
      -D name -
      Define a name for use in in -IfDefine directives. -This option can be used to optionally enable certain functionality in the -configuration file, or to use a common configuration for -several independent hosts, where host specific information is enclosed in -<IfDefine> sections. - -
      -f config -
      Execute the commands in the file config on startup. If -config does not begin with a /, then it is taken to be a -path relative to the ServerRoot. The -default is conf/httpd.conf. - -
      -C "directive" -
      Process the given apache "directive" (just as if it had been part of a -configuration file) before actually reading the regular configuration files. - -
      -c "directive" -
      Process the given apache "directive" after reading -all the regular configuration files. - -
      -X -
      Run in single-process mode, for internal debugging purposes only; the -daemon does not detach from the terminal or fork any children. Do NOT -use this mode to provide ordinary web service. - -
      -v -
      Print the version of httpd and its build date, and then exit. - -
      -V -
      Print the base version of httpd, its -build date, and a list of compile time settings which influence the -behavior and performance of the apache server (e.g., --DUSE_MMAP_FILES), -then exit. - -
      -L -
      - -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.3.4 and -later. Earlier versions used -l instead). - - -
      -l -
      - -Give a list of all modules compiled into the server, then exit. -(Apache 1.3.4 and later. Earlier versions used -h instead).
      - -Give a list of directives together with expected arguments and places -where the directive is valid, then exit. (Apache 1.2 to 1.3.3. Later -versions use -L instead). - - - -
      -h -
      - -Print a list of the httpd options, then exit. (Apache 1.3.4 and -later. Earlier versions used -? instead).
      - -Give a list of all modules compiled into the server, then exit. (Up to -Apache 1.3.3. Later versions use -l instead).
      - - -
      -S -
      Show the settings as parsed from the config file (currently only -shows a breakdown of the vhost settings) but do not start the -server. (Up to Apache 1.3.3, this option also started the server). - -
      -t -
      Test the configuration file syntax (i.e., read all configuration files -and interpret them) but do not start the server. If the configuration contains -errors, display an error message and exit with a non-zero exit status, -otherwise display "Syntax OK" and terminate with a zero exit status. This -command checks to see if all DocumentRoot entries exist and are directories. -For sites with many vhosts, this is expensive; consider the -T -command instead. - -
      -T -
      Test the configuration file syntax (i.e., read all configuration files -and interpret them) but do not start the server. If the configuration contains -errors, display an error message and exit with a non-zero exit status, -otherwise display "Syntax OK" and terminate with a zero exit status. This -command does not perform any checking of the DocumentRoot entries. - -
      -k option -
      Windows only: signal Apache to restart or shutdown. option -is one of "shutdown" or "restart". (Apache 1.3.3 and later). - -
      -? -
      Print a list of the httpd options, and then exit (up to Apache -1.3.3. Later version use -h instead). - -
      - - - - diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en deleted file mode 100644 index 03a9c3f67e9..00000000000 --- a/docs/manual/mod/directive-dict.html.en +++ /dev/null @@ -1,265 +0,0 @@ - - - - Definitions of terms used to describe Apache directives - - - - - -

      Terms Used to Describe Apache Directives

      - -

      - Each Apache configuration directive is described using a common format - that looks like this: -

      -
      -
      Syntax: directive-name some args -
      - Default: - directive-name default-value -
      - Context: context-list -
      - Override: override -
      - Status: status -
      - Module: module-name -
      - Compatibility: compatibility notes -
      -
      -

      - Each of the directive's attributes, complete with possible values - where possible, are described in this document. -

      - -

      Directive Terms

      - - -
      -

      Syntax

      -

      - This indicates the format of the directive as it would appear in a - configuration file. This syntax is extremely directive-specific, so - refer to the text of the directive's description for details. -

      - -
      -

      Default

      -

      - If the directive has a default value (i.e., if you omit it - from your configuration entirely, the Apache Web server will behave as - though you set it to a particular value), it is described here. If - there is no default value, this section should say - "None". -

      - -
      -

      Context

      -

      - This indicates where in the server's configuration files the directive - is legal. It's a comma-separated list of one or more of the following - values: -

      -
      -
      server config -
      -
      This means that the directive may be used in the server - configuration files (e.g., httpd.conf, - srm.conf, and access.conf), but - not within any <VirtualHost> or - <Directory> containers. It is not allowed in - .htaccess files at all. -

      -

      -
      -
      virtual host -
      -
      This context means that the directive may appear inside - <VirtualHost> containers in the server - configuration files. -

      -

      -
      -
      directory -
      -
      A directive marked as being valid in this context may be used - inside <Directory>, - <Location>, and <Files> - containers in the server configuration files, subject to the - restrictions outlined in How Directory, - Location and Files sections work. -

      -

      -
      -
      .htaccess -
      -
      If a directive is valid in this context, it means that it can - appear inside per-directory .htaccess files. - It may not be processed, though depending upon the - overrides - currently active. -

      -

      -
      -
      -

      - The directive is only allowed within the designated context; - if you try to use it elsewhere, you'll get a configuration error that - will either prevent the server from handling requests in that context - correctly, or will keep the server from operating at all -- - i.e., the server won't even start. -

      -

      - The valid locations for the directive are actually the result of a - Boolean OR of all of the listed contexts. In other words, a directive - that is marked as being valid in "server config, - .htaccess" can be used in the httpd.conf file - and in .htaccess files, but not within any - <Directory> or <VirtualHost> containers. -

      - -
      -

      Override

      -

      - This directive attribute indicates which configuration override must - be active in order for the directive to be processed when it appears - in a .htaccess file. If the directive's - context - doesn't permit it to appear in .htaccess files, this - attribute should say "Not applicable". -

      -

      - Overrides are activated by the - AllowOverride - directive, and apply to a particular scope (such as a directory) and - all descendants, unless further modified by other - AllowOverride directives at lower levels. The - documentation for that directive also lists the possible override - names available. -

      - -
      -

      Status

      -

      - This indicates how tightly bound into the Apache Web server the - directive is; in other words, you may need to recompile the server - with an enhanced set of modules in order to gain access to the - directive and its functionality. Possible values for this attribute - are: -

      -
      -
      Core -
      -
      If a directive is listed as having "Core" status, that - means it is part of the innermost portions of the Apache Web server, - and is always available. -

      -

      -
      -
      Base -
      -
      A directive labeled as having "Base" status is - supported by one of the standard Apache modules which is compiled - into the server by default, and is therefore normally available - unless you've taken steps to remove the module from your configuration. -

      -

      -
      -
      Extension -
      -
      A directive with "Extension" status is provided by one - of the modules included with the Apache server kit, but the module - isn't normally compiled into the server. To enable the directive - and its functionality, you will need to change the server build - configuration files and re-compile Apache. -

      -

      -
      -
      Experimental -
      -
      "Experimental" status indicates that the directive is - available as part of the Apache kit, but you're on your own if you - try to use it. The directive is being documented for completeness, - and is not necessarily supported. The module which provides the - directive may or may not be compiled in by default; check the top of - the page which describes the directive and its module to see if it - remarks on the availability. -

      -

      -
      -
      - -
      -

      Module

      -

      - This quite simply lists the name of the source module which defines - the directive. -

      - -
      -

      Compatibility

      -

      - If the directive wasn't part of the original Apache version 1 - distribution, the version in which it was introduced should be listed - here. If the directive has the same name as one from the NCSA HTTPd - server, any inconsistencies in behaviour between the two should also - be mentioned. Otherwise, this attribute should say "No - compatibility issues." -

      - - - diff --git a/docs/manual/mod/module-dict.html.en b/docs/manual/mod/module-dict.html.en deleted file mode 100644 index c4d40675234..00000000000 --- a/docs/manual/mod/module-dict.html.en +++ /dev/null @@ -1,144 +0,0 @@ - - - - Definitions of terms used to describe Apache modules - - - - - -

      Terms Used to Describe Apache Modules

      - -

      - Each Apache module is described using a common format that looks - like this: -

      -
      -
      Status: status -
      - Source File: source-file -
      - Module Identifier: module-identifier -
      - Compatibility: compatibility notes -
      -
      -

      - Each of the attributes, complete with values where possible, are - described in this document. -

      - -

      Module Terms

      - - -
      -

      Status

      -

      - This indicates how tightly bound into the Apache Web server the - module is; in other words, you may need to recompile the server in - order to gain access to the module and its functionality. Possible - values for this attribute are: -

      -
      -
      MPM -
      -
      A module with status "MPM" is a Muti-Processing Module. Unlike the other - types of modules, Apache must have one and only one MPM in use at - any time. This type of module is responsible for basic request - handling and dispatching. -

      -

      -
      Base -
      -
      A module labeled as having "Base" status is compiled - and loaded into the server by default, and is therefore normally - available unless you have taken steps to remove the module from your - configuration. -

      -

      -
      -
      Extension -
      -
      A module with "Extension" status is not normally - compiled and loaded into the server. To enable the module and its - functionality, you may need to change the server build - configuration files and re-compile Apache. -

      -

      -
      -
      Experimental -
      -
      "Experimental" status indicates that the module is - available as part of the Apache kit, but you are on your own if you - try to use it. The module is being documented for completeness, - and is not necessarily supported. -

      -

      -
      -
      External -
      -
      Modules which are not included with the base Apache - distribution ("third-party modules") may use the - "External" status. We are not responsible for, nor do we - support such modules. -

      -

      -
      -
      - -
      -

      Source File

      -

      - This quite simply lists the name of the source file which contains - the code for the module. This is also the name used by the <IfModule> - directive. -

      - -
      -

      Module Identifier

      -

      - This is a string which identifies the module for use in the LoadModule directive when - dynamically loading modules. In particular, it is the name - of the external variable of type module in the source file. -

      - -
      -

      Compatibility

      -

      - If the module was not part of the original Apache version 2 - distribution, the version in which it was introduced should be listed - here. -

      - - - diff --git a/docs/manual/mpm.html.en b/docs/manual/mpm.html.en deleted file mode 100644 index 75c4deb8d11..00000000000 --- a/docs/manual/mpm.html.en +++ /dev/null @@ -1,96 +0,0 @@ - - - -Available MPM's for Apache 2.0 - - - - -

      Apache 2.0 - Available MPM's

      -

      Dated 15th January 2000

      -

      Apache 2.0 has a new architecture that moves the processing of requests from the code server into a MultiProcessing Module (MPM). By selecting the MPM to use you can alter the way the server behaves. Additionally the introduction of the MPM's has led to platforms developing their own optimised modules. On some platforms there is no choice, whilst on others there are different options, each with differing processing models. This list aims to help you select a suitable MPM for your system.

      -
      -

      Platforms

      - -

      Unix

      - - - - - - - - - - - - - - - - - - - - - -
      MPMDescriptionMaintainer
      preforkThe prefork MPM reproduces the behaviour of Apache 1.3.Ryan Bloom
      mpmt_pthreadThis MPM uses a multi-process, multi-threaded model to provide good scability and stability.Ryan Bloom
      dexterThis is Manoj's plaything. It has a number of hybrid features that Manoj has been looking at to improve performance.Manoj
      - -

      Windows

      - - - - - - - - - - - -
      MPMDescriptionMaintainer
      mpm_winntThe Windows MPM, this is a multi-threaded model with a parent watchdog process.Bill Stoddard
      - -

      OS/2

      - - - - - - - - - - - -
      MPMDescriptionMaintainer
      spmt_os2Single process, multiple thread MPM for OS2.Brian Havard
      - -

      BeOS

      - - - - - - - - - - - -
      MPMDescriptionMaintainer
      mpmt_beosMulti-threaded MPM for BeOS. This follows the mpmt_pthread model.David Reid
      - -
      -David Reid, 15th January 2000 - - - diff --git a/docs/manual/new_features_2_0.html.en b/docs/manual/new_features_2_0.html.en deleted file mode 100644 index c537c374726..00000000000 --- a/docs/manual/new_features_2_0.html.en +++ /dev/null @@ -1,79 +0,0 @@ - - -New features with Apache 2.0 - - - - - -

      Overview of New Features in Apache 2.0

      - -

      Enhancements: Core | Module - -

      - -

      Core Enhancements:

      - -
      -
      Unix Threading -
      On Unix systems with POSIX threads support, Apache can now run in a - hybrid multiprocess, multithreaded mode. This should improve - scalability. - -
      New Build System -
      The build system has been rewritten from scratch to be based on - autoconf and libtool. This makes Apache's configuration system more - similar to that of other packages. - -
      Multiprotocol Support -
      Apache now has some of the infrastructure in place to support serving - multiple protocols. mod_echo has been written as an example. - -
      Better support for non-Unix platforms -
      Apache 2.0 is faster and more stable on non-Unix platforms such as - BeOS, OS/2, and Windows. With the introduction of platform-specific - multiprocessing modules (MPM) and the Apache Portable Runtime (APR), - these platforms are now implemented in their native API, avoiding the - often buggy and poorly performing POSIX-emulation layers. -
      A list of the MPM's currently available is here. - -
      New Apache API -
      The API for modules has changed significantly for 2.0. Many of the - module-ordering problems from 1.3 should be gone. 2.0 does much of - this automatically, and module ordering is now done per-hook to - allow more flexibility. Also, new calls have been added that provide - additional module capabilities without patching the core Apache server. - -

      - -

      Module Enhancements:

      - -
      - -
      mod_auth_db -
      Now supports Berkely DB 3.0 - -
      mod_auth_digest -
      Includes additional support for session caching across processes -using shared memory. - -
      mod_charset_lite
      New module in Apache 2.0. -This experimental module allows for character set translation -or recoding. - -
      mod_dav -
      New module in Apache 2.0. This module implements the -HTTP Distributed Authoring and Versioning (DAV) specification for -posting and maintaining web content. - -
      mod_file_cache -
      New module in Apache 2.0. This module includes the functionality -of mod_mmap_static in Apache 1.3, plus adds further caching abilities. - -
      - - - - - diff --git a/docs/manual/platform/netware.html b/docs/manual/platform/netware.html deleted file mode 100644 index 8add778b5f1..00000000000 --- a/docs/manual/platform/netware.html +++ /dev/null @@ -1,278 +0,0 @@ - - - -Using Apache with Novell NetWare 5 - - - - - - -

      Using Apache With Novell NetWare 5

      - -

      This document explains how to install, configure and run - Apache 1.3 under Novell NetWare 5. Please note that at - this time, NetWare support is entirely experimental, and is - recommended only for experienced users. The Apache Group does not - guarantee that this software will work as documented, or even at - all. If you find any bugs, or wish to contribute in other ways, please - use our bug reporting - page.

      - -

      Warning: Apache on NetWare has not yet been optimized for performance. -Apache still performs best, and is most reliable on Unix platforms. Over -time we will improve NetWare performance. Folks doing comparative reviews -of webserver performance are asked to compare against Apache -on a Unix platform such as Solaris, FreeBSD, or Linux.

      - -

      - -Most of this document assumes that you are installing Apache from a -binary distribution. If you want to compile Apache yourself (possibly -to help with development, or to track down bugs), see the section on -Compiling Apache for NetWare below. - -

      - - - -
      - -

      Requirements

      - -Apache 1.3 is designed to run on NetWare 5.0 and 5.1. -

      - -If running on NetWare 5.0 you must install Service Pack 4. - -

      -

      - -Service pack 4 is available here. - -

      Downloading Apache for NetWare 5

      - -

      Information on the latest version of Apache can be found on the -Apache web server at http://www.apache.org/. This will -list the current release, any more recent alpha or beta-test releases, -together with details of mirror web and anonymous ftp sites.

      - -

      -

      Installing Apache for NetWare

      - -There is no Apache install program for NetWare currently. You will need -to compile apache and copy the files over to the server manually. An -install program will be posted at a later date. -

      -Follow these steps to install Apache on NetWare (assuming you will install to sys:/apache): - -

        -
      • Create a directory called Apache on a NetWare volume -
      • Copy Apache.nlm, Apachec.nlm, htdigest.nlm, and htpasswd.nlm to sys:/apache -
      • Create a directory under sys:/Apache called conf -
      • Copy all the *.conf-dist-nw files to the sys:/apache/conf directory - and rename them all as *.conf files -
      • Copy the mime.types and magic files to sys:/apache/conf directory -
      • Copy all files and subdirectories of \apache-1.3\htdocs to sys:/apache/htdocs and - rename the proper index file (index.html.en) to index.html -
      • Copy all files and subdirectories in \apache-1.3\icons to sys:/apache/icons -
      • Create the directory sys:/apache/logs on the server -
      • Create the directory sys:/apache/cgi-bin on the server -
      • Create the directory sys:/apache/modules and copy all nlm modules built into the - modules directory -
      • Edit the httpd.conf file setting ServerRoot and ServerName to reflect your correct - server settings -
      • Add sys:/apache to the search path. EXAMPLE: search add sys:\apache -
      - -

      Apache may be installed to other volumes besides the default sys volume. - -

      Running Apache for NetWare

      - -To start Apache just type apache at the console. This -will load apache in the OS address space. If you prefer to load -Apache in a protected address space you may specify the address space -with the load statement as follows: -

      -

      -    load address space = apache apache
-
      -

      -This will load Apache into an address space called apache. Running multiple instances -of Apache concurrently on NetWare is possible by loading each instance into its own -protected address space. - -

      -After starting Apache it will be listening to port 80 (unless you -changed the Port, Listen or -BindAddress directives in the configuration files). -To connect to the server and access the default page, launch a browser -and enter the server's name or address. - -This should respond with a welcome page, and a link to the Apache -manual. If nothing happens or you get an error, look in the -error_log file in the logs directory. - -

      - -Once your basic installation is working, you should configure it -properly by editing the files in the conf directory. - -

      -To unload Apache running in the OS address space just type the -following at the console: -

      -    unload apache
-
      -If apache is running in a protected address space specify the -address space in the unload statement: -
      -    unload address space = apache apache
-
      - -

      -When working with Apache it is important to know how it will find the -configuration files. You can specify a configuration file on the command line -in two ways: - -

        -
      • -f specifies a path to a particular configuration file -
      -
          apache -f "vol:/my server/conf/my.conf"
      -
          apache -f test/test.conf
      - -In these cases, the proper ServerRoot should be set in the configuration file. - -

      - -If you don't specify a configuration file name with -f, Apache will -use the file name compiled into the server, usually "conf/httpd.conf". Invoking -Apache with the -V switch will display this value labeled as SERVER_CONFIG_FILE. -Apache will then determine its ServerRoot by trying the following, in this order: - -

        -
      • A ServerRoot directive via a -C switch. -
      • The -d switch on the command line. -
      • Current working directory -
      • The server root compiled into the server. -
      - -

      -The server root compiled into the server is usually "sys:/apache". -invoking apache with the -V switch will display this value -labeled as HTTPD_ROOT. - -

      Configuring Apache for NetWare

      - -Apache is configured by files in the conf -directory. These are the same as files used to configure the Unix -version, but there are a few different directives for Apache on -NetWare. See the Apache documentation for all the -available directives. - -

      - -The main differences in Apache for NetWare are: - -

        -

      • Because Apache for NetWare is multithreaded, it does not use a - separate process for each request, as Apache does with - Unix. Instead there are only threads running: a parent thread, and - a child which handles the requests. Within the child each request is - handled by a separate thread. -

        - - So the "process"-management directives are different: -

        MaxRequestsPerChild - - Like the Unix directive, this controls how many requests a - process will serve before exiting. However, unlike Unix, a - process serves all the requests at once, not just one, so if - this is set, it is recommended that a very high number is - used. The recommended default, MaxRequestsPerChild - 0, does not cause the process to ever exit. -

        ThreadsPerChild - - This directive is new, and tells the server how many threads it - should use. This is the maximum number of connections the server - can handle at once; be sure and set this number high enough for - your site if you get a lot of hits. The recommended default is - ThreadsPerChild 50. -

        ThreadStackSize - - This directive tells the server what size of stack to use for - the individual threads. The recommended default is - ThreadStackSize 65536. -

        -

      • The directives that accept filenames as arguments now must use - NetWare filenames instead of Unix ones. However, because Apache - uses Unix-style names internally, you must use forward slashes, not - backslashes. Volumes can be used; if omitted, the drive with the - Apache executable will be assumed.

        -

      • Apache for NetWare contains the ability to load modules at runtime, - without recompiling the server. If Apache is compiled normally, it - will install a number of optional modules in the - \Apache\modules directory. To activate these, or other - modules, the new LoadModule - directive must be used. For example, to active the status module, - use the following (in addition to the status-activating directives - in access.conf):

        -
        -    LoadModule status_module modules/status
-
        -

        Information on creating loadable - modules is also available.

        -
      - -

      Compiling Apache for NetWare

      - -

      Compiling Apache requires MetroWerks CodeWarrior 5 to be properly - installed. - -

      First, unpack the Apache distribution into an appropriate - directory. Then go to the src subdirectory of the Apache - distribution and unzip ApacheNW.mcp.gz. You may use a - recent version of WinZip to accomplish this or gzip for Windows. The main - Metrowerks project file for Apache (ApacheNW.mcp) is now ready - to use. Just double click on it from within explorer and it should - automatically launch MetroWerks CodeWarrior. -

      - -

      All major pieces of Apache may be built using the ApacheNW.mcp project - file. This includes modules such as status, info, and proxy. In addition, - the following project files have been provided as well: -

         
-       /apache-1.3/src/support/htpasswd.mcp.gz
-       /apache-1.3/src/support/htdigest.mcp.gz
-
      - -

      -htpasswd.mcp.gz and htdigest.mcp.gz will also need -to be unzipped before they can be used with MetroWerks CodeWarrior. - -

      Once Apache has been compiled, it needs to be installed in its server - root directory. The default is the sys:/Apache - directory.

      -

      -Before running the server you must fill out the conf directory. -Copy the *.conf-dist-nw from the distribution conf directory -and rename *.conf. Edit the ServerRoot entries to your -actual server root (for example "sys:/apache"). Copy over -the conf/magic and conf/mime.types files as well. - - - - - diff --git a/docs/manual/platform/perf-bsd44.html b/docs/manual/platform/perf-bsd44.html deleted file mode 100644 index c5e978c2b98..00000000000 --- a/docs/manual/platform/perf-bsd44.html +++ /dev/null @@ -1,254 +0,0 @@ - - - -Running a High-Performance Web Server for BSD - - - - - - - -

      Running a High-Performance Web Server for BSD

      - -Like other OS's, the listen queue is often the first limit -hit. The -following are comments from "Aaron Gifford <agifford@InfoWest.COM>" -on how to fix this on BSDI 1.x, 2.x, and FreeBSD 2.0 (and earlier): - -

      - -Edit the following two files: -

      /usr/include/sys/socket.h
      - /usr/src/sys/sys/socket.h
      -In each file, look for the following: -
      -    /*
-     * Maximum queue length specifiable by listen.
-     */
-    #define SOMAXCONN       5
-
      - -Just change the "5" to whatever appears to work. I bumped the two -machines I was having problems with up to 32 and haven't noticed the -problem since. - -

      - -After the edit, recompile the kernel and recompile the Apache server -then reboot. - -

      - -FreeBSD 2.1 seems to be perfectly happy, with SOMAXCONN -set to 32 already. - -

      - - -Addendum for very heavily loaded BSD servers
      -       -from Chuck Murcko <chuck@telebase.com> - -

      - -If you're running a really busy BSD Apache server, the following are useful -things to do if the system is acting sluggish:

      - -

        - -
      • Run vmstat to check memory usage, page/swap rates, etc. - -
      • Run netstat -m to check mbuf usage - -
      • Run fstat to check file descriptor usage - -
      - -These utilities give you an idea what you'll need to tune in your kernel, -and whether it'll help to buy more RAM. - -Here are some BSD kernel config parameters (actually BSDI, but pertinent to -FreeBSD and other 4.4-lite derivatives) from a system getting heavy usage. -The tools mentioned above were used, and the system memory was increased to -48 MB before these tuneups. Other system parameters remained unchanged. - -

      - -

      -maxusers        256
-
      - -Maxusers drives a lot of other kernel parameters: - -
        - -
      • Maximum # of processes - -
      • Maximum # of processes per user - -
      • System wide open files limit - -
      • Per-process open files limit - -
      • Maximum # of mbuf clusters - -
      • Proc/pgrp hash table size - -
      - -The actual formulae for these derived parameters are in -/usr/src/sys/conf/param.c. -These calculated parameters can also be overridden (in part) by specifying -your own values in the kernel configuration file: - -
      -# Network options. NMBCLUSTERS defines the number of mbuf clusters and
-# defaults to 256. This machine is a server that handles lots of traffic,
-# so we crank that value.
-options         NMBCLUSTERS=4096        # mbuf clusters at 4096
-
-#
-# Misc. options
-#
-options         CHILD_MAX=512           # maximum number of child processes
-options         OPEN_MAX=512            # maximum fds (breaks RPC svcs)
-
      - -

      - -In many cases, NMBCLUSTERS must be set much larger than would appear -necessary at first glance. The reason for this is that if the browser -disconnects in mid-transfer, the socket fd associated with that particular -connection ends up in the TIME_WAIT state for several minutes, during -which time its mbufs are not yet freed. Another reason is that, on server -timeouts, some connections end up in FIN_WAIT_2 state forever, because -this state doesn't time out on the server, and the browser never sent -a final FIN. For more details see the -FIN_WAIT_2 page. - -

      - -Some more info on mbuf clusters (from sys/mbuf.h): -

      -/*
- * Mbufs are of a single size, MSIZE (machine/machparam.h), which
- * includes overhead.  An mbuf may add a single "mbuf cluster" of size
- * MCLBYTES (also in machine/machparam.h), which has no additional overhead
- * and is used instead of the internal data area; this is done when
- * at least MINCLSIZE of data must be stored.
- */
-
      - -

      - -CHILD_MAX and OPEN_MAX are set to allow up to 512 child processes (different -than the maximum value for processes per user ID) and file descriptors. -These values may change for your particular configuration (a higher OPEN_MAX -value if you've got modules or CGI scripts opening lots of connections or -files). If you've got a lot of other activity besides httpd on the same -machine, you'll have to set NPROC higher still. In this example, the NPROC -value derived from maxusers proved sufficient for our load. - -

      - -To increase the size of the listen() queue, you need to -adjust the value of SOMAXCONN. SOMAXCONN is not derived from maxusers, -so you'll always need to increase that yourself. We use a value guaranteed -to be larger than Apache's default for the listen() of 128, currently. -The actual value for SOMAXCONN is set in sys/socket.h. -The best way to adjust this parameter is run-time, rather than changing -it in this header file and thus hardcoding a value in the kernel and -elsewhere. To do this, edit /etc/rc.local and add the -following line: -

      -    /usr/sbin/sysctl -w kern.somaxconn=256
-
      - -

      - -We used 256 but you can tune it for your own setup. In -many cases, however, even the default value of 128 (for -later versions of FreeBSD) is OK. - -

      - -Caveats - -

      - -Be aware that your system may not boot with a kernel that is configured -to use more resources than you have available system RAM. -ALWAYS -have a known bootable kernel available when tuning your system this way, -and use the system tools beforehand to learn if you need to buy more -memory before tuning. - -

      - -RPC services will fail when the value of OPEN_MAX is larger than 256. -This is a function of the original implementations of the RPC library, -which used a byte value for holding file descriptors. BSDI has partially -addressed this limit in its 2.1 release, but a real fix may well await -the redesign of RPC itself. - -

      - -Finally, there's the hard limit of child processes configured in Apache. - -

      - -For versions of Apache later than 1.0.5 you'll need to change the -definition for HARD_SERVER_LIMIT in httpd.h and -recompile if you need to run more than the default 150 instances of httpd. - -

      - -From conf/httpd.conf-dist: - -

      -# Limit on total number of servers running, i.e., limit on the number
-# of clients who can simultaneously connect --- if this limit is ever
-# reached, clients will be LOCKED OUT, so it should NOT BE SET TOO LOW.
-# It is intended mainly as a brake to keep a runaway server from taking
-# Unix with it as it spirals down...
-
-MaxClients 150
-
      - -Know what you're doing if you bump this value up, and make sure you've -done your system monitoring, RAM expansion, and kernel tuning beforehand. -Then you're ready to service some serious hits! - -

      - -Thanks to Tony Sanders and Chris Torek at BSDI for their -helpful suggestions and information. - -

      - -"M. Teterin" <mi@ALDAN.ziplink.net> writes:

      -

      It really does help if your kernel and frequently used utilities -are fully optimized. Rebuilding the FreeBSD kernel on an AMD-133 -(486-class CPU) web-server with
      - -m486 -fexpensive-optimizations -fomit-frame-pointer -O2
      -helped reduce the number of "unable" errors, because the CPU was -often maxed out.
      -

      - -

      - -

      More welcome!

      - -If you have tips to contribute, send mail to -apache@apache.org - - - - diff --git a/docs/manual/platform/perf-dec.html b/docs/manual/platform/perf-dec.html deleted file mode 100644 index 2b9cc9cc5e1..00000000000 --- a/docs/manual/platform/perf-dec.html +++ /dev/null @@ -1,285 +0,0 @@ - - - -Performance Tuning Tips for Digital Unix - - - - -

      Performance Tuning Tips for Digital Unix

      - -Below is a set of newsgroup posts made by an engineer from DEC in -response to queries about how to modify DEC's Digital Unix OS for more -heavily loaded web sites. Copied with permission. - -
      - -

      Update

      -From: Jeffrey Mogul <mogul@pa.dec.com>
      -Date: Fri, 28 Jun 96 16:07:56 MDT
      - -
        -
      1. The advice given in the README file regarding the - "tcbhashsize" variable is incorrect. The largest value - this should be set to is 1024. Setting it any higher - will have the perverse result of disabling the hashing - mechanism. - -
      2. Patch ID OSF350-146 has been superseded by -
        - Patch ID OSF350-195 for V3.2C
        - Patch ID OSF360-350195 for V3.2D -
        - Patch IDs for V3.2E and V3.2F should be available soon. - There is no known reason why the Patch ID OSF360-350195 - won't work on these releases, but such use is not officially - supported by Digital. This patch kit will not be needed for - V3.2G when it is released. -
      -
      - - -
      -From           mogul@pa.dec.com (Jeffrey Mogul)
-Organization   DEC Western Research
-Date           30 May 1996 00:50:25 GMT
-Newsgroups     comp.unix.osf.osf1
-Message-ID     <4oirch$bc8@usenet.pa.dec.com>
-Subject        Re: Web Site Performance
-References     1
-
-
-
-In article <skoogDs54BH.9pF@netcom.com> skoog@netcom.com (Jim Skoog) writes:
->Where are the performance bottlenecks for Alpha AXP running the
->Netscape Commerce Server 1.12 with high volume internet traffic?
->We are evaluating network performance for a variety of Alpha AXP
->runing DEC UNIX 3.2C, which run DEC's seal firewall and behind
->that Alpha 1000 and 2100 webservers.
-
-Our experience (running such Web servers as altavista.digital.com
-and www.digital.com) is that there is one important kernel tuning
-knob to adjust in order to get good performance on V3.2C.  You
-need to patch the kernel global variable "somaxconn" (use dbx -k
-to do this) from its default value of 8 to something much larger.
-
-How much larger?  Well, no larger than 32767 (decimal).  And
-probably no less than about 2048, if you have a really high volume
-(millions of hits per day), like AltaVista does.
-
-This change allows the system to maintain more than 8 TCP
-connections in the SYN_RCVD state for the HTTP server.  (You
-can use "netstat -An |grep SYN_RCVD" to see how many such
-connections exist at any given instant).
-
-If you don't make this change, you might find that as the load gets
-high, some connection attempts take a very long time.  And if a lot
-of your clients disconnect from the Internet during the process of
-TCP connection establishment (this happens a lot with dialup
-users), these "embryonic" connections might tie up your somaxconn
-quota of SYN_RCVD-state connections.  Until the kernel times out
-these embryonic connections, no other connections will be accepted,
-and it will appear as if the server has died.
-
-The default value for somaxconn in Digital UNIX V4.0 will be quite
-a bit larger than it has been in previous versions (we inherited
-this default from 4.3BSD).
-
-Digital UNIX V4.0 includes some other performance-related changes
-that significantly improve its maximum HTTP connection rate.  However,
-we've been using V3.2C systems to front-end for altavista.digital.com
-with no obvious performance bottlenecks at the millions-of-hits-per-day
-level.
-
-We have some Webstone performance results available at
-        http://www.digital.com/info/alphaserver/news/webff.html
-
-[The document referenced above is no longer at that URL -- Ed.]
-
-I'm not sure if these were done using V4.0 or an earlier version
-of Digital UNIX, although I suspect they were done using a test
-version of V4.0.
-
--Jeff
-
-
      
-
-----------------------------------------------------------------------------
-
-From           mogul@pa.dec.com (Jeffrey Mogul)
-Organization   DEC Western Research
-Date           31 May 1996 21:01:01 GMT
-Newsgroups     comp.unix.osf.osf1
-Message-ID     <4onmmd$mmd@usenet.pa.dec.com>
-Subject        Digital UNIX V3.2C Internet tuning patch info
-
-----------------------------------------------------------------------------
-
-Something that probably few people are aware of is that Digital
-has a patch kit available for Digital UNIX V3.2C that may improve
-Internet performance, especially for busy web servers.
-
-This patch kit is one way to increase the value of somaxconn,
-which I discussed in a message here a day or two ago.
-
-I've included in this message the revised README file for this
-patch kit below.  Note that the original README file in the patch
-kit itself may be an earlier version; I'm told that the version
-below is the right one.
-
-Sorry, this patch kit is NOT available for other versions of Digital
-UNIX.  Most (but not quite all) of these changes also made it into V4.0,
-so the description of the various tuning parameters in this README
-file might be useful to people running V4.0 systems.
-
-This patch kit does not appear to be available (yet?) from
-        http://www.service.digital.com/html/patch_service.html
-so I guess you'll have to call Digital's Customer Support to get it.
-
--Jeff
-
-DESCRIPTION: Digital UNIX Network tuning patch
-
-             Patch ID: OSF350-146
-
-             SUPERSEDED PATCHES: OSF350-151, OSF350-158
-
-        This set of files improves the performance of the network
-        subsystem on a system being used as a web server.  There are
-        additional tunable parameters included here, to be used
-        cautiously by an informed system administrator.
-
-TUNING
-
-        To tune the web server, the number of simultaneous socket
-        connection requests are limited by:
-
-        somaxconn               Sets the maximum number of pending requests
-                                allowed to wait on a listening socket.  The
-                                default value in Digital UNIX V3.2 is 8.
-                                This patch kit increases the default to 1024,
-                                which matches the value in Digital UNIX V4.0.
-
-        sominconn               Sets the minimum number of pending connections
-                                allowed on a listening socket.  When a user
-                                process calls listen with a backlog less
-                                than sominconn, the backlog will be set to
-                                sominconn.  sominconn overrides somaxconn.
-                                The default value is 1.
-
-        The effectiveness of tuning these parameters can be monitored by
-        the sobacklog variables available in the kernel:
-
-        sobacklog_hiwat         Tracks the maximum pending requests to any
-                                socket.  The initial value is 0.
-
-        sobacklog_drops         Tracks the number of drops exceeding the
-                                socket set backlog limit.  The initial
-                                value is 0.
-
-        somaxconn_drops         Tracks the number of drops exceeding the
-                                somaxconn limit.  When sominconn is larger
-                                than somaxconn, tracks the number of drops
-                                exceeding sominconn.  The initial value is 0.
-
-        TCP timer parameters also affect performance. Tuning the following
-        require some knowledge of the characteristics of the network.
-
-        tcp_msl                 Sets the tcp maximum segment lifetime.
-                                This is the maximum lifetime in half
-                                seconds that a packet can be in transit
-                                on the network.  This value, when doubled,
-                                is the length of time a connection remains
-                                in the TIME_WAIT state after a incoming
-                                close request is processed.  The unit is
-                                specified in 1/2 seconds, the initial
-                                value is 60.
-
-        tcp_rexmit_interval_min
-                                Sets the minimum TCP retransmit interval.
-                                For some WAN networks the default value may
-                                be too short, causing unnecessary duplicate
-                                packets to be sent.  The unit is specified
-                                in 1/2 seconds, the initial value is 1.
-
-        tcp_keepinit            This is the amount of time a partially
-                                established connection will sit on the listen
-                                queue before timing out (e.g., if a client
-                                sends a SYN but never answers our SYN/ACK).
-                                Partially established connections tie up slots
-                                on the listen queue.  If the queue starts to
-                                fill with connections in SYN_RCVD state,
-                                tcp_keepinit can be decreased to make those
-                                partial connects time out sooner.  This should
-                                be used with caution, since there might be
-                                legitimate clients that are taking a while
-                                to respond to SYN/ACK.  The unit is specified
-                                in 1/2 seconds, the default value is 150
-                                (ie. 75 seconds).
-
-        The hashlist size for the TCP inpcb lookup table is regulated by:
-
-        tcbhashsize             The number of hash buckets used for the
-                                TCP connection table used in the kernel.
-                                The initial value is 32.  For best results,
-                                should be specified as a power of 2.  For
-                                busy Web servers, set this to 2048 or more.
-
-        The hashlist size for the interface alias table is regulated by:
-
-        inifaddr_hsize          The number of hash buckets used for the
-                                interface alias table used in the kernel.
-                                The initial value is 32.  For best results,
-                                should be specified as a power of 2.
-
-        ipport_userreserved     The maximum number of concurrent non-reserved,
-                                dynamically allocated ports.  Default range
-                                is 1025-5000.  The maximum value is 65535.
-                                This limits the numer of times you can
-                                simultaneously telnet or ftp out to connect
-                                to other systems.
-
-        tcpnodelack             Don't delay acknowledging TCP data; this
-                                can sometimes improve performance of locally
-                                run CAD packages.  Default is value is 0,
-                                the enabled value is 1.
-
-                           Digital UNIX version:
-
-                                  V3.2C
-Feature                    V3.2C  patch  V4.0
-=======                    =====  =====  ====
-somaxconn                   X      X      X
-sominconn                   -      X      X
-sobacklog_hiwat             -      X      -
-sobacklog_drops             -      X      -
-somaxconn_drops             -      X      -
-tcpnodelack                 X      X      X
-tcp_keepidle                X      X      X
-tcp_keepintvl               X      X      X
-tcp_keepcnt                 -      X      X
-tcp_keepinit                -      X      X
-TCP keepalive per-socket    -      -      X
-tcp_msl                     -      X      -
-tcp_rexmit_interval_min     -      X      -
-TCP inpcb hashing           -      X      X
-tcbhashsize                 -      X      X
-interface alias hashing     -      X      X
-inifaddr_hsize              -      X      X
-ipport_userreserved         -      X      -
-sysconfig -q inet           -      -      X
-sysconfig -q socket         -      -      X
-
-
      - - - diff --git a/docs/manual/platform/perf-hp.html b/docs/manual/platform/perf-hp.html deleted file mode 100644 index ca902a09fe8..00000000000 --- a/docs/manual/platform/perf-hp.html +++ /dev/null @@ -1,122 +0,0 @@ - - - -Running a High-Performance Web Server on HPUX - - - - -  - - -

      Running a High-Performance Web Server for HPUX

      - -
      -Date: Wed, 05 Nov 1997 16:59:34 -0800
-From: Rick Jones <raj@cup.hp.com>
-Reply-To: raj@cup.hp.com
-Organization: Network Performance
-Subject: HP-UX tuning tips
-
      - -Here are some tuning tips for HP-UX to add to the tuning page. - -

      - -For HP-UX 9.X: Upgrade to 10.20
      -For HP-UX 10.[00|01|10]: Upgrade to 10.20 - -

      - -For HP-UX 10.20: - -

      - -Install the latest cumulative ARPA Transport Patch. This will allow you -to configure the size of the TCP connection lookup hash table. The -default is 256 buckets and must be set to a power of two. This is -accomplished with adb against the *disc* image of the kernel. The -variable name is tcp_hash_size. - -Notice that it's critically important that you use "W" to write a 32 bit -quantity, not "w" to write a 16 bit value when patching the disc image because -the tcp_hash_size variable is a 32 bit quantity. - -

      - -How to pick the value? Examine the output of - -ftp://ftp.cup.hp.com/dist/networking/tools/connhist and see how many -total TCP connections exist on the system. You probably want that number -divided by the hash table size to be reasonably small, say less than 10. -Folks can look at HP's SPECweb96 disclosures for some common settings. -These can be found at -http://www.specbench.org/. If an HP-UX system was -performing at 1000 SPECweb96 connections per second, the TIME_WAIT time -of 60 seconds would mean 60,000 TCP "connections" being tracked. - -

      - -Folks can check their listen queue depths with - -ftp://ftp.cup.hp.com/dist/networking/misc/listenq. - -

      - -If folks are running Apache on a PA-8000 based system, they should -consider "chatr'ing" the Apache executable to have a large page size. -This would be "chatr +pi L <BINARY>." The GID of the running executable -must have MLOCK privileges. Setprivgrp(1m) should be consulted for -assigning MLOCK. The change can be validated by running Glance and -examining the memory regions of the server(s) to make sure that they -show a non-trivial fraction of the text segment being locked. - -

      - -If folks are running Apache on MP systems, they might consider writing a -small program that uses mpctl() to bind processes to processors. A -simple pid % numcpu algorithm is probably sufficient. This might even go -into the source code. - -

      - -If folks are concerned about the number of FIN_WAIT_2 connections, they -can use nettune to shrink the value of tcp_keepstart. However, they -should be careful there - certainly do not make it less than oh two to -four minutes. If tcp_hash_size has been set well, it is probably OK to -let the FIN_WAIT_2's take longer to timeout (perhaps even the default -two hours) - they will not on average have a big impact on performance. - -

      - -There are other things that could go into the code base, but that might -be left for another email. Feel free to drop me a message if you or -others are interested. - -

      - -sincerely, - -

      - -rick jones
      - -http://www.cup.hp.com/netperf/NetperfPage.html - -

      - -

      - Apache HTTP Server Version 1.3 -

      - -Index -Home - - - diff --git a/docs/manual/platform/perf.html b/docs/manual/platform/perf.html deleted file mode 100644 index 73bd5b5b20f..00000000000 --- a/docs/manual/platform/perf.html +++ /dev/null @@ -1,175 +0,0 @@ - - - -Hints on Running a High-Performance Web Server - - - - - -

      Hints on Running a High-Performance Web Server

      - -Running Apache on a heavily loaded web server, one often encounters -problems related to the machine and OS configuration. "Heavy" is -relative, of course - but if you are seeing more than a couple hits -per second on a sustained basis you should consult the pointers on -this page. In general the suggestions involve how to tune your kernel -for the heavier TCP load, hardware/software conflicts that arise, etc. - - - -
      - -

      -A/UX (Apple's UNIX) -

      - -If you are running Apache on A/UX, a page that gives some helpful -performance hints (concerning the listen() queue and using -virtual hosts) -can be found here - -

      - -

      -BSD-based (BSDI, FreeBSD, etc) -

      - -Quick and -detailed -performance tuning hints for BSD-derived systems. - -

      - -

      -Digital UNIX -

      - - - -

      - -

      -Linux -

      - -There are no known problems with heavily loaded systems running Linux -kernels 2.0.32 or later. Earlier kernels have some problems, and an -upgrade to the latest 2.0.x is a good idea to eliminate various security -and denial of service attacks. - -

      - -

      -Solaris 2.4 -

      - -The Solaris 2.4 TCP implementation has a few inherent limitations that -only became apparent under heavy loads. This has been fixed to some -extent in 2.5 (and completely revamped in 2.6), but for now consult -the following URL for tips on how to expand the capabilities if you -are finding slowdowns and lags are hurting performance. - -

      - -Other links: - -

      - -

      - -

      -SunOS 4.x -

      - -More information on tuning SOMAXCONN on SunOS can be found at - -http://www.islandnet.com/~mark/somaxconn.html. - -

      - -

      -SVR4 -

      - -Some SVR4 versions waste three system calls on every -gettimeofday() call. Depending on the syntactic -form of the TZ environment variable, these -systems have several different algorithms to determine the -local time zone (presumably compatible with -something). The following example uses the central european -time zone to demonstrate this: -
      -
      TZ=:MET -
      This form delegates the knowledge of the time zone - information to an external compiled zoneinfo file - (à la BSD).
      - Caveat: Each time the gettimeofday() - function is called, the external zone info is read in - again (at least on some SVR4 systems). That results in - three wasted system calls with every apache request - served.
      -     open("/usr/lib/locale/TZ/MET", O_RDONLY) = 3
-     read(3, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"..., 7944) = 778
-     close(3)                                = 0
      - -
      TZ=MET-1MDT,M3.5.0/02:00:00,M10.5.0/03:00:00 -
      This syntax form (à la SYSV) contains all the - knowledge about time zone beginning and ending times in - its external representation. It has to be parsed each - time it is evaluated, resulting in a slight computing - overhead, but it requires no system call. Though the - table lookup à la BSD is the more sophisticated - technical solution, the bad SVR4 implementation makes - this the preferred syntax on systems which otherwise - access the external zone info file repeatedly. -
      -You should use the truss utility on a -single-process apache server (started with the -X -debugging switch) to determine whether your system can profit -from the second form of the TZ environment -variable. If it does, you could integrate the setting of the -preferred TZ syntax into the httpd startup -script, which is usually simply a copy of (or symbolic link -to) the apachectl utility script, or into the -system's /etc/TIMEZONE script. - -

      - -

      More welcome!

      - -If you have tips to contribute, send mail to apache@apache.org - - - - diff --git a/docs/manual/platform/readme-tpf.html b/docs/manual/platform/readme-tpf.html deleted file mode 100644 index 2b3c0e2cdc9..00000000000 --- a/docs/manual/platform/readme-tpf.html +++ /dev/null @@ -1,208 +0,0 @@ - - - -The Apache TPF Port - - - -

      Overview of the Apache TPF Port

      -
      -
      [ Configuration Files -  | What's Available -  | Porting Notes ] -
      -
      -
      - -

      - This version of Apache includes changes allowing it to run on - IBM's EBCDIC-based - TPF - (Transaction Processing Facility) operating system. - Unless otherwise noted TPF version 4.1 PUT09 is required. -

      - Refer to htdocs/manual/install-tpf.html - for step-by-step installation instructions. -

      - As this is the first cut at making Apache run on TPF, - performance tuning has not been done. -

      - This port builds upon the EBCDIC changes - previously made to Apache. -
      -

      - -  -

      Apache Configuration Files

      -

      - The distributed configuration files (httpd.conf-dist and - mime.types, both located in the conf subdirectory) - work on TPF. Performance considerations may dictate setting KeepAlive to "Off" - (the default is "On") or lowering the Timeout value from the default - 300 seconds (5 minutes) in order to reduce the number of active ECBs on your system. -

      - -  -

      What's Available in this Version

      - - (The Apache organization provides - online documentation - describing the various modules and components of the server.) - -

      Components/modules tested on TPF:

      - -
        -
      • alloc.c -
      • ap_base64.c -
      • ap_checkpass.c -
      • ap_cpystrn.c -
      • ap_fnmatch.c -
      • ap_md5c.c -
      • ap_sha1.c -
      • ap_signal.c -
      • ap_slack.c -
      • ap_snprintf.c -
      • buff.c -
      • buildmark.c -
      • ebcdic.c -
      • gen_test.char.c -
      • gen_uri_delims.c -
      • htpasswd.c (requires PUT10) -
      • http_config.c -
      • http_core.c -
      • http_log.c -
      • http_main.c -
      • http_protocol.c -
      • http_request.c -
      • http_vhost.c -
      • logresolve.c (requires PUT10) -
      • mod_access.c (see note 1) -
      • mod_actions.c -
      • mod_alias.c -
      • mod_asis.c -
      • mod_auth.c -
      • mod_auth_anon.c -
      • mod_autoindex.c -
      • mod_cern_meta.c -
      • mod_cgi.c (requires PUT10) -
      • mod_digest.c -
      • mod_dir.c -
      • mod_env.c -
      • mod_example.c -
      • mod_expires.c -
      • mod_headers.c -
      • mod_imap.c -
      • mod_include.c (see note 2) -
      • mod_info.c -
      • mod_log_agent.c -
      • mod_log_config.c -
      • mod_log_referer.c -
      • mod_mime.c -
      • mod_mime_magic.c -
      • mod_negotiation.c -
      • mod_put.c - (third party module) -
      • mod_proxy.c -
      • mod_setenvif.c -
      • mod_speling.c -
      • mod_status.c -
      • mod_tpf_shm_static.c (third party module, requires PUT10) -
      • mod_unique_id.c (requires PUT10) -
      • mod_userdir.c -
      • mod_usertrack.c -
      • os.c -
      • os-inline.c -
      • proxy_cache.c -
      • proxy_connect.c -
      • proxy_ftp.c -
      • proxy_http.c -
      • proxy_util.c -
      • regular expression parser -
      • regular expression test tool (requires PUT10) -
      • rfc1413.c -
      • rotatelogs.c (requires PUT10) -
      • util.c -
      • util_date.c -
      • util_md5.c -
      • util_script.c -
      • util_uri.c -
      - Notes: -
        -
      1. Use of mod_access directives "Allow from" & "Deny from" - with host names (verses ip addresses) requires TPF version 4.1 PUT10 -
      2. CGI execution requires TPF version 4.1 PUT10 -
      - -

      Components/modules not yet supported on TPF:

      - -
        -
      • htdigest.c -
      • lib/expat-lite -
      • mod_auth_digest.c -
      • mod_rewrite.c -
      • mod_vhost_alias.c -
      - -

      Components/modules that don't apply or that probably won't ever be available on TPF:

      - -
        -
      • ab.c -
      • ap_getpass.c -
      • mod_auth_db.c -
      • mod_auth_dbm.c -
      • mod_auth_db.module -
      • mod_mmap_static.c -
      • mod_so.c -
      • suexec.c -
      - -  -

      Porting Notes

      -

      -

      Changes made due to differences between UNIX and - TPF's process models:

      -
        -
      • Signals: On TPF a signal that is sent to a process - remains unhandled until the process explicitly requests that signals - be handled using the tpf_process_signals() function. - Additionally, the default action for an alarm on TPF is to take - an OPR-7777 dump and exit. (On UNIX the default is the equivalent - of exit() with no dump taken.) - These differences necessitated a few modifications: -

        -
          -
        • bypass the use of ap_block_alarms() & - ap_unblock_alarms() -
        • add tpf_process_signals() calls -
        • add select() calls to prevent blocking. -
        -
        -
      - -

      Find that function...

      -

      Some simple functions & definitions initially needed to be added - on TPF, such as FD_SET(). - We've put these in src/os/tpf/os.h for now. -

      - -

      EBCDIC changes:

      -

      TPF-specific conversion tables between US-ASCII and - EBCDIC (character set IBM-1047 to be exact) were created - and put into ebcdic.c in the src/os/tpf directory. -

      - -

      Miscellaneous, minor changes:

      -

      Various minor changes (such as casting) were made due to - differences in how some functions are implemented on TPF. -

      - -
      -
      [ top -  | Configuration Files -  | What's Available -  | Porting Notes ] -
      - - - diff --git a/docs/manual/platform/unixware.html b/docs/manual/platform/unixware.html deleted file mode 100644 index a77a3b5cd45..00000000000 --- a/docs/manual/platform/unixware.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -Compiling Apache under UnixWare - - - - - - -

      Compiling Apache under UnixWare

      - -To compile a working copy of Apache under UnixWare, there are several other -steps you may need to take. These prevent such problems as zombie processes, -bind errors, and accept errors, to name a few. - -

      UnixWare 1.x

      - -Make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). If using the UnixWare cc -compiler, and you still see accept() errors, don't use compiler optimization, -or get gcc. - -

      UnixWare 2.0.x

      - -SCO patch tf2163 is required -in order for Apache to work correctly on UnixWare 2.0.x. See -http://www.sco.com -for UnixWare patch information.

      - -In addition, make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). To reduce instances of connections -in FIN_WAIT_2 state, you may also want to define NO_LINGCLOSE (Apache 1.2 -only). - -

      UnixWare 2.1.x

      - -SCO patch ptf3123 is required -in order for Apache to work correctly on UnixWare 2.1.x. See -http://www.sco.com -for UnixWare patch information.

      - -NOTE: Unixware 2.1.2 and later already have patch ptf3123 -included

      - -In addition, make sure that USE_FCNTL_SERIALIZE_ACCEPT is defined (if not -defined by Apache autoconfiguration). To reduce instances of connections -in FIN_WAIT_2 state, you may also want to define NO_LINGCLOSE (Apache 1.2 -only).

      - -Thanks to Joe Doupnik <JRD@cc.usu.edu> and Rich Vaughn -<rvaughn@aad.com> for additional info for UnixWare builds.

      - - - - diff --git a/docs/manual/platform/win_compiling.html b/docs/manual/platform/win_compiling.html deleted file mode 100644 index a415747e41e..00000000000 --- a/docs/manual/platform/win_compiling.html +++ /dev/null @@ -1,182 +0,0 @@ - - - -Compiling Apache for Microsoft Windows - - - - - - -

      Compiling Apache for Microsoft Windows

      - -

      There are many important points before you begin compiling Apache. - See Using Apache with Microsoft Windows - before you begin.

      - -

      Compiling Apache requires Microsoft Visual C++ 5.0 (or later) to be - properly installed. It is easiest to compile with the command-line tools - (nmake, etc...). Consult the VC++ manual to determine how to install - them. Be especially aware that the vcvars32.bat file from the - Program Files/DevStudio/VC/bin folder may be required to prepare the - command-line environment for command-line builds!

      - -

      First, unpack the Apache distribution into an appropriate - directory. Open a command-line prompt, and change to the - src subdirectory of the Apache distribution.

      - -

      The master Apache makefile instructions are contained in the - Makefile.win file. To compile Apache on Windows, simply - use one of the following commands:

      -

        -
      • nmake /f Makefile.win _apacher (release build) -
      • nmake /f Makefile.win _apached (debug build) -
      - -

      These will both compile Apache. The latter will include debugging - information in the resulting files, making it easier to find bugs and - track down problems.

      - -

      Apache can also be compiled using VC++'s Visual Studio development - environment. To simplify this process, a Visual Studio workspace, - Apache.dsw, is provided in the src folder. This workspace exposes - the entire list of working .dsp projects that are required for the - complete Apache binary release. It includes dependencies between - the projects to assure that they are built in the appropriate order.

      - -

      Notice: The Apache/VisualStudio project files are distributed - in VisualStudio 6.0 (98) format. In fact you may build with - VisualStudio 5.0 (97) but you must first use the perl script command:

      - -
      -    cd src\helpers
-    cvstodsp5.pl
-
      - -

      Without running the script you will be able to load and build Apache, - however VisualStudio 97 in particular will not recognize the /ZI flag - to the C compiler for the debugging mode. This script toggles the - new /ZI flag back to /Zi for Debug builds, among other adjustments. - The converse script in src/helpers/dsp5tocvs.pl will - reverse the adjustments, and we ask you to do so before submitting - patches against any .dsp project files.

      - -

      The Apache.dsw workspace and makefile.win nmake script both build the - .dsp projects of the Apache server in the following sequence:

      - -
        -
      1. lib\apr\aprlib.dsp -
      2. lib\apr\aprlibdll.dsp requires aprlib -
      3. lib\pcre\dftables.dsp -
      4. lib\pcre\pcre.dsp requires dftables -
      5. lib\pcre\pcreposix.dsp requires dftables and pcre -
      6. lib\expat-lite\xmltok.dsp -
      7. lib\expat-lite\xmlparse.dsp requires xmltok -
      8. main\gen_uri_delims.dsp -
      9. main\gen_test_char.dsp -
      10. ApacheCore.dsp requires all of the above -
      11. Apache.dsp requires ApacheCore and aprlibdll -
      - - In addition, the os\win32 subdirectory contains - project files for the optional modules. - -
        -
      1. os\win32\ApacheModuleAuthAnon.dsp -
      2. os\win32\ApacheModuleAuthDigest.dsp -
      3. os\win32\ApacheModuleCERNMeta.dsp -
      4. os\win32\ApacheModuleExpires.dsp -
      5. os\win32\ApacheModuleFileCache.dsp -
      6. os\win32\ApacheModuleHeaders.dsp -
      7. os\win32\ApacheModuleInfo.dsp -
      8. os\win32\ApacheModuleRewrite.dsp -
      9. os\win32\ApacheModuleSpeling.dsp -
      10. os\win32\ApacheModuleStatus.dsp -
      11. os\win32\ApacheModuleUserTrack.dsp -
      12. modules\proxy\ApacheModuleProxy.dsp -
      - - The support\ folder contains project files for additional - programs that are not part of the apache runtime, but are used by - the administrator to test Apache and maintain password and log files.

      - -
        -
      1. support\ab.dsp -
      2. support\htdigest.dsp -
      3. support\htpasswd.dsp -
      4. support\logresolve.dsp -
      5. support\rotatelogs.dsp -
      - -

      Once Apache has been compiled, it needs to be installed in its server - root directory. The default is the \Apache - directory, on the current hard drive.

      - -

      To build and install all the files into the desired folder dir - automatically, use one the following nmake commands: - -

        -
      • nmake /f Makefile.win installr INSTDIR=dir - (for release build) -
      • nmake /f Makefile.win installd INSTDIR=dir - (for debug build) -
      - - The dir argument to INSTDIR gives the installation directory; it - can be omitted if Apache is to be installed into \Apache.

      - -

      This will install the following:

      - -
        -
      • dir\Apache.exe - Apache executable -
      • dir\aprlib.dll - Apache Portable Runtime shared library -
      • dir\ApacheCore.dll - Apache Core application -
      • dir\modules\ApacheModule*.dll - Loadable Apache - modules -
      • dir\bin\*.exe - Administrator support executables -
      • dir\conf - Empty configuration directory -
      • dir\logs - Empty logging directory -
      - -

      If you do not have nmake, or wish to install in a different directory, - be sure to use a similar naming scheme, or use the following shortcut.

      - -

      To simplify the process, dependencies between all projects - are defined in the Microsoft VisualStudio workspace file: - -

      -   src/Apache.dsw
-
      - -

      This assures that lower-level sources are rebuilt from within - VisualStudio. The top level project is InstallBin, which invokes - Makefile.win to move the compiled executables and dlls. You may - personalize the INSTDIR= setting by changing the Settings for - InstallBin, Build command line entry under the General tab. - The default from within the InstallBin.dsp project is one level up - (..) from the src tree.

      - -

      Warning about building Apache from the development tree

      - -

      Only the .dsp files are distributed between release builds. The - .mak files are NOT regenerated, due to the tremendous waste of - reviewer's time. Therefore, you cannot rely on the NMAKE commands - above to build revised .dsp project files unless you then export - all .mak files yourself from the project. This is unnecessary if - you build from withing the Microsoft DeveloperStudio environment.

      - -

      Before running the server you must fill out the conf directory. - Copy the *.conf-dist-win from the distribution conf directory - and rename *.conf. Edit the @@ServerRoot@@ entries to your - actual server root (for example "C:\apache"). Copy over - the conf/magic and conf/mime.types files as well.

      - - - - diff --git a/docs/manual/platform/win_service.html b/docs/manual/platform/win_service.html deleted file mode 100644 index 6fb76bc9fdb..00000000000 --- a/docs/manual/platform/win_service.html +++ /dev/null @@ -1,325 +0,0 @@ - - - -Running Apache for Windows as a Service - - - - - - -

      Running Apache for Windows as a Service

      - -

      Apache can be run as a service on Windows NT/2000. (There is also some - HIGHLY EXPERIMENTAL support for similar behavior on - Windows 95/98, introduced with Apache 1.3.13).

      - -

      Installing Apache as a service should only be done once you can - successfully run it in a console window. See - Using Apache with Microsoft Windows - before you attempt to install or run Apache as a service. Changes to the - httpd.conf file should always be followed by starting Apache as a console - window. If this succeeds, the service should succeed.

      - -

      NOTE: Prior to version 1.3.13, the configuration was not - tested prior to performing the installation, and a lack of - service dependencies often caused the console window to succeed, but the - service would still fail. See below if you are - having problems running a version of Apache prior to 1.3.13 to resolve the - issue. If you have this problem with version 1.3.13 or greater, first try - uninstalling (-u) and re-installing (-i) the Apache service.

      - -
      - -

      To start Apache as a service, you first need to install it as a - service. Multiple Apache services can be installed, each with a - different name and configuration. To install the default Apache - service named "Apache", run the "Install Apache as Service (NT only)" - option from the Start menu. Once this is done you can start the "Apache" - service by opening the Services window (in the Control Panel), selecting - Apache, then clicking on Start. Apache will now be running, hidden in the - background. You can later stop Apache by clicking on Stop. As an - alternative to using the Services window, you can start and stop the - "Apache" service from the command line with

      - -
      -  NET START APACHE
-  NET STOP APACHE
-
      - -

      See Controlling Apache as a Service - for more information on installing and controlling Apache services.

      - -

      Apache, unlike many other Windows NT/2000 services, logs any - errors to it's own error.log file in the logs folder within the - Apache server root folder. You will not find Apache error - details in the Windows NT Event Log.

      - -

      After starting Apache as a service (or if you have trouble starting it) - you can test it using the same procedure - as for running in a console window. Remember to use the command:

      - -
      -  apache -n "service name"
-
      - -

      to assure you are using the service's configuration.

      - - -

      Running Apache for Windows as a Service

      - -

      Note: The -n option to specify a service name is only available - with Apache 1.3.7 and later. Earlier versions of Apache only - support the default service name 'Apache'.

      - -

      You can install Apache as a Windows NT service as follows:

      - -
      -    apache -i -n "service name"
-
      - -

      To install a service to use a particular configuration, specify the - configuration file when the service is installed:

      - -
      -    apache -i -n "service name" -f "\my server\conf\my.conf"
-
      - -

      To remove an Apache service, use:

      - -
      -    apache -u -n "service name"
-
      - -

      The default "service name", if one is not specified, is "Apache".

      - -

      Once a service is installed, you can use the -n option, in - conjunction with other options, to refer to a service's configuration file. - For example:

      - -

      To test a service's configuration file:

      -
      -    apache -n "service name" -t
-
      - -

      To start a console Apache using a service's configuration file:

      -
      -    apache -n "service name"
-
      - -

      Important Note on service dependencies:

      - -

      Prior to Apache release 1.3.13, the dependencies required to - successfully start an installed service were not configured. - After installing a service using earlier versions of Apache, - you must follow these steps: - -

      -    Run regedt32
-    Select Window - "HKEY_LOCAL_MACHINE on Local Machine" from the menu
-    Double-click to open the SYSTEM, then the CurrentControlSet keys
-    Scroll down and click on the Apache servicename
-    Select Edit - Add Value... from the menu
-    Fill in the Add Value dialog with 
-        Value Name: DependOnGroup 
-        Data Type: REG_MULTI_SZ
-        and click OK
-    Leave the Multi-String Editor dialog empty and click OK
-    Select Edit - Add Value... from the menu
-    Fill in the Add Value dialog with 
-        Value Name: DependOnService
-        Data Type: REG_MULTI_SZ
-        and click OK
-    Type the following list (one per line) in the Multi-String Editor dialog
-        Tcpip
-        Afd
-        and click OK
-
      - -

      If you are using COM or DCOM components from a third party module, ISAPI, - or other add-in scripting technologies such as ActiveState Perl, you may - also need to add the entry Rpcss to the DependOnService list. To avoid - exposing the TCP port 135 when it is unnecessary, Apache does not create - that entry upon installation. Follow the directions above to find or - create the DependOnService value, double click that value if it already - exists, and add the Rpcss entry to the list.

      - - -

      User Account for Apache Service to Run As (NT/2000)

      - -

      When Apache is first installed as a service (e.g. with the -i option) - it will run as user "System" (the LocalSystem account). There should - be few issues if all resources for the web server reside on the local - system, but it has broad security privilages to affect the local machine!

      - -
      - LocalSystem is a very privileged account locally, so - you shouldn't run any shareware applications there. - However, it has no network privileges and cannot leave - the machine via any NT-secured mechanism, including - file system, named pipes, DCOM, or secure RPC. -
      - -

      NEVER grant network privilages to the SYSTEM account! - Create a new user account instead, grant the appropriate privilages to - that user, and use the the 'Log On As:' option. Select the Start Menu -> - Settings -> Control Panel -> Services -> apache service ... and click - the "Startup" button to access this setting.

      - -
      - A service that runs in the context of the LocalSystem account - inherits the security context of the SCM. It is not associated with - any logged-on user account and does not have credentials (domain name, - user name, and password) to be used for verification. -
      - -

      The SYSTEM account has no privilages to the network, so shared pages or - a shared installation of Apache is invisible to the service. If you intend - to use any network resources, the following steps should help:

      - -
        -
      • Select Apache from the Control Panel's Service dialog and click Startup. -
      • Verify that the service account is correct. You may wish to create an - account for your Apache services. -
      • Retype the password and password confirmation. -
      • Go to User Manager for Domains. -
      • Click on Policies from the title bar menu, and select User Rights. -
      • Select the option for Advanced User Rights. -
      • In the drop-down list, verify that the following rights have been - granted to the selected account: -
          -
        • Act as part of the operating system -
        • Back up files and directories -
        • Log on as a service -
        • Restore files and directories -
        -
      • Confirm that the selected account is a member of the Users group. -
      • Confirm the selected account has access to all document and script - directories (minimally read and browse access). -
      • Confirm the selected account has read/write/delete access to the Apache - logs directory! -
      - -

      If you allow the account to log in as a user, then you can log in yourself - and test that the account has the privilages to execute the scripts, read - the web pages, and that you can start Apache in a console window. If this - works, and you have followed the steps above, Apache should execute as - a service with no problems.

      -

      Note: error code 2186 is a good indication that you need - to review the 'Log On As' configuration, since the server can't access a - required network resource.

      - - -

      Troubleshooting Apache for Windows as a Service

      - -

      When starting Apache as a service you may encounter an error message from - Windows service manager. For example if you try to start Apache using the Services - applet in Windows Control Panel you may get the following message; -

      -  Could not start the apache service on \\COMPUTER
-  Error 1067; The process terminated unexpectedly.
-
      -

      You will get this error if there is any problem starting Apache. In order to see - what is causing the problem you should follow the instructions - for Testing Apache at the Command Prompt.

      - -

      Also, Apache 1.3.13 now records startup errors in the Application Event Log - under Windows NT/2000, if Apache is run as a service. Run the Event Viewer - and select Log ... Application to see these events. - -

      Check the Application Event Log with the Event Viewer in case of any - problems, even if no error message pops up to warn you that an error - occured.

      - -

      Running Apache for Windows from the Command Line

      - -For details on controlling Apache service from the command line, please refer to -console command line section. - - -

      Controlling Apache as a Service

      - -

      Multiple instances of Apache can be installed and run as services. Signal - an installed Apache service to start, restart, or shutdown/stop - as follows:

      - -
      -    apache -n "service name" -k start
-    apache -n "service name" -k restart
-    apache -n "service name" -k shutdown
-    apache -n "service name" -k stop
-
      - -

      For the default "Apache" service, the -n Apache option is still required, - since the -k commands without the -n option are directed at Apache running - in a console window. The quotes are only required if the service name - contains spaces.

      - -

      Note: the -k stop alias for the -k shutdown command was introduced - in Apache version 1.3.13. Earlier versions of Apache will only - recognize the -k shutdown option. Prior to 1.3.3, Apache did not recognize - any -k options at all!

      - -

      In addition, you can use the native NT NET command to - start and stop Apache services as follows:

      - -
      -    NET START "service name"
-    NET STOP "service name"
-
      - -

      Again, quotes are only required if the service name contains spaces.

      - -

      HIGHLY EXPERIMENTAL Windows 95/98 Service

      - -

      Note: The service options for Windows 95 and 98 are only available - with Apache 1.3.13 and later. Earlier versions of Apache only - supported Apache in a console window for Windows 95/98.

      - -

      There is some support for Apache on Windows 95/98 to behave in a similar - manner as a service on Windows NT/2000. It is highly experimental, - if it works (at all) the Apache Sofware Foundation will not attest to it's - reliability or future support. Proceed at your own risk!

      - -

      Once you have confirmed that Apache runs correctly at the - Command Prompt you can install, control - and uninstall it with the same commands as the Windows NT/2000 version.

      - -

      There are, however, significant differences that you should note:

      - -

      Apache will attempt to start and if successful it will run in the - background. If you run the command - -

      -   Apache -n "service name" -k start
-
      - - via a shortcut on your desktop, for example, then if the service starts - successfully a console window will flash up but immediately disappears. - If Apache detects any errors on startup such as a incorrect entries in the - httpd.conf file, then the console window will remain visible. This will - display an error message which will be useful in tracking down the cause of - the problem.

      - -

      Windows 95/98 does not support NET START or NET STOP commands so you must - use Apache's Service Control options at a command prompt. You may wish to - set up a shortcut for each of these commands so that you can just choose - it from the start menu or desktop to perform the required action.

      - -

      Apache and Windows 95/98 offer no support for running the Apache service - as a specific user with network privilages. In fact, Windows 95/98 offers - no security on the local machine, either. This is the simple reason that - the Apache Software Foundation never endorses the use of Windows 95/98 as a - public httpd server. These facilities exist only to assist the user in - developing web content and learning the Apache server, and perhaps as a - intranet server on a secured, private network.

      - - - - diff --git a/docs/manual/platform/windows.html b/docs/manual/platform/windows.html deleted file mode 100644 index f7d5d6f884d..00000000000 --- a/docs/manual/platform/windows.html +++ /dev/null @@ -1,511 +0,0 @@ - - - -Using Apache with Microsoft Windows - - - - - - -

      Using Apache With Microsoft Windows

      - -

      This document explains how to install, configure and run - Apache 2.0 under Microsoft Windows. If you find any bugs, or wish - to contribute in other ways, please use our - bug reporting page.

      - -

      Most of this document assumes that you are installing Windows from a - binary distribution. If you want to compile Apache yourself (possibly - to help with development, or to track down bugs), see - Compiling Apache for Microsoft Windows. - -

      - - - -
      - -

      Requirements

      - -

      Apache 2.0 is designed to run on Windows NT 4.0 and Windows 2000. The - binary installer will only work with the x86 family of processors, such - as Intel's. Apache may also run on Windows 95 and 98, but these have not - been tested, and are never recommended for production servers. In all - cases TCP/IP networking must be installed.

      - -

      If running on Windows 95, the "Winsock2" upgrade MUST BE INSTALLED. - "Winsock2" for Windows 95 is available - here.

      - -

      If running on NT 4.0, installing Service Pack 3 or 6 is recommended, as - Service Pack 4 created known issues with TCPIP/WinSock integrety that - were resolved in later Service Packs.

      - -

      Warning: as of alpha 2.0a4 Windows 95 (and possibly 98) do not - run at all. Please don't let that stop you, however, from contributing - the fixes required to make that platform run successfully.

      - -

      Downloading Apache for Windows

      - -

      Information on the latest version of Apache can be found on the - Apache web server at - http://www.apache.org/httpd. This will list the current release, - any more recent alpha or beta-test releases, together with details of - mirror web and anonymous ftp sites.

      - -

      You should download the version of Apache for Windows with the - .exe extension. This is a single file containing Apache, - ready to install and run. There may also be a .zip file - containing the source code, to compile Apache yourself. (If there is - no .zip file, the source will be available in a - .tar.gz file but this will contain Unix line endings. You - will have to convert at least the .mak and - .dsp files to have DOS line endings before MSVC will - understand them).

      - -

      Notice: alpha versions are not distributed in binary form (as - an .exe ready-to-run version). You must use the Microsoft Visual C++ - compiler version 5 or 6 (bundled in VisualStudio 97 and 98). Read - Compiling Apache for Microsoft Windows - for compilation/installation instructions.

      - -

      Installing Apache for Windows

      - -

      Run the Apache .exe file you downloaded above. This will - ask for:

      - -
        - -
      • the directory to install Apache into (the default is - \Program Files\Apache Group\Apache although you can - change this to any other directory) - -
      • the start menu name (default is "Apache Web Server") - -
      • the installation type. The "Typical" option installs - everything except the source code. The "Minimum" option does not - install the manuals or source code. Choose the "Custom" install if - you want to install the source code. - -
      - -

      During the installation, Apache will configure the files in the - conf directory for your chosen installation - directory. However if any of the files in this directory already exist - they will not be overwritten. Instead the new copy of - the corresponding file will be left with the extension - .default. So, for example, if - conf\httpd.conf already exists it will not be altered, - but the version which would have been installed will be left in - conf\httpd.conf.default. After the installation has - finished you should manually check to see what in new in the - .default file, and if necessary update your existing - configuration files.

      - -

      Also, if you already have a file called htdocs\index.html - then it will not be overwritten (no index.html.default - file will be installed either). This should mean it a safe to install - Apache over an existing installation (but you will have to stop the - existing server running before doing the installation, then start the - new one after the installation is finished).

      - -

      After installing Apache, you should edit the configuration files in - the conf directory as required. These files will be - configured during the install ready for Apache to be run from the - directory where it was installed, with the documents served from the - subdirectory htdocs. There are lots of other options - which should be set before you start really using Apache. However to - get started quickly the files should work as installed.

      - -

      Running Apache for Windows

      - -There are two ways you can run Apache: - -
        -
      • As a "service" (available on Windows NT/2000 only). - This is the best option if you want Apache to automatically start when you - machine boots, and to keep Apache running when you log-off. -
      • From a console window. This is the only option - available for Windows 95/98 users, and MUST be used by Windows NT/2000 - users before to attempting to run as a service. -
      - -

      To run Apache from a console window, select the "Start Apache as - console app" option from the Start menu (in Apache 1.3.4 and earlier, - this option was called "Apache Server"). This will open a console - window and start Apache running inside it. The window will remain - active until you stop Apache. To stop Apache running, either select - the "Shutdown Apache console app" icon option from the Start menu - (this is not available in Apache 1.3.4 or earlier), or see Signalling Console Apache when Running for how - to control Apache from the command line.

      - -

      If the Apache console window closes immediately (or unexpectedly), - run the "Command Prompt" from the Start Menu - Programs list. Change - to the folder to which you installed Apache, type the command apache, - and read the error message. Then change to the logs folder, and review - the error.log file for configuration mistakes. If you accepted the - defaults when you installed Apache, the commands would be:

      - -
      -  c:
-  cd "\program files\apache group\apache"
-  apache
-  Wait for Apache to exit, or press Ctrl+C
-  cd logs
-  more <error.log
-
      - -

      Complete the steps above before you proceed to attempt to - start Apache as a Window NT/2000 service!

      - -

      To start Apache as a service, you first need to install it as a - service. Multiple Apache services can be installed, each with a - different name and configuration. To install the default Apache - service named "Apache", run the "Install Apache as Service (NT only)" - option from the Start menu. Once this is done you can start the "Apache" - service by opening the Services window (in the Control Panel), selecting Apache, - then clicking on Start. Apache will now be running in the background. You - can later stop Apache by clicking on Stop. As an alternative to using - the Services window, you can start and stop the "Apache" service from the control - line with:

      - -
      -  NET START APACHE
-  NET STOP APACHE
-
      - -

      See Signalling Service Apache when Running - for more information on installing and controlling Apache services.

      - -

      Apache, unlike many other Windows NT/2000 services, logs any - errors to it's own error.log file in the logs folder within the - Apache server root folder. You will not find Apache error - details in the Windows NT Event Log.

      - -

      After starting Apache running (either in a console window or as a - service) if will be listening to port 80 (unless you changed the - Port, Listen or BindAddress - directives in the configuration files). To connect to the server and - access the default page, launch a browser and enter this URL:

      - -
      -  http://localhost/
-
      - -

      This should respond with a welcome page, and a link to the Apache - manual. If nothing happens or you get an error, look in the - error_log file in the logs directory. - If your host isn't connected to the net, you may have to use - this URL:

      - -
      -  http://127.0.0.1/
-
      - -

      Once your basic installation is working, you should configure it - properly by editing the files in the conf directory. - Again, if you change the configuration of the Windows NT/2000 - service for Apache, first attempt to start it from the command - line to assure that the service starts with no errors.

      - -

      Because Apache CANNOT share the same port with another - TCPIP application, you may need to stop or uninstall certain - services first. These include (but are not limited to) other - web servers, and firewall products such as BlackIce. If you can - only start Apache with these services disabled, reconfigure either - Apache or the other product so that they do not listen on the - same TCPIP ports.

      - -

      Configuring Apache for Windows

      - -

      Apache is configured by files in the conf - directory. These are the same as files used to configure the Unix - version, but there are a few different directives for Apache on - Windows. See the Apache documentation for all the - available directives.

      - -

      The main differences in Apache for Windows are:

      - -
        -

      • Because Apache for Windows is multithreaded, it does not use a - separate process for each request, as Apache does with - Unix. Instead there are usually only two Apache processes running: - a parent process, and a child which handles the requests. Within - the child each request is handled by a separate thread. -

        - - So the "process"-management directives are different: -

        MaxRequestsPerChild - - Like the Unix directive, this controls how many requests a - process will serve before exiting. However, unlike Unix, a - process serves all the requests at once, not just one, so if - this is set, it is recommended that a very high number is - used. The recommended default, MaxRequestsPerChild - 0, does not cause the process to ever exit. - - Warning: The server configuration file is reread when the - new child process is started. If you have modified httpd.conf, - the new child may not start or you may receive unexpected results. - -

        ThreadsPerChild - - This directive is new, and tells the server how many threads it - should use. This is the maximum number of connections the server - can handle at once; be sure and set this number high enough for - your site if you get a lot of hits. The recommended default is - ThreadsPerChild 50.

        -

      • The directives that accept filenames as arguments now must use - Windows filenames instead of Unix ones. However, because Apache - uses Unix-style names internally, you must use forward slashes, not - backslashes. Drive letters can be used; if omitted, the drive with - the Apache executable will be assumed.

        -

      • Apache for Windows contains the ability to load modules at runtime, - without recompiling the server. If Apache is compiled normally, it - will install a number of optional modules in the - \Apache\modules directory. To activate these, or other - modules, the new LoadModule - directive must be used. For example, to active the status module, - use the following (in addition to the status-activating directives - in access.conf):

        -
        -    LoadModule status_module modules/ApacheModuleStatus.dll
-
        -

        Information on creating loadable - modules is also available.

        -

      • Apache can also load ISAPI Extensions (i.e., Internet Server - Applications), such as those used by Microsoft's IIS, and other - Windows servers. More information - is available. Note that Apache CANNOT load ISAPI - Filters. -

      - -

      Running Apache for Windows as a Service

      - -

      Note: The -n option to specify a service name is only available - with Apache 1.3.7 and later. Earlier versions of Apache only support - the default service name 'Apache'.

      - -

      You can install Apache as a Windows NT service as follows: - -

      -    apache -k install -n "service name"
-
      - - To install a service to use a particular configuration, specify the - configuration file when the service is installed: - -
      -    apache -k install -n "service name" -f "\my server\conf\my.conf"
-
      - - To remove an Apache service, use - -
      -    apache -k uninstall -n "service name"
-
      - - The default "service name", if one is not specified, is "Apache".

      - -

      Once a service is installed, you can use the -n option, in - conjunction with other options, to refer to a service's configuration - file. For example:

      - -

      To test a service's configuration file:

      - -
      -    apache -n "service name" -t
-
      - -

      To start a console Apache using a service's configuration file:

      - -
      -    apache -n "service name"
-
      - -

      Important Note on service dependencies:

      - -

      Prior to Apache release 1.3.13, the dependencies required to - successfully start an installed service were not configured. - After installing a service using earlier versions of Apache, - you must follow these steps: - -

      -    Run regedt32
-    Select Window - "HKEY_LOCAL_MACHINE on Local Machine" from the menu
-    Double-click to open the SYSTEM, then the CurrentControlSet keys
-    Scroll down and click on the Apache servicename
-    Select Edit - Add Value... from the menu
-    Fill in the Add Value dialog with 
-        Value Name: DependOnGroup 
-        Data Type: REG_MULTI_SZ
-        and click OK
-    Leave the Multi-String Editor dialog empty and click OK
-    Select Edit - Add Value... from the menu
-    Fill in the Add Value dialog with 
-        Value Name: DependOnService
-        Data Type: REG_MULTI_SZ
-        and click OK
-    Type the following list (one per line) in the Multi-String Editor dialog
-        Tcpip
-        Afd
-        and click OK
-
      - -

      If you are using COM or DCOM components from a third party module, ISAPI, - or other add-in scripting technologies such as ActiveState Perl, you may - also need to add the entry Rpcss to the DependOnService list. To avoid - exposing the TCP port 135 when it is unnecessary, Apache does not create - that entry upon installation. Follow the directions above to find or - create the DependOnService value, double click that value if it already - exists, and add the Rpcss entry to the list.

      - -

      Running Apache for Windows from the Command Line

      - -

      The Start menu icons and the NT Service manager can provide a simple - interface for administering Apache. But in some cases it is easier to - work from the command line.

      - -

      When working with Apache it is important to know how it will find the - configuration files. You can specify a configuration file on the command line - in two ways: - -

        -
      • -f specifies a path to a particular configuration file -
      -
          apache -f "c:\my server\conf\my.conf"
      -
          apache -f test\test.conf
      -
        -
      • -n specifies the configuration file of an installed Apache service (Apache 1.3.7 and later) -
      -
          apache -n "service name"
      - - In these cases, the proper ServerRoot should be set in the configuration file.

      - -

      If you don't specify a configuration file name with -f or -n, Apache will - use the file name compiled into the server, usually "conf/httpd.conf". Invoking - Apache with the -V switch will display this value labeled as SERVER_CONFIG_FILE. - Apache will then determine its ServerRoot by trying the following, in this order:

      - -
        -
      • A ServerRoot directive via a -C switch. -
      • The -d switch on the command line. -
      • Current working directory -
      • A registry entry, created if you did a binary install. -
      • The server root compiled into the server. -
      - -

      The server root compiled into the server is usually "/apache". - invoking apache with the -V switch will display this value - labeled as HTTPD_ROOT.

      - -

      When invoked from the start menu, Apache is usually passed no arguments, - so using the registry entry is the preferred technique for console Apache.

      - -

      During a binary installation, a version-specific registry key is created - in the Windows registry: - -

      -  HKEY_LOCAL_MACHINE\Software\Apache Group\Apache\1.3.7
-
-  HKEY_LOCAL_MACHINE\Software\Apache Group\Apache\2.0a3
-
      - -

      This key is compiled into the server and can enable you to test - new versions without affecting the current version. Of course - you must take care not to install the new version on top of the - old version in the file system.

      - -

      If you did not do a binary install then Apache will in some - scenarios complain that about the missing registry key. This - warning can be ignored if it otherwise was able to find its - configuration files.

      - -

      The value of this key is the "ServerRoot" directory, containing the - conf directory. When Apache starts it will read the - httpd.conf file from this directory. If this file - contains a ServerRoot directive which is different from - the directory obtained from the registry key above, Apache will forget - the registry key and use the directory from the configuration file. - If you copy the Apache directory or configuration files to a new - location it is vital that you update the ServerRoot - directory in the httpd.conf file to the new location. - -

      To run Apache from the command line as a console application, use the - following command: - -

      -    apache 
-
      - - Apache will execute, and will remain running until it is stopped by pressing - control-C.

      - -

      Signalling Service Apache when running

      - -

      On Windows NT, multiple instances of Apache can be run as services. - Signal an Apache service to start, restart, or shutdown as follows:

      - -
      -    apache -n "service name" -k start
-    apache -n "service name" -k restart
-    apache -n "service name" -k shutdown
-
      - -

      In addition, you can use the native NT NET command to - start and stop Apache services as follows:

      - -
      -    NET START "service name"
-    NET STOP "service name"
-
      - -

      Signalling Console Apache when running

      - -

      On Windows 95, Apache runs as a console application. You can tell a - running Apache to stop by opening another console window and typing:

      - -
      -    apache -k shutdown
-
      - -

      This should be used instead of pressing Control-C in the running - Apache console window, because it lets Apache end any current - transactions and cleanup gracefully.

      - -

      You can also tell Apache to restart. This makes it re-read the - configuration files. Any transactions in progress are allowed to - complete without interruption. To restart Apache, run

      - -
      -    apache -k restart
-
      - -

      Note for people familiar with the Unix version of Apache: these - commands provide a Windows equivalent to kill -TERM - pid and kill -USR1 pid. The command - line option used, -k, was chosen as a reminder of the - "kill" command used on Unix.

      - - - - - diff --git a/docs/manual/sections.html.en b/docs/manual/sections.html.en deleted file mode 100644 index 08a93b5b594..00000000000 --- a/docs/manual/sections.html.en +++ /dev/null @@ -1,170 +0,0 @@ - - -How Directory, Location and Files sections work - - - - - -

      How Directory, Location and Files sections work

      - -The sections <Directory>, <Location> and <Files> can contain -directives which only apply to specified directories, URLs or files -respectively. Also htaccess files can be used inside a directory to -apply directives to that directory. This document explains how these -different sections differ and how they relate to each other when -Apache decides which directives apply for a particular directory or -request URL. - -

      Directives allowed in the sections

      - -Everything that is syntactically allowed in -<Directory> is also allowed in -<Location> (except a sub-<Files> -section). Semantically however some things, and the most -notable are AllowOverride and the two options -FollowSymLinks and SymLinksIfOwnerMatch, -make no sense in <Location>, -<LocationMatch> or <DirectoryMatch>. -The same for <Files> -- syntactically everything -is fine, but semantically some things are different. - -

      How the sections are merged

      - -The order of merging is: - -
        - -
      1. - - <Directory> (except regular expressions) and - .htaccess done simultaneously (with .htaccess overriding - <Directory>) - -
        2. - -
      2. - <DirectoryMatch>, and - <Directory> with regular expressions - -
        3. - -
      3. <Files> and <FilesMatch> done - simultaneously -
        4. - -
      4. <Location> and <LocationMatch> done - simultaneously -
        5. - -
      - -Apart from <Directory>, each group is processed in -the order that they appear in the configuration -files. <Directory> (group 1 above) is processed in -the order shortest directory component to longest. If multiple -<Directory> sections apply to the same directory -they they are processed in the configuration file order. The -configuration files are read in the order httpd.conf, srm.conf and -access.conf. Configurations included via the Include -directive will be treated as if they were inside the including file -at the location of the Include directive. - -

      - -Sections inside <VirtualHost> sections are applied -after the corresponding sections outside the virtual host -definition. This allows virtual hosts to override the main server -configuration. (Note: this only works correctly from 1.2.2 and 1.3a2 -onwards. Before those releases sections inside virtual hosts were -applied before the main server). - -

      Notes about using sections

      - -The general guidelines are: - -

      - -

        -
      • - If you are attempting to match objects at the filesystem level - then you must use <Directory> and/or - <Files>. -
        • - -
      • - If you are attempting to match objects at the URL level then you - must use <Location> -
        • -
      - -But a notable exception is: - -
        -
      • - proxy control is done via <Directory>. This is - a legacy mistake because the proxy existed prior to - <Location>. A future version of the config - language should probably switch this to - <Location>. -
        • -
      - -

      -Note about .htaccess parsing: -

      -
        -
      • - Modifying .htaccess parsing during Location doesn't do - anything because .htaccess parsing has already occurred. -
      - -

      -<Location> and symbolic links: -

      -
        -
      • - It is not possible to use "Options FollowSymLinks" - or "Options SymLinksIfOwnerMatch" inside a - <Location>, <LocationMatch> - or <DirectoryMatch> section - (the options are simply ignored). - Using the options in question is only possible inside a - <Directory> section (or a .htaccess file). -
      - -

      -<Files> and Options: -

      -
        -
      • - Apache won't check for it, but using an Options - directive inside a <Files> section has no effect. -
      - -

      -Another note: -

      - -
        -
      • - There is actually a - <Location>/<LocationMatch> - sequence performed just before the name translation phase (where - Aliases and DocumentRoots are used to - map URLs to filenames). The results of this sequence are - completely thrown away after the translation has completed. -
        • -
      - - - diff --git a/docs/manual/server-wide.html.en b/docs/manual/server-wide.html.en deleted file mode 100644 index be987a8f5a4..00000000000 --- a/docs/manual/server-wide.html.en +++ /dev/null @@ -1,217 +0,0 @@ - - - -Server-Wide Configuration - - - - - -

      Server-Wide Configuration

      - -

      This document explains some of the directives provided by the -core server which are used to configure -the basic operations of the server.

      - - - -
      - -

      Server Identification

      - - -
      -Related Directives

      - -ServerName
      -ServerAdmin
      -ServerSignature
      -ServerTokens
      -UseCanonicalName
      -
      - -

      The ServerAdmin and ServerTokens -directives control what information about the server will be presented -in server-generated documents such as error messages. -The ServerTokens directive sets the value of the -Server HTTP response header field.

      - -

      The ServerName and UseCanonicalName -directives are used by the server to determine how to construct -self-referential URLs. For example, when a client requests a -directory, but does not include the trailing slash in the directory -name, Apache must redirect the client to the full name including the -trailing slash so that the client will correctly resolve relative -references in the document.

      - -
      - -

      File Locations

      - - -
      -Related Directives

      - -CoreDumpDirectory
      -DocumentRoot
      -ErrorLog
      -Lockfile
      -PidFile
      -ScoreBoardFile
      -ServerRoot
      -
      - -

      These directives control the locations of the various files that -Apache needs for proper operation. When the pathname used does not -begin with a slash "/", the files are located relative to the -ServerRoot. Be careful about locating files in paths -which are writable by non-root users. See the security tips documentation for -more details.

      - -
      - -

      Process Creation

      - - -
      -Related Directives

      - -BS2000Account
      -Group
      -MaxClients
      -MaxRequestsPerChild
      -MaxSpareServers
      -MinSpareServers
      -ServerType
      -StartServers
      -ThreadsPerChild
      -User
      -
      - -

      When ServerType is set to its recommended value of -Standalone, Apache 1.3 for Unix is a pre-forking web -server. A single control process is responsible for launching child -processes which listen for connections and serve them when they -arrive. Apache always tries to maintain several spare or -idle server processes, which stand ready to serve incoming requests. -In this way, clients do not need to wait for a new child processes to -be forked before their requests can be served.

      - -

      The StartServers, MinSpareServers, -MaxSpareServers, and MaxServers regulate how -the parent process creates children to serve requests. In general, -Apache is very self-regulating, so most sites do not need to adjust -these directives from their default values. Sites which need to serve -more than 256 simultaneous requests may need to increase -MaxClients, while sites with limited memory may need to -decrease MaxClients to keep the server from thrashing -(swapping memory to disk and back). More information about tuning -process creation is provided in the performance hints documentation.

      - -

      While the parent process is usually started as root under Unix -in order to bind to port 80, the child processes are launched -by Apache as a less-privileged user. The User and -Group directives are used to set the privileges -of the Apache child processes. The child processes must -be able to read all the content that will be served, but -should have as few privileges beyond that as possible. -In addition, unless suexec is used, -these directives also set the privileges which will be inherited -by CGI scripts.

      - -

      MaxRequestsPerChild controls how frequently the server -recycles processes by killing old ones and launching new ones.

      - -

      Under Windows, Apache launches one control process and one -child process. The child process creates multiple threads to -serve requests. The number of threads is controlled by the -ThreadsPerChild directive.

      - -
      - -

      Network Configuration

      - - -
      -Related Directives

      - -BindAddress
      -KeepAlive
      -KeepAliveTimeout
      -Listen
      -ListenBackLog
      -MaxKeepAliveRequests
      -Port
      -SendBufferSize
      -TimeOut
      -
      - -

      When Apache starts, it connects to some port and address on the -local machine and waits for incoming requests. By default, it listens -to all addresses on the machine, and to the port as specified by the -Port directive in the server configuration. However, it -can be told to listen to more than one port, to listen to only -selected addresses, or a combination. This is often combined with the -Virtual Host feature which determines how Apache -responds to different IP addresses, hostnames and ports.

      - -

      There are two directives used to restrict or specify which addresses -and ports Apache listens to. The BindAddress directive -is used to restrict the server to listening to a single IP address. -The Listen directive can be used to specify multiple -IP addresses and/or Ports to which Apache will listen.

      - -

      The ListenBackLog, SendBufferSize, and -TimeOut directives are used to adjust how Apache -interacts with the network.

      - -

      The KeepAlive, KeepAliveTimeout, -and MaxKeepAliveRequests directives are used to -configure how Apache handles persistent connections.

      - -
      -

      Limiting Resource Usage

      - -
      -Related Directives

      - -LimitRequestBody
      -LimitRequestFields
      -LimitRequestFieldsize
      -LimitRequestLine
      -RLimitCPU
      -RLimitMEM
      -RLimitNPROC
      -ThreadStackSize
      -
      - -

      The LimitRequest* directives are used to place limits -on the amount of resources Apache will use in reading requests -from clients. By limiting these values, some kinds of denial -of service attacks can be mitigated.

      - -

      The RLimit* directives are used to limit the amount -of resources which can be used by processes forked off from -the Apache children. In particular, this will control -resources used by CGI scripts and SSI exec commands.

      - -

      The ThreadStackSize directive is used only -on Netware to control the stack size.

      - - - - diff --git a/docs/manual/stopping.html.en b/docs/manual/stopping.html.en deleted file mode 100644 index 783d1c02508..00000000000 --- a/docs/manual/stopping.html.en +++ /dev/null @@ -1,183 +0,0 @@ - - - -Stopping and Restarting Apache - - - - - -

      Stopping and Restarting Apache

      - -

      This document covers stopping and restarting Apache on Unix -only. Windows users should see Signalling -Apache when running.

      - -

      You will notice many httpd executables running on your system, -but you should not send signals to any of them except the parent, whose -pid is in the PidFile. That is to -say you shouldn't ever need to send signals to any process except the -parent. There are three signals that you can send the parent: -TERM, HUP, and USR1, which will -be described in a moment. - -

      To send a signal to the parent you should issue a command such as: -

      -    kill -TERM `cat /usr/local/apache/logs/httpd.pid`
-
      - -You can read about its progress by issuing: - -
      -    tail -f /usr/local/apache/logs/error_log
-
      - -Modify those examples to match your -ServerRoot and -PidFile settings. - -

      As of Apache 1.3 we provide a script src/support/apachectl -which can be used to start, stop, and restart Apache. It may need a -little customization for your system, see the comments at the top of -the script. - -

      TERM Signal: stop now

      - -

      Sending the TERM signal to the parent causes it to -immediately attempt to kill off all of its children. It may take it -several seconds to complete killing off its children. Then the -parent itself exits. Any requests in progress are terminated, and no -further requests are served. - -

      HUP Signal: restart now

      - -

      Sending the HUP signal to the parent causes it to kill off -its children like in TERM but the parent doesn't exit. It -re-reads its configuration files, and re-opens any log files. -Then it spawns a new set of children and continues -serving hits. - -

      Users of the -status module -will notice that the server statistics are -set to zero when a HUP is sent. - -

      Note: If your configuration file has errors in it when -you issue a -restart then your parent will not restart, it will exit with an error. -See below for a method of avoiding this. - -

      USR1 Signal: graceful restart

      - -

      Note: prior to release 1.2b9 this code is quite unstable -and shouldn't be used at all. - -

      The USR1 signal causes the parent process to advise -the children to exit after their current request (or to exit immediately -if they're not serving anything). The parent re-reads its configuration -files and re-opens its log files. As each child dies off the parent -replaces it with a child from the new generation of the -configuration, which begins serving new requests immediately. - -

      This code is designed to always respect the -MaxClients, -MinSpareServers, -and MaxSpareServers settings. -Furthermore, it respects StartServers -in the following manner: if after one second at least StartServers new -children have not been created, then create enough to pick up the slack. -This is to say that the code tries to maintain both the number of children -appropriate for the current load on the server, and respect your wishes -with the StartServers parameter. - -

      Users of the -status module -will notice that the server statistics -are not set to zero when a USR1 is sent. The -code -was written to both minimize the time in which the server is unable to serve -new requests (they will be queued up by the operating system, so they're -not lost in any event) and to respect your tuning parameters. In order -to do this it has to keep the scoreboard used to keep track -of all children across generations. - -

      The status module will also use a G to indicate those -children which are still serving requests started before the graceful -restart was given. - -

      At present there is no way for a log rotation script using -USR1 to know for certain that all children writing the -pre-restart log have finished. We suggest that you use a suitable delay -after sending the USR1 signal before you do anything with the -old log. For example if most of your hits take less than 10 minutes to -complete for users on low bandwidth links then you could wait 15 minutes -before doing anything with the old log. - -

      Note: If your configuration file has errors in it when -you issue a -restart then your parent will not restart, it will exit with an error. -In the case of graceful -restarts it will also leave children running when it exits. (These are -the children which are "gracefully exiting" by handling their last request.) -This will cause problems if you attempt to restart the server -- it will -not be able to bind to its listening ports. Before doing a restart, you -can check the syntax of the configuration files with the -t -command line argument (see Starting -Apache). This still will not guarantee that the server will restart -correctly. To check the semantics of the configuration files as well -as the syntax, you can try starting httpd as a non-root user. If -there are no errors it will attempt to open its sockets and logs and -fail because it's not root (or because the currently running httpd -already has those ports bound). If it fails for any other reason then -it's probably a config file error and the error should be fixed before -issuing the graceful restart. - - -

      Appendix: signals and race conditions

      - -

      Prior to Apache 1.2b9 there were several race conditions -involving the restart and die signals (a simple description of race -condition is: a time-sensitive problem, as in if something happens at just -the wrong time it won't behave as expected). For those architectures that -have the "right" feature set we have eliminated as many as we can. -But it should be noted that there still do exist race conditions on -certain architectures. - -

      Architectures that use an on disk -ScoreBoardFile -have the potential to corrupt their scoreboards. This can result in -the "bind: Address already in use" (after HUP) or -"long lost child came home!" (after USR1). The former is -a fatal error, while the latter just causes the server to lose a scoreboard -slot. So it might be advisable to use graceful restarts, with -an occasional hard restart. These problems are very difficult to work -around, but fortunately most architectures do not require a scoreboard file. -See the ScoreBoardFile documentation for a method to determine if your -architecture uses it. - -

      NEXT and MACHTEN (68k only) have small race -conditions -which can cause a restart/die signal to be lost, but should not cause the -server to do anything otherwise problematic. - - -

      All architectures have a small race condition in each child involving -the second and subsequent requests on a persistent HTTP connection -(KeepAlive). It may exit after reading the request line but before -reading any of the request headers. There is a fix that was discovered -too late to make 1.2. In theory this isn't an issue because the KeepAlive -client has to expect these events because of network latencies and -server timeouts. In practice it doesn't seem to affect anything either --- in a test case the server was restarted twenty times per second and -clients successfully browsed the site without getting broken images or -empty documents. - - - - diff --git a/docs/manual/suexec.html.en b/docs/manual/suexec.html.en deleted file mode 100644 index 3d8623df04e..00000000000 --- a/docs/manual/suexec.html.en +++ /dev/null @@ -1,518 +0,0 @@ - - - -Apache suEXEC Support - - - - - -

      Apache suEXEC Support

      - -

      -

        -
      1. CONTENTS
        2. -
      2. What is suEXEC?
        3. -
      3. Before we begin.
        4. -
      4. suEXEC Security Model.
        5. -
      5. Configuring & Installing suEXEC
        6. -
      6. Enabling & Disabling suEXEC
        7. -
      7. Using suEXEC
        8. -
      8. Debugging suEXEC
        9. -
      9. Beware the Jabberwock: Warnings & - Examples
        10. -
      -

      - -

      What is suEXEC?

      -

      -The suEXEC feature -- introduced in Apache 1.2 -- provides -Apache users the ability to run CGI and SSI -programs under user IDs different from the user ID of the calling web-server. -Normally, when a CGI or SSI program executes, it runs as the same user who is -running the web server. -

      - -

      -Used properly, this feature can reduce considerably the security risks involved -with allowing users to develop and run private CGI or SSI programs. However, -if suEXEC is improperly configured, it can cause any number of problems and -possibly create new holes in your computer's security. If you aren't familiar -with managing setuid root programs and the security issues they present, we -highly recommend that you not consider using suEXEC. -

      - -

      -BACK TO CONTENTS -

      - -

      Before we begin.

      -

      -Before jumping head-first into this document, you should be aware of the -assumptions made on the part of the Apache Group and this document. -

      - -

      -First, it is assumed that you are using a UNIX derivate operating system that -is capable of setuid and setgid operations. -All command examples are given in this regard. Other platforms, if they are -capable of supporting suEXEC, may differ in their configuration. -

      - -

      -Second, it is assumed you are familiar with some basic concepts of your -computer's security and its administration. This involves an understanding -of setuid/setgid operations and the various effects they -may have on your system and its level of security. -

      - -

      -Third, it is assumed that you are using an unmodified -version of suEXEC code. All code for suEXEC has been carefully scrutinized and -tested by the developers as well as numerous beta testers. Every precaution -has been taken to ensure a simple yet solidly safe base of code. Altering this -code can cause unexpected problems and new security risks. It is -highly recommended you not alter the suEXEC code unless you -are well versed in the particulars of security programming and are willing to -share your work with the Apache Group for consideration. -

      - -

      -Fourth, and last, it has been the decision of the Apache Group to -NOT make suEXEC part of the default installation of Apache. -To this end, suEXEC configuration requires of the administrator careful -attention to details. After due consideration has been given to the various -settings for suEXEC, the administrator may install suEXEC through normal -installation methods. The values for these settings need to be carefully -determined and specified by the administrator to properly maintain system -security during the use of suEXEC functionality. It is through this detailed -process that the Apache Group hopes to limit suEXEC installation only to those -who are careful and determined enough to use it. -

      - -

      -Still with us? Yes? Good. Let's move on! -

      - -

      -BACK TO CONTENTS -

      - -

      suEXEC Security Model

      -

      -Before we begin configuring and installing suEXEC, we will first discuss -the security model you are about to implement. By doing so, you may -better understand what exactly is going on inside suEXEC and what precautions -are taken to ensure your system's security. -

      - -

      -suEXEC is based on a setuid "wrapper" program that is -called by the main Apache web server. This wrapper is called when an HTTP -request is made for a CGI or SSI program that the administrator has designated -to run as a userid other than that of the main server. When such a request -is made, Apache provides the suEXEC wrapper with the program's name and the -user and group IDs under which the program is to execute. -

      - -

      -The wrapper then employs the following process to determine success or -failure -- if any one of these conditions fail, the program logs the failure -and exits with an error, otherwise it will continue: -

        -
      1. Was the wrapper called with the proper number of - arguments? -
        - The wrapper will only execute if it is given the proper number of arguments. - The proper argument format is known to the Apache web server. If the - wrapper - is not receiving the proper number of arguments, it is either being hacked, - or - there is something wrong with the suEXEC portion of your Apache binary. -
        -
        2. -
      2. Is the user executing this wrapper a valid user of this - system? -
        - This is to ensure that the user executing the wrapper is truly a user of the - system. -
        -
        3. -
      3. Is this valid user allowed to run the wrapper? -
        - Is this user the user allowed to run this wrapper? Only one user (the - Apache user) is allowed to execute this program. -
        -
        4. -
      4. Does the target program have an unsafe hierarchical - reference? -
        - Does the target program contain a leading '/' or have a '..' backreference? - These are not allowed; the target program must reside within the Apache - webspace. -
        -
        5. -
      5. Is the target user name valid? -
        - Does the target user exist? -
        -
        6. -
      6. Is the target group name valid? -
        - Does the target group exist? -
        -
        7. -
      7. Is the target user NOT superuser? -
        - Presently, suEXEC does not allow 'root' to execute CGI/SSI programs. -
        -
        8. -
      8. Is the target userid ABOVE the minimum ID - number? -
        - The minimum user ID number is specified during configuration. This allows - you - to set the lowest possible userid that will be allowed to execute CGI/SSI - programs. This is useful to block out "system" accounts. -
        -
        9. -
      9. Is the target group NOT the superuser group? -
        - Presently, suEXEC does not allow the 'root' group to execute CGI/SSI - programs. -
        -
        10. -
      10. Is the target groupid ABOVE the minimum ID - number? -
        - The minimum group ID number is specified during configuration. This allows - you - to set the lowest possible groupid that will be allowed to execute CGI/SSI - programs. This is useful to block out "system" groups. -
        -
        11. -
      11. Can the wrapper successfully become the target user and - group? -
        - Here is where the program becomes the target user and group via setuid and - setgid - calls. The group access list is also initialized with all of the groups - of which - the user is a member. -
        -
        12. -
      12. Does the directory in which the program resides exist? -
        - If it doesn't exist, it can't very well contain files. -
        -
        13. -
      13. Is the directory within the Apache webspace? -
        - If the request is for a regular portion of the server, is the requested - directory - within the server's document root? If the request is for a UserDir, is - the requested - directory within the user's document root? -
        -
        14. -
      14. Is the directory NOT writable by anyone else? -
        - We don't want to open up the directory to others; only the owner user - may be able - to alter this directories contents. -
        -
        15. -
      15. Does the target program exist? -
        - If it doesn't exists, it can't very well be executed. -
        -
        16. -
      16. Is the target program NOT writable by anyone - else? -
        - We don't want to give anyone other than the owner the ability to - change the program. -
        -
        17. -
      17. Is the target program NOT setuid or setgid? -
        - We do not want to execute programs that will then change our UID/GID again. -
        -
        18. -
      18. Is the target user/group the same as the program's - user/group? -
        - Is the user the owner of the file? -
        -
        19. -
      19. Can we successfully clean the process environment to - ensure safe operations? -
        - suEXEC cleans the process' environment by establishing a safe - execution PATH (defined - during configuration), as well as only passing through those - variables whose names - are listed in the safe environment list (also created during - configuration). -
        -
        20. -
      20. Can we successfully become the target program and - execute? -
        - Here is where suEXEC ends and the target program begins. -
        -
        21. -
      -

      - -

      -This is the standard operation of the the suEXEC wrapper's security model. -It is somewhat stringent and can impose new limitations and guidelines for -CGI/SSI design, but it was developed carefully step-by-step with security -in mind. -

      - -

      -For more information as to how this security model can limit your possibilities -in regards to server configuration, as well as what security risks can be -avoided with a proper suEXEC setup, see the -"Beware the Jabberwock" -section of this document. -

      - -

      -BACK TO CONTENTS -

      - -

      Configuring & Installing suEXEC

      -

      -Here's where we begin the fun. If you use Apache 1.2 or prefer to configure -Apache 1.3 with the "src/Configure" script you have to edit -the suEXEC header file and install the binary in its proper location -manually. This procedure is described in an -extra document. -The following sections describe the configuration and installation -for Apache 1.3 with the AutoConf-style interface (APACI). -

      - -

      -APACI's suEXEC configuration options
      -

      -
      --enable-suexec -
      This option enables the suEXEC feature which is never installed or - activated by default. At least one --suexec-xxxxx option has to be - provided together with the --enable-suexec option to let APACI - accept your request for using the suEXEC feature. -
      --suexec-caller=UID -
      The username under which - Apache normally runs. - This is the only user allowed to execute this program. -
      --suexec-docroot=DIR -
      Define as the DocumentRoot set for Apache. - This will be the only hierarchy (aside from UserDirs) - that can be used for suEXEC behavior. - The default directory is the --datadir value with - the suffix "/htdocs", e.g. if you configure with - "--datadir=/home/apache" the directory - "/home/apache/htdocs" is used as document root for - the suEXEC wrapper. -
      --suexec-logfile=FILE -
      This defines the filename to which all suEXEC transactions and - errors are logged (useful for auditing and debugging purposes). - By default the logfile is named "suexec_log" and located in your - standard logfile directory (--logfiledir). -
      --suexec-userdir=DIR -
      Define to be the subdirectory under users' - home directories where suEXEC access should - be allowed. All executables under this directory - will be executable by suEXEC as the user so - they should be "safe" programs. If you are - using a "simple" UserDir directive (ie. one - without a "*" in it) this should be set to - the same value. suEXEC will not work properly - in cases where the UserDir directive points to - a location that is not the same as the user's - home directory as referenced in the passwd file. - Default value is "public_html". -
      - If you have virtual hosts with a different - UserDir for each, you will need to define them to - all reside in one parent directory; then name that - parent directory here. If this is not defined - properly, "~userdir" cgi requests will not work! -
      --suexec-uidmin=UID -
      Define this as the lowest UID allowed to be a target user - for suEXEC. For most systems, 500 or 100 is common. - Default value is 100. -
      --suexec-gidmin=GID -
      Define this as the lowest GID allowed to be a target group - for suEXEC. For most systems, 100 is common and therefore - used as default value. -
      --suexec-safepath=PATH -
      Define a safe PATH environment to pass to CGI executables. - Default value is "/usr/local/bin:/usr/bin:/bin". -
      -

      - -

      -Checking your suEXEC setup
      -Before you compile and install the suEXEC wrapper you can check -the configuration with the --layout option. -
      -Example output: -

      -    suEXEC setup:
-            suexec binary: /usr/local/apache/sbin/suexec
-            document root: /usr/local/apache/share/htdocs
-           userdir suffix: public_html
-                  logfile: /usr/local/apache/var/log/suexec_log
-                safe path: /usr/local/bin:/usr/bin:/bin
-                caller ID: www
-          minimum user ID: 100
-         minimum group ID: 100
-
      -

      - -

      -Compiling and installing the suEXEC wrapper
      -If you have enabled the suEXEC feature with the --enable-suexec option -the suexec binary (together with Apache itself) is automatically built -if you execute the command "make". -
      -After all components have been built you can execute the command -"make install" to install them. -The binary image "suexec" is installed in the directory defined by -the --sbindir option. Default location is "/usr/local/apache/sbin/suexec". -
      -Please note that you need root privileges for -the installation step. In order for the wrapper to set the user ID, it -must be installed as owner root and must have the -setuserid execution bit set for file modes. -

      - -

      -BACK TO CONTENTS -

      - -

      Enabling & Disabling suEXEC

      -

      -Upon startup of Apache, it looks for the file "suexec" in the "sbin" -directory (default is "/usr/local/apache/sbin/suexec"). -If Apache finds a properly configured suEXEC wrapper, it will print -the following message to the error log: -

      -    [notice] suEXEC mechanism enabled (wrapper: /path/to/suexec)
-
      -If you don't see this message at server startup, the server is most -likely not finding the wrapper program where it expects it, or the -executable is not installed setuid root. -
      -If you want to enable the suEXEC mechanism for the first time -and an Apache server is already running you must kill and restart Apache. -Restarting it with a simple HUP or USR1 signal will not be enough. -
      -If you want to disable suEXEC you should kill and restart Apache after -you have removed the "suexec" file. -

      - -

      -BACK TO CONTENTS -

      - -

      Using suEXEC

      -

      -Virtual Hosts:
      -One way to use the suEXEC wrapper is through the -User and -Group directives in -VirtualHost -definitions. By setting these directives to values different from the -main server user ID, all requests for CGI resources will be executed as -the User and Group defined for that -<VirtualHost>. If only one or -neither of these directives are specified for a -<VirtualHost> then the main -server userid is assumed. -

      -User directories:
      -The suEXEC wrapper can also be used to execute CGI programs as -the user to which the request is being directed. This is accomplished by -using the "~" character prefixing the user -ID for whom execution is desired. -The only requirement needed for this feature to work is for CGI -execution to be enabled for the user and that the script must meet the -scrutiny of the security checks above. - -

      -BACK TO CONTENTS -

      - -

      Debugging suEXEC

      -

      -The suEXEC wrapper will write log information to the file defined -with the --suexec-logfile option as indicated above. If you feel you have -configured and installed the wrapper properly, have a look at this log -and the error_log for the server to see where you may have gone astray. -

      - -

      -BACK TO CONTENTS -

      - -

      -Beware the Jabberwock: Warnings & Examples -

      -

      -NOTE! This section may not be complete. For the latest -revision of this section of the documentation, see the Apache Group's -Online Documentation -version. -

      - -

      -There are a few points of interest regarding the wrapper that can cause -limitations on server setup. Please review these before submitting any -"bugs" regarding suEXEC. -

        -
      • suEXEC Points Of Interest
        • -
      • Hierarchy limitations -
        - For security and efficiency reasons, all suexec requests must - remain within either a top-level document root for virtual - host requests, or one top-level personal document root for - userdir requests. For example, if you have four VirtualHosts - configured, you would need to structure all of your VHosts' - document roots off of one main Apache document hierarchy to - take advantage of suEXEC for VirtualHosts. (Example forthcoming.) -
        -
        • -
      • suEXEC's PATH environment variable -
        - This can be a dangerous thing to change. Make certain every - path you include in this define is a trusted - directory. You don't want to open people up to having someone - from across the world running a trojan horse on them. -
        -
        • -
      • Altering the suEXEC code -
        - Again, this can cause Big Trouble if you try - this without knowing what you are doing. Stay away from it - if at all possible. -
        -
        • -
      - -

      -BACK TO CONTENTS -

      - - - - diff --git a/docs/manual/upgrading.html.en b/docs/manual/upgrading.html.en deleted file mode 100644 index 990a0649368..00000000000 --- a/docs/manual/upgrading.html.en +++ /dev/null @@ -1,94 +0,0 @@ - - -Upgrading to 2.0 from 1.3 - - - - - -

      Upgrading to 2.0 from 1.3

      - -

      In order to assist folks upgrading, we maintain a document -describing information critical to existing Apache users. These are -intended to be brief notes, and you should be able to find more -information in either the New -Features document, or in the src/CHANGES file. - -

      Compile-Time Configuration Changes

      - -
        -
      • Apache now uses an autoconf and libtool -system for configuring the build processes. Using this system -is similar to, but not the same as, using the APACI system in -Apache 1.3. Further documentation to follow.
        • - -
      • In addition to the usual selection of modules which you can -choose to compile, Apache 2.0 has moved the main part of request -processing into Multi-Processing-Modules (MPMs). Documentation -on how to select an MPM is to follow.
        • -
      - -

      Run-Time Configuration Changes

      - -
        -
      • The CacheNegotiatedDocs directive now takes -the argument on or off. Existing -instances of CacheNegotiatedDocs should be replaced -with CachNegotiatedDocs on.
        • - -
      • The ErrorDocument directive no longer uses a single -quote at the beginning of the argument to indicate a text message. -Instead, you should enclose the message in double quotes. For -example, existing instances of ErrorDocument 403 "Some -Message should be replaced with ErrorDocument 403 "Some -Message". As long as the second argument is not a valid URL or -pathname, it will be treated as a text message.
        • - -
      • The AccessConfig and ResourceConfig -directives no longer exist. Existing instances of these directives -can be replaced with the Include directive which -has equivalent functionality. If you were making use of the -default values of these directives without including them in -the configuration files, you may need to add -Include conf/access.conf and Include conf/srm.conf -to your httpd.conf.
        • - -
      • The ExtendedStatus directive no longer exists.
        • - -
      • The ServerType directive no longer exists.
        • - -
      • The CoreDumpDirectory directive no longer exists.
        • - -
      • Many directives that were in the core server in Apache 1.3 -are now in the MPMs.
        • - - -
      - -

      Misc Changes

      - -
        -
      • The module mod_auth_digest, which was experimental in Apache 1.3 -is now a standard module.
        • - -
      • The mod_mmap_static module, which was experimental in Apache 1.3 -has been replaced with mod_file_cache.
        • - - -
      - -

      Third Party Modules

      - -

      Extensive changes were made to the server API in Apache 2.0. -Existing modules designed for the Apache 1.3 API will not -work in Apache 2.0 without modification. Details to follow. - - - - diff --git a/docs/manual/vhosts/fd-limits.html.en b/docs/manual/vhosts/fd-limits.html.en deleted file mode 100644 index 6b9d0f93c46..00000000000 --- a/docs/manual/vhosts/fd-limits.html.en +++ /dev/null @@ -1,59 +0,0 @@ - - - -Apache Server Virtual Host Support - - - - - -

      File Descriptor Limits

      - -

      -When using a large number of Virtual Hosts, Apache may run out of available -file descriptors (sometimes called file handles if each Virtual -Host specifies different log files. -The total number of file descriptors used by Apache is one for each distinct -error log file, one for every other log file directive, plus 10-20 for -internal use. Unix operating systems limit the number of file descriptors that -may be used by a process; the limit is typically 64, and may usually be -increased up to a large hard-limit. -

      -Although Apache attempts to increase the limit as required, this -may not work if: -

        -
      1. Your system does not provide the setrlimit() system call. -
      2. The setrlimit(RLIMIT_NOFILE) call does not function on your system - (such as Solaris 2.3) -
      3. The number of file descriptors required exceeds the hard limit. -
      4. Your system imposes other limits on file descriptors, such as a limit -on stdio streams only using file descriptors below 256. (Solaris 2) -
      - -In the event of problems you can: -
        -
      • Reduce the number of log files; don't specify log files in the VirtualHost -sections, but only log to the main log files. -
      • If you system falls into 1 or 2 (above), then increase the file descriptor -limit before starting Apache, using a script like -
        -#!/bin/sh
        -ulimit -S -n 100
        -exec httpd
        -
      -

      -Please see the -Descriptors and Apache -document containing further details about file descriptor problems and how -they can be solved on your operating system. -

      - - - - diff --git a/docs/manual/vhosts/index.html.en b/docs/manual/vhosts/index.html.en deleted file mode 100644 index bb4a0f89312..00000000000 --- a/docs/manual/vhosts/index.html.en +++ /dev/null @@ -1,65 +0,0 @@ - - - -Apache Virtual Host documentation - - - - - -

      Apache Virtual Host documentation

      - -

      The term Virtual Host refers to the practice of maintaining -more than one server on one machine, as differentiated by their apparent -hostname. For example, it is often desirable for companies sharing a -web server to have their own domains, with web servers accessible as -www.company1.com and www.company2.com, -without requiring the user to know any extra path information.

      - -

      Apache was one of the first servers to support IP-based -virtual hosts right out of the box. Versions 1.1 and later of -Apache support both, IP-based and name-based virtual hosts (vhosts). -The latter variant of virtual hosts is sometimes also called host-based or -non-IP virtual hosts.

      - -

      Below is a list of documentation pages which explain all details -of virtual host support in Apache version 1.3 and later.

      - -
      - -

      Virtual Host Support

      - - - -

      Configuration directives

      - - - -

      Folks trying to debug their virtual host configuration may find the -Apache -S command line switch useful. It will dump out a -description of how Apache parsed the configuration file. Careful -examination of the IP addresses and server names may help uncover -configuration mistakes. - - - - diff --git a/docs/manual/vhosts/name-based.html.en b/docs/manual/vhosts/name-based.html.en deleted file mode 100644 index 1d834f29893..00000000000 --- a/docs/manual/vhosts/name-based.html.en +++ /dev/null @@ -1,169 +0,0 @@ - - -Apache name-based Virtual Hosts - - - - - -

      Apache name-based Virtual Host Support

      - -See Also: -IP-based Virtual Host Support - -
      - -

      Name-based vs. IP-based virtual hosts

      - -

      Early versions of HTTP (like many other protocols, e.g. FTP) -required a different IP address for each virtual host on the server. -On some platforms this can limit the number of virtual hosts you can -run, and because there are concerns about the availability of IP -addresses it is strongly discouraged by the registraries (ARIN, RIPE, -and APNIC).

      - -

      The HTTP/1.1 protocol, and a common extension to -HTTP/1.0, includes a method for the server to identify -what name it is being addressed as. Apache 1.1 and later support this -approach as well as the old IP-address-per-hostname method.

      - -

      The benefits of using the name-based virtual hosts is a practically -unlimited number of servers, ease of configuration and use, and it -requires no additional hardware or software. The main disadvantage is -that the client must support this part of the protocol. Almost all -browsers do, but there are still tiny numbers of very old browsers in -use which do not. This can cause problems, although a possible -solution is addressed below.

      - -

      Using name-based virtual hosts

      - -

      Using name-based virtual hosts is quite easy, and superficially looks -like the old method. The notable difference between IP-based and -name-based virtual host configuration is the -NameVirtualHost -directive which specifies an IP address that should be used as a -target for name-based virtual hosts, or the wildcard * to -indicate that the server only does name-based virtual hosting (no -IP-based virtual hosting).

      - -

      For example, suppose that both www.domain.tld and -www.otherdomain.tld point at the IP address of your -server. Then you simply add to one of the Apache configuration files -(most likely httpd.conf or srm.conf) code -similar to the following:

      - -
      -    NameVirtualHost *
-
-    <VirtualHost *>
-    ServerName www.domain.tld
-    DocumentRoot /www/domain
-    </VirtualHost>
-
-    <VirtualHost *>
-    ServerName www.otherdomain.tld
-    DocumentRoot /www/otherdomain
-    </VirtualHost>
-
      - -

      Of course, any additional directives can (and should) be placed -into the <VirtualHost> section. To make this work, -all that is needed is to make sure that the names -www.domain.tld and www.otherdomain.tld -are pointing to the right IP address. - -

      Note: When you specify an IP address in a NameVirtualHost -directive then requests to that IP address will only ever be served -by matching <VirtualHost>s. The "main server" will -never be served from the specified IP address. -If you specify a wildcard then the "main server" isn't used at all. -If you start to use virtual hosts you should stop using the "main server" -as an independent server and rather use it as a place for -configuration directives that are common for all your virtual hosts. -In other words, you should add a <VirtualHost> section for -every server (hostname) you want to maintain on your server. - -

      Additionally, many servers may wish to be accessible by more than -one name. For example, the example server might want to be accessible -as domain.tld, or www2.domain.tld, assuming -the IP addresses pointed to the same server. In fact, one might want it -so that all addresses at domain.tld were picked up by the -server. This is possible with the -ServerAlias -directive, placed inside the <VirtualHost> section. For -example:

      - -
      -    ServerAlias domain.tld *.domain.tld
-
      - -

      Note that you can use * and ? as wild-card -characters.

      - -

      You also might need ServerAlias if you are -serving local users who do not always include the domain name. -For example, if local users are -familiar with typing "www" or "www.foobar" then you will need to add -ServerAlias www www.foobar. It isn't possible for the -server to know what domain the client uses for their name resolution -because the client doesn't provide that information in the request. -The ServerAlias directive is generally a way to have different -hostnames pointing to the same virtual host. -

      - -

      Compatibility with Older Browsers

      - -

      As mentioned earlier, there are still some clients in use who -do not send the required data for the name-based virtual hosts to work -properly. These clients will always be sent the pages from the -first virtual host listed for that IP address (the -primary name-based virtual host).

      - -

      There is a possible workaround with the -ServerPath -directive, albeit a slightly cumbersome one:

      - -

      Example configuration: - -

      -    NameVirtualHost 111.22.33.44
-
-    <VirtualHost 111.22.33.44>
-    ServerName www.domain.tld
-    ServerPath /domain
-    DocumentRoot /web/domain
-    </VirtualHost>
-
      - -

      What does this mean? It means that a request for any URI beginning -with "/domain" will be served from the virtual host -www.domain.tld This means that the pages can be accessed as -http://www.domain.tld/domain/ for all clients, although -clients sending a Host: header can also access it as -http://www.domain.tld/.

      - -

      In order to make this work, put a link on your primary virtual host's page -to http://www.domain.tld/domain/ -Then, in the virtual host's pages, be sure to use either purely -relative links (e.g., "file.html" or -"../icons/image.gif" or links containing the prefacing -/domain/ -(e.g., "http://www.domain.tld/domain/misc/file.html" or -"/domain/misc/file.html").

      - -

      This requires a bit of -discipline, but adherence to these guidelines will, for the most part, -ensure that your pages will work with all browsers, new and old.

      - -

      See also: ServerPath configuration -example

      - - - - diff --git a/httpd.dsp b/httpd.dsp deleted file mode 100644 index bbf11f72d5e..00000000000 --- a/httpd.dsp +++ /dev/null @@ -1,553 +0,0 @@ -# Microsoft Developer Studio Project File - Name="ApacheCore" - Package Owner=<4> -# Microsoft Developer Studio Generated Build File, Format Version 6.00 -# ** DO NOT EDIT ** - -# TARGTYPE "Win32 (x86) Static Library" 0x0104 - -CFG=ApacheCore - Win32 Debug -!MESSAGE This is not a valid makefile. To build this project using NMAKE, -!MESSAGE use the Export Makefile command and run -!MESSAGE -!MESSAGE NMAKE /f "ApacheCore.mak". -!MESSAGE -!MESSAGE You can specify a configuration when running NMAKE -!MESSAGE by defining the macro CFG on the command line. For example: -!MESSAGE -!MESSAGE NMAKE /f "ApacheCore.mak" CFG="ApacheCore - Win32 Debug" -!MESSAGE -!MESSAGE Possible choices for configuration are: -!MESSAGE -!MESSAGE "ApacheCore - Win32 Release" (based on "Win32 (x86) Static Library") -!MESSAGE "ApacheCore - Win32 Debug" (based on "Win32 (x86) Static Library") -!MESSAGE - -# Begin Project -# PROP AllowPerConfigDependencies 0 -# PROP Scc_ProjName "" -# PROP Scc_LocalPath "" -CPP=cl.exe - -!IF "$(CFG)" == "ApacheCore - Win32 Release" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 0 -# PROP BASE Output_Dir "LibR" -# PROP BASE Intermediate_Dir "LibR" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 0 -# PROP Output_Dir "LibR" -# PROP Intermediate_Dir "LibR" -# PROP Target_Dir "" -RSC=rc.exe -# ADD BASE RSC /l 0x409 -# ADD RSC /l 0x409 -# ADD BASE CPP /nologo /MD /W3 /GX /O2 /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -# ADD CPP /nologo /MD /W3 /GX /O2 /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /I ".\modules\mpm\winnt" /I ".\lib\expat-lite" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LIB32=link.exe -lib -# ADD BASE LIB32 /nologo -# ADD LIB32 /nologo - -!ELSEIF "$(CFG)" == "ApacheCore - Win32 Debug" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 1 -# PROP BASE Output_Dir "LibD" -# PROP BASE Intermediate_Dir "LibD" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 1 -# PROP Output_Dir "LibD" -# PROP Intermediate_Dir "LibD" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -RSC=rc.exe -# ADD BASE RSC /l 0x409 -# ADD RSC /l 0x409 -# ADD BASE CPP /nologo /MDd /W3 /GX /ZI /Od /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -# ADD CPP /nologo /MDd /W3 /GX /ZI /Od /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /I ".\modules\mpm\winnt" /I ".\lib\expat-lite" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LIB32=link.exe -lib -# ADD BASE LIB32 /nologo -# ADD LIB32 /nologo - -!ENDIF - -# Begin Target - -# Name "ApacheCore - Win32 Release" -# Name "ApacheCore - Win32 Debug" -# Begin Group "Configuration" - -# PROP Default_Filter "cpp;c;cxx;rc;def;r;odl;hpj;bat;for;f90" -# Begin Source File - -SOURCE=.\include\ap_config.h -# End Source File -# Begin Source File - -SOURCE=.\include\ap_mmn.h -# End Source File -# Begin Source File - -SOURCE=.\ApacheCore.def -# PROP Exclude_From_Build 1 -# End Source File -# Begin Source File - -SOURCE=.\buildmark.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_conf_globals.h -# End Source File -# Begin Source File - -SOURCE=.\os\win32\modules.c -# End Source File -# Begin Source File - -SOURCE=.\os\win32\os.h -# End Source File -# End Group -# Begin Group "Generated Files" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\main\gen_test_char.exe - -!IF "$(CFG)" == "ApacheCore - Win32 Release" - -# Begin Custom Build - Generating test_char.h -InputPath=.\main\gen_test_char.exe - -".\main\test_char.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)" - .\main\gen_test_char.exe >.\main\test_char.h - echo Generated test_char.h from gen_test_char.exe - -# End Custom Build - -!ELSEIF "$(CFG)" == "ApacheCore - Win32 Debug" - -# Begin Custom Build - Generating test_char.h -InputPath=.\main\gen_test_char.exe - -".\main\test_char.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)" - .\main\gen_test_char.exe >.\main\test_char.h - echo Generated test_char.h from gen_test_char.exe - -# End Custom Build - -!ENDIF - -# End Source File -# Begin Source File - -SOURCE=.\main\gen_uri_delims.exe - -!IF "$(CFG)" == "ApacheCore - Win32 Release" - -# Begin Custom Build - Generating uri_delims.h -InputPath=.\main\gen_uri_delims.exe - -".\main\uri_delims.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)" - .\main\gen_uri_delims.exe >.\main\uri_delims.h - echo Generated uri_delims.h from gen_uri_delims.exe - -# End Custom Build - -!ELSEIF "$(CFG)" == "ApacheCore - Win32 Debug" - -# Begin Custom Build - Generating uri_delims.h -InputPath=.\main\gen_uri_delims.exe - -".\main\uri_delims.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)" - .\main\gen_uri_delims.exe >.\main\uri_delims.h - echo Generated uri_delims.h from gen_uri_delims.exe - -# End Custom Build - -!ENDIF - -# End Source File -# Begin Source File - -SOURCE=.\main\test_char.h -# End Source File -# Begin Source File - -SOURCE=.\main\uri_delims.h -# End Source File -# End Group -# Begin Group "ap_buckets" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\ap\ap_buckets.c -# End Source File -# Begin Source File - -SOURCE=.\include\ap_buckets.h -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_eos.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_file.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_flush.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_heap.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_pipe.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_pool.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_refcount.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_simple.c -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_buckets_socket.c -# End Source File -# End Group -# Begin Group "ap_general" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\ap\ap_base64.c -# End Source File -# Begin Source File - -SOURCE=.\include\ap_base64.h -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_hooks.c -# End Source File -# Begin Source File - -SOURCE=.\include\ap_hooks.h -# End Source File -# Begin Source File - -SOURCE=.\include\ap_ring.h -# End Source File -# Begin Source File - -SOURCE=.\ap\ap_sha1.c -# End Source File -# Begin Source File - -SOURCE=.\include\ap_sha1.h -# End Source File -# End Group -# Begin Group "httpd" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\main\http_config.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_config.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_connection.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_connection.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_core.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_core.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_log.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_log.h -# End Source File -# Begin Source File - -SOURCE=.\include\http_main.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_protocol.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_protocol.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_request.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_request.h -# End Source File -# Begin Source File - -SOURCE=.\main\http_vhost.c -# End Source File -# Begin Source File - -SOURCE=.\include\http_vhost.h -# End Source File -# Begin Source File - -SOURCE=.\include\httpd.h -# End Source File -# End Group -# Begin Group "modules" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\modules\standard\mod_access.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_actions.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_alias.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_asis.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_auth.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_autoindex.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_cgi.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_dir.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_env.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_imap.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_include.c -# End Source File -# Begin Source File - -SOURCE=.\os\win32\mod_isapi.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_log_config.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_mime.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_negotiation.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_setenvif.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_so.c -# End Source File -# Begin Source File - -SOURCE=.\modules\standard\mod_userdir.c -# End Source File -# End Group -# Begin Group "util" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\main\buff.c -# End Source File -# Begin Source File - -SOURCE=.\include\buff.h -# End Source File -# Begin Source File - -SOURCE=.\main\rfc1413.c -# End Source File -# Begin Source File - -SOURCE=.\include\rfc1413.h -# End Source File -# Begin Source File - -SOURCE=.\main\util.c -# End Source File -# Begin Source File - -SOURCE=.\main\util_cfgtree.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_cfgtree.h -# End Source File -# Begin Source File - -SOURCE=.\include\util_charset.h -# End Source File -# Begin Source File - -SOURCE=.\main\util_date.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_date.h -# End Source File -# Begin Source File - -SOURCE=.\include\util_ebcdic.h -# End Source File -# Begin Source File - -SOURCE=.\main\util_filter.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_filter.h -# End Source File -# Begin Source File - -SOURCE=.\main\util_md5.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_md5.h -# End Source File -# Begin Source File - -SOURCE=.\main\util_script.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_script.h -# End Source File -# Begin Source File - -SOURCE=.\main\util_uri.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_uri.h -# End Source File -# Begin Source File - -SOURCE=.\os\win32\util_win32.c -# End Source File -# Begin Source File - -SOURCE=.\main\util_xml.c -# End Source File -# Begin Source File - -SOURCE=.\include\util_xml.h -# End Source File -# End Group -# Begin Group "mpm_winnt" - -# PROP Default_Filter "" -# Begin Source File - -SOURCE=.\include\ap_listen.h -# End Source File -# Begin Source File - -SOURCE=.\include\ap_mpm.h -# End Source File -# Begin Source File - -SOURCE=.\main\listen.c -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\mpm.h -# End Source File -# Begin Source File - -SOURCE=.\include\mpm_common.h -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\mpm_default.h -# End Source File -# Begin Source File - -SOURCE=.\include\mpm_status.h -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\mpm_winnt.c -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\mpm_winnt.h -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\registry.c -# End Source File -# Begin Source File - -SOURCE=.\modules\mpm\winnt\service.c -# End Source File -# End Group -# End Target -# End Project diff --git a/libhttpd.def b/libhttpd.def deleted file mode 100644 index 0d2eb756859..00000000000 --- a/libhttpd.def +++ /dev/null @@ -1,440 +0,0 @@ -; apachecore.def : - -LIBRARY ApacheCore -DESCRIPTION '' - -EXPORTS - ; Add new API calls to the end of this list. - - - - - ap_add_cgi_vars - ap_add_common_vars - ap_add_loaded_module - ap_add_module - ap_add_named_module - ap_add_per_dir_conf - ap_add_per_url_conf - ap_add_version_component - ap_allow_options - ap_allow_overrides - - - ap_auth_name - ap_auth_type - ap_basic_http_header - ap_bclose - ap_bcreate - ap_bfilbuf - - ap_bflsbuf - ap_bflush - ap_bgetopt - ap_bgets - - - ap_blookc - - ap_bonerror - - - ap_bputs - - ap_bsetflag - ap_bsetopt - - - - - - - - ap_cfg_closefile - ap_cfg_getc - ap_cfg_getline - ap_chdir_file - - ap_check_cmd_context - ap_checkmask - - ap_clear_module_list - - - ap_close_piped_log - ap_construct_server - ap_construct_url - ap_content_type_tolower - - - ap_core_translate - ap_count_dirs - - ap_create_environment - - ap_create_per_dir_config - ap_custom_response - ap_default_port_for_request - ap_default_port_for_scheme - ap_default_type - - - ap_destroy_sub_req - ap_die - ap_discard_request_body - ap_document_root - - ap_error_log2stderr - ap_escape_html - ap_escape_path_segment - ap_escape_quotes - ap_escape_shell_cmd - - ap_finalize_request_protocol - ap_find_command - ap_find_command_in_modules - ap_find_last_token - ap_find_linked_module - ap_find_module_name - ap_find_path_info - ap_find_token - ap_get_basic_auth_pw - ap_get_client_block - - ap_get_limit_req_body - ap_get_remote_host - ap_get_remote_logname - ap_get_server_built - ap_get_server_name - ap_get_server_port - ap_get_server_version - - ap_get_token - ap_getparents - ap_getword - ap_getword_conf - ap_getword_conf_nc - ap_getword_nc - ap_getword_nulls - ap_getword_nulls_nc - ap_getword_white - ap_getword_white_nc - - ap_gname2id - - - ap_ht_time - ap_ind - ap_index_of_response - ap_init_virtual_host - ap_internal_redirect - ap_internal_redirect_handler - ap_is_directory - - ap_is_initial_req - ap_is_matchexp - ap_is_url - - - - - ap_log_assert - - - - - - ap_make_dirstr_parent - ap_make_dirstr_prefix - ap_make_full_path - - - ap_matches_request_vhost - ap_md5 - ap_md5_binary - ap_md5contextTo64 - ap_md5digest - ap_meets_conditions - ap_no2slash - ap_note_auth_failure - ap_note_basic_auth_failure - - - - - ap_note_digest_auth_failure - - - ap_open_piped_log - ap_os_canonical_filename - ap_os_case_canonical_filename - ap_os_escape_path - - - ap_parseHTTPdate - ap_parse_hostinfo_components - ap_parse_uri - ap_parse_uri_components - - ap_pcfg_open_custom - ap_pcfg_openfile - - - - - ap_pduphostent - - - - ap_pgethostbyname - - - ap_pregcomp - ap_pregfree - ap_pregsub - ap_psignature - - - - - - ap_rationalize_mtime - - - ap_remove_loaded_module - ap_remove_module - ap_requires - - ap_rflush - ap_rind - ap_rputc - ap_rputs - - ap_run_sub_req - ap_rwrite - ap_satisfies - ap_scan_script_header_err - - ap_scan_script_header_err_core - ap_scan_script_header_err_strs - - ap_send_fd - - ap_send_http_header - ap_send_http_trace - - ap_send_size - ap_server_root_relative - - ap_set_content_length - ap_set_etag - ap_set_keepalive - ap_set_last_modified - ap_setup_client_block - ap_should_client_block - - ap_some_auth_required - - - ap_str_tolower - ap_strcasecmp_match - ap_strcmp_match - ap_sub_req_lookup_file - ap_sub_req_lookup_uri - - - - - - - - - - - ap_uname2id - - ap_unescape_url - ap_unparse_uri_components - ap_update_mtime - - - ap_vbprintf - - - - - - - - - regcomp - regexec - regfree - access_module - alias_module - ap_bprintf - ap_bputstrs - - - ap_limit_section - ap_loaded_modules - ap_log_error - - ap_log_rerror - - - - - - ap_rprintf - ap_rvputs - - - ap_server_argv0 - ap_server_root - ap_set_file_slot - ap_set_flag_slot - ap_set_string_slot - ap_set_string_slot_lower - - - - - asis_module - auth_module - autoindex_module - - config_log_module - core_module - dir_module - env_module - imap_module - - mime_module - negotiation_module - - setenvif_module - - top_module - - ap_method_number_of - ap_exists_config_define - ap_single_module_configure - ap_make_etag - - - ap_find_list_item - - - ap_size_list_item - ap_get_list_item - - ap_get_status_line - - - - - - - - - - - - ap_sub_req_method_uri - ap_regerror - ap_regexec - ap_field_noparam - ap_pbase64decode - ap_pbase64encode - ap_base64encode - ap_base64encode_binary - ap_base64encode_len - ap_base64decode - ap_base64decode_binary - ap_base64decode_len - ap_SHA1Init - ap_SHA1Update_binary - ap_SHA1Update - ap_SHA1Final - ap_sha1_base64 - ap_show_hook - ap_hook_sort_register - ap_hook_process_connection - ap_process_http_connection - ap_hook_check_user_id - ap_hook_auth_checker - ap_hook_fixups - regerror - ap_send_error_response - ap_start_shutdown - - ap_read_config - ap_server_pre_read_config - ap_server_post_read_config - ap_setup_prelinked_modules - - - - - ap_debug_module_hooks - ap_debug_module_name - ap_global_hook_pool - ap_hook_pre_connection - ap_hook_post_read_request - ap_hook_log_transaction - ap_hook_http_method - ap_hook_default_port - ap_hook_translate_name - ap_hook_type_checker - ap_hook_access_checker - ap_hook_header_parser - ap_hook_post_config - ap_hook_open_logs - ap_hook_child_init - - ap_get_status_table - ap_run_default_port - ap_run_http_method - ap_bread_core - ap_bwrite_core - ap_vbputstrs - -; Exclusively provided for http_main.c - ap_register_hooks - ap_prelinked_modules - ap_preloaded_modules - ap_post_config_hook - ap_run_pre_config - ap_run_rewrite_args - ap_show_directives - ap_show_modules - ap_util_uri_init - ap_mpm_run - ap_hook_deregister_all - ap_run_open_logs - ap_process_config_tree - ap_server_config_defines - ap_sort_hooks - ap_fini_vhost_config - ap_fixup_virtual_hosts - ap_conftree - -; -; util_xml.h - ap_text_append - ap_xml_parse_input - ap_xml_to_text - ap_xml_empty_elem - ap_xml_quote_string - ap_xml_quote_elem - ap_xml_insert_uri -; -; buckets - ap_bucket_create_transient - ap_bucket_split_shared - ap_bucket_make_shared - ap_bucket_destroy_shared - ap_bucket_create_pool - - ap_os_create_privileged_process diff --git a/libhttpd.dsp b/libhttpd.dsp deleted file mode 100644 index 78c38706033..00000000000 --- a/libhttpd.dsp +++ /dev/null @@ -1,100 +0,0 @@ -# Microsoft Developer Studio Project File - Name="ApacheCoreDll" - Package Owner=<4> -# Microsoft Developer Studio Generated Build File, Format Version 6.00 -# ** DO NOT EDIT ** - -# TARGTYPE "Win32 (x86) Dynamic-Link Library" 0x0102 - -CFG=ApacheCoreDll - Win32 Release -!MESSAGE This is not a valid makefile. To build this project using NMAKE, -!MESSAGE use the Export Makefile command and run -!MESSAGE -!MESSAGE NMAKE /f "ApacheCoreDll.mak". -!MESSAGE -!MESSAGE You can specify a configuration when running NMAKE -!MESSAGE by defining the macro CFG on the command line. For example: -!MESSAGE -!MESSAGE NMAKE /f "ApacheCoreDll.mak" CFG="ApacheCoreDll - Win32 Release" -!MESSAGE -!MESSAGE Possible choices for configuration are: -!MESSAGE -!MESSAGE "ApacheCoreDll - Win32 Release" (based on "Win32 (x86) Dynamic-Link Library") -!MESSAGE "ApacheCoreDll - Win32 Debug" (based on "Win32 (x86) Dynamic-Link Library") -!MESSAGE - -# Begin Project -# PROP AllowPerConfigDependencies 0 -# PROP Scc_ProjName "" -# PROP Scc_LocalPath "" -CPP=cl.exe -MTL=midl.exe -RSC=rc.exe - -!IF "$(CFG)" == "ApacheCoreDll - Win32 Release" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 0 -# PROP BASE Output_Dir ".\CoreR" -# PROP BASE Intermediate_Dir ".\CoreR" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 0 -# PROP Output_Dir ".\CoreR" -# PROP Intermediate_Dir ".\CoreR" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /MD /W3 /GX /O2 /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -# ADD CPP /nologo /MD /W3 /GX /O2 /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "NDEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /c -# ADD BASE MTL /nologo /D "NDEBUG" /win32 -# ADD MTL /nologo /D "NDEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0x809 /d "NDEBUG" -# ADD RSC /l 0x809 /d "NDEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 kernel32.lib user32.lib advapi32.lib ws2_32.lib mswsock.lib /nologo /subsystem:windows /dll /map /machine:I386 /base:@"os\win32\BaseAddr.ref",ApacheCore -# ADD LINK32 kernel32.lib user32.lib advapi32.lib ws2_32.lib mswsock.lib /nologo /subsystem:windows /dll /map /machine:I386 /out:".\CoreR/ApacheCore.dll" /base:@"os\win32\BaseAddr.ref",ApacheCore - -!ELSEIF "$(CFG)" == "ApacheCoreDll - Win32 Debug" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 1 -# PROP BASE Output_Dir ".\CoreD" -# PROP BASE Intermediate_Dir ".\CoreD" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 1 -# PROP Output_Dir ".\CoreD" -# PROP Intermediate_Dir ".\CoreD" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /MDd /W3 /GX /Od /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "_DEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /ZI /c -# ADD CPP /nologo /MDd /W3 /GX /Od /I ".\include" /I ".\lib\apr\include" /I ".\os\win32" /D "_DEBUG" /D "WIN32" /D "_WINDOWS" /D "AP_DECLARE_EXPORT" /FD /ZI /c -# SUBTRACT CPP /YX -# ADD BASE MTL /nologo /D "_DEBUG" /win32 -# ADD MTL /nologo /D "_DEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0x809 /d "_DEBUG" -# ADD RSC /l 0x809 /d "_DEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 kernel32.lib user32.lib advapi32.lib ws2_32.lib mswsock.lib /nologo /subsystem:windows /dll /map /debug /machine:I386 /base:@"os\win32\BaseAddr.ref",ApacheCore -# ADD LINK32 kernel32.lib user32.lib advapi32.lib ws2_32.lib mswsock.lib /nologo /subsystem:windows /dll /map /debug /machine:I386 /out:".\CoreD/ApacheCore.dll" /base:@"os\win32\BaseAddr.ref",ApacheCore - -!ENDIF - -# Begin Target - -# Name "ApacheCoreDll - Win32 Release" -# Name "ApacheCoreDll - Win32 Debug" -# Begin Source File - -SOURCE=.\os\win32\ApacheCore.c -# End Source File -# Begin Source File - -SOURCE=.\ApacheCore.def -# End Source File -# End Target -# End Project diff --git a/modules/arch/win32/mod_isapi.c b/modules/arch/win32/mod_isapi.c deleted file mode 100644 index bc2f3b9ab45..00000000000 --- a/modules/arch/win32/mod_isapi.c +++ /dev/null @@ -1,1294 +0,0 @@ -/* ==================================================================== - * The Apache Software License, Version 1.1 - * - * Copyright (c) 2000 The Apache Software Foundation. All rights - * reserved. - * - * 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 - * . - * - * Portions of this software are based upon public domain software - * originally written at the National Center for Supercomputing Applications, - * University of Illinois, Urbana-Champaign. - */ - -/* - * mod_isapi.c - Internet Server Application (ISA) module for Apache - * by Alexei Kosut - * - * This module implements Microsoft's ISAPI, allowing Apache (when running - * under Windows) to load Internet Server Applications (ISAPI extensions). - * It implements all of the ISAPI 2.0 specification, except for the - * "Microsoft-only" extensions dealing with asynchronous I/O. All ISAPI - * extensions that use only synchronous I/O and are compatible with the - * ISAPI 2.0 specification should work (most ISAPI 1.0 extensions should - * function as well). - * - * To load, simply place the ISA in a location in the document tree. - * Then add an "AddHandler isapi-isa dll" into your config file. - * You should now be able to load ISAPI DLLs just be reffering to their - * URLs. Make sure the ExecCGI option is active in the directory - * the ISA is in. - */ - -#include "apr_strings.h" -#include "apr_portable.h" -#include "ap_buckets.h" -#include "ap_config.h" -#include "httpd.h" -#include "http_config.h" -#include "http_core.h" -#include "http_protocol.h" -#include "http_request.h" -#include "http_log.h" -#include "util_script.h" - - -/* We use the exact same header file as the original */ -#include - -#if !defined(HSE_REQ_MAP_URL_TO_PATH_EX) \ - || !defined(HSE_REQ_SEND_RESPONSE_HEADER_EX) -#pragma message("WARNING: This build of Apache is missing the recent changes") -#pragma message("in the Microsoft Win32 Platform SDK; some mod_isapi features") -#pragma message("will be disabled. To obtain the latest Platform SDK files,") -#pragma message("please refer to:") -#pragma message("http://msdn.microsoft.com/downloads/sdks/platform/platform.asp") -#endif - -/* TODO: Unknown errors that must be researched for correct codes */ - -#define TODO_ERROR 1 - -/* Seems IIS does not enforce the requirement for \r\n termination on HSE_REQ_SEND_RESPONSE_HEADER, - define this to conform */ -#define RELAX_HEADER_RULE - -module isapi_module; - -/* Declare the ISAPI functions */ - -BOOL WINAPI GetServerVariable (HCONN hConn, LPSTR lpszVariableName, - LPVOID lpvBuffer, LPDWORD lpdwSizeofBuffer); -BOOL WINAPI WriteClient (HCONN ConnID, LPVOID Buffer, LPDWORD lpwdwBytes, - DWORD dwReserved); -BOOL WINAPI ReadClient (HCONN ConnID, LPVOID lpvBuffer, LPDWORD lpdwSize); -BOOL WINAPI ServerSupportFunction (HCONN hConn, DWORD dwHSERequest, - LPVOID lpvBuffer, LPDWORD lpdwSize, - LPDWORD lpdwDataType); - -/* - The optimiser blows it totally here. What happens is that autos are addressed relative to the - stack pointer, which, of course, moves around. The optimiser seems to lose track of it somewhere - between setting HttpExtensionProc's address and calling through it. We work around the problem by - forcing it to use frame pointers. - - The revisions below may eliminate this artifact. -*/ -#pragma optimize("y",off) - -/* Our isapi server config structure */ - -typedef struct { - HANDLE lock; - apr_array_header_t *loaded; - DWORD ReadAheadBuffer; - int LogNotSupported; - int AppendLogToErrors; - int AppendLogToQuery; -} isapi_server_conf; - -/* Our loaded isapi module description structure */ - -typedef struct { - const char *filename; - apr_dso_handle_t *handle; - HSE_VERSION_INFO *pVer; - PFN_GETEXTENSIONVERSION GetExtensionVersion; - PFN_HTTPEXTENSIONPROC HttpExtensionProc; - PFN_TERMINATEEXTENSION TerminateExtension; - int refcount; - DWORD timeout; - BOOL fakeasync; - DWORD reportversion; -} isapi_loaded; - -/* Our "Connection ID" structure */ - -typedef struct { - LPEXTENSION_CONTROL_BLOCK ecb; - isapi_server_conf *sconf; - isapi_loaded *isa; - request_rec *r; - PFN_HSE_IO_COMPLETION completion; - PVOID completion_arg; - HANDLE complete; -} isapi_cid; - -static BOOL isapi_unload(isapi_loaded* isa, int force); - -static apr_status_t cleanup_isapi_server_config(void *sconfv) -{ - isapi_server_conf *sconf = sconfv; - size_t n; - isapi_loaded **isa; - - n = sconf->loaded->nelts; - isa = (isapi_loaded **)sconf->loaded->elts; - while(n--) { - if ((*isa)->handle) - isapi_unload(*isa, TRUE); - ++isa; - } - CloseHandle(sconf->lock); - return APR_SUCCESS; -} - -static void *create_isapi_server_config(apr_pool_t *p, server_rec *s) -{ - isapi_server_conf *sconf = apr_palloc(p, sizeof(isapi_server_conf)); - sconf->loaded = apr_make_array(p, 20, sizeof(isapi_loaded*)); - sconf->lock = CreateMutex(NULL, FALSE, NULL); - - sconf->ReadAheadBuffer = 49152; - sconf->LogNotSupported = -1; - sconf->AppendLogToErrors = 0; - sconf->AppendLogToQuery = 0; - - apr_register_cleanup(p, sconf, cleanup_isapi_server_config, - apr_null_cleanup); - - return sconf; -} - -static int compare_loaded(const void *av, const void *bv) -{ - const isapi_loaded **a = av; - const isapi_loaded **b = bv; - - return strcmp((*a)->filename, (*b)->filename); -} - -static void isapi_post_config(apr_pool_t *p, apr_pool_t *plog, - apr_pool_t *ptemp, server_rec *s) -{ - isapi_server_conf *sconf = ap_get_module_config(s->module_config, - &isapi_module); - isapi_loaded **elts = (isapi_loaded **)sconf->loaded->elts; - int nelts = sconf->loaded->nelts; - - /* sort the elements of the main_server, by filename */ - qsort(elts, nelts, sizeof(isapi_loaded*), compare_loaded); - - /* and make the virtualhosts share the same thing */ - for (s = s->next; s; s = s->next) { - ap_set_module_config(s->module_config, &isapi_module, sconf); - } -} - -static apr_status_t isapi_load(apr_pool_t *p, isapi_server_conf *sconf, - request_rec *r, const char *fpath, - isapi_loaded** isa) -{ - isapi_loaded **found = (isapi_loaded **)sconf->loaded->elts; - apr_status_t rv; - int n; - - for (n = 0; n < sconf->loaded->nelts; ++n) { - if (strcasecmp(fpath, (*found)->filename) == 0) { - break; - } - ++found; - } - - if (n < sconf->loaded->nelts) - { - *isa = *found; - if ((*isa)->handle) - { - ++(*isa)->refcount; - return APR_SUCCESS; - } - /* Otherwise we fall through and have to reload the resource - * into this existing mod_isapi cache bucket. - */ - } - else - { - *isa = apr_pcalloc(p, sizeof(isapi_module)); - (*isa)->filename = fpath; - (*isa)->pVer = apr_pcalloc(p, sizeof(HSE_VERSION_INFO)); - - /* TODO: These need to become overrideable, so that we - * assure a given isapi can be fooled into behaving well. - */ - (*isa)->timeout = INFINITE; /* microsecs */ - (*isa)->fakeasync = TRUE; - (*isa)->reportversion = MAKELONG(0, 5); /* Revision 5.0 */ - } - - rv = apr_dso_load(&(*isa)->handle, fpath, p); - if (rv) - { - ap_log_rerror(APLOG_MARK, APLOG_ALERT, rv, r, - "ISAPI %s failed to load", fpath); - (*isa)->handle = NULL; - return rv; - } - - rv = apr_dso_sym((void**)&(*isa)->GetExtensionVersion, (*isa)->handle, - "GetExtensionVersion"); - if (rv) - { - ap_log_rerror(APLOG_MARK, APLOG_ALERT, rv, r, - "ISAPI %s is missing GetExtensionVersion()", - fpath); - apr_dso_unload((*isa)->handle); - (*isa)->handle = NULL; - return rv; - } - - rv = apr_dso_sym((void**)&(*isa)->HttpExtensionProc, (*isa)->handle, - "HttpExtensionProc"); - if (rv) - { - ap_log_rerror(APLOG_MARK, APLOG_ALERT, rv, r, - "ISAPI %s is missing HttpExtensionProc()", - fpath); - apr_dso_unload((*isa)->handle); - (*isa)->handle = NULL; - return rv; - } - - /* TerminateExtension() is an optional interface */ - rv = apr_dso_sym((void**)&(*isa)->TerminateExtension, (*isa)->handle, - "TerminateExtension"); - SetLastError(0); - - /* Run GetExtensionVersion() */ - if (!((*isa)->GetExtensionVersion)((*isa)->pVer)) { - apr_status_t rv = apr_get_os_error(); - ap_log_rerror(APLOG_MARK, APLOG_ALERT, rv, r, - "ISAPI %s call GetExtensionVersion() failed", - fpath); - apr_dso_unload((*isa)->handle); - (*isa)->handle = NULL; - return rv; - } - - ++(*isa)->refcount; - - return APR_SUCCESS; -} - -static int isapi_unload(isapi_loaded* isa, int force) -{ - /* All done with the DLL... get rid of it... - * - * If optionally cached, pass HSE_TERM_ADVISORY_UNLOAD, - * and if it returns TRUE, unload, otherwise, cache it. - */ - if ((--isa->refcount > 0) && !force) - return FALSE; - if (isa->TerminateExtension) { - if (force) - (*isa->TerminateExtension)(HSE_TERM_MUST_UNLOAD); - else if (!(*isa->TerminateExtension)(HSE_TERM_ADVISORY_UNLOAD)) - return FALSE; - } - apr_dso_unload(isa->handle); - isa->handle = NULL; - return TRUE; -} - -apr_status_t isapi_handler (request_rec *r) -{ - isapi_server_conf *sconf = ap_get_module_config(r->server->module_config, - &isapi_module); - apr_table_t *e = r->subprocess_env; - apr_status_t rv; - isapi_loaded *isa; - isapi_cid *cid; - DWORD read; - int res; - - /* Use similar restrictions as CGIs - * - * If this fails, it's pointless to load the isapi dll. - */ - if (!(ap_allow_options(r) & OPT_EXECCGI)) - return HTTP_FORBIDDEN; - - if (r->finfo.filetype == APR_NOFILE) - return HTTP_NOT_FOUND; - - if (r->finfo.filetype != APR_REG) - return HTTP_FORBIDDEN; - - /* Load the isapi extention without caching (sconf == NULL) - * but note that we will recover an existing cached module. - */ - if (isapi_load(r->pool, sconf, r, r->filename, &isa) != APR_SUCCESS) - return HTTP_INTERNAL_SERVER_ERROR; - - /* Set up variables */ - ap_add_common_vars(r); - ap_add_cgi_vars(r); - apr_table_setn(r->subprocess_env, "UNMAPPED_REMOTE_USER", "REMOTE_USER"); - apr_table_setn(r->subprocess_env, "SERVER_PORT_SECURE", "0"); - apr_table_setn(r->subprocess_env, "URL", r->uri); - - /* Set up connection structure and ecb */ - cid = apr_pcalloc(r->pool, sizeof(isapi_cid)); - cid->sconf = ap_get_module_config(r->server->module_config, &isapi_module); - - cid->ecb = apr_pcalloc(r->pool, sizeof(struct _EXTENSION_CONTROL_BLOCK)); - cid->ecb->ConnID = (HCONN)cid; - cid->isa = isa; - cid->r = r; - cid->r->status = 0; - cid->complete = NULL; - cid->completion = NULL; - - cid->ecb->cbSize = sizeof(EXTENSION_CONTROL_BLOCK); - cid->ecb->dwVersion = isa->reportversion; - cid->ecb->dwHttpStatusCode = 0; - strcpy(cid->ecb->lpszLogData, ""); - // TODO: are copies really needed here? - cid->ecb->lpszMethod = apr_pstrdup(r->pool, (char*) r->method); - cid->ecb->lpszQueryString = apr_pstrdup(r->pool, - (char*) apr_table_get(e, "QUERY_STRING")); - cid->ecb->lpszPathInfo = apr_pstrdup(r->pool, - (char*) apr_table_get(e, "PATH_INFO")); - cid->ecb->lpszPathTranslated = apr_pstrdup(r->pool, - (char*) apr_table_get(e, "PATH_TRANSLATED")); - cid->ecb->lpszContentType = apr_pstrdup(r->pool, - (char*) apr_table_get(e, "CONTENT_TYPE")); - /* Set up the callbacks */ - cid->ecb->GetServerVariable = GetServerVariable; - cid->ecb->WriteClient = WriteClient; - cid->ecb->ReadClient = ReadClient; - cid->ecb->ServerSupportFunction = ServerSupportFunction; - - - /* Set up client input */ - rv = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR); - if (rv) { - isapi_unload(isa, FALSE); - return HTTP_INTERNAL_SERVER_ERROR; /* XXX: The wrong error */ - } - - if (ap_should_client_block(r)) { - /* Time to start reading the appropriate amount of data, - * and allow the administrator to tweak the number - * TODO: add the httpd.conf option for ReadAheadBuffer. - */ - if (r->remaining) { - cid->ecb->cbTotalBytes = r->remaining; - if (cid->ecb->cbTotalBytes > cid->sconf->ReadAheadBuffer) - cid->ecb->cbAvailable = cid->sconf->ReadAheadBuffer; - else - cid->ecb->cbAvailable = cid->ecb->cbTotalBytes; - } - else - { - cid->ecb->cbTotalBytes = 0xffffffff; - cid->ecb->cbAvailable = cid->sconf->ReadAheadBuffer; - } - - cid->ecb->lpbData = apr_pcalloc(r->pool, cid->ecb->cbAvailable + 1); - - read = 0; - while (read < cid->ecb->cbAvailable && - ((res = ap_get_client_block(r, cid->ecb->lpbData + read, - cid->ecb->cbAvailable - read)) > 0)) { - read += res; - } - - if (res < 0) { - isapi_unload(isa, FALSE); - return HTTP_INTERNAL_SERVER_ERROR; - } - - /* Although its not to spec, IIS seems to null-terminate - * its lpdData string. So we will too. - */ - if (res == 0) - cid->ecb->cbAvailable = cid->ecb->cbTotalBytes = read; - else - cid->ecb->cbAvailable = read; - cid->ecb->lpbData[read] = '\0'; - } - else { - cid->ecb->cbTotalBytes = 0; - cid->ecb->cbAvailable = 0; - cid->ecb->lpbData = NULL; - } - - /* All right... try and run the sucker */ - rv = (*isa->HttpExtensionProc)(cid->ecb); - - /* Check for a log message - and log it */ - if (cid->ecb->lpszLogData && *cid->ecb->lpszLogData) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r, - "ISAPI %s: %s", r->filename, cid->ecb->lpszLogData); - - switch(rv) { - case HSE_STATUS_SUCCESS: - case HSE_STATUS_SUCCESS_AND_KEEP_CONN: - /* Ignore the keepalive stuff; Apache handles it just fine without - * the ISA's "advice". - * Per Microsoft: "In IIS versions 4.0 and later, the return - * values HSE_STATUS_SUCCESS and HSE_STATUS_SUCCESS_AND_KEEP_CONN - * are functionally identical: Keep-Alive connections are - * maintained, if supported by the client." - * ... so we were pat all this time - */ - break; - - case HSE_STATUS_PENDING: - /* emulating async behavior... - * - * Create a cid->completed event and wait on it for some timeout - * so that the app thinks is it running async. - * - * All async ServerSupportFunction calls will be handled through - * the registered IO_COMPLETION hook. - */ - - if (!isa->fakeasync) { - if (cid->sconf->LogNotSupported) - { - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI %s asynch I/O request refused", - r->filename); - cid->r->status = HTTP_INTERNAL_SERVER_ERROR; - } - } - else { - cid->complete = CreateEvent(NULL, FALSE, FALSE, NULL); - if (WaitForSingleObject(cid->complete, isa->timeout) - == WAIT_TIMEOUT) { - /* TODO: Now what... if this hung, then do we kill our own - * thread to force it's death? For now leave timeout = -1 - */ - } - } - break; - - case HSE_STATUS_ERROR: - /* end response if we have yet to do so. - */ - cid->r->status = HTTP_INTERNAL_SERVER_ERROR; - break; - - default: - /* TODO: log unrecognized retval for debugging - */ - cid->r->status = HTTP_INTERNAL_SERVER_ERROR; - break; - } - - /* Set the status (for logging) */ - if (cid->ecb->dwHttpStatusCode) { - cid->r->status = cid->ecb->dwHttpStatusCode; - } - - /* All done with the DLL... get rid of it... */ - isapi_unload(isa, FALSE); - - return OK; /* NOT r->status, even if it has changed. */ -} -#pragma optimize("",on) - -BOOL WINAPI GetServerVariable (HCONN hConn, LPSTR lpszVariableName, - LPVOID lpvBuffer, LPDWORD lpdwSizeofBuffer) -{ - request_rec *r = ((isapi_cid *)hConn)->r; - const char *result; - DWORD len; - - if (!strcmp(lpszVariableName, "ALL_HTTP")) - { - /* lf delimited, colon split, comma seperated and - * null terminated list of HTTP_ vars - */ - char **env = (char**) apr_table_elts(r->subprocess_env)->elts; - int nelts = 2 * apr_table_elts(r->subprocess_env)->nelts; - int i; - - for (len = 0, i = 0; i < nelts; i += 2) - if (!strncmp(env[i], "HTTP_", 5)) - len += strlen(env[i]) + strlen(env[i + 1]) + 2; - - if (*lpdwSizeofBuffer < len + 1) { - *lpdwSizeofBuffer = len + 1; - SetLastError(ERROR_INSUFFICIENT_BUFFER); - return FALSE; - } - - for (i = 0; i < nelts; i += 2) - if (!strncmp(env[i], "HTTP_", 5)) { - strcpy(lpvBuffer, env[i]); - ((char*)lpvBuffer) += strlen(env[i]); - *(((char*)lpvBuffer)++) = ':'; - strcpy(lpvBuffer, env[i + 1]); - ((char*)lpvBuffer) += strlen(env[i + 1]); - *(((char*)lpvBuffer)++) = '\n'; - } - - *(((char*)lpvBuffer)++) = '\0'; - *lpdwSizeofBuffer = len; - return TRUE; - } - - if (!strcmp(lpszVariableName, "ALL_RAW")) - { - /* lf delimited, colon split, comma seperated and - * null terminated list of the raw request header - */ - char **raw = (char**) apr_table_elts(r->headers_in)->elts; - int nelts = 2 * apr_table_elts(r->headers_in)->nelts; - int i; - - for (i = 0; i < nelts; i += 2) - len += strlen(raw[i]) + strlen(raw[i + 1]) + 2; - - if (*lpdwSizeofBuffer < len + 1) { - *lpdwSizeofBuffer = len + 1; - SetLastError(ERROR_INSUFFICIENT_BUFFER); - return FALSE; - } - - for (i = 0; i < nelts; i += 2) { - strcpy(lpvBuffer, raw[i]); - ((char*)lpvBuffer) += strlen(raw[i]); - *(((char*)lpvBuffer)++) = ':'; - *(((char*)lpvBuffer)++) = ' '; - strcpy(lpvBuffer, raw[i + 1]); - ((char*)lpvBuffer) += strlen(raw[i + 1]); - *(((char*)lpvBuffer)++) = '\n'; - i += 2; - } - *(((char*)lpvBuffer)++) = '\0'; - *lpdwSizeofBuffer = len; - return TRUE; - } - - /* Not a special case */ - result = apr_table_get(r->subprocess_env, lpszVariableName); - - if (result) { - len = strlen(result); - if (*lpdwSizeofBuffer < len + 1) { - *lpdwSizeofBuffer = len + 1; - SetLastError(ERROR_INSUFFICIENT_BUFFER); - return FALSE; - } - strcpy(lpvBuffer, result); - *lpdwSizeofBuffer = len; - return TRUE; - } - - /* Not Found */ - SetLastError(ERROR_INVALID_INDEX); - return FALSE; -} - -BOOL WINAPI WriteClient (HCONN ConnID, LPVOID Buffer, LPDWORD lpwdwBytes, - DWORD dwReserved) -{ - request_rec *r = ((isapi_cid *)ConnID)->r; - ap_bucket_brigade *bb; - ap_bucket *b; - - if (dwReserved == HSE_IO_SYNC) - ; /* XXX: Fake it */ - - bb = ap_brigade_create(r->pool); - b = ap_bucket_create_transient(Buffer, (apr_size_t)lpwdwBytes); - AP_BRIGADE_INSERT_TAIL(bb, b); - b = ap_bucket_create_eos(); - AP_BRIGADE_INSERT_TAIL(bb, b); - ap_pass_brigade(r->output_filters, bb); - - return TRUE; -} - -BOOL WINAPI ReadClient (HCONN ConnID, LPVOID lpvBuffer, LPDWORD lpdwSize) -{ - request_rec *r = ((isapi_cid *)ConnID)->r; - DWORD read = 0; - int res; - - if (r->remaining < (long) *lpdwSize) - *lpdwSize = r->remaining; - - while (read < *lpdwSize && - ((res = ap_get_client_block(r, (char*)lpvBuffer + read, - *lpdwSize - read)) > 0)) { - if (res < 0) { - *lpdwSize = 0; - if (!apr_get_os_error()) - SetLastError(TODO_ERROR); /* XXX: Find the right error code */ - return FALSE; - } - - read += res; - } - - *lpdwSize = read; - return TRUE; -} - -static apr_off_t SendResponseHeaderEx(isapi_cid *cid, const char *stat, - const char *head, apr_size_t statlen, - apr_size_t headlen) -{ - int termarg; - char *termch; - - if (!stat || statlen == 0 || !*stat) { - stat = "Status: 200 OK"; - } - else { - char *newstat; - newstat = apr_palloc(cid->r->pool, statlen + 9); - strcpy(newstat, "Status: "); - apr_cpystrn(newstat + 8, stat, statlen + 1); - stat = newstat; - } - - if (!head || headlen == 0 || !*head) { - head = "\r\n"; - } - else - { - if (head[headlen]) { - /* Whoops... not NULL terminated */ - head = apr_pstrndup(cid->r->pool, head, headlen); - } - } - - /* Parse them out, or die trying */ - cid->r->status= ap_scan_script_header_err_strs(cid->r, NULL, &termch, - &termarg, stat, head, NULL); - cid->ecb->dwHttpStatusCode = cid->r->status; - if (cid->r->status == HTTP_INTERNAL_SERVER_ERROR) - return -1; - - /* All the headers should be set now */ - ap_send_http_header(cid->r); - - /* Any data left is sent directly by the caller, all we - * give back is the size of the headers we consumed - */ - if (termch && (termarg == 1) && headlen > (termch - head)) { - return termch - head; - } - return 0; -} - -/* XXX: Is there is still an O(n^2) attack possible here? Please detail. */ -BOOL WINAPI ServerSupportFunction(HCONN hConn, DWORD dwHSERequest, - LPVOID lpvBuffer, LPDWORD lpdwSize, - LPDWORD lpdwDataType) -{ - isapi_cid *cid = (isapi_cid *)hConn; - request_rec *r = cid->r; - request_rec *subreq; - - switch (dwHSERequest) { - case 1: /* HSE_REQ_SEND_URL_REDIRECT_RESP */ - /* Set the status to be returned when the HttpExtensionProc() - * is done. - * WARNING: Microsoft now advertises HSE_REQ_SEND_URL_REDIRECT_RESP - * and HSE_REQ_SEND_URL as equivalant per the Jan 2000 SDK. - * They most definately are not, even in their own samples. - */ - apr_table_set (r->headers_out, "Location", lpvBuffer); - cid->r->status = cid->ecb->dwHttpStatusCode - = HTTP_MOVED_TEMPORARILY; - return TRUE; - - case 2: /* HSE_REQ_SEND_URL */ - /* Soak up remaining input */ - if (r->remaining > 0) { - char argsbuffer[HUGE_STRING_LEN]; - while (ap_get_client_block(r, argsbuffer, HUGE_STRING_LEN)); - } - - /* Reset the method to GET */ - r->method = apr_pstrdup(r->pool, "GET"); - r->method_number = M_GET; - - /* Don't let anyone think there's still data */ - apr_table_unset(r->headers_in, "Content-Length"); - - /* AV fault per PR3598 - redirected path is lost! */ - (char*)lpvBuffer = apr_pstrdup(r->pool, (char*)lpvBuffer); - ap_internal_redirect((char*)lpvBuffer, r); - return TRUE; - - case 3: /* HSE_REQ_SEND_RESPONSE_HEADER */ - { - /* Parse them out, or die trying */ - apr_size_t statlen = 0, headlen = 0; - int ate; - if (lpvBuffer) - statlen = strlen((char*) lpvBuffer); - if (lpdwDataType) - headlen = strlen((char*) lpdwDataType); - ate = SendResponseHeaderEx(cid, (char*) lpvBuffer, - (char*) lpdwDataType, - statlen, headlen); - if (ate < 0) { - SetLastError(TODO_ERROR); - return FALSE; - } - else if (ate < headlen) { - ap_bucket_brigade *bb; - ap_bucket *b; - bb = ap_brigade_create(cid->r->pool); - b = ap_bucket_create_transient((char*) lpdwDataType + ate, - headlen - ate); - AP_BRIGADE_INSERT_TAIL(bb, b); - b = ap_bucket_create_eos(); - AP_BRIGADE_INSERT_TAIL(bb, b); - ap_pass_brigade(cid->r->output_filters, bb); - } - return TRUE; - } - - case 4: /* HSE_REQ_DONE_WITH_SESSION */ - /* Signal to resume the thread completing this request - */ - if (cid->complete) - SetEvent(cid->complete); - return TRUE; - - case 1001: /* HSE_REQ_MAP_URL_TO_PATH */ - { - /* Map a URL to a filename */ - char *file = (char *)lpvBuffer; - DWORD len; - subreq = ap_sub_req_lookup_uri(apr_pstrndup(r->pool, file, *lpdwSize), r); - - len = apr_cpystrn(file, subreq->filename, *lpdwSize) - file; - - - /* IIS puts a trailing slash on directories, Apache doesn't */ - if (subreq->finfo.filetype == APR_DIR) { - if (len < *lpdwSize - 1) { - file[len++] = '\\'; - file[len] = '\0'; - } - } - *lpdwSize = len; - return TRUE; - } - - case 1002: /* HSE_REQ_GET_SSPI_INFO */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction HSE_REQ_GET_SSPI_INFO " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - case 1003: /* HSE_APPEND_LOG_PARAMETER */ - /* Log lpvBuffer, of lpdwSize bytes, in the URI Query (cs-uri-query) field - */ - apr_table_set(r->notes, "isapi-parameter", (char*) lpvBuffer); - if (cid->sconf->AppendLogToQuery) { - if (r->args) - r->args = apr_pstrcat(r->pool, r->args, (char*) lpvBuffer, NULL); - else - r->args = apr_pstrdup(r->pool, (char*) lpvBuffer); - } - if (cid->sconf->AppendLogToErrors) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r, - "ISAPI %s: %s", cid->r->filename, - (char*) lpvBuffer); - return TRUE; - - case 1005: /* HSE_REQ_IO_COMPLETION */ - /* Emulates a completion port... Record callback address and - * user defined arg, we will call this after any async request - * (e.g. transmitfile) as if the request executed async. - * Per MS docs... HSE_REQ_IO_COMPLETION replaces any prior call - * to HSE_REQ_IO_COMPLETION, and lpvBuffer may be set to NULL. - */ - if (!cid->isa->fakeasync) { - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction HSE_REQ_IO_COMPLETION " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - } - cid->completion = (PFN_HSE_IO_COMPLETION) lpvBuffer; - cid->completion_arg = (PVOID) lpdwDataType; - return TRUE; - - case 1006: /* HSE_REQ_TRANSMIT_FILE */ - { - HSE_TF_INFO *tf = (HSE_TF_INFO*)lpvBuffer; - apr_status_t rv; - ap_bucket_brigade *bb; - ap_bucket *b; - apr_file_t *fd; - - if (!cid->isa->fakeasync && (tf->dwFlags & HSE_IO_ASYNC)) { - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction HSE_REQ_TRANSMIT_FILE " - "as HSE_IO_ASYNC is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - } - - if ((rv = apr_put_os_file(&fd, tf->hFile, r->pool)) != APR_SUCCESS) { - return FALSE; - } - - /* apr_dupfile_oshandle (&fd, tf->hFile, r->pool); */ - bb = ap_brigade_create(r->pool); - - if (tf->dwFlags & HSE_IO_SEND_HEADERS) - { - /* According to MS: if calling HSE_REQ_TRANSMIT_FILE with the - * HSE_IO_SEND_HEADERS flag, then you can't otherwise call any - * HSE_SEND_RESPONSE_HEADERS* fn, but if you don't use the flag, - * you must have done so. They document that the pHead headers - * option is valid only for HSE_IO_SEND_HEADERS - we are a bit - * more flexible and assume with the flag, pHead are the - * response headers, and without, pHead simply contains text - * (handled after this case). - */ - apr_off_t ate = SendResponseHeaderEx(cid, tf->pszStatusCode, - (char*)tf->pHead, - strlen(tf->pszStatusCode), - (apr_size_t)tf->HeadLength); - if (ate < 0) - { - ap_brigade_destroy(bb); - SetLastError(TODO_ERROR); - return FALSE; - } - if (ate < (apr_size_t)tf->HeadLength) - { - b = ap_bucket_create_transient((char*)tf->pHead + ate, - (apr_size_t)tf->HeadLength - ate); - AP_BRIGADE_INSERT_TAIL(bb, b); - } - } - else if (tf->pHead && tf->HeadLength) { - b = ap_bucket_create_transient((char*)tf->pHead, - (apr_size_t)tf->HeadLength); - AP_BRIGADE_INSERT_TAIL(bb, b); - } - - b = ap_bucket_create_file(fd, (apr_off_t)tf->Offset, - (apr_size_t)tf->BytesToWrite); - AP_BRIGADE_INSERT_TAIL(bb, b); - - if (tf->pTail && (apr_size_t)tf->TailLength) { - b = ap_bucket_create_transient((char*)tf->pTail, - (apr_size_t)tf->TailLength); - AP_BRIGADE_INSERT_TAIL(bb, b); - } - - b = ap_bucket_create_eos(); - AP_BRIGADE_INSERT_TAIL(bb, b); - ap_pass_brigade(r->output_filters, bb); - - /* we do nothing with (tf->dwFlags & HSE_DISCONNECT_AFTER_SEND) - */ - - if (tf->dwFlags & HSE_IO_ASYNC) { - /* XXX: Fake async response, - * use tf->pfnHseIO, or if NULL, then use cid->fnIOComplete - * pass pContect to the HseIO callback. - */ - } - return TRUE; - } - - case 1007: /* HSE_REQ_REFRESH_ISAPI_ACL */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction " - "HSE_REQ_REFRESH_ISAPI_ACL " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - case 1008: /* HSE_REQ_IS_KEEP_CONN */ - *((LPBOOL) lpvBuffer) = (r->connection->keepalive == 1); - return TRUE; - - case 1010: /* XXX: Fake it : HSE_REQ_ASYNC_READ_CLIENT */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI asynchronous I/O not supported: %s", - r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - case 1011: /* HSE_REQ_GET_IMPERSONATION_TOKEN Added in ISAPI 4.0 */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction " - "HSE_REQ_GET_IMPERSONATION_TOKEN " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - -#ifdef HSE_REQ_MAP_URL_TO_PATH_EX - case 1012: /* HSE_REQ_MAP_URL_TO_PATH_EX */ - { - /* Map a URL to a filename */ - LPHSE_URL_MAPEX_INFO info = (LPHSE_URL_MAPEX_INFO) lpdwDataType; - char* test_uri = apr_pstrndup(r->pool, (char *)lpvBuffer, *lpdwSize); - - subreq = ap_sub_req_lookup_uri(test_uri, r); - info->cchMatchingURL = strlen(test_uri); - info->cchMatchingPath = apr_cpystrn(info->lpszPath, subreq->filename, - MAX_PATH) - info->lpszPath; - - /* Mapping started with assuming both strings matched. - * Now roll on the path_info as a mismatch and handle - * terminating slashes for directory matches. - */ - if (subreq->path_info && *subreq->path_info) { - apr_cpystrn(info->lpszPath + info->cchMatchingPath, - subreq->path_info, MAX_PATH - info->cchMatchingPath); - info->cchMatchingURL -= strlen(subreq->path_info); - if (subreq->finfo.filetype == APR_DIR - && info->cchMatchingPath < MAX_PATH - 1) { - /* roll forward over path_info's first slash */ - ++info->cchMatchingPath; - ++info->cchMatchingURL; - } - } - else if (subreq->finfo.filetype == APR_DIR - && info->cchMatchingPath < MAX_PATH - 1) { - /* Add a trailing slash for directory */ - info->lpszPath[info->cchMatchingPath++] = '/'; - info->lpszPath[info->cchMatchingPath] = '\0'; - } - - /* If the matched isn't a file, roll match back to the prior slash */ - if (subreq->finfo.filetype == APR_NOFILE) { - while (info->cchMatchingPath && info->cchMatchingURL) { - if (info->lpszPath[info->cchMatchingPath - 1] == '/') - break; - --info->cchMatchingPath; - --info->cchMatchingURL; - } - } - - /* Paths returned with back slashes */ - for (test_uri = info->lpszPath; *test_uri; ++test_uri) - if (*test_uri == '/') - *test_uri = '\\'; - - /* is a combination of: - * HSE_URL_FLAGS_READ 0x001 Allow read - * HSE_URL_FLAGS_WRITE 0x002 Allow write - * HSE_URL_FLAGS_EXECUTE 0x004 Allow execute - * HSE_URL_FLAGS_SSL 0x008 Require SSL - * HSE_URL_FLAGS_DONT_CACHE 0x010 Don't cache (VRoot only) - * HSE_URL_FLAGS_NEGO_CERT 0x020 Allow client SSL cert - * HSE_URL_FLAGS_REQUIRE_CERT 0x040 Require client SSL cert - * HSE_URL_FLAGS_MAP_CERT 0x080 Map client SSL cert to account - * HSE_URL_FLAGS_SSL128 0x100 Require 128-bit SSL cert - * HSE_URL_FLAGS_SCRIPT 0x200 Allow script execution - * - * XxX: As everywhere, EXEC flags could use some work... - * and this could go further with more flags, as desired. - */ - info->dwFlags = (subreq->finfo.protection & APR_UREAD ? 0x001 : 0) - | (subreq->finfo.protection & APR_UWRITE ? 0x002 : 0) - | (subreq->finfo.protection & APR_UEXECUTE ? 0x204 : 0); - return TRUE; - } -#endif - - case 1014: /* HSE_REQ_ABORTIVE_CLOSE */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction HSE_REQ_ABORTIVE_CLOSE" - " is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - case 1015: /* HSE_REQ_GET_CERT_INFO_EX Added in ISAPI 4.0 */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction " - "HSE_REQ_GET_CERT_INFO_EX " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - -#ifdef HSE_REQ_SEND_RESPONSE_HEADER_EX - case 1016: /* HSE_REQ_SEND_RESPONSE_HEADER_EX Added in ISAPI 4.0 */ - { - LPHSE_SEND_HEADER_EX_INFO shi - = (LPHSE_SEND_HEADER_EX_INFO) lpvBuffer; - /* XXX: ignore shi->fKeepConn? We shouldn't need the advise */ - /* r->connection->keepalive = shi->fKeepConn; */ - apr_off_t ate = SendResponseHeaderEx(cid, shi->pszStatus, - shi->pszHeader, - shi->cchStatus, - shi->cchHeader); - if (ate < 0) { - SetLastError(TODO_ERROR); - return FALSE; - } - else if (ate < (apr_off_t)shi->cchHeader) { - ap_bucket_brigade *bb; - ap_bucket *b; - bb = ap_brigade_create(cid->r->pool); - b = ap_bucket_create_transient(shi->pszHeader + ate, - (apr_size_t)shi->cchHeader - ate); - AP_BRIGADE_INSERT_TAIL(bb, b); - b = ap_bucket_create_eos(); - AP_BRIGADE_INSERT_TAIL(bb, b); - ap_pass_brigade(cid->r->output_filters, bb); - } - return TRUE; - - } -#endif - - case 1017: /* HSE_REQ_CLOSE_CONNECTION Added after ISAPI 4.0 */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction " - "HSE_REQ_CLOSE_CONNECTION " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - case 1018: /* HSE_REQ_IS_CONNECTED Added after ISAPI 4.0 */ - /* Returns True if client is connected c.f. MSKB Q188346 - * assuming the identical return mechanism as HSE_REQ_IS_KEEP_CONN - */ - *((LPBOOL) lpvBuffer) = (r->connection->aborted == 0); - return TRUE; - - case 1020: /* HSE_REQ_EXTENSION_TRIGGER Added after ISAPI 4.0 */ - /* Undocumented - defined by the Microsoft Jan '00 Platform SDK - */ - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction " - "HSE_REQ_EXTENSION_TRIGGER " - "is not supported: %s", r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - - default: - if (cid->sconf->LogNotSupported) - ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, r, - "ISAPI ServerSupportFunction (%d) not supported: " - "%s", dwHSERequest, r->filename); - SetLastError(ERROR_INVALID_PARAMETER); - return FALSE; - } -} - -/* - * Command handler for the ISAPIReadAheadBuffer directive, which is TAKE1 - */ -static const char *isapi_cmd_readaheadbuffer(cmd_parms *cmd, void *config, - char *arg) -{ - isapi_server_conf *sconf = ap_get_module_config(cmd->server->module_config, - &isapi_module); - char *scan; - long val; - - if (((val = strtol(arg, (char **) &scan, 10)) <= 0) || *scan) - return "ISAPIReadAheadBuffer must be a legitimate value."; - - sconf->ReadAheadBuffer = val; - return NULL; -} - -/* - * Command handler for the ISAPIReadAheadBuffer directive, which is TAKE1 - */ -static const char *isapi_cmd_lognotsupported(cmd_parms *cmd, void *config, - char *arg) -{ - isapi_server_conf *sconf = ap_get_module_config(cmd->server->module_config, - &isapi_module); - - if (strcasecmp(arg, "on") == 0) { - sconf->LogNotSupported = -1; - } - else if (strcasecmp(arg, "off") == 0) { - sconf->LogNotSupported = 0; - } - else { - return "ISAPILogNotSupported must be on or off"; - } - return NULL; -} - -static const char *isapi_cmd_appendlogtoerrors(cmd_parms *cmd, void *config, - char *arg) -{ - isapi_server_conf *sconf = ap_get_module_config(cmd->server->module_config, - &isapi_module); - - if (strcasecmp(arg, "on") == 0) { - sconf->AppendLogToErrors = -1; - } - else if (strcasecmp(arg, "off") == 0) { - sconf->AppendLogToErrors = 0; - } - else { - return "ISAPIAppendLogToErrors must be on or off"; - } - return NULL; -} - -static const char *isapi_cmd_appendlogtoquery(cmd_parms *cmd, void *config, - char *arg) -{ - isapi_server_conf *sconf = ap_get_module_config(cmd->server->module_config, - &isapi_module); - - if (strcasecmp(arg, "on") == 0) { - sconf->AppendLogToQuery = -1; - } - else if (strcasecmp(arg, "off") == 0) { - sconf->AppendLogToQuery = 0; - } - else { - return "ISAPIAppendLogToQuery must be on or off"; - } - return NULL; -} - -static const char *isapi_cmd_cachefile(cmd_parms *cmd, void *dummy, - const char *filename) - -{ - isapi_server_conf *sconf = ap_get_module_config(cmd->server->module_config, - &isapi_module); - isapi_loaded *isa, **newisa; - apr_finfo_t tmp; - apr_status_t rv; - char *fspec; - - fspec = ap_os_case_canonical_filename(cmd->pool, filename); - if (apr_stat(&tmp, fspec, cmd->temp_pool) != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, cmd->server, - "ISAPI: unable to stat(%s), skipping", filename); - return NULL; - } - if (tmp.filetype != APR_REG) { - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, cmd->server, - "ISAPI: %s isn't a regular file, skipping", filename); - return NULL; - } - - /* Load the extention as cached (passing sconf) */ - rv = isapi_load(cmd->pool, sconf, NULL, fspec, &isa); - if (rv != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_WARNING, rv, cmd->server, - "ISAPI: unable to cache %s, skipping", filename); - return NULL; - } - - /* Add to cached list of loaded modules */ - newisa = apr_push_array(sconf->loaded); - *newisa = isa; - - return NULL; -} - -static void isapi_hooks(void) -{ - ap_hook_post_config(isapi_post_config, NULL, NULL, AP_HOOK_MIDDLE); -} - -static const command_rec isapi_cmds[] = { -AP_INIT_TAKE1("ISAPIReadAheadBuffer", isapi_cmd_readaheadbuffer, NULL, RSRC_CONF, - "Maximum bytes to initially pass to the ISAPI handler"), -AP_INIT_TAKE1("ISAPILogNotSupported", isapi_cmd_lognotsupported, NULL, RSRC_CONF, - "Log requests not supported by the ISAPI server"), -AP_INIT_TAKE1("ISAPIAppendLogToErrors", isapi_cmd_appendlogtoerrors, NULL, RSRC_CONF, - "Send all Append Log requests to the error log"), -AP_INIT_TAKE1("ISAPIAppendLogToQuery", isapi_cmd_appendlogtoquery, NULL, RSRC_CONF, - "Append Log requests are concatinated to the query args"), -AP_INIT_ITERATE("ISAPICacheFile", isapi_cmd_cachefile, NULL, RSRC_CONF, - "Cache the specified ISAPI extension in-process"), -{ NULL } -}; - -handler_rec isapi_handlers[] = { - { "isapi-isa", isapi_handler }, - { NULL} -}; - -module isapi_module = { - STANDARD20_MODULE_STUFF, - NULL, /* create per-dir config */ - NULL, /* merge per-dir config */ - create_isapi_server_config, /* server config */ - NULL, /* merge server config */ - isapi_cmds, /* command apr_table_t */ - isapi_handlers, /* handlers */ - isapi_hooks /* register hooks */ -}; diff --git a/os/win32/libhttpd.c b/os/win32/libhttpd.c deleted file mode 100644 index 8dddf18aa6f..00000000000 --- a/os/win32/libhttpd.c +++ /dev/null @@ -1,10 +0,0 @@ -/* - * Placeholder to force ApacheCore.dll creation with no LNK4001 error - * - * However, this isn't a bad place to store dynamic-only functions - * that determine which version of apr the application has loaded. - * These functions are of (less?) importance to static-bound apps. - * - * We may also need this hook to play with dll-oriented thread-local - * storage for modules on a per-thread DllMain() basis. - */ diff --git a/server/mpm/experimental/perchild/.cvsignore b/server/mpm/experimental/perchild/.cvsignore deleted file mode 100644 index 84df2572148..00000000000 --- a/server/mpm/experimental/perchild/.cvsignore +++ /dev/null @@ -1,5 +0,0 @@ -.deps -.libs -*.lo -*.la -Makefile diff --git a/server/mpm/experimental/perchild/Makefile.in b/server/mpm/experimental/perchild/Makefile.in deleted file mode 100644 index 4d83d72d2d2..00000000000 --- a/server/mpm/experimental/perchild/Makefile.in +++ /dev/null @@ -1,5 +0,0 @@ - -LTLIBRARY_NAME = libperchild.la -LTLIBRARY_SOURCES = perchild.c scoreboard.c - -include $(top_srcdir)/build/ltlib.mk diff --git a/server/mpm/experimental/perchild/mpm.h b/server/mpm/experimental/perchild/mpm.h deleted file mode 100644 index 062f83f68e6..00000000000 --- a/server/mpm/experimental/perchild/mpm.h +++ /dev/null @@ -1,88 +0,0 @@ -/* ==================================================================== - * The Apache Software License, Version 1.1 - * - * Copyright (c) 2000 The Apache Software Foundation. All rights - * reserved. - * - * 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 - * . - * - * Portions of this software are based upon public domain software - * originally written at the National Center for Supercomputing Applications, - * University of Illinois, Urbana-Champaign. - */ - -#include "httpd.h" -#include "mpm_default.h" -#include "unixd.h" - -#ifndef APACHE_MPM_PERCHILD_H -#define APACHE_MPM_PERCHILD_H - -#define PERCHILD_MPM - -#define MPM_NEEDS_RECLAIM_CHILD_PROCESSES 1 -#define MPM_SYNC_CHILD_TABLE() -#define MPM_CHILD_PID(i) (ap_child_table[i].pid) -#define MPM_NOTE_CHILD_KILLED(i) (MPM_CHILD_PID(i) = 0) - -/* Table of child status */ -#define SERVER_DEAD 0 -#define SERVER_DYING 1 -#define SERVER_ALIVE 2 - -typedef struct ap_ctable{ - pid_t pid; - unsigned char status; -} ap_ctable; - -extern int ap_max_daemons_limit; -extern ap_ctable ap_child_table[HARD_SERVER_LIMIT]; -extern server_rec *ap_server_conf; -extern char ap_coredump_dir[MAX_STRING_LEN]; - -#endif /* APACHE_MPM_PERCHILD_H */ diff --git a/server/mpm/experimental/perchild/mpm_default.h b/server/mpm/experimental/perchild/mpm_default.h deleted file mode 100644 index 5bd323b09b4..00000000000 --- a/server/mpm/experimental/perchild/mpm_default.h +++ /dev/null @@ -1,144 +0,0 @@ -/* ==================================================================== - * The Apache Software License, Version 1.1 - * - * Copyright (c) 2000 The Apache Software Foundation. All rights - * reserved. - * - * 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 - * . - * - * Portions of this software are based upon public domain software - * originally written at the National Center for Supercomputing Applications, - * University of Illinois, Urbana-Champaign. - */ - -#ifndef APACHE_MPM_DEFAULT_H -#define APACHE_MPM_DEFAULT_H - -/* Number of threads to spawn off by default --- also, if fewer than - * this free when the caretaker checks, it will spawn more. - */ -#ifndef DEFAULT_START_THREAD -#define DEFAULT_START_THREAD 5 -#endif - -/* Maximum number of *free* server threads --- more than this, and - * they will die off. - */ - -#ifndef DEFAULT_MAX_SPARE_THREAD -#define DEFAULT_MAX_SPARE_THREAD 10 -#endif - -/* Minimum --- fewer than this, and more will be created */ - -#ifndef DEFAULT_MIN_SPARE_THREAD -#define DEFAULT_MIN_SPARE_THREAD 5 -#endif - -/* Limit on the threads per process. Clients will be locked out if more than - * this * HARD_SERVER_LIMIT are needed. - * - * We keep this for one reason it keeps the size of the scoreboard file small - * enough that we can read the whole thing without worrying too much about - * the overhead. - */ -#ifndef HARD_THREAD_LIMIT -#define HARD_THREAD_LIMIT 64 -#endif - -/* Number of servers to spawn off by default - */ -#ifndef DEFAULT_NUM_DAEMON -#define DEFAULT_NUM_DAEMON 2 -#endif - -/* Limit on the total --- clients will be locked out if more servers than - * this are needed. It is intended solely to keep the server from crashing - * when things get out of hand. - * - * We keep a hard maximum number of servers, for two reasons --- first off, - * in case something goes seriously wrong, we want to stop the fork bomb - * short of actually crashing the machine we're running on by filling some - * kernel table. Secondly, it keeps the size of the scoreboard file small - * enough that we can read the whole thing without worrying too much about - * the overhead. - */ -#ifndef HARD_SERVER_LIMIT -#define HARD_SERVER_LIMIT 8 -#endif - -/* File used for accept locking, when we use a file */ -#ifndef DEFAULT_LOCKFILE -#define DEFAULT_LOCKFILE "logs/accept.lock" -#endif - -/* Scoreboard file, if there is one */ -#ifndef DEFAULT_SCOREBOARD -#define DEFAULT_SCOREBOARD "logs/apache_runtime_status" -#endif - -/* Where the main/parent process's pid is logged */ -#ifndef DEFAULT_PIDLOG -#define DEFAULT_PIDLOG "logs/httpd.pid" -#endif - -/* - * Interval, in microseconds, between scoreboard maintenance. - */ -#ifndef SCOREBOARD_MAINTENANCE_INTERVAL -#define SCOREBOARD_MAINTENANCE_INTERVAL 1000000 -#endif - -/* Number of requests to try to handle in a single process. If <= 0, - * the children don't die off. - */ -#ifndef DEFAULT_MAX_REQUESTS_PER_CHILD -#define DEFAULT_MAX_REQUESTS_PER_CHILD 10000 -#endif - -#endif /* AP_MPM_DEFAULT_H */ diff --git a/server/mpm/experimental/perchild/perchild.c b/server/mpm/experimental/perchild/perchild.c deleted file mode 100644 index d934e9e99a5..00000000000 --- a/server/mpm/experimental/perchild/perchild.c +++ /dev/null @@ -1,1765 +0,0 @@ -/* ==================================================================== - * The Apache Software License, Version 1.1 - * - * Copyright (c) 2000 The Apache Software Foundation. All rights - * reserved. - * - * 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 - * . - * - * Portions of this software are based upon public domain software - * originally written at the National Center for Supercomputing Applications, - * University of Illinois, Urbana-Champaign. - */ - -#define CORE_PRIVATE - -#include "ap_config.h" -#include "apr_hash.h" -#include "apr_strings.h" -#include "apr_portable.h" -#include "apr_file_io.h" -#include "httpd.h" -#include "http_main.h" -#include "http_log.h" -#include "http_config.h" /* for read_config */ -#include "http_core.h" /* for get_remote_host */ -#include "http_protocol.h" -#include "http_connection.h" -#include "ap_mpm.h" -#include "unixd.h" -#include "mpm_common.h" -#include "ap_listen.h" -#include "mpm_default.h" -#include "mpm.h" -#include "scoreboard.h" - -#ifdef HAVE_UNISTD_H -#include -#endif -#include -#ifdef HAVE_SYS_SOCKET_H -#include -#endif -#ifdef HAVE_NETINET_TCP_H -#include -#endif -#include -#include -#include -#include -#include -#include -#include -#include - -/* - * Actual definitions of config globals - */ - -static int threads_to_start = 0; /* Worker threads per child */ -static int min_spare_threads = 0; -static int max_spare_threads = 0; -static int max_threads = 0; -static int max_requests_per_child = 0; -static const char *ap_pid_fname=NULL; -AP_DECLARE_DATA const char *ap_scoreboard_fname=NULL; -static int num_daemons=0; -static int curr_child_num=0; -static int workers_may_exit = 0; -static int requests_this_child; -static int num_listenfds = 0; -static apr_socket_t **listenfds; -static jmp_buf jmpbuffer; - -struct child_info_t { - uid_t uid; - gid_t gid; - int sd; -}; - -typedef struct { - const char *sockname; /* The base name for the socket */ - const char *fullsockname; /* socket base name + extension */ - int sd; /* The socket descriptor */ - int sd2; /* The socket descriptor */ -} perchild_server_conf; - -typedef struct child_info_t child_info_t; - -/* Tables used to determine the user and group each child process should - * run as. The hash table is used to correlate a server name with a child - * process. - */ -static child_info_t child_info_table[HARD_SERVER_LIMIT]; -static int thread_socket_table[HARD_THREAD_LIMIT]; - - -struct ap_ctable ap_child_table[HARD_SERVER_LIMIT]; - -/* - * The max child slot ever assigned, preserved across restarts. Necessary - * to deal with NumServers changes across SIGWINCH restarts. We use this - * value to optimize routines that have to scan the entire child table. - * - * XXX - It might not be worth keeping this code in. There aren't very - * many child processes in this MPM. - */ -int ap_max_daemons_limit = -1; - -char ap_coredump_dir[MAX_STRING_LEN]; - -module AP_MODULE_DECLARE_DATA mpm_perchild_module; - -static apr_file_t *pipe_of_death_in = NULL; -static apr_file_t *pipe_of_death_out = NULL; -static pthread_mutex_t pipe_of_death_mutex; - -/* *Non*-shared http_main globals... */ - -server_rec *ap_server_conf; - -/* one_process --- debugging mode variable; can be set from the command line - * with the -X flag. If set, this gets you the child_main loop running - * in the process which originally started up (no detach, no make_child), - * which is a pretty nice debugging environment. (You'll get a SIGHUP - * early in standalone_main; just continue through. This is the server - * trying to kill off any child processes which it might have lying - * around --- Apache doesn't keep track of their pids, it just sends - * SIGHUP to the process group, ignoring it in the root process. - * Continue through and you'll be fine.). - */ - -static int one_process = 0; - -#ifdef DEBUG_SIGSTOP -int raise_sigstop_flags; -#endif - -static apr_pool_t *pconf; /* Pool for config stuff */ -static apr_pool_t *pchild; /* Pool for httpd child stuff */ -static apr_pool_t *thread_pool_parent; /* Parent of per-thread pools */ -static pthread_mutex_t thread_pool_parent_mutex; - -static int child_num; -static unsigned int my_pid; /* Linux getpid() doesn't work except in - main thread. Use this instead */ -/* Keep track of the number of worker threads currently active */ -static int worker_thread_count; -static pthread_mutex_t worker_thread_count_mutex; -static int worker_thread_free_ids[HARD_THREAD_LIMIT]; -static pthread_attr_t worker_thread_attr; - -/* Keep track of the number of idle worker threads */ -static int idle_thread_count; -static pthread_mutex_t idle_thread_count_mutex; - -/* Locks for accept serialization */ -#ifdef NO_SERIALIZED_ACCEPT -#define SAFE_ACCEPT(stmt) APR_SUCCESS -#else -#define SAFE_ACCEPT(stmt) (stmt) -static apr_lock_t *process_accept_mutex; -#endif /* NO_SERIALIZED_ACCEPT */ -static const char *lock_fname; -static pthread_mutex_t thread_accept_mutex = PTHREAD_MUTEX_INITIALIZER; - -AP_DECLARE(int) ap_get_max_daemons(void) -{ - return ap_max_daemons_limit; -} - -/* a clean exit from a child with proper cleanup */ -static void clean_child_exit(int code) -{ - if (pchild) { - apr_destroy_pool(pchild); - } - exit(code); -} - -/* handle all varieties of core dumping signals */ -static void sig_coredump(int sig) -{ - chdir(ap_coredump_dir); - apr_signal(sig, SIG_DFL); - kill(getpid(), sig); - /* At this point we've got sig blocked, because we're still inside - * the signal handler. When we leave the signal handler it will - * be unblocked, and we'll take the signal... and coredump or whatever - * is appropriate for this particular Unix. In addition the parent - * will see the real signal we received -- whereas if we called - * abort() here, the parent would only see SIGABRT. - */ -} - -static void just_die(int sig) -{ - clean_child_exit(0); -} - -/***************************************************************** - * Connection structures and accounting... - */ - -/* volatile just in case */ -static int volatile shutdown_pending; -static int volatile restart_pending; -static int volatile is_graceful; - -/* - * ap_start_shutdown() and ap_start_restart(), below, are a first stab at - * functions to initiate shutdown or restart without relying on signals. - * Previously this was initiated in sig_term() and restart() signal handlers, - * but we want to be able to start a shutdown/restart from other sources -- - * e.g. on Win32, from the service manager. Now the service manager can - * call ap_start_shutdown() or ap_start_restart() as appropiate. Note that - * these functions can also be called by the child processes, since global - * variables are no longer used to pass on the required action to the parent. - * - * These should only be called from the parent process itself, since the - * parent process will use the shutdown_pending and restart_pending variables - * to determine whether to shutdown or restart. The child process should - * call signal_parent() directly to tell the parent to die -- this will - * cause neither of those variable to be set, which the parent will - * assume means something serious is wrong (which it will be, for the - * child to force an exit) and so do an exit anyway. - */ - -void ap_start_shutdown(void) -{ - if (shutdown_pending == 1) { - /* Um, is this _probably_ not an error, if the user has - * tried to do a shutdown twice quickly, so we won't - * worry about reporting it. - */ - return; - } - shutdown_pending = 1; -} - -/* do a graceful restart if graceful == 1 */ -static void ap_start_restart(int graceful) -{ - - if (restart_pending == 1) { - /* Probably not an error - don't bother reporting it */ - return; - } - restart_pending = 1; - is_graceful = graceful; - if (is_graceful) { - apr_kill_cleanup(pconf, NULL, ap_cleanup_shared_mem); - } -} - -static void sig_term(int sig) -{ - ap_start_shutdown(); -} - -static void restart(int sig) -{ -#ifndef WIN32 - ap_start_restart(sig == SIGWINCH); -#else - ap_start_restart(1); -#endif -} - -static void set_signals(void) -{ -#ifndef NO_USE_SIGACTION - struct sigaction sa; - - sigemptyset(&sa.sa_mask); - sa.sa_flags = 0; - - if (!one_process) { - sa.sa_handler = sig_coredump; -#if defined(SA_ONESHOT) - sa.sa_flags = SA_ONESHOT; -#elif defined(SA_RESETHAND) - sa.sa_flags = SA_RESETHAND; -#endif - if (sigaction(SIGSEGV, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGSEGV)"); -#ifdef SIGBUS - if (sigaction(SIGBUS, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGBUS)"); -#endif -#ifdef SIGABORT - if (sigaction(SIGABORT, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGABORT)"); -#endif -#ifdef SIGABRT - if (sigaction(SIGABRT, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGABRT)"); -#endif -#ifdef SIGILL - if (sigaction(SIGILL, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGILL)"); -#endif - sa.sa_flags = 0; - } - sa.sa_handler = sig_term; - if (sigaction(SIGTERM, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGTERM)"); -#ifdef SIGINT - if (sigaction(SIGINT, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGINT)"); -#endif -#ifdef SIGXCPU - sa.sa_handler = SIG_DFL; - if (sigaction(SIGXCPU, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGXCPU)"); -#endif -#ifdef SIGXFSZ - sa.sa_handler = SIG_DFL; - if (sigaction(SIGXFSZ, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGXFSZ)"); -#endif -#ifdef SIGPIPE - sa.sa_handler = SIG_IGN; - if (sigaction(SIGPIPE, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGPIPE)"); -#endif - - /* we want to ignore HUPs and WINCH while we're busy processing one */ - sigaddset(&sa.sa_mask, SIGHUP); - sigaddset(&sa.sa_mask, SIGWINCH); - sa.sa_handler = restart; - if (sigaction(SIGHUP, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGHUP)"); - if (sigaction(SIGWINCH, &sa, NULL) < 0) - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, "sigaction(SIGWINCH)"); -#else - if (!one_process) { - apr_signal(SIGSEGV, sig_coredump); -#ifdef SIGBUS - apr_signal(SIGBUS, sig_coredump); -#endif /* SIGBUS */ -#ifdef SIGABORT - apr_signal(SIGABORT, sig_coredump); -#endif /* SIGABORT */ -#ifdef SIGABRT - apr_signal(SIGABRT, sig_coredump); -#endif /* SIGABRT */ -#ifdef SIGILL - apr_signal(SIGILL, sig_coredump); -#endif /* SIGILL */ -#ifdef SIGXCPU - apr_signal(SIGXCPU, SIG_DFL); -#endif /* SIGXCPU */ -#ifdef SIGXFSZ - apr_signal(SIGXFSZ, SIG_DFL); -#endif /* SIGXFSZ */ - } - - apr_signal(SIGTERM, sig_term); -#ifdef SIGHUP - apr_signal(SIGHUP, restart); -#endif /* SIGHUP */ -#ifdef SIGWINCH - apr_signal(SIGWINCH, restart); -#endif /* SIGWINCH */ -#ifdef SIGPIPE - apr_signal(SIGPIPE, SIG_IGN); -#endif /* SIGPIPE */ - -#endif -} - -/***************************************************************** - * Here follows a long bunch of generic server bookkeeping stuff... - */ - -int ap_graceful_stop_signalled(void) -{ - /* XXX - Does this really work? - Manoj */ - return is_graceful; -} - -/***************************************************************** - * Child process main loop. - */ - -static void process_socket(apr_pool_t *p, apr_socket_t *sock, long conn_id) -{ - conn_rec *current_conn; - int csd; - apr_status_t rv; - int thread_num = conn_id % HARD_THREAD_LIMIT; - - if ((rv = apr_get_os_sock(&csd, sock)) != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_ERR, rv, NULL, "apr_get_os_sock"); - } - - if (csd >= FD_SETSIZE) { - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, NULL, - "new file descriptor %d is too large; you probably need " - "to rebuild Apache with a larger FD_SETSIZE " - "(currently %d)", - csd, FD_SETSIZE); - apr_close_socket(sock); - return; - } - - if (thread_socket_table[thread_num] < 0) { - ap_sock_disable_nagle(sock); - } - - current_conn = ap_new_apr_connection(p, ap_server_conf, sock, - conn_id); - - ap_process_connection(current_conn); - ap_lingering_close(current_conn); -} - -static void *worker_thread(void *); - -/* Starts a thread as long as we're below max_threads */ -static int start_thread(void) -{ - pthread_t thread; - int rc; - - pthread_mutex_lock(&worker_thread_count_mutex); - if (worker_thread_count < max_threads) { - if ((rc = pthread_create(&thread, &worker_thread_attr, worker_thread, - &worker_thread_free_ids[worker_thread_count]))) { -#ifdef PTHREAD_SETS_ERRNO - rc = errno; -#endif - ap_log_error(APLOG_MARK, APLOG_ALERT, rc, ap_server_conf, - "pthread_create: unable to create worker thread"); - /* In case system resources are maxxed out, we don't want - Apache running away with the CPU trying to fork over and - over and over again if we exit. */ - sleep(10); - workers_may_exit = 1; - pthread_mutex_unlock(&worker_thread_count_mutex); - return 0; - } - else { - worker_thread_count++; - } - } - else { - static int reported = 0; - - if (!reported) { - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, ap_server_conf, - "server reached MaxThreadsPerChild setting, consider raising the" - " MaxThreadsPerChild or NumServers settings"); - reported = 1; - } - pthread_mutex_unlock(&worker_thread_count_mutex); - return 0; - } - pthread_mutex_unlock(&worker_thread_count_mutex); - return 1; - -} -/* Sets workers_may_exit if we received a character on the pipe_of_death */ -static void check_pipe_of_death(void) -{ - pthread_mutex_lock(&pipe_of_death_mutex); - if (!workers_may_exit) { - int ret; - char pipe_read_char; - apr_size_t n = 1; - - ret = apr_recv(listenfds[0], &pipe_read_char, &n); - if (APR_STATUS_IS_EAGAIN(ret)) { - /* It lost the lottery. It must continue to suffer - * through a life of servitude. */ - } - else { - /* It won the lottery (or something else is very - * wrong). Embrace death with open arms. */ - workers_may_exit = 1; - } - } - pthread_mutex_unlock(&pipe_of_death_mutex); -} - -/* idle_thread_count should be incremented before starting a worker_thread */ - -static void *worker_thread(void *arg) -{ - apr_socket_t *csd = NULL; - apr_pool_t *tpool; /* Pool for this thread */ - apr_pool_t *ptrans; /* Pool for per-transaction stuff */ - apr_socket_t *sd = NULL; - int srv; - int curr_pollfd, last_pollfd = 0; - int thread_just_started = 1; - int thread_num = *((int *) arg); - long conn_id = child_num * HARD_THREAD_LIMIT + thread_num; - apr_pollfd_t *pollset; - int n; - apr_status_t rv; - - pthread_mutex_lock(&thread_pool_parent_mutex); - apr_create_pool(&tpool, thread_pool_parent); - pthread_mutex_unlock(&thread_pool_parent_mutex); - apr_create_pool(&ptrans, tpool); - - apr_setup_poll(&pollset, num_listenfds+1, tpool); - for(n=0 ; n <= num_listenfds ; ++n) { - apr_add_poll_socket(pollset, listenfds[n], APR_POLLIN); - } - - while (!workers_may_exit) { - workers_may_exit |= (max_requests_per_child != 0) && (requests_this_child <= 0); - if (workers_may_exit) break; - if (!thread_just_started) { - pthread_mutex_lock(&idle_thread_count_mutex); - if (idle_thread_count < max_spare_threads) { - idle_thread_count++; - pthread_mutex_unlock(&idle_thread_count_mutex); - } - else { - pthread_mutex_unlock(&idle_thread_count_mutex); - break; - } - } - else { - thread_just_started = 0; - } - pthread_mutex_lock(&thread_accept_mutex); - if (workers_may_exit) { - pthread_mutex_unlock(&thread_accept_mutex); - break; - } - if ((rv = SAFE_ACCEPT(apr_lock(process_accept_mutex))) - != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf, - "apr_lock failed. Attempting to shutdown " - "process gracefully."); - workers_may_exit = 1; - } - - while (!workers_may_exit) { - apr_int16_t event; - srv = apr_poll(pollset, &n, -1); - - if (srv != APR_SUCCESS) { - if (APR_STATUS_IS_EINTR(srv)) { - continue; - } - - /* apr_poll() will only return errors in catastrophic - * circumstances. Let's try exiting gracefully, for now. */ - ap_log_error(APLOG_MARK, APLOG_ERR, srv, (const server_rec *) - ap_server_conf, "apr_poll: (listen)"); - workers_may_exit = 1; - } - if (workers_may_exit) break; - - apr_get_revents(&event, listenfds[0], pollset); - if (event & APR_POLLIN) { - /* A process got a signal on the shutdown pipe. Check if we're - * the lucky process to die. */ - check_pipe_of_death(); - continue; - } - - apr_get_revents(&event, listenfds[1], pollset); - if (event & APR_POLLIN || event & APR_POLLOUT) { - /* This request is from another child in our current process. - * We should set a flag here, and then below we will read - * two bytes (the socket number and the NULL byte. - */ - thread_socket_table[thread_num] = -2; - goto got_from_other_child; - } - - if (num_listenfds == 1) { - sd = ap_listeners->sd; - goto got_fd; - } - else { - /* find a listener */ - curr_pollfd = last_pollfd; - do { - curr_pollfd++; - if (curr_pollfd > num_listenfds) { - curr_pollfd = 1; - } - /* XXX: Should we check for POLLERR? */ - apr_get_revents(&event, listenfds[curr_pollfd], pollset); - if (event & APR_POLLIN) { - last_pollfd = curr_pollfd; - sd = listenfds[curr_pollfd]; - goto got_fd; - } - } while (curr_pollfd != last_pollfd); - } - } - got_fd: - if (!workers_may_exit) { - if ((rv = apr_accept(&csd, sd, ptrans)) != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_ERR, rv, ap_server_conf, "apr_accept"); - } - if ((rv = SAFE_ACCEPT(apr_unlock(process_accept_mutex))) - != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf, - "apr_unlock failed. Attempting to shutdown " - "process gracefully."); - workers_may_exit = 1; - } - pthread_mutex_unlock(&thread_accept_mutex); - pthread_mutex_lock(&idle_thread_count_mutex); - if (idle_thread_count > min_spare_threads) { - idle_thread_count--; - } - else { - if (!start_thread()) { - idle_thread_count--; - } - } - pthread_mutex_unlock(&idle_thread_count_mutex); - got_from_other_child: - if (thread_socket_table[thread_num] == -2) { - struct msghdr msg; - struct cmsghdr *cmsg; - char sockname[80]; - struct iovec iov; - int ret, sd, dp; - - iov.iov_base = sockname; - iov.iov_len = 80; - - msg.msg_name = NULL; - msg.msg_namelen = 0; - msg.msg_iov = &iov; - msg.msg_iovlen = 1; - - cmsg = apr_palloc(ptrans, sizeof(*cmsg) + sizeof(sd)); - cmsg->cmsg_len = sizeof(*cmsg) + sizeof(sd); - msg.msg_control = cmsg; - msg.msg_controllen = cmsg->cmsg_len; - msg.msg_flags = 0; - - ret = recvmsg(child_info_table[child_num].sd, &msg, 0); - - memcpy(&dp, CMSG_DATA(cmsg), sizeof(dp)); - - thread_socket_table[thread_num] = dp; - apr_put_os_sock(&csd, &child_info_table[child_num].sd, ptrans); - } - if (setjmp(jmpbuffer) != 1) { - process_socket(ptrans, csd, conn_id); - } - else { - thread_socket_table[thread_num] = -1; - } - requests_this_child--; - } else { - if ((rv = SAFE_ACCEPT(apr_unlock(process_accept_mutex))) - != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf, - "apr_unlock failed. Attempting to shutdown " - "process gracefully."); - workers_may_exit = 1; - } - pthread_mutex_unlock(&thread_accept_mutex); - pthread_mutex_lock(&idle_thread_count_mutex); - idle_thread_count--; - pthread_mutex_unlock(&idle_thread_count_mutex); - break; - } - apr_clear_pool(ptrans); - } - - pthread_mutex_lock(&thread_pool_parent_mutex); - apr_destroy_pool(tpool); - pthread_mutex_unlock(&thread_pool_parent_mutex); - pthread_mutex_lock(&worker_thread_count_mutex); - worker_thread_count--; - worker_thread_free_ids[worker_thread_count] = thread_num; - if (worker_thread_count == 0) { - /* All the threads have exited, now finish the shutdown process - * by signalling the sigwait thread */ - kill(my_pid, SIGTERM); - } - pthread_mutex_unlock(&worker_thread_count_mutex); - - return NULL; -} - -/* Set group privileges. - * - * Note that we use the username as set in the config files, rather than - * the lookup of to uid --- the same uid may have multiple passwd entries, - * with different sets of groups for each. - */ - -static int set_group_privs(uid_t uid, gid_t gid) -{ - if (!geteuid()) { - const char *name; - - /* Get username if passed as a uid */ - - struct passwd *ent; - - if ((ent = getpwuid(uid)) == NULL) { - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, NULL, - "getpwuid: couldn't determine user name from uid %u, " - "you probably need to modify the User directive", - (unsigned)uid); - return -1; - } - - name = ent->pw_name; - - /* - * Set the GID before initgroups(), since on some platforms - * setgid() is known to zap the group list. - */ - if (setgid(gid) == -1) { - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, NULL, - "setgid: unable to set group id to Group %u", - (unsigned)gid); - return -1; - } - - /* Reset `groups' attributes. */ - - if (initgroups(name, gid) == -1) { - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, NULL, - "initgroups: unable to set groups for User %s " - "and Group %u", name, (unsigned)gid); - return -1; - } - } - return 0; -} - - -static int perchild_setup_child(int childnum) -{ - child_info_t *ug = &child_info_table[childnum]; - - if (ug->uid == -1 && ug->gid == -1) { - return unixd_setup_child(); - } - if (set_group_privs(ug->uid, ug->gid)) { - return -1; - } - /* Only try to switch if we're running as root */ - if (!geteuid() && ( -#ifdef _OSD_POSIX - os_init_job_environment(server_conf, unixd_config.user_name, one_process) != 0 || -#endif - setuid(ug->uid) == -1)) { - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, NULL, - "setuid: unable to change to uid: %ld", - (long) ug->uid); - return -1; - } - return 0; -} - -static void child_main(int child_num_arg) -{ - sigset_t sig_mask; - int signal_received; - int i; - ap_listen_rec *lr; - apr_status_t rv; - - my_pid = getpid(); - child_num = child_num_arg; - apr_create_pool(&pchild, pconf); - - /*stuff to do before we switch id's, so we have permissions.*/ - - rv = SAFE_ACCEPT(apr_child_init_lock(&process_accept_mutex, lock_fname, - pchild)); - if (rv != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_EMERG, rv, ap_server_conf, - "Couldn't initialize cross-process lock in child"); - clean_child_exit(APEXIT_CHILDFATAL); - } - - if (perchild_setup_child(child_num)) { - clean_child_exit(APEXIT_CHILDFATAL); - } - - ap_child_init_hook(pchild, ap_server_conf); - - /*done with init critical section */ - - /* All threads should mask signals out, accoring to sigwait(2) man page */ - sigfillset(&sig_mask); - -#ifdef SIGPROCMASK_SETS_THREAD_MASK - if (sigprocmask(SIG_SETMASK, &sig_mask, NULL) != 0) { - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf, "sigprocmask"); - } -#else - if ((rv = pthread_sigmask(SIG_SETMASK, &sig_mask, NULL)) != 0) { -#ifdef PTHREAD_SETS_ERRNO - rv = errno; -#endif - ap_log_error(APLOG_MARK, APLOG_ALERT, rv, ap_server_conf, - "pthread_sigmask"); - } -#endif - - requests_this_child = max_requests_per_child; - - /* Set up the pollfd array, num_listenfds + 1 for the pipe and 1 for - * the child socket. - */ - listenfds = apr_pcalloc(pchild, sizeof(*listenfds) * (num_listenfds + 2)); -#if APR_FILES_AS_SOCKETS - apr_socket_from_file(&listenfds[0], pipe_of_death_in); -#endif - - /* The child socket */ - apr_put_os_sock(&listenfds[1], &child_info_table[child_num].sd, pchild); - - num_listenfds++; - for (lr = ap_listeners, i = 2; i <= num_listenfds; lr = lr->next, ++i) - listenfds[i]=lr->sd; - - /* Setup worker threads */ - - if (threads_to_start > max_threads) { - threads_to_start = max_threads; - } - idle_thread_count = threads_to_start; - worker_thread_count = 0; - for (i = 0; i < max_threads; i++) { - worker_thread_free_ids[i] = i; - } - apr_create_pool(&thread_pool_parent, pchild); - pthread_mutex_init(&thread_pool_parent_mutex, NULL); - pthread_mutex_init(&idle_thread_count_mutex, NULL); - pthread_mutex_init(&worker_thread_count_mutex, NULL); - pthread_mutex_init(&pipe_of_death_mutex, NULL); - pthread_attr_init(&worker_thread_attr); -#ifdef PTHREAD_ATTR_SETDETACHSTATE_ARG2_ADDR - { - int on = 1; - - pthread_attr_setdetachstate(&worker_thread_attr, &on); - } -#else - pthread_attr_setdetachstate(&worker_thread_attr, PTHREAD_CREATE_DETACHED); -#endif - - /* We are creating worker threads right now */ - for (i=0; i < threads_to_start; i++) { - /* start_thread shouldn't fail here */ - if (!start_thread()) { - break; - } - } - - /* This thread will be the one responsible for handling signals */ - sigemptyset(&sig_mask); - sigaddset(&sig_mask, SIGTERM); - sigaddset(&sig_mask, SIGINT); - ap_sigwait(&sig_mask, &signal_received); - switch (signal_received) { - case SIGTERM: - case SIGINT: - just_die(signal_received); - break; - default: - ap_log_error(APLOG_MARK, APLOG_ALERT, errno, ap_server_conf, - "received impossible signal: %d", signal_received); - just_die(SIGTERM); - } -} - -static int make_child(server_rec *s, int slot, time_t now) -{ - int pid; - - if (slot + 1 > ap_max_daemons_limit) { - ap_max_daemons_limit = slot + 1; - } - - if (one_process) { - set_signals(); - ap_child_table[slot].pid = getpid(); - ap_child_table[slot].status = SERVER_ALIVE; - child_main(slot); - } - - if ((pid = fork()) == -1) { - ap_log_error(APLOG_MARK, APLOG_ERR, errno, s, - "fork: Unable to fork new process"); - /* In case system resources are maxxed out, we don't want - Apache running away with the CPU trying to fork over and - over and over again. */ - sleep(10); - - return -1; - } - - if (!pid) { -#ifdef AIX_BIND_PROCESSOR - /* By default, AIX binds to a single processor. This bit unbinds - children which will then bind to another CPU. - */ -#include - int status = bindprocessor(BINDPROCESS, (int)getpid(), - PROCESSOR_CLASS_ANY); - if (status != OK) - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, errno, - ap_server_conf, "processor unbind failed %d", status); -#endif - - RAISE_SIGSTOP(MAKE_CHILD); - - /* XXX - For an unthreaded server, a signal handler will be necessary - apr_signal(SIGTERM, just_die); - */ - child_main(slot); - - return 0; - } - /* else */ - ap_child_table[slot].pid = pid; - ap_child_table[slot].status = SERVER_ALIVE; - - return 0; -} - -/* start up a bunch of children */ -static int startup_children(int number_to_start) -{ - int i; - - for (i = 0; number_to_start && i < num_daemons; ++i) { - if (ap_child_table[i].pid) { - continue; - } - if (make_child(ap_server_conf, i, 0) < 0) { - break; - } - --number_to_start; - } - return number_to_start; -} - - -/* - * spawn_rate is the number of children that will be spawned on the - * next maintenance cycle if there aren't enough servers. It is - * doubled up to MAX_SPAWN_RATE, and reset only when a cycle goes by - * without the need to spawn. - */ -static int spawn_rate = 1; -#ifndef MAX_SPAWN_RATE -#define MAX_SPAWN_RATE (32) -#endif -static int hold_off_on_exponential_spawning; - -static void perform_child_maintenance(void) -{ - int i; - time_t now = 0; - int free_length; - int free_slots[MAX_SPAWN_RATE]; - int last_non_dead = -1; - - /* initialize the free_list */ - free_length = 0; - - for (i = 0; i < num_daemons; ++i) { - if (ap_child_table[i].pid == 0) { - if (free_length < spawn_rate) { - free_slots[free_length] = i; - ++free_length; - } - } - else { - last_non_dead = i; - } - - if (i >= ap_max_daemons_limit && free_length >= spawn_rate) { - break; - } - } - ap_max_daemons_limit = last_non_dead + 1; - - if (free_length > 0) { - for (i = 0; i < free_length; ++i) { - make_child(ap_server_conf, free_slots[i], now); - } - /* the next time around we want to spawn twice as many if this - * wasn't good enough, but not if we've just done a graceful - */ - if (hold_off_on_exponential_spawning) { - --hold_off_on_exponential_spawning; - } - else if (spawn_rate < MAX_SPAWN_RATE) { - spawn_rate *= 2; - } - } - else { - spawn_rate = 1; - } -} - -static void server_main_loop(int remaining_children_to_start) -{ - int child_slot; - apr_wait_t status; - apr_proc_t pid; - int i; - - while (!restart_pending && !shutdown_pending) { - ap_wait_or_timeout(&status, &pid, pconf); - - if (pid.pid != -1) { - ap_process_child_status(&pid, status); - /* non-fatal death... note that it's gone in the child table and - * clean out the status table. */ - child_slot = -1; - for (i = 0; i < ap_max_daemons_limit; ++i) { - if (ap_child_table[i].pid == pid.pid) { - int j; - - child_slot = i; - for (j = 0; j < HARD_THREAD_LIMIT; j++) { - ap_perchild_force_reset_connection_status(i * HARD_THREAD_LIMIT + j); - } - break; - } - } - if (child_slot >= 0) { - ap_child_table[child_slot].pid = 0; - - if (remaining_children_to_start - && child_slot < num_daemons) { - /* we're still doing a 1-for-1 replacement of dead - * children with new children - */ - make_child(ap_server_conf, child_slot, time(NULL)); - --remaining_children_to_start; - } -#if APR_HAS_OTHER_CHILD - } - else if (apr_reap_other_child(&pid, status) == 0) { - /* handled */ -#endif - } - else if (is_graceful) { - /* Great, we've probably just lost a slot in the - * child table. Somehow we don't know about this - * child. - */ - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_WARNING, 0, - ap_server_conf, - "long lost child came home! (pid %ld)", - (long)pid.pid); - } - /* Don't perform idle maintenance when a child dies, - * only do it when there's a timeout. Remember only a - * finite number of children can die, and it's pretty - * pathological for a lot to die suddenly. - */ - continue; - } - else if (remaining_children_to_start) { - /* we hit a 1 second timeout in which none of the previous - * generation of children needed to be reaped... so assume - * they're all done, and pick up the slack if any is left. - */ - remaining_children_to_start = \ - startup_children(remaining_children_to_start); - /* In any event we really shouldn't do the code below because - * few of the servers we just started are in the IDLE state - * yet, so we'd mistakenly create an extra server. - */ - continue; - } - - perform_child_maintenance(); - } -} - -int ap_mpm_run(apr_pool_t *_pconf, apr_pool_t *plog, server_rec *s) -{ - int remaining_children_to_start; - int i; - apr_status_t rv; - apr_size_t one = 1; - - pconf = _pconf; - ap_server_conf = s; - if ((rv = apr_create_pipe(&pipe_of_death_in, &pipe_of_death_out, pconf)) - != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_ERR, rv, - (const server_rec*) ap_server_conf, - "apr_create_pipe (pipe_of_death)"); - exit(1); - } - if ((rv = apr_set_pipe_timeout(pipe_of_death_in, 0)) != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_ERR, rv, - (const server_rec*) ap_server_conf, - "apr_set_pipe_timeout (pipe_of_death)"); - exit(1); - } - ap_server_conf = s; - if ((num_listenfds = ap_setup_listeners(ap_server_conf)) < 1) { - /* XXX: hey, what's the right way for the mpm to indicate a fatal error? */ - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ALERT, 0, s, - "no listening sockets available, shutting down"); - return 1; - } - ap_log_pid(pconf, ap_pid_fname); - - /* Initialize cross-process accept lock */ - lock_fname = apr_psprintf(_pconf, "%s.%u", - ap_server_root_relative(_pconf, lock_fname), - my_pid); - rv = SAFE_ACCEPT(apr_create_lock(&process_accept_mutex, APR_MUTEX, - APR_CROSS_PROCESS, lock_fname, _pconf)); - if (rv != APR_SUCCESS) { - ap_log_error(APLOG_MARK, APLOG_EMERG, rv, s, - "Couldn't create cross-process lock"); - return 1; - } - - if (!is_graceful) { - reinit_scoreboard(pconf); - } - /* Initialize the child table */ - if (!is_graceful) { - for (i = 0; i < HARD_SERVER_LIMIT; i++) { - ap_child_table[i].pid = 0; - } - } - - set_signals(); - - /* If we're doing a graceful_restart then we're going to see a lot - * of children exiting immediately when we get into the main loop - * below (because we just sent them SIGWINCH). This happens pretty - * rapidly... and for each one that exits we'll start a new one until - * we reach at least daemons_min_free. But we may be permitted to - * start more than that, so we'll just keep track of how many we're - * supposed to start up without the 1 second penalty between each fork. - */ - remaining_children_to_start = num_daemons; - if (!is_graceful) { - remaining_children_to_start = \ - startup_children(remaining_children_to_start); - } - else { - /* give the system some time to recover before kicking into - * exponential mode */ - hold_off_on_exponential_spawning = 10; - } - - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf, - "%s configured -- resuming normal operations", - ap_get_server_version()); - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, ap_server_conf, - "Server built: %s", ap_get_server_built()); - restart_pending = shutdown_pending = 0; - - server_main_loop(remaining_children_to_start); - - if (shutdown_pending) { - /* Time to gracefully shut down: - * Kill child processes, tell them to call child_exit, etc... - */ - if (unixd_killpg(getpgrp(), SIGTERM) < 0) { - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, - "killpg SIGTERM"); - } - ap_reclaim_child_processes(1); /* Start with SIGTERM */ - - /* cleanup pid file on normal shutdown */ - { - const char *pidfile = NULL; - pidfile = ap_server_root_relative (pconf, ap_pid_fname); - if ( pidfile != NULL && unlink(pidfile) == 0) - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, - ap_server_conf, - "removed PID file %s (pid=%ld)", - pidfile, (long)getpid()); - } - - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, - ap_server_conf, "caught SIGTERM, shutting down"); - - return 1; - } - - /* we've been told to restart */ - apr_signal(SIGHUP, SIG_IGN); - - if (one_process) { - /* not worth thinking about */ - return 1; - } - - if (is_graceful) { - char char_of_death = '!'; - - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, ap_server_conf, - "SIGWINCH received. Doing graceful restart"); - - /* This is mostly for debugging... so that we know what is still - * gracefully dealing with existing request. - */ - - for (i = 0; i < num_daemons; ++i) { - if (ap_child_table[i].pid) { - ap_child_table[i].status = SERVER_DYING; - } - } - /* give the children the signal to die */ - for (i = 0; i < num_daemons;) { - if ((rv = apr_write(pipe_of_death_out, &char_of_death, &one)) != APR_SUCCESS) { - if (APR_STATUS_IS_EINTR(rv)) continue; - ap_log_error(APLOG_MARK, APLOG_WARNING, rv, ap_server_conf, - "write pipe_of_death"); - } - i++; - } - } - else { - /* Kill 'em all. Since the child acts the same on the parents SIGTERM - * and a SIGHUP, we may as well use the same signal, because some user - * pthreads are stealing signals from us left and right. - */ - if (unixd_killpg(getpgrp(), SIGTERM) < 0) { - ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, - "killpg SIGTERM"); - } - ap_reclaim_child_processes(1); /* Start with SIGTERM */ - ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, - ap_server_conf, "SIGHUP received. Attempting to restart"); - } - return 0; -} - -static void perchild_pre_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp) -{ - static int restart_num = 0; - int no_detach = 0; - int i; - - one_process = !!getenv("ONE_PROCESS"); - no_detach = !!getenv("NO_DETACH"); - - /* sigh, want this only the second time around */ - if (restart_num++ == 1) { - is_graceful = 0; - - if (!one_process && !no_detach) { - apr_detach(); - } - - my_pid = getpid(); - } - - unixd_pre_config(ptemp); - ap_listen_pre_config(); - num_daemons = DEFAULT_NUM_DAEMON; - threads_to_start = DEFAULT_START_THREAD; - min_spare_threads = DEFAULT_MIN_SPARE_THREAD; - max_spare_threads = DEFAULT_MAX_SPARE_THREAD; - max_threads = HARD_THREAD_LIMIT; - ap_pid_fname = DEFAULT_PIDLOG; - ap_scoreboard_fname = DEFAULT_SCOREBOARD; - lock_fname = DEFAULT_LOCKFILE; - max_requests_per_child = DEFAULT_MAX_REQUESTS_PER_CHILD; - ap_perchild_set_maintain_connection_status(1); - curr_child_num = 0; - - apr_cpystrn(ap_coredump_dir, ap_server_root, sizeof(ap_coredump_dir)); - - for (i = 0; i < HARD_SERVER_LIMIT; i++) { - child_info_table[i].uid = -1; - child_info_table[i].gid = -1; - child_info_table[i].sd = -1; - } - for (i = 0; i < HARD_THREAD_LIMIT; i++) { - thread_socket_table[i] = -1; - } -} - -static int pass_request(request_rec *r) -{ - apr_socket_t *thesock = r->connection->client->bsock; - struct msghdr msg; - struct cmsghdr *cmsg; - int sfd; - struct iovec iov; - char *foo = r->connection->client->inbase; - int len = r->connection->client->inptr - r->connection->client->inbase; - perchild_server_conf *sconf = (perchild_server_conf *) - ap_get_module_config(r->server->module_config, - &mpm_perchild_module); - - apr_get_os_sock(&sfd, thesock); - - iov.iov_base = (char *)sconf->fullsockname; - iov.iov_len = strlen(sconf->fullsockname) + 1; - - msg.msg_name = NULL; - msg.msg_namelen = 0; - msg.msg_iov = &iov; - msg.msg_iovlen = 1; - - cmsg = apr_palloc(r->pool, sizeof(*cmsg) + sizeof(sfd)); - cmsg->cmsg_len = sizeof(*cmsg) + sizeof(int); - cmsg->cmsg_level = SOL_SOCKET; - cmsg->cmsg_type = SCM_RIGHTS; - - memcpy(CMSG_DATA(cmsg), &sfd, sizeof(sfd)); - - msg.msg_control = cmsg; - msg.msg_controllen = cmsg->cmsg_len; - msg.msg_flags=0; - - if (sendmsg(sconf->sd2, &msg, 0) == -1) { - apr_destroy_pool(r->pool); - return -1; - } - - write(sconf->sd2, foo, len); - - apr_destroy_pool(r->pool); - return 1; -} - -static char *make_perchild_socket(const char *fullsockname, int sd[2]) -{ - socketpair(PF_UNIX, SOCK_STREAM, 0, sd); - return NULL; -} - - -static void perchild_post_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s) -{ - int i; - server_rec *sr; - perchild_server_conf *sconf; - int def_sd[2]; - - def_sd[0] = -1; - def_sd[1] = -1; - - for (sr = s; sr; sr = sr->next) { - sconf = (perchild_server_conf *)ap_get_module_config(sr->module_config, - &mpm_perchild_module); - - if (sconf->sd == -1) { - sconf->fullsockname = apr_pstrcat(sr->process->pool, - sconf->sockname, ".DEFAULT", NULL); - if (def_sd[0] == -1) { - if (!make_perchild_socket(sconf->fullsockname, def_sd)) { - /* log error */ - } - } - sconf->sd = def_sd[0]; - sconf->sd2 = def_sd[1]; - } - } - - for (i = 0; i < num_daemons; i++) { - if (child_info_table[i].uid == -1) { - child_info_table[i].sd = def_sd[0]; - } - } -} - -static int perchild_post_read(request_rec *r) -{ - int thread_num = r->connection->id % HARD_THREAD_LIMIT; - perchild_server_conf *sconf = (perchild_server_conf *) - ap_get_module_config(r->server->module_config, - &mpm_perchild_module); - - if (thread_socket_table[thread_num] != -1) { - apr_socket_t *csd = NULL; - - apr_put_os_sock(&csd, &thread_socket_table[thread_num], - r->connection->client->pool); - ap_sock_disable_nagle(thread_socket_table[thread_num]); - ap_bpush_socket(r->connection->client, csd); - return OK; - } - else { - if (sconf->sd != child_info_table[child_num].sd) { - if (pass_request(r) == -1) { - ap_log_error(APLOG_MARK, APLOG_ERR | APLOG_NOERRNO, 0, - ap_server_conf, "Could not pass request to proper " - "child, request will not be honored."); - } - longjmp(jmpbuffer, 1); - } - return OK; - } - return OK; -} - -static void perchild_hooks(void) -{ - INIT_SIGLIST() - one_process = 0; - - ap_hook_pre_config(perchild_pre_config, NULL, NULL, AP_HOOK_MIDDLE); - ap_hook_post_config(perchild_post_config, NULL, NULL, AP_HOOK_MIDDLE); - /* This must be run absolutely first. If this request isn't for this - * server then we need to forward it to the proper child. No sense - * tying up this server running more post_read request hooks if it is - * just going to be forwarded along. - */ - ap_hook_post_read_request(perchild_post_read, NULL, NULL, AP_HOOK_REALLY_FIRST); -} - -static const char *set_pidfile(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - if (cmd->server->is_virtual) { - return "PidFile directive not allowed in "; - } - ap_pid_fname = arg; - return NULL; -} - -static const char *set_scoreboard(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - ap_scoreboard_fname = arg; - return NULL; -} - -static const char *set_lockfile(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - lock_fname = arg; - return NULL; -} -static const char *set_num_daemons (cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - num_daemons = atoi(arg); - if (num_daemons > HARD_SERVER_LIMIT) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: NumServers of %d exceeds compile time limit " - "of %d servers,", num_daemons, HARD_SERVER_LIMIT); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - " lowering NumServers to %d. To increase, please " - "see the", HARD_SERVER_LIMIT); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - " HARD_SERVER_LIMIT define in %s.", - AP_MPM_HARD_LIMITS_FILE); - num_daemons = HARD_SERVER_LIMIT; - } - else if (num_daemons < 1) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: Require NumServers > 0, setting to 1"); - num_daemons = 1; - } - return NULL; -} - -static const char *set_threads_to_start (cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - threads_to_start = atoi(arg); - if (threads_to_start > HARD_THREAD_LIMIT) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: StartThreads of %d exceeds compile time" - " limit of %d threads,", threads_to_start, - HARD_THREAD_LIMIT); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - " lowering StartThreads to %d. To increase, please" - " see the", HARD_THREAD_LIMIT); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - " HARD_THREAD_LIMIT define in %s.", - AP_MPM_HARD_LIMITS_FILE); - } - else if (threads_to_start < 1) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: Require StartThreads > 0, setting to 1"); - threads_to_start = 1; - } - return NULL; -} - -static const char *set_min_spare_threads(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - min_spare_threads = atoi(arg); - if (min_spare_threads <= 0) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: detected MinSpareThreads set to non-positive."); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "Resetting to 1 to avoid almost certain Apache failure."); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "Please read the documentation."); - min_spare_threads = 1; - } - - return NULL; -} - -static const char *set_max_spare_threads(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - max_spare_threads = atoi(arg); - if (max_spare_threads >= HARD_THREAD_LIMIT) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: detected MinSpareThreads set higher than"); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "HARD_THREAD_LIMIT. Resetting to %d", HARD_THREAD_LIMIT); - max_spare_threads = HARD_THREAD_LIMIT; - } - return NULL; -} - -static const char *set_max_threads(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - max_threads = atoi(arg); - if (max_threads > HARD_THREAD_LIMIT) { - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "WARNING: detected MaxThreadsPerChild set higher than"); - ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL, - "HARD_THREAD_LIMIT. Resetting to %d", HARD_THREAD_LIMIT); - max_threads = HARD_THREAD_LIMIT; - } - return NULL; -} - -static const char *set_max_requests(cmd_parms *cmd, void *dummy, const char *arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - max_requests_per_child = atoi(arg); - - return NULL; -} - -static const char *set_maintain_connection_status(cmd_parms *cmd, - void *dummy, int arg) -{ - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - ap_perchild_set_maintain_connection_status(arg != 0); - return NULL; -} - -static const char *set_coredumpdir (cmd_parms *cmd, void *dummy, const char *arg) -{ - apr_finfo_t finfo; - const char *fname; - const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY); - if (err != NULL) { - return err; - } - - fname = ap_server_root_relative(cmd->pool, arg); - if ((apr_stat(&finfo, fname, cmd->pool) != APR_SUCCESS) || - (finfo.filetype != APR_DIR)) { - return apr_pstrcat(cmd->pool, "CoreDumpDirectory ", fname, - " does not exist or is not a directory", NULL); - } - apr_cpystrn(ap_coredump_dir, fname, sizeof(ap_coredump_dir)); - return NULL; -} - -static const char *set_child_per_uid(cmd_parms *cmd, void *dummy, const char *u, - const char *g, const char *num) -{ - int i; - int max_this_time = atoi(num) + curr_child_num; - for (i = curr_child_num; i < max_this_time; i++, curr_child_num++); { - child_info_t *ug = &child_info_table[i - 1]; - - if (i > num_daemons) { - return "Trying to use more child ID's than NumServers. Increase " - "NumServers in your config file."; - } - - ug->uid = atoi(u); - ug->gid = atoi(g); - } - return NULL; -} - -static const char *assign_childuid(cmd_parms *cmd, void *dummy, const char *uid, - const char *gid) -{ - int i; - int u = atoi(uid); - int g = atoi(gid); - const char *errstr; - int socks[2]; - perchild_server_conf *sconf = (perchild_server_conf *) - ap_get_module_config(cmd->server->module_config, - &mpm_perchild_module); - - sconf->fullsockname = apr_pstrcat(cmd->pool, sconf->sockname, ".", uid, ":", gid, NULL); - - if ((errstr = make_perchild_socket(sconf->fullsockname, socks))) { - return errstr; - } - - sconf->sd = socks[0]; - sconf->sd2 = socks[1]; - - for (i = 0; i < num_daemons; i++) { - if (u == child_info_table[i].uid && g == child_info_table[i].gid) { - child_info_table[i].sd = sconf->sd; - } - } - - return NULL; -} - - -static const command_rec perchild_cmds[] = { -UNIX_DAEMON_COMMANDS -LISTEN_COMMANDS -AP_INIT_TAKE1("PidFile", set_pidfile, NULL, RSRC_CONF, - "A file for logging the server process ID"), -AP_INIT_TAKE1("ScoreBoardFile", set_scoreboard, NULL, RSRC_CONF, - "A file for Apache to maintain runtime process management information"), -AP_INIT_TAKE1("LockFile", set_lockfile, NULL, RSRC_CONF, - "The lockfile used when Apache needs to lock the accept() call"), -AP_INIT_TAKE1("NumServers", set_num_daemons, NULL, RSRC_CONF, - "Number of children alive at the same time"), -AP_INIT_TAKE1("StartThreads", set_threads_to_start, NULL, RSRC_CONF, - "Number of threads each child creates"), -AP_INIT_TAKE1("MinSpareThreads", set_min_spare_threads, NULL, RSRC_CONF, - "Minimum number of idle threads per child, to handle request spikes"), -AP_INIT_TAKE1("MaxSpareThreads", set_max_spare_threads, NULL, RSRC_CONF, - "Maximum number of idle threads per child"), -AP_INIT_TAKE1("MaxThreadsPerChild", set_max_threads, NULL, RSRC_CONF, - "Maximum number of threads per child"), -AP_INIT_TAKE1("MaxRequestsPerChild", set_max_requests, NULL, RSRC_CONF, - "Maximum number of requests a particular child serves before dying."), -AP_INIT_FLAG("ConnectionStatus", set_maintain_connection_status, NULL, RSRC_CONF, - "Whether or not to maintain status information on current connections"), -AP_INIT_TAKE1("CoreDumpDirectory", set_coredumpdir, NULL, RSRC_CONF, - "The location of the directory Apache changes to before dumping core"), -AP_INIT_TAKE3("ChildperUserID", set_child_per_uid, NULL, RSRC_CONF, - "Specify a User and Group for a specific child process."), -AP_INIT_TAKE2("AssignUserID", assign_childuid, NULL, RSRC_CONF, - "Tie a virtual host to a specific child process."), -{ NULL } -}; - -static void *perchild_create_config(apr_pool_t *p, server_rec *s) -{ - perchild_server_conf *c = - (perchild_server_conf *) apr_pcalloc(p, sizeof(perchild_server_conf)); - - c->sd = -1; - return c; -} - -module AP_MODULE_DECLARE_DATA mpm_perchild_module = { - MPM20_MODULE_STUFF, - NULL, /* hook to run before apache parses args */ - NULL, /* create per-directory config structure */ - NULL, /* merge per-directory config structures */ - perchild_create_config, /* create per-server config structure */ - NULL, /* merge per-server config structures */ - perchild_cmds, /* command apr_table_t */ - NULL, /* handlers */ - perchild_hooks /* register_hooks */ -}; - diff --git a/srclib/expat-lite/libexpat.def b/srclib/expat-lite/libexpat.def deleted file mode 100644 index c1f81676913..00000000000 --- a/srclib/expat-lite/libexpat.def +++ /dev/null @@ -1,51 +0,0 @@ -; expatlib.def - -LIBRARY expatlib -DESCRIPTION '' - -EXPORTS - XmlGetUtf16InternalEncoding - XmlGetUtf8InternalEncoding - XmlInitEncoding - XmlInitUnknownEncoding - XmlParseXmlDecl - XmlPrologStateInit - XmlSizeOfUnknownEncoding - XmlUtf16Encode - XmlUtf8Encode - - XML_DefaultCurrent - XML_ErrorString - XML_ExternalEntityParserCreate - XML_GetBase - XML_GetBuffer - XML_GetCurrentByteCount - XML_GetCurrentByteIndex - XML_GetCurrentColumnNumber - XML_GetCurrentLineNumber - XML_GetErrorCode - XML_GetSpecifiedAttributeCount - XML_Parse - XML_ParseBuffer - XML_ParserCreate - XML_ParserCreateNS - XML_ParserFree - XML_SetBase - XML_SetCdataSectionHandler - XML_SetCharacterDataHandler - XML_SetCommentHandler - XML_SetDefaultHandler - XML_SetDefaultHandlerExpand - XML_SetElementHandler - XML_SetEncoding - XML_SetExternalEntityRefHandler - XML_SetExternalEntityRefHandlerArg - XML_SetNamespaceDeclHandler - XML_SetNotStandaloneHandler - XML_SetNotationDeclHandler - XML_SetProcessingInstructionHandler - XML_SetUnknownEncodingHandler - XML_SetUnparsedEntityDeclHandler - XML_SetUserData - XML_UseParserAsHandlerArg - diff --git a/srclib/expat-lite/libexpat.dsp b/srclib/expat-lite/libexpat.dsp deleted file mode 100644 index 66b3f40dbf2..00000000000 --- a/srclib/expat-lite/libexpat.dsp +++ /dev/null @@ -1,124 +0,0 @@ -# Microsoft Developer Studio Project File - Name="expatlib" - Package Owner=<4> -# Microsoft Developer Studio Generated Build File, Format Version 6.00 -# ** DO NOT EDIT ** - -# TARGTYPE "Win32 (x86) Dynamic-Link Library" 0x0102 - -CFG=expatlib - Win32 Debug -!MESSAGE This is not a valid makefile. To build this project using NMAKE, -!MESSAGE use the Export Makefile command and run -!MESSAGE -!MESSAGE NMAKE /f "expatlib.mak". -!MESSAGE -!MESSAGE You can specify a configuration when running NMAKE -!MESSAGE by defining the macro CFG on the command line. For example: -!MESSAGE -!MESSAGE NMAKE /f "expatlib.mak" CFG="expatlib - Win32 Debug" -!MESSAGE -!MESSAGE Possible choices for configuration are: -!MESSAGE -!MESSAGE "expatlib - Win32 Release" (based on "Win32 (x86) Dynamic-Link Library") -!MESSAGE "expatlib - Win32 Debug" (based on "Win32 (x86) Dynamic-Link Library") -!MESSAGE - -# Begin Project -# PROP AllowPerConfigDependencies 0 -# PROP Scc_ProjName "" -# PROP Scc_LocalPath "" -CPP=cl.exe -MTL=midl.exe -RSC=rc.exe - -!IF "$(CFG)" == "expatlib - Win32 Release" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 0 -# PROP BASE Output_Dir "Release" -# PROP BASE Intermediate_Dir "Release" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 0 -# PROP Output_Dir "expatlibR" -# PROP Intermediate_Dir "expatlibR" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /MT /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "XMLTOK_EXPORTS" /D "XMLPARSE_EXPORTS" /YX /FD /c -# ADD CPP /nologo /MD /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "XMLTOK_EXPORTS" /D "XMLPARSE_EXPORTS" /FD /c -# SUBTRACT CPP /YX -# ADD BASE MTL /nologo /D "NDEBUG" /mktyplib203 /win32 -# ADD MTL /nologo /D "NDEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0x409 /d "NDEBUG" -# ADD RSC /l 0x409 /d "NDEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 /nologo /dll /machine:I386 -# ADD LINK32 /nologo /dll /machine:I386 /base:@"..\..\os\win32\BaseAddr.ref",expatlib -# SUBTRACT LINK32 /pdb:none - -!ELSEIF "$(CFG)" == "expatlib - Win32 Debug" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 1 -# PROP BASE Output_Dir "Debug" -# PROP BASE Intermediate_Dir "Debug" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 1 -# PROP Output_Dir "expatlibD" -# PROP Intermediate_Dir "expatlibD" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /MTd /W3 /Gm /GX /ZI /Od /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "XMLTOK_EXPORTS" /D "XMLPARSE_EXPORTS" /YX /FD /GZ /c -# ADD CPP /nologo /MDd /W3 /Gm /GX /ZI /Od /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "XMLTOK_EXPORTS" /D "XMLPARSE_EXPORTS" /FD /GZ /c -# SUBTRACT CPP /YX -# ADD BASE MTL /nologo /D "_DEBUG" /mktyplib203 /win32 -# ADD MTL /nologo /D "_DEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0x409 /d "_DEBUG" -# ADD RSC /l 0x409 /d "_DEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 /nologo /dll /debug /machine:I386 -# ADD LINK32 /nologo /dll /debug /machine:I386 /base:@"..\..\os\win32\BaseAddr.ref",expatlib -# SUBTRACT LINK32 /pdb:none - -!ENDIF - -# Begin Target - -# Name "expatlib - Win32 Release" -# Name "expatlib - Win32 Debug" -# Begin Source File - -SOURCE="..\..\lib\expat-lite\hashtable.c" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\xmlparse.c" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\xmlparse.h" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\dllmain.c" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\xmlrole.c" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\xmltok.c" -# End Source File -# Begin Source File - -SOURCE="..\..\lib\expat-lite\expatlib.def" -# End Source File - -# End Target -# End Project