michael@0: /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: const HOURS_TO_MINUTES = 60;
michael@0: const MINUTES_TO_SECONDS = 60;
michael@0: const SECONDS_TO_MILLISECONDS = 1000;
michael@0: const MINUTES_TO_MILLISECONDS = MINUTES_TO_SECONDS * SECONDS_TO_MILLISECONDS;
michael@0: const HOURS_TO_MILLISECONDS = HOURS_TO_MINUTES * MINUTES_TO_MILLISECONDS;
michael@0: 
michael@0: this.EXPORTED_SYMBOLS = ["ISO8601DateUtils"];
michael@0: 
michael@0: debug("*** loading ISO8601DateUtils\n");
michael@0: 
michael@0: this.ISO8601DateUtils = {
michael@0: 
michael@0:   /**
michael@0:   * XXX Thunderbird's W3C-DTF function
michael@0:   *
michael@0:   * Converts a W3C-DTF (subset of ISO 8601) date string to a Javascript
michael@0:   * date object. W3C-DTF is described in this note:
michael@0:   * http://www.w3.org/TR/NOTE-datetime IETF is obtained via the Date
michael@0:   * object's toUTCString() method.  The object's toString() method is
michael@0:   * insufficient because it spells out timezones on Win32
michael@0:   * (f.e. "Pacific Standard Time" instead of "PST"), which Mail doesn't
michael@0:   * grok.  For info, see
michael@0:   * http://lxr.mozilla.org/mozilla/source/js/src/jsdate.c#1526.
michael@0:   */
michael@0:   parse: function ISO8601_parse(aDateString) {
michael@0:     var dateString = aDateString;
michael@0:     if (!dateString.match('-')) {
michael@0:       // Workaround for server sending
michael@0:       // dates such as: 20030530T11:18:50-08:00
michael@0:       // instead of: 2003-05-30T11:18:50-08:00
michael@0:       var year = dateString.slice(0, 4);
michael@0:       var month = dateString.slice(4, 6);
michael@0:       var rest = dateString.slice(6, dateString.length);
michael@0:       dateString = year + "-" + month + "-" + rest;
michael@0:     }
michael@0: 
michael@0:     var parts = dateString.match(/(\d{4})(-(\d{2,3}))?(-(\d{2}))?(T(\d{2}):(\d{2})(:(\d{2})(\.(\d+))?)?(Z|([+-])(\d{2}):(\d{2}))?)?/);
michael@0: 
michael@0:     // Here's an example of a W3C-DTF date string and what .match returns for it.
michael@0:     //
michael@0:     // date: 2003-05-30T11:18:50.345-08:00
michael@0:     // date.match returns array values:
michael@0:     //
michael@0:     //   0: 2003-05-30T11:18:50-08:00,
michael@0:     //   1: 2003,
michael@0:     //   2: -05,
michael@0:     //   3: 05,
michael@0:     //   4: -30,
michael@0:     //   5: 30,
michael@0:     //   6: T11:18:50-08:00,
michael@0:     //   7: 11,
michael@0:     //   8: 18,
michael@0:     //   9: :50,
michael@0:     //   10: 50,
michael@0:     //   11: .345,
michael@0:     //   12: 345,
michael@0:     //   13: -08:00,
michael@0:     //   14: -,
michael@0:     //   15: 08,
michael@0:     //   16: 00
michael@0: 
michael@0:     // Create a Date object from the date parts.  Note that the Date
michael@0:     // object apparently can't deal with empty string parameters in lieu
michael@0:     // of numbers, so optional values (like hours, minutes, seconds, and
michael@0:     // milliseconds) must be forced to be numbers.
michael@0:     var date = new Date(parts[1], parts[3] - 1, parts[5], parts[7] || 0,
michael@0:       parts[8] || 0, parts[10] || 0, parts[12] || 0);
michael@0: 
michael@0:     // We now have a value that the Date object thinks is in the local
michael@0:     // timezone but which actually represents the date/time in the
michael@0:     // remote timezone (f.e. the value was "10:00 EST", and we have
michael@0:     // converted it to "10:00 PST" instead of "07:00 PST").  We need to
michael@0:     // correct that.  To do so, we're going to add the offset between
michael@0:     // the remote timezone and UTC (to convert the value to UTC), then
michael@0:     // add the offset between UTC and the local timezone //(to convert
michael@0:     // the value to the local timezone).
michael@0: 
michael@0:     // Ironically, W3C-DTF gives us the offset between UTC and the
michael@0:     // remote timezone rather than the other way around, while the
michael@0:     // getTimezoneOffset() method of a Date object gives us the offset
michael@0:     // between the local timezone and UTC rather than the other way
michael@0:     // around.  Both of these are the additive inverse (i.e. -x for x)
michael@0:     // of what we want, so we have to invert them to use them by
michael@0:     // multipying by -1 (f.e. if "the offset between UTC and the remote
michael@0:     // timezone" is -5 hours, then "the offset between the remote
michael@0:     // timezone and UTC" is -5*-1 = 5 hours).
michael@0: 
michael@0:     // Note that if the timezone portion of the date/time string is
michael@0:     // absent (which violates W3C-DTF, although ISO 8601 allows it), we
michael@0:     // assume the value to be in UTC.
michael@0: 
michael@0:     // The offset between the remote timezone and UTC in milliseconds.
michael@0:     var remoteToUTCOffset = 0;
michael@0:     if (parts[13] && parts[13] != "Z") {
michael@0:       var direction = (parts[14] == "+" ? 1 : -1);
michael@0:       if (parts[15])
michael@0:         remoteToUTCOffset += direction * parts[15] * HOURS_TO_MILLISECONDS;
michael@0:       if (parts[16])
michael@0:         remoteToUTCOffset += direction * parts[16] * MINUTES_TO_MILLISECONDS;
michael@0:     }
michael@0:     remoteToUTCOffset = remoteToUTCOffset * -1; // invert it
michael@0: 
michael@0:     // The offset between UTC and the local timezone in milliseconds.
michael@0:     var UTCToLocalOffset = date.getTimezoneOffset() * MINUTES_TO_MILLISECONDS;
michael@0:     UTCToLocalOffset = UTCToLocalOffset * -1; // invert it
michael@0:     date.setTime(date.getTime() + remoteToUTCOffset + UTCToLocalOffset);
michael@0: 
michael@0:     return date;
michael@0:   },
michael@0: 
michael@0:   create: function ISO8601_create(aDate) {
michael@0:     function zeropad (s, l) {
michael@0:       s = s.toString(); // force it to a string
michael@0:       while (s.length < l) {
michael@0:         s = '0' + s;
michael@0:       }
michael@0:       return s;
michael@0:     }
michael@0: 
michael@0:     var myDate;
michael@0:     // if d is a number, turn it into a date
michael@0:     if (typeof aDate == 'number') {
michael@0:       myDate = new Date()
michael@0:       myDate.setTime(aDate);
michael@0:     } else {
michael@0:       myDate = aDate;
michael@0:     }
michael@0: 
michael@0:     // YYYY-MM-DDThh:mm:ssZ
michael@0:     var result = zeropad(myDate.getUTCFullYear (), 4) +
michael@0:                  zeropad(myDate.getUTCMonth () + 1, 2) +
michael@0:                  zeropad(myDate.getUTCDate (), 2) + 'T' +
michael@0:                  zeropad(myDate.getUTCHours (), 2) + ':' +
michael@0:                  zeropad(myDate.getUTCMinutes (), 2) + ':' +
michael@0:                  zeropad(myDate.getUTCSeconds (), 2) + 'Z';
michael@0: 
michael@0:     return result;
michael@0:   }
michael@0: }