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
|
<?php
declare(strict_types=1);
namespace Sabre\CardDAV\Xml\Request;
use Sabre\CardDAV\Plugin;
use Sabre\DAV\Exception\BadRequest;
use Sabre\Xml\Reader;
use Sabre\Xml\XmlDeserializable;
/**
* AddressBookQueryReport request parser.
*
* This class parses the {urn:ietf:params:xml:ns:carddav}addressbook-query
* REPORT, as defined in:
*
* http://tools.ietf.org/html/rfc6352#section-8.6
*
* @copyright Copyright (C) fruux GmbH (https://fruux.com/)
* @author Evert Pot (http://www.rooftopsolutions.nl/)
* @license http://sabre.io/license/ Modified BSD License
*/
class AddressBookQueryReport implements XmlDeserializable
{
/**
* An array with requested properties.
*
* @var array
*/
public $properties;
/**
* An array with requested vcard properties.
*
* @var array
*/
public $addressDataProperties = [];
/**
* List of property/component filters.
*
* This is an array with filters. Every item is a property filter. Every
* property filter has the following keys:
* * name - name of the component to filter on
* * test - anyof or allof
* * is-not-defined - Test for non-existence
* * param-filters - A list of parameter filters on the property
* * text-matches - A list of text values the filter needs to match
*
* Each param-filter has the following keys:
* * name - name of the parameter
* * is-not-defined - Test for non-existence
* * text-match - Match the parameter value
*
* Each text-match in property filters, and the single text-match in
* param-filters have the following keys:
*
* * value - value to match
* * match-type - contains, starts-with, ends-with, equals
* * negate-condition - Do the opposite match
* * collation - Usually i;unicode-casemap
*
* @var array
*/
public $filters;
/**
* The number of results the client wants.
*
* null means it wasn't specified, which in most cases means 'all results'.
*
* @var int|null
*/
public $limit;
/**
* Either 'anyof' or 'allof'.
*
* @var string
*/
public $test;
/**
* The mimetype of the content that should be returend. Usually
* text/vcard.
*
* @var string
*/
public $contentType = null;
/**
* The version of vcard data that should be returned. Usually 3.0,
* referring to vCard 3.0.
*
* @var string
*/
public $version = null;
/**
* The deserialize method is called during xml parsing.
*
* This method is called statically, this is because in theory this method
* may be used as a type of constructor, or factory method.
*
* Often you want to return an instance of the current class, but you are
* free to return other data as well.
*
* You are responsible for advancing the reader to the next element. Not
* doing anything will result in a never-ending loop.
*
* If you just want to skip parsing for this element altogether, you can
* just call $reader->next();
*
* $reader->parseInnerTree() will parse the entire sub-tree, and advance to
* the next element.
*
* @return mixed
*/
public static function xmlDeserialize(Reader $reader)
{
$elems = (array) $reader->parseInnerTree([
'{urn:ietf:params:xml:ns:carddav}prop-filter' => 'Sabre\\CardDAV\\Xml\\Filter\\PropFilter',
'{urn:ietf:params:xml:ns:carddav}param-filter' => 'Sabre\\CardDAV\\Xml\\Filter\\ParamFilter',
'{urn:ietf:params:xml:ns:carddav}address-data' => 'Sabre\\CardDAV\\Xml\\Filter\\AddressData',
'{DAV:}prop' => 'Sabre\\Xml\\Element\\KeyValue',
]);
$newProps = [
'filters' => null,
'properties' => [],
'test' => 'anyof',
'limit' => null,
];
if (!is_array($elems)) {
$elems = [];
}
foreach ($elems as $elem) {
switch ($elem['name']) {
case '{DAV:}prop':
$newProps['properties'] = array_keys($elem['value']);
if (isset($elem['value']['{'.Plugin::NS_CARDDAV.'}address-data'])) {
$newProps += $elem['value']['{'.Plugin::NS_CARDDAV.'}address-data'];
}
break;
case '{'.Plugin::NS_CARDDAV.'}filter':
if (!is_null($newProps['filters'])) {
throw new BadRequest('You can only include 1 {'.Plugin::NS_CARDDAV.'}filter element');
}
if (isset($elem['attributes']['test'])) {
$newProps['test'] = $elem['attributes']['test'];
if ('allof' !== $newProps['test'] && 'anyof' !== $newProps['test']) {
throw new BadRequest('The "test" attribute must be one of "allof" or "anyof"');
}
}
$newProps['filters'] = [];
foreach ((array) $elem['value'] as $subElem) {
if ($subElem['name'] === '{'.Plugin::NS_CARDDAV.'}prop-filter') {
$newProps['filters'][] = $subElem['value'];
}
}
break;
case '{'.Plugin::NS_CARDDAV.'}limit':
foreach ($elem['value'] as $child) {
if ($child['name'] === '{'.Plugin::NS_CARDDAV.'}nresults') {
$newProps['limit'] = (int) $child['value'];
}
}
break;
}
}
if (is_null($newProps['filters'])) {
/*
* We are supposed to throw this error, but KDE sometimes does not
* include the filter element, and we need to treat it as if no
* filters are supplied
*/
//throw new BadRequest('The {' . Plugin::NS_CARDDAV . '}filter element is required for this request');
$newProps['filters'] = [];
}
$obj = new self();
foreach ($newProps as $key => $value) {
$obj->$key = $value;
}
return $obj;
}
}
|
