-
Notifications
You must be signed in to change notification settings - Fork 13
/
sync.php
1709 lines (1478 loc) · 65.1 KB
/
sync.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* SPDX-License-Identifier: AGPL-3.0-only
* SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
* SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
*
* Provides the SYNC command
*/
class Sync extends RequestProcessor {
// Ignored SMS identifier
public const GSYNCIGNORESMS = "ZPISMS";
private $importer;
private $globallyExportedItems;
private $singleFolder;
private $multiFolderInfo;
private $startTagsSent = false;
private $startFolderTagSent = false;
/**
* Handles the Sync command
* Performs the synchronization of messages.
*
* @param int $commandCode
*
* @return bool
*/
public function Handle($commandCode) {
// Contains all requested folders (containers)
$sc = new SyncCollections();
$status = SYNC_STATUS_SUCCESS;
$wbxmlproblem = false;
$emptysync = false;
$this->singleFolder = true;
$this->multiFolderInfo = [];
$this->globallyExportedItems = 0;
// check if the hierarchySync was fully completed
if (USE_PARTIAL_FOLDERSYNC) {
if (self::$deviceManager->GetFolderSyncComplete() === false) {
SLog::Write(LOGLEVEL_INFO, "Request->HandleSync(): Sync request aborted, as exporting of folders has not yet completed");
self::$topCollector->AnnounceInformation("Aborted due incomplete folder sync", true);
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
}
else {
SLog::Write(LOGLEVEL_INFO, "Request->HandleSync(): FolderSync marked as complete");
}
}
// Start Synchronize
if (self::$decoder->getElementStartTag(SYNC_SYNCHRONIZE)) {
// AS 1.0 sends version information in WBXML
if (self::$decoder->getElementStartTag(SYNC_VERSION)) {
$sync_version = self::$decoder->getElementContent();
SLog::Write(LOGLEVEL_DEBUG, sprintf("WBXML sync version: '%s'", $sync_version));
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
// Syncing specified folders
// Android still sends heartbeat sync even if all syncfolders are disabled.
// Check if Folders tag is empty (<Folders/>) and only sync if there are
// some folders in the request. See ZP-172
$startTag = self::$decoder->getElementStartTag(SYNC_FOLDERS);
if (isset($startTag[EN_FLAGS]) && $startTag[EN_FLAGS]) {
while (self::$decoder->getElementStartTag(SYNC_FOLDER)) {
$actiondata = [];
$actiondata["requested"] = true;
$actiondata["clientids"] = [];
$actiondata["modifyids"] = [];
$actiondata["removeids"] = [];
$actiondata["fetchids"] = [];
$actiondata["statusids"] = [];
// read class, synckey and folderid without SyncParameters Object for now
$class = $synckey = $folderid = false;
// if there are already collections in SyncCollections, this is min. the second folder
if ($sc->HasCollections()) {
$this->singleFolder = false;
}
// for AS versions < 2.5
if (self::$decoder->getElementStartTag(SYNC_FOLDERTYPE)) {
$class = self::$decoder->getElementContent();
SLog::Write(LOGLEVEL_DEBUG, sprintf("Sync folder: '%s'", $class));
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
// SyncKey
if (self::$decoder->getElementStartTag(SYNC_SYNCKEY)) {
$synckey = "0";
if (($synckey = self::$decoder->getElementContent()) !== false) {
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
}
else {
return false;
}
// FolderId
if (self::$decoder->getElementStartTag(SYNC_FOLDERID)) {
$folderid = self::$decoder->getElementContent();
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
// compatibility mode AS 1.0 - get folderid which was sent during GetHierarchy()
if (!$folderid && $class) {
$folderid = self::$deviceManager->GetFolderIdFromCacheByClass($class);
}
// folderid HAS TO BE known by now, so we retrieve the correct SyncParameters object for an update
try {
$spa = self::$deviceManager->GetStateManager()->GetSynchedFolderState($folderid);
// TODO remove resync of folders
// this forces a resync of all states
if (!$spa instanceof SyncParameters) {
throw new StateInvalidException("Saved state are not of type SyncParameters");
}
// new/resync requested
if ($synckey == "0") {
$spa->RemoveSyncKey();
$spa->DelFolderStat();
$spa->SetMoveState(false);
}
elseif ($synckey !== false) {
if ($synckey !== $spa->GetSyncKey() && $synckey !== $spa->GetNewSyncKey()) {
SLog::Write(LOGLEVEL_DEBUG, "HandleSync(): Synckey does not match latest saved for this folder or there is a move state, removing folderstat to force Exporter setup");
$spa->DelFolderStat();
}
$spa->SetSyncKey($synckey);
}
}
catch (StateInvalidException $stie) {
$spa = new SyncParameters();
$status = SYNC_STATUS_INVALIDSYNCKEY;
self::$topCollector->AnnounceInformation("State invalid - Resync folder", $this->singleFolder);
self::$deviceManager->ForceFolderResync($folderid);
$this->saveMultiFolderInfo("exception", "StateInvalidException");
}
// update folderid.. this might be a new object
$spa->SetFolderId($folderid);
$spa->SetBackendFolderId(self::$deviceManager->GetBackendIdForFolderId($folderid));
if ($class !== false) {
$spa->SetContentClass($class);
}
// Get class for as versions >= 12.0
if (!$spa->HasContentClass()) {
try {
$spa->SetContentClass(self::$deviceManager->GetFolderClassFromCacheByID($spa->GetFolderId()));
SLog::Write(LOGLEVEL_DEBUG, sprintf("GetFolderClassFromCacheByID from Device Manager: '%s' for id:'%s'", $spa->GetContentClass(), $spa->GetFolderId()));
}
catch (NoHierarchyCacheAvailableException $nhca) {
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
self::$deviceManager->ForceFullResync();
}
}
// done basic SPA initialization/loading -> add to SyncCollection
$sc->AddCollection($spa);
$sc->AddParameter($spa, "requested", true);
if ($spa->HasContentClass()) {
self::$topCollector->AnnounceInformation(sprintf("%s request", $spa->GetContentClass()), $this->singleFolder);
}
else {
SLog::Write(LOGLEVEL_WARN, "Not possible to determine class of request. Request did not contain class and apparently there is an issue with the HierarchyCache.");
}
// SUPPORTED properties
if (($se = self::$decoder->getElementStartTag(SYNC_SUPPORTED)) !== false) {
// ZP-481: LG phones send an empty supported tag, so only read the contents if available here
// if <Supported/> is received, it's as no supported fields would have been sent at all.
// unsure if this is the correct approach, or if in this case some default list should be used
if ($se[EN_FLAGS] & EN_FLAGS_CONTENT) {
$supfields = [];
WBXMLDecoder::ResetInWhile("syncSupported");
while (WBXMLDecoder::InWhile("syncSupported")) {
$el = self::$decoder->getElement();
if ($el[EN_TYPE] == EN_TYPE_ENDTAG) {
break;
}
$supfields[] = $el[EN_TAG];
}
self::$deviceManager->SetSupportedFields($spa->GetFolderId(), $supfields);
}
}
// Deletes as moves can be an empty tag as well as have value
if (self::$decoder->getElementStartTag(SYNC_DELETESASMOVES)) {
$spa->SetDeletesAsMoves(true);
if (($dam = self::$decoder->getElementContent()) !== false) {
$spa->SetDeletesAsMoves((bool) $dam);
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
}
// Get changes can be an empty tag as well as have value
// code block partly contributed by dw2412
if ($starttag = self::$decoder->getElementStartTag(SYNC_GETCHANGES)) {
$sc->AddParameter($spa, "getchanges", true);
if (($gc = self::$decoder->getElementContent()) !== false) {
$sc->AddParameter($spa, "getchanges", $gc);
}
// read the endtag if SYNC_GETCHANGES wasn't an empty tag
if ($starttag[EN_FLAGS] & EN_FLAGS_CONTENT) {
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
}
if (self::$decoder->getElementStartTag(SYNC_WINDOWSIZE)) {
$ws = self::$decoder->getElementContent();
// normalize windowsize - see ZP-477
if ($ws == 0 || $ws > WINDOW_SIZE_MAX) {
$ws = WINDOW_SIZE_MAX;
}
$spa->SetWindowSize($ws);
// also announce the currently requested window size to the DeviceManager
self::$deviceManager->SetWindowSize($spa->GetFolderId(), $spa->GetWindowSize());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
// conversation mode requested
if (self::$decoder->getElementStartTag(SYNC_CONVERSATIONMODE)) {
$spa->SetConversationMode(true);
if (($conversationmode = self::$decoder->getElementContent()) !== false) {
$spa->SetConversationMode((bool) $conversationmode);
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
}
// Do not truncate by default
$spa->SetTruncation(SYNC_TRUNCATION_ALL);
// use default conflict handling if not specified by the mobile
$spa->SetConflict(SYNC_CONFLICT_DEFAULT);
// save the current filtertype because it might have been changed on the mobile
$currentFilterType = $spa->GetFilterType();
while (self::$decoder->getElementStartTag(SYNC_OPTIONS)) {
$firstOption = true;
WBXMLDecoder::ResetInWhile("syncOptions");
while (WBXMLDecoder::InWhile("syncOptions")) {
// foldertype definition
if (self::$decoder->getElementStartTag(SYNC_FOLDERTYPE)) {
$foldertype = self::$decoder->getElementContent();
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): specified options block with foldertype '%s'", $foldertype));
// switch the foldertype for the next options
$spa->UseCPO($foldertype);
// save the current filtertype because it might have been changed on the mobile
$currentFilterType = $spa->GetFilterType();
// set to synchronize all changes. The mobile could overwrite this value
$spa->SetFilterType(SYNC_FILTERTYPE_ALL);
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
// if no foldertype is defined, use default cpo
elseif ($firstOption) {
$spa->UseCPO();
// save the current filtertype because it might have been changed on the mobile
$currentFilterType = $spa->GetFilterType();
// set to synchronize all changes. The mobile could overwrite this value
$spa->SetFilterType(SYNC_FILTERTYPE_ALL);
}
$firstOption = false;
if (self::$decoder->getElementStartTag(SYNC_FILTERTYPE)) {
$spa->SetFilterType(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_TRUNCATION)) {
$spa->SetTruncation(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_RTFTRUNCATION)) {
$spa->SetRTFTruncation(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_MIMESUPPORT)) {
$spa->SetMimeSupport(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_MIMETRUNCATION)) {
$spa->SetMimeTruncation(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_CONFLICT)) {
$spa->SetConflict(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
while (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_BODYPREFERENCE)) {
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_TYPE)) {
$bptype = self::$decoder->getElementContent();
$spa->BodyPreference($bptype);
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_TRUNCATIONSIZE)) {
$spa->BodyPreference($bptype)->SetTruncationSize(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_ALLORNONE)) {
$spa->BodyPreference($bptype)->SetAllOrNone(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_PREVIEW)) {
$spa->BodyPreference($bptype)->SetPreview(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_BODYPARTPREFERENCE)) {
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_TYPE)) {
$bpptype = self::$decoder->getElementContent();
$spa->BodyPartPreference($bpptype);
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_TRUNCATIONSIZE)) {
$spa->BodyPartPreference($bpptype)->SetTruncationSize(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_ALLORNONE)) {
$spa->BodyPartPreference($bpptype)->SetAllOrNone(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_PREVIEW)) {
$spa->BodyPartPreference($bpptype)->SetPreview(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_RIGHTSMANAGEMENT_SUPPORT)) {
$spa->SetRmSupport(self::$decoder->getElementContent());
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
$e = self::$decoder->peek();
if ($e[EN_TYPE] == EN_TYPE_ENDTAG) {
self::$decoder->getElementEndTag();
break;
}
}
}
// limit items to be synchronized to the mobiles if configured
$maxAllowed = self::$deviceManager->GetFilterType($spa->GetFolderId(), $spa->GetBackendFolderId());
if ($maxAllowed > SYNC_FILTERTYPE_ALL &&
(!$spa->HasFilterType() || $spa->GetFilterType() == SYNC_FILTERTYPE_ALL || $spa->GetFilterType() > $maxAllowed)) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): FilterType applied globally or specifically, using value: %s", $maxAllowed));
$spa->SetFilterType($maxAllowed);
}
if ($currentFilterType != $spa->GetFilterType()) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): FilterType has changed (old: '%s', new: '%s'), removing folderstat to force Exporter setup", $currentFilterType, $spa->GetFilterType()));
$spa->DelFolderStat();
}
// Check if the hierarchycache is available. If not, trigger a HierarchySync
if (self::$deviceManager->IsHierarchySyncRequired()) {
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
SLog::Write(LOGLEVEL_DEBUG, "HierarchyCache is also not available. Triggering HierarchySync to device");
}
// AS16: Check if this is a DRAFTS folder - if so, disable FilterType
if (Request::GetProtocolVersion() >= 16.0 && self::$deviceManager->GetFolderTypeFromCacheById($spa->GetFolderId()) == SYNC_FOLDER_TYPE_DRAFTS) {
$spa->SetFilterType(SYNC_FILTERTYPE_DISABLE);
SLog::Write(LOGLEVEL_DEBUG, "HandleSync(): FilterType has been disabled as this is a DRAFTS folder.");
}
if (($el = self::$decoder->getElementStartTag(SYNC_PERFORM)) && ($el[EN_FLAGS] & EN_FLAGS_CONTENT)) {
// We can not proceed here as the content class is unknown
if ($status != SYNC_STATUS_SUCCESS) {
SLog::Write(LOGLEVEL_WARN, "Ignoring all incoming actions as global status indicates problem.");
$wbxmlproblem = true;
break;
}
$performaction = true;
// unset the importer
$this->importer = false;
$nchanges = 0;
WBXMLDecoder::ResetInWhile("syncActions");
while (WBXMLDecoder::InWhile("syncActions")) {
// ADD, MODIFY, REMOVE or FETCH
$element = self::$decoder->getElement();
if ($element[EN_TYPE] != EN_TYPE_STARTTAG) {
self::$decoder->ungetElement($element);
break;
}
if ($status == SYNC_STATUS_SUCCESS) {
++$nchanges;
}
// Foldertype sent when syncing SMS
if (self::$decoder->getElementStartTag(SYNC_FOLDERTYPE)) {
$foldertype = self::$decoder->getElementContent();
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): incoming data with foldertype '%s'", $foldertype));
if (!self::$decoder->getElementEndTag()) {
return false;
}
}
else {
$foldertype = false;
}
$serverid = false;
if (self::$decoder->getElementStartTag(SYNC_SERVERENTRYID)) {
if (($serverid = self::$decoder->getElementContent()) !== false) {
if (!self::$decoder->getElementEndTag()) { // end serverid
return false;
}
}
}
// get the instanceId if available
$instanceid = false;
if (self::$decoder->getElementStartTag(SYNC_AIRSYNCBASE_INSTANCEID)) {
if (($instanceid = self::$decoder->getElementContent()) !== false) {
if (!self::$decoder->getElementEndTag()) { // end instanceid
return false;
}
}
}
if (self::$decoder->getElementStartTag(SYNC_CLIENTENTRYID)) {
$clientid = self::$decoder->getElementContent();
if (!self::$decoder->getElementEndTag()) { // end clientid
return false;
}
}
else {
$clientid = false;
}
// Get the SyncMessage if sent
if (($el = self::$decoder->getElementStartTag(SYNC_DATA)) && ($el[EN_FLAGS] & EN_FLAGS_CONTENT)) {
$message = GSync::getSyncObjectFromFolderClass($spa->GetContentClass());
$message->Decode(self::$decoder);
// set Ghosted fields
$message->emptySupported(self::$deviceManager->GetSupportedFields($spa->GetFolderId()));
if (!self::$decoder->getElementEndTag()) { // end applicationdata
return false;
}
}
else {
$message = false;
}
// InstanceID sent: do action to a recurrency exception
if ($instanceid) {
// for delete actions we don't have an ASObject
if (!$message) {
$message = GSync::getSyncObjectFromFolderClass($spa->GetContentClass());
$message->Decode(self::$decoder);
}
$message->instanceid = $instanceid;
if ($element[EN_TAG] == SYNC_REMOVE) {
$message->instanceiddelete = true;
$element[EN_TAG] = SYNC_MODIFY;
}
}
switch ($element[EN_TAG]) {
case SYNC_FETCH:
array_push($actiondata["fetchids"], $serverid);
break;
default:
// get the importer
if ($this->importer === false) {
$status = $this->getImporter($sc, $spa, $actiondata);
}
if ($status == SYNC_STATUS_SUCCESS) {
$this->importMessage($spa, $actiondata, $element[EN_TAG], $message, $clientid, $serverid, $foldertype, $nchanges);
}
else {
SLog::Write(LOGLEVEL_WARN, "Ignored incoming change, global status indicates problem.");
}
break;
}
if ($actiondata["fetchids"]) {
self::$topCollector->AnnounceInformation(sprintf("Fetching %d", $nchanges));
}
else {
self::$topCollector->AnnounceInformation(sprintf("Incoming %d", $nchanges));
}
if (!self::$decoder->getElementEndTag()) { // end add/change/delete/move
return false;
}
}
if ($status == SYNC_STATUS_SUCCESS && $this->importer !== false) {
SLog::Write(LOGLEVEL_INFO, sprintf("Processed '%d' incoming changes", $nchanges));
if (!$actiondata["fetchids"]) {
self::$topCollector->AnnounceInformation(sprintf("%d incoming", $nchanges), $this->singleFolder);
$this->saveMultiFolderInfo("incoming", $nchanges);
}
try {
// Save the updated state, which is used for the exporter later
$sc->AddParameter($spa, "state", $this->importer->GetState());
}
catch (StatusException $stex) {
$status = $stex->getCode();
}
}
if (!self::$decoder->getElementEndTag()) { // end PERFORM
return false;
}
}
// save the failsafe state
if (!empty($actiondata["statusids"])) {
unset($actiondata["failstate"]);
$actiondata["failedsyncstate"] = $sc->GetParameter($spa, "state");
self::$deviceManager->GetStateManager()->SetSyncFailState($actiondata);
}
// save actiondata
$sc->AddParameter($spa, "actiondata", $actiondata);
if (!self::$decoder->getElementEndTag()) { // end collection
return false;
}
// AS14 does not send GetChanges anymore. We should do it if there were no incoming changes
if (!isset($performaction) && !$sc->GetParameter($spa, "getchanges") && $spa->HasSyncKey()) {
$sc->AddParameter($spa, "getchanges", true);
}
} // END FOLDER
if (!$wbxmlproblem && !self::$decoder->getElementEndTag()) { // end collections
return false;
}
} // end FOLDERS
if (self::$decoder->getElementStartTag(SYNC_HEARTBEATINTERVAL)) {
$hbinterval = self::$decoder->getElementContent();
if (!self::$decoder->getElementEndTag()) { // SYNC_HEARTBEATINTERVAL
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_WAIT)) {
$wait = self::$decoder->getElementContent();
if (!self::$decoder->getElementEndTag()) { // SYNC_WAIT
return false;
}
// internally the heartbeat interval and the wait time are the same
// heartbeat is in seconds, wait in minutes
$hbinterval = $wait * 60;
}
if (self::$decoder->getElementStartTag(SYNC_WINDOWSIZE)) {
$sc->SetGlobalWindowSize(self::$decoder->getElementContent());
SLog::Write(LOGLEVEL_DEBUG, "Sync(): Global WindowSize requested: " . $sc->GetGlobalWindowSize());
if (!self::$decoder->getElementEndTag()) { // SYNC_WINDOWSIZE
return false;
}
}
if (self::$decoder->getElementStartTag(SYNC_PARTIAL)) {
$partial = true;
}
else {
$partial = false;
}
if (!$wbxmlproblem && !self::$decoder->getElementEndTag()) { // end sync
return false;
}
}
// we did not receive a SYNCHRONIZE block - assume empty sync
else {
$emptysync = true;
}
// END SYNCHRONIZE
// check heartbeat/wait time
if (isset($hbinterval)) {
if ($hbinterval < 60 || $hbinterval > 3540) {
$status = SYNC_STATUS_INVALIDWAITORHBVALUE;
SLog::Write(LOGLEVEL_WARN, sprintf("HandleSync(): Invalid heartbeat or wait value '%s'", $hbinterval));
}
}
// Partial & Empty Syncs need saved data to proceed with synchronization
if ($status == SYNC_STATUS_SUCCESS && ($emptysync === true || $partial === true)) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): Partial or Empty sync requested. Retrieving data of synchronized folders."));
// Load all collections - do not overwrite existing (received!), load states, check permissions and only load confirmed states!
try {
$sc->LoadAllCollections(false, true, true, true, true);
}
catch (StateInvalidException $siex) {
$status = SYNC_STATUS_INVALIDSYNCKEY;
self::$topCollector->AnnounceInformation("StateNotFoundException", $this->singleFolder);
$this->saveMultiFolderInfo("exception", "StateNotFoundException");
}
catch (StatusException $stex) {
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
self::$topCollector->AnnounceInformation(sprintf("StatusException code: %d", $status), $this->singleFolder);
$this->saveMultiFolderInfo("exception", "StatusException");
}
// update a few values
foreach ($sc as $folderid => $spa) {
// manually set getchanges parameter for this collection if it is synchronized
if ($spa->HasSyncKey()) {
$actiondata = $sc->GetParameter($spa, "actiondata");
// request changes if no other actions are executed
if (empty($actiondata["modifyids"]) && empty($actiondata["clientids"]) && empty($actiondata["removeids"])) {
$sc->AddParameter($spa, "getchanges", true);
}
// announce WindowSize to DeviceManager
self::$deviceManager->SetWindowSize($folderid, $spa->GetWindowSize());
}
}
if (!$sc->HasCollections()) {
$status = SYNC_STATUS_SYNCREQUESTINCOMPLETE;
}
}
elseif (isset($hbinterval)) {
// load the hierarchy data - there are no permissions to verify so we just set it to false
if (!$sc->LoadCollection(false, true, false)) {
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
self::$topCollector->AnnounceInformation(sprintf("StatusException code: %d", $status), $this->singleFolder);
$this->saveMultiFolderInfo("exception", "StatusException");
}
}
// HEARTBEAT
if ($status == SYNC_STATUS_SUCCESS && isset($hbinterval)) {
$interval = (defined('PING_INTERVAL') && PING_INTERVAL > 0) ? PING_INTERVAL : 30;
if (isset($hbinterval)) {
$sc->SetLifetime($hbinterval);
}
// states are lazy loaded - we have to make sure that they are there!
$loadstatus = SYNC_STATUS_SUCCESS;
foreach ($sc as $folderid => $spa) {
// some androids do heartbeat on the OUTBOX folder, with weird results - ZP-362
// we do not load the state so we will never get relevant changes on the OUTBOX folder
if (self::$deviceManager->GetFolderTypeFromCacheById($folderid) == SYNC_FOLDER_TYPE_OUTBOX) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): Heartbeat on Outbox folder not allowed"));
continue;
}
$fad = [];
// if loading the states fails, we do not enter heartbeat, but we keep $status on SYNC_STATUS_SUCCESS
// so when the changes are exported the correct folder gets an SYNC_STATUS_INVALIDSYNCKEY
if ($loadstatus == SYNC_STATUS_SUCCESS) {
$loadstatus = $this->loadStates($sc, $spa, $fad);
}
}
if ($loadstatus == SYNC_STATUS_SUCCESS) {
$foundchanges = false;
try {
// always check for changes
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): Entering Heartbeat mode"));
$foundchanges = $sc->CheckForChanges($sc->GetLifetime(), $interval);
}
catch (StatusException $stex) {
if ($stex->getCode() == SyncCollections::OBSOLETE_CONNECTION) {
$status = SYNC_COMMONSTATUS_SYNCSTATEVERSIONINVALID;
}
else {
$status = SYNC_STATUS_FOLDERHIERARCHYCHANGED;
self::$topCollector->AnnounceInformation(sprintf("StatusException code: %d", $status), $this->singleFolder);
$this->saveMultiFolderInfo("exception", "StatusException");
}
}
// update the waittime waited
self::$waitTime = $sc->GetWaitedSeconds();
// in case there are no changes and no other request has synchronized while we waited, we can reply with an empty response
if (!$foundchanges && $status == SYNC_STATUS_SUCCESS) {
// if there were changes to the SPA or CPOs we need to save this before we terminate
// only save if the state was not modified by some other request, if so, return state invalid status
foreach ($sc as $folderid => $spa) {
if (self::$deviceManager->CheckHearbeatStateIntegrity($spa->GetFolderId(), $spa->GetUuid(), $spa->GetUuidCounter())) {
$status = SYNC_COMMONSTATUS_SYNCSTATEVERSIONINVALID;
}
else {
$sc->SaveCollection($spa);
}
}
if ($status == SYNC_STATUS_SUCCESS) {
SLog::Write(LOGLEVEL_DEBUG, "No changes found and no other process changed states. Replying with empty response and closing connection.");
self::$specialHeaders = [];
self::$specialHeaders[] = "Connection: close";
return true;
}
}
if ($foundchanges) {
foreach ($sc->GetChangedFolderIds() as $folderid => $changecount) {
// check if there were other sync requests for a folder during the heartbeat
$spa = $sc->GetCollection($folderid);
if ($changecount > 0 && $sc->WaitedForChanges() && self::$deviceManager->CheckHearbeatStateIntegrity($spa->GetFolderId(), $spa->GetUuid(), $spa->GetUuidCounter())) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): heartbeat: found %d changes in '%s' which was already synchronized. Heartbeat aborted!", $changecount, $folderid));
$status = SYNC_COMMONSTATUS_SYNCSTATEVERSIONINVALID;
}
else {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): heartbeat: found %d changes in '%s'", $changecount, $folderid));
}
}
}
}
}
// Start the output
SLog::Write(LOGLEVEL_DEBUG, "HandleSync(): Start Output");
// global status
// SYNC_COMMONSTATUS_* start with values from 101
if ($status != SYNC_COMMONSTATUS_SUCCESS && ($status == SYNC_STATUS_FOLDERHIERARCHYCHANGED || $status > 100)) {
self::$deviceManager->AnnounceProcessStatus($folderid, $status);
$this->sendStartTags();
self::$encoder->startTag(SYNC_STATUS);
self::$encoder->content($status);
self::$encoder->endTag();
self::$encoder->endTag(); // SYNC_SYNCHRONIZE
return true;
}
// Loop through requested folders
foreach ($sc as $folderid => $spa) {
// get actiondata
$actiondata = $sc->GetParameter($spa, "actiondata");
if ($status == SYNC_STATUS_SUCCESS && (!$spa->GetContentClass() || !$spa->GetFolderId())) {
SLog::Write(LOGLEVEL_ERROR, sprintf("HandleSync(): no content class or folderid found for collection."));
continue;
}
if (!$sc->GetParameter($spa, "requested")) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync(): partial sync for folder class '%s' with id '%s'", $spa->GetContentClass(), $spa->GetFolderId()));
// reload state and initialize StateMachine correctly
$sc->AddParameter($spa, "state", null);
$status = $this->loadStates($sc, $spa, $actiondata);
}
// initialize exporter to get changecount
$changecount = false;
$exporter = false;
$streamimporter = false;
$newFolderStat = false;
$setupExporter = true;
// TODO we could check against $sc->GetChangedFolderIds() on heartbeat so we do not need to configure all exporter again
if ($status == SYNC_STATUS_SUCCESS && ($sc->GetParameter($spa, "getchanges") || !$spa->HasSyncKey())) {
// no need to run the exporter if the globalwindowsize is already full - if collection already has a synckey (ZP-1215)
if ($sc->GetGlobalWindowSize() == $this->globallyExportedItems && $spa->HasSyncKey()) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("Sync(): no exporter setup for '%s' as GlobalWindowSize is full.", $spa->GetFolderId()));
$setupExporter = false;
}
// if the maximum request timeout is reached, stop processing other collections
if (Request::IsRequestTimeoutReached()) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("Sync(): no exporter setup for '%s' as request timeout reached, omitting output for collection.", $spa->GetFolderId()));
$setupExporter = false;
}
// if max memory allocation is reached, stop processing other collections
if (Request::IsRequestMemoryLimitReached()) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("Sync(): no exporter setup for '%s' as max memory allocatation reached, omitting output for collection.", $spa->GetFolderId()));
$setupExporter = false;
}
// force exporter run if there is a saved status
if ($setupExporter && self::$deviceManager->HasFolderSyncStatus($spa->GetFolderId())) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("Sync(): forcing exporter setup for '%s' as a sync status is saved - ignoring backend folder stats", $spa->GetFolderId()));
}
// compare the folder statistics if the backend supports this
elseif ($setupExporter && self::$backend->HasFolderStats()) {
// check if the folder stats changed -> if not, don't setup the exporter, there are no changes!
$newFolderStat = self::$backend->GetFolderStat(GSync::GetAdditionalSyncFolderStore($spa->GetBackendFolderId()), $spa->GetBackendFolderId());
if ($newFolderStat !== false && !$spa->IsExporterRunRequired($newFolderStat, true)) {
$changecount = 0;
$setupExporter = false;
}
}
// Do a full Exporter setup if we can't avoid it
if ($setupExporter) {
// make sure the states are loaded
$status = $this->loadStates($sc, $spa, $actiondata);
if ($status == SYNC_STATUS_SUCCESS) {
try {
// if this is an additional folder the backend has to be setup correctly
if (!self::$backend->Setup(GSync::GetAdditionalSyncFolderStore($spa->GetBackendFolderId()))) {
throw new StatusException(sprintf("HandleSync() could not Setup() the backend for folder id %s/%s", $spa->GetFolderId(), $spa->GetBackendFolderId()), SYNC_STATUS_FOLDERHIERARCHYCHANGED);
}
// Use the state from the importer, as changes may have already happened
$exporter = self::$backend->GetExporter($spa->GetBackendFolderId());
if ($exporter === false) {
throw new StatusException(sprintf("HandleSync() could not get an exporter for folder id %s/%s", $spa->GetFolderId(), $spa->GetBackendFolderId()), SYNC_STATUS_FOLDERHIERARCHYCHANGED);
}
}
catch (StatusException $stex) {
$status = $stex->getCode();
}
try {
// Stream the messages directly to the PDA
$streamimporter = new ImportChangesStream(self::$encoder, GSync::getSyncObjectFromFolderClass($spa->GetContentClass()));
if ($exporter !== false) {
$exporter->Config($sc->GetParameter($spa, "state"));
$exporter->ConfigContentParameters($spa->GetCPO());
$exporter->InitializeExporter($streamimporter);
$changecount = $exporter->GetChangeCount();
}
}
catch (StatusException $stex) {
if ($stex->getCode() === SYNC_FSSTATUS_CODEUNKNOWN && $spa->HasSyncKey()) {
$status = SYNC_STATUS_INVALIDSYNCKEY;
}
else {
$status = $stex->getCode();
}
}
if (!$spa->HasSyncKey()) {
self::$topCollector->AnnounceInformation(sprintf("Exporter registered. %d objects queued.", $changecount), $this->singleFolder);
$this->saveMultiFolderInfo("queued", $changecount);
// update folder status as initialized
$spa->SetFolderSyncTotal($changecount);
$spa->SetFolderSyncRemaining($changecount);
if ($changecount > 0) {
self::$deviceManager->SetFolderSyncStatus($folderid, DeviceManager::FLD_SYNC_INITIALIZED);
}
}
elseif ($status != SYNC_STATUS_SUCCESS) {
self::$topCollector->AnnounceInformation(sprintf("StatusException code: %d", $status), $this->singleFolder);
$this->saveMultiFolderInfo("exception", "StatusException");
}
self::$deviceManager->AnnounceProcessStatus($spa->GetFolderId(), $status);
}
}
}
// Get a new sync key to output to the client if any changes have been send by the mobile or a new synckey is to be sent
if (!empty($actiondata["modifyids"]) ||
!empty($actiondata["clientids"]) ||
!empty($actiondata["removeids"]) ||
(!$spa->HasSyncKey() && $status == SYNC_STATUS_SUCCESS)) {
$spa->SetNewSyncKey(self::$deviceManager->GetStateManager()->GetNewSyncKey($spa->GetSyncKey()));
}
// get a new synckey only if we did not reach the global limit yet
else {
// when reaching the global limit for changes of all collections, stop processing other collections (ZP-697)
if ($sc->GetGlobalWindowSize() <= $this->globallyExportedItems) {
SLog::Write(LOGLEVEL_DEBUG, "Global WindowSize for amount of exported changes reached, omitting output for collection.");
continue;
}
// get a new synckey if there are changes are we did not reach the limit yet
if ($changecount > 0) {
$spa->SetNewSyncKey(self::$deviceManager->GetStateManager()->GetNewSyncKey($spa->GetSyncKey()));
}
}
// Fir AS 14.0+ omit output for folder, if there were no incoming or outgoing changes and no Fetch
if (Request::GetProtocolVersion() >= 14.0 && !$spa->HasNewSyncKey() && $changecount == 0 && empty($actiondata["fetchids"]) && $status == SYNC_STATUS_SUCCESS &&
!$spa->HasConfirmationChanged() && ($newFolderStat === false || !$spa->IsExporterRunRequired($newFolderStat))) {
SLog::Write(LOGLEVEL_DEBUG, sprintf("HandleSync: No changes found for %s folder id '%s'. Omitting output.", $spa->GetContentClass(), $spa->GetFolderId()));
continue;
}
// if there are no other responses sent, we should end with a global status
if ($status == SYNC_STATUS_FOLDERHIERARCHYCHANGED && $this->startTagsSent === false) {
$this->sendStartTags();
self::$encoder->startTag(SYNC_STATUS);
self::$encoder->content($status);
self::$encoder->endTag();
self::$encoder->endTag(); // SYNC_SYNCHRONIZE
return true;
}
// there is something to send here, sync folder to output
$this->syncFolder($sc, $spa, $exporter, $changecount, $streamimporter, $status, $newFolderStat);
// reset status for the next folder
$status = SYNC_STATUS_SUCCESS;
} // END foreach collection
// SYNC_FOLDERS - only if the starttag was sent