1 // CalDAV.h - CalDAV Connection Object header.
3 // (c) 2016 Xestia Software Development.
5 // This file is part of Xestia Calendar.
7 // Xestia Address Book is free software: you can redistribute it and/or modify
8 // it under the terms of the GNU General Public License as published by the
9 // Free Software Foundation, version 3 of the license.
11 // Xestia Address Book is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License along
17 // with Xestia Calendar. If not, see <http://www.gnu.org/licenses/>
19 #ifndef __OBJECTS_CALDAV_CALDAV_H__
20 #define __OBJECTS_CALDAV_CALDAV_H__
22 #include <curl/curl.h>
23 #include <libxml/parser.h>
24 #include <libxml/tree.h>
30 #include "../../common/colour.h"
31 #include "../../common/text.h"
32 #include "../../common/uuid.h"
36 // CalDAVConnectionData: used for
37 // connecting to the server.
39 enum CalDAVQueryResult {
40 CALDAVQUERYRESULT_UNITTESTFAIL = -1,
42 CALDAVQUERYRESULT_NOTRUN,
43 CALDAVQUERYRESULT_SERVERERROR
46 struct CalDAVCalendarList {
51 map<int,string> Description;
52 map<int,Colour> CalColour;
54 map<int,string> TagURL;
60 struct CalDAVConnectionData{
72 // CalDAVStatusData: used for
73 // getting the current server
74 // settings for the CalDAV
88 // CalDAVServerSupport: used for
89 // getting what the server supports
90 // from the CalDAV specification.
92 struct CalDAVServerSupport{
94 // Variable name. Name in CalDAV header.
96 bool BasicSupport = false; // calendar-access
100 // CalDAVServerResult: used for
101 // getting the result of the
102 // request made via the CalDAV
105 struct CalDAVServerResult{
107 CalDAVQueryResult Result = CALDAVQUERYRESULT_NOTRUN;
108 CURLcode Code = CURLE_OK;
113 // CalDAVSendData: used for
114 // sending data to the CaLDAV
117 struct CalDAVSendData{
126 string ProcessXMLUserPrincipal();
127 string ProcessXMLCalendarHome();
128 CalDAVCalendarList ProcessXMLCalendarList();
129 string ProcessXMLEntryETag();
130 bool MatchXMLNameTransverse(xmlNodePtr *NodePtr, string NodeName);
131 bool MatchXMLName(xmlNodePtr *NodePtrOriginal, string NodeName);
132 string FetchXMLData(xmlNodePtr *NodePtr);
133 CalDAVServerResult EditCalendarProcess(string *CalendarHREF,
134 string *CalendarName,
135 Colour *CalendarColour,
136 string *CalendarDescription,
139 CalDAVConnectionData ConnectionData;
140 CalDAVServerResult ConnectionServerResult;
141 CURL *ConnectionHandle = nullptr;
142 string ServerData = "";
143 string ServerHeader = "";
148 void SetupConnectionData(CalDAVConnectionData *ConnData);
149 CalDAVStatus GetConnectionData();
150 CalDAVServerResult Connect();
151 CalDAVServerResult GetServerResult();
152 CalDAVServerSupport GetServerSupport();
153 CalDAVCalendarList GetCalendars();
155 CalDAVServerResult AddCalendar(string CalendarName);
156 CalDAVServerResult AddCalendar(string *CalendarName, string *CalendarShortName);
158 CalDAVServerResult EditCalendar(string *CalendarHREF,
159 string *CalendarName,
160 Colour *CalendarColour,
161 string *CalendarDescription,
163 CalDAVServerResult EditCalendar(string *CalendarHREF,
164 Colour *CalendarColour);
165 CalDAVServerResult EditCalendar(string *CalendarHREF,
166 string *CalendarName);
167 CalDAVServerResult EditCalendar(string *CalendarHREF,
169 CalDAVServerResult EditCalendarDescription(string *CalendarHREF,
170 string *CalendarDescription);
172 CalDAVServerResult DeleteCalendar(string *CalendarHREF);
174 CalDAVServerResult AddEntry(string *CalendarEntryHREF, string *EntryData);
175 CalDAVServerResult EditEntry(string *CalendarEntryHREF, string *EntryData, string *EntryETag);
176 CalDAVServerResult DeleteEntry(string *CalendarEntryHREF);
178 string GetUserPrincipal();
179 string GetCalendarHome(string UserPrincipalURI);
181 CalDAVServerResult GetEntryETag(string *CalendarEntryHREF, string *ETagValue);
185 // Subroutines that are used with the
186 // CalDAVConnectionData struct.
188 bool CalDAVObjectValidSettings(CalDAVConnectionData *ConnData);
189 string BuildServerAddress(CalDAVConnectionData *ConnData, string URIAddress);