Skip to content

feat: parse and persist plural default calendar alarms #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rich0 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: parse and persist plural default calendar alarms #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/models/calendar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ const debug = debugFactory('Calendar')
* - timezone
* - defaultAlarmPartDay
* - defaultAlarmFullDay
* - defaultAlarmsPartDay
* - defaultAlarmsFullDay
* - transparency
* - components
*
Expand All @@ -58,6 +60,8 @@ export class Calendar extends davCollectionPublishable(davCollectionShareable(Da
super._exposeProperty('transparency', NS.IETF_CALDAV, 'schedule-calendar-transp', true)
super._exposeProperty('defaultAlarmPartDay', NS.NEXTCLOUD, 'default-alarm-part-day', true)
super._exposeProperty('defaultAlarmFullDay', NS.NEXTCLOUD, 'default-alarm-full-day', true)
super._exposeProperty('defaultAlarmsPartDay', NS.NEXTCLOUD, 'default-alarms-part-day', true)
super._exposeProperty('defaultAlarmsFullDay', NS.NEXTCLOUD, 'default-alarms-full-day', true)
}

/**
Expand Down Expand Up @@ -288,6 +292,8 @@ export class Calendar extends davCollectionPublishable(davCollectionShareable(Da
[NS.OWNCLOUD, 'calendar-enabled'],
[NS.NEXTCLOUD, 'default-alarm-part-day'],
[NS.NEXTCLOUD, 'default-alarm-full-day'],
[NS.NEXTCLOUD, 'default-alarms-part-day'],
[NS.NEXTCLOUD, 'default-alarms-full-day'],
[NS.NEXTCLOUD, 'owner-displayname'],
[NS.NEXTCLOUD, 'trash-bin-retention-duration'],
[NS.NEXTCLOUD, 'deleted-at'],
Expand Down
28 changes: 28 additions & 0 deletions src/parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ export default class Parser {
this.registerParser('{http://owncloud.org/ns}read-only', Parser.bool)
this.registerParser('{http://nextcloud.com/ns}default-alarm-part-day', Parser.decInt)
this.registerParser('{http://nextcloud.com/ns}default-alarm-full-day', Parser.decInt)
this.registerParser('{http://nextcloud.com/ns}default-alarms-part-day', Parser.defaultAlarms)
this.registerParser('{http://nextcloud.com/ns}default-alarms-full-day', Parser.defaultAlarms)
this.registerParser('{http://nextcloud.com/ns}owner-displayname', Parser.text)
this.registerParser('{http://nextcloud.com/ns}deleted-at', Parser.iso8601DateTime)
this.registerParser('{http://nextcloud.com/ns}calendar-uri', Parser.text)
Expand Down Expand Up @@ -595,6 +597,32 @@ export default class Parser {
* @param {XPathNSResolver} resolver
* @return {string[]}
*/
/**
* Parses a {http://nextcloud.com/ns}default-alarms-* Node (JSON array of alarm templates)
*
* @param {Document} document
* @param {Node} node
* @param {XPathNSResolver} resolver
* @return {Array|null}
*/
static defaultAlarms(document, node, resolver) {
const text = Parser.text(document, node, resolver)
if (text === null || text === '') {
return null
}

try {
const parsed = JSON.parse(text)
if (!Array.isArray(parsed) || parsed.length === 0) {
return null
}

return parsed
} catch (error) {
return null
}
}

static ocAccess(document, node, resolver) {
const result = []
const privileges = document.evaluate('oc:access/*', node, resolver, XPathResult.ANY_TYPE, null)
Expand Down
14 changes: 14 additions & 0 deletions src/propset/calendarPropSet.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import * as NS from '../utility/namespaceUtility.js'
* - {http://owncloud.org/ns}calendar-enabled
* - {http://nextcloud.com/ns}default-alarm-part-day
* - {http://nextcloud.com/ns}default-alarm-full-day
* - {http://nextcloud.com/ns}default-alarms-part-day
* - {http://nextcloud.com/ns}default-alarms-full-day
*
* @param {object} props
* @return {object}
Expand Down Expand Up @@ -85,6 +87,18 @@ export default function calendarPropSet(props) {
value,
})
break
case '{http://nextcloud.com/ns}default-alarms-part-day':
xmlified.push({
name: [NS.NEXTCLOUD, 'default-alarms-part-day'],
value: Array.isArray(value) ? JSON.stringify(value) : value,
})
break
case '{http://nextcloud.com/ns}default-alarms-full-day':
xmlified.push({
name: [NS.NEXTCLOUD, 'default-alarms-full-day'],
value: Array.isArray(value) ? JSON.stringify(value) : value,
})
break
case '{urn:ietf:params:xml:ns:caldav}schedule-calendar-transp':
xmlified.push({
name: [NS.IETF_CALDAV, 'schedule-calendar-transp'],
Expand Down
17 changes: 17 additions & 0 deletions test/unit/models/calendarTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,23 @@ END:VCALENDAR
expect(calendar.defaultAlarmFullDay).toEqual(39600);
});

it('should inherit expose the property defaultAlarmsPartDay', () => {
const parent = new DavCollectionMock();
const request = new RequestMock();
const url = '/foo/bar/folder';
const props = returnDefaultProps();
props['{http://nextcloud.com/ns}default-alarms-part-day'] = [
{ trigger: -86400, action: 'EMAIL' },
{ trigger: -900, action: 'DISPLAY' },
];

const calendar = new Calendar(parent, request, url, props);
expect(calendar.defaultAlarmsPartDay).toEqual([
{ trigger: -86400, action: 'EMAIL' },
{ trigger: -900, action: 'DISPLAY' },
]);
});

it('should find all VObjects', () => {
const parent = new DavCollectionMock();
const request = new RequestMock();
Expand Down
25 changes: 25 additions & 0 deletions test/unit/parserTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1907,6 +1907,31 @@ END:VALARM`);
expect(parser.parse(document, node, resolver)).toEqual(32400);
});

it('should properly handle {http://nextcloud.com/ns}default-alarms-part-day', () => {
const parser = new Parser();

const xml = `<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:" xmlns:nc="http://nextcloud.com/ns">
<D:response>
<D:href>/foo</D:href>
<D:propstat>
<D:prop>
<nc:default-alarms-part-day>[{"trigger":-86400,"action":"EMAIL"},{"trigger":-900,"action":"DISPLAY"}]</nc:default-alarms-part-day>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>`;

const [document, node, resolver] = getDocumentNodeResolverFromXML(xml);

expect(parser.canParse('{http://nextcloud.com/ns}default-alarms-part-day')).toEqual(true);
expect(parser.parse(document, node, resolver)).toEqual([
{ trigger: -86400, action: 'EMAIL' },
{ trigger: -900, action: 'DISPLAY' },
]);
});

it('should properly handle {http://nextcloud.com/ns}default-alarm-full-day', () => {
const parser = new Parser();

Expand Down
15 changes: 15 additions & 0 deletions test/unit/propset/calendarPropSetTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,21 @@ describe('Calendar prop-set', () => {
]);
});

it('should serialize {http://nextcloud.com/ns}default-alarms-part-day correctly', () => {
const alarms = [
{ trigger: -86400, action: 'EMAIL' },
{ trigger: -900, action: 'DISPLAY' },
];
expect(calendarPropSet({
'{http://nextcloud.com/ns}default-alarms-part-day': alarms,
})).toEqual([
{
name: ['http://nextcloud.com/ns', 'default-alarms-part-day'],
value: JSON.stringify(alarms),
},
]);
});

it('should serialize {urn:ietf:params:xml:ns:caldav}schedule-calendar-transp correctly - transparent', () => {
expect(calendarPropSet({
'{Foo:}bar': 123,
Expand Down