Happy New Year
[squirrelmail.git] / functions / date.php
index 8e86e10def4b6a7c28bd905ef80e10ab450440b3..dbd482ab48b6abd140139332a1e29ec82ff44f68 100644 (file)
@@ -3,21 +3,22 @@
 /**
  * date.php
  *
- * Copyright (c) 1999-2005 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:
  *       <Tue,> 29 Jun 1999 09:52:11 -0500 (EDT)
  * (as specified in RFC 822) -- 'Tue' is optional
  *
+ * @copyright 1999-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  * @subpackage date
  */
 
-/** Load up some useful constants */
-require_once(SM_PATH . 'functions/constants.php');
+/**
+ * dependency information
+ * - none
+ */
 
 /**
  * Corrects a time stamp to be the local time.
@@ -68,6 +69,8 @@ function getGMTSeconds($stamp, $tzc) {
         case 'IST':
         case 'MET DST':
         case 'METDST':
+       case 'MEST':
+       case 'CEST':
             $tzc = '+0200';
             break;
         case 'HKT':
@@ -90,7 +93,7 @@ function getGMTSeconds($stamp, $tzc) {
     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;
@@ -288,11 +291,12 @@ function date_intl( $date_format, $stamp ) {
     $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]);
+    $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 );
 }
 
@@ -302,20 +306,21 @@ function date_intl( $date_format, $stamp ) {
  * 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 ) {
+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 ) );
@@ -329,12 +334,19 @@ function getLongDateString( $stamp ) {
  * of the form: "14:23" or "Jun 14, 2003" depending
  * on whether the stamp is "today" or not.
  *
- * @param int stamp the timestamp
+ * @param int $stamp The timestamp
+ * @param boolean $return_full_date_and_time When TRUE,
+ *                                           ignore all
+ *                                           user settings
+ *                                           and use full
+ *                                           date and time
+ *                                           (OPTIONAL;
+ *                                           default FALSE)
  * @return string the date string
  */
-function getDateString( $stamp ) {
+function getDateString( $stamp, $return_full_date_and_time=FALSE ) {
 
-    global $invert_time, $hour_format, $show_full_date;
+    global $invert_time, $hour_format, $show_full_date, $custom_date_format;
 
     if ( $stamp == -1 ) {
        return '';
@@ -360,21 +372,31 @@ function getDateString( $stamp ) {
     }
     $nextmid = $midnight + 86400;
 
-    if (($show_full_date == 1) || ($nextmid < $stamp)) {
+    $custom_date_format = trim($custom_date_format);
+
+    if ($return_full_date_and_time) {
+        if ( $hour_format == SMPREF_TIME_12HR ) {
+            $date_format = _("D, F j, Y g:i a");
+        } else {
+            $date_format = _("D, F j, Y H:i");
+        }
+    } else 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 */
@@ -391,27 +413,22 @@ function getDateString( $stamp ) {
  * @return int the timestamp calculated from the header
  */
 function getTimeStamp($dateParts) {
-    /** $dateParts[0] == <day of week>   Mon, Tue, Wed
-    ** $dateParts[1] == <day of month>  23
-    ** $dateParts[2] == <month>         Jan, Feb, Mar
-    ** $dateParts[3] == <year>          1999
-    ** $dateParts[4] == <time>          18:54:23 (HH:MM:SS)
-    ** $dateParts[5] == <from GMT>      +0100
-    ** $dateParts[6] == <zone>          (EDT)
-    **
-    ** NOTE:  In RFC 822, it states that <day of week> is optional.
-    **        In that case, dateParts[0] would be the <day of month>
-    **        and everything would be bumped up one.
-    **/
-
-    /*
-     * Simply check to see if the first element in the dateParts
-     * array is an integer or not.
-     * Since the day of week is optional, this check is needed.
+    /* $dateParts[0] == <day of week>   Mon, Tue, Wed
+     * $dateParts[1] == <day of month>  23
+     * $dateParts[2] == <month>         Jan, Feb, Mar
+     * $dateParts[3] == <year>          1999
+     * $dateParts[4] == <time>          18:54:23 (HH:MM:SS)
+     * $dateParts[5] == <from GMT>      +0100
+     * $dateParts[6] == <zone>          (EDT)
+     *
+     * NOTE:  In RFC 822, it states that <day of week> is optional.
+     *        In that case, dateParts[0] would be the <day of month>
+     *        and everything would be bumped up one.
      */
-     if (count($dateParts) <2) {
+
+    if (count($dateParts) <2) {
         return -1;
-     } else if (count($dateParts) ==3) {
+    } else if (count($dateParts) ==3) {
         if (substr_count($dateParts[0],'-') == 2 &&
             substr_count($dateParts[1],':') == 2) {
             //  dd-Month-yyyy 23:19:05 +0200
@@ -420,12 +437,24 @@ function getTimeStamp($dateParts) {
             $newDate = array($aDate[0],$aDate[1],$aDate[2],$dateParts[1],$dateParts[2]);
             $dateParts = $newDate;
         }
-     }
+    }
 
-    /* remove day of week */
+    /*
+     * Simply check to see if the first element in the dateParts
+     * array is an integer or not.
+     * Since the day of week is optional, this check is needed.
+     */
     if (!is_numeric(trim($dateParts[0]))) {
-        $dataParts = array_shift($dateParts);
+        /* cope with broken mailers that send "Tue,23" without space */
+        if ( preg_match ('/^\w+,(\d{1,2})$/', $dateParts[0], $match) ) {
+            /* replace Tue,23 with 23 */
+            $dateParts[0] = $match[1];
+        } else {
+            /* just drop the day of week */
+            array_shift($dateParts);
+        }
     }
+
     /* calculate timestamp separated from the zone and obs-zone */
     $stamp = strtotime(implode (' ', array_splice ($dateParts,0,4)));
     if (!isset($dateParts[0])) {
@@ -444,15 +473,3 @@ function getTimeStamp($dateParts) {
         return getGMTSeconds($stamp, $dateParts[0]);
     }
 }
-
-/* I use this function for profiling. Should never be called in
-   actual versions of squirrelmail released to public. */
-/*
-   function getmicrotime() {
-      $mtime = microtime();
-      $mtime = explode(' ',$mtime);
-      $mtime = $mtime[1] + $mtime[0];
-      return ($mtime);
-   }
-*/
-?>