home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _cf4a7711691365994f52ccdc66c6d3d8 < prev    next >
Text File  |  2000-03-15  |  6KB  |  234 lines
  1. #
  2. # $Id: Status.pm,v 1.25 1999/03/20 07:37:35 gisle Exp $
  3.  
  4. package HTTP::Status;
  5.  
  6. use strict;
  7. require 5.002;   # becase we use prototypes
  8.  
  9. =head1 NAME
  10.  
  11. HTTP::Status - HTTP Status code processing
  12.  
  13. =head1 SYNOPSIS
  14.  
  15.  use HTTP::Status;
  16.  
  17.  if ($rc != RC_OK) {
  18.      print status_message($rc), "\n";
  19.  }
  20.  
  21.  if (is_success($rc)) { ... }
  22.  if (is_error($rc)) { ... }
  23.  if (is_redirect($rc)) { ... }
  24.  
  25. =head1 DESCRIPTION
  26.  
  27. I<HTTP::Status> is a library of routines for defining and
  28. classifying HTTP status codes for libwww-perl.  Status codes are
  29. used to encode the overall outcome of a HTTP response message.  Codes
  30. correspond to those defined in F<draft-ietf-http-v11-spec-rev-03> (an
  31. update to RFC 2068).
  32.  
  33. =head1 CONSTANTS
  34.  
  35. The following constant functions can be used as mnemonic status code
  36. names:
  37.  
  38.    RC_CONTINUE                (100)
  39.    RC_SWITCHING_PROTOCOLS        (101)
  40.  
  41.    RC_OK                (200)
  42.    RC_CREATED                (201)
  43.    RC_ACCEPTED                (202)
  44.    RC_NON_AUTHORITATIVE_INFORMATION    (203)
  45.    RC_NO_CONTENT            (204)
  46.    RC_RESET_CONTENT            (205)
  47.    RC_PARTIAL_CONTENT            (206)
  48.  
  49.    RC_MULTIPLE_CHOICES            (300)
  50.    RC_MOVED_PERMANENTLY            (301)
  51.    RC_FOUND                (302)
  52.    RC_SEE_OTHER                (303)
  53.    RC_NOT_MODIFIED            (304)
  54.    RC_USE_PROXY                (305)
  55.    RC_TEMPORARY_REDIRECT        (307)
  56.  
  57.    RC_BAD_REQUEST            (400)
  58.    RC_UNAUTHORIZED            (401)
  59.    RC_PAYMENT_REQUIRED            (402)
  60.    RC_FORBIDDEN                (403)
  61.    RC_NOT_FOUND                (404)
  62.    RC_METHOD_NOT_ALLOWED        (405)
  63.    RC_NOT_ACCEPTABLE            (406)
  64.    RC_PROXY_AUTHENTICATION_REQUIRED    (407)
  65.    RC_REQUEST_TIMEOUT            (408)
  66.    RC_CONFLICT                (409)
  67.    RC_GONE                (410)
  68.    RC_LENGTH_REQUIRED            (411)
  69.    RC_PRECONDITION_FAILED        (412)
  70.    RC_REQUEST_ENTITY_TOO_LARGE        (413)
  71.    RC_REQUEST_URI_TOO_LARGE        (414)
  72.    RC_UNSUPPORTED_MEDIA_TYPE        (415)
  73.    RC_REQUEST_RANGE_NOT_SATISFIABLE     (416)
  74.    RC_EXPECTATION_FAILED        (417)
  75.  
  76.    RC_INTERNAL_SERVER_ERROR        (500)
  77.    RC_NOT_IMPLEMENTED            (501)
  78.    RC_BAD_GATEWAY            (502)
  79.    RC_SERVICE_UNAVAILABLE        (503)
  80.    RC_GATEWAY_TIMEOUT            (504)
  81.    RC_HTTP_VERSION_NOT_SUPPORTED    (505)
  82.  
  83. =cut
  84.  
  85. #####################################################################
  86.  
  87. use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION);
  88.  
  89. require Exporter;
  90. @ISA = qw(Exporter);
  91. @EXPORT = qw(is_info is_success is_redirect is_error status_message);
  92. @EXPORT_OK = qw(is_client_error is_server_error);
  93. $VERSION = sprintf("%d.%02d", q$Revision: 1.25 $ =~ /(\d+)\.(\d+)/);
  94.  
  95. # Note also addition of mnemonics to @EXPORT below
  96.  
  97. my %StatusCode = (
  98.     100 => 'Continue',
  99.     101 => 'Switching Protocols',
  100.     200 => 'OK',
  101.     201 => 'Created',
  102.     202 => 'Accepted',
  103.     203 => 'Non-Authoritative Information',
  104.     204 => 'No Content',
  105.     205 => 'Reset Content',
  106.     206 => 'Partial Content',
  107.     300 => 'Multiple Choices',
  108.     301 => 'Moved Permanently',
  109.     302 => 'Found',
  110.     303 => 'See Other',
  111.     304 => 'Not Modified',
  112.     305 => 'Use Proxy',
  113.     307 => 'Temporary Redirect',
  114.     400 => 'Bad Request',
  115.     401 => 'Unauthorized',
  116.     402 => 'Payment Required',
  117.     403 => 'Forbidden',
  118.     404 => 'Not Found',
  119.     405 => 'Method Not Allowed',
  120.     406 => 'Not Acceptable',
  121.     407 => 'Proxy Authentication Required',
  122.     408 => 'Request Timeout',
  123.     409 => 'Conflict',
  124.     410 => 'Gone',
  125.     411 => 'Length Required',
  126.     412 => 'Precondition Failed',
  127.     413 => 'Request Entity Too Large',
  128.     414 => 'Request-URI Too Large',
  129.     415 => 'Unsupported Media Type',
  130.     416 => 'Request Range Not Satisfiable',
  131.     417 => 'Expectation Failed',
  132.     500 => 'Internal Server Error',
  133.     501 => 'Not Implemented',
  134.     502 => 'Bad Gateway',
  135.     503 => 'Service Unavailable',
  136.     504 => 'Gateway Timeout',
  137.     505 => 'HTTP Version Not Supported',
  138. );
  139.  
  140. my $mnemonicCode = '';
  141. my ($code, $message);
  142. while (($code, $message) = each %StatusCode) {
  143.     # create mnemonic subroutines
  144.     $message =~ tr/a-z \-/A-Z__/;
  145.     $mnemonicCode .= "sub RC_$message () { $code }\t";
  146.     # make them exportable
  147.     $mnemonicCode .= "push(\@EXPORT, 'RC_$message');\n";
  148. }
  149. # warn $mnemonicCode; # for development
  150. eval $mnemonicCode; # only one eval for speed
  151. die if $@;
  152.  
  153. # backwards compatibility
  154. *RC_MOVED_TEMPORARILY = \&RC_FOUND;  # 302 was renamed in the standard
  155. push(@EXPORT, "RC_MOVED_TEMPORARILY");
  156.  
  157.  
  158. =head1 FUNCTIONS
  159.  
  160. The following additional functions are provided.  Most of them are
  161. exported by default.
  162.  
  163. =over 4
  164.  
  165. =item status_message($code)
  166.  
  167. The status_message() function will translate status codes to human
  168. readable strings. The string is the same as found in the constant
  169. names above.  If the $code is unknown, then C<undef> is returned.
  170.  
  171. =cut
  172.  
  173. sub status_message ($)
  174. {
  175.     $StatusCode{$_[0]};
  176. }
  177.  
  178. =item is_info($code)
  179.  
  180. Return TRUE if C<$code> is an I<Informational> status code.  This
  181. class of status code indicates a provisional response which can't have
  182. any content.
  183.  
  184. =item is_success($code)
  185.  
  186. Return TRUE if C<$code> is a I<Successful> status code.
  187.  
  188. =item is_redirect($code)
  189.  
  190. Return TRUE if C<$code> is a I<Redirection> status code. This class of
  191. status code indicates that further action needs to be taken by the
  192. user agent in order to fulfill the request.
  193.  
  194. =item is_error($code)
  195.  
  196. Return TRUE if C<$code> is an I<Error> status code.  The function
  197. return TRUE for both client error or a server error status codes.
  198.  
  199. =item is_client_error($code)
  200.  
  201. Return TRUE if C<$code> is an I<Client Error> status code. This class
  202. of status code is intended for cases in which the client seems to have
  203. erred.
  204.  
  205. This function is B<not> exported by default.
  206.  
  207. =item is_server_error($code)
  208.  
  209. Return TRUE if C<$code> is an I<Server Error> status code. This class
  210. of status codes is intended for cases in which the server is aware
  211. that it has erred or is incapable of performing the request.
  212.  
  213. This function is B<not> exported by default.
  214.  
  215. =back
  216.  
  217. =cut
  218.  
  219. sub is_info         ($) { $_[0] >= 100 && $_[0] < 200; }
  220. sub is_success      ($) { $_[0] >= 200 && $_[0] < 300; }
  221. sub is_redirect     ($) { $_[0] >= 300 && $_[0] < 400; }
  222. sub is_error        ($) { $_[0] >= 400 && $_[0] < 600; }
  223. sub is_client_error ($) { $_[0] >= 400 && $_[0] < 500; }
  224. sub is_server_error ($) { $_[0] >= 500 && $_[0] < 600; }
  225.  
  226. 1;
  227.  
  228. =head1 BUGS
  229.  
  230. Wished @EXPORT_OK had been used instead of @EXPORT in the beginning.
  231. Now too much is exported by default.
  232.  
  233. =cut
  234.