home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277197_apr_date.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  3KB  |  106 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. #ifndef APR_DATE_H
  17. #define APR_DATE_H
  18.  
  19. /**
  20.  * @file apr_date.h
  21.  * @brief APR-UTIL date routines
  22.  */
  23.  
  24. /**
  25.  * @defgroup APR_Util_Date Date routines
  26.  * @ingroup APR_Util
  27.  * @{
  28.  */
  29.  
  30. /*
  31.  * apr_date.h: prototypes for date parsing utility routines
  32.  */
  33.  
  34. #include "apu.h"
  35. #include "apr_time.h"
  36.  
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40.  
  41. /** A bad date. */
  42. #define APR_DATE_BAD ((apr_time_t)0)
  43.  
  44. /**
  45.  * Compare a string to a mask
  46.  * @param data The string to compare
  47.  * @param mask Mask characters (arbitrary maximum is 256 characters):
  48.  * <PRE>
  49.  *   '\@' - uppercase letter
  50.  *   '\$' - lowercase letter
  51.  *   '\&' - hex digit
  52.  *   '#' - digit
  53.  *   '~' - digit or space
  54.  *   '*' - swallow remaining characters
  55.  * </PRE>
  56.  * @remark The mask tests for an exact match for any other character
  57.  * @return 1 if the string matches, 0 otherwise
  58.  */
  59. APU_DECLARE(int) apr_date_checkmask(const char *data, const char *mask);
  60.  
  61. /**
  62.  * Parses an HTTP date in one of three standard forms:
  63.  * <PRE>
  64.  *     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
  65.  *     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
  66.  *     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
  67.  * </PRE>
  68.  * @param date The date in one of the three formats above
  69.  * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or
  70.  *         0 if this would be out of range or if the date is invalid.
  71.  */
  72. APU_DECLARE(apr_time_t) apr_date_parse_http(const char *date);
  73.  
  74. /**
  75.  * Parses a string resembling an RFC 822 date.  This is meant to be
  76.  * leinent in its parsing of dates.  Hence, this will parse a wider 
  77.  * range of dates than apr_date_parse_http.
  78.  *
  79.  * The prominent mailer (or poster, if mailer is unknown) that has
  80.  * been seen in the wild is included for the unknown formats.
  81.  * <PRE>
  82.  *     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
  83.  *     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
  84.  *     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
  85.  *     Sun, 6 Nov 1994 08:49:37 GMT   ; RFC 822, updated by RFC 1123
  86.  *     Sun, 06 Nov 94 08:49:37 GMT    ; RFC 822
  87.  *     Sun, 6 Nov 94 08:49:37 GMT     ; RFC 822
  88.  *     Sun, 06 Nov 94 08:49 GMT       ; Unknown [drtr\@ast.cam.ac.uk] 
  89.  *     Sun, 6 Nov 94 08:49 GMT        ; Unknown [drtr\@ast.cam.ac.uk]
  90.  *     Sun, 06 Nov 94 8:49:37 GMT     ; Unknown [Elm 70.85]
  91.  *     Sun, 6 Nov 94 8:49:37 GMT      ; Unknown [Elm 70.85] 
  92.  * </PRE>
  93.  *
  94.  * @param date The date in one of the formats above
  95.  * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or
  96.  *         0 if this would be out of range or if the date is invalid.
  97.  */
  98. APU_DECLARE(apr_time_t) apr_date_parse_rfc(const char *date);
  99.  
  100. /** @} */
  101. #ifdef __cplusplus
  102. }
  103. #endif
  104.  
  105. #endif    /* !APR_DATE_H */
  106.