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
|
/* carddav_db.h -- abstract interface for per-user CardDAV database
*
* Copyright (c) 1994-2013 Carnegie Mellon University. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name "Carnegie Mellon University" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For permission or any legal
* details, please contact
* Carnegie Mellon University
* Center for Technology Transfer and Enterprise Creation
* 4615 Forbes Avenue
* Suite 302
* Pittsburgh, PA 15213
* (412) 268-7393, fax: (412) 268-7395
* innovation@andrew.cmu.edu
*
* 4. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by Computing Services
* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
*
* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
*/
#ifndef CARDDAV_DB_H
#define CARDDAV_DB_H
#include <config.h>
#include "auth.h"
#include "dav_db.h"
#include "mboxlist.h"
#include "strarray.h"
#include "util.h"
#include "vparse.h"
struct carddav_db;
#define CARDDAV_KIND_CONTACT 0
#define CARDDAV_KIND_GROUP 1
struct carddav_data {
struct dav_data dav; /* MUST be first so we can typecast */
unsigned version;
const char *vcard_uid;
unsigned kind;
const char *fullname;
const char *name;
const char *nickname;
int jmapversion;
const char *jmapdata;
strarray_t *emails;
strarray_t *member_uids;
};
enum carddav_sort {
CARD_SORT_NONE = 0,
CARD_SORT_MODSEQ,
CARD_SORT_UID,
CARD_SORT_FULLNAME,
CARD_SORT_DESC = 0x80 /* bit-flag for descending sort */
};
typedef int carddav_cb_t(void *rock, struct carddav_data *cdata);
/* prepare for carddav operations in this process */
int carddav_init(void);
/* done with all carddav operations for this process */
int carddav_done(void);
/* get a database handle corresponding to mailbox */
struct carddav_db *carddav_open_mailbox(struct mailbox *mailbox);
struct carddav_db *carddav_open_userid(const char *userid);
/* add another DB */
int carddav_set_otheruser(struct carddav_db *db, const char *userid);
/* close this handle */
int carddav_close(struct carddav_db *carddavdb);
/* lookup an entry from 'carddavdb' by resource
(optionally inside a transaction for updates) */
int carddav_lookup_resource(struct carddav_db *carddavdb,
const mbentry_t *mbentry, const char *resource,
struct carddav_data **result,
int tombstones);
/* lookup an entry from 'carddavdb' by mailbox and IMAP uid
(optionally inside a transaction for updates) */
int carddav_lookup_imapuid(struct carddav_db *carddavdb,
const mbentry_t *mbentry, int uid,
struct carddav_data **result,
int tombstones);
/* lookup an entry from 'carddavdb' by iCal UID
(optionally inside a transaction for updates) */
int carddav_lookup_uid(struct carddav_db *carddavdb, const char *ical_uid,
struct carddav_data **result);
/* check if an email address exists on any card.
returns the groups its in (if any) */
strarray_t *carddav_getemail(struct carddav_db *carddavdb, const char *key);
strarray_t *carddav_getemail2details(struct carddav_db *carddavdb, const char *key,
const mbentry_t *mbentry, int *ispinned);
strarray_t *carddav_getuid2groups(struct carddav_db *carddavdb, const char *key,
const mbentry_t *mbentry, const char *otheruser);
/* checks if a group exists (by id), optionally filtered by addressbook mailbox.
* Looks up groups across addressbooks if mbentry is NULL.
returns emails of its members (if any) */
strarray_t *carddav_getgroup(struct carddav_db *carddavdb,
const mbentry_t *mbentry, const char *group,
const mbentry_t *othermb);
/* get a list of groups the given uid is a member of */
strarray_t *carddav_getuid_groups(struct carddav_db *carddavdb, const char *uid);
/* process each entry of type 'kind' for 'mailbox' in 'carddavdb' with cb() */
int carddav_get_cards(struct carddav_db *carddavdb,
const mbentry_t *mbentry, const char *vcard_uid, int kind,
carddav_cb_t *cb, void *rock);
/* Process each entry for 'carddavdb' with a modseq higher than oldmodseq,
* in ascending order of modseq.
* If mailbox is not NULL, only process entries of this mailbox.
* If kind is non-negative, only process entries of this kind.
* If max_records is positive, only call cb for at most this entries. */
int carddav_get_updates(struct carddav_db *carddavdb,
modseq_t oldmodseq, const mbentry_t *mbentry, int kind,
int max_records, carddav_cb_t *cb, void *rock);
/* process each entry for 'mailbox' in 'carddavdb' with cb() */
int carddav_foreach(struct carddav_db *carddavdb, const mbentry_t *mbentry,
carddav_cb_t *cb, void *rock);
/* process each entry for 'mailbox' in 'carddavdb' with cb()
* The callback is called in order of sort, or by descending
* modseq if no sort is specified. */
int carddav_foreach_sort(struct carddav_db *carddavdb, const mbentry_t *mbentry,
enum carddav_sort* sort, size_t nsort,
carddav_cb_t *cb, void *rock);
int carddav_write_jmapcache(struct carddav_db *carddavdb, int rowid,
int version, const char *data);
/* write an entry to 'carddavdb' */
int carddav_write(struct carddav_db *carddavdb, struct carddav_data *cdata);
/* write an entry form a vcard */
int carddav_writecard(struct carddav_db *carddavdb, struct carddav_data *cdata,
struct vparse_card *vcard, int ispinned);
/* delete an entry from 'carddavdb' */
int carddav_delete(struct carddav_db *carddavdb, unsigned rowid);
/* delete all entries for 'mailbox' from 'carddavdb' */
int carddav_delmbox(struct carddav_db *carddavdb, const mbentry_t *mbentry);
/* begin transaction */
int carddav_begin(struct carddav_db *carddavdb);
/* commit transaction */
int carddav_commit(struct carddav_db *carddavdb);
/* abort transaction */
int carddav_abort(struct carddav_db *carddavdb);
/* store a vcard to mailbox/resource */
int carddav_store(struct mailbox *mailbox, struct vparse_card *vcard,
const char *resource, modseq_t createdmodseq,
strarray_t *flags, struct entryattlist **annots,
const char *userid, struct auth_state *authstate,
int ignorequota);
/* delete a carddav entry */
int carddav_remove(struct mailbox *mailbox,
uint32_t olduid, int isreplace,
const char *userid);
/* calculate a mailbox name */
char *carddav_mboxname(const char *userid, const char *name);
#endif /* CARDDAV_DB_H */
|
