source/objects/CalDAV/CalDAV.cpp

   1 // CalDAV.cpp - CalDAV Connection Object.
   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 #include "CalDAV.h"
  20
  21 using namespace std;
  22
  23 size_t CalDAVReceive(char *ReceivedBuffer, size_t Size, size_t NewMemoryBytes, string *StringPointer)
  24 {
  25
  26         string ReceivedBufferString = "";
  27         ReceivedBufferString.append(ReceivedBuffer, NewMemoryBytes);
  28
  29         StringPointer->append(ReceivedBufferString);
  30
  31         return Size * NewMemoryBytes;
  32
  33 }
  34
  35 size_t CalDAVSend(char *SendBuffer, size_t Size, size_t NewMemoryBytes, void *DataStruct){
  36
  37         struct CalDAVSendData *UploadPtr = (struct CalDAVSendData *)DataStruct;
  38
  39         if (UploadPtr->sizeleft){
  40
  41                 UploadPtr->sizeleft--;
  42                 char CharSend;
  43
  44                 CharSend = (*UploadPtr->readptr)[UploadPtr->seek];
  45
  46                 *SendBuffer = CharSend;
  47
  48                 UploadPtr->seek++;
  49
  50                 return 1;
  51
  52         }
  53
  54         return 0;
  55
  56 }
  57
  58 CalDAV::CalDAV(){
  59
  60         // Setup the objects within the CalDAV connection
  61         // object.
  62
  63         ConnectionHandle = curl_easy_init();
  64
  65 }
  66
  67 CalDAV::~CalDAV(){
  68
  69         // Destory the objects within the CalDAV connection
  70         // object.
  71
  72         curl_easy_cleanup(ConnectionHandle);
  73         ConnectionHandle = nullptr;
  74
  75 }
  76
  77 void CalDAV::SetupConnectionData(CalDAVConnectionData *ConnData){
  78
  79         // Check if ConnData is a nullptr, return if it is.
  80
  81         if (ConnData == nullptr){
  82                 return;
  83         }
  84
  85         // Set the connection settings to the values from ConnData.
  86
  87         ConnectionData = (*ConnData);
  88
  89 }
  90
  91 CalDAVStatus CalDAV::GetConnectionData(){
  92
  93         // Get the current connection settings for the CalDAV
  94         // connection object and return a CalDAVStatus object.
  95
  96         CalDAVStatus ConnectionStatus;
  97
  98         ConnectionStatus.Hostname = ConnectionData.Hostname;
  99         ConnectionStatus.Port = ConnectionData.Port;
 100         ConnectionStatus.Username = ConnectionData.Username;
 101         ConnectionStatus.Prefix = ConnectionData.Prefix;
 102         ConnectionStatus.UseSSL = ConnectionData.UseSSL;
 103         ConnectionStatus.Timeout = ConnectionData.Timeout;
 104
 105         return ConnectionStatus;
 106
 107 }
 108
 109 CalDAVServerResult CalDAV::Connect(){
 110
 111         CalDAVServerResult ServerResult;
 112
 113         string ServerAddress = "";
 114         string ServerUserPass = "";
 115
 116         // Setup the server address.
 117
 118         ServerAddress = BuildServerAddress(&ConnectionData, "/principals/");
 119
 120         // Setup the server password.
 121
 122         ServerUserPass += ConnectionData.Username;
 123         ServerUserPass += ":";
 124         ServerUserPass += ConnectionData.Password;
 125
 126         curl_easy_setopt(ConnectionHandle, CURLOPT_URL, ServerAddress.c_str());
 127         curl_easy_setopt(ConnectionHandle, CURLOPT_USERPWD, ServerUserPass.c_str());
 128         curl_easy_setopt(ConnectionHandle, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
 129         curl_easy_setopt(ConnectionHandle, CURLOPT_FAILONERROR, 1L);
 130         curl_easy_setopt(ConnectionHandle, CURLOPT_TIMEOUT, ConnectionData.Timeout);
 131         curl_easy_setopt(ConnectionHandle, CURLOPT_WRITEFUNCTION, CalDAVReceive);
 132         curl_easy_setopt(ConnectionHandle, CURLOPT_WRITEDATA, &ServerData);
 133         curl_easy_setopt(ConnectionHandle, CURLOPT_WRITEHEADER, &ServerHeader);
 134
 135         // Connect to the CalDAV server.
 136
 137         ServerResult.Code = curl_easy_perform(ConnectionHandle);
 138
 139         // Process the result received from the server.
 140
 141         if (ServerResult.Code != CURLE_OK){
 142
 143                 ServerResult.Result = CALDAVQUERYRESULT_SERVERERROR;
 144
 145         } else {
 146
 147                 ServerResult.Result = CALDAVQUERYRESULT_OK;
 148
 149         }
 150
 151         // Get the HTTP code.
 152
 153         curl_easy_getinfo(ConnectionHandle, CURLINFO_RESPONSE_CODE, &ServerResult.HTTPCode);
 154
 155         return ServerResult;
 156
 157 }
 158
 159 CalDAVServerResult CalDAV::GetServerResult(){
 160
 161         return ConnectionServerResult;
 162
 163 }
 164
 165 CalDAVServerSupport CalDAV::GetServerSupport(){
 166
 167         CalDAVServerSupport ServerStatus;
 168
 169         // Setup the server connection.
 170
 171         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, "OPTIONS");
 172
 173         CURLcode ServerResult = curl_easy_perform(ConnectionHandle);
 174
 175         // Set the results.
 176
 177         if (ServerResult == CURLE_OK){
 178                 ConnectionServerResult.Result = CALDAVQUERYRESULT_OK;
 179         } else {
 180                 ConnectionServerResult.Result = CALDAVQUERYRESULT_SERVERERROR;
 181         }
 182         ConnectionServerResult.Code = ServerResult;
 183         curl_easy_getinfo(ConnectionHandle, CURLINFO_RESPONSE_CODE, &ConnectionServerResult.HTTPCode);
 184
 185         if (ServerResult != CURLE_OK){
 186                 return ServerStatus;
 187         }
 188
 189         // Check that the server header has data in,
 190         // otherwise return an "empty" CalDAVServerSupport.
 191
 192         if (ServerHeader.size() == 0){
 193                 return ServerStatus;
 194         }
 195
 196         // Process each line looking for the first DAV header
 197         // line.
 198
 199         bool NewlineMode = true;
 200
 201         string DAVLine;
 202
 203         for (int CharSeek = 0; CharSeek < ServerHeader.size(); CharSeek++){
 204
 205                 if (NewlineMode == true){
 206
 207                         // Check if we have reached the end of the string.
 208
 209                         if (CharSeek >= ServerHeader.size()){
 210
 211                                 break;
 212
 213                         }
 214
 215                         // Check the first four letters to make sure
 216                         // they are 'DAV:'.
 217
 218                         string DAVHeaderCheck = "";
 219
 220                         try {
 221                                 DAVHeaderCheck = ServerHeader.substr(CharSeek, 4);
 222                         }
 223
 224                         catch (out_of_range &oor){
 225                                 break;
 226                         }
 227
 228                         if (DAVHeaderCheck == "DAV:"){
 229
 230                                 CharSeek += 5;
 231
 232                                 for (; CharSeek < ServerHeader.size(); CharSeek++){
 233
 234                                         if (ServerHeader[CharSeek] == '\n'){
 235
 236                                                 break;
 237
 238                                         }
 239
 240                                         DAVLine.push_back(ServerHeader[CharSeek]);
 241
 242                                 }
 243
 244                                 break;
 245
 246                         }
 247
 248                         NewlineMode = false;
 249
 250                 }
 251
 252                 if (ServerHeader[CharSeek] == '\n'){
 253
 254                         NewlineMode = true;
 255
 256                 }
 257
 258         }
 259
 260         // Process the DAV line.
 261
 262         vector<string> DAVLineData;
 263         string DAVSegmentString;
 264
 265         for (int CharSeek = 0; CharSeek < DAVLine.size(); CharSeek++){
 266
 267                 if (DAVLine[CharSeek] == ' '){
 268                         continue;
 269                 }
 270
 271                 if (DAVLine[CharSeek] == ','){
 272
 273                         DAVLineData.push_back(DAVSegmentString);
 274                         DAVSegmentString.clear();
 275                         continue;
 276
 277                 }
 278
 279                 DAVSegmentString += DAVLine[CharSeek];
 280
 281         }
 282
 283         // Process the DAV values and set each value
 284         // to true as required.
 285
 286         for (int DAVItemSeek = 0;
 287                 DAVItemSeek < DAVLineData.size();
 288                 DAVItemSeek++){
 289
 290                 if (DAVLineData.at(DAVItemSeek) == "calendar-access"){
 291
 292                         ServerStatus.BasicSupport = true;
 293
 294                 }
 295
 296         }
 297
 298         // Reset the connection status.
 299
 300         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, NULL);
 301
 302         return ServerStatus;
 303
 304 }
 305
 306 string CalDAV::GetUserPrincipal(){
 307
 308         string CurrentUserPrincipal = "";
 309         string UserPrincipalRequest = "";
 310         CalDAVSendData UserPrincipalSendData;
 311
 312         UserPrincipalRequest = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 313         "<d:propfind xmlns:d=\"DAV:\">\n"
 314         " <d:prop>\n"
 315         "  <d:current-user-principal />\n"
 316         " </d:prop>\n"
 317         "</d:propfind>";
 318
 319         UserPrincipalSendData.readptr = &UserPrincipalRequest;
 320         UserPrincipalSendData.sizeleft = UserPrincipalRequest.size();
 321
 322         // Setup the header.
 323
 324         struct curl_slist *UserPrincipalRequestHeader = NULL;
 325
 326         UserPrincipalRequestHeader = curl_slist_append(UserPrincipalRequestHeader, "Depth: 0");
 327         UserPrincipalRequestHeader = curl_slist_append(UserPrincipalRequestHeader, "Prefer: return-minimal");
 328         UserPrincipalRequestHeader = curl_slist_append(UserPrincipalRequestHeader, "Content-Type: application/xml; charset=utf-8");
 329
 330         curl_easy_setopt(ConnectionHandle, CURLOPT_HTTPHEADER, UserPrincipalRequestHeader);
 331
 332         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, "PROPFIND");
 333         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 1L);
 334         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, &UserPrincipalSendData);
 335         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, CalDAVSend);
 336
 337         // Process the data.
 338
 339         ServerData.clear();
 340         ServerHeader.clear();
 341
 342         CURLcode ServerResult = curl_easy_perform(ConnectionHandle);
 343
 344         // Set the results.
 345
 346         if (ServerResult == CURLE_OK){
 347                 ConnectionServerResult.Result = CALDAVQUERYRESULT_OK;
 348         } else {
 349                 ConnectionServerResult.Result = CALDAVQUERYRESULT_SERVERERROR;
 350         }
 351         ConnectionServerResult.Code = ServerResult;
 352         curl_easy_getinfo(ConnectionHandle, CURLINFO_RESPONSE_CODE, &ConnectionServerResult.HTTPCode);
 353
 354         if (ServerResult != CURLE_OK){
 355
 356                 return CurrentUserPrincipal;
 357
 358         }
 359
 360         // Process the User Principal from the ServerData.
 361
 362         CurrentUserPrincipal = ProcessXMLUserPrincipal();
 363
 364         // Reset the changed settings.
 365
 366         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 0L);
 367         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, NULL);
 368         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, NULL);
 369
 370         return CurrentUserPrincipal;
 371
 372 }
 373
 374 string CalDAV::GetCalendarHome(string UserPrincipalURI){
 375
 376         string CalendarHomeURI = "";
 377
 378         // Build the Calendar Home URL address.
 379
 380         string CalendarHomeURL = BuildServerAddress(&ConnectionData, UserPrincipalURI);
 381
 382         // Setup the header request.
 383
 384         CalDAVSendData CalendarHomeSendData;
 385
 386         string CalendarHomeRequest = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 387         "<d:propfind xmlns:d=\"DAV:\" xmlns:c=\"urn:ietf:params:xml:ns:caldav\">\n"
 388         " <d:prop>\n"
 389         "  <c:calendar-home-set />\n"
 390         " </d:prop>\n"
 391         "</d:propfind>";
 392
 393         CalendarHomeSendData.readptr = &CalendarHomeRequest;
 394         CalendarHomeSendData.sizeleft = CalendarHomeRequest.size();
 395
 396         // Setup the header.
 397
 398         struct curl_slist *CalendarRequestHeader = NULL;
 399
 400         CalendarRequestHeader = curl_slist_append(CalendarRequestHeader, "Depth: 0");
 401         CalendarRequestHeader = curl_slist_append(CalendarRequestHeader, "Prefer: return-minimal");
 402         CalendarRequestHeader = curl_slist_append(CalendarRequestHeader, "Content-Type: application/xml; charset=utf-8");
 403
 404         curl_easy_setopt(ConnectionHandle, CURLOPT_HTTPHEADER, CalendarRequestHeader);
 405         curl_easy_setopt(ConnectionHandle, CURLOPT_URL, CalendarHomeURL.c_str());
 406         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, "PROPFIND");
 407         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 1L);
 408         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, &CalendarHomeSendData);
 409         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, CalDAVSend);
 410
 411         // Process the data.
 412
 413         ServerData.clear();
 414         ServerHeader.clear();
 415
 416         CURLcode ServerResult = curl_easy_perform(ConnectionHandle);
 417
 418         // Set the results.
 419
 420         if (ServerResult == CURLE_OK){
 421                 ConnectionServerResult.Result = CALDAVQUERYRESULT_OK;
 422         } else {
 423                 ConnectionServerResult.Result = CALDAVQUERYRESULT_SERVERERROR;
 424         }
 425         ConnectionServerResult.Code = ServerResult;
 426         curl_easy_getinfo(ConnectionHandle, CURLINFO_RESPONSE_CODE, &ConnectionServerResult.HTTPCode);
 427
 428         if (ServerResult != CURLE_OK){
 429
 430                 return CalendarHomeURI;
 431
 432         }
 433
 434         // Process the User Principal from the ServerData.
 435
 436         CalendarHomeURI = ProcessXMLCalendarHome();
 437
 438         // Reset the changed settings.
 439
 440         string OriginalServerAddress = BuildServerAddress(&ConnectionData, "/principals");
 441         curl_easy_setopt(ConnectionHandle, CURLOPT_URL, OriginalServerAddress.c_str());
 442
 443         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 0L);
 444         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, NULL);
 445         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, NULL);
 446
 447         return CalendarHomeURI;
 448
 449 }
 450
 451 CalDAVCalendarList CalDAV::GetCalendars(){
 452
 453         CalDAVCalendarList ServerList;
 454         CalDAVSendData CalendarListSendData;
 455
 456         // Build the server address.
 457
 458         string UserPrincipalURI = "";
 459         UserPrincipalURI = GetUserPrincipal();
 460
 461         if (UserPrincipalURI.size() == 0){
 462
 463                 return ServerList;
 464
 465         }
 466
 467         string CalendarHomeURI = "";
 468         CalendarHomeURI = GetCalendarHome(UserPrincipalURI);
 469
 470         string CalendarListURLAddress = BuildServerAddress(&ConnectionData, CalendarHomeURI);
 471
 472         string CalendarListRequest = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 473         "<d:propfind xmlns:d=\"DAV:\" xmlns:cs=\"http://calendarserver.org/ns/\""
 474         " xmlns:c=\"urn:ietf:params:xml:ns:caldav\" xmlns:x0=\"http://apple.com/ns/ical/\">\n"
 475         " <d:prop>\n"
 476         "  <d:resourcetype />\n"
 477         "  <d:displayname />\n"
 478         "  <x0:calendar-color />\n"
 479         "  <x0:calendar-order />\n"
 480         "  <cs:getctag />\n"
 481         "  <c:supported-calendar-component-set />\n"
 482         "  <c:calendar-description />\n"
 483         " </d:prop>\n"
 484         "</d:propfind>";
 485
 486         CalendarListSendData.readptr = &CalendarListRequest;
 487         CalendarListSendData.sizeleft = CalendarListRequest.size();
 488
 489         // Setup the header.
 490
 491         struct curl_slist *CalendarListRequestHeader = NULL;
 492
 493         CalendarListRequestHeader = curl_slist_append(CalendarListRequestHeader, "Depth: 1");
 494         CalendarListRequestHeader = curl_slist_append(CalendarListRequestHeader, "Prefer: return-minimal");
 495         CalendarListRequestHeader = curl_slist_append(CalendarListRequestHeader, "Content-Type: application/xml; charset=utf-8");
 496
 497         curl_easy_setopt(ConnectionHandle, CURLOPT_HTTPHEADER, CalendarListRequestHeader);
 498         curl_easy_setopt(ConnectionHandle, CURLOPT_URL, CalendarListURLAddress.c_str());
 499         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, "PROPFIND");
 500         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 1L);
 501         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, &CalendarListSendData);
 502         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, CalDAVSend);
 503
 504         // Process the data.
 505
 506         ServerData.clear();
 507         ServerHeader.clear();
 508
 509         CURLcode ServerResult = curl_easy_perform(ConnectionHandle);
 510
 511         //ServerList = ProcessXMLCalendarList();
 512
 513         // Restore the original settings.
 514
 515         string OriginalServerAddress = BuildServerAddress(&ConnectionData, "/principals");
 516         curl_easy_setopt(ConnectionHandle, CURLOPT_URL, OriginalServerAddress.c_str());
 517         curl_easy_setopt(ConnectionHandle, CURLOPT_CUSTOMREQUEST, NULL);
 518         curl_easy_setopt(ConnectionHandle, CURLOPT_UPLOAD, 0L);
 519         curl_easy_setopt(ConnectionHandle, CURLOPT_READDATA, NULL);
 520         curl_easy_setopt(ConnectionHandle, CURLOPT_READFUNCTION, NULL);
 521
 522         // Process the received XML data into a list of calendars
 523         // and locations.
 524
 525         if (ServerResult != CURLE_OK){
 526
 527                 return ServerList;
 528
 529         }
 530
 531         ServerList = ProcessXMLCalendarList();
 532
 533         return ServerList;
 534
 535 }
 536
 537 bool CalDAVObjectValidSettings(CalDAVConnectionData *ConnData){
 538
 539         // Check if the passed CalDAV Connection Data is has
 540         // an address set. Return false if nullptr is used.
 541
 542         if (ConnData == nullptr){
 543
 544                 return false;
 545
 546         }
 547
 548         // Check the server hostname. Return false
 549         // if no value has been set.
 550
 551         if (ConnData->Hostname.size() == 0){
 552
 553                 return false;
 554
 555         }
 556
 557         // Check the server port. Return false if
 558         // no value has been set or the port number
 559         // is less than 1 or higher than 65535.
 560
 561         if (ConnData->Port < 1 || ConnData->Port > 65535){
 562
 563                 return false;
 564
 565         }
 566
 567         // Check the server username. Return false
 568         // if no value has been set.
 569
 570         if (ConnData->Username.size() == 0){
 571
 572                 return false;
 573
 574         }
 575
 576         // Check the server password. Return false
 577         // if no value has been set.
 578
 579         if (ConnData->Password.size() == 0){
 580
 581                 return false;
 582
 583         }
 584
 585         // Cannot check UseSSL: It is either true
 586         // or false.
 587
 588         // Cannot check Prefix: The prefix may need
 589         // to be worked out first.
 590
 591         // No errors were found whilst checking so
 592         // return true.
 593
 594         return true;
 595
 596 }
 597
 598 string BuildServerAddress(CalDAVConnectionData *ConnData, string URIAddress){
 599
 600         string ServerAddress;
 601
 602         // Setup the server address.
 603
 604         if (ConnData->UseSSL == true){
 605                 ServerAddress += "https://";
 606         } else {
 607                 ServerAddress += "http://";
 608         }
 609
 610         ServerAddress += ConnData->Hostname;
 611
 612         // Check if server port is 80, otherwise
 613         // specifiy the port number in the address.
 614
 615         if (ConnData->Port != 80){
 616                 ServerAddress += ":";
 617                 ServerAddress += to_string(ConnData->Port);
 618         }
 619
 620         ServerAddress += URIAddress;
 621
 622         return ServerAddress;
 623
 624 }