X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdate.php;h=06e921200fc4e9379286c4b1724c00cfce21b94f;hp=85a4cd6922fc4714c457fa88f4ffc11e842b7c56;hb=ace33b58d2b4d8266e1dc66d1bbe54074eb01a70;hpb=22d739419c0903ab824c99ba623b5d72d5d7261d diff --git a/functions/date.php b/functions/date.php index 85a4cd69..06e92120 100644 --- a/functions/date.php +++ b/functions/date.php @@ -3,20 +3,30 @@ /** * date.php * - * Copyright (c) 1999-2003 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * Takes a date and parses it into a usable format. The form that a * date SHOULD arrive in is: * 29 Jun 1999 09:52:11 -0500 (EDT) * (as specified in RFC 822) -- 'Tue' is optional * - * $Id$ + * @copyright 1999-2010 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage date */ -require_once(SM_PATH . 'functions/constants.php'); +/** + * dependency information + * - none + */ -/* corrects a time stamp to be the local time */ +/** + * Corrects a time stamp to be the local time. + * + * @param int stamp the timestamp to adjust + * @param string tzc the timezone correction + * @return int the corrected timestamp + */ function getGMTSeconds($stamp, $tzc) { /* date couldn't be parsed */ if ($stamp == -1) { @@ -29,26 +39,26 @@ function getGMTSeconds($stamp, $tzc) { case 'PST': $tzc = '-0800'; break; - case 'Mountain': - case 'MST': - case 'PDT': - $tzc = '-0700'; + case 'Mountain': + case 'MST': + case 'PDT': + $tzc = '-0700'; break; case 'Central': case 'CST': - case 'MDT': - $tzc = '-0600'; + case 'MDT': + $tzc = '-0600'; break; case 'Eastern': case 'EST': - case 'CDT': - $tzc = '-0500'; + case 'CDT': + $tzc = '-0500'; break; case 'EDT': $tzc = '-0400'; break; - case 'GMT': - $tzc = '+0000'; + case 'GMT': + $tzc = '+0000'; break; case 'BST': case 'MET': @@ -56,17 +66,19 @@ function getGMTSeconds($stamp, $tzc) { $tzc = '+0100'; break; case 'EET': - case 'IST': - case 'MET DST': - case 'METDST': - $tzc = '+0200'; + case 'IST': + case 'MET DST': + case 'METDST': + case 'MEST': + case 'CEST': + $tzc = '+0200'; break; - case 'HKT': - $tzc = '+0800'; + case 'HKT': + $tzc = '+0800'; break; - case 'JST': + case 'JST': case 'KST': - $tzc = '+0900'; + $tzc = '+0900'; break; } $neg = false; @@ -78,24 +90,27 @@ function getGMTSeconds($stamp, $tzc) { $hh = substr($tzc,1,2); $mm = substr($tzc,3,2); $iTzc = ($hh * 60 + $mm) * 60; - if ($neg) $iTzc = -1 * (int) $iTzc; + if ($neg) $iTzc = -1 * (int) $iTzc; /* stamp in gmt */ $stamp -= $iTzc; - /** now find what the server is at **/ + /* now find what the server is at */ $current = date('Z', time()); /* stamp in local timezone */ $stamp += $current; - + return $stamp; } /** - Switch system has been intentionaly chosen for the - internationalization of month and day names. The reason - is to make sure that _("") strings will go into the - main po. -**/ - + * Returns the (localized) string for a given day number. + * Switch system has been intentionaly chosen for the + * internationalization of month and day names. The reason + * is to make sure that _("") strings will go into the + * main po. + * + * @param int day_number the day number + * @return string the day in human readable form + */ function getDayName( $day_number ) { switch( $day_number ) { @@ -126,6 +141,11 @@ function getDayName( $day_number ) { return( $ret ); } +/** + * Like getDayName, but returns the short form + * @param int day_number the day number + * @return string the day in short human readable form + */ function getDayAbrv( $day_number ) { switch( $day_number ) { @@ -156,6 +176,13 @@ function getDayAbrv( $day_number ) { return( $ret ); } + +/** + * Returns the (localized) string for a given month number. + * + * @param string month_number the month number (01..12) + * @return string the month name in human readable form + */ function getMonthName( $month_number ) { switch( $month_number ) { case '01': @@ -200,6 +227,13 @@ function getMonthName( $month_number ) { return( $ret ); } +/** + * Returns the (localized) string for a given month number, + * short representation. + * + * @param string month_number the month number (01..12) + * @return string the shortened month in human readable form + */ function getMonthAbrv( $month_number ) { switch( $month_number ) { case '01': @@ -244,106 +278,169 @@ function getMonthAbrv( $month_number ) { return( $ret ); } - +/** + * Returns the localized representation of the date/time. + * + * @param string date_format The format for the date, like the input for the PHP date() function. + * @param int stamp the timestamp to convert + * @return string a full date representation + */ function date_intl( $date_format, $stamp ) { - - $ret = str_replace( 'D', '$1', $date_format ); - $ret = str_replace( 'F', '$2', $ret ); - $ret = str_replace( 'l', '$4', $ret ); - $ret = str_replace( 'M', '$5', $ret ); - $ret = date( '$3'. $ret . '$3', $stamp ); // Workaround for a PHP 4.0.4 problem - $ret = str_replace( '$1', getDayAbrv( date( 'w', $stamp ) ), $ret ); - $ret = str_replace( '$5', getMonthAbrv( date( 'm', $stamp ) ), $ret ); - $ret = str_replace( '$2', getMonthName( date( 'm', $stamp ) ), $ret ); - $ret = str_replace( '$4', getDayName( date( 'w', $stamp ) ), $ret ); - $ret = str_replace( '$3', '', $ret ); - + $ret = str_replace( array('D','F','l','M'), array('$1','$2','$3','$4'), $date_format ); + // to reduce the date calls we retrieve m and w in the same call + $ret = date('w#m#'. $ret, $stamp ); + // extract day and month in order to replace later by intl day and month + $aParts = explode('#',$ret); + $ret = str_replace(array('$1','$4','$2','$3',), + array(getDayAbrv($aParts[0]), + getMonthAbrv($aParts[1]), + getMonthName($aParts[1]), + getDayName($aParts[0])), + $aParts[2]); return( $ret ); } -function getLongDateString( $stamp ) { +/** + * This returns a date of the format "Wed, Oct 29, 2003 9:52 am", + * or the same in 24H format (depending on the user's settings), + * and taking localization into accout. + * + * @param int stamp the timestamp + * @param string fallback string to use when stamp not valid + * @return string the long date string + */ +function getLongDateString( $stamp, $fallback = '' ) { global $hour_format; - + if ($stamp == -1) { - return ''; + return $fallback; } if ( $hour_format == SMPREF_TIME_12HR ) { $date_format = _("D, F j, Y g:i a"); } else { - $date_format = _("D, F j, Y G:i"); + $date_format = _("D, F j, Y H:i"); } - + return( date_intl( $date_format, $stamp ) ); } +/** + * Returns a short representation of the date, + * taking timezones and localization into account. + * Depending on user's settings, this string can be + * of the form: "14:23" or "Jun 14, 2003" depending + * on whether the stamp is "today" or not. + * + * @param int stamp the timestamp + * @return string the date string + */ function getDateString( $stamp ) { - global $invert_time, $hour_format; + global $invert_time, $hour_format, $show_full_date, $custom_date_format; if ( $stamp == -1 ) { return ''; } - + $now = time(); - + $dateZ = date('Z', $now ); + + // FIXME: isn't this obsolete and introduced as a terrible workaround + // for bugs at other places which are fixed a long time ago? if ($invert_time) { $dateZ = - $dateZ; } + + // calculate when it was midnight and when it will be, + // in order to display dates differently if they're 'today' $midnight = $now - ($now % 86400) - $dateZ; - - if ($midnight < $stamp) { + // this is to correct if after calculations midnight is more than + // one whole day away. + if ($now - $midnight > 86400) { + $midnight += 86400; + } + $nextmid = $midnight + 86400; + + $custom_date_format = trim($custom_date_format); + if (!empty($custom_date_format)) { + $date_format = $custom_date_format; + } else if ($show_full_date == 1 || $nextmid < $stamp) { + $date_format = _("M j, Y"); + } else if ($midnight < $stamp) { /* Today */ if ( $hour_format == SMPREF_TIME_12HR ) { $date_format = _("g:i a"); } else { - $date_format = _("G:i"); + $date_format = _("H:i"); } } else if ($midnight - 518400 < $stamp) { /* This week */ if ( $hour_format == SMPREF_TIME_12HR ) { $date_format = _("D, g:i a"); } else { - $date_format = _("D, G:i"); + $date_format = _("D, H:i"); } } else { /* before this week */ $date_format = _("M j, Y"); } - + return( date_intl( $date_format, $stamp ) ); } +/** + * Decodes a RFC 822 Date-header into a timestamp + * + * @param array dateParts the Date-header split by whitespace + * @return int the timestamp calculated from the header + */ function getTimeStamp($dateParts) { - /** $dateParts[0] == Mon, Tue, Wed - ** $dateParts[1] == 23 - ** $dateParts[2] == Jan, Feb, Mar - ** $dateParts[3] == 1999 - ** $dateParts[4] ==