|
132
|
1 /*******************************************************************************
|
|
|
2
|
|
|
3 copyright: Copyright (c) 2004 Kris Bell. All rights reserved
|
|
|
4
|
|
|
5 license: BSD style: $(LICENSE)
|
|
|
6
|
|
|
7 version: Initial release: May 2005
|
|
|
8
|
|
|
9 author: Kris
|
|
|
10
|
|
|
11 Converts between native and text representations of HTTP time
|
|
|
12 values. Internally, time is represented as UTC with an epoch
|
|
|
13 fixed at Jan 1st 1970. The text representation is formatted in
|
|
|
14 accordance with RFC 1123, and the parser will accept one of
|
|
|
15 RFC 1123, RFC 850, or asctime formats.
|
|
|
16
|
|
|
17 See http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html for
|
|
|
18 further detail.
|
|
|
19
|
|
|
20 Applying the D "import alias" mechanism to this module is highly
|
|
|
21 recommended, in order to limit namespace pollution:
|
|
|
22 ---
|
|
|
23 import TimeStamp = tango.text.convert.TimeStamp;
|
|
|
24
|
|
|
25 auto t = TimeStamp.parse ("Sun, 06 Nov 1994 08:49:37 GMT");
|
|
|
26 ---
|
|
|
27
|
|
|
28 *******************************************************************************/
|
|
|
29
|
|
|
30 module tango.text.convert.TimeStamp;
|
|
|
31
|
|
|
32 private import tango.time.Time;
|
|
|
33
|
|
|
34 private import tango.core.Exception;
|
|
|
35
|
|
|
36 private import Util = tango.text.Util;
|
|
|
37
|
|
|
38 private import tango.time.chrono.Gregorian;
|
|
|
39
|
|
|
40 private import Int = tango.text.convert.Integer;
|
|
|
41
|
|
|
42 /******************************************************************************
|
|
|
43
|
|
|
44 Parse provided input and return a UTC epoch time. An exception
|
|
|
45 is raised where the provided string is not fully parsed.
|
|
|
46
|
|
|
47 ******************************************************************************/
|
|
|
48
|
|
|
49 ulong toTime(T) (T[] src)
|
|
|
50 {
|
|
|
51 uint len;
|
|
|
52
|
|
|
53 auto x = parse (src, &len);
|
|
|
54 if (len < src.length)
|
|
|
55 throw new IllegalArgumentException ("unknown time format: "~src);
|
|
|
56 return x;
|
|
|
57 }
|
|
|
58
|
|
|
59 /******************************************************************************
|
|
|
60
|
|
|
61 Template wrapper to make life simpler. Returns a text version
|
|
|
62 of the provided value.
|
|
|
63
|
|
|
64 See format() for details
|
|
|
65
|
|
|
66 ******************************************************************************/
|
|
|
67
|
|
|
68 char[] toString (Time time)
|
|
|
69 {
|
|
|
70 char[32] tmp = void;
|
|
|
71
|
|
|
72 return format (tmp, time).dup;
|
|
|
73 }
|
|
|
74
|
|
|
75 /******************************************************************************
|
|
|
76
|
|
|
77 Template wrapper to make life simpler. Returns a text version
|
|
|
78 of the provided value.
|
|
|
79
|
|
|
80 See format() for details
|
|
|
81
|
|
|
82 ******************************************************************************/
|
|
|
83
|
|
|
84 wchar[] toString16 (Time time)
|
|
|
85 {
|
|
|
86 wchar[32] tmp = void;
|
|
|
87
|
|
|
88 return format (tmp, time).dup;
|
|
|
89 }
|
|
|
90
|
|
|
91 /******************************************************************************
|
|
|
92
|
|
|
93 Template wrapper to make life simpler. Returns a text version
|
|
|
94 of the provided value.
|
|
|
95
|
|
|
96 See format() for details
|
|
|
97
|
|
|
98 ******************************************************************************/
|
|
|
99
|
|
|
100 dchar[] toString32 (Time time)
|
|
|
101 {
|
|
|
102 dchar[32] tmp = void;
|
|
|
103
|
|
|
104 return format (tmp, time).dup;
|
|
|
105 }
|
|
|
106
|
|
|
107 /******************************************************************************
|
|
|
108
|
|
|
109 RFC1123 formatted time
|
|
|
110
|
|
|
111 Converts to the format "Sun, 06 Nov 1994 08:49:37 GMT", and
|
|
|
112 returns a populated slice of the provided buffer. Note that
|
|
|
113 RFC1123 format is always in absolute GMT time, and a thirty-
|
|
|
114 element buffer is sufficient for the produced output
|
|
|
115
|
|
|
116 Throws an exception where the supplied time is invalid
|
|
|
117
|
|
|
118 ******************************************************************************/
|
|
|
119
|
|
|
120 T[] format(T, U=Time) (T[] output, U t)
|
|
|
121 {return format!(T)(output, cast(Time) t);}
|
|
|
122
|
|
|
123 T[] format(T) (T[] output, Time t)
|
|
|
124 {
|
|
|
125 static T[][] Months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
|
|
|
126 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
|
|
|
127 static T[][] Days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
|
|
|
128
|
|
|
129 T[] convert (T[] tmp, int i)
|
|
|
130 {
|
|
|
131 return Int.format!(T) (tmp, i, Int.Style.Unsigned, Int.Flags.Zero);
|
|
|
132 }
|
|
|
133
|
|
|
134
|
|
|
135 assert (output.length >= 29);
|
|
|
136 if (t is t.max)
|
|
|
137 throw new IllegalArgumentException ("TimeStamp.format :: invalid Time argument");
|
|
|
138
|
|
|
139 // convert time to field values
|
|
|
140 auto time = t.time;
|
|
|
141 auto date = Gregorian.generic.toDate (t);
|
|
|
142
|
|
|
143 // use the featherweight formatter ...
|
|
|
144 T[14] tmp = void;
|
|
|
145 return Util.layout (output, "%0, %1 %2 %3 %4:%5:%6 GMT",
|
|
|
146 Days[date.dow],
|
|
|
147 convert (tmp[0..2], date.day),
|
|
|
148 Months[date.month-1],
|
|
|
149 convert (tmp[2..6], date.year),
|
|
|
150 convert (tmp[6..8], time.hours),
|
|
|
151 convert (tmp[8..10], time.minutes),
|
|
|
152 convert (tmp[10..12], time.seconds)
|
|
|
153 );
|
|
|
154 }
|
|
|
155
|
|
|
156
|
|
|
157 /******************************************************************************
|
|
|
158
|
|
|
159 Parse provided input and return a UTC epoch time. A return value
|
|
|
160 of Time.max indicated a parse-failure.
|
|
|
161
|
|
|
162 An option is provided to return the count of characters parsed -
|
|
|
163 an unchanged value here also indicates invalid input.
|
|
|
164
|
|
|
165 ******************************************************************************/
|
|
|
166
|
|
|
167 Time parse(T) (T[] src, uint* ate = null)
|
|
|
168 {
|
|
|
169 int len;
|
|
|
170 Time value;
|
|
|
171
|
|
|
172 if ((len = rfc1123 (src, value)) > 0 ||
|
|
|
173 (len = rfc850 (src, value)) > 0 ||
|
|
|
174 (len = asctime (src, value)) > 0)
|
|
|
175 {
|
|
|
176 if (ate)
|
|
|
177 *ate = len;
|
|
|
178 return value;
|
|
|
179 }
|
|
|
180
|
|
|
181 return Time.max;
|
|
|
182 }
|
|
|
183
|
|
|
184
|
|
|
185 /******************************************************************************
|
|
|
186
|
|
|
187 RFC 822, updated by RFC 1123 :: "Sun, 06 Nov 1994 08:49:37 GMT"
|
|
|
188
|
|
|
189 Returns the number of elements consumed by the parse; zero if
|
|
|
190 the parse failed
|
|
|
191
|
|
|
192 ******************************************************************************/
|
|
|
193
|
|
|
194 int rfc1123(T) (T[] src, inout Time value)
|
|
|
195 {
|
|
|
196 TimeOfDay tod;
|
|
|
197 Date date;
|
|
|
198 T* p = src.ptr;
|
|
|
199
|
|
|
200 bool dt (inout T* p)
|
|
|
201 {
|
|
|
202 return ((date.day = parseInt(p)) > 0 &&
|
|
|
203 *p++ == ' ' &&
|
|
|
204 (date.month = parseMonth(p)) > 0 &&
|
|
|
205 *p++ == ' ' &&
|
|
|
206 (date.year = parseInt(p)) > 0);
|
|
|
207 }
|
|
|
208
|
|
|
209 if (parseShortDay(p) >= 0 &&
|
|
|
210 *p++ == ',' &&
|
|
|
211 *p++ == ' ' &&
|
|
|
212 dt (p) &&
|
|
|
213 *p++ == ' ' &&
|
|
|
214 time (tod, p) &&
|
|
|
215 *p++ == ' ' &&
|
|
|
216 p[0..3] == "GMT")
|
|
|
217 {
|
|
|
218 value = Gregorian.generic.toTime (date, tod);
|
|
|
219 return (p+3) - src.ptr;
|
|
|
220 }
|
|
|
221
|
|
|
222 return 0;
|
|
|
223 }
|
|
|
224
|
|
|
225
|
|
|
226 /******************************************************************************
|
|
|
227
|
|
|
228 RFC 850, obsoleted by RFC 1036 :: "Sunday, 06-Nov-94 08:49:37 GMT"
|
|
|
229
|
|
|
230 Returns the number of elements consumed by the parse; zero if
|
|
|
231 the parse failed
|
|
|
232
|
|
|
233 ******************************************************************************/
|
|
|
234
|
|
|
235 int rfc850(T) (T[] src, inout Time value)
|
|
|
236 {
|
|
|
237 TimeOfDay tod;
|
|
|
238 Date date;
|
|
|
239 T* p = src.ptr;
|
|
|
240
|
|
|
241 bool dt (inout T* p)
|
|
|
242 {
|
|
|
243 return ((date.day = parseInt(p)) > 0 &&
|
|
|
244 *p++ == '-' &&
|
|
|
245 (date.month = parseMonth(p)) > 0 &&
|
|
|
246 *p++ == '-' &&
|
|
|
247 (date.year = parseInt(p)) > 0);
|
|
|
248 }
|
|
|
249
|
|
|
250 if (parseFullDay(p) >= 0 &&
|
|
|
251 *p++ == ',' &&
|
|
|
252 *p++ == ' ' &&
|
|
|
253 dt (p) &&
|
|
|
254 *p++ == ' ' &&
|
|
|
255 time (tod, p) &&
|
|
|
256 *p++ == ' ' &&
|
|
|
257 p[0..3] == "GMT")
|
|
|
258 {
|
|
|
259 if (date.year < 70)
|
|
|
260 date.year += 2000;
|
|
|
261 else
|
|
|
262 if (date.year < 100)
|
|
|
263 date.year += 1900;
|
|
|
264
|
|
|
265 value = Gregorian.generic.toTime (date, tod);
|
|
|
266 return (p+3) - src.ptr;
|
|
|
267 }
|
|
|
268
|
|
|
269 return 0;
|
|
|
270 }
|
|
|
271
|
|
|
272
|
|
|
273 /******************************************************************************
|
|
|
274
|
|
|
275 ANSI C's asctime() format :: "Sun Nov 6 08:49:37 1994"
|
|
|
276
|
|
|
277 Returns the number of elements consumed by the parse; zero if
|
|
|
278 the parse failed
|
|
|
279
|
|
|
280 ******************************************************************************/
|
|
|
281
|
|
|
282 int asctime(T) (T[] src, inout Time value)
|
|
|
283 {
|
|
|
284 TimeOfDay tod;
|
|
|
285 Date date;
|
|
|
286 T* p = src.ptr;
|
|
|
287
|
|
|
288 bool dt (inout T* p)
|
|
|
289 {
|
|
|
290 return ((date.month = parseMonth(p)) > 0 &&
|
|
|
291 *p++ == ' ' &&
|
|
|
292 ((date.day = parseInt(p)) > 0 ||
|
|
|
293 (*p++ == ' ' &&
|
|
|
294 (date.day = parseInt(p)) > 0)));
|
|
|
295 }
|
|
|
296
|
|
|
297 if (parseShortDay(p) >= 0 &&
|
|
|
298 *p++ == ' ' &&
|
|
|
299 dt (p) &&
|
|
|
300 *p++ == ' ' &&
|
|
|
301 time (tod, p) &&
|
|
|
302 *p++ == ' ' &&
|
|
|
303 (date.year = parseInt (p)) > 0)
|
|
|
304 {
|
|
|
305 value = Gregorian.generic.toTime (date, tod);
|
|
|
306 return p - src.ptr;
|
|
|
307 }
|
|
|
308
|
|
|
309 return 0;
|
|
|
310 }
|
|
|
311
|
|
|
312 /******************************************************************************
|
|
|
313
|
|
|
314 DOS time format :: "12-31-06 08:49AM"
|
|
|
315
|
|
|
316 Returns the number of elements consumed by the parse; zero if
|
|
|
317 the parse failed
|
|
|
318
|
|
|
319 ******************************************************************************/
|
|
|
320
|
|
|
321 int dostime(T) (T[] src, inout Time value)
|
|
|
322 {
|
|
|
323 TimeOfDay tod;
|
|
|
324 Date date;
|
|
|
325 T* p = src.ptr;
|
|
|
326
|
|
|
327 bool dt (inout T* p)
|
|
|
328 {
|
|
|
329 return ((date.month = parseInt(p)) > 0 &&
|
|
|
330 *p++ == '-' &&
|
|
|
331 ((date.day = parseInt(p)) > 0 &&
|
|
|
332 (*p++ == '-' &&
|
|
|
333 (date.year = parseInt(p)) > 0)));
|
|
|
334 }
|
|
|
335
|
|
|
336 if (dt(p) >= 0 &&
|
|
|
337 *p++ == ' ' &&
|
|
|
338 (tod.hours = parseInt(p)) > 0 &&
|
|
|
339 *p++ == ':' &&
|
|
|
340 (tod.minutes = parseInt(p)) > 0 &&
|
|
|
341 (*p == 'A' || *p == 'P'))
|
|
|
342 {
|
|
|
343 if (*p is 'P')
|
|
|
344 tod.hours += 12;
|
|
|
345
|
|
|
346 if (date.year < 70)
|
|
|
347 date.year += 2000;
|
|
|
348 else
|
|
|
349 if (date.year < 100)
|
|
|
350 date.year += 1900;
|
|
|
351
|
|
|
352 value = Gregorian.generic.toTime (date, tod);
|
|
|
353 return (p+2) - src.ptr;
|
|
|
354 }
|
|
|
355
|
|
|
356 return 0;
|
|
|
357 }
|
|
|
358
|
|
|
359 /******************************************************************************
|
|
|
360
|
|
|
361 ISO-8601 format :: "2006-01-31 14:49:30,001"
|
|
|
362
|
|
|
363 Returns the number of elements consumed by the parse; zero if
|
|
|
364 the parse failed
|
|
|
365
|
|
|
366 ******************************************************************************/
|
|
|
367
|
|
|
368 int iso8601(T) (T[] src, inout Time value)
|
|
|
369 {
|
|
|
370 TimeOfDay tod;
|
|
|
371 Date date;
|
|
|
372 T* p = src.ptr;
|
|
|
373
|
|
|
374 bool dt (inout T* p)
|
|
|
375 {
|
|
|
376 return ((date.year = parseInt(p)) > 0 &&
|
|
|
377 *p++ == '-' &&
|
|
|
378 ((date.month = parseInt(p)) > 0 &&
|
|
|
379 (*p++ == '-' &&
|
|
|
380 (date.day = parseInt(p)) > 0)));
|
|
|
381 }
|
|
|
382
|
|
|
383 if (dt(p) >= 0 &&
|
|
|
384 *p++ == ' ' &&
|
|
|
385 time (tod, p) &&
|
|
|
386 *p++ == ',')
|
|
|
387 {
|
|
|
388 tod.millis = parseInt (p);
|
|
|
389 value = Gregorian.generic.toTime (date, tod);
|
|
|
390 return p - src.ptr;
|
|
|
391 }
|
|
|
392
|
|
|
393 return 0;
|
|
|
394 }
|
|
|
395
|
|
|
396
|
|
|
397 /******************************************************************************
|
|
|
398
|
|
|
399 Parse a time field
|
|
|
400
|
|
|
401 ******************************************************************************/
|
|
|
402
|
|
|
403 private bool time(T) (inout TimeOfDay time, inout T* p)
|
|
|
404 {
|
|
|
405 return ((time.hours = parseInt(p)) > 0 &&
|
|
|
406 *p++ == ':' &&
|
|
|
407 (time.minutes = parseInt(p)) > 0 &&
|
|
|
408 *p++ == ':' &&
|
|
|
409 (time.seconds = parseInt(p)) > 0);
|
|
|
410 }
|
|
|
411
|
|
|
412
|
|
|
413 /******************************************************************************
|
|
|
414
|
|
|
415 Match a month from the input
|
|
|
416
|
|
|
417 ******************************************************************************/
|
|
|
418
|
|
|
419 private int parseMonth(T) (inout T* p)
|
|
|
420 {
|
|
|
421 int month;
|
|
|
422
|
|
|
423 switch (p[0..3])
|
|
|
424 {
|
|
|
425 case "Jan":
|
|
|
426 month = 1;
|
|
|
427 break;
|
|
|
428 case "Feb":
|
|
|
429 month = 2;
|
|
|
430 break;
|
|
|
431 case "Mar":
|
|
|
432 month = 3;
|
|
|
433 break;
|
|
|
434 case "Apr":
|
|
|
435 month = 4;
|
|
|
436 break;
|
|
|
437 case "May":
|
|
|
438 month = 5;
|
|
|
439 break;
|
|
|
440 case "Jun":
|
|
|
441 month = 6;
|
|
|
442 break;
|
|
|
443 case "Jul":
|
|
|
444 month = 7;
|
|
|
445 break;
|
|
|
446 case "Aug":
|
|
|
447 month = 8;
|
|
|
448 break;
|
|
|
449 case "Sep":
|
|
|
450 month = 9;
|
|
|
451 break;
|
|
|
452 case "Oct":
|
|
|
453 month = 10;
|
|
|
454 break;
|
|
|
455 case "Nov":
|
|
|
456 month = 11;
|
|
|
457 break;
|
|
|
458 case "Dec":
|
|
|
459 month = 12;
|
|
|
460 break;
|
|
|
461 default:
|
|
|
462 return month;
|
|
|
463 }
|
|
|
464
|
|
|
465 p += 3;
|
|
|
466 return month;
|
|
|
467 }
|
|
|
468
|
|
|
469
|
|
|
470 /******************************************************************************
|
|
|
471
|
|
|
472 Match a day from the input
|
|
|
473
|
|
|
474 ******************************************************************************/
|
|
|
475
|
|
|
476 private int parseShortDay(T) (inout T* p)
|
|
|
477 {
|
|
|
478 int day;
|
|
|
479
|
|
|
480 switch (p[0..3])
|
|
|
481 {
|
|
|
482 case "Sun":
|
|
|
483 day = 0;
|
|
|
484 break;
|
|
|
485 case "Mon":
|
|
|
486 day = 1;
|
|
|
487 break;
|
|
|
488 case "Tue":
|
|
|
489 day = 2;
|
|
|
490 break;
|
|
|
491 case "Wed":
|
|
|
492 day = 3;
|
|
|
493 break;
|
|
|
494 case "Thu":
|
|
|
495 day = 4;
|
|
|
496 break;
|
|
|
497 case "Fri":
|
|
|
498 day = 5;
|
|
|
499 break;
|
|
|
500 case "Sat":
|
|
|
501 day = 6;
|
|
|
502 break;
|
|
|
503 default:
|
|
|
504 return -1;
|
|
|
505 }
|
|
|
506
|
|
|
507 p += 3;
|
|
|
508 return day;
|
|
|
509 }
|
|
|
510
|
|
|
511
|
|
|
512 /******************************************************************************
|
|
|
513
|
|
|
514 Match a day from the input. Sunday is 0
|
|
|
515
|
|
|
516 ******************************************************************************/
|
|
|
517
|
|
|
518 private int parseFullDay(T) (inout T* p)
|
|
|
519 {
|
|
|
520 static T[][] days =
|
|
|
521 [
|
|
|
522 "Sunday",
|
|
|
523 "Monday",
|
|
|
524 "Tuesday",
|
|
|
525 "Wednesday",
|
|
|
526 "Thursday",
|
|
|
527 "Friday",
|
|
|
528 "Saturday",
|
|
|
529 ];
|
|
|
530
|
|
|
531 foreach (i, day; days)
|
|
|
532 if (day == p[0..day.length])
|
|
|
533 {
|
|
|
534 p += day.length;
|
|
|
535 return i;
|
|
|
536 }
|
|
|
537 return -1;
|
|
|
538 }
|
|
|
539
|
|
|
540
|
|
|
541 /******************************************************************************
|
|
|
542
|
|
|
543 Extract an integer from the input
|
|
|
544
|
|
|
545 ******************************************************************************/
|
|
|
546
|
|
|
547 private static int parseInt(T) (inout T* p)
|
|
|
548 {
|
|
|
549 int value;
|
|
|
550
|
|
|
551 while (*p >= '0' && *p <= '9')
|
|
|
552 value = value * 10 + *p++ - '0';
|
|
|
553 return value;
|
|
|
554 }
|
|
|
555
|
|
|
556
|
|
|
557 /******************************************************************************
|
|
|
558
|
|
|
559 ******************************************************************************/
|
|
|
560
|
|
|
561 debug (UnitTest)
|
|
|
562 {
|
|
|
563 unittest
|
|
|
564 {
|
|
|
565 wchar[30] tmp;
|
|
|
566 wchar[] test = "Sun, 06 Nov 1994 08:49:37 GMT";
|
|
|
567
|
|
|
568 auto time = parse (test);
|
|
|
569 auto text = format (tmp, time);
|
|
|
570 assert (text == test);
|
|
|
571 }
|
|
|
572 }
|
|
|
573
|
|
|
574 /******************************************************************************
|
|
|
575
|
|
|
576 ******************************************************************************/
|
|
|
577
|
|
|
578 debug (TimeStamp)
|
|
|
579 {
|
|
|
580 void main()
|
|
|
581 {
|
|
|
582 wchar[30] tmp;
|
|
|
583 wchar[] test = "Sun, 06 Nov 1994 08:49:37 GMT";
|
|
|
584
|
|
|
585 auto time = parse (test);
|
|
|
586 auto text = format (tmp, time);
|
|
|
587 assert (text == test);
|
|
|
588 }
|
|
|
589 }
|
