calendar/providers/storage/calStorageHelpers.jsm
author tbirdbld
Mon, 14 Nov 2016 03:02:33 -0800
changeset 26104 e95d9bd956af9a8e8506d857af298d14ef1e36fc
parent 26016 311e2a727825d2b098d19ff265a9153f0eca1ebe
child 30044 18938fc0dd706992c6fd9fec8baddee302b2cd45
permissions -rw-r--r--
No bug, Automated blocklist update from host bld-linux64-spot-340 - a=blocklist-update

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

Components.utils.import("resource://calendar/modules/calUtils.jsm");

/* exported CAL_ITEM_FLAG, getInUtcOrKeepFloating, dateToText, textToDate,
 *          calStorageTimezone, getTimezone, newDateTime
 */

this.EXPORTED_SYMBOLS = [
    "CAL_ITEM_FLAG",
    "getInUtcOrKeepFloating",
    "dateToText",
    "textToDate",
    "calStorageTimezone",
    "getTimezone",
    "newDateTime"
];

// Storage flags. These are used in the Database |flags| column to give
// information about the item's features. For example, if the item has
// attachments, the HAS_ATTACHMENTS flag is added to the flags column.
var CAL_ITEM_FLAG = {
    PRIVATE: 1,
    HAS_ATTENDEES: 2,
    HAS_PROPERTIES: 4,
    EVENT_ALLDAY: 8,
    HAS_RECURRENCE: 16,
    HAS_EXCEPTIONS: 32,
    HAS_ATTACHMENTS: 64,
    HAS_RELATIONS: 128,
    HAS_ALARMS: 256,
    RECURRENCE_ID_ALLDAY: 512
};

// The cache of foreign timezones
var gForeignTimezonesCache = {};

/**
 * Returns the passed date in UTC, unless it is floating. In this case, it is
 * kept floating.
 *
 * @param date      The calIDateTime to convert.
 * @return          The possibly converted calIDateTime.
 */
function getInUtcOrKeepFloating(date) {
    let timezone = date.timezone;
    if (timezone.isFloating || timezone.isUTC) {
        return date;
    } else {
        return date.getInTimezone(cal.UTC());
    }
}

/**
 * Transforms a date object to a text which is suitable for the database
 *
 * @param date  The calIDateTime to transform.
 * @return      The string representation of the date object.
 */
function dateToText(date) {
    let zonestr;
    if (date.timezone.isFloating) {
        zonestr = "L";
    } else if (date.timezone.isUTC) {
        zonestr = "U";
    } else {
        zonestr = "Z";
    }

    let datestr = zonestr + (date.isDate ? "D" : "T") + date.nativeTime;
    if (!date.timezone.isFloating && !date.timezone.isUTC) {
        datestr += ":" + date.timezone.tzid.replace(/%/g, "%%").replace(/:/g, "%:");
    }
    return datestr;
}

/**
 * Transforms the text representation of this date object to a calIDateTime
 * object.
 *
 * @param text  The text to transform.
 * @return      The resulting calIDateTime.
 */
function textToDate(text) {
    let textval;
    let timezone = "UTC";

    if (text[0] == "Z") {
        let strs = text.substr(2).split(":");
        textval = parseInt(strs[0], 10);
        timezone = strs[1].replace(/%:/g, ":").replace(/%%/g, "%");
    } else {
        textval = parseInt(text.substr(2), 10);
    }

    let date;
    if (text[0] == "U" || text[0] == "Z") {
        date = newDateTime(textval, timezone);
    } else if (text[0] == "L") {
        // is local time
        date = newDateTime(textval, "floating");
    }

    if (text[1] == "D") {
        date.isDate = true;
    }
    return date;
}

//
// other helpers
//

/**
 * Prototype definition for foreign timezone.
 */
function calStorageTimezone(comp) {
    this.wrappedJSObject = this;
    this.provider = null;
    this.icalComponent = comp;
    this.tzid = comp.getFirstProperty("TZID").value;
    this.displayName = null;
    this.isUTC = false;
    this.isFloating = false;
    this.latitude = null;
    this.longitude = null;
}
calStorageTimezone.prototype = {
    toString: function() {
        return this.icalComponent.toString();
    }
};

/**
 * Gets the timezone for the given definition or identifier
 *
 * @param aTimezone     The timezone data
 * @return              The calITimezone object
 */
function getTimezone(aTimezone) {
    let timezone = null;
    if (aTimezone.indexOf("BEGIN:VTIMEZONE") == 0) {
        timezone = gForeignTimezonesCache[aTimezone]; // using full definition as key
        if (!timezone) {
            try {
                // cannot cope without parent VCALENDAR:
                let comp = cal.getIcsService().parseICS("BEGIN:VCALENDAR\n" + aTimezone + "\nEND:VCALENDAR", null);
                timezone = new calStorageTimezone(comp.getFirstSubcomponent("VTIMEZONE"));
                gForeignTimezonesCache[aTimezone] = timezone;
            } catch (e) {
                cal.ASSERT(false, e);
            }
        }
    } else {
        timezone = cal.getTimezoneService().getTimezone(aTimezone);
    }
    return timezone;
}

/**
 * Creates a new calIDateTime from the given native time and optionally
 * the passed timezone. The timezone can either be the TZID of the timezone (in
 * this case the timezone service will be asked for the definition), or a string
 * representation of the timezone component (i.e a VTIMEZONE component).
 *
 * @param aNativeTime       The native time, in microseconds
 * @param aTimezone         The timezone identifier or definition.
 */
function newDateTime(aNativeTime, aTimezone) {
    let date = cal.createDateTime();

    // Bug 751821 - Dates before 1970 were incorrectly stored with an unsigned nativeTime value, we need to
    // convert back to a negative value
    if (aNativeTime > 0x7fffffffffffffff) {
        cal.WARN("[calStorageCalendar] Converting invalid native time value: " + aNativeTime);
        aNativeTime = -0x7fffffffffffffff + (aNativeTime - 0x7fffffffffffffff);
        // Round to nearest second to fix microsecond rounding errors
        aNativeTime = Math.round(aNativeTime / 1000000) * 1000000;
    }

    date.nativeTime = aNativeTime;
    if (aTimezone) {
        let timezone = getTimezone(aTimezone);
        if (timezone) {
            date = date.getInTimezone(timezone);
        } else {
            cal.ASSERT(false, "Timezone not available: " + aTimezone);
        }
    } else {
        date.timezone = cal.floating();
    }
    return date;
}