1
|
|
|
<?php |
2
|
|
|
/* |
3
|
|
|
* SPDX-License-Identifier: AGPL-3.0-only |
4
|
|
|
* SPDX-FileCopyrightText: Copyright 2022-2024 grommunio GmbH |
5
|
|
|
* |
6
|
|
|
* Provides the FIND command |
7
|
|
|
*/ |
8
|
|
|
|
9
|
|
|
class Find extends RequestProcessor { |
10
|
|
|
/** |
11
|
|
|
* Handles the Find command. |
12
|
|
|
* |
13
|
|
|
* @param int $commandCode |
14
|
|
|
* |
15
|
|
|
* @return bool |
16
|
|
|
*/ |
17
|
|
|
public function Handle($commandCode) { |
18
|
|
|
$cpo = new ContentParameters(); |
19
|
|
|
if (!self::$decoder->getElementStartTag(SYNC_FIND_FIND)) { |
20
|
|
|
return false; |
21
|
|
|
} |
22
|
|
|
|
23
|
|
|
if (!self::$decoder->getElementStartTag(SYNC_FIND_SEARCHID)) { |
24
|
|
|
return false; |
25
|
|
|
} |
26
|
|
|
$searchId = self::$decoder->getElementContent(); |
27
|
|
|
$cpo->SetFindSearchId($searchId); |
|
|
|
|
28
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_SEARCHID |
29
|
|
|
return false; |
30
|
|
|
} |
31
|
|
|
|
32
|
|
|
if (!self::$decoder->getElementStartTag(SYNC_FIND_EXECUTESEARCH)) { |
33
|
|
|
return false; |
34
|
|
|
} |
35
|
|
|
|
36
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_MAILBOXSEARCHCRITERION)) { |
37
|
|
|
$searchname = ISearchProvider::SEARCH_MAILBOX; |
38
|
|
|
if (!self::$decoder->getElementStartTag(SYNC_FIND_QUERY)) { |
39
|
|
|
return false; |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FOLDERTYPE)) { |
43
|
|
|
$folderType = self::$decoder->getElementContent(); |
44
|
|
|
$cpo->SetFindFolderType($folderType); |
|
|
|
|
45
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FOLDERTYPE |
46
|
|
|
return false; |
47
|
|
|
} |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FOLDERID)) { |
51
|
|
|
$folderId = self::$decoder->getElementContent(); |
52
|
|
|
$cpo->SetFindFolderId($folderId); |
|
|
|
|
53
|
|
|
$cpo->SetRawFindFolderId($folderId); |
|
|
|
|
54
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FOLDERID |
55
|
|
|
return false; |
56
|
|
|
} |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_FREETEXT)) { |
60
|
|
|
$freeText = self::$decoder->getElementContent(); |
61
|
|
|
$cpo->SetFindFreeText($freeText); |
|
|
|
|
62
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_FREETEXT |
63
|
|
|
return false; |
64
|
|
|
} |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_QUERY |
68
|
|
|
return false; |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
$deeptraversal = false; |
72
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_OPTIONS)) { |
73
|
|
|
WBXMLDecoder::ResetInWhile("findOptions"); |
74
|
|
|
while (WBXMLDecoder::InWhile("findOptions")) { |
75
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_RANGE)) { |
76
|
|
|
$findrange = self::$decoder->getElementContent(); |
77
|
|
|
$cpo->SetFindRange($findrange); |
|
|
|
|
78
|
|
|
if (!self::$decoder->getElementEndTag()) { |
79
|
|
|
return false; |
80
|
|
|
} |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_DEEPTRAVERSAL)) { |
84
|
|
|
$deeptraversal = true; |
85
|
|
|
if (($dam = self::$decoder->getElementContent()) !== false) { |
|
|
|
|
86
|
|
|
$deeptraversal = true; |
87
|
|
|
if (!self::$decoder->getElementEndTag()) { |
88
|
|
|
return false; |
89
|
|
|
} |
90
|
|
|
} |
91
|
|
|
} |
92
|
|
|
$e = self::$decoder->peek(); |
93
|
|
|
if ($e[EN_TYPE] == EN_TYPE_ENDTAG) { |
94
|
|
|
self::$decoder->getElementEndTag(); |
95
|
|
|
|
96
|
|
|
break; |
97
|
|
|
} |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
$cpo->SetFindDeepTraversal($deeptraversal); |
|
|
|
|
101
|
|
|
|
102
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_MAILBOXSEARCHCRITERION |
103
|
|
|
return false; |
104
|
|
|
} |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
if (self::$decoder->getElementStartTag(SYNC_FIND_GALSEARCHCRITERION)) { |
108
|
|
|
$searchname = ISearchProvider::SEARCH_GAL; |
109
|
|
|
$galSearchCriterion = self::$decoder->getElementContent(); |
|
|
|
|
110
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_GALSEARCHCRITERION |
111
|
|
|
return false; |
112
|
|
|
} |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_EXECUTESEARCH |
116
|
|
|
return false; |
117
|
|
|
} |
118
|
|
|
|
119
|
|
|
if (!self::$decoder->getElementEndTag()) { // SYNC_FIND_FIND |
120
|
|
|
return false; |
121
|
|
|
} |
122
|
|
|
|
123
|
|
|
// get SearchProvider |
124
|
|
|
$searchprovider = GSync::GetBackend()->GetSearchProvider(); |
125
|
|
|
$findstatus = SYNC_FINDSTATUS_SUCCESS; |
126
|
|
|
|
127
|
|
|
if (!isset($searchname)) { |
128
|
|
|
$findstatus = SYNC_FINDSTATUS_INVALIDREQUEST; |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
self::$encoder->startWBXML(); |
132
|
|
|
self::$encoder->startTag(SYNC_FIND_FIND); |
133
|
|
|
|
134
|
|
|
self::$encoder->startTag(SYNC_FIND_STATUS); |
135
|
|
|
self::$encoder->content($findstatus); |
136
|
|
|
self::$encoder->endTag(); |
137
|
|
|
|
138
|
|
|
if ($findstatus == SYNC_FINDSTATUS_SUCCESS) { |
139
|
|
|
$status = SYNC_FINDSTATUS_SUCCESS; |
140
|
|
|
|
141
|
|
|
try { |
142
|
|
|
if ($searchname == ISearchProvider::SEARCH_GAL) { |
|
|
|
|
143
|
|
|
// TODO: Fix GAL search in Find command |
144
|
|
|
// $rows = $searchprovider->GetGALSearchResults($cpo->GetFindFreeText(), "0-100", null); |
145
|
|
|
throw new StatusException("GAL search in FIND command is not implemented. Please report this including the 'WBXML debug data' logged. Be aware that the debug data could contain confidential information.", SYNC_FINDSTATUS_INVALIDREQUEST, null, LOGLEVEL_FATAL); |
146
|
|
|
} |
147
|
|
|
if ($searchname == ISearchProvider::SEARCH_MAILBOX) { |
148
|
|
|
$backendFolderId = self::$deviceManager->GetBackendIdForFolderId($cpo->GetFindFolderid()); |
|
|
|
|
149
|
|
|
$cpo->SetFindFolderid($backendFolderId); |
|
|
|
|
150
|
|
|
$rows = $searchprovider->GetMailboxSearchResults($cpo); |
151
|
|
|
} |
152
|
|
|
} |
153
|
|
|
catch (StatusException $stex) { |
154
|
|
|
$status = $stex->getCode(); |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
self::$encoder->startTag(SYNC_FIND_RESPONSE); |
158
|
|
|
|
159
|
|
|
self::$encoder->startTag(SYNC_ITEMOPERATIONS_STORE); |
160
|
|
|
self::$encoder->content("Mailbox"); |
161
|
|
|
self::$encoder->endTag(); |
162
|
|
|
|
163
|
|
|
self::$encoder->startTag(SYNC_FIND_STATUS); |
164
|
|
|
self::$encoder->content($status); |
165
|
|
|
self::$encoder->endTag(); |
166
|
|
|
|
167
|
|
|
if (isset($rows['range'])) { |
168
|
|
|
$searchrange = $rows['range']; |
|
|
|
|
169
|
|
|
unset($rows['range']); |
170
|
|
|
} |
171
|
|
|
if (isset($rows['searchtotal'])) { |
172
|
|
|
$searchtotal = $rows['searchtotal']; |
173
|
|
|
unset($rows['searchtotal']); |
174
|
|
|
} |
175
|
|
|
|
176
|
|
|
if ($searchtotal > 0) { |
|
|
|
|
177
|
|
|
foreach ($rows as $u) { |
|
|
|
|
178
|
|
|
// fetch the SyncObject for this result |
179
|
|
|
$message = self::$backend->Fetch(false, $u['longid'], $cpo); |
180
|
|
|
$mfolderid = self::$deviceManager->GetFolderIdForBackendId(bin2hex($message->ParentSourceKey)); |
181
|
|
|
|
182
|
|
|
self::$encoder->startTag(SYNC_FIND_RESULT); |
183
|
|
|
self::$encoder->startTag(SYNC_FOLDERTYPE); |
184
|
|
|
self::$encoder->content($u['class']); |
185
|
|
|
self::$encoder->endTag(); |
186
|
|
|
|
187
|
|
|
self::$encoder->startTag(SYNC_SERVERENTRYID); |
188
|
|
|
self::$encoder->content($mfolderid . ":" . $u['serverid']); |
189
|
|
|
self::$encoder->endTag(); |
190
|
|
|
self::$encoder->startTag(SYNC_FOLDERID); |
191
|
|
|
self::$encoder->content($cpo->GetRawFindFolderId()); |
|
|
|
|
192
|
|
|
self::$encoder->endTag(); |
193
|
|
|
|
194
|
|
|
self::$encoder->startTag(SYNC_FIND_PROPERTIES); |
195
|
|
|
$fpmessage = SyncFindProperties::GetObjectFromSyncMail($message); |
196
|
|
|
$fpmessage->Encode(self::$encoder); |
197
|
|
|
|
198
|
|
|
self::$encoder->endTag(); // properties |
199
|
|
|
self::$encoder->endTag(); // result |
200
|
|
|
} |
201
|
|
|
} |
202
|
|
|
|
203
|
|
|
self::$encoder->startTag(SYNC_FIND_RANGE); |
204
|
|
|
self::$encoder->content("0-" . $searchtotal); |
205
|
|
|
self::$encoder->endTag(); |
206
|
|
|
if ($searchtotal > 0) { |
207
|
|
|
self::$encoder->startTag(SYNC_FIND_TOTAL); |
208
|
|
|
self::$encoder->content($searchtotal); // $searchtotal); |
209
|
|
|
self::$encoder->endTag(); |
210
|
|
|
} |
211
|
|
|
|
212
|
|
|
self::$encoder->endTag(); // SYNC_FIND_RESPONSE |
213
|
|
|
} |
214
|
|
|
self::$encoder->endTag(); // SYNC_FIND_FIND |
215
|
|
|
|
216
|
|
|
return true; |
217
|
|
|
} |
218
|
|
|
} |
219
|
|
|
|