-
Notifications
You must be signed in to change notification settings - Fork 8
/
property.js
532 lines (473 loc) · 12.3 KB
/
property.js
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
/**
* @copyright Copyright (c) 2019 Georg Ehrke
*
* @author Georg Ehrke <georg-nextcloud@ehrke.email>
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
import ExpectedICalJSError from '../errors/expectedICalJSError.js'
import Parameter from '../parameters/parameter.js'
import { createProperty } from '../factories/icalFactory.js'
import { lc, uc } from '../helpers/stringHelper.js'
import { getConstructorForICALType } from '../values/index.js'
import AbstractValue from '../values/abstractValue.js'
import DateTimeValue from '../values/dateTimeValue.js'
import lockableTrait from '../traits/lockable.js'
import observerTrait from '../traits/observer.js'
import ICAL from 'ical.js'
/**
* @class Property
* @classdesc This class represents a property as defined in RFC 5545 Section 3.5
*
* @url https://tools.ietf.org/html/rfc5545#section-3.5
* @url https://github.com/mozilla-comm/ical.js/blob/master/lib/ical/property.js
*/
export default class Property extends observerTrait(lockableTrait(class {})) {
/**
* Constructor
*
* @param {string} name The name of the property
* @param {string | number | AbstractValue | string[] | number[] | AbstractValue[] | null} value The value of the property
* @param {Parameter[] | [string][]} parameters Array of parameters
* @param {CalendarComponent|null} root The root of the calendar-document
* @param {AbstractComponent|null} parent The parent-element of this property
*/
constructor(name, value = null, parameters = [], root = null, parent = null) {
super()
/**
* Name of the property
*
* @type {string}
* @protected
*/
this._name = uc(name)
/**
* Value of the property
*
* @type {string | number | AbstractValue | string[] | number[] | AbstractValue[] | null}
* @protected
*/
this._value = value
/**
* List of parameters associated with this parameter
*
* @type {Map<string, Parameter>}
*/
this._parameters = new Map()
/**
* Root node of ical document
*
* @type {CalendarComponent|null}
* @protected
*/
this._root = root
/**
* Parent node
*
* @type {AbstractComponent|null}
* @protected
*/
this._parent = parent
this._setParametersFromConstructor(parameters)
if (value instanceof AbstractValue) {
value.subscribe(() => this._notifySubscribers())
}
}
/**
* Get property name
*
* @readonly
* @return {string}
*/
get name() {
return this._name
}
/**
* Get parameter value
*
* @return {string | number | AbstractValue | string[] | number[] | AbstractValue[] | null}
*/
get value() {
return this._value
}
/**
* Set new parameter value
*
* @param {string | number | AbstractValue | string[] | number[] | AbstractValue[] | null} value The value of the property
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
set value(value) {
this._modifyContent()
this._value = value
if (value instanceof AbstractValue) {
value.subscribe(() => this._notifySubscribers())
}
}
/**
* Gets the root of this property
*
* @return {CalendarComponent|null}
*/
get root() {
return this._root
}
/**
* Sets the root of this property
*
* @param {CalendarComponent|null} root The root of the calendar-document
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
set root(root) {
this._modify()
this._root = root
}
/**
* Gets the direct parent element of this property
*
* @return {AbstractComponent}
*/
get parent() {
return this._parent
}
/**
* Sets the direct parent element of this property
*
* @param {AbstractComponent|null} parent The parent element of this property
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
set parent(parent) {
this._modify()
this._parent = parent
}
/**
* Gets the first value of this property
*
* @return {null | string | number | AbstractValue}
*/
getFirstValue() {
if (!this.isMultiValue()) {
return this.value
} else {
if (this.value.length > 0) {
return this.value[0]
}
}
return null
}
/**
* Gets an iterator over all values
*/
* getValueIterator() {
if (this.isMultiValue()) {
yield * this.value.slice()[Symbol.iterator]()
} else {
yield this.value
}
}
/**
* Adds a value to the multi-value property
*
* @param {string | AbstractValue} value Value to add
*/
addValue(value) {
if (!this.isMultiValue()) {
throw new TypeError('This is not a multivalue property')
}
this._modifyContent()
this.value.push(value)
}
/**
* Checks if a value is inside this multi-value property
*
* @param {string | AbstractValue} value Value to check for
* @return {boolean}
*/
hasValue(value) {
if (!this.isMultiValue()) {
throw new TypeError('This is not a multivalue property')
}
return this.value.includes(value)
}
/**
* Removes a value from this multi-value property
*
* @param {string | AbstractValue} value Value to remove
*/
removeValue(value) {
if (!this.hasValue(value)) {
return
}
this._modifyContent()
const index = this.value.indexOf(value)
this.value.splice(index, 1)
}
/**
* Sets a parameter on this property
*
* @param {Parameter} parameter The parameter to set
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
setParameter(parameter) {
this._modify()
this._parameters.set(parameter.name, parameter)
parameter.subscribe(() => this._notifySubscribers())
}
/**
* Gets a parameter on this property by its name
*
* @param {string} parameterName Name of the parameter to get
* @return {Parameter}
*/
getParameter(parameterName) {
return this._parameters.get(uc(parameterName))
}
/**
* Gets an iterator over all available parameters
*/
* getParametersIterator() {
yield * this._parameters.values()
}
/**
* Get first value of a parameter
*
* @param {string} parameterName Name of the parameter
* @return {null | string}
*/
getParameterFirstValue(parameterName) {
const parameter = this.getParameter(parameterName)
if (parameter instanceof Parameter) {
if (parameter.isMultiValue()) {
return parameter.value[0]
} else {
return parameter.value
}
}
return null
}
/**
* Returns whether a parameter exists on this property
*
* @param {string} parameterName Name of the parameter
* @return {boolean}
*/
hasParameter(parameterName) {
return this._parameters.has(uc(parameterName))
}
/**
* Deletes a parameter on this property
*
* @param {string} parameterName Name of the parameter
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
deleteParameter(parameterName) {
this._modify()
this._parameters.delete(uc(parameterName))
}
/**
* update a parameter if it exists,
* create a new one if it doesn't
*
* @param {string} parameterName Name of the parameter
* @param {string|Array|null} value Value to set
* @throws {ModificationNotAllowedError} if property is locked for modification
*/
updateParameterIfExist(parameterName, value) {
this._modify()
if (this.hasParameter(parameterName)) {
const parameter = this.getParameter(parameterName)
parameter.value = value
} else {
const parameter = new Parameter(uc(parameterName), value)
this.setParameter(parameter)
}
}
/**
* Returns whether or not the value is a multivalue
*
* @return {boolean}
*/
isMultiValue() {
return Array.isArray(this._value)
}
/**
* Returns whether or not this valus is decorated
*
* @return {boolean}
*/
isDecoratedValue() {
if (this.isMultiValue()) {
return this._value[0] instanceof AbstractValue
} else {
return this._value instanceof AbstractValue
}
}
/**
* Marks this parameter is immutable
* locks it against further modification
*/
lock() {
super.lock()
for (const parameter of this.getParametersIterator()) {
parameter.lock()
}
if (this.isDecoratedValue()) {
for (const value of this.getValueIterator()) {
value.lock()
}
}
}
/**
* Marks this parameter as mutable
* allowing further modification
*/
unlock() {
super.unlock()
for (const parameter of this.getParametersIterator()) {
parameter.unlock()
}
if (this.isDecoratedValue()) {
for (const value of this.getValueIterator()) {
value.unlock()
}
}
}
/**
* Creates a copy of this parameter
*
* @return {Property}
*/
clone() {
const parameters = []
for (const parameter of this.getParametersIterator()) {
parameters.push(parameter.clone())
}
return new this.constructor(this.name, this._cloneValue(), parameters, this.root, this.parent)
}
/**
* Copies the values of this property
*
* @return {string | number | AbstractValue | string[] | number[] | AbstractValue[] | null}
* @protected
*/
_cloneValue() {
if (this.isDecoratedValue()) {
if (this.isMultiValue()) {
return this._value.map((val) => val.clone())
} else {
return this._value.clone()
}
} else {
if (this.isMultiValue()) {
// only copy array values, don't copy array reference
return this._value.slice()
} else {
return this._value
}
}
}
/**
* Sets parameters from the constructor
*
* @param {Parameter[] | [string][]} parameters Array of parameters to set
* @private
*/
_setParametersFromConstructor(parameters) {
parameters.forEach((parameter) => {
if (!(parameter instanceof Parameter)) {
parameter = new Parameter(parameter[0], parameter[1])
}
this.setParameter(parameter)
})
}
/**
* Creates a new Component based on an ical object
*
* @param {ICAL.Property} icalProperty The ical.js property to initialise from
* @param {CalendarComponent=} root The root of the calendar-document
* @param {AbstractComponent=} parent The parent element of this property
* @return {Property}
*/
static fromICALJs(icalProperty, root = null, parent = null) {
if (!(icalProperty instanceof ICAL.Property)) {
throw new ExpectedICalJSError()
}
let value
if (icalProperty.isDecorated) {
const constructor = getConstructorForICALType(icalProperty.getFirstValue().icaltype)
if (icalProperty.isMultiValue) {
value = icalProperty.getValues().map((val) => constructor.fromICALJs(val))
} else {
value = constructor.fromICALJs(icalProperty.getFirstValue())
}
} else {
if (icalProperty.isMultiValue) {
value = icalProperty.getValues()
} else {
value = icalProperty.getFirstValue()
}
}
const parameters = []
const paramNames = Object.keys(Object.assign({}, icalProperty.toJSON()[1]))
paramNames.forEach((paramName) => {
// Timezone id is handled by DateTimeValue
if (uc(paramName) === 'TZID') {
return
}
parameters.push([paramName, icalProperty.getParameter(paramName)])
})
return new this(icalProperty.name, value, parameters, root, parent)
}
/**
* Returns an ICAL.js property based on this Property
*
* @return {ICAL.Property}
*/
toICALJs() {
const icalProperty = createProperty(lc(this.name))
if (this.isMultiValue()) {
if (this.isDecoratedValue()) {
icalProperty.setValues(this.value.map((val) => val.toICALJs()))
} else {
icalProperty.setValues(this.value)
}
} else {
if (this.isDecoratedValue()) {
icalProperty.setValue(this.value.toICALJs())
} else {
icalProperty.setValue(this.value)
}
}
for (const parameter of this.getParametersIterator()) {
icalProperty.setParameter(lc(parameter.name), parameter.value)
}
const firstValue = this.getFirstValue()
if (firstValue instanceof DateTimeValue
&& firstValue.timezoneId !== 'floating'
&& firstValue.timezoneId !== 'UTC'
&& !firstValue.isDate) {
icalProperty.setParameter('tzid', firstValue.timezoneId)
}
return icalProperty
}
/**
* @inheritDoc
*/
_modifyContent() {
super._modifyContent()
this._notifySubscribers()
}
}