1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* Copyright (c) 2010 Timothy Pearson ([email protected])
* Copyright (c) 2008 Michael Rasmussen ([email protected])
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __CARDDAV_UTILS_H__
#define __CARDDAV_UTILS_H__
#include <glib.h>
#include <stdlib.h>
#include <curl/curl.h>
#include "carddav.h"
/**
* @typedef struct _CARDDAV_SETTINGS carddav_settings
* A pointer to a struct _CARDDAV_SETTINGS
*/
typedef struct _CARDDAV_SETTINGS carddav_settings;
/**
* @struct _CARDDAV_SETTINGS
* A struct used to exchange all user input between various parts
* of the library
*/
struct _CARDDAV_SETTINGS {
gchar* username;
gchar* password;
gchar* url;
gchar* file;
gboolean usehttps;
gboolean verify_ssl_certificate;
gchar* custom_cacert;
gboolean debug;
gboolean use_locking;
char trace_ascii;
CARDDAV_ACTION ACTION;
time_t start;
time_t end;
char use_uri;
};
/**
* @typedef struct MemoryStruct memory_ptr
* A pointer to a struct MemoryStruct
*/
typedef struct MemoryStruct memory_ptr;
/**
* @struct MemoryStruct
* Used to hold messages between the CardDAV server and the library
*/
struct MemoryStruct {
char *memory;
size_t size;
};
/** @struct config_data
* Used to exchange user options to the library
*/
struct config_data {
char trace_ascii;
};
/**
* This function is burrowed from the libcurl documentation
* @param text
* @param stream
* @param ptr
* @param size
* @param nohex
*/
void dump(const char* text, FILE* stream, char* ptr, size_t size, char nohex);
/**
* This function is burrowed from the libcurl documentation
* @param handle
* @param type
* @param data
* @param size
* @param userp
* @return
*/
int my_trace(CURL* handle, curl_infotype type, char* data, size_t size, void* userp);
/**
* This function is burrowed from the libcurl documentation
* @param ptr
* @param size
* @return void* to memory region
*/
size_t WriteMemoryCallback(void* ptr, size_t size, size_t nmemb, void* data);
/**
* This function is burrowed from the libcurl documentation
* @param ptr
* @param size
* @param nmemb
* @param data
* @return number of written bytes
*/
size_t WriteHeaderCallback(void* ptr, size_t size, size_t nmemb, void* data);
/*size_t ReadMemoryCallback(void* ptr, size_t size, size_t nmemb, void* data);*/
/**
* Initialize carddav settings structure.
* @param settings @see carddav_settings
*/
void init_carddav_settings(carddav_settings* settings);
/**
* Free momory assigned to carddav settings structure.
* @param settings @see carddav_settings
*/
void free_carddav_settings(carddav_settings* settings);
/**
* Parse URL
* @param settings @see carddav_settings
* @param url String containing URL to collection
*/
void parse_url(carddav_settings* settings, const char* url);
/**
* Find a specific HTTP header from last request
* @param header HTTP header to search for
* @param headers String of HTTP headers from last request
* @param lowcase Should string be returned in all lower case.
* @return The header found or NULL
*/
gchar* get_response_header(
const char* header, gchar* headers, gboolean lowcase);
/**
* Parse response from CardDAV server
* @param report Response from server
* @param element XML element to find
* @param type VCalendar element to find
* @return the parsed result
*/
gchar* parse_carddav_report(char* report, const char* element, const char* type);
/**
* Convert a time_t variable to CardDAV DateTime
* @param time a specific date and time
* @return the CardDAV DateTime
*/
gchar* get_carddav_datetime(time_t* time);
/**
* Create a random text string, using MD5. @see carddav_md5_hex_digest()
* @param text some text to randomize
* @return MD5 hash of text
*/
gchar* random_file_name(gchar* text);
/**
* Does the card contain a UID element or not. If not add it.
* @param object A specific card
* @return card, eventually added UID
*/
gchar* verify_uid(gchar* object);
/**
* Fetch a URL from a XML element
* @param text String
* @return URL
*/
gchar* get_url(gchar* text);
/**
* Fetch host from URL
* @param url URL
* @return host
*/
gchar* get_host(gchar* url);
/**
* Fetch the etag element from XML
* @param text String
* @return etag
*/
gchar* get_etag(gchar* text);
/**
* Fetch any element from XML
* @param text String
* @return element
*/
gchar* get_tag(const gchar* tag, gchar* text);
/**
* rebuild a raw URL with https if needed from the settings
* @param settings carddav_settings
* @return URL
*/
gchar* rebuild_url(carddav_settings* setting, gchar* uri);
/**
* Prepare a curl connection
* @param settings carddav_settings
* @return CURL
*/
CURL* get_curl(carddav_settings* setting);
#endif
|
