date.js (38294B)
1 // ----- 2 // The `timezoneJS.Date` object gives you full-blown timezone support, independent from the timezone set on the end-user's machine running the browser. It uses the Olson zoneinfo files for its timezone data. 3 // 4 // The constructor function and setter methods use proxy JavaScript Date objects behind the scenes, so you can use strings like '10/22/2006' with the constructor. You also get the same sensible wraparound behavior with numeric parameters (like setting a value of 14 for the month wraps around to the next March). 5 // 6 // The other significant difference from the built-in JavaScript Date is that `timezoneJS.Date` also has named properties that store the values of year, month, date, etc., so it can be directly serialized to JSON and used for data transfer. 7 8 /* 9 * Copyright 2010 Matthew Eernisse (mde@fleegix.org) 10 * and Open Source Applications Foundation 11 * 12 * Licensed under the Apache License, Version 2.0 (the "License"); 13 * you may not use this file except in compliance with the License. 14 * You may obtain a copy of the License at 15 * 16 * http://www.apache.org/licenses/LICENSE-2.0 17 * 18 * Unless required by applicable law or agreed to in writing, software 19 * distributed under the License is distributed on an "AS IS" BASIS, 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 21 * See the License for the specific language governing permissions and 22 * limitations under the License. 23 * 24 * Credits: Ideas included from incomplete JS implementation of Olson 25 * parser, "XMLDAte" by Philippe Goetz (philippe.goetz@wanadoo.fr) 26 * 27 * Contributions: 28 * Jan Niehusmann 29 * Ricky Romero 30 * Preston Hunt (prestonhunt@gmail.com) 31 * Dov. B Katz (dov.katz@morganstanley.com) 32 * Peter Bergström (pbergstr@mac.com) 33 * Long Ho 34 */ 35 (function () { 36 // Standard initialization stuff to make sure the library is 37 // usable on both client and server (node) side. 38 39 var root = this; 40 41 var timezoneJS; 42 if (typeof exports !== 'undefined') { 43 timezoneJS = exports; 44 } else { 45 timezoneJS = root.timezoneJS = {}; 46 } 47 48 timezoneJS.VERSION = '1.0.0'; 49 50 // Grab the ajax library from global context. 51 // This can be jQuery, Zepto or fleegix. 52 // You can also specify your own transport mechanism by declaring 53 // `timezoneJS.timezone.transport` to a `function`. More details will follow 54 var $ = root.$ || root.jQuery || root.Zepto 55 , fleegix = root.fleegix 56 // Declare constant list of days and months. Unfortunately this doesn't leave room for i18n due to the Olson data being in English itself 57 , DAYS = timezoneJS.Days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'] 58 , MONTHS = timezoneJS.Months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'] 59 , SHORT_MONTHS = {} 60 , SHORT_DAYS = {} 61 , EXACT_DATE_TIME = {} 62 , TZ_REGEXP = new RegExp('^[a-zA-Z]+/'); 63 64 //`{ "Jan": 0, "Feb": 1, "Mar": 2, "Apr": 3, "May": 4, "Jun": 5, "Jul": 6, "Aug": 7, "Sep": 8, "Oct": 9, "Nov": 10, "Dec": 11 }` 65 for (var i = 0; i < MONTHS.length; i++) { 66 SHORT_MONTHS[MONTHS[i].substr(0, 3)] = i; 67 } 68 69 //`{ "Sun": 0, "Mon": 1, "Tue": 2, "Wed": 3, "Thu": 4, "Fri": 5, "Sat": 6 }` 70 for (i = 0; i < DAYS.length; i++) { 71 SHORT_DAYS[DAYS[i].substr(0, 3)] = i; 72 } 73 74 75 //Handle array indexOf in IE 76 if (!Array.prototype.indexOf) { 77 Array.prototype.indexOf = function (el) { 78 for (var i = 0; i < this.length; i++ ) { 79 if (el === this[i]) return i; 80 } 81 return -1; 82 } 83 } 84 85 // Format a number to the length = digits. For ex: 86 // 87 // `_fixWidth(2, 2) = '02'` 88 // 89 // `_fixWidth(1998, 2) = '98'` 90 // 91 // This is used to pad numbers in converting date to string in ISO standard. 92 var _fixWidth = function (number, digits) { 93 if (typeof number !== "number") { throw "not a number: " + number; } 94 var s = number.toString(); 95 if (number.length > digits) { 96 return number.substr(number.length - digits, number.length); 97 } 98 while (s.length < digits) { 99 s = '0' + s; 100 } 101 return s; 102 }; 103 104 // Abstraction layer for different transport layers, including fleegix/jQuery/Zepto 105 // 106 // Object `opts` include 107 // 108 // - `url`: url to ajax query 109 // 110 // - `async`: true for asynchronous, false otherwise. If false, return value will be response from URL. This is true by default 111 // 112 // - `success`: success callback function 113 // 114 // - `error`: error callback function 115 // Returns response from URL if async is false, otherwise the AJAX request object itself 116 var _transport = function (opts) { 117 if ((!fleegix || typeof fleegix.xhr === 'undefined') && (!$ || typeof $.ajax === 'undefined')) { 118 throw new Error('Please use the Fleegix.js XHR module, jQuery ajax, Zepto ajax, or define your own transport mechanism for downloading zone files.'); 119 } 120 if (!opts) return; 121 if (!opts.url) throw new Error ('URL must be specified'); 122 if (!('async' in opts)) opts.async = true; 123 if (!opts.async) { 124 return fleegix && fleegix.xhr 125 ? fleegix.xhr.doReq({ url: opts.url, async: false }) 126 : $.ajax({ url : opts.url, async : false }).responseText; 127 } 128 return fleegix && fleegix.xhr 129 ? fleegix.xhr.send({ 130 url : opts.url, 131 method : 'get', 132 handleSuccess : opts.success, 133 handleErr : opts.error 134 }) 135 : $.ajax({ 136 url : opts.url, 137 dataType: 'text', 138 method : 'GET', 139 error : opts.error, 140 success : opts.success 141 }); 142 }; 143 144 // Constructor, which is similar to that of the native Date object itself 145 timezoneJS.Date = function () { 146 var args = Array.prototype.slice.apply(arguments) 147 , dt = null 148 , tz = null 149 , arr = []; 150 151 152 //We support several different constructors, including all the ones from `Date` object 153 // with a timezone string at the end. 154 // 155 //- `[tz]`: Returns object with time in `tz` specified. 156 // 157 // - `utcMillis`, `[tz]`: Return object with UTC time = `utcMillis`, in `tz`. 158 // 159 // - `Date`, `[tz]`: Returns object with UTC time = `Date.getTime()`, in `tz`. 160 // 161 // - `year, month, [date,] [hours,] [minutes,] [seconds,] [millis,] [tz]: Same as `Date` object 162 // with tz. 163 // 164 // - `Array`: Can be any combo of the above. 165 // 166 //If 1st argument is an array, we can use it as a list of arguments itself 167 if (Object.prototype.toString.call(args[0]) === '[object Array]') { 168 args = args[0]; 169 } 170 if (typeof args[args.length - 1] === 'string' && TZ_REGEXP.test(args[args.length - 1])) { 171 tz = args.pop(); 172 } 173 switch (args.length) { 174 case 0: 175 dt = new Date(); 176 break; 177 case 1: 178 dt = new Date(args[0]); 179 break; 180 default: 181 for (var i = 0; i < 7; i++) { 182 arr[i] = args[i] || 0; 183 } 184 dt = new Date(arr[0], arr[1], arr[2], arr[3], arr[4], arr[5], arr[6]); 185 break; 186 } 187 188 this._useCache = false; 189 this._tzInfo = {}; 190 this._day = 0; 191 this.year = 0; 192 this.month = 0; 193 this.date = 0; 194 this.hours = 0; 195 this.minutes = 0; 196 this.seconds = 0; 197 this.milliseconds = 0; 198 this.timezone = tz || null; 199 //Tricky part: 200 // For the cases where there are 1/2 arguments: `timezoneJS.Date(millis, [tz])` and `timezoneJS.Date(Date, [tz])`. The 201 // Date `dt` created should be in UTC. Thus the way I detect such cases is to determine if `arr` is not populated & `tz` 202 // is specified. Because if `tz` is not specified, `dt` can be in local time. 203 if (arr.length) { 204 this.setFromDateObjProxy(dt); 205 } else { 206 this.setFromTimeProxy(dt.getTime(), tz); 207 } 208 }; 209 210 // Implements most of the native Date object 211 timezoneJS.Date.prototype = { 212 getDate: function () { return this.date; }, 213 getDay: function () { return this._day; }, 214 getFullYear: function () { return this.year; }, 215 getMonth: function () { return this.month; }, 216 getYear: function () { return this.year; }, 217 getHours: function () { return this.hours; }, 218 getMilliseconds: function () { return this.milliseconds; }, 219 getMinutes: function () { return this.minutes; }, 220 getSeconds: function () { return this.seconds; }, 221 getUTCDate: function () { return this.getUTCDateProxy().getUTCDate(); }, 222 getUTCDay: function () { return this.getUTCDateProxy().getUTCDay(); }, 223 getUTCFullYear: function () { return this.getUTCDateProxy().getUTCFullYear(); }, 224 getUTCHours: function () { return this.getUTCDateProxy().getUTCHours(); }, 225 getUTCMilliseconds: function () { return this.getUTCDateProxy().getUTCMilliseconds(); }, 226 getUTCMinutes: function () { return this.getUTCDateProxy().getUTCMinutes(); }, 227 getUTCMonth: function () { return this.getUTCDateProxy().getUTCMonth(); }, 228 getUTCSeconds: function () { return this.getUTCDateProxy().getUTCSeconds(); }, 229 // Time adjusted to user-specified timezone 230 getTime: function () { 231 return this._timeProxy + (this.getTimezoneOffset() * 60 * 1000); 232 }, 233 getTimezone: function () { return this.timezone; }, 234 getTimezoneOffset: function () { return this.getTimezoneInfo().tzOffset; }, 235 getTimezoneAbbreviation: function () { return this.getTimezoneInfo().tzAbbr; }, 236 getTimezoneInfo: function () { 237 if (this._useCache) return this._tzInfo; 238 var res; 239 // If timezone is specified, get the correct timezone info based on the Date given 240 if (this.timezone) { 241 res = this.timezone === 'Etc/UTC' || this.timezone === 'Etc/GMT' 242 ? { tzOffset: 0, tzAbbr: 'UTC' } 243 : timezoneJS.timezone.getTzInfo(this._timeProxy, this.timezone); 244 } 245 // If no timezone was specified, use the local browser offset 246 else { 247 res = { tzOffset: this.getLocalOffset(), tzAbbr: null }; 248 } 249 this._tzInfo = res; 250 this._useCache = true; 251 return res 252 }, 253 getUTCDateProxy: function () { 254 var dt = new Date(this._timeProxy); 255 dt.setUTCMinutes(dt.getUTCMinutes() + this.getTimezoneOffset()); 256 return dt; 257 }, 258 setDate: function (n) { this.setAttribute('date', n); }, 259 setFullYear: function (n) { this.setAttribute('year', n); }, 260 setMonth: function (n) { this.setAttribute('month', n); }, 261 setYear: function (n) { this.setUTCAttribute('year', n); }, 262 setHours: function (n) { this.setAttribute('hours', n); }, 263 setMilliseconds: function (n) { this.setAttribute('milliseconds', n); }, 264 setMinutes: function (n) { this.setAttribute('minutes', n); }, 265 setSeconds: function (n) { this.setAttribute('seconds', n); }, 266 setTime: function (n) { 267 if (isNaN(n)) { throw new Error('Units must be a number.'); } 268 this.setFromTimeProxy(n, this.timezone); 269 }, 270 setUTCDate: function (n) { this.setUTCAttribute('date', n); }, 271 setUTCFullYear: function (n) { this.setUTCAttribute('year', n); }, 272 setUTCHours: function (n) { this.setUTCAttribute('hours', n); }, 273 setUTCMilliseconds: function (n) { this.setUTCAttribute('milliseconds', n); }, 274 setUTCMinutes: function (n) { this.setUTCAttribute('minutes', n); }, 275 setUTCMonth: function (n) { this.setUTCAttribute('month', n); }, 276 setUTCSeconds: function (n) { this.setUTCAttribute('seconds', n); }, 277 setFromDateObjProxy: function (dt) { 278 this.year = dt.getFullYear(); 279 this.month = dt.getMonth(); 280 this.date = dt.getDate(); 281 this.hours = dt.getHours(); 282 this.minutes = dt.getMinutes(); 283 this.seconds = dt.getSeconds(); 284 this.milliseconds = dt.getMilliseconds(); 285 this._day = dt.getDay(); 286 this._dateProxy = dt; 287 this._timeProxy = Date.UTC(this.year, this.month, this.date, this.hours, this.minutes, this.seconds, this.milliseconds); 288 this._useCache = false; 289 }, 290 setFromTimeProxy: function (utcMillis, tz) { 291 var dt = new Date(utcMillis); 292 var tzOffset; 293 tzOffset = tz ? timezoneJS.timezone.getTzInfo(dt, tz).tzOffset : dt.getTimezoneOffset(); 294 dt.setTime(utcMillis + (dt.getTimezoneOffset() - tzOffset) * 60000); 295 this.setFromDateObjProxy(dt); 296 }, 297 setAttribute: function (unit, n) { 298 if (isNaN(n)) { throw new Error('Units must be a number.'); } 299 var dt = this._dateProxy; 300 var meth = unit === 'year' ? 'FullYear' : unit.substr(0, 1).toUpperCase() + unit.substr(1); 301 dt['set' + meth](n); 302 this.setFromDateObjProxy(dt); 303 }, 304 setUTCAttribute: function (unit, n) { 305 if (isNaN(n)) { throw new Error('Units must be a number.'); } 306 var meth = unit === 'year' ? 'FullYear' : unit.substr(0, 1).toUpperCase() + unit.substr(1); 307 var dt = this.getUTCDateProxy(); 308 dt['setUTC' + meth](n); 309 dt.setUTCMinutes(dt.getUTCMinutes() - this.getTimezoneOffset()); 310 this.setFromTimeProxy(dt.getTime() + this.getTimezoneOffset() * 60000, this.timezone); 311 }, 312 setTimezone: function (tz) { 313 var previousOffset = this.getTimezoneInfo().tzOffset; 314 this.timezone = tz; 315 this._useCache = false; 316 // Set UTC minutes offsets by the delta of the two timezones 317 this.setUTCMinutes(this.getUTCMinutes() - this.getTimezoneInfo().tzOffset + previousOffset); 318 }, 319 removeTimezone: function () { 320 this.timezone = null; 321 this._useCache = false; 322 }, 323 valueOf: function () { return this.getTime(); }, 324 clone: function () { 325 return this.timezone ? new timezoneJS.Date(this.getTime(), this.timezone) : new timezoneJS.Date(this.getTime()); 326 }, 327 toGMTString: function () { return this.toString('EEE, dd MMM yyyy HH:mm:ss Z', 'Etc/GMT'); }, 328 toLocaleString: function () {}, 329 toLocaleDateString: function () {}, 330 toLocaleTimeString: function () {}, 331 toSource: function () {}, 332 toISOString: function () { return this.toString('yyyy-MM-ddTHH:mm:ss.SSS', 'Etc/UTC') + 'Z'; }, 333 toJSON: function () { return this.toISOString(); }, 334 // Allows different format following ISO8601 format: 335 toString: function (format, tz) { 336 // Default format is the same as toISOString 337 if (!format) format = 'yyyy-MM-dd HH:mm:ss'; 338 var result = format; 339 var tzInfo = tz ? timezoneJS.timezone.getTzInfo(this.getTime(), tz) : this.getTimezoneInfo(); 340 var _this = this; 341 // If timezone is specified, get a clone of the current Date object and modify it 342 if (tz) { 343 _this = this.clone(); 344 _this.setTimezone(tz); 345 } 346 var hours = _this.getHours(); 347 return result 348 // fix the same characters in Month names 349 .replace(/a+/g, function () { return 'k'; }) 350 // `y`: year 351 .replace(/y+/g, function (token) { return _fixWidth(_this.getFullYear(), token.length); }) 352 // `d`: date 353 .replace(/d+/g, function (token) { return _fixWidth(_this.getDate(), token.length); }) 354 // `m`: minute 355 .replace(/m+/g, function (token) { return _fixWidth(_this.getMinutes(), token.length); }) 356 // `s`: second 357 .replace(/s+/g, function (token) { return _fixWidth(_this.getSeconds(), token.length); }) 358 // `S`: millisecond 359 .replace(/S+/g, function (token) { return _fixWidth(_this.getMilliseconds(), token.length); }) 360 // `M`: month. Note: `MM` will be the numeric representation (e.g February is 02) but `MMM` will be text representation (e.g February is Feb) 361 .replace(/M+/g, function (token) { 362 var _month = _this.getMonth(), 363 _len = token.length; 364 if (_len > 3) { 365 return timezoneJS.Months[_month]; 366 } else if (_len > 2) { 367 return timezoneJS.Months[_month].substring(0, _len); 368 } 369 return _fixWidth(_month + 1, _len); 370 }) 371 // `k`: AM/PM 372 .replace(/k+/g, function () { 373 if (hours >= 12) { 374 if (hours > 12) { 375 hours -= 12; 376 } 377 return 'PM'; 378 } 379 return 'AM'; 380 }) 381 // `H`: hour 382 .replace(/H+/g, function (token) { return _fixWidth(hours, token.length); }) 383 // `E`: day 384 .replace(/E+/g, function (token) { return DAYS[_this.getDay()].substring(0, token.length); }) 385 // `Z`: timezone abbreviation 386 .replace(/Z+/gi, function () { return tzInfo.tzAbbr; }); 387 }, 388 toUTCString: function () { return this.toGMTString(); }, 389 civilToJulianDayNumber: function (y, m, d) { 390 var a; 391 // Adjust for zero-based JS-style array 392 m++; 393 if (m > 12) { 394 a = parseInt(m/12, 10); 395 m = m % 12; 396 y += a; 397 } 398 if (m <= 2) { 399 y -= 1; 400 m += 12; 401 } 402 a = Math.floor(y / 100); 403 var b = 2 - a + Math.floor(a / 4) 404 , jDt = Math.floor(365.25 * (y + 4716)) + Math.floor(30.6001 * (m + 1)) + d + b - 1524; 405 return jDt; 406 }, 407 getLocalOffset: function () { 408 return this._dateProxy.getTimezoneOffset(); 409 } 410 }; 411 412 413 timezoneJS.timezone = new function () { 414 var _this = this 415 , regionMap = {'Etc':'etcetera','EST':'northamerica','MST':'northamerica','HST':'northamerica','EST5EDT':'northamerica','CST6CDT':'northamerica','MST7MDT':'northamerica','PST8PDT':'northamerica','America':'northamerica','Pacific':'australasia','Atlantic':'europe','Africa':'africa','Indian':'africa','Antarctica':'antarctica','Asia':'asia','Australia':'australasia','Europe':'europe','WET':'europe','CET':'europe','MET':'europe','EET':'europe'} 416 , regionExceptions = {'Pacific/Honolulu':'northamerica','Atlantic/Bermuda':'northamerica','Atlantic/Cape_Verde':'africa','Atlantic/St_Helena':'africa','Indian/Kerguelen':'antarctica','Indian/Chagos':'asia','Indian/Maldives':'asia','Indian/Christmas':'australasia','Indian/Cocos':'australasia','America/Danmarkshavn':'europe','America/Scoresbysund':'europe','America/Godthab':'europe','America/Thule':'europe','Asia/Yekaterinburg':'europe','Asia/Omsk':'europe','Asia/Novosibirsk':'europe','Asia/Krasnoyarsk':'europe','Asia/Irkutsk':'europe','Asia/Yakutsk':'europe','Asia/Vladivostok':'europe','Asia/Sakhalin':'europe','Asia/Magadan':'europe','Asia/Kamchatka':'europe','Asia/Anadyr':'europe','Africa/Ceuta':'europe','America/Argentina/Buenos_Aires':'southamerica','America/Argentina/Cordoba':'southamerica','America/Argentina/Tucuman':'southamerica','America/Argentina/La_Rioja':'southamerica','America/Argentina/San_Juan':'southamerica','America/Argentina/Jujuy':'southamerica','America/Argentina/Catamarca':'southamerica','America/Argentina/Mendoza':'southamerica','America/Argentina/Rio_Gallegos':'southamerica','America/Argentina/Ushuaia':'southamerica','America/Aruba':'southamerica','America/La_Paz':'southamerica','America/Noronha':'southamerica','America/Belem':'southamerica','America/Fortaleza':'southamerica','America/Recife':'southamerica','America/Araguaina':'southamerica','America/Maceio':'southamerica','America/Bahia':'southamerica','America/Sao_Paulo':'southamerica','America/Campo_Grande':'southamerica','America/Cuiaba':'southamerica','America/Porto_Velho':'southamerica','America/Boa_Vista':'southamerica','America/Manaus':'southamerica','America/Eirunepe':'southamerica','America/Rio_Branco':'southamerica','America/Santiago':'southamerica','Pacific/Easter':'southamerica','America/Bogota':'southamerica','America/Curacao':'southamerica','America/Guayaquil':'southamerica','Pacific/Galapagos':'southamerica','Atlantic/Stanley':'southamerica','America/Cayenne':'southamerica','America/Guyana':'southamerica','America/Asuncion':'southamerica','America/Lima':'southamerica','Atlantic/South_Georgia':'southamerica','America/Paramaribo':'southamerica','America/Port_of_Spain':'southamerica','America/Montevideo':'southamerica','America/Caracas':'southamerica'}; 417 function invalidTZError(t) { throw new Error('Timezone "' + t + '" is either incorrect, or not loaded in the timezone registry.'); } 418 function builtInLoadZoneFile(fileName, opts) { 419 var url = _this.zoneFileBasePath + '/' + fileName; 420 return !opts || !opts.async 421 ? _this.parseZones(_this.transport({ url : url, async : false })) 422 : _this.transport({ 423 async: true, 424 url : url, 425 success : function (str) { 426 if (_this.parseZones(str) && typeof opts.callback === 'function') { 427 opts.callback(); 428 } 429 return true; 430 }, 431 error : function () { 432 throw new Error('Error retrieving "' + url + '" zoneinfo files'); 433 } 434 }); 435 } 436 function getRegionForTimezone(tz) { 437 var exc = regionExceptions[tz] 438 , reg 439 , ret; 440 if (exc) return exc; 441 reg = tz.split('/')[0]; 442 ret = regionMap[reg]; 443 // If there's nothing listed in the main regions for this TZ, check the 'backward' links 444 if (ret) return ret; 445 var link = _this.zones[tz]; 446 if (typeof link === 'string') { 447 return getRegionForTimezone(link); 448 } 449 // Backward-compat file hasn't loaded yet, try looking in there 450 if (!_this.loadedZones.backward) { 451 // This is for obvious legacy zones (e.g., Iceland) that don't even have a prefix like "America/" that look like normal zones 452 _this.loadZoneFile('backward'); 453 return getRegionForTimezone(tz); 454 } 455 invalidTZError(tz); 456 } 457 function parseTimeString(str) { 458 var pat = /(\d+)(?::0*(\d*))?(?::0*(\d*))?([wsugz])?$/; 459 var hms = str.match(pat); 460 hms[1] = parseInt(hms[1], 10); 461 hms[2] = hms[2] ? parseInt(hms[2], 10) : 0; 462 hms[3] = hms[3] ? parseInt(hms[3], 10) : 0; 463 464 return hms; 465 } 466 function processZone(z) { 467 if (!z[3]) { return; } 468 var yea = parseInt(z[3], 10); 469 var mon = 11; 470 var dat = 31; 471 if (z[4]) { 472 mon = SHORT_MONTHS[z[4].substr(0, 3)]; 473 dat = parseInt(z[5], 10) || 1; 474 } 475 var string = z[6] ? z[6] : '00:00:00' 476 , t = parseTimeString(string); 477 return [yea, mon, dat, t[1], t[2], t[3]]; 478 } 479 function getZone(dt, tz) { 480 var utcMillis = typeof dt === 'number' ? dt : new Date(dt).getTime(); 481 var t = tz; 482 var zoneList = _this.zones[t]; 483 // Follow links to get to an actual zone 484 while (typeof zoneList === "string") { 485 t = zoneList; 486 zoneList = _this.zones[t]; 487 } 488 if (!zoneList) { 489 // Backward-compat file hasn't loaded yet, try looking in there 490 if (!_this.loadedZones.backward) { 491 //This is for backward entries like "America/Fort_Wayne" that 492 // getRegionForTimezone *thinks* it has a region file and zone 493 // for (e.g., America => 'northamerica'), but in reality it's a 494 // legacy zone we need the backward file for. 495 _this.loadZoneFile('backward'); 496 return getZone(dt, tz); 497 } 498 invalidTZError(t); 499 } 500 if (zoneList.length === 0) { 501 throw new Error('No Zone found for "' + tz + '" on ' + dt); 502 } 503 //Do backwards lookup since most use cases deal with newer dates. 504 for (var i = zoneList.length - 1; i >= 0; i--) { 505 var z = zoneList[i]; 506 if (z[3] && utcMillis > z[3]) break; 507 } 508 return zoneList[i+1]; 509 } 510 function getBasicOffset(time) { 511 var off = parseTimeString(time) 512 , adj = time.indexOf('-') === 0 ? -1 : 1; 513 off = adj * (((off[1] * 60 + off[2]) * 60 + off[3]) * 1000); 514 return off/60/1000; 515 } 516 517 //if isUTC is true, date is given in UTC, otherwise it's given 518 // in local time (ie. date.getUTC*() returns local time components) 519 function getRule(dt, zone, isUTC) { 520 var date = typeof dt === 'number' ? new Date(dt) : dt; 521 var ruleset = zone[1]; 522 var basicOffset = zone[0]; 523 524 //Convert a date to UTC. Depending on the 'type' parameter, the date 525 // parameter may be: 526 // 527 // - `u`, `g`, `z`: already UTC (no adjustment). 528 // 529 // - `s`: standard time (adjust for time zone offset but not for DST) 530 // 531 // - `w`: wall clock time (adjust for both time zone and DST offset). 532 // 533 // DST adjustment is done using the rule given as third argument. 534 var convertDateToUTC = function (date, type, rule) { 535 var offset = 0; 536 537 if (type === 'u' || type === 'g' || type === 'z') { // UTC 538 offset = 0; 539 } else if (type === 's') { // Standard Time 540 offset = basicOffset; 541 } else if (type === 'w' || !type) { // Wall Clock Time 542 offset = getAdjustedOffset(basicOffset, rule); 543 } else { 544 throw("unknown type " + type); 545 } 546 offset *= 60 * 1000; // to millis 547 548 return new Date(date.getTime() + offset); 549 }; 550 551 //Step 1: Find applicable rules for this year. 552 // 553 //Step 2: Sort the rules by effective date. 554 // 555 //Step 3: Check requested date to see if a rule has yet taken effect this year. If not, 556 // 557 //Step 4: Get the rules for the previous year. If there isn't an applicable rule for last year, then 558 // there probably is no current time offset since they seem to explicitly turn off the offset 559 // when someone stops observing DST. 560 // 561 // FIXME if this is not the case and we'll walk all the way back (ugh). 562 // 563 //Step 5: Sort the rules by effective date. 564 //Step 6: Apply the most recent rule before the current time. 565 var convertRuleToExactDateAndTime = function (yearAndRule, prevRule) { 566 var year = yearAndRule[0] 567 , rule = yearAndRule[1]; 568 // Assume that the rule applies to the year of the given date. 569 570 var hms = rule[5]; 571 var effectiveDate; 572 573 if (!EXACT_DATE_TIME[year]) 574 EXACT_DATE_TIME[year] = {}; 575 576 // Result for given parameters is already stored 577 if (EXACT_DATE_TIME[year][rule]) 578 effectiveDate = EXACT_DATE_TIME[year][rule]; 579 else { 580 //If we have a specific date, use that! 581 if (!isNaN(rule[4])) { 582 effectiveDate = new Date(Date.UTC(year, SHORT_MONTHS[rule[3]], rule[4], hms[1], hms[2], hms[3], 0)); 583 } 584 //Let's hunt for the date. 585 else { 586 var targetDay 587 , operator; 588 //Example: `lastThu` 589 if (rule[4].substr(0, 4) === "last") { 590 // Start at the last day of the month and work backward. 591 effectiveDate = new Date(Date.UTC(year, SHORT_MONTHS[rule[3]] + 1, 1, hms[1] - 24, hms[2], hms[3], 0)); 592 targetDay = SHORT_DAYS[rule[4].substr(4, 3)]; 593 operator = "<="; 594 } 595 //Example: `Sun>=15` 596 else { 597 //Start at the specified date. 598 effectiveDate = new Date(Date.UTC(year, SHORT_MONTHS[rule[3]], rule[4].substr(5), hms[1], hms[2], hms[3], 0)); 599 targetDay = SHORT_DAYS[rule[4].substr(0, 3)]; 600 operator = rule[4].substr(3, 2); 601 } 602 var ourDay = effectiveDate.getUTCDay(); 603 //Go forwards. 604 if (operator === ">=") { 605 effectiveDate.setUTCDate(effectiveDate.getUTCDate() + (targetDay - ourDay + ((targetDay < ourDay) ? 7 : 0))); 606 } 607 //Go backwards. Looking for the last of a certain day, or operator is "<=" (less likely). 608 else { 609 effectiveDate.setUTCDate(effectiveDate.getUTCDate() + (targetDay - ourDay - ((targetDay > ourDay) ? 7 : 0))); 610 } 611 } 612 EXACT_DATE_TIME[year][rule] = effectiveDate; 613 } 614 615 616 //If previous rule is given, correct for the fact that the starting time of the current 617 // rule may be specified in local time. 618 if (prevRule) { 619 effectiveDate = convertDateToUTC(effectiveDate, hms[4], prevRule); 620 } 621 return effectiveDate; 622 }; 623 624 var findApplicableRules = function (year, ruleset) { 625 var applicableRules = []; 626 for (var i = 0; ruleset && i < ruleset.length; i++) { 627 //Exclude future rules. 628 if (ruleset[i][0] <= year && 629 ( 630 // Date is in a set range. 631 ruleset[i][1] >= year || 632 // Date is in an "only" year. 633 (ruleset[i][0] === year && ruleset[i][1] === "only") || 634 //We're in a range from the start year to infinity. 635 ruleset[i][1] === "max" 636 ) 637 ) { 638 //It's completely okay to have any number of matches here. 639 // Normally we should only see two, but that doesn't preclude other numbers of matches. 640 // These matches are applicable to this year. 641 applicableRules.push([year, ruleset[i]]); 642 } 643 } 644 return applicableRules; 645 }; 646 647 var compareDates = function (a, b, prev) { 648 var year, rule; 649 if (a.constructor !== Date) { 650 year = a[0]; 651 rule = a[1]; 652 a = (!prev && EXACT_DATE_TIME[year] && EXACT_DATE_TIME[year][rule]) 653 ? EXACT_DATE_TIME[year][rule] 654 : convertRuleToExactDateAndTime(a, prev); 655 } else if (prev) { 656 a = convertDateToUTC(a, isUTC ? 'u' : 'w', prev); 657 } 658 if (b.constructor !== Date) { 659 year = b[0]; 660 rule = b[1]; 661 b = (!prev && EXACT_DATE_TIME[year] && EXACT_DATE_TIME[year][rule]) ? EXACT_DATE_TIME[year][rule] 662 : convertRuleToExactDateAndTime(b, prev); 663 } else if (prev) { 664 b = convertDateToUTC(b, isUTC ? 'u' : 'w', prev); 665 } 666 a = Number(a); 667 b = Number(b); 668 return a - b; 669 }; 670 671 var year = date.getUTCFullYear(); 672 var applicableRules; 673 674 applicableRules = findApplicableRules(year, _this.rules[ruleset]); 675 applicableRules.push(date); 676 //While sorting, the time zone in which the rule starting time is specified 677 // is ignored. This is ok as long as the timespan between two DST changes is 678 // larger than the DST offset, which is probably always true. 679 // As the given date may indeed be close to a DST change, it may get sorted 680 // to a wrong position (off by one), which is corrected below. 681 applicableRules.sort(compareDates); 682 683 //If there are not enough past DST rules... 684 if (applicableRules.indexOf(date) < 2) { 685 applicableRules = applicableRules.concat(findApplicableRules(year-1, _this.rules[ruleset])); 686 applicableRules.sort(compareDates); 687 } 688 var pinpoint = applicableRules.indexOf(date); 689 if (pinpoint > 1 && compareDates(date, applicableRules[pinpoint-1], applicableRules[pinpoint-2][1]) < 0) { 690 //The previous rule does not really apply, take the one before that. 691 return applicableRules[pinpoint - 2][1]; 692 } else if (pinpoint > 0 && pinpoint < applicableRules.length - 1 && compareDates(date, applicableRules[pinpoint+1], applicableRules[pinpoint-1][1]) > 0) { 693 694 //The next rule does already apply, take that one. 695 return applicableRules[pinpoint + 1][1]; 696 } else if (pinpoint === 0) { 697 //No applicable rule found in this and in previous year. 698 return null; 699 } 700 return applicableRules[pinpoint - 1][1]; 701 } 702 function getAdjustedOffset(off, rule) { 703 return -Math.ceil(rule[6] - off); 704 } 705 function getAbbreviation(zone, rule) { 706 var res; 707 var base = zone[2]; 708 if (base.indexOf('%s') > -1) { 709 var repl; 710 if (rule) { 711 repl = rule[7] === '-' ? '' : rule[7]; 712 } 713 //FIXME: Right now just falling back to Standard -- 714 // apparently ought to use the last valid rule, 715 // although in practice that always ought to be Standard 716 else { 717 repl = 'S'; 718 } 719 res = base.replace('%s', repl); 720 } 721 else if (base.indexOf('/') > -1) { 722 //Chose one of two alternative strings. 723 res = base.split("/", 2)[rule[6] ? 1 : 0]; 724 } else { 725 res = base; 726 } 727 return res; 728 } 729 730 this.zoneFileBasePath; 731 this.zoneFiles = ['africa', 'antarctica', 'asia', 'australasia', 'backward', 'etcetera', 'europe', 'northamerica', 'pacificnew', 'southamerica']; 732 this.loadingSchemes = { 733 PRELOAD_ALL: 'preloadAll', 734 LAZY_LOAD: 'lazyLoad', 735 MANUAL_LOAD: 'manualLoad' 736 }; 737 this.loadingScheme = this.loadingSchemes.LAZY_LOAD; 738 this.loadedZones = {}; 739 this.zones = {}; 740 this.rules = {}; 741 742 this.init = function (o) { 743 var opts = { async: true } 744 , def = this.defaultZoneFile = this.loadingScheme === this.loadingSchemes.PRELOAD_ALL 745 ? this.zoneFiles 746 : 'northamerica' 747 , done = 0 748 , callbackFn; 749 //Override default with any passed-in opts 750 for (var p in o) { 751 opts[p] = o[p]; 752 } 753 if (typeof def === 'string') { 754 return this.loadZoneFile(def, opts); 755 } 756 //Wraps callback function in another one that makes 757 // sure all files have been loaded. 758 callbackFn = opts.callback; 759 opts.callback = function () { 760 done++; 761 (done === def.length) && typeof callbackFn === 'function' && callbackFn(); 762 }; 763 for (var i = 0; i < def.length; i++) { 764 this.loadZoneFile(def[i], opts); 765 } 766 }; 767 768 //Get the zone files via XHR -- if the sync flag 769 // is set to true, it's being called by the lazy-loading 770 // mechanism, so the result needs to be returned inline. 771 this.loadZoneFile = function (fileName, opts) { 772 if (typeof this.zoneFileBasePath === 'undefined') { 773 throw new Error('Please define a base path to your zone file directory -- timezoneJS.timezone.zoneFileBasePath.'); 774 } 775 //Ignore already loaded zones. 776 if (this.loadedZones[fileName]) { 777 return; 778 } 779 this.loadedZones[fileName] = true; 780 return builtInLoadZoneFile(fileName, opts); 781 }; 782 this.loadZoneJSONData = function (url, sync) { 783 var processData = function (data) { 784 data = eval('('+ data +')'); 785 for (var z in data.zones) { 786 _this.zones[z] = data.zones[z]; 787 } 788 for (var r in data.rules) { 789 _this.rules[r] = data.rules[r]; 790 } 791 }; 792 return sync 793 ? processData(_this.transport({ url : url, async : false })) 794 : _this.transport({ url : url, success : processData }); 795 }; 796 this.loadZoneDataFromObject = function (data) { 797 if (!data) { return; } 798 for (var z in data.zones) { 799 _this.zones[z] = data.zones[z]; 800 } 801 for (var r in data.rules) { 802 _this.rules[r] = data.rules[r]; 803 } 804 }; 805 this.getAllZones = function () { 806 var arr = []; 807 for (var z in this.zones) { arr.push(z); } 808 return arr.sort(); 809 }; 810 this.parseZones = function (str) { 811 var lines = str.split('\n') 812 , arr = [] 813 , chunk = '' 814 , l 815 , zone = null 816 , rule = null; 817 for (var i = 0; i < lines.length; i++) { 818 l = lines[i]; 819 if (l.match(/^\s/)) { 820 l = "Zone " + zone + l; 821 } 822 l = l.split("#")[0]; 823 if (l.length > 3) { 824 arr = l.split(/\s+/); 825 chunk = arr.shift(); 826 //Ignore Leap. 827 switch (chunk) { 828 case 'Zone': 829 zone = arr.shift(); 830 if (!_this.zones[zone]) { 831 _this.zones[zone] = []; 832 } 833 if (arr.length < 3) break; 834 //Process zone right here and replace 3rd element with the processed array. 835 arr.splice(3, arr.length, processZone(arr)); 836 if (arr[3]) arr[3] = Date.UTC.apply(null, arr[3]); 837 arr[0] = -getBasicOffset(arr[0]); 838 _this.zones[zone].push(arr); 839 break; 840 case 'Rule': 841 rule = arr.shift(); 842 if (!_this.rules[rule]) { 843 _this.rules[rule] = []; 844 } 845 //Parse int FROM year and TO year 846 arr[0] = parseInt(arr[0], 10); 847 arr[1] = parseInt(arr[1], 10) || arr[1]; 848 //Parse time string AT 849 arr[5] = parseTimeString(arr[5]); 850 //Parse offset SAVE 851 arr[6] = getBasicOffset(arr[6]); 852 _this.rules[rule].push(arr); 853 break; 854 case 'Link': 855 //No zones for these should already exist. 856 if (_this.zones[arr[1]]) { 857 throw new Error('Error with Link ' + arr[1] + '. Cannot create link of a preexisted zone.'); 858 } 859 //Create the link. 860 _this.zones[arr[1]] = arr[0]; 861 break; 862 } 863 } 864 } 865 return true; 866 }; 867 //Expose transport mechanism and allow overwrite. 868 this.transport = _transport; 869 this.getTzInfo = function (dt, tz, isUTC) { 870 //Lazy-load any zones not yet loaded. 871 if (this.loadingScheme === this.loadingSchemes.LAZY_LOAD) { 872 //Get the correct region for the zone. 873 var zoneFile = getRegionForTimezone(tz); 874 if (!zoneFile) { 875 throw new Error('Not a valid timezone ID.'); 876 } 877 if (!this.loadedZones[zoneFile]) { 878 //Get the file and parse it -- use synchronous XHR. 879 this.loadZoneFile(zoneFile); 880 } 881 } 882 var z = getZone(dt, tz); 883 var off = z[0]; 884 //See if the offset needs adjustment. 885 var rule = getRule(dt, z, isUTC); 886 if (rule) { 887 off = getAdjustedOffset(off, rule); 888 } 889 var abbr = getAbbreviation(z, rule); 890 return { tzOffset: off, tzAbbr: abbr }; 891 }; 892 }; 893 }).call(this);