The $r->method_number method will return the request method number. The method numbers are defined by the M_GET, M_POST,... constants available from the Apache::Constants module. Passing an argument will set the method_number, mainly used for internal redirects and testing authorization restriction masks.

The number of bytes sent to the client, handy for logging, etc.

The request line send by the client, handy for logging, etc.

Returns true if the request is proxy http. Mainly used during the filename translation stage of the request, which may be handled by a PerlTransHandler.

Returns true if the client is asking for headers only, e.g. if the request method was HEAD.

The $r->protocol method will return a string identifying the protocol that the client speaks. Typical values will be ``HTTP/1.0'' or ``HTTP/1.1''.

The $r->uri method will return the requested URI, optionally changing it with the first argument.

The $r->filename method will return the result of the URI --> filename translation, optionally changing it with the first argument if you happen to be doing the translation.

The $r->path_info method will return what is left in the path after the URI --> filename translation, optionally changing it with the first argument if you happen to be doing the translation.

The $r->args method will return the contents of the URI query string. When called in a scalar context, the entire string is returned. When called in a list context, a list of parsed key => value pairs are returned, i.e. it can be used like this:

   $query = $r->args;
   %in    = $r->args;

Return the value of a client header. Can be used like this:

   $ct = $r->header_in("Content-type");
   $r->header_in($key, $val); #set the value of header '$key'

The $r->content method will return the entity body read from the client, but only if the request content type is application/x-www-form-urlencoded. When called in a scalar context, the entire string is returned. When called in a list context, a list of parsed key => value pairs are returned. *NOTE*: you can only ask for this once, as the entire body is read from the client.

Lookup the client's DNS hostname. If the configuration directive HostNameLookups is set to off, this returns the dotted decimal representation of the client's IP address instead. Might return undef if the hostname is not known.

Lookup the remote user's system name. Might return undef if the remote system is not running an RFC 1413 server or if the configuration directive IdentityCheck is not turned on.

$c = $r->connection

The $r->connection method will return a reference to the request connection object (blessed into the Apache::Connection package). This is really a conn_rec* in disguise. The following methods can be used on the connection object:

If the configuration directive HostNameLookups is set to on: then the first time $r->get_remote_host is called the server does a DNS lookup to get the remote client's host name. The result is cached in $c->remote_host then returned. If the server was unable to resolve the remote client's host name this will be set to ``''. Subsequent calls to $r->get_remote_host return this cached value.

If the configuration directive HostNameLookups is set to off: calls to $r->get_remote_host return a string that contains the dotted decimal representation of the remote client's IP address. However this string is not cached, and $c->remote_host is undefined. So, it's best to to call $r->get_remote_host instead of directly accessing this variable.

The dotted decimal representation of the remote client's IP address. This is set by then server when the connection record is created so is always defined.

A packed SOCKADDR_IN in the same format as returned by Socket, containing the port and address on the local host that the remote client is connected to. This is set by the server when the connection record is created so it is always defined.

A packed SOCKADDR_IN in the same format as returned by Socket, containing the port and address on the remote host that the server is connected to. This is set by the server when the connection record is created so it is always defined.

Among other things, this can be used, together with $c->local_addr, to perform RFC1413 ident lookups on the remote client even when the configuration directive IdentityCheck is turned off.

Can be used like:

   use Net::Ident qw (lookupFromInAddr);
   ...
   my $remoteuser = lookupFromInAddr ($c->local_addr,
  $c->remote_addr, 2);

Note that the lookupFromInAddr interface does not currently exist in the Net::Ident module, but the author is planning on adding it soon.

If the configuration directive IdentityCheck is set to on: then the first time $r->get_remote_logname is called the server does an RFC 1413 (ident) lookup to get the remote users system name. Generally for UNI* systems this is their login. The result is cached in $c->remote_logname then returned. Subsequent calls to $r->get_remote_host return the cached value.

If the configuration directive IdentityCheck is set to off: then $r->get_remote_logname does nothing and $c->remote_logname is always undefined.

If an authentication check was successful, the authentication handler caches the user name here.

Returns the authentication scheme that successfully authenticate $c->user, if any.

Returns true if the client stopped talking to us.

SERVER CONFIGURATION INFORMATION

Returns the value of a per-directory variable specified by the PerlSetVar directive.

   # 
   # SetPerlVar  Key  Value
   # 

   my $val = $r->dir_config('Key');

Returns an array reference of hash references, containing information related to the require directive. This is normally used for access control, see Apache for an example.

Returns a reference to the current value of the per directory configuration directive AuthType. Normally this would be set to Basic to use the basic authentication scheme defined in RFC 1945, Hypertext Transfer Protocol -- HTTP/1.0. However, you could set to something else and implement your own authentication scheme.

Returns a reference to the current value of the per directory configuration directive AuthName. The AuthName directive creates protection realm within the server document space. To quote RFC 1945 ``These realms allow the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme and/or authorization database.'' The client uses the root URL of the server to determine which authentication credentials to send with each HTTP request. These credentials are tagged with the name of the authentication realm that created them. Then during the authentication stage the server uses the current authentication realm, from $r->auth_name, to determine which set of credentials to authenticate.

Returns a reference to the current value of the per server configuration directive DocumentRoot. To quote the Apache server documentation, ``Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document.'' This same value is passed to CGI scripts in the DOCUMENT_ROOT environment variable.

The $r->allow_options method can be used for checking if it is OK to run a perl script. The Apache::Options module provides the constants to check against.

   if(!($r->allow_options & OPT_EXECCGI)) {
 $r->log_reason("Options ExecCGI is off in this directory", 
    $filename);
   }

Return a reference to the server info object (blessed into the Apache::Server package). This is really a server_rec* in disguise. The following methods can be used on the server object: