This file is indexed.

/usr/lib/perl5/Apache2/RequestIO.pm is in libapache2-mod-perl2 2.0.5-5ubuntu1.

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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
# 
# /*
#  * *********** WARNING **************
#  * This file generated by ModPerl::WrapXS/0.01
#  * Any changes made here will be lost
#  * ***********************************
#  * 01: lib/ModPerl/Code.pm:709
#  * 02: lib/ModPerl/WrapXS.pm:626
#  * 03: lib/ModPerl/WrapXS.pm:1175
#  * 04: Makefile.PL:424
#  * 05: Makefile.PL:326
#  * 06: Makefile.PL:57
#  */
# 


package Apache2::RequestIO;

use strict;
use warnings FATAL => 'all';



use Apache2::XSLoader ();
our $VERSION = '2.000005';
Apache2::XSLoader::load __PACKAGE__;



1;
__END__

=head1 NAME

Apache2::RequestIO - Perl API for Apache request record IO




=head1 Synopsis

  use Apache2::RequestIO ();
  
  $rc = $r->discard_request_body();
  
  $r->print("foo", "bar");
  $r->puts("foo", "bar"); # same as print, but no flushing
  $r->printf("%s $d", "foo", 5);
  
  $r->read($buffer, $len);
  
  $r->rflush();
  
  $r->sendfile($filename);
  
  $r->write("foobartarcar", 3, 5);




=head1 Description

C<Apache2::RequestIO> provides the API to perform IO on the L<Apache
request object|docs::2.0::api::Apache2::RequestRec>.




=head1 API

C<Apache2::RequestIO> provides the following functions and/or methods:




=head2 C<discard_request_body>

In HTTP/1.1, any method can have a body.  However, most GET handlers
wouldn't know what to do with a request body if they received one.
This helper routine tests for and reads any message body in the
request, simply discarding whatever it receives.  We need to do this
because failing to read the request body would cause it to be
interpreted as the next request on a persistent connection.

  $rc = $r->discard_request_body();

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

The current request

=item ret: C<$rc> ( integer )

C<L<APR::Const status constant|docs::2.0::api::APR::Const>> if request
is malformed, C<Apache2::Const::OK> otherwise.

=item since: 2.0.00

=back

Since we return an error status if the request is malformed, this
routine should be called at the beginning of a no-body handler, e.g.,

   use Apache2::Const -compile => qw(OK);
   $rc = $r->discard_request_body;
   return $rc if $rc != Apache2::Const::OK;





=head2 C<print>

Send data to the client.

  $cnt = $r->print(@msg);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<@msg> ( ARRAY )

Data to send

=item ret: C<$cnt> ( number )

How many bytes were sent (or buffered).  If zero bytes were
sent, C<print> will return C<0E0>, or "zero but true," which
will still evaluate to C<0> in a numerical context.

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

=item since: 2.0.00

=back

The data is flushed only if STDOUT stream's C<$|> is true. Otherwise
it's buffered up to the size of the buffer, flushing only excessive
data.




=head2 C<printf>

Format and send data to the client (same as C<printf>).

  $cnt = $r->printf($format, @args);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<$format> ( string )

Format string, as in the Perl core C<printf> function.

=item arg2: C<@args> ( ARRAY )

Arguments to be formatted, as in the Perl core C<printf> function.

=item ret: C<$cnt> ( number )

How many bytes were sent (or buffered)

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

=item since: 2.0.00

=back

The data is flushed only if STDOUT stream's C<$|> is true. Otherwise
it's buffered up to the size of the buffer, flushing only excessive
data.




=head2 C<puts>

Send data to the client

  $cnt = $r->puts(@msg);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<@msg> ( ARRAY )

Data to send

=item ret: C<$cnt> ( number )

How many bytes were sent (or buffered)

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

=item since: 2.0.00

=back

C<puts()> is similar to C<L<print()|/C_print_>>, but it won't attempt
to flush data, no matter what the value of STDOUT stream's C<$|>
is. Therefore assuming that STDOUT stream's C<$|> is true, this method
should be a tiny bit faster than C<L<print()|/C_print_>>, especially
if small strings are printed.





=head2 C<read>

Read data from the client.

  $cnt = $r->read($buffer, $len);
  $cnt = $r->read($buffer, $len, $offset);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<$buffer> ( SCALAR )

The buffer to populate with the read data

=item arg2: C<$len> ( number )

How many bytes to attempt to read

=item opt arg3: C<$offset> ( number )

If a non-zero C<$offset> is specified, the read data will be placed at
that offset in the C<$buffer>.

META: negative offset and \0 padding are not supported at the moment

=item ret: C<$cnt> ( number )

How many characters were actually read

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

=item since: 2.0.00

=back

This method shares a lot of similarities with the Perl core C<read()>
function. The main difference in the error handling, which is done via
C<L<APR::Error exceptions|docs::2.0::api::APR::Error>>




=head2 C<rflush>

Flush any buffered data to the client.

  $r->rflush();

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item ret: no return value

=item since: 2.0.00

=back

Unless STDOUT stream's C<$|> is false, data sent via
C<L<$r-E<gt>print()|/C_print_>> is buffered. This method flushes that
data to the client.





=head2 C<sendfile>

Send a file or a part of it

  $rc = $r->sendfile($filename);
  $rc = $r->sendfile($filename, $offset);
  $rc = $r->sendfile($filename, $offset, $len);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<$filename> ( string )

The full path to the file (using C</> on all systems)

=item opt arg2: C<$offset> ( integer )

Offset into the file to start sending.

No offset is used if C<$offset> is not specified.

=item opt arg3: C<$len> ( integer )

How many bytes to send.

If not specified the whole file is sent (or a part of it, if
C<$offset> if specified)

=item ret: C<$rc> ( C<L<APR::Const status
constant|docs::2.0::api::APR::Const>> )

On success,
C<L<APR::Const::SUCCESS|docs::2.0::api::APR::Const/C_APR__Const__SUCCESS_>> is
returned.

In case of a failure -- a failure code is returned, in which case
normally it should be returned to the caller.

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

Exceptions are thrown only when this function is called in the VOID
context. So if you don't want to handle the errors, just don't ask for
a return value and the function will handle all the errors on its own.

=item since: 2.0.00

=back





=head2 C<write>

Send partial string to the client

  $cnt = $r->write($buffer);
  $cnt = $r->write($buffer, $len);
  $cnt = $r->write($buffer, $len, $offset);

=over 4

=item obj: C<$r>
( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )

=item arg1: C<$buffer> ( SCALAR )

The string with data

=item opt arg2: C<$len> ( SCALAR )

How many bytes to send. If not specified, or -1 is specified, all the
data in C<$buffer> (or starting from C<$offset>) will be sent.

=item opt arg3: C<$offset> ( number )

Offset into the C<$buffer> string.

=item ret: C<$cnt> ( number )

How many bytes were sent (or buffered)

=item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>

=item since: 2.0.00

=back

Examples:

Assuming that we have a string:

  $string = "123456789";

Then:

  $r->write($string);

sends:

  123456789

Whereas:

  $r->write($string, 3);

sends:

  123

And:

  $r->write($string, 3, 5);

sends:

  678

Finally:

  $r->write($string, -1, 5);

sends:

  6789








=head1 TIE Interface

The TIE interface implementation. This interface is used for HTTP
request handlers, when running under C<L<SetHandler
perl-script|docs::2.0::user::config::config/C_perl_script_>> and
Perl doesn't have perlio enabled.

See the I<perltie> manpage for more information.




=head2 C<BINMODE>

=over 4

=item since: 2.0.00

=back

NoOP

See the I<binmode> Perl entry in the I<perlfunc> manpage



=head2 C<CLOSE>

=over 4

=item since: 2.0.00

=back

NoOP

See the I<close> Perl entry in the I<perlfunc> manpage



=head2 C<FILENO>

=over 4

=item since: 2.0.00

=back

See the I<fileno> Perl entry in the I<perlfunc> manpage




=head2 C<GETC>

=over 4

=item since: 2.0.00

=back

See the I<getc> Perl entry in the I<perlfunc> manpage




=head2 C<OPEN>

=over 4

=item since: 2.0.00

=back

See the I<open> Perl entry in the I<perlfunc> manpage





=head2 C<PRINT>

=over 4

=item since: 2.0.00

=back

See the I<print> Perl entry in the I<perlfunc> manpage




=head2 C<PRINTF>

=over 4

=item since: 2.0.00

=back

See the I<printf> Perl entry in the I<perlfunc> manpage




=head2 C<READ>

=over 4

=item since: 2.0.00

=back

See the I<read> Perl entry in the I<perlfunc> manpage





=head2 C<TIEHANDLE>

=over 4

=item since: 2.0.00

=back

See the I<tie> Perl entry in the I<perlfunc> manpage




=head2 C<UNTIE>

=over 4

=item since: 2.0.00

=back

NoOP

See the I<untie> Perl entry in the I<perlfunc> manpage





=head2 C<WRITE>

=over 4

=item since: 2.0.00

=back

See the I<write> Perl entry in the I<perlfunc> manpage




=head1 Deprecated API

The following methods are deprecated, Apache plans to remove those in
the future, therefore avoid using them.



=head2 C<get_client_block>

This method is deprecated since the C implementation is buggy and we
don't want you to use it at all. Instead use the plain
C<L<$r-E<gt>read()|/C_read_>>.




=head2 C<setup_client_block>

This method is deprecated since
C<L<$r-E<gt>get_client_block|/C__get_client_block_>> is deprecated.




=head2 C<should_client_block>

This method is deprecated since
C<L<$r-E<gt>get_client_block|/C__get_client_block_>> is deprecated.






=head1 See Also

L<mod_perl 2.0 documentation|docs::2.0::index>.




=head1 Copyright

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




=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut