Apache::URI - Perl API for manipulating URIs

See Also
Copyright
Authors

NAME

Apache::URI - Perl API for manipulating URIs

Synopsis

  use Apache::URI ();


  $hostport = $r->construct_server();
  $hostport = $r->construct_server($hostname);
  $hostport = $r->construct_server($hostname, $port);
  $hostport = $r->construct_server($hostname, $port, $pool);


  $url = $r->construct_url();
  $url = $r->construct_url($rel_uri);
  $url = $r->construct_url($rel_uri, $pool);


  $parsed_uri = $r->parse_uri($uri);


  $parsed_uri = $r->parsed_uri();


  $url = join '%20', qw(one two three);
  Apache::URI::unescape_url($url);

Description

While APR::URI provides a generic API to dissect, adjust and put together any given URI string, Apache::URI provides an API specific to Apache, by taking the information directly from the $r object. Therefore when manipulating the URI of the current HTTP request usually methods from both classes are used.

API

Apache::URI provides the following functions and methods:

`construct_server`

Construct a string made of hostname and port

  $hostport = $r->construct_server();
  $hostport = $r->construct_server($hostname);
  $hostport = $r->construct_server($hostname, $port);
  $hostport = $r->construct_server($hostname, $port, $pool);

obj: $r ( Apache::RequestRec object|docs::2.0::api::Apache::RequestRec )

The current request object

opt arg1: $hostname ( string )

The hostname of the server.

If that argument is not passed, $r->get_server_name|docs::2.0::api::Apache::RequestUtil/C_get_server_name_ is used.

opt arg2: $port ( string )

The port the server is running on.

If that argument is not passed, $r->get_server_port|docs::2.0::api::Apache::RequestUtil/C_get_server_port_ is used.

opt arg3: $pool ( APR::Pool object|docs::2.0::api::APR::Pool )

The pool to allocate the string from.

If that argument is not passed, $r->pool|docs::2.0::api::Apache::RequestRec/C_pool_ is used.

ret: $hostport ( string )

The server's hostport string

since: 1.99_10

Examples:

Assuming that:

  $r->get_server_name == "localhost";
  $r->get_server_port == 8001;

The code:

  $hostport = $r->construct_server();

returns a string:

  localhost:8001

The following code sets the values explicitly:

  $hostport = $r->construct_server("my.example.com", 8888);

and it returns a string:

  my.example.com:8888

`construct_url`

Build a fully qualified URL from the uri and information in the request rec:

  $url = $r->construct_url();
  $url = $r->construct_url($rel_uri);
  $url = $r->construct_url($rel_uri, $pool);

obj: $r ( Apache::RequestRec object|docs::2.0::api::Apache::RequestRec )

The current request object

opt arg1: $rel_uri ( string )

The path to the requested file (it may include a concatenation of path, query and fragment components).

If that argument is not passed, $r->uri|docs::2.0::api::Apache::RequestRec/C_uri_ is used.

opt arg2: $pool ( APR::Pool object|docs::2.0::api::APR::Pool )

The pool to allocate the URL from

If that argument is not passed, $r->pool|docs::2.0::api::Apache::RequestRec/C_pool_ is used.

ret: $url ( string )

A fully qualified URL

since: 1.99_10

Examples:

Assuming that the request was
```
  http://localhost.localdomain:8529/test?args
```
The code:
```
  my $url = $r->construct_url;
```
returns the string:
```
  http://localhost.localdomain:8529/test
```
notice that the query (args) component is not in the string. You need to append it manually if it's needed.

Assuming that the request was

  http://localhost.localdomain:8529/test?args

The code:

  my $rel_uri = "/foo/bar?tar";
  my $url = $r->construct_url($rel_uri);

returns the string:

  http://localhost.localdomain:8529/foo/bar?tar

`parse_uri`

Break apart URI (affecting the current request's uri components)

  $r->parse_uri($uri);

obj: $r ( Apache::RequestRec object|docs::2.0::api::Apache::RequestRec ): The current request object
arg1: $uri ( string ): The uri to break apart
ret: no return value
warning:: This method has several side-effects explained below
since: 1.99_10

This method call has the following side-effects:

sets $r->args|docs::2.0::api::Apache::RequestRec/C_args_ to the rest after '?' if such exists in the passed $uri, otherwise sets it to undef.
sets $r->uri|docs::2.0::api::Apache::RequestRec/C_uri_ to the passed $uri without the $r->args|docs::2.0::api::Apache::RequestRec/C_args_ part.
sets $r->hostname|docs::2.0::api::Apache::RequestRec/C_hostname_ (if not set already) using the (scheme://host:port) parts of the passed $uri.

`parsed_uri`

Get the current request's parsed uri object

  my $uri = $r->parsed_uri();

obj: $r ( Apache::RequestRec object|docs::2.0::api::Apache::RequestRec ): The current request object
ret: $uri ( APR::URI object|docs::2.0::api::APR::URI ): The parsed uri
since: 1.99_10

META: this object is suitable for a currently non-existing rpath() method

`unescape_url`

Unescape URLs

  Apache::URI::unescape_url($url);

obj: $url ( string ): The URL to unescape
ret: no return value: The argument $url is now unescaped
since: 1.99_10

Example:

  my $url = join '%20', qw(one two three);
  Apache::URI::unescape_url($url);

$url now contains the string:

  "one two three";

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

Authors

The mod_perl development team and numerous contributors.

Apache::URI - Perl API for manipulating URIs