Getting ready for 1.2.0 release.
[squirrelmail.git] / functions / date.php
index e1d9c388ccaf0016d3497d85995d0204554e66ea..ef3f0fadfd008f1baf43742afed6121cd50cad51 100644 (file)
-<?
-   /**
-    **  date.php
-    **
-    **  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
-    **
-    **/
+<?php
 
-   function getMinutes($hour) {
-      $date = $hour;
-
-      if (($hour == 0) || ($hour == "00"))
-         $date = "00";
-      else if (($hour == 1) || ($hour == "01"))
-         $date = "01";
-      else if (($hour == 2) || ($hour == "02"))
-         $date = "02";
-      else if (($hour == 3) || ($hour == "03"))
-         $date = "03";
-      else if (($hour == 4) || ($hour == "04"))
-         $date = "04";
-      else if (($hour == 5) || ($hour == "05"))
-         $date = "05";
-      else if (($hour == 6) || ($hour == "06"))
-         $date = "06";
-      else if (($hour == 7) || ($hour == "07"))
-         $date = "07";
-      else if (($hour == 8) || ($hour == "08"))
-         $date = "08";
-      else if (($hour == 9) || ($hour == "09"))
-         $date = "09";
-
-      return $date;
-   }
+/**
+ * date.php
+ *
+ * Copyright (c) 1999-2002 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
+ *
+ * $Id$
+ */
 
-   // corrects a time stamp to be the local time
-   function getGMTSeconds($stamp, $gmt) {
-      if (substr($gmt, 0, 1) == "-") {
-         $neg = true;
-         $gmt = substr($gmt, 1, strlen($gmt));
-      } else if (substr($gmt, 0, 1) == "+") {
-         $neg = false;
-         $gmt = substr($gmt, 1, strlen($gmt));
-      } else
-         $neg = false;
-
-      $gmt = substr($gmt, 0, 2);
-      $gmt = $gmt * 3600;
-      if ($neg == true)
-         $gmt = "-$gmt";
-      else
-         $gmt = "+$gmt";
-
-      /** now find what the server is at **/
-      $current = date("Z", time());
-
-      $stamp = (int)$stamp - (int)$gmt + (int)$current;
-
-      return $stamp;
-   }
+require_once( '../functions/constants.php' );
 
-   function getHour($hour) {
-      $time = explode(":", $hour);
-      return $time[0];
-   }
+// corrects a time stamp to be the local time
+function getGMTSeconds($stamp, $gmt) {
+    global $invert_time;
+    if (($gmt == 'Pacific') || ($gmt == 'PST')) {
+        $gmt = '-0800'; 
+    } else if (($gmt == 'EDT')) {
+        $gmt = '-0400';
+    } else if (($gmt == 'Eastern') || ($gmt == 'EST') || ($gmt == 'CDT')) {
+        $gmt = '-0500';
+    } else if (($gmt == 'Central') || ($gmt == 'CST') || ($gmt == 'MDT')) {
+        $gmt = '-0600';
+    } else if (($gmt == 'Mountain') || ($gmt == 'MST') || ($gmt == 'PDT')) {
+        $gmt = '-0700';
+    } else if ($gmt == 'BST') {
+        $gmt = '+0100';
+    } else if ($gmt == 'EET') {
+        $gmt = '+0200';
+    } else if ($gmt == 'GMT') {
+        $gmt = '+0000';
+    } else if ($gmt == 'HKT') {
+        $gmt = '+0800';
+    } else if ($gmt == 'IST') {
+        $gmt = '+0200';
+    } else if ($gmt == 'JST') {
+        $gmt = '+0900';
+    } else if ($gmt == 'KST') {
+        $gmt = "+0900";
+    } else if ($gmt == 'MET') {
+        $gmt = '+0100';
+    } else if ($gmt == 'MET DST' || $gmt == 'METDST') {
+        $gmt = '+0200';
+    }
+    
+    if (substr($gmt, 0, 1) == '-') {
+        $neg = true;
+        $gmt = substr($gmt, 1, strlen($gmt));
+    } else if (substr($gmt, 0, 1) == '+') {
+        $neg = false;
+        $gmt = substr($gmt, 1, strlen($gmt));
+    } else {
+        $neg = false;
+    }
+    
+    $gmt = substr($gmt, 0, 2);
+    $gmt = $gmt * 3600;
+    if ($neg == true) {
+        $gmt = "-$gmt";
+    } else {
+        $gmt = "+$gmt";
+    }
+    
+    /** now find what the server is at **/
+    $current = date('Z', time());
+    if ($invert_time) {
+        $current = - $current;
+    }
+    $stamp = (int)$stamp - (int)$gmt + (int)$current;
+    
+    return $stamp;
+}
 
-   function getMinute($min) {
-      $time = explode(":", $min);
-      return $time[1];
-   }
+/**
+  Switch system has been intentionaly choosed for the
+  internationalization of month and day names. The reason
+  is to make sure that _("") strings will go into the
+  main po.
+**/
 
-   function getSecond($sec) {
-      $time = explode(":", $sec);
-      return $time[2];
-   }
+function getDayName( $day_number ) {
 
-   function getMonthNum($month) {
-      if (eregi("jan|january", $month, $tmp))
-         $date = "01";
-      else if (eregi("feb|february|febuary", $month, $tmp))
-         $date = "02";
-      else if (eregi("mar|march", $month, $tmp))
-         $date = "03";
-      else if (eregi("apr|april", $month, $tmp))
-         $date = "04";
-      else if (eregi("may", $month, $tmp))
-         $date = "05";
-      else if (eregi("jun|june", $month, $tmp))
-         $date = "06";
-      else if (eregi("jul|july", $month, $tmp))
-         $date = "07";
-      else if (eregi("aug|august", $month, $tmp))
-         $date = "08";
-      else if (eregi("sep|sept|september", $month, $tmp))
-         $date = "09";
-      else if (eregi("oct|october", $month, $tmp))
-         $date = "10";
-      else if (eregi("nov|november", $month, $tmp))
-         $date = "11";
-      else if (eregi("dec|december", $month, $tmp))
-         $date = "12";
-
-      return $date;
-   }
+    switch( $day_number ) {
+    case 0:
+        $ret = _("Sunday");
+        break;
+    case 1:
+        $ret = _("Monday");
+        break;
+    case 2:
+        $ret = _("Tuesday");
+        break;
+    case 3:
+        $ret = _("Wednesday");
+        break;
+    case 4:
+        $ret = _("Thursday");
+        break;
+    case 5:
+        $ret = _("Friday");
+        break;
+    case 6:
+        $ret = _("Saturday");
+        break;
+    default:
+        $ret = '';
+    }
+    return( $ret );
+}
 
-   function getDayOfWeek($day) {
-      $date = "{WEEKDAY}";
-
-      if (eregi("(mon|monday)", $day, $tmp))
-         $date = "Mon";
-      else if (eregi("(tue|tuesday)", $day, $tmp))
-         $date = "Tue";
-      else if (eregi("(wed|wednesday)", $day, $tmp))
-         $date = "Wed";
-      else if (eregi("(thurs|thu|thursday)", $day, $tmp))
-         $date = "Thu";
-      else if (eregi("(fri|friday)", $day, $tmp))
-         $date = "Fri";
-      else if (eregi("(sat|saturday)", $day, $tmp))
-         $date = "Sat";
-      else if (eregi("(sun|sunday)", $day, $tmp))
-         $date = "Sun";
-
-      return $date;
-   }
+function getMonthName( $month_number ) {
+    switch( $month_number ) {
+     case '01':
+        $ret = _("January");
+        break;
+     case '02':
+        $ret = _("February");
+        break;
+     case '03':
+        $ret = _("March");
+        break;
+     case '04':
+        $ret = _("April");
+        break;
+     case '05':
+        $ret = _("May");
+        break;
+     case '06':
+        $ret = _("June");
+        break;
+     case '07':
+        $ret = _("July");
+        break;
+     case '08':
+        $ret = _("August");
+        break;
+     case '09':
+        $ret = _("September");
+        break;
+     case '10':
+        $ret = _("October");
+        break;
+     case '11':
+        $ret = _("November");
+        break;
+     case '12':
+        $ret = _("December");
+        break;
+     default:
+        $ret = '';
+    }
+    return( $ret );
+}
 
-   function getDayOfMonth($day) {
-      return ereg_replace("^0", "", $day); /* remove a preceeding 0 */
-   }
+function date_intl( $date_format, $stamp ) {
 
-   function getMonth($month) {
-      $date = "{MONTH}";
-      if (eregi("jan|january", $month, $tmp))
-         $date = "Jan";
-      else if (eregi("feb|february|febuary", $month, $tmp))
-         $date = "Feb";
-      else if (eregi("mar|march", $month, $tmp))
-         $date = "Mar";
-      else if (eregi("apr|april", $month, $tmp))
-         $date = "Apr";
-      else if (eregi("may", $month, $tmp))
-         $date = "May";
-      else if (eregi("jun|june", $month, $tmp))
-         $date = "Jun";
-      else if (eregi("jul|july", $month, $tmp))
-         $date = "Jul";
-      else if (eregi("aug|august", $month, $tmp))
-         $date = "Aug";
-      else if (eregi("sep|sept|september", $month, $tmp))
-         $date = "Sep";
-      else if (eregi("oct|october", $month, $tmp))
-         $date = "Oct";
-      else if (eregi("nov|november", $month, $tmp))
-         $date = "Nov";
-      else if (eregi("dec|december", $month, $tmp))
-         $date = "Dec";
-
-      return $date;
-   }
+    $ret = str_replace( 'D', '$1', $date_format );
+    $ret = str_replace( 'F', '$2', $ret );
+    $ret = date( '$3'. $ret . '$3', $stamp ); // Workaround for a PHP 4.0.4 problem
+    $ret = str_replace( '$1', substr( getDayName( date( 'w', $stamp ) ), 0, 3 ), $ret );
+    $ret = str_replace( '$2', getMonthName( date( 'm', $stamp ) ), $ret );
+    $ret = str_replace( '$3', '', $ret );
+    
+    return( $ret );
+}
 
-   function getYear($year) {
-      return $year;
-   }
+function getLongDateString( $stamp ) {
 
-   function getLongDateString($stamp) {
-      return date("D, F j, Y g:i a", $stamp);
-   }
+    global $hour_format;
+    
+    if ( $hour_format == SMPREF_TIME_12HR ) {
+        $date_format = _("D, F j, Y g:i a");
+    } else {
+        $date_format = _("D, F j, Y G:i");
+    }
+    
+    return( date_intl( $date_format, $stamp ) );
 
-   function getDateString($stamp) {
-      return date("M j, Y", $stamp);
-   }
+}
+
+function getDateString( $stamp ) {
+
+    global $invert_time, $hour_format;
+    
+    $now = time();
+    
+    $dateZ = date('Z', $now );
+    if ($invert_time) {
+        $dateZ = - $dateZ;
+    }
+    $midnight = $now - ($now % 86400) - $dateZ;
+    
+    if ($midnight < $stamp) {
+        /* Today */
+        if ( $hour_format == SMPREF_TIME_12HR ) {
+            $date_format = _("g:i a");
+        } else {
+            $date_format = _("G: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");
+        }
+    } else {
+        /* before this week */
+        $date_format = _("M j, Y");
+    }
+    
+    return( date_intl( $date_format, $stamp ) );
+}
+
+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.
+     *
+     *    The old code used eregi('mon|tue|wed|thu|fri|sat|sun',
+     *    $dateParts[0], $tmp) to find if the first element was the
+     *    day of week or day of month. This is an expensive call
+     *    (processing time) to have inside a loop. Doing it this way
+     *    saves quite a bit of time for large mailboxes.
+     *
+     *    It is also quicker to call explode only once rather than
+     *    the 3 times it was getting called by calling the functions
+     *    getHour, getMinute, and getSecond.
+     */
+
+    if (! isset($dateParts[1])) {
+        $dateParts[1] = '';
+    }
+    if (! isset($dateParts[2])) {
+        $dateParts[2] = '';
+    }
+    if (! isset($dateParts[3])) {
+        $dateParts[3] = '';
+    }
+    if (! isset($dateParts[4])) {
+        $dateParts[4] = '';
+    }
+    if (! isset($dateParts[5])) {
+        $dateParts[5] = '';
+    }
+    if (intval(trim($dateParts[0])) > 0) {
+        $string = $dateParts[0] . ' ' . $dateParts[1] . ' ' .
+                  $dateParts[2] . ' ' . $dateParts[3];
+        return getGMTSeconds(strtotime($string), $dateParts[4]);
+    }
+    $string = $dateParts[0] . ' ' . $dateParts[1] . ' ' .
+            $dateParts[2] . ' ' . $dateParts[3] . ' ' . $dateParts[4];
+    if (isset($dateParts[5])) {
+        return getGMTSeconds(strtotime($string), $dateParts[5]);
+    } else {
+        return getGMTSeconds(strtotime($string), '');
+    }
+}
 
-   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.
-       **/
-
-      if (eregi("mon|tue|wed|thu|fri|sat|sun", $dateParts[0], $tmp)) {
-         $d[0] = getHour(trim($dateParts[4]));
-         $d[1] = getMinute(trim($dateParts[4]));
-         $d[2] = getSecond(trim($dateParts[4]));
-         $d[3] = getMonthNum(trim($dateParts[2]));
-         $d[4] = getDayOfMonth(trim($dateParts[1]));
-         $d[5] = getYear(trim($dateParts[3]));
-         return getGMTSeconds(mktime($d[0], $d[1], $d[2], $d[3], $d[4], $d[5]), $dateParts[5]);
-      }
-      $d[0] = getHour(trim($dateParts[3]));
-      $d[1] = getMinute(trim($dateParts[3]));
-      $d[2] = getSecond(trim($dateParts[3]));
-      $d[3] = getMonthNum(trim($dateParts[1]));
-      $d[4] = getDayOfMonth(trim($dateParts[0]));
-      $d[5] = getYear(trim($dateParts[2]));
-      return getGMTSeconds(mktime($d[0], $d[1], $d[2], $d[3], $d[4], $d[5]), $dateParts[4]);
+/* 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);
    }
+*/
 ?>