forked from 1afa/sabre-zarafa
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ZarafaCardDavBackend.php
290 lines (264 loc) · 8.13 KB
/
ZarafaCardDavBackend.php
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<?php
/*
* Copyright 2011 - 2012 Guillaume Lapierre
* Copyright 2012 - 2013 Bokxing IT, http://www.bokxing-it.nl
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* "Zarafa" is a registered trademark of Zarafa B.V.
*
* This software use SabreDAV, an open source software distributed
* with New BSD License. Please see <http://code.google.com/p/sabredav/>
* for more information about SabreDAV
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Project page: <http://github.com/bokxing-it/sabre-zarafa/>
*
*/
require_once 'common.inc.php';
require_once 'ZarafaLogger.php';
// PHP-MAPI
require_once("mapi/mapi.util.php");
require_once("mapi/mapicode.php");
require_once("mapi/mapidefs.php");
require_once("mapi/mapitags.php");
require_once("mapi/mapiguid.php");
class Zarafa_CardDav_Backend extends Sabre\CardDAV\Backend\AbstractBackend
{
protected $bridge;
private $logger;
public function __construct ($zarafaBridge)
{
// Stores a reference to Zarafa Auth Backend so as to get the session
$this->bridge = $zarafaBridge;
$this->logger = new Zarafa_Logger(__CLASS__);
}
/**
* Returns the list of addressbooks for a specific user.
*
* Every addressbook should have the following properties:
* id - an arbitrary unique id
* uri - the 'basename' part of the url
* principaluri - Same as the passed parameter
*
* Any additional clark-notation property may be passed besides this. Some
* common ones are :
* {DAV:}displayname
* {urn:ietf:params:xml:ns:carddav}addressbook-description
* {http://calendarserver.org/ns/}getctag
*
* @param string $principalUri
* @return array
*/
public function
getAddressBooksForUser ($principalUri)
{
$this->logger->trace(__FUNCTION__."($principalUri)");
$folders = array_merge(
$this->bridge->get_folders_private($principalUri),
$this->bridge->get_folders_public($principalUri),
$this->bridge->get_folders_other($principalUri)
);
$dump = print_r($folders, true);
$this->logger->debug("Address books:\n$dump");
return $folders;
}
/**
* Updates an addressbook's properties
*
* See Sabre_DAV_IProperties for a description of the mutations array, as
* well as the return value.
*
* @param mixed $addressBookId
* @param array $mutations
* @see Sabre_DAV_IProperties::updateProperties
* @return bool|array
*/
public function
updateAddressBook ($addressBookId, array $mutations)
{
$this->logger->trace(__FUNCTION__.'('.bin2hex($addressBookId).', (mutations))');
if (READ_ONLY) {
return $this->exc_forbidden(__FUNCTION__.': cannot update address book: permission denied by config (read-only)');
}
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
return $this->exc_notfound(__FUNCTION__.': cannot find folder');
}
if (FALSE($folder->update_folder($mutations))) {
$this->logger->fatal(__FUNCTION__.': cannot apply mutations');
return FALSE;
}
return TRUE;
}
/**
* Creates a new address book
*
* @param string $principalUri
* @param string $url Just the 'basename' of the url.
* @param array $properties
* @return bool
*/
public function
createAddressBook ($principalUri, $url, array $properties)
{
$this->logger->trace(__FUNCTION__."($principalUri, $url, (properties))");
// FIXME: we don't actually do anything with the principal URI or the
// url; we just create a folder in the root of the user's private store.
if (READ_ONLY) {
return $this->exc_forbidden(__FUNCTION__.': cannot create address book: permission denied by config (read-only)');
}
if (FALSE($store = $this->bridge->get_private_store())) {
return $this->exc_notfound(__FUNCTION__.': cannot find private store');
}
return $store->create_folder($properties);
}
/**
* Deletes an entire addressbook and all its contents
*
* @param mixed $addressBookId
* @return void
*/
public function
deleteAddressBook ($addressBookId)
{
$this->logger->trace(__FUNCTION__.'('.bin2hex($addressBookId).')');
if (READ_ONLY || !ALLOW_DELETE_FOLDER) {
return $this->exc_forbidden(__FUNCTION__.': cannot delete address book: permission denied by config (read-only)');
}
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
return $this->exc_notfound(__FUNCTION__.': cannot find folder');
}
return $folder->delete_folder();
}
/**
* Returns all cards for a specific addressbook id.
*
* This method should return the following properties for each card:
* * carddata - raw vcard data
* * uri - Some unique url
* * lastmodified - A unix timestamp
* @param mixed $addressBookId
* @return array
*/
public function
getCards ($addressBookId)
{
$this->logger->trace(__FUNCTION__.'('.bin2hex($addressBookId).')');
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
$this->exc_notfound(__FUNCTION__.': cannot find folder');
return Array();
}
return $folder->get_dav_cards();
}
/**
* Returns a specfic card
*
* @param mixed $addressBookId
* @param string $cardUri
* @return void
*/
public function
getCard ($addressBookId, $uri)
{
$this->logger->trace(__FUNCTION__.'('.bin2hex($addressBookId).", $uri)");
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
$this->exc_notfound(__FUNCTION__.': cannot find folder');
return Array();
}
return $folder->get_dav_card($uri);
}
/**
* Creates a new card
*
* @param mixed $addressBookId
* @param string $uri
* @param string $data
* @return string|null
*/
public function
createCard ($addressBookId, $uri, $data)
{
$this->logger->trace(__FUNCTION__." - $uri\n$data");
if (READ_ONLY) {
return $this->exc_forbidden(__FUNCTION__.': cannot create card: permission denied by config (read-only)');
}
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
return $this->exc_notfound(__FUNCTION__.': cannot find folder');
}
if (FALSE($etag = $folder->create_contact($uri, $data))) {
$this->logger->fatal(__FUNCTION__.': could not create card');
return FALSE;
}
return (is_string($etag)) ? $etag : NULL;
}
/**
* Updates a card
*
* @param mixed $addressBookId
* @param string $uri
* @param string $data
* @return string|null
*/
public function
updateCard ($addressBookId, $uri, $data)
{
$this->logger->trace(__FUNCTION__." - $uri");
if (READ_ONLY) {
return $this->exc_forbidden(__FUNCTION__.': cannot update card: permission denied by config (read-only)');
}
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
return $this->exc_notfound(__FUNCTION__.': cannot find folder');
}
if (FALSE($etag = $folder->update_contact($uri, $data))) {
$this->logger->fatal(__FUNCTION__.': failed to update card');
return FALSE;
}
return (is_string($etag)) ? $etag : NULL;
}
/**
* Deletes a card
*
* @param mixed $addressBookId
* @param string $uri
* @return bool
*/
public function
deleteCard ($addressBookId, $uri)
{
$this->logger->trace(__FUNCTION__." - $uri");
if (READ_ONLY) {
return $this->exc_forbidden(__FUNCTION__.': cannot delete card: permission denied by config (read-only)');
}
if (FALSE($folder = $this->bridge->get_folder($addressBookId))) {
return $this->exc_notfound(__FUNCTION__.': cannot find folder');
}
if (FALSE($folder->delete_contact($uri))) {
$this->logger->fatal(__FUNCTION__.': failed to delete card');
return FALSE;
}
return TRUE;
}
private function
exc_forbidden ($msg)
{
$this->logger->fatal($msg);
throw new Sabre\DAV\Exception\Forbidden($msg);
return FALSE;
}
private function
exc_notfound ($msg)
{
$this->logger->fatal($msg);
throw new Sabre\DAV\Exception\NotFound($msg);
return FALSE;
}
}