source/objects/CalDAV/CalDAV.h

   1 // CalDAV.h - CalDAV Connection Object header.
   2 //
   3 // (c) 2016 Xestia Software Development.
   4 //
   5 // This file is part of Xestia Calendar.
   6 //
   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.
  10 //
  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.
  15 //
  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/>
  18
  19 #ifndef __OBJECTS_CALDAV_CALDAV_H__
  20 #define __OBJECTS_CALDAV_CALDAV_H__
  21
  22 #include <curl/curl.h>
  23 #include <libxml/parser.h>
  24 #include <libxml/tree.h>
  25 #include <string>
  26 #include <iostream>
  27 #include <vector>
  28 #include <stdexcept>
  29
  30 using namespace std;
  31
  32 // CalDAVConnectionData: used for
  33 // connecting to the server.
  34
  35 enum CalDAVQueryResult {
  36         CALDAVQUERYRESULT_UNITTESTFAIL = -1,
  37         CALDAVQUERYRESULT_OK,
  38         CALDAVQUERYRESULT_NOTRUN,
  39         CALDAVQUERYRESULT_SERVERERROR
  40 };
  41
  42 struct CalDAVCalendarList {
  43
  44 };
  45
  46 struct CalDAVConnectionData{
  47
  48         string Hostname = "";
  49         int Port = 8008;
  50         string Username = "";
  51         string Password = "";
  52         string Prefix = "";
  53         bool UseSSL = true;
  54         int Timeout = 60;
  55
  56 };
  57
  58 // CalDAVStatusData: used for
  59 // getting the current server
  60 // settings for the CalDAV
  61 // object.
  62
  63 struct CalDAVStatus{
  64
  65         string Hostname;
  66         int Port;
  67         string Username;
  68         string Prefix;
  69         bool UseSSL;
  70         int Timeout;
  71
  72 };
  73
  74 // CalDAVServerSupport: used for
  75 // getting what the server supports
  76 // from the CalDAV specification.
  77
  78 struct CalDAVServerSupport{
  79
  80         // Variable name.                          Name in CalDAV header.
  81
  82         bool BasicSupport = false;              // calendar-access
  83
  84 };
  85
  86 // CalDAVServerResult: used for
  87 // getting the result of the
  88 // request made via the CalDAV
  89 // object.
  90
  91 struct CalDAVServerResult{
  92
  93         CalDAVQueryResult Result = CALDAVQUERYRESULT_NOTRUN;
  94         CURLcode Code = CURLE_OK;
  95         long HTTPCode = 0;
  96
  97 };
  98
  99 // CalDAVSendData: used for
 100 // sending data to the CaLDAV
 101 // server.
 102
 103 struct CalDAVSendData{
 104         string *readptr;
 105         long sizeleft;
 106         int seek = 0;
 107 };
 108
 109 class CalDAV{
 110
 111         private:
 112                 string ProcessXMLUserPrincipal();
 113                 string ProcessXMLCalendarHome();
 114                 bool MatchXMLName(xmlNodePtr *NodePtr, string NodeName);
 115                 string FetchXMLData(xmlNodePtr *NodePtr);
 116
 117                 CalDAVConnectionData ConnectionData;
 118                 CalDAVServerResult ConnectionServerResult;
 119                 CURL *ConnectionHandle = nullptr;
 120                 string ServerData = "";
 121                 string ServerHeader = "";
 122
 123         public:
 124                 CalDAV();
 125                 ~CalDAV();
 126                 void SetupConnectionData(CalDAVConnectionData *ConnData);
 127                 CalDAVStatus GetConnectionData();
 128                 CalDAVServerResult Connect();
 129                 CalDAVServerResult GetServerResult();
 130                 CalDAVServerSupport GetServerSupport();
 131                 CalDAVCalendarList GetCalendars();
 132
 133                 string GetUserPrincipal();
 134                 string GetCalendarHome(string UserPrincipalURI);
 135
 136 };
 137
 138 // Subroutines that are used with the
 139 // CalDAVConnectionData struct.
 140
 141 bool CalDAVObjectValidSettings(CalDAVConnectionData *ConnData);
 142 string BuildServerAddress(CalDAVConnectionData *ConnData, string URIAddress);
 143
 144 #endif