Fix bug 350845 - Implement relevant parameter methods (enumerate, exists, set). r=markus
This commit is contained in:
Philipp Kewisch
Родитель
2a7a9e87ab
Коммит
c1dddcb4b7
|
|
@ -87,14 +87,14 @@ interface calIItemBase : nsISupports
|
|||
|
||||
/**
|
||||
* Checks whether the argument object refers the same calendar item as
|
||||
* this one, by testing both the id and recurrenceId property. This
|
||||
* this one, by testing both the id and recurrenceId property. This
|
||||
*
|
||||
* @arg aItem the item to compare against this one
|
||||
*
|
||||
* @return true if both ids match, false otherwise
|
||||
*/
|
||||
boolean hasSameIds(in calIItemBase aItem);
|
||||
|
||||
|
||||
//
|
||||
// the generation number of this item
|
||||
//
|
||||
|
|
@ -174,7 +174,7 @@ interface calIItemBase : nsISupports
|
|||
attribute calIRecurrenceInfo recurrenceInfo;
|
||||
readonly attribute calIDateTime recurrenceStartDate;
|
||||
|
||||
//
|
||||
//
|
||||
// All event properties are stored in a property bag;
|
||||
// some number of these are "promoted" to top-level
|
||||
// accessor attributes. For example, "SUMMARY" is
|
||||
|
|
@ -182,7 +182,7 @@ interface calIItemBase : nsISupports
|
|||
//
|
||||
// If you use the has/get/set/deleteProperty
|
||||
// methods, property names are case-insensitive.
|
||||
//
|
||||
//
|
||||
// For purposes of ICS serialization, all property names in
|
||||
// the hashbag are in uppercase.
|
||||
//
|
||||
|
|
@ -235,14 +235,44 @@ interface calIItemBase : nsISupports
|
|||
boolean isPropertyPromoted(in AString name);
|
||||
|
||||
/**
|
||||
* Returns a particular parameter value for a property, or null if the
|
||||
* Returns a particular parameter value for a property, or null if the
|
||||
* parameter does not exist. If the property does not exist, throws.
|
||||
*
|
||||
* @param aPropertyName the name of the property
|
||||
* @param aParameterName the name of the parameter on the property
|
||||
*/
|
||||
AString getPropertyParameter(in AString aPropertyName,
|
||||
in AString aParameterName);
|
||||
AString getPropertyParameter(in AString aPropertyName,
|
||||
in AString aParameterName);
|
||||
|
||||
/**
|
||||
* Checks if the given property has the given parameter.
|
||||
*
|
||||
* @param aPropertyName The name of the property.
|
||||
* @param aParameterName The name of the parameter on the property.
|
||||
* @return True, if the parameter exists on the property
|
||||
*/
|
||||
boolean hasPropertyParameter(in AString aPropertyName,
|
||||
in AString aParameterName);
|
||||
|
||||
/**
|
||||
* Sets a particular parameter value for a property, or unsets if null is
|
||||
* passed. If the property does not exist, throws.
|
||||
*
|
||||
* @param aPropertyName The name of the property
|
||||
* @param aParameterName The name of the parameter on the property
|
||||
* @param aParameterValue The value of the parameter to set
|
||||
*/
|
||||
void setPropertyParameter(in AString aPropertyName,
|
||||
in AString aParameterName,
|
||||
in AUTF8String aParameterValue);
|
||||
|
||||
/**
|
||||
* Returns a property parameter enumerator for the given property name
|
||||
*
|
||||
* @param aPropertyName The name of the property.
|
||||
* @return The parameter enumerator.
|
||||
*/
|
||||
nsISimpleEnumerator getParameterEnumerator(in AString aPropertyName);
|
||||
|
||||
/**
|
||||
* The organizer (originator) of the item. We will likely not
|
||||
|
|
@ -316,7 +346,7 @@ interface calIItemBase : nsISupports
|
|||
* Removes the relation for this item and the referred item
|
||||
*/
|
||||
void removeRelation(in calIRelation relation);
|
||||
|
||||
|
||||
/**
|
||||
* Removes every relation for this item (in this items and also where it is referred
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -438,11 +438,73 @@ calItemBase.prototype = {
|
|||
} else {
|
||||
this.mProperties.deleteProperty(aName);
|
||||
}
|
||||
delete this.mPropertyParams[aName];
|
||||
},
|
||||
|
||||
// AString getPropertyParameter(in AString aPropertyName,
|
||||
getPropertyParameter: function getPP(aPropName, aParamName) {
|
||||
return this.mPropertyParams[aPropName][aParamName];
|
||||
// in AString aParameterName);
|
||||
getPropertyParameter: function cIB_getPropertyParameter(aPropName, aParamName) {
|
||||
let propName = aPropName.toUpperCase();
|
||||
let paramName = aParamName.toUpperCase();
|
||||
if (propName in this.mPropertyParams) {
|
||||
// If the property is not in mPropertyParams, then this just means
|
||||
// there are no properties set.
|
||||
return this.mPropertyParams[propName][paramName];
|
||||
}
|
||||
return null;
|
||||
},
|
||||
|
||||
// boolean hasPropertyParameter(in AString aPropertyName,
|
||||
// in AString aParameterName);
|
||||
hasPropertyParameter: function cIB_hasPropertyParameter(aPropName, aParamName) {
|
||||
let propName = aPropName.toUpperCase();
|
||||
let paramName = aParamName.toUpperCase();
|
||||
return ((propName in this.mPropertyParams) &&
|
||||
(paramName in this.mPropertyParams[propName]));
|
||||
},
|
||||
|
||||
//void setPropertyParameter(in AString aPropertyName,
|
||||
// in AString aParameterName,
|
||||
// in AUTF8String aParameterValue);
|
||||
setPropertyParameter: function cIB_setPropertyParameter(aPropName, aParamName, aParamValue) {
|
||||
let propName = aPropName.toUpperCase();
|
||||
let paramName = aParamName.toUpperCase();
|
||||
if (!(propName in this.mPropertyParams)) {
|
||||
throw "Property " + aPropName + " not set";
|
||||
}
|
||||
this.modify();
|
||||
if (aParamValue || !isNaN(parseInt(aParamValue, 10))) {
|
||||
this.mPropertyParams[propName][paramName] = aParamValue;
|
||||
} else {
|
||||
delete this.mPropertyParams[propName][paramName];
|
||||
}
|
||||
return aParamValue;
|
||||
},
|
||||
|
||||
// nsISimpleEnumerator getParameterEnumerator(in AString aPropertyName);
|
||||
getParameterEnumerator: function cIB_getParameterEnumerator(aPropName) {
|
||||
let propName = aPropName.toUpperCase();
|
||||
if (!(propName in this.mPropertyParams)) {
|
||||
throw "Property " + aPropName + " not set";
|
||||
}
|
||||
let parameters = this.mPropertyParams[propName];
|
||||
return { // nsISimpleEnumerator
|
||||
mParamNames: [ key for (key in parameters) ],
|
||||
hasMoreElements: function cIB_gPE_hasMoreElements() {
|
||||
return (this.mParamNames.length > 0);
|
||||
},
|
||||
|
||||
getNext: function cIB_gPE_getNext() {
|
||||
let paramName = this.mParamNames.pop()
|
||||
return { // nsIProperty
|
||||
QueryInterface: function cIB_gPE_gN_QueryInterface(aIID) {
|
||||
return doQueryInterface(this, null, aIID, [Components.interfaces.nsIProperty]);
|
||||
},
|
||||
name: paramName,
|
||||
value: parameters[paramName]
|
||||
};
|
||||
}
|
||||
};
|
||||
},
|
||||
|
||||
// void getAttendees(out PRUint32 count,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,93 @@
|
|||
/* ***** 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
|
||||
* Philipp Kewisch <mozilla@kewis.ch>
|
||||
* Portions created by the Initial Developer are Copyright (C) 2009
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
*
|
||||
* 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 ***** */
|
||||
|
||||
function run_test() {
|
||||
let event = createEventFromIcalString(
|
||||
"BEGIN:VEVENT\n" +
|
||||
"UID:182d2719-fe2a-44c1-9210-0286b16c0538\n" +
|
||||
"X-FOO;X-BAR=BAZ:QUUX\n" +
|
||||
"END:VEVENT");
|
||||
|
||||
// Test getters for imported event
|
||||
do_check_eq(event.getProperty("X-FOO"), "QUUX");
|
||||
do_check_true(event.hasProperty("X-FOO"));
|
||||
do_check_eq(event.getPropertyParameter("X-FOO", "X-BAR"), "BAZ");
|
||||
do_check_true(event.hasPropertyParameter("X-FOO", "X-BAR"));
|
||||
|
||||
// Test setters
|
||||
let (passed = false) {
|
||||
try {
|
||||
event.setPropertyParameter("X-UNKNOWN", "UNKNOWN", "VALUE");
|
||||
} catch (e) {
|
||||
passed = true;
|
||||
}
|
||||
if (!passed) {
|
||||
do_throw("Setting parameter on unset property unexpectedly succeeded");
|
||||
}
|
||||
}
|
||||
|
||||
// More setters
|
||||
event.setPropertyParameter("X-FOO", "X-BAR", "FNORD");
|
||||
do_check_eq(event.getPropertyParameter("X-FOO", "X-BAR"), "FNORD");
|
||||
do_check_neq(event.icalString.match(/^X-FOO;X-BAR=FNORD:QUUX$/m), null);
|
||||
|
||||
// Enumerator
|
||||
let (passed = false) {
|
||||
try {
|
||||
event.getParameterEnumerator("X-UNKNOWN");
|
||||
} catch (e) {
|
||||
passed = true;
|
||||
}
|
||||
if (!passed) {
|
||||
do_throw("Getting parameter enumerator on unset property unexpectedly succeeded");
|
||||
}
|
||||
}
|
||||
|
||||
// More enumerator
|
||||
let enum = event.getParameterEnumerator("X-FOO");
|
||||
do_check_true(enum.hasMoreElements());
|
||||
let xbar = enum.getNext().QueryInterface(Components.interfaces.nsIProperty);
|
||||
do_check_eq(xbar.name, "X-BAR");
|
||||
do_check_eq(xbar.value, "FNORD");
|
||||
do_check_false(enum.hasMoreElements());
|
||||
|
||||
// Deletion of parameters when deleting properties
|
||||
event.deleteProperty("X-FOO");
|
||||
do_check_false(event.hasProperty("X-FOO"));
|
||||
event.setProperty("X-FOO", "SNORK");
|
||||
do_check_eq(event.getProperty("X-FOO"), "SNORK");
|
||||
do_check_eq(event.getPropertyParameter("X-FOO", "X-BAR"), null);
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче