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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero 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 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/>.
*
*/
namespace OCA\Contacts\Dav;
use Sabre\CardDAV\Card;
use Sabre\DAV;
use Sabre\DAV\INode;
use Sabre\DAV\PropPatch;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;
use Sabre\VObject\Reader;
class PatchPlugin extends ServerPlugin {
public const METHOD_REPLACE = 0;
public const METHOD_APPEND = 1;
/** @var Server */
protected $server;
/**
* Initializes the plugin and registers event handlers
*
* @param Server $server
* @return void
*/
public function initialize(Server $server) {
$this->server = $server;
$server->on('method:PATCH', [$this, 'httpPatch']);
}
/**
* Use this method to tell the server this plugin defines additional
* HTTP methods.
*
* This method is passed a uri. It should only return HTTP methods that are
* available for the specified uri.
*
* We claim to support PATCH method (partirl update) if and only if
* - the node exist
* - the node implements our partial update interface
*
* @param string $uri
*
* @return array
*/
public function getHTTPMethods($uri) {
$tree = $this->server->tree;
if ($tree->nodeExists($uri)) {
$node = $tree->getNodeForPath($uri);
if ($node instanceof Card) {
return ['PATCH'];
}
}
return [];
}
/**
* Adds all CardDAV-specific properties
*
* @param PropPatch $propPatch
* @param INode $node
* @return void
*/
public function httpPatch(RequestInterface $request, ResponseInterface $response) {
$path = $request->getPath();
$node = $this->server->tree->getNodeForPath($path);
if (!($node instanceof Card)) {
return true;
}
// Checking ACL, if available.
if ($aclPlugin = $this->server->getPlugin('acl')) {
/** @var \Sabre\DAVACL\Plugin $aclPlugin */
$aclPlugin->checkPrivileges($path, '{DAV:}write');
}
// Init property name & value
$propertyName = $request->getHeader('X-Property');
if (is_null($propertyName)) {
throw new DAV\Exception\BadRequest('No valid "X-Property" found in the headers');
}
$propertyData = $request->getHeader('X-Property-Replace');
$method = self::METHOD_REPLACE;
if (is_null($propertyData)) {
$propertyData = $request->getHeader('X-Property-Append');
$method = self::METHOD_APPEND;
if (is_null($propertyData)) {
throw new DAV\Exception\BadRequest('No valid "X-Property-Append" or "X-Property-Replace" found in the headers');
}
}
// Init contact
$vCard = Reader::read($node->get());
$properties = $vCard->select($propertyName);
// We cannot know which one to update in that case
if (count($properties) > 1) {
throw new DAV\Exception\BadRequest('The specified property appear more than once');
}
// Init if not in the vcard
if (count($properties) === 0) {
$vCard->add($propertyName, $propertyData);
$properties = $vCard->select($propertyName);
}
// Replace existing value
if ($method === self::METHOD_REPLACE) {
$properties[0]->setRawMimeDirValue($propertyData);
}
// Append to existing value
if ($method === self::METHOD_APPEND) {
$oldData = $properties[0]->getValue();
$properties[0]->setRawMimeDirValue($oldData.$propertyData);
}
// Validate & write
$vCard->validate();
$node->put($vCard->serialize());
$response->setStatus(200);
return false;
}
/**
* Returns a plugin name.
*
* Using this name other plugins will be able to access other plugins
* using \Sabre\DAV\Server::getPlugin
*
* @return string
*/
public function getPluginName() {
return 'vcard-patch';
}
/**
* Returns a bunch of meta-data about the plugin.
*
* Providing this information is optional, and is mainly displayed by the
* Browser plugin.
*
* The description key in the returned array may contain html and will not
* be sanitized.
*
* @return array
*/
public function getPluginInfo() {
return [
'name' => $this->getPluginName(),
'description' => 'Allow to patch unique properties.'
];
}
}
|
