X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FDate.pm;h=2b6a3e3f496faab177ec936e563ff4011fb75167;hp=620acc7590b8aa14784e34577d1898b4df3f1cdc;hb=75162bb14b3e38d66617077843f4dfdcaf09d5c4;hpb=d4d0590bef31071e8809ec046717444b95b3f30a diff --git a/rt/lib/RT/Date.pm b/rt/lib/RT/Date.pm index 620acc759..2b6a3e3f4 100644 --- a/rt/lib/RT/Date.pm +++ b/rt/lib/RT/Date.pm @@ -1,38 +1,40 @@ # BEGIN BPS TAGGED BLOCK {{{ -# +# # COPYRIGHT: -# -# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC -# -# +# +# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC +# +# # (Except where explicitly superseded by other copyright notices) -# -# +# +# # LICENSE: -# +# # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have # been provided with this software, but in any event can be snarfed # from www.gnu.org. -# +# # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. -# +# # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software -# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -# -# +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +# +# # CONTRIBUTION SUBMISSION POLICY: -# +# # (The following paragraph is not intended to limit the rights granted # to you to modify and distribute this software under the terms of # the GNU General Public License and is only of importance to you if # you choose to contribute your changes and enhancements to the # community by submitting them to Best Practical Solutions, LLC.) -# +# # By intentionally submitting any modifications, corrections or # derivatives to this work, or any other work intended for use with # Request Tracker, to Best Practical Solutions, LLC, you confirm that @@ -41,7 +43,7 @@ # royalty-free, perpetual, license to use, copy, create derivative # works based on those contributions, and sublicense and distribute # those contributions and any derivatives thereof. -# +# # END BPS TAGGED BLOCK }}} =head1 NAME @@ -58,11 +60,6 @@ RT Date is a simple Date Object designed to be speedy and easy for RT to use The fact that it assumes that a time of 0 means "never" is probably a bug. -=begin testing - -ok (require RT::Date); - -=end testing =head1 METHODS @@ -72,12 +69,11 @@ ok (require RT::Date); package RT::Date; use Time::Local; - -use RT::Base; +use POSIX qw(tzset); use strict; -use vars qw/@ISA/; -@ISA = qw/RT::Base/; +use warnings; +use base qw/RT::Base/; use vars qw($MINUTE $HOUR $DAY $WEEK $MONTH $YEAR); @@ -85,30 +81,68 @@ $MINUTE = 60; $HOUR = 60 * $MINUTE; $DAY = 24 * $HOUR; $WEEK = 7 * $DAY; -$MONTH = 4 * $WEEK; -$YEAR = 365 * $DAY; - -# {{{ sub new - -sub new { - my $proto = shift; - my $class = ref($proto) || $proto; - my $self = {}; - bless ($self, $class); - $self->CurrentUser(@_); - $self->Unix(0); - return $self; +$MONTH = 30.4375 * $DAY; +$YEAR = 365.25 * $DAY; + +our @MONTHS = ( + 'Jan', # loc + 'Feb', # loc + 'Mar', # loc + 'Apr', # loc + 'May', # loc + 'Jun', # loc + 'Jul', # loc + 'Aug', # loc + 'Sep', # loc + 'Oct', # loc + 'Nov', # loc + 'Dec', # loc +); + +our @DAYS_OF_WEEK = ( + 'Sun', # loc + 'Mon', # loc + 'Tue', # loc + 'Wed', # loc + 'Thu', # loc + 'Fri', # loc + 'Sat', # loc +); + +our @FORMATTERS = ( + 'DefaultFormat', # loc + 'ISO', # loc + 'W3CDTF', # loc + 'RFC2822', # loc + 'RFC2616', # loc + 'iCal', # loc +); +if ( eval 'use DateTime qw(); 1;' && eval 'use DateTime::Locale qw(); 1;' && + DateTime->can('format_cldr') && DateTime::Locale::root->can('date_format_full') ) { + push @FORMATTERS, 'LocalizedDateTime'; # loc } -# }}} +=head2 new + +Object constructor takes one argument C object. -# {{{ sub Set +=cut + +sub new { + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + bless ($self, $class); + $self->CurrentUser(@_); + $self->Unix(0); + return $self; +} -=head2 sub Set +=head2 Set -takes a param hash with the fields 'Format' and 'Value' +Takes a param hash with the fields C, C and C. -if $args->{'Format'} is 'unix', takes the number of seconds since the epoch +If $args->{'Format'} is 'unix', takes the number of seconds since the epoch. If $args->{'Format'} is ISO, tries to parse an ISO date. @@ -117,244 +151,218 @@ things out. This is a heavyweight operation that should never be called from within RT's core. But it's really useful for something like the textbox date entry where we let the user do whatever they want. -If $args->{'Value'} is 0, assumes you mean never. - -=begin testing - -use_ok(RT::Date); -my $date = RT::Date->new($RT::SystemUser); -$date->Set(Format => 'unix', Value => '0'); -ok ($date->ISO eq '1970-01-01 00:00:00', "Set a date to midnight 1/1/1970 GMT"); - -=end testing +If $args->{'Value'} is 0, assumes you mean never. =cut sub Set { my $self = shift; - my %args = ( Format => 'unix', - Value => time, - @_ ); - if ( !$args{'Value'} - || ( ( $args{'Value'} =~ /^\d*$/ ) and ( $args{'Value'} == 0 ) ) ) { - $self->Unix(-1); - return ( $self->Unix() ); - } + my %args = ( + Format => 'unix', + Value => time, + Timezone => 'user', + @_ + ); + + return $self->Unix(0) unless $args{'Value'}; if ( $args{'Format'} =~ /^unix$/i ) { - $self->Unix( $args{'Value'} ); + return $self->Unix( $args{'Value'} ); } - elsif ( $args{'Format'} =~ /^(sql|datemanip|iso)$/i ) { - $args{'Value'} =~ s!/!-!g; - - if (( $args{'Value'} =~ /^(\d{4}?)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/ ) - || ( $args{'Value'} =~ - /^(\d{4}?)-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)$/ ) - || ( $args{'Value'} =~ - /^(\d{4}?)-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)\+00$/ ) - || ($args{'Value'} =~ /^(\d{4}?)(\d\d)(\d\d)(\d\d):(\d\d):(\d\d)$/ ) + $args{'Value'} =~ s!/!-!g; + + if ( ( $args{'Value'} =~ /^(\d{4})?(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/ ) + || ( $args{'Value'} =~ /^(\d{4})?(\d\d)(\d\d)(\d\d):(\d\d):(\d\d)$/ ) + || ( $args{'Value'} =~ /^(?:(\d{4})-)?(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)$/ ) + || ( $args{'Value'} =~ /^(?:(\d{4})-)?(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)\+00$/ ) ) { - my $year = $1; - my $mon = $2; - my $mday = $3; - my $hours = $4; - my $min = $5; - my $sec = $6; + my ($year, $mon, $mday, $hours, $min, $sec) = ($1, $2, $3, $4, $5, $6); + + # use current year if string has no value + $year ||= (localtime time)[5] + 1900; #timegm expects month as 0->11 $mon--; - #now that we've parsed it, deal with the case where everything - #was 0 - if ( $mon == -1 ) { - $self->Unix(-1); - } - else { - - #Dateamnip strings aren't in GMT. - if ( $args{'Format'} =~ /^datemanip$/i ) { - $self->Unix( - timelocal( $sec, $min, $hours, $mday, $mon, $year ) ); - } - - #ISO and SQL dates are in GMT - else { - $self->Unix( - timegm( $sec, $min, $hours, $mday, $mon, $year ) ); - } - - $self->Unix(-1) unless $self->Unix; - } + #now that we've parsed it, deal with the case where everything was 0 + return $self->Unix(0) if $mon < 0 || $mon > 11; + + my $tz = lc $args{'Format'} eq 'datemanip'? 'user': 'utc'; + $self->Unix( $self->Timelocal( $tz, $sec, $min, $hours, $mday, $mon, $year ) ); + + $self->Unix(0) unless $self->Unix > 0; } else { - use Carp; - Carp::cluck; - $RT::Logger->debug( - "Couldn't parse date $args{'Value'} as a $args{'Format'}"); - + $RT::Logger->warning( + "Couldn't parse date '$args{'Value'}' as a $args{'Format'} format" + ); + return $self->Unix(0); } } elsif ( $args{'Format'} =~ /^unknown$/i ) { require Time::ParseDate; - - #Convert it to an ISO format string - - my $date = Time::ParseDate::parsedate($args{'Value'}, - UK => $RT::DateDayBeforeMonth, - PREFER_PAST => $RT::AmbiguousDayInPast, - PREFER_FUTURE => !($RT::AmbiguousDayInPast)); - - #This date has now been set to a date in the _local_ timezone. - #since ISO dates are known to be in GMT (for RT's purposes); - - $RT::Logger->debug( "RT::Date used date::parse to make " - . $args{'Value'} - . " $date\n" ); - - return ( $self->Set( Format => 'unix', Value => "$date" ) ); + # the module supports only legacy timezones like PDT or EST... + # so we parse date as GMT and later apply offset, this only + # should be applied to absolute times, so compensate shift in NOW + my $now = time; + $now += ($self->Localtime( $args{Timezone}, $now ))[9]; + my $date = Time::ParseDate::parsedate( + $args{'Value'}, + GMT => 1, + NOW => $now, + UK => RT->Config->Get('DateDayBeforeMonth'), + PREFER_PAST => RT->Config->Get('AmbiguousDayInPast'), + PREFER_FUTURE => RT->Config->Get('AmbiguousDayInFuture'), + ); + # apply timezone offset + $date -= ($self->Localtime( $args{Timezone}, $date ))[9]; + + $RT::Logger->debug( + "RT::Date used Time::ParseDate to make '$args{'Value'}' $date\n" + ); + + return $self->Set( Format => 'unix', Value => $date); } else { - die "Unknown Date format: " . $args{'Format'} . "\n"; + $RT::Logger->error( + "Unknown Date format: $args{'Format'}\n" + ); + return $self->Unix(0); } - return ( $self->Unix() ); + return $self->Unix; } -# }}} +=head2 SetToNow -# {{{ sub SetToMidnight +Set the object's time to the current time. Takes no arguments +and returns unix time. -=head2 SetToMidnight +=cut + +sub SetToNow { + return $_[0]->Unix(time); +} -Sets the date to midnight (at the beginning of the day) GMT +=head2 SetToMidnight [Timezone => 'utc'] + +Sets the date to midnight (at the beginning of the day). Returns the unixtime at midnight. -=cut +Arguments: -sub SetToMidnight { - my $self = shift; - - use Time::Local; - my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) = gmtime($self->Unix); - $self->Unix(timegm (0,0,0,$mday,$mon,$year,$wday,$yday)); - - return ($self->Unix); - - -} +=over 4 +=item Timezone -# }}} +Timezone context C, C or C. See also L. -# {{{ sub SetToNow -sub SetToNow { - my $self = shift; - return($self->Set(Format => 'unix', Value => time)) -} -# }}} +=back -# {{{ sub Diff +=cut + +sub SetToMidnight { + my $self = shift; + my %args = ( Timezone => '', @_ ); + my $new = $self->Timelocal( + $args{'Timezone'}, + 0,0,0,($self->Localtime( $args{'Timezone'} ))[3..9] + ); + return $self->Unix( $new ); +} =head2 Diff -Takes either an RT::Date object or the date in unixtime format as a string +Takes either an C object or the date in unixtime format as a string, +if nothing is specified uses the current time. -Returns the differnce between $self and that time as a number of seconds +Returns the differnce between the time in the current object and that time +as a number of seconds. Returns C if any of two compared values is +incorrect or not set. =cut sub Diff { my $self = shift; my $other = shift; - - if (ref($other) eq 'RT::Date') { - $other=$other->Unix; + $other = time unless defined $other; + if ( UNIVERSAL::isa( $other, 'RT::Date' ) ) { + $other = $other->Unix; } - return ($self->Unix - $other); -} -# }}} + return undef unless $other=~ /^\d+$/ && $other > 0; + + my $unix = $self->Unix; + return undef unless $unix > 0; -# {{{ sub DiffAsString + return $unix - $other; +} -=head2 sub DiffAsString +=head2 DiffAsString -Takes either an RT::Date object or the date in unixtime format as a string +Takes either an C object or the date in unixtime format as a string, +if nothing is specified uses the current time. -Returns the differnce between $self and that time as a number of seconds as -as string fit for human consumption +Returns the differnce between C<$self> and that time as a number of seconds as +a localized string fit for human consumption. Returns empty string if any of +two compared values is incorrect or not set. =cut sub DiffAsString { my $self = shift; - my $other = shift; - - - if ($other < 1) { - return (""); - } - if ($self->Unix < 1) { - return(""); - } - my $diff = $self->Diff($other); + my $diff = $self->Diff( @_ ); + return '' unless defined $diff; - return ($self->DurationAsString($diff)); + return $self->DurationAsString( $diff ); } -# }}} - -# {{{ sub DurationAsString - =head2 DurationAsString -Takes a number of seconds. returns a string describing that duration +Takes a number of seconds. Returns a localized string describing +that duration. =cut sub DurationAsString { - my $self = shift; - my $duration = shift; + my $duration = int shift; - my ( $negative, $s ); + my ( $negative, $s, $time_unit ); + $negative = 1 if $duration < 0; + $duration = abs $duration; - $negative = 1 if ( $duration < 0 ); - - $duration = abs($duration); - - my $time_unit; if ( $duration < $MINUTE ) { $s = $duration; $time_unit = $self->loc("sec"); } elsif ( $duration < ( 2 * $HOUR ) ) { - $s = int( $duration / $MINUTE ); + $s = int( $duration / $MINUTE + 0.5 ); $time_unit = $self->loc("min"); } elsif ( $duration < ( 2 * $DAY ) ) { - $s = int( $duration / $HOUR ); + $s = int( $duration / $HOUR + 0.5 ); $time_unit = $self->loc("hours"); } elsif ( $duration < ( 2 * $WEEK ) ) { - $s = int( $duration / $DAY ); + $s = int( $duration / $DAY + 0.5 ); $time_unit = $self->loc("days"); } elsif ( $duration < ( 2 * $MONTH ) ) { - $s = int( $duration / $WEEK ); + $s = int( $duration / $WEEK + 0.5 ); $time_unit = $self->loc("weeks"); } elsif ( $duration < $YEAR ) { - $s = int( $duration / $MONTH ); + $s = int( $duration / $MONTH + 0.5 ); $time_unit = $self->loc("months"); } else { - $s = int( $duration / $YEAR ); + $s = int( $duration / $YEAR + 0.5 ); $time_unit = $self->loc("years"); } - if ($negative) { + if ( $negative ) { return $self->loc( "[_1] [_2] ago", $s, $time_unit ); } else { @@ -362,47 +370,46 @@ sub DurationAsString { } } -# }}} - -# {{{ sub AgeAsString +=head2 AgeAsString -=head2 sub AgeAsString +Takes nothing. Returns a string that's the differnce between the +time in the object and now. -Takes nothing +=cut -Returns a string that's the differnce between the time in the object and now +sub AgeAsString { return $_[0]->DiffAsString } -=cut -sub AgeAsString { - my $self = shift; - return ($self->DiffAsString(time)); - } -# }}} -# {{{ sub AsString +=head2 AsString -=head2 sub AsString +Returns the object's time as a localized string with curent user's prefered +format and timezone. -Returns the object\'s time as a string with the current timezone. +If the current user didn't choose prefered format then system wide setting is +used or L if the latter is not specified. See config option +C. =cut sub AsString { my $self = shift; - return ($self->loc("Not set")) if ($self->Unix <= 0); + my %args = (@_); - my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($self->Unix); + return $self->loc("Not set") unless $self->Unix > 0; - return $self->loc("[_1] [_2] [_3] [_4]:[_5]:[_6] [_7]", $self->GetWeekday($wday), $self->GetMonth($mon), map {sprintf "%02d", $_} ($mday, $hour, $min, $sec), ($year+1900)); -} -# }}} + my $format = RT->Config->Get( 'DateTimeFormat', $self->CurrentUser ) || 'DefaultFormat'; + $format = { Format => $format } unless ref $format; + %args = (%$format, %args); -# {{{ GetWeekday + return $self->Get( Timezone => 'user', %args ); +} =head2 GetWeekday DAY -Takes an integer day of week and returns a localized string for that day of week +Takes an integer day of week and returns a localized string for +that day of week. Valid values are from range 0-6, Note that B<0 +is sunday>. =cut @@ -410,193 +417,629 @@ sub GetWeekday { my $self = shift; my $dow = shift; - return $self->loc('Mon.') if ($dow == 1); - return $self->loc('Tue.') if ($dow == 2); - return $self->loc('Wed.') if ($dow == 3); - return $self->loc('Thu.') if ($dow == 4); - return $self->loc('Fri.') if ($dow == 5); - return $self->loc('Sat.') if ($dow == 6); - return $self->loc('Sun.') if ($dow == 0); + return $self->loc($DAYS_OF_WEEK[$dow]) + if $DAYS_OF_WEEK[$dow]; + return ''; } -# }}} - -# {{{ GetMonth - -=head2 GetMonth DAY +=head2 GetMonth MONTH -Takes an integer month and returns a localized string for that month +Takes an integer month and returns a localized string for that month. +Valid values are from from range 0-11. =cut sub GetMonth { my $self = shift; - my $mon = shift; - - # We do this rather than an array so that we don't call localize 12x what we need to - return $self->loc('Jan.') if ($mon == 0); - return $self->loc('Feb.') if ($mon == 1); - return $self->loc('Mar.') if ($mon == 2); - return $self->loc('Apr.') if ($mon == 3); - return $self->loc('May.') if ($mon == 4); - return $self->loc('Jun.') if ($mon == 5); - return $self->loc('Jul.') if ($mon == 6); - return $self->loc('Aug.') if ($mon == 7); - return $self->loc('Sep.') if ($mon == 8); - return $self->loc('Oct.') if ($mon == 9); - return $self->loc('Nov.') if ($mon == 10); - return $self->loc('Dec.') if ($mon == 11); -} - -# }}} + my $mon = shift; -# {{{ sub AddSeconds + return $self->loc($MONTHS[$mon]) + if $MONTHS[$mon]; + return ''; +} -=head2 sub AddSeconds +=head2 AddSeconds SECONDS -Takes a number of seconds as a string +Takes a number of seconds and returns the new unix time. -Returns the new time +Negative value can be used to substract seconds. =cut sub AddSeconds { my $self = shift; - my $delta = shift; + my $delta = shift or return $self->Unix; $self->Set(Format => 'unix', Value => ($self->Unix + $delta)); - + return ($self->Unix); - +} + +=head2 AddDays [DAYS] +Adds C<24 hours * DAYS> to the current time. Adds one day when +no argument is specified. Negative value can be used to substract +days. + +Returns new unix time. + +=cut + +sub AddDays { + my $self = shift; + my $days = shift || 1; + return $self->AddSeconds( $days * $DAY ); } -# }}} +=head2 AddDay + +Adds 24 hours to the current time. Returns new unix time. -# {{{ sub AddDays +=cut -=head2 AddDays $DAYS +sub AddDay { return $_[0]->AddSeconds($DAY) } -Adds 24 hours * $DAYS to the current time +=head2 Unix [unixtime] + +Optionally takes a date in unix seconds since the epoch format. +Returns the number of seconds since the epoch =cut -sub AddDays { +sub Unix { + my $self = shift; + $self->{'time'} = int(shift || 0) if @_; + return $self->{'time'}; +} + +=head2 DateTime + +Alias for L method. Arguments C and