updated docs
[squirrelmail.git] / functions / date.php
index 4760d0290a3b0b40d579bc257fa4b2e4057a1a0a..59a10dca4e67860b32f84bf16c314e14789c5c2a 100644 (file)
-<?
+<?php
    /**
     **  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
+    **  (as specified in RFC 822) -- 'Tue' is optional
     **
+    **  $Id$
     **/
 
-   function getHour($hour) {
-      $time = explode(":", $hour);
-      return $time[0];
-   }
-
-   function getMinute($min) {
-      $time = explode(":", $min);
-      return $time[1];
-   }
-
-   function getSecond($sec) {
-      $time = explode(":", $sec);
-      return $time[2];
-   }
-
-   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;
-   }
+   if (defined ('date_php'))
+      return; 
+   define ('date_php', true);
+   
+   // 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;
 
-   function getDayOfWeek($day) {
-      $date = "{WEEKDAY}";
+      $gmt = substr($gmt, 0, 2);
+      $gmt = $gmt * 3600;
+      if ($neg == true)
+         $gmt = "-$gmt";
+      else
+         $gmt = "+$gmt";
 
-      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";
+      /** now find what the server is at **/
+      $current = date('Z', time());
+      if ($invert_time)
+          $current = - $current;
+      $stamp = (int)$stamp - (int)$gmt + (int)$current;
 
-      return $date;
+      return $stamp;
    }
 
-   function getDayOfMonth($day) {
-      return ereg_replace("^0", "", $day); /* remove a preceeding 0 */
+   function getLongDateString($stamp) {
+      return date('D, F j, Y g:i a', $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;
-   }
+   function getDateString($stamp) {
+      global $invert_time;
+      $now = time();
+      $dateZ = date('Z', $now);
+      if ($invert_time)
+          $dateZ = - $dateZ;
+      $midnight = $now - ($now % 86400) - $dateZ;
 
-   function getYear($year) {
-      return $year;
+      if ($midnight < $stamp) {
+         // Today
+         return date('g:i a', $stamp);
+      } else if ($midnight - (60 * 60 * 24 * 6) < $stamp) {
+         // This week
+         return date('D, g:i a', $stamp);
+      } else {
+         // before this week 
+         return date('M j, Y', $stamp);
+      }
    }
 
-   function getDateString($dateParts) {
+   function getTimeStamp($dateParts) {
       /** $dateParts[0] == <day of week>   Mon, Tue, Wed
        ** $dateParts[1] == <day of month>  23
        ** $dateParts[2] == <month>         Jan, Feb, Mar
        **        and everything would be bumped up one.
        **/
 
-      /* if the first part is a day */
-      if (eregi("mon|tue|wed|thu|fri|sat|sun", $dateParts[0], $tmp)) {
-         $dateParts[0] = getDayOfWeek($dateParts[0]);
-         $dateParts[1] = getDayOfMonth($dateParts[1]);
-         $dateParts[2] = getMonth($dateParts[2]);
-         $dateParts[3] = getYear($dateParts[3]);
-         return "$dateParts[2] $dateParts[1], $dateParts[3]";
+      // 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 (intval(trim($dateParts[0])) > 0) {
+         $string = $dateParts[0] . ' ' . $dateParts[1] . ' ' . 
+                   $dateParts[2] . ' ' . $dateParts[3];
+         return getGMTSeconds(strtotime($string), $dateParts[4]);
       }
-      $dateParts[0] = getDayOfMonth($dateParts[0]);
-      $dateParts[1] = getMonth($dateParts[1]);
-      $dateParts[2] = getYear($dateParts[2]);
-      return "$dateParts[1] $dateParts[0], $dateParts[2]";
+      $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) {
-      if (eregi("mon|tue|wed|thu|fri|sat|sun", $dateParts[0], $tmp)) {
-         $d[0] = getHour($dateParts[4]);
-         $d[1] = getMinute($dateParts[4]);
-         $d[2] = getSecond($dateParts[4]);
-         $d[3] = getMonthNum($dateParts[2]);
-         $d[4] = getDayOfMonth($dateParts[1]);
-         $d[5] = getYear($dateParts[3]);
-         return mktime($d[0], $d[1], $d[2], $d[3], $d[4], $d[5]);
-      }
-      $d[0] = getHour($dateParts[3]);
-      $d[1] = getMinute($dateParts[3]);
-      $d[2] = getSecond($dateParts[3]);
-      $d[3] = getMonthNum($dateParts[1]);
-      $d[4] = getDayOfMonth($dateParts[0]);
-      $d[5] = getYear($dateParts[2]);
-      return mktime($d[0], $d[1], $d[2], $d[3], $d[4], $d[5]);
+   // 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);
    }
 ?>