pjs/calendar/providers/ics/calICSCalendar.js

1052 строки
37 KiB
JavaScript

/* -*- Mode: java; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla calendar code.
*
* The Initial Developer of the Original Code is
* Michiel van Leeuwen <mvl@exedo.nl>
* Portions created by the Initial Developer are Copyright (C) 2004
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
* Dan Mosedale <dan.mosedale@oracle.com>
* Joey Minta <jminta@gmail.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
//
// calICSCalendar.js
//
// This is a non-sync ics file. It reads the file pointer to by uri when set,
// then writes it on updates. External changes to the file will be
// ignored and overwritten.
//
// XXX Should do locks, so that external changes are not overwritten.
const CI = Components.interfaces;
const calIOperationListener = Components.interfaces.calIOperationListener;
const calICalendar = Components.interfaces.calICalendar;
const calIErrors = Components.interfaces.calIErrors;
var appInfo = Components.classes["@mozilla.org/xre/app-info;1"].
getService(Components.interfaces.nsIXULAppInfo);
var isOnBranch = appInfo.platformVersion.indexOf("1.8") == 0;
function calICSCalendar () {
this.wrappedJSObject = this;
this.initICSCalendar();
this.unmappedComponents = [];
this.unmappedProperties = [];
this.queue = new Array();
}
calICSCalendar.prototype = {
mICSService: null,
mObserver: null,
locked: false,
QueryInterface: function (aIID) {
if (!aIID.equals(Components.interfaces.nsISupports) &&
!aIID.equals(Components.interfaces.calICalendarProvider) &&
!aIID.equals(Components.interfaces.calICalendar) &&
!aIID.equals(Components.interfaces.nsIStreamListener) &&
!aIID.equals(Components.interfaces.nsIStreamLoaderObserver) &&
!aIID.equals(Components.interfaces.nsIInterfaceRequestor)) {
throw Components.results.NS_ERROR_NO_INTERFACE;
}
return this;
},
initICSCalendar: function() {
this.mMemoryCalendar = Components.classes["@mozilla.org/calendar/calendar;1?type=memory"]
.createInstance(Components.interfaces.calICalendar);
this.mICSService = Components.classes["@mozilla.org/calendar/ics-service;1"]
.getService(Components.interfaces.calIICSService);
this.mObserver = new calICSObserver(this);
this.mMemoryCalendar.addObserver(this.mObserver);
this.mMemoryCalendar.wrappedJSObject.calendarToReturn = this;
},
//
// calICalendarProvider interface
//
get prefChromeOverlay() {
return null;
},
get displayName() {
return calGetString("calendar", "icsName");
},
createCalendar: function ics_createCal() {
throw NS_ERROR_NOT_IMPLEMENTED;
},
deleteCalendar: function ics_deleteCal(cal, listener) {
throw NS_ERROR_NOT_IMPLEMENTED;
},
//
// calICalendar interface
//
// attribute AUTF8String id;
mID: null,
get id() {
return this.mID;
},
set id(id) {
if (this.mID)
throw Components.results.NS_ERROR_ALREADY_INITIALIZED;
return (this.mID = id);
},
get name() {
return getCalendarManager().getCalendarPref(this, "NAME");
},
set name(name) {
getCalendarManager().setCalendarPref(this, "NAME", name);
},
get type() { return "ics"; },
mReadOnly: false,
get readOnly() {
return this.mReadOnly;
},
set readOnly(bool) {
this.mReadOnly = bool;
},
get canRefresh() {
return true;
},
mUri: null,
get uri() { return this.mUri },
set uri(aUri) {
this.mUri = aUri;
this.mMemoryCalendar.uri = this.mUri;
// Use the ioservice, to create a channel, which makes finding the
// right hooks to use easier.
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var channel = ioService.newChannelFromURI(this.mUri);
if (channel instanceof Components.interfaces.nsIHttpChannel) {
this.mHooks = new httpHooks();
} else {
this.mHooks = new dummyHooks();
}
this.refresh();
},
refresh: function calICSCalendar_refresh() {
this.queue.push({action: 'refresh'});
this.processQueue();
},
doRefresh: function calICSCalendar_doRefresh() {
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var channel = ioService.newChannelFromURI(this.mUri);
channel.loadFlags |= Components.interfaces.nsIRequest.LOAD_BYPASS_CACHE;
channel.notificationCallbacks = this;
// Allow the hook to do its work, like a performing a quick check to
// see if the remote file really changed. Might save a lot of time
this.mHooks.onBeforeGet(channel);
var streamLoader = Components.classes["@mozilla.org/network/stream-loader;1"]
.createInstance(Components.interfaces.nsIStreamLoader);
// Lock other changes to the item list.
this.lock();
try {
if (isOnBranch) {
streamLoader.init(channel, this, this);
} else {
streamLoader.init(this);
channel.asyncOpen(streamLoader, this);
}
} catch(e) {
// File not found: a new calendar. No problem.
this.unlock();
}
},
calendarPromotedProps: {
"PRODID": true,
"VERSION": true
},
// nsIStreamLoaderObserver impl
// Listener for download. Parse the downloaded file
onStreamComplete: function(loader, ctxt, status, resultLength, result)
{
// No need to do anything if there was no result
if (!resultLength) {
this.unlock();
return;
}
// Allow the hook to get needed data (like an etag) of the channel
var cont = this.mHooks.onAfterGet();
if (!cont) {
this.unlock();
return;
}
// This conversion is needed, because the stream only knows about
// byte arrays, not about strings or encodings. The array of bytes
// need to be interpreted as utf8 and put into a javascript string.
var unicodeConverter = Components.classes["@mozilla.org/intl/scriptableunicodeconverter"]
.createInstance(Components.interfaces.nsIScriptableUnicodeConverter);
// ics files are always utf8
unicodeConverter.charset = "UTF-8";
var str;
try {
str = unicodeConverter.convertFromByteArray(result, result.length);
} catch(e) {
this.mObserver.onError(calIErrors.CAL_UTF8_DECODING_FAILED, e.toString());
this.unlock();
return;
}
// Create a new calendar, to get rid of all the old events
this.mMemoryCalendar = Components.classes["@mozilla.org/calendar/calendar;1?type=memory"]
.createInstance(Components.interfaces.calICalendar);
this.mMemoryCalendar.uri = this.mUri;
this.mMemoryCalendar.wrappedJSObject.calendarToReturn = this;
this.mObserver.onStartBatch();
// Wrap parsing in a try block. Will ignore errors. That's a good thing
// for non-existing or empty files, but not good for invalid files.
// That's why we put them in readOnly mode
try {
var parser = Components.classes["@mozilla.org/calendar/ics-parser;1"].
createInstance(Components.interfaces.calIIcsParser);
parser.parseString(str);
var items = parser.getItems({});
for each (var item in items) {
this.mMemoryCalendar.adoptItem(item, null);
}
this.unmappedComponents = parser.getComponents({});
this.unmappedProperties = parser.getProperties({});
} catch(e) {
LOG("Parsing the file failed:"+e);
this.mObserver.onError(e.result, e.toString());
}
this.mObserver.onEndBatch();
this.mObserver.onLoad(this);
// Now that all items have been stuffed into the memory calendar
// we should add ourselves as observer. It is important that this
// happens *after* the calls to adoptItem in the above loop to prevent
// the views from being notified.
this.mMemoryCalendar.addObserver(this.mObserver);
this.unlock();
},
writeICS: function () {
this.lock();
if (!this.mUri)
throw Components.results.NS_ERROR_FAILURE;
// makeBackup will call doWriteICS
this.makeBackup(this.doWriteICS);
},
doWriteICS: function () {
var savedthis = this;
var appStartup = Components.classes["@mozilla.org/toolkit/app-startup;1"]
.getService(Components.interfaces.nsIAppStartup);
var listener =
{
serializer: null,
onOperationComplete: function(aCalendar, aStatus, aOperationType, aId, aDetail)
{
var inLastWindowClosingSurvivalArea = false;
try {
// All events are returned. Now set up a channel and a
// streamloader to upload. onStopRequest will be called
// once the write has finished
var ioService = Components.classes
["@mozilla.org/network/io-service;1"]
.getService(Components.interfaces.nsIIOService);
var channel = ioService.newChannelFromURI(savedthis.mUri);
// Allow the hook to add things to the channel, like a
// header that checks etags
savedthis.mHooks.onBeforePut(channel);
channel.notificationCallbacks = savedthis;
var uploadChannel = channel.QueryInterface(
Components.interfaces.nsIUploadChannel);
// Create a pipe to convert the output stream from the
// serializer into an input stream for the upload channel
var pipe = Components.classes["@mozilla.org/pipe;1"].
createInstance(Components.interfaces.nsIPipe);
const PR_UINT32_MAX = 4294967295; // signals "infinite-length"
pipe.init(true, true, 0, PR_UINT32_MAX, null);
// Serialize
var icsStream = this.serializer.serializeToStream(pipe.outputStream);
// Upload
uploadChannel.setUploadStream(pipe.inputStream,
"text/calendar", -1);
appStartup.enterLastWindowClosingSurvivalArea();
inLastWindowClosingSurvivalArea = true;
channel.asyncOpen(savedthis, savedthis);
} catch (ex) {
if (inLastWindowClosingSurvivalArea) {
appStartup.exitLastWindowClosingSurvivalArea();
}
savedthis.mObserver.onError(
ex.result, "The calendar could not be saved; there " +
"was a failure: 0x" + ex.result.toString(16));
}
return;
},
onGetResult: function(aCalendar, aStatus, aItemType, aDetail, aCount, aItems)
{
this.serializer.addItems(aItems, aCount);
}
};
listener.serializer = Components.classes["@mozilla.org/calendar/ics-serializer;1"].
createInstance(Components.interfaces.calIIcsSerializer);
for each (var comp in this.unmappedComponents) {
listener.serializer.addComponent(comp);
}
for each (var prop in this.unmappedProperties) {
listener.serializer.addProperty(prop);
}
// don't call this.getItems, because we are locked:
this.mMemoryCalendar.getItems(calICalendar.ITEM_FILTER_TYPE_ALL | calICalendar.ITEM_FILTER_COMPLETED_ALL,
0, null, null, listener);
},
// nsIStreamListener impl
// For after publishing. Do error checks here
onStartRequest: function(request, ctxt) {},
onDataAvailable: function(request, ctxt, inStream, sourceOffset, count) {},
onStopRequest: function(request, ctxt, status, errorMsg)
{
ctxt = ctxt.wrappedJSObject;
var channel;
try {
channel = request.QueryInterface(Components.interfaces.nsIHttpChannel);
LOG(channel.requestSucceeded);
} catch(e) {
}
if (channel && !channel.requestSucceeded) {
ctxt.mObserver.onError(channel.requestSucceeded,
"Publishing the calendar file failed\n" +
"Status code: "+channel.responseStatus+": "+channel.responseStatusText+"\n");
}
else if (!channel && !Components.isSuccessCode(request.status)) {
ctxt.mObserver.onError(request.status,
"Publishing the calendar file failed\n" +
"Status code: "+request.status.toString(16)+"\n");
}
// Allow the hook to grab data of the channel, like the new etag
ctxt.mHooks.onAfterPut(channel);
ctxt.unlock();
var appStartup = Components.classes["@mozilla.org/toolkit/app-startup;1"]
.getService(Components.interfaces.nsIAppStartup);
appStartup.exitLastWindowClosingSurvivalArea();
},
addObserver: function (aObserver) {
this.mObserver.addObserver(aObserver);
},
removeObserver: function (aObserver) {
this.mObserver.removeObserver(aObserver);
},
get sendItipInvitations() { return true; },
// Always use the queue, just to reduce the amount of places where
// this.mMemoryCalendar.addItem() and friends are called. less
// copied code.
addItem: function (aItem, aListener) {
if (this.readOnly)
throw Components.interfaces.calIErrors.CAL_IS_READONLY;
this.queue.push({action:'add', item:aItem, listener:aListener});
this.processQueue();
},
modifyItem: function (aNewItem, aOldItem, aListener) {
if (this.readOnly)
throw Components.interfaces.calIErrors.CAL_IS_READONLY;
this.queue.push({action:'modify', oldItem: aOldItem,
newItem: aNewItem, listener:aListener});
this.processQueue();
},
deleteItem: function (aItem, aListener) {
if (this.readOnly)
throw Components.interfaces.calIErrors.CAL_IS_READONLY;
this.queue.push({action:'delete', item:aItem, listener:aListener});
this.processQueue();
},
getItem: function (aId, aListener) {
this.queue.push({action:'get_item', id:aId, listener:aListener});
this.processQueue();
},
getItems: function (aItemFilter, aCount,
aRangeStart, aRangeEnd, aListener)
{
this.queue.push({action:'get_items',
itemFilter:aItemFilter, count:aCount,
rangeStart:aRangeStart, rangeEnd:aRangeEnd,
listener:aListener});
this.processQueue();
},
processQueue: function ()
{
if (this.isLocked())
return;
var a;
var writeICS = false;
var refreshAction = null;
while ((a = this.queue.shift())) {
switch (a.action) {
case 'add':
this.mMemoryCalendar.addItem(a.item, a.listener);
writeICS = true;
break;
case 'modify':
this.mMemoryCalendar.modifyItem(a.newItem, a.oldItem,
a.listener);
writeICS = true;
break;
case 'delete':
this.mMemoryCalendar.deleteItem(a.item, a.listener);
writeICS = true;
break;
case 'get_item':
this.mMemoryCalendar.getItem(a.id, a.listener);
break;
case 'get_items':
this.mMemoryCalendar.getItems(a.itemFilter, a.count,
a.rangeStart, a.rangeEnd,
a.listener);
break;
case 'refresh':
refreshAction = a;
break;
}
if (refreshAction) {
// break queue processing here and wait for refresh to finish
// before processing further operations
break;
}
}
if (writeICS) {
if (refreshAction) {
// reschedule the refresh for next round, after the file has been written;
// strictly we may not need to refresh once the file has been successfully
// written, but we don't know if that write will succeed.
this.queue.unshift(refreshAction);
}
this.writeICS();
}
else if (refreshAction) {
this.doRefresh();
}
},
lock: function () {
this.locked = true;
},
unlock: function () {
this.locked = false;
this.processQueue();
},
isLocked: function () {
return this.locked;
},
startBatch: function ()
{
this.mObserver.onStartBatch();
},
endBatch: function ()
{
this.mObserver.onEndBatch();
},
// nsIInterfaceRequestor impl
getInterface: function(iid, instance) {
if (iid.equals(Components.interfaces.nsIAuthPrompt)) {
return new calAuthPrompt();
}
else if (iid.equals(Components.interfaces.nsIPrompt)) {
// use the window watcher service to get a nsIPrompt impl
return Components.classes["@mozilla.org/embedcomp/window-watcher;1"]
.getService(Components.interfaces.nsIWindowWatcher)
.getNewPrompter(null);
}
Components.returnCode = Components.results.NS_ERROR_NO_INTERFACE;
return null;
},
/**
* Make a backup of the (remote) calendar
*
* This will download the remote file into the profile dir.
* It should be called before every upload, so every change can be
* restored. By default, it will keep 3 backups. It also keeps one
* file each day, for 3 days. That way, even if the user doesn't notice
* the remote calendar has become corrupted, he will still loose max 1
* day of work.
* After the back up is finished, will call aCallback.
*
* @param aCallback
* Function that will be calles after the backup is finished.
* will be called in the original context in which makeBackup
* was called
*/
makeBackup: function(aCallback) {
// Uses |pseudoID|, an id of the calendar, defined below
function makeName(type) {
return 'calBackupData_'+pseudoID+'_'+type+'.ics';
}
// This is a bit messy. createUnique creates an empty file,
// but we don't use that file. All we want is a filename, to be used
// in the call to copyTo later. So we create a file, get the filename,
// and never use the file again, but write over it.
// Using createUnique anyway, because I don't feel like
// re-implementing it
function makeDailyFileName() {
var dailyBackupFile = backupDir.clone();
dailyBackupFile.append(makeName('day'));
dailyBackupFile.createUnique(CI.nsIFile.NORMAL_FILE_TYPE, 0600);
dailyBackupFileName = dailyBackupFile.leafName;
// Remove the reference to the nsIFile, because we need to
// write over the file later, and you never know what happens
// if something still has a reference.
// Also makes it explicit that we don't need the file itself,
// just the name.
dailyBackupFile = null;
return dailyBackupFileName;
}
function purgeBackupsByType(files, type) {
// filter out backups of the type we care about.
var filteredFiles = files.filter(
function f(v) {
return (v.name.indexOf("calBackupData_"+pseudoID+"_"+type) != -1)
});
// Sort by lastmodifed
filteredFiles.sort(
function s(a,b) {
return (a.lastmodified - b.lastmodified);
});
// And delete the oldest files, and keep the desired number of
// old backups
var i;
for (i = 0; i < filteredFiles.length - numBackupFiles; ++i) {
file = backupDir.clone();
file.append(filteredFiles[i].name);
// This can fail because of some crappy code in nsILocalFile.
// That's not the end of the world. We can try to remove the
// file the next time around.
try {
file.remove(false);
} catch(ex) {}
}
return;
}
function purgeOldBackups() {
// Enumerate files in the backupdir for expiry of old backups
var dirEnum = backupDir.directoryEntries;
var files = [];
while (dirEnum.hasMoreElements()) {
var file = dirEnum.getNext().QueryInterface(CI.nsIFile);
if (file.isFile()) {
files.push({name: file.leafName, lastmodified: file.lastModifiedTime});
}
}
if (doDailyBackup)
purgeBackupsByType(files, 'day');
else
purgeBackupsByType(files, 'edit');
return;
}
function copyToOverwriting(oldFile, newParentDir, newName) {
try {
var newFile = newParentDir.clone();
newFile.append(newName);
if (newFile.exists()) {
newFile.remove(false);
}
oldFile.copyTo(newParentDir, newName);
} catch(e) {
Components.utils.reportError("Backup failed, no copy:"+e);
// Error in making a daily/initial backup.
// not fatal, so just continue
}
}
function getIntPrefSafe(prefName, defaultValue)
{
try {
var prefValue = backupBranch.getIntPref(prefName);
return prefValue;
}
catch (ex) {
return defaultValue;
}
}
var backupDays = getIntPrefSafe("days", 1);
var numBackupFiles = getIntPrefSafe("filenum", 3);
try {
var dirService = Components.classes["@mozilla.org/file/directory_service;1"]
.getService(CI.nsIProperties);
var backupDir = dirService.get("ProfD", CI.nsILocalFile);
backupDir.append("backupData");
if (!backupDir.exists()) {
backupDir.create(CI.nsIFile.DIRECTORY_TYPE, 0755);
}
} catch(e) {
// Backup dir wasn't found. Likely because we are running in
// xpcshell. Don't die, but continue the upload.
LOG("Backup failed, no backupdir:"+e);
aCallback.call(this);
return;
}
try {
var pseudoID = getCalendarManager().getCalendarPref(this, "UNIQUENUM");
if (!pseudoID) {
pseudoID = new Date().getTime();
getCalendarManager().setCalendarPref(this, "UNIQUENUM", pseudoID);
}
} catch(e) {
// calendarmgr not found. Likely because we are running in
// xpcshell. Don't die, but continue the upload.
LOG("Backup failed, no calendarmanager:"+e);
aCallback.call(this);
return;
}
var doInitialBackup = false;
var initialBackupFile = backupDir.clone();
initialBackupFile.append(makeName('initial'));
if (!initialBackupFile.exists())
doInitialBackup = true;
var doDailyBackup = false;
var backupTime = new Number(getCalendarManager().
getCalendarPref(this, 'backup-time'));
if (!backupTime ||
(new Date().getTime() > backupTime + backupDays*24*60*60*1000)) {
// It's time do to a daily backup
doDailyBackup = true;
getCalendarManager().setCalendarPref(this, 'backup-time',
new Date().getTime());
}
var dailyBackupFileName;
if (doDailyBackup) {
dailyBackupFileName = makeDailyFileName(backupDir);
}
var backupFile = backupDir.clone();
backupFile.append(makeName('edit'));
backupFile.createUnique(CI.nsIFile.NORMAL_FILE_TYPE, 0600);
purgeOldBackups();
// Now go download the remote file, and store it somewhere local.
var ioService = Components.classes["@mozilla.org/network/io-service;1"]
.getService(CI.nsIIOService);
var channel = ioService.newChannelFromURI(this.mUri);
channel.loadFlags |= Components.interfaces.nsIRequest.LOAD_BYPASS_CACHE;
channel.notificationCallbacks = this;
var downloader = Components.classes["@mozilla.org/network/downloader;1"]
.createInstance(CI.nsIDownloader);
var savedthis = this;
var listener = {
onDownloadComplete: function(downloader, request, ctxt, status, result) {
if (doInitialBackup)
copyToOverwriting(result, backupDir, makeName('initial'));
if (doDailyBackup)
copyToOverwriting(result, backupDir, dailyBackupFileName);
aCallback.call(savedthis);
},
}
downloader.init(listener, backupFile);
try {
channel.asyncOpen(downloader, null);
} catch(e) {
// For local files, asyncOpen throws on new (calendar) files
// No problem, go and upload something
LOG("Backup failed in asyncOpen:"+e);
aCallback.call(this);
return;
}
return;
}
};
function calICSObserver(aCalendar) {
this.mCalendar = aCalendar;
this.mObservers = new calListenerBag(Ci.calIObserver);
}
calICSObserver.prototype = {
mCalendar: null,
mObservers: null,
mInBatch: false,
// calIObserver:
onStartBatch: function() {
this.mObservers.notify("onStartBatch");
this.mInBatch = true;
},
onEndBatch: function() {
this.mObservers.notify("onEndBatch");
this.mInBatch = false;
},
onLoad: function(calendar) {
this.mObservers.notify("onLoad", [calendar]);
},
onAddItem: function(aItem) {
this.mObservers.notify("onAddItem", [aItem]);
},
onModifyItem: function(aNewItem, aOldItem) {
this.mObservers.notify("onModifyItem", [aNewItem, aOldItem]);
},
onDeleteItem: function(aDeletedItem) {
this.mObservers.notify("onDeleteItem", [aDeletedItem]);
},
// Unless an error number is in this array, we consider it very bad, set
// the calendar to readOnly, and give up.
acceptableErrorNums: [],
onError: function(aErrNo, aMessage) {
var errorIsOk = false;
for each (num in this.acceptableErrorNums) {
if (num == aErrNo) {
errorIsOk = true;
break;
}
}
if (!errorIsOk)
this.mCalendar.readOnly = true;
this.mObservers.notify("onError", [aErrNo, aMessage]);
},
// This observer functions as proxy for all the other observers
// So need addObserver and removeObserver here
addObserver: function (aObserver) {
this.mObservers.add(aObserver);
},
removeObserver: function (aObserver) {
this.mObservers.remove(aObserver);
}
};
/***************************
* Transport Abstraction Hooks
*
* Those hooks provide a way to do checks before or after publishing an
* ics file. The main use will be to check etags (or some other way to check
* for remote changes) to protect remote changes from being overwritten.
*
* Different protocols need different checks (webdav can do etag, but
* local files need last-modified stamps), hence different hooks for each
* types
*/
// dummyHooks are for transport types that don't have hooks of their own.
// Also serves as poor-mans interface definition.
function dummyHooks() {
}
dummyHooks.prototype = {
onBeforeGet: function(aChannel) {
return true;
},
/**
* @return
* a boolean, false if the previous data should be used (the datastore
* didn't change, there might be no data in this GET), true in all
* other cases
*/
onAfterGet: function() {
return true;
},
onBeforePut: function(aChannel) {
return true;
},
onAfterPut: function(aChannel) {
return true;
},
}
function httpHooks() {
this.mChannel = null;
}
httpHooks.prototype = {
onBeforeGet: function(aChannel) {
this.mChannel = aChannel;
if (this.mEtag) {
var httpchannel = aChannel.QueryInterface(Components.interfaces.nsIHttpChannel);
// Somehow the webdav header 'If' doesn't work on apache when
// passing in a Not, so use the http version here.
httpchannel.setRequestHeader("If-None-Match", this.mEtag, false);
}
return true;
},
onAfterGet: function() {
var httpchannel = this.mChannel.QueryInterface(Components.interfaces.nsIHttpChannel);
// 304: Not Modified
// Can use the old data, so tell the caller that it can skip parsing.
if (httpchannel.responseStatus == 304)
return false;
// 404: Not Found
// This is a new calendar. Shouldn't try to parse it. But it also
// isn't a failure, so don't throw.
if (httpchannel.responseStatus == 404)
return false;
try {
this.mEtag = httpchannel.getResponseHeader("ETag");
} catch(e) {
// No etag header. Now what?
this.mEtag = null;
}
this.mChannel = null;
return true;
},
onBeforePut: function(aChannel) {
if (this.mEtag) {
var httpchannel = aChannel.QueryInterface(Components.interfaces.nsIHttpChannel);
// Apache doesn't work correctly with if-match on a PUT method,
// so use the webdav header
httpchannel.setRequestHeader("If", '(['+this.mEtag+'])', false);
}
return true;
},
onAfterPut: function(aChannel) {
var httpchannel = aChannel.QueryInterface(Components.interfaces.nsIHttpChannel);
try {
this.mEtag = httpchannel.getResponseHeader("ETag");
} catch(e) {
// There was no ETag header on the response. This means that
// putting is not atomic. This is bad. Race conditions can happen,
// because there is a time in which we don't know the right
// etag.
// Try to do the best we can, by immediatly getting the etag.
// Only on branch, because webdav doesn't work on trunk: bug 332840
if (isOnBranch) {
var res = new WebDavResource(aChannel.URI);
var webSvc = Components.classes['@mozilla.org/webdav/service;1']
.getService(Components.interfaces.nsIWebDAVService);
// The namespace is 'DAV:', not just 'DAV'.
webSvc.getResourceProperties(res, 1, ['DAV: getetag'], false,
this, null, null);
} else {
// instead, on trunk, set mEtag to null, so it will be ignored on
// the next GET/PUT
this.mEtag = null;
}
}
return true;
},
onOperationComplete: function(aStatusCode, aResource, aOperation, aClosure) {
},
onOperationDetail: function(aStatusCode, aResource, aOperation, aDetail, aClosure) {
var props = aDetail.QueryInterface(Components.interfaces.nsIProperties);
try {
this.mEtag = props.get('DAV: getetag', Components.interfaces.nsISupportsString).toString();
} catch(e) {
// No etag header. Now what?
this.mEtag = null;
}
},
}
function WebDavResource(url) {
this.mResourceURL = url;
}
WebDavResource.prototype = {
mResourceURL: {},
get resourceURL() { return this.mResourceURL; },
QueryInterface: function(iid) {
if (iid.equals(CI.nsIWebDAVResource) ||
iid.equals(CI.nsISupports)) {
return this;
}
throw Components.interfaces.NS_ERROR_NO_INTERFACE;
}
};
/****
**** module registration
****/
var calICSCalendarModule = {
mCID: Components.ID("{f8438bff-a3c9-4ed5-b23f-2663b5469abf}"),
mContractID: "@mozilla.org/calendar/calendar;1?type=ics",
mUtilsLoaded: false,
loadUtils: function icsLoadUtils() {
if (this.mUtilsLoaded)
return;
const jssslContractID = "@mozilla.org/moz/jssubscript-loader;1";
const jssslIID = Components.interfaces.mozIJSSubScriptLoader;
const iosvcContractID = "@mozilla.org/network/io-service;1";
const iosvcIID = Components.interfaces.nsIIOService;
var loader = Components.classes[jssslContractID].getService(jssslIID);
var iosvc = Components.classes[iosvcContractID].getService(iosvcIID);
// Note that unintuitively, __LOCATION__.parent == .
// We expect to find utils in ./../js
var appdir = __LOCATION__.parent.parent;
appdir.append("js");
var scriptName = "calUtils.js";
var f = appdir.clone();
f.append(scriptName);
try {
var fileurl = iosvc.newFileURI(f);
loader.loadSubScript(fileurl.spec, this.__parent__.__parent__);
} catch (e) {
dump("Error while loading " + fileurl.spec + "\n");
throw e;
}
this.mUtilsLoaded = true;
},
registerSelf: function (compMgr, fileSpec, location, type) {
compMgr = compMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar);
compMgr.registerFactoryLocation(this.mCID,
"Calendar ICS provider",
this.mContractID,
fileSpec,
location,
type);
},
getClassObject: function (compMgr, cid, iid) {
if (!cid.equals(this.mCID))
throw Components.results.NS_ERROR_NO_INTERFACE;
if (!iid.equals(Components.interfaces.nsIFactory))
throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
this.loadUtils();
return this.mFactory;
},
mFactory: {
createInstance: function (outer, iid) {
if (outer != null)
throw Components.results.NS_ERROR_NO_AGGREGATION;
return (new calICSCalendar()).QueryInterface(iid);
}
},
canUnload: function(compMgr) {
return true;
}
};
function NSGetModule(compMgr, fileSpec) {
return calICSCalendarModule;
}