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 <string>
  24 #include <iostream>
  25 #include <vector>
  26 #include <stdexcept>
  27
  28 using namespace std;
  29
  30 // CalDAVConnectionData: used for
  31 // connecting to the server.
  32
  33 enum CalDAVQueryResult {
  34         CALDAVQUERYRESULT_UNITTESTFAIL = -1,
  35         CALDAVQUERYRESULT_OK,
  36         CALDAVQUERYRESULT_NOTRUN,
  37         CALDAVQUERYRESULT_SERVERERROR
  38 };
  39
  40 struct CalDAVConnectionData{
  41
  42         string Hostname = "";
  43         int Port = 8008;
  44         string Username = "";
  45         string Password = "";
  46         string Prefix = "";
  47         bool UseSSL = true;
  48         int Timeout = 60;
  49
  50 };
  51
  52 // CalDAVStatusData: used for
  53 // getting the current server
  54 // settings for the CalDAV
  55 // object.
  56
  57 struct CalDAVStatus{
  58
  59         string Hostname;
  60         int Port;
  61         string Username;
  62         string Prefix;
  63         bool UseSSL;
  64         int Timeout;
  65
  66 };
  67
  68 // CalDAVServerSupport: used for
  69 // getting what the server supports
  70 // from the CalDAV specification.
  71
  72 struct CalDAVServerSupport{
  73
  74         // Variable name.                          Name in CalDAV header.
  75
  76         bool BasicSupport = false;              // calendar-access
  77
  78 };
  79
  80 // CalDAVServerResult: used for
  81 // getting the result of the
  82 // request made via the CalDAV
  83 // object.
  84
  85 struct CalDAVServerResult{
  86
  87         CalDAVQueryResult Result = CALDAVQUERYRESULT_NOTRUN;
  88         CURLcode Code = CURLE_OK;
  89         long HTTPCode = 0;
  90
  91 };
  92
  93 class CalDAV{
  94
  95         private:
  96                 CalDAVConnectionData ConnectionData;
  97                 CURL *ConnectionHandle = nullptr;
  98                 string ServerData = "";
  99                 string ServerHeader = "";
 100
 101         public:
 102                 void SetupConnectionData(CalDAVConnectionData *ConnData);
 103                 CalDAVStatus GetConnectionData();
 104                 CalDAVServerResult Connect();
 105                 CalDAVServerSupport GetServerSupport();
 106                 CalDAV();
 107                 ~CalDAV();
 108
 109 };
 110
 111 // Subroutines that are used with the
 112 // CalDAVConnectionData struct.
 113
 114 bool CalDAVObjectValidSettings(CalDAVConnectionData *ConnData);
 115 string BuildServerAddress(CalDAVConnectionData *ConnData, string URIAddress);
 116
 117 #endif