/usr/lib/thunderbird-addons/extensions/{e2fda1a4-762b-4020-b5ad-a41df1933103}/modules/calRecurrenceUtils.jsm is in xul-ext-lightning 1:24.4.0+build1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | /* 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://gre/modules/PluralForm.jsm");
Components.utils.import("resource://calendar/modules/calUtils.jsm");
EXPORTED_SYMBOLS = ["recurrenceRule2String", "splitRecurrenceRules", "checkRecurrenceRule"];
/**
* This function takes the recurrence info passed as argument and creates a
* literal string representing the repeat pattern in natural language.
*
* @param recurrenceInfo An item's recurrence info to parse.
* @param startDate The start date to base rules on.
* @param endDate The end date to base rules on.
* @param allDay If true, the pattern should assume an allday item.
* @return A human readable string describing the recurrence.
*/
function recurrenceRule2String(recurrenceInfo, startDate, endDate, allDay) {
function getRString(name, args) cal.calGetString("calendar-event-dialog", name, args);
// Retrieve a valid recurrence rule from the currently
// set recurrence info. Bail out if there's more
// than a single rule or something other than a rule.
recurrenceInfo = recurrenceInfo.clone();
let rrules = splitRecurrenceRules(recurrenceInfo);
if (rrules[0].length == 1) {
let rule = cal.wrapInstance(rrules[0][0], Components.interfaces.calIRecurrenceRule);
// currently we don't allow for any BYxxx-rules.
if (rule &&
!checkRecurrenceRule(rule, ['BYSECOND',
'BYMINUTE',
//'BYDAY',
'BYHOUR',
//'BYMONTHDAY',
'BYYEARDAY',
'BYWEEKNO',
//'BYMONTH',
'BYSETPOS'])) {
function day_of_week(day) {
return Math.abs(day) % 8;
}
function day_position(day) {
let dow = day_of_week(day);
return (Math.abs(day) - dow) / 8 * (day < 0 ? -1 : 1);
}
function nounClass(aDayString, aRuleString) {
// Select noun class (grammatical gender) for rule string
let nounClass = getRString(aDayString + "Nounclass");
return aRuleString + nounClass.substr(0, 1).toUpperCase() +
nounClass.substr(1);
}
function pluralWeekday(aDayString) {
let plural = getRString("pluralForWeekdays") == "true";
return (plural ? aDayString + "Plural" : aDayString);
}
let ruleString;
if (rule.type == 'DAILY') {
if (checkRecurrenceRule(rule, ['BYDAY'])) {
let days = rule.getComponent("BYDAY", {});
let weekdays = [2, 3, 4, 5, 6];
if (weekdays.length == days.length) {
let i;
for (i = 0; i < weekdays.length; i++) {
if (weekdays[i] != days[i]) {
break;
}
}
if (i == weekdays.length) {
ruleString = getRString("repeatDetailsRuleDaily4");
}
} else {
return null;
}
} else {
let dailyString = getRString("dailyEveryNth");
ruleString = PluralForm.get(rule.interval, dailyString)
.replace("#1", rule.interval);
}
} else if (rule.type == 'WEEKLY') {
// weekly recurrence, currently we
// support a single 'BYDAY'-rule only.
if (checkRecurrenceRule(rule, ['BYDAY'])) {
// create a string like 'Monday, Tuesday and Wednesday'
let days = rule.getComponent("BYDAY", {});
let weekdays = "";
// select noun class (grammatical gender) according to the
// first day of the list
let weeklyString = nounClass("repeatDetailsDay" + days[0], "weeklyNthOn");
for (let i = 0; i < days.length; i++) {
if (rule.interval == 1) {
weekdays += getRString(pluralWeekday("repeatDetailsDay" + days[i]));
} else {
weekdays += getRString("repeatDetailsDay" + days[i]);
}
if (days.length > 1 && i == (days.length - 2)) {
weekdays += ' ' + getRString("repeatDetailsAnd") + ' ';
} else if (i < days.length - 1) {
weekdays += ', ';
}
}
weeklyString = getRString(weeklyString, [weekdays]);
ruleString= PluralForm.get(rule.interval, weeklyString)
.replace("#2", rule.interval);
} else {
let weeklyString = getRString("weeklyEveryNth");
ruleString = PluralForm.get(rule.interval, weeklyString)
.replace("#1", rule.interval);
}
} else if (rule.type == 'MONTHLY') {
if (checkRecurrenceRule(rule, ['BYDAY'])) {
let weekdaysString_every = "";
let weekdaysString_position = "";
let byday = rule.getComponent("BYDAY", {});
let firstDay = byday[0];
// build two strings for weekdays with and without
// "position" prefix, then join these strings
for (let i = 0 ; i < byday.length; i++) {
if (day_position(byday[i]) == 0) {
if (!weekdaysString_every) {
firstDay = byday[i];
}
weekdaysString_every += getRString(pluralWeekday("repeatDetailsDay" + byday[i])) + ", ";
} else {
if (day_position(byday[i]) < -1 || day_position(byday[i]) > 5) {
// we support only weekdays with -1 as negative
// position ('THE LAST ...')
return null;
}
if (byday.some(function(element) {
return (day_position(element) == 0 &&
day_of_week(byday[i]) == day_of_week(element));
})) {
// prevent to build strings such as for example:
// "every Monday and the second Monday..."
continue;
}
let ordinalString = "repeatOrdinal" + day_position(byday[i]);
let dayString = "repeatDetailsDay" + day_of_week(byday[i]);
ordinalString = nounClass(dayString, ordinalString);
ordinalString = getRString(ordinalString);
dayString = getRString(dayString);
let stringOrdinalWeekday = getRString("ordinalWeekdayOrder",
[ordinalString, dayString]);
weekdaysString_position += stringOrdinalWeekday + ", ";
}
}
let weekdaysString = weekdaysString_every + weekdaysString_position;
weekdaysString = weekdaysString.slice(0,-2)
.replace(/,(?= [^,]*$)/, ' ' + getRString("repeatDetailsAnd"));
let monthlyString = weekdaysString_every ? "monthlyEveryOfEvery" : "monthlyRuleNthOfEvery";
monthlyString = nounClass("repeatDetailsDay" + day_of_week(firstDay), monthlyString);
monthlyString = getRString(monthlyString, [weekdaysString]);
ruleString = PluralForm.get(rule.interval, monthlyString).
replace("#2", rule.interval);
} else if (checkRecurrenceRule(rule, ['BYMONTHDAY'])) {
let component = rule.getComponent("BYMONTHDAY", {});
// First, find out if the 'BYMONTHDAY' component contains
// any elements with a negative value lesser than -1 ("the
// last day"). If so we currently don't support any rule
if (component.some(function(element, index, array) {
return element < -1;
})) {
// we don't support any other combination for now...
return getRString("ruleTooComplex");
} else {
if (component.length == 1 && component[0] == -1) {
// i.e. one day, the last day of the month
let monthlyString = getRString("monthlyLastDayOfNth");
ruleString = PluralForm.get(rule.interval, monthlyString)
.replace("#1", rule.interval);
} else if (component.length == 31 &&
component.every(function (element, index, array) {
for (let i = 0; i < array.length; i++) {
if ((index + 1) == array[i])
return true;
}
return false;
})) {
// i.e. every day every N months
ruleString = getRString("monthlyEveryDayOfNth");
ruleString = PluralForm.get(rule.interval, ruleString)
.replace("#2", rule.interval);
} else {
// i.e. one or more monthdays every N months
let day_string = "";
let lastDay = false;
for (let i = 0; i < component.length; i++) {
if (component[i] == -1) {
lastDay = true;
continue;
}
day_string += component[i] + ", ";
}
if (lastDay) {
day_string += getRString("monthlyLastDay") + ", ";
}
day_string = day_string.slice(0,-2)
.replace(/,(?= [^,]*$)/, ' ' + getRString("repeatDetailsAnd"));
let monthlyString = getRString("monthlyDayOfNth", [day_string]);
ruleString = PluralForm.get(rule.interval, monthlyString)
.replace("#2", rule.interval);
}
}
} else {
let monthlyString = getRString("monthlyDayOfNth", [startDate.day]);
ruleString = PluralForm.get(rule.interval, monthlyString)
.replace("#2", rule.interval);
}
} else if (rule.type == 'YEARLY') {
let bymonth = rule.getComponent("BYMONTH", {});
if (checkRecurrenceRule(rule, ['BYMONTH']) &&
checkRecurrenceRule(rule, ['BYMONTHDAY'])) {
let bymonthday = rule.getComponent("BYMONTHDAY", {});
if (bymonth.length == 1 && bymonthday.length == 1) {
let monthNameString = getRString("repeatDetailsMonth" + bymonth[0]);
let yearlyString = getRString("yearlyNthOn",
[monthNameString, bymonthday[0]]);
ruleString = PluralForm.get(rule.interval, yearlyString)
.replace("#3", rule.interval);
}
} else if (checkRecurrenceRule(rule, ['BYMONTH']) &&
checkRecurrenceRule(rule, ['BYDAY'])) {
let byday = rule.getComponent("BYDAY", {});
if (bymonth.length == 1 && byday.length == 1) {
let dayString = "repeatDetailsDay" + day_of_week(byday[0]);
let month = getRString("repeatDetailsMonth" + bymonth[0]);
if (day_position(byday[0]) == 0) {
let yearlyString = "yearlyOnEveryNthOfNth";
yearlyString = nounClass(dayString, yearlyString);
let day = getRString(pluralWeekday(dayString));
yearlyString = getRString(yearlyString, [day, month]);
ruleString = PluralForm.get(rule.interval, yearlyString)
.replace("#3", rule.interval);
} else {
let yearlyString = "yearlyNthOnNthOf";
let ordinalString = "repeatOrdinal" + day_position(byday[0])
yearlyString = nounClass(dayString, yearlyString);
ordinalString = nounClass(dayString, ordinalString);
let ordinal = getRString(ordinalString);
let day = getRString(dayString);
yearlyString = getRString(yearlyString, [ordinal, day, month]);
ruleString = PluralForm.get(rule.interval, yearlyString)
.replace("#4", rule.interval);
}
} else {
return null;
}
} else {
let monthNameString = getRString("repeatDetailsMonth" + (startDate.month + 1));
let yearlyString = getRString("yearlyNthOn",
[monthNameString, startDate.day]);
ruleString = PluralForm.get(rule.interval, yearlyString)
.replace("#3", rule.interval);
}
}
let kDefaultTimezone = cal.calendarDefaultTimezone();
let dateFormatter = cal.getDateFormatter();
let detailsString;
if (!endDate || allDay) {
if (rule.isFinite) {
if (rule.isByCount) {
let countString = getRString("repeatCountAllDay",
[ruleString,
dateFormatter.formatDateShort(startDate)]);
detailsString = PluralForm.get(rule.count, countString)
.replace("#3", rule.count);
} else {
let untilDate = rule.untilDate.getInTimezone(kDefaultTimezone);
detailsString = getRString("repeatDetailsUntilAllDay",
[ruleString,
dateFormatter.formatDateShort(startDate),
dateFormatter.formatDateShort(untilDate)]);
}
} else {
detailsString = getRString("repeatDetailsInfiniteAllDay",
[ruleString,
dateFormatter.formatDateShort(startDate)]);
}
} else {
if (rule.isFinite) {
if (rule.isByCount) {
let countString = getRString("repeatCount",
[ruleString,
dateFormatter.formatDateShort(startDate),
dateFormatter.formatTime(startDate),
dateFormatter.formatTime(endDate) ]);
detailsString = PluralForm.get(rule.count, countString)
.replace("#5", rule.count);
} else {
let untilDate = rule.untilDate.getInTimezone(kDefaultTimezone);
detailsString = getRString("repeatDetailsUntil",
[ruleString,
dateFormatter.formatDateShort(startDate),
dateFormatter.formatDateShort(untilDate),
dateFormatter.formatTime(startDate),
dateFormatter.formatTime(endDate)]);
}
} else {
detailsString = getRString("repeatDetailsInfinite",
[ruleString,
dateFormatter.formatDateShort(startDate),
dateFormatter.formatTime(startDate),
dateFormatter.formatTime(endDate) ]);
}
}
return detailsString;
}
}
return null;
}
/**
* Split rules into negative and positive rules.
*
* @param recurrenceInfo An item's recurrence info to parse.
* @return An array with two elements: an array of positive
* rules and an array of negative rules.
*/
function splitRecurrenceRules(recurrenceInfo) {
var ritems = recurrenceInfo.getRecurrenceItems({});
var rules = [];
var exceptions = [];
for each (var r in ritems) {
if (r.isNegative) {
exceptions.push(r);
} else {
rules.push(r);
}
}
return [rules, exceptions];
}
/**
* Check if a recurrence rule's component is valid.
*
* @see calIRecurrenceRule
* @param aRule The recurrence rule to check.
* @param aArray An array of component names to check.
* @return Returns true if the rule is valid.
*/
function checkRecurrenceRule(aRule, aArray) {
for each (var comp in aArray) {
var ruleComp = aRule.getComponent(comp, {});
if (ruleComp && ruleComp.length > 0) {
return true;
}
}
return false;
}
|