lib/PublicInbox/MsgTime.pm

   1 # Copyright (C) 2018-2019 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3
   4 # Various date/time-related functions
   5 package PublicInbox::MsgTime;
   6 use strict;
   7 use warnings;
   8 use base qw(Exporter);
   9 our @EXPORT_OK = qw(msg_timestamp msg_datestamp);
  10 use Date::Parse qw(str2time strptime);
  11
  12 sub str2date_zone ($) {
  13         my ($date) = @_;
  14
  15         my $ts = str2time($date);
  16         return undef unless(defined $ts);
  17
  18         # off is the time zone offset in seconds from GMT
  19         my ($ss,$mm,$hh,$day,$month,$year,$off) = strptime($date);
  20         return undef unless(defined $off);
  21
  22         # Compute the time zone from offset
  23         my $sign = ($off < 0) ? '-' : '+';
  24         my $hour = abs(int($off / 3600));
  25         my $min  = ($off / 60) % 60;
  26
  27         # deal with weird offsets like '-0420' properly
  28         $min = 60 - $min if ($min && $off < 0);
  29
  30         my $zone = sprintf('%s%02d%02d', $sign, $hour, $min);
  31
  32         # "-1200" is the furthest westermost zone offset,
  33         # but git fast-import is liberal so we use "-1400"
  34         if ($zone >= 1400 || $zone <= -1400) {
  35                 warn "bogus TZ offset: $zone, ignoring and assuming +0000\n";
  36                 $zone = '+0000';
  37         }
  38         [$ts, $zone];
  39 }
  40
  41 sub time_response ($) {
  42         my ($ret) = @_;
  43         wantarray ? @$ret : $ret->[0];
  44 }
  45
  46 sub msg_received_at ($) {
  47         my ($hdr) = @_; # Email::MIME::Header
  48         my @recvd = $hdr->header_raw('Received');
  49         my ($ts);
  50         foreach my $r (@recvd) {
  51                 $r =~ /\s*([0-9]+\s+[a-zA-Z]+\s+[0-9]{2,4}\s+
  52                         [0-9]+[^0-9][0-9]+(?:[^0-9][0-9]+)
  53                         \s+([\+\-][0-9]+))/sx or next;
  54                 $ts = eval { str2date_zone($1) } and return $ts;
  55                 my $mid = $hdr->header_raw('Message-ID');
  56                 warn "no date in $mid Received: $r\n";
  57         }
  58         undef;
  59 }
  60
  61 sub msg_date_only ($) {
  62         my ($hdr) = @_; # Email::MIME::Header
  63         my @date = $hdr->header_raw('Date');
  64         my ($ts);
  65         foreach my $d (@date) {
  66                 # Y2K problems: 3-digit years
  67                 $d =~ s!([A-Za-z]{3}) ([0-9]{3}) ([0-9]{2}:[0-9]{2}:[0-9]{2})!
  68                         my $yyyy = $2 + 1900; "$1 $yyyy $3"!e;
  69                 $ts = eval { str2date_zone($d) } and return $ts;
  70                 if ($@) {
  71                         my $mid = $hdr->header_raw('Message-ID');
  72                         warn "bad Date: $d in $mid: $@\n";
  73                 }
  74         }
  75         undef;
  76 }
  77
  78 # Favors Received header for sorting globally
  79 sub msg_timestamp ($) {
  80         my ($hdr) = @_; # Email::MIME::Header
  81         my $ret;
  82         $ret = msg_received_at($hdr) and return time_response($ret);
  83         $ret = msg_date_only($hdr) and return time_response($ret);
  84         wantarray ? (time, '+0000') : time;
  85 }
  86
  87 # Favors the Date: header for display and sorting within a thread
  88 sub msg_datestamp ($) {
  89         my ($hdr) = @_; # Email::MIME::Header
  90         my $ret;
  91         $ret = msg_date_only($hdr) and return time_response($ret);
  92         $ret = msg_received_at($hdr) and return time_response($ret);
  93         wantarray ? (time, '+0000') : time;
  94 }
  95
  96 1;