/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | <?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="#fragment">fragment</a></li>
<li><a href="#hostinfo">hostinfo</a></li>
<li><a href="#hostname">hostname</a></li>
<li><a href="#password">password</a></li>
<li><a href="#parse">parse</a></li>
<li><a href="#path">path</a></li>
<li><a href="#rpath">rpath</a></li>
<li><a href="#port">port</a></li>
<li><a href="#port_of_scheme">port_of_scheme</a></li>
<li><a href="#query">query</a></li>
<li><a href="#scheme">scheme</a></li>
<li><a href="#user">user</a></li>
<li><a href="#unparse">unparse</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>APR::URI - Perl API for URI manipulations</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::URI ();
my $url = 'http://user:pass@example.com:80/foo?bar#item5';
# parse and break the url into components
my $parsed = APR::URI->parse($r->pool, $url);
print $parsed->scheme;
print $parsed->user;
print $parsed->password;
print $parsed->hostname;
print $parsed->port;
print $parsed->path;
print $parsed->rpath;
print $parsed->query;
print $parsed->fragment;
# reconstruct the url, after changing some components and completely
# removing other
$parsed->scheme($new_scheme);
$parsed->user(undef);
$parsed->password(undef);
$parsed->hostname($new_hostname);
$parsed->port($new_port);
$parsed->path($new_path);
$parsed->query(undef);
$parsed->fragment(undef);
print $parsed->unparse;
# get the password field too (by default it's not revealed)
use APR::Const -compile => qw(URI_UNP_REVEALPASSWORD);
print $parsed->unparse(APR::Const::URI_UNP_REVEALPASSWORD);
# what the default port for the ftp protocol?
my $ftp_port = APR::URI::port_of_scheme("ftp");</code></pre>
<h1 id="Description">Description</h1>
<p><code>APR::URI</code> allows you to parse URI strings, manipulate each of the URI elements and deparse them back into URIs.</p>
<p>All <code>APR::URI</code> object accessors accept a string or an <code>undef</code> value as an argument. Same goes for return value. It's important to distinguish between an empty string and <code>undef</code>. For example let's say your code was:</p>
<pre><code> my $uri = 'http://example.com/foo?bar#item5';
my $parsed = APR::URI->parse($r->pool, $uri);</code></pre>
<p>Now you no longer want to the query and fragment components in the final url. If you do:</p>
<pre><code> $parsed->fragment('');
$parsed->query('');</code></pre>
<p>followed by:</p>
<pre><code> my $new_uri = parsed->unparse;</code></pre>
<p>the resulting URI will be:</p>
<pre><code> http://example.com/foo?#</code></pre>
<p>which is probably not something that you've expected. In order to get rid of the separators, you must completely unset the fields you don't want to see. So, if you do:</p>
<pre><code> $parsed->fragment(undef);
$parsed->query(undef);</code></pre>
<p>followed by:</p>
<pre><code> my $new_uri = parsed->unparse;</code></pre>
<p>the resulting URI will be:</p>
<pre><code> http://example.com/foo</code></pre>
<p>As mentioned earlier the same goes for return values, so continuing this example:</p>
<pre><code> my $new_fragment = $parsed->fragment();
my $new_query = $parsed->query();</code></pre>
<p>Both values now contain <code>undef</code>, therefore you must be careful when using the return values, when you use them, as you may get warnings.</p>
<p>Also make sure you read through <code><a href="#C_unparse_">the unparse() section</a></code> as various optional flags affect how the deparsed URI is rendered.</p>
<h1 id="API">API</h1>
<p><code>APR::URI</code> provides the following functions and/or methods:</p>
<h2 id="fragment"><code>fragment</code></h2>
<p>Get/set trailing "#fragment" string</p>
<pre><code> $oldval = $parsed->fragment($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="hostinfo"><code>hostinfo</code></h2>
<p>Get/set combined <code>[user[:password]@]host[:port]</code></p>
<pre><code> $oldval = $parsed->hostinfo($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object1">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef1">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef1">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.001">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>The <code>hostinfo</code> value is set automatically when <code><a href="#C_parse_">parse()</a></code> is called.</p>
<p>It's not updated if any of the individual fields is modified.</p>
<p>It's not used when <code><a href="#C_unparse_">unparse()</a></code> is called.</p>
<h2 id="hostname"><code>hostname</code></h2>
<p>Get/set hostname</p>
<pre><code> $oldval = $parsed->hostname($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object2">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef2">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef2">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.002">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="password"><code>password</code></h2>
<p>Get/set password (as in http://user:password@host:port/)</p>
<pre><code> $oldval = $parsed->password($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object3">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef3">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef3">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.003">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="parse"><code>parse</code></h2>
<p>Parse the URI string into URI components</p>
<pre><code> $parsed = APR::URI->parse($pool, $uri);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object-or-class">obj: <code>$parsed</code> ( <code><a>APR::URI object or class</a></code> )</dt>
<dd>
</dd>
<dt id="arg1:-pool-string-APR::Pool-object">arg1: <code>$pool</code> ( string ) ( <code><a>APR::Pool object</a></code> )</dt>
<dd>
</dd>
<dt id="arg2:-uri-string">arg2: <code>$uri</code> ( string )</dt>
<dd>
<p>The URI to parse</p>
</dd>
<dt id="ret:-parsed-APR::URI-object-or-class">ret: <code>$parsed</code> ( <code><a>APR::URI object or class</a></code> )</dt>
<dd>
<p>The parsed URI object</p>
</dd>
<dt id="since:-2.0.004">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>After parsing, if a component existed but was an empty string (e.g. empty query <i>http://hostname/path?</i>) -- the corresponding accessor will return an empty string. If a component didn't exist (e.g. no query part <i>http://hostname/path</i>) -- the corresponding accessor will return <code>undef</code>.</p>
<h2 id="path"><code>path</code></h2>
<p>Get/set the request path</p>
<pre><code> $oldval = $parsed->path($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object4">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef4">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef4">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
<p><code>"/"</code> if only <code>scheme://host</code></p>
</dd>
<dt id="since:-2.0.005">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="rpath"><code>rpath</code></h2>
<p>Gets the <code><a href="#C_path_">path</a></code> minus the <code><a>path_info</a></code></p>
<pre><code> $rpath = $parsed->rpath();</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object5">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef5">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef5">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
<p>The path minus the <i>path_info</i></p>
</dd>
<dt id="since:-2.0.006">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="port"><code>port</code></h2>
<p>Get/set port number</p>
<pre><code> $oldval = $parsed->port($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object6">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-number-or-string-or-undef">opt arg1: <code>$newval</code> ( number or string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef6">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
<p>If the port component didn't appear in the parsed URI, APR internally calls <code><a href="#C_port_of_scheme_">port_of_scheme()</a></code> to find out the port number for the given <code><a href="#C_scheme_">scheme()</a></code>.</p>
</dd>
<dt id="since:-2.0.007">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="port_of_scheme"><code>port_of_scheme</code></h2>
<p>Return the default port for a given scheme. The recognized schemes are http, ftp, https, gopher, wais, nntp, snews and prospero.</p>
<pre><code> $port = APR::URI::port_of_scheme($scheme);</code></pre>
<dl>
<dt id="obj:-scheme-string">obj: <code>$scheme</code> ( string )</dt>
<dd>
<p>The scheme string</p>
</dd>
<dt id="ret:-port-integer">ret: <code>$port</code> (integer)</dt>
<dd>
<p>The default port for this scheme</p>
</dd>
<dt id="since:-2.0.008">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="query"><code>query</code></h2>
<p>Get/set the query string (the part starting after <code>'?'</code> and all the way till the end or the <code>'#fragment'</code> part if the latter exists).</p>
<pre><code> $oldval = $parsed->query($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object7">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef6">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef7">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.009">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="scheme"><code>scheme</code></h2>
<p>Get/set the protocol scheme ("http", "ftp", ...)</p>
<pre><code> $oldval = $parsed->scheme($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object8">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef7">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef8">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.0010">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="user"><code>user</code></h2>
<p>Get/set user name (as in http://user:password@host:port/)</p>
<pre><code> $oldval = $parsed->user($newval);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object9">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-newval-string-or-undef8">opt arg1: <code>$newval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="ret:-oldval-string-or-undef9">ret: <code>$oldval</code> ( string or undef )</dt>
<dd>
</dd>
<dt id="since:-2.0.0011">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<h2 id="unparse"><code>unparse</code></h2>
<p>Unparse the URI components back into a URI string</p>
<pre><code> $new_uri = $parsed->unparse();
$new_uri = $parsed->unparse($flags);</code></pre>
<dl>
<dt id="obj:-parsed-APR::URI-object10">obj: <code>$parsed</code> ( <code><a>APR::URI object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-flags-the-APR::Const-:uri-constants">opt arg1: <code>$flags</code> ( <a>the APR::Const :uri constants</a> )</dt>
<dd>
<p>By default the constant <code>APR::Const::URI_UNP_OMITPASSWORD</code> is passed.</p>
<p>If you need to pass more than one flag use unary <code>|</code>, e.g.:</p>
<pre><code> $flags = APR::Const::URI_UNP_OMITUSER|APR::Const::URI_UNP_OMITPASSWORD;</code></pre>
<p>The valid <code>flags</code> constants are listed next</p>
</dd>
<dt id="ret:-new_uri-string">ret: <code>$new_uri</code> ( string )</dt>
<dd>
</dd>
<dt id="since:-2.0.0012">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Valid <code>flags</code> constants:</p>
<p>To import all URI constants you could do:</p>
<pre><code> use APR::Const -compile => qw(:uri);</code></pre>
<p>but there is a significant amount of them, most irrelevant to this method. Therefore you probably don't want to do that. Instead specify explicitly the ones that you need. All the relevant to this method constants start with <code>APR::URI_UNP_</code>.</p>
<p>And the available constants are:</p>
<dl>
<dt id="APR::Const::URI_UNP_OMITSITEPART"><code>APR::Const::URI_UNP_OMITSITEPART</code></dt>
<dd>
<p>Don't show <code><a href="#C_scheme_">scheme</a></code>, <code><a href="#C_user_">user</a></code>, <code><a href="#C_password_">password</a></code>, <code><a href="#C_hostname_">hostname</a></code> and <code><a href="#C_port_">port</a></code> components (i.e. if you want only the relative URI)</p>
</dd>
<dt id="APR::Const::URI_UNP_OMITUSER"><code>APR::Const::URI_UNP_OMITUSER</code></dt>
<dd>
<p>Hide the <code><a href="#C_user_">user</a></code> component</p>
</dd>
<dt id="APR::Const::URI_UNP_OMITPASSWORD"><code>APR::Const::URI_UNP_OMITPASSWORD</code></dt>
<dd>
<p>Hide the <code><a href="#C_password_">password</a></code> component (the default)</p>
</dd>
<dt id="APR::Const::URI_UNP_REVEALPASSWORD"><code>APR::Const::URI_UNP_REVEALPASSWORD</code></dt>
<dd>
<p>Reveal the <code><a href="#C_password_">password</a></code> component</p>
</dd>
<dt id="APR::Const::URI_UNP_OMITPATHINFO"><code>APR::Const::URI_UNP_OMITPATHINFO</code></dt>
<dd>
<p>Don't show <code><a href="#C_path_">path</a></code>, <code><a href="#C_query_">query</a></code> and <code><a href="#C_fragment_">fragment</a></code> components</p>
</dd>
<dt id="APR::Const::URI_UNP_OMITQUERY"><code>APR::Const::URI_UNP_OMITQUERY</code></dt>
<dd>
<p>Don't show <code><a href="#C_query_">query</a></code> and <code><a href="#C_fragment_">fragment</a></code> components</p>
</dd>
</dl>
<p>Notice that some flags overlap.</p>
<p>If the optional <code>$flags</code> argument is passed and contains no <code>APR::Const::URI_UNP_OMITPASSWORD</code> and no <code>APR::Const::URI_UNP_REVEALPASSWORD</code> -- the <code><a href="#C_password_">password</a></code> part will be rendered as a literal <code>"XXXXXXXX"</code> string.</p>
<p>If the <code><a href="#C_port_">port</a></code> number matches the <code><a href="#C_port_of_scheme_">port_of_scheme()</a></code>, the unparsed URI won't include it and there is no flag to force that <code><a href="#C_port_">port</a></code> to appear. If the <code><a href="#C_port_">port</a></code> number is non-standard it will show up in the unparsed string.</p>
<p>Examples:</p>
<p>Starting with the parsed URL:</p>
<pre><code> use APR::URI ();
my $url = 'http://user:pass@example.com:80/foo?bar#item5';
my $parsed = APR::URI->parse($r->pool, $url);</code></pre>
<p>deparse it back including and excluding parts, using different values for the optional <code>flags</code> argument:</p>
<ul>
<li><p>Show all but the <code><a href="#C_password_">password</a></code> fields:</p>
<pre><code> print $parsed->unparse;</code></pre>
<p>Prints:</p>
<pre><code> http://user@example.com/foo?bar#item5</code></pre>
<p>Notice that the <code><a href="#C_port_">port</a></code> field is gone too, since it was a default <code><a href="#C_port_of_scheme_">port</a></code> for <code><a href="#C_scheme_">scheme</a></code> <code>http://</code>.</p>
</li>
<li><p>Include the <code><a href="#C_password_">password</a></code> field (by default it's not revealed)</p>
<pre><code> use APR::Const -compile => qw(URI_UNP_REVEALPASSWORD);
print $parsed->unparse(APR::Const::URI_UNP_REVEALPASSWORD);</code></pre>
<p>Prints:</p>
<pre><code> http://user:pass@example.com/foo?bar#item5</code></pre>
</li>
<li><p>Show all fields but the last three, <code><a href="#C_path_">path</a></code>, <code><a href="#C_query_">query</a></code> and <code><a href="#C_fragment_">fragment</a></code>:</p>
<pre><code> use APR::Const -compile => qw(URI_UNP_REVEALPASSWORD
APR::Const::URI_UNP_OMITPATHINFO);
print $parsed->unparse(
APR::Const::URI_UNP_REVEALPASSWORD|URI_UNP_OMITPATHINFO);</code></pre>
<p>Prints:</p>
<pre><code> http://user:pass@example.com</code></pre>
</li>
</ul>
<h1 id="See-Also">See Also</h1>
<p><code><a>Apache2::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>
|