EPrints::Apache::AnApache - Utility methods for talking to mod_perl
This module provides a number of utility methods for interacting with the request object.
For backwards compatibility - use HTTP_ constants instead of :common constants.
Maps to EPrints::Const::HTTP_UNAUTHORIZED. Authorization is required to access the requested resource.
Maps to EPrints::Const::HTTP_FORBIDDEN. Access to the requested resource is forbidden.
Maps to EPrints::Const::HTTP_INTERNAL_SERVER_ERROR. Requesting the resource has caused an internal server error.
EPrints::Apache::AnApache::send_http_header( $request )
Send the HTTP header, if needed.
$request is the current Apache request.
EPrints::Apache::AnApache::header_out( $request, $header, $value )
Set a value in the HTTP headers of the response. $request is the apache request object, $header is the name of the header and $value is the value to give that header.
$value = EPrints::Apache::AnApache::header_in( $request, $header )
Return the specified HTTP header from the current request.
$request = EPrints::Apache::AnApache::get_request
Return the current Apache request object.
$value = EPrints::Apache::AnApache::cookie( $request, $cookieid )
Return the value of the named cookie, or undef if it is not set.
This avoids using CGI, so does not consume the POST data.
EPrints::Apache::AnApache::upload_doc_file( $session, $document, $paramid );
Collect a file named $paramid uploaded via HTTP and add it to the specified $document.
EPrints::Apache::AnApache::upload_doc_archive( $session, $document, $paramid, $archive_format );
Collect an archive file (.ZIP, .tar.gz, etc.) uploaded via HTTP and unpack it then add it to the specified document.
EPrints::Apache::AnApache::send_status_line( $request, $code, $message )
Send a HTTP status to the client with $code and $message.
EPrints::Apache::AnApache::send_hidden_status_line( $request, $code )
Send a hidden HTTP status to the client with $code.
This is intended for where EPrints already displays a useful error message but a 200 HTTP status code is otherwise logged.
$rc = EPrints::Apache::AnApache::ranges( $r, $maxlength, $chunks )
Populates the byte-ranges in $chunks requested by the client.
$maxlength is the length, in bytes, of the resource.
Returns the appropriate byte-range result code or OK if no Range header is set.
© Copyright 2023 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.