File Coverage

blib/lib/Email/Date/Format.pm

Criterion	Covered	Total	%
statement	34	34	100.0
branch	6	6	100.0
condition	2	3	66.6
subroutine	8	8	100.0
pod			n/a
total	50	51	98.0

use v5.12.0;
use warnings;
package Email::Date::Format 1.008;
# ABSTRACT: produce RFC 2822 date strings

our @EXPORT_OK = qw[email_date email_gmdate];

use Exporter 5.57 'import';
use Time::Local 1.27 ();

#pod =head1 SYNOPSIS
#pod
#pod   use Email::Date::Format qw(email_date);
#pod
#pod   my $header = email_date($date->epoch);
#pod
#pod   Email::Simple->create(
#pod     header => [
#pod       Date => $header,
#pod     ],
#pod     body => '...',
#pod   );
#pod
#pod =head1 DESCRIPTION
#pod
#pod This module provides a simple means for generating an RFC 2822 compliant
#pod datetime string.  (In case you care, they're not RFC 822 dates, because they
#pod use a four digit year, which is not allowed in RFC 822.)
#pod
#pod =func email_date
#pod
#pod   my $date = email_date; # now
#pod   my $date = email_date( time - 60*60 ); # one hour ago
#pod
#pod C accepts an epoch value, such as the one returned by C.
#pod It returns a string representing the date and time of the input, as
#pod specified in RFC 2822. If no input value is provided, the current value
#pod of C is used.
#pod
#pod C is exported only if requested.
#pod
#pod =func email_gmdate
#pod
#pod   my $date = email_gmdate;
#pod
#pod C is identical to C, but it will return a string
#pod indicating the time in Greenwich Mean Time, rather than local time.
#pod
#pod C is exported only if requested.
#pod
#pod =cut

sub _tz_diff {
  my ($time) = @_;

  my @localtime = localtime $time;
  my @gmtime    = gmtime    $time;
  $localtime[5] += 1900;
  $gmtime[5]    += 1900;
  my $diff  =   Time::Local::timegm_modern(@localtime)
              - Time::Local::timegm_modern(@gmtime);

  my $direc = $diff < 0 ? '-' : '+';
  $diff  = abs $diff;
  my $tz_hr = int( $diff / 3600 );
  my $tz_mi = int( $diff / 60 - $tz_hr * 60 );

  return ($direc, $tz_hr, $tz_mi);
}

sub _format_date {
  my ($local) = @_;

  sub {
    my ($time) = @_;
    $time //= time;

    my ($sec, $min, $hour, $mday, $mon, $year, $wday)
      = $local ? (localtime $time) : (gmtime $time);

    my $day   = (qw[Sun Mon Tue Wed Thu Fri Sat])[$wday];
    my $month = (qw[Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec])[$mon];
    $year += 1900;

    my ($direc, $tz_hr, $tz_mi) = $local ? _tz_diff($time)
      : ('+', 0, 0);

    sprintf "%s, %d %s %d %02d:%02d:%02d %s%02d%02d",
            $day, $mday, $month, $year, $hour, $min, $sec, $direc, $tz_hr, $tz_mi;
  }
}

BEGIN {
  *email_date   = _format_date(1);
  *email_gmdate = _format_date(0);
};

1;

__END__