/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/Apache2/URI.html is in libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 | <?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#Synopsis">Synopsis</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#API">API</a>
<ul>
<li><a href="#construct_server">construct_server</a></li>
<li><a href="#construct_url">construct_url</a></li>
<li><a href="#parse_uri">parse_uri</a></li>
<li><a href="#parsed_uri">parsed_uri</a></li>
<li><a href="#unescape_url">unescape_url</a></li>
</ul>
</li>
<li><a href="#See-Also">See Also</a></li>
<li><a href="#Copyright">Copyright</a></li>
<li><a href="#Authors">Authors</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Apache2::URI - Perl API for manipulating URIs</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use Apache2::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);
Apache2::URI::unescape_url($url);</code></pre>
<h1 id="Description">Description</h1>
<p>While <code>APR::URI</code> provides a generic API to dissect, adjust and put together any given URI string, <code>Apache2::URI</code> provides an API specific to Apache, by taking the information directly from the <code>$r</code> object. Therefore when manipulating the URI of the current HTTP request usually methods from both classes are used.</p>
<h1 id="API">API</h1>
<p><code>Apache2::URI</code> provides the following functions and methods:</p>
<h2 id="construct_server"><code>construct_server</code></h2>
<p>Construct a string made of hostname and port</p>
<pre><code> $hostport = $r->construct_server();
$hostport = $r->construct_server($hostname);
$hostport = $r->construct_server($hostname, $port);
$hostport = $r->construct_server($hostname, $port, $pool);</code></pre>
<dl>
<dt id="obj:-r-Apache2::RequestRec-object">obj: <code>$r</code> ( <code><a>Apache2::RequestRec object</a></code> )</dt>
<dd>
<p>The current request object</p>
</dd>
<dt id="opt-arg1:-hostname-string">opt arg1: <code>$hostname</code> ( string )</dt>
<dd>
<p>The hostname of the server.</p>
<p>If that argument is not passed, <code><a>$r->get_server_name</a></code> is used.</p>
</dd>
<dt id="opt-arg2:-port-string">opt arg2: <code>$port</code> ( string )</dt>
<dd>
<p>The port the server is running on.</p>
<p>If that argument is not passed, <code><a>$r->get_server_port</a></code> is used.</p>
</dd>
<dt id="opt-arg3:-pool-APR::Pool-object">opt arg3: <code>$pool</code> ( <code><a>APR::Pool object</a></code> )</dt>
<dd>
<p>The pool to allocate the string from.</p>
<p>If that argument is not passed, <code><a>$r->pool</a></code> is used.</p>
</dd>
<dt id="ret:-hostport-string">ret: <code>$hostport</code> ( string )</dt>
<dd>
<p>The server's hostport string</p>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Examples:</p>
<ul>
<li><p>Assuming that:</p>
<pre><code> $r->get_server_name == "localhost";
$r->get_server_port == 8001;</code></pre>
<p>The code:</p>
<pre><code> $hostport = $r->construct_server();</code></pre>
<p>returns a string:</p>
<pre><code> localhost:8001</code></pre>
</li>
<li><p>The following code sets the values explicitly:</p>
<pre><code> $hostport = $r->construct_server("my.example.com", 8888);</code></pre>
<p>and it returns a string:</p>
<pre><code> my.example.com:8888</code></pre>
</li>
</ul>
<h2 id="construct_url"><code>construct_url</code></h2>
<p>Build a fully qualified URL from the uri and information in the request rec:</p>
<pre><code> $url = $r->construct_url();
$url = $r->construct_url($rel_uri);
$url = $r->construct_url($rel_uri, $pool);</code></pre>
<dl>
<dt id="obj:-r-Apache2::RequestRec-object1">obj: <code>$r</code> ( <code><a>Apache2::RequestRec object</a></code> )</dt>
<dd>
<p>The current request object</p>
</dd>
<dt id="opt-arg1:-rel_uri-string">opt arg1: <code>$rel_uri</code> ( string )</dt>
<dd>
<p>The path to the requested file (it may include a concatenation of <i>path</i>, <i>query</i> and <i>fragment</i> components).</p>
<p>If that argument is not passed, <code><a>$r->uri</a></code> is used.</p>
</dd>
<dt id="opt-arg2:-pool-APR::Pool-object">opt arg2: <code>$pool</code> ( <code><a>APR::Pool object</a></code> )</dt>
<dd>
<p>The pool to allocate the URL from</p>
<p>If that argument is not passed, <code><a>$r->pool</a></code> is used.</p>
</dd>
<dt id="ret:-url-string">ret: <code>$url</code> ( string )</dt>
<dd>
<p>A fully qualified URL</p>
</dd>
<dt id="since:-2.0.001">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Examples:</p>
<ul>
<li><p>Assuming that the request was</p>
<pre><code> http://localhost.localdomain:8529/test?args</code></pre>
<p>The code:</p>
<pre><code> my $url = $r->construct_url;</code></pre>
<p>returns the string:</p>
<pre><code> http://localhost.localdomain:8529/test</code></pre>
<p>notice that the query (args) component is not in the string. You need to append it manually if it's needed.</p>
</li>
<li><p>Assuming that the request was</p>
<pre><code> http://localhost.localdomain:8529/test?args</code></pre>
<p>The code:</p>
<pre><code> my $rel_uri = "/foo/bar?tar";
my $url = $r->construct_url($rel_uri);</code></pre>
<p>returns the string:</p>
<pre><code> http://localhost.localdomain:8529/foo/bar?tar</code></pre>
</li>
</ul>
<h2 id="parse_uri"><code>parse_uri</code></h2>
<p>Break apart URI (affecting the current request's uri components)</p>
<pre><code> $r->parse_uri($uri);</code></pre>
<dl>
<dt id="obj:-r-Apache2::RequestRec-object2">obj: <code>$r</code> ( <code><a>Apache2::RequestRec object</a></code> )</dt>
<dd>
<p>The current request object</p>
</dd>
<dt id="arg1:-uri-string">arg1: <code>$uri</code> ( string )</dt>
<dd>
<p>The uri to break apart</p>
</dd>
<dt id="ret:-no-return-value">ret: no return value</dt>
<dd>
</dd>
<dt id="warning">warning:</dt>
<dd>
<p>This method has several side-effects explained below</p>
</dd>
<dt id="since:-2.0.002">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>This method call has the following side-effects:</p>
<ol>
<li><p>sets <code><a>$r->args</a></code> to the rest after <code>'?'</code> if such exists in the passed <code>$uri</code>, otherwise sets it to <code>undef</code>.</p>
</li>
<li><p>sets <code><a>$r->uri</a></code> to the passed <code>$uri</code> without the <code><a>$r->args</a></code> part.</p>
</li>
<li><p>sets <code><a>$r->hostname</a></code> (if not set already) using the (<code>scheme://host:port</code>) parts of the passed <code>$uri</code>.</p>
</li>
</ol>
<h2 id="parsed_uri"><code>parsed_uri</code></h2>
<p>Get the current request's parsed uri object</p>
<pre><code> my $uri = $r->parsed_uri();</code></pre>
<dl>
<dt id="obj:-r-Apache2::RequestRec-object3">obj: <code>$r</code> ( <code><a>Apache2::RequestRec object</a></code> )</dt>
<dd>
<p>The current request object</p>
</dd>
<dt id="ret:-uri-APR::URI-object">ret: <code>$uri</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
<p>The parsed uri</p>
</dd>
<dt id="since:-2.0.003">since: 2.0.00</dt>
<dd>
<p>This object is suitable for using with <code><a>APR::URI::rpath</a></code></p>
</dd>
</dl>
<h2 id="unescape_url"><code>unescape_url</code></h2>
<p>Unescape URLs</p>
<pre><code> Apache2::URI::unescape_url($url);</code></pre>
<dl>
<dt id="obj:-url-string">obj: <code>$url</code> ( string )</dt>
<dd>
<p>The URL to unescape</p>
</dd>
<dt id="ret:-no-return-value1">ret: no return value</dt>
<dd>
<p>The argument <code>$url</code> is now unescaped</p>
</dd>
<dt id="since:-2.0.004">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Example:</p>
<pre><code> my $url = join '%20', qw(one two three);
Apache2::URI::unescape_url($url);</code></pre>
<p><code>$url</code> now contains the string:</p>
<pre><code> "one two three";</code></pre>
<h1 id="See-Also">See Also</h1>
<p><code><a>APR::URI</a></code>, <a>mod_perl 2.0 documentation</a>.</p>
<h1 id="Copyright">Copyright</h1>
<p>mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.</p>
<h1 id="Authors">Authors</h1>
<p><a>The mod_perl development team and numerous contributors</a>.</p>
</body>
</html>
|