forked from open-horizon/edge-sync-service
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiModule.go
1218 lines (1000 loc) · 42.7 KB
/
apiModule.go
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
package base
import (
"fmt"
"io"
"math"
"net/url"
"os"
"strings"
"sync"
"time"
"github.com/open-horizon/edge-sync-service/common"
"github.com/open-horizon/edge-sync-service/core/communications"
"github.com/open-horizon/edge-sync-service/core/dataURI"
"github.com/open-horizon/edge-sync-service/core/storage"
"github.com/open-horizon/edge-utilities/logger"
"github.com/open-horizon/edge-utilities/logger/log"
"github.com/open-horizon/edge-utilities/logger/trace"
)
var apiLock sync.RWMutex
var apiObjectLocks common.Locks
func init() {
apiObjectLocks = *common.NewLocks("api")
}
// UpdateObject invoked when an app sends an updated object
func UpdateObject(orgID string, objectType string, objectID string, metaData common.MetaData, data []byte) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In UpdateObject. Update %s %s %s\n", orgID, objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
if !common.IsValidName(orgID) {
return &common.InvalidRequest{Message: fmt.Sprintf("Organization ID (%s) contains invalid characters", orgID)}
}
// Verify that the object is valid
if metaData.ObjectID == "" {
return &common.InvalidRequest{Message: "Object's meta data does not contain object's ID"}
}
if objectID != metaData.ObjectID {
message := fmt.Sprintf("Object ID (%+v) in the URL doesn't match the object-id (%+v) in the payload", objectID, metaData.ObjectID)
return &common.InvalidRequest{Message: message}
}
if !common.IsValidName(objectID) {
return &common.InvalidRequest{Message: fmt.Sprintf("Object ID (%s) contains invalid characters", objectID)}
}
if metaData.ObjectType == "" {
return &common.InvalidRequest{Message: "Object's meta data does not contain object's type"}
}
if objectType != metaData.ObjectType {
message := fmt.Sprintf("Object type (%+v) in the URL doesn't match the object-type (%+v) in the payload", objectType, metaData.ObjectType)
return &common.InvalidRequest{Message: message}
}
if !common.IsValidName(objectType) {
return &common.InvalidRequest{Message: fmt.Sprintf("Object type (%s) contains invalid characters", objectType)}
}
if metaData.Expiration != "" {
if common.Configuration.NodeType == common.ESS {
return &common.InvalidRequest{Message: "Object expiration is disabled on ESS"}
}
expiration, err := time.Parse(time.RFC3339, metaData.Expiration)
if err != nil {
return &common.InvalidRequest{Message: "Failed to parse expiration in object's meta data. Error: " + err.Error()}
}
if time.Now().After(expiration) {
return &common.InvalidRequest{Message: "Invalid expiration time in object's meta data"}
}
}
if metaData.Version != "" && !common.IsValidName(metaData.Version) {
return &common.InvalidRequest{Message: fmt.Sprintf("Version (%s) contains one/some invalid characters (eg: <, >, =, ', \", &, space, \\, /)", metaData.Version)}
}
if metaData.Description != "" && common.IsInvalidDescription(metaData.Description) {
return &common.InvalidRequest{Message: fmt.Sprintf("Description (%s) contains one/some invalid characters (<, >, =, ', \", &, space, \\, /)", metaData.Description)}
}
if metaData.MetaOnly && len(data) != 0 {
return &common.InvalidRequest{Message: "Can't update data if MetaOnly is true"}
}
if metaData.DestID != "" && metaData.DestType == "" {
return &common.InvalidRequest{Message: "Destination ID provided without destination type in object's meta data"}
}
if metaData.DestinationsList != nil && common.Configuration.NodeType == common.ESS {
return &common.InvalidRequest{Message: "Destinations list is not supported for ESS"}
}
if metaData.DestinationsList != nil && metaData.DestType != "" {
return &common.InvalidRequest{Message: "Both destinations list and destination type are specified"}
}
if validatedDestList, _ := common.ValidateDestinationListInput(metaData.DestinationsList); validatedDestList == false {
return &common.InvalidRequest{Message: "Unsupported char <, > in destinationsList."}
}
if metaData.DestinationPolicy != nil {
if metaData.DestType != "" {
return &common.InvalidRequest{Message: "Both destination policy and destination type are specified"}
}
if metaData.DestinationsList != nil {
return &common.InvalidRequest{Message: "Both destination policy and destination list are specified"}
}
properties := metaData.DestinationPolicy.Properties
for _, property := range properties {
if len(property.Name) == 0 {
return &common.InvalidRequest{Message: "A property in the DestinationPolicy must have a name"}
}
}
services := metaData.DestinationPolicy.Services
for _, service := range services {
if len(service.OrgID) == 0 || len(service.Arch) == 0 || len(service.ServiceName) == 0 || len(service.Version) == 0 {
return &common.InvalidRequest{
Message: "A service in a DestinationPolicy must have an organization ID, architecture, service name, and version specified"}
}
if _, err := common.ParseSemVerRange(service.Version); err != nil {
return &common.InvalidRequest{
Message: fmt.Sprintf("A service in the DestinationPolicy has an invalid version `%s`", service.Version)}
}
}
}
if metaData.DestType != "" && !common.IsValidName(metaData.DestType) {
return &common.InvalidRequest{Message: fmt.Sprintf("Destination type (%s) contains invalid characters", metaData.DestType)}
}
if metaData.AutoDelete && metaData.DestinationsList == nil && metaData.DestID == "" {
return &common.InvalidRequest{Message: "AutoDelete can be used only for objects with DestinationsList or DestID set"}
}
if metaData.ActivationTime != "" && metaData.Inactive {
activation, err := time.Parse(time.RFC3339, metaData.ActivationTime)
if err != nil {
return &common.InvalidRequest{Message: "Failed to parse activation time in object's meta data. Error: " + err.Error()}
}
if time.Now().After(activation) {
return &common.InvalidRequest{Message: "Invalid activation time in object's meta data"}
}
}
if metaData.Deleted {
return &common.InvalidRequest{Message: "Object marked as deleted"}
}
if metaData.DestinationDataURI != "" {
if common.Configuration.NodeType == common.ESS {
return &common.InvalidRequest{Message: "Data URI is disabled on CSS"}
}
uri, err := url.Parse(metaData.DestinationDataURI)
if err != nil || !strings.EqualFold(uri.Scheme, "file") || uri.Host != "" {
return &common.InvalidRequest{Message: "Invalid destination data URI"}
}
}
if metaData.SourceDataURI != "" {
if common.Configuration.NodeType == common.CSS {
return &common.InvalidRequest{Message: "Data URI is disabled on CSS"}
}
if data != nil {
return &common.InvalidRequest{Message: "Both source data URI and data are set"}
}
uri, err := url.Parse(metaData.SourceDataURI)
if err != nil || !strings.EqualFold(uri.Scheme, "file") || uri.Host != "" {
return &common.InvalidRequest{Message: "Invalid source data URI"}
}
if fi, err := os.Stat(uri.Path); err == nil {
metaData.ObjectSize = fi.Size()
} else {
log.Error(" Invalid source data URI: %s, failed to get file information for the file, err= %v\n", metaData.SourceDataURI, err)
return &common.InvalidRequest{Message: "Invalid source data URI"}
}
}
if metaData.OriginType == "" || metaData.OriginID == "" {
// Set the origin so the other side can respond
metaData.OriginType = common.Configuration.DestinationType
metaData.OriginID = common.Configuration.DestinationID
} else {
// metaData.OriginType != "" && metaData.OriginID != "", check if given valud is valid
if !common.IsValidName(metaData.OriginType) {
return &common.InvalidRequest{Message: fmt.Sprintf("OriginType (%s) contains one/some invalid characters (eg: <, >, =, ', \", &, space, \\, /)", metaData.OriginType)}
} else if !common.IsValidName(metaData.OriginID) {
return &common.InvalidRequest{Message: fmt.Sprintf("OriginID (%s) contains one/some invalid characters (eg: <, >, =, ', \", &, space, \\, /)", metaData.OriginID)}
}
}
if metaData.DestOrgID == "" {
metaData.DestOrgID = orgID
} else if !common.IsValidName(metaData.DestOrgID) {
return &common.InvalidRequest{Message: fmt.Sprintf("DestOrgID (%s) contains one/some invalid characters (eg: <, >, =, ', \", &, space, \\, /)", metaData.DestOrgID)}
}
if metaData.ExpectedConsumers == 0 {
metaData.ExpectedConsumers = 1
} else if metaData.ExpectedConsumers == -1 {
metaData.ExpectedConsumers = math.MaxInt32
}
// Store the object in the storage module
status := common.NotReadyToSend
if data != nil || metaData.Link != "" || metaData.NoData || metaData.SourceDataURI != "" {
status = common.ReadyToSend
} else if metaData.MetaOnly {
reader, err := store.RetrieveObjectData(metaData.DestOrgID, metaData.ObjectType, metaData.ObjectID)
if err != nil {
return err
}
if reader != nil {
status = common.ReadyToSend
store.CloseDataReader(reader)
}
}
if metaData.NoData {
data = nil
metaData.Link = ""
metaData.SourceDataURI = ""
} else if data != nil {
metaData.ObjectSize = int64(len(data))
}
metaData.ChunkSize = common.Configuration.MaxDataChunkSize
lockIndex := common.HashStrings(metaData.DestOrgID, metaData.ObjectType, metaData.ObjectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
deletedDestinations, err := store.StoreObject(metaData, data, status)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
store.DeleteNotificationRecords(metaData.DestOrgID, metaData.ObjectType, metaData.ObjectID, "", "")
if status == common.NotReadyToSend || metaData.Inactive {
common.ObjectLocks.Unlock(lockIndex)
return nil
}
// StoreObject increments the instance id, we need to fetch the updated meta data
updatedMetaData, err := store.RetrieveObject(metaData.DestOrgID, metaData.ObjectType, metaData.ObjectID)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
var deleteNotificationsInfo []common.NotificationInfo
if len(deletedDestinations) != 0 {
deleteNotificationsInfo, err = communications.PrepareNotificationsForDestinations(*updatedMetaData, deletedDestinations, common.Delete)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
}
updateNotificationsInfo, err := communications.PrepareObjectNotifications(*updatedMetaData)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return err
}
if deleteNotificationsInfo != nil {
if err := communications.SendNotifications(deleteNotificationsInfo); err != nil {
return err
}
}
return communications.SendNotifications(updateNotificationsInfo)
}
// GetObjectStatus sends the status of the object to the app
// Call the storage module to get the status of the object and return it in the response
func GetObjectStatus(orgID string, objectType string, objectID string) (string, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In GetObjectStatus. Get status of %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.RLock(lockIndex)
defer apiObjectLocks.RUnlock(lockIndex)
return store.RetrieveObjectStatus(orgID, objectType, objectID)
}
// ListUpdatedObjects provides a list of edge updated objects
// Call the storage module to get the list of edge updated objects and send it to the app
func ListUpdatedObjects(orgID string, objectType string, received bool) ([]common.MetaData, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
updatedObjects, err := store.RetrieveUpdatedObjects(orgID, objectType, received)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListUpdatedObjects. Get %s %s. returned %d objects\n", orgID, objectType, len(updatedObjects))
}
return updatedObjects, err
}
// ListObjectsWithDestinationPolicy provides a list of objects that have a DestinationPolicy
func ListObjectsWithDestinationPolicy(orgID string, received bool) ([]common.ObjectDestinationPolicy, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
objects, err := store.RetrieveObjectsWithDestinationPolicy(orgID, received)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListObjectsWithDestinationPolicy. Get %s. Returned %d objects\n", orgID, len(objects))
}
return objects, err
}
// ListObjectsWithDestinationPolicyByService provides a list of objects that have a DestinationPolicy and are
// associated with a service
func ListObjectsWithDestinationPolicyByService(orgID, serviceOrgID, serviceName string) ([]common.ObjectDestinationPolicy, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
objects, err := store.RetrieveObjectsWithDestinationPolicyByService(orgID, serviceOrgID, serviceName)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListObjectsWithDestinationPolicyByService. Get %s/%s. Returned %d objects\n",
serviceOrgID, serviceName, len(objects))
}
return objects, err
}
// ListObjectsWithDestinationPolicyUpdatedSince provides a list of objects that have a DestinationPolicy that has been updated since the specified time
func ListObjectsWithDestinationPolicyUpdatedSince(orgID string, since int64) ([]common.ObjectDestinationPolicy, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
objects, err := store.RetrieveObjectsWithDestinationPolicyUpdatedSince(orgID, since)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListObjectsWithDestinationPolicyByService. Get %s since %d. Returned %d objects\n",
orgID, since, len(objects))
}
return objects, err
}
// ListObjectsWithFilters provides a list of objects that satisfy the given conditions
func ListObjectsWithFilters(orgID string, destinationPolicy *bool, dpServiceOrgID string, dpServiceName string, dpPropertyName string, since int64, objectType string, objectID string, destinationType string, destinationID string, noData *bool, expirationTimeBefore string) ([]common.MetaData, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
objects, err := store.RetrieveObjectsWithFilters(orgID, destinationPolicy, dpServiceOrgID, dpServiceName, dpPropertyName, since, objectType, objectID, destinationType, destinationID, noData, expirationTimeBefore)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListObjectsWithFilters. Get %s. Returned %d objects\n", orgID, len(objects))
}
return objects, err
}
// ListAllObjects provides a list of all objects with the specified type
func ListAllObjects(orgID string, objectType string) ([]common.ObjectDestinationPolicy, common.SyncServiceError) {
apiLock.RLock()
defer apiLock.RUnlock()
common.HealthStatus.ClientRequestReceived()
objects, err := store.RetrieveAllObjects(orgID, objectType)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListAllObjects. Get %s:%s. Returned %d objects\n", orgID, objectType, len(objects))
}
return objects, err
}
// GetObject delivers an object to the app
// Call the storage module to get the object's meta data and send it to the app
func GetObject(orgID string, objectType string, objectID string) (*common.MetaData, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In GetObject. Get %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.RLock(lockIndex)
defer apiObjectLocks.RUnlock(lockIndex)
return store.RetrieveObject(orgID, objectType, objectID)
}
// GetObjectData delivers object data to the app
// Call the storage module to get the object's data and send it to the app
func GetObjectData(orgID string, objectType string, objectID string) (io.Reader, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In GetObjectData. Get data %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.RLock(lockIndex)
defer apiObjectLocks.RUnlock(lockIndex)
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
return nil, err
}
if metaData == nil || status == common.NotReadyToSend || status == common.PartiallyReceived {
return nil, nil
}
if metaData.DestinationDataURI != "" && status == common.CompletelyReceived {
return dataURI.GetData(metaData.DestinationDataURI)
}
if metaData.SourceDataURI != "" && status == common.ReadyToSend {
return dataURI.GetData(metaData.SourceDataURI)
}
return store.RetrieveObjectData(orgID, objectType, objectID)
}
// GetRemovedDestinationPolicyServicesFromESS get the removedDestinationPolicyServices list
// Call the storage module to get the object's removedDestinationPolicyServices
func GetRemovedDestinationPolicyServicesFromESS(orgID string, objectType string, objectID string) ([]common.ServiceID, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In GetRemovedDestinationPolicyServicesFromESS. Get RemovedDestinationPolicyServices for object %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.RLock(lockIndex)
defer apiObjectLocks.RUnlock(lockIndex)
_, removedDestinationPolicyServices, err := store.RetrieveObjectAndRemovedDestinationPolicyServices(orgID, objectType, objectID)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In GetRemovedDestinationPolicyServicesFromESS. Get %d RemovedDestinationPolicyServices for object %s %s\n", len(removedDestinationPolicyServices), objectType, objectID)
}
return removedDestinationPolicyServices, err
}
// PutObjectData stores an object's data
// Call the storage module to store the object's data
// Return true if the object was found and updated
// Return false and no error if the object was not found
func PutObjectData(orgID string, objectType string, objectID string, dataReader io.Reader) (bool, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In PutObjectData. Update data %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return false, err
}
if metaData == nil {
common.ObjectLocks.Unlock(lockIndex)
return false, nil
}
if status != common.ReadyToSend && status != common.NotReadyToSend {
common.ObjectLocks.Unlock(lockIndex)
return false, &common.InvalidRequest{Message: "Can't update data of the receiving side"}
}
if metaData.NoData {
common.ObjectLocks.Unlock(lockIndex)
return false, &common.InvalidRequest{Message: "Can't update data, the NoData flag is set to true"}
}
if exists, err := store.StoreObjectData(orgID, objectType, objectID, dataReader); err != nil || !exists {
common.ObjectLocks.Unlock(lockIndex)
return false, err
}
if metaData.SourceDataURI != "" {
if err = store.UpdateObjectSourceDataURI(orgID, objectType, objectID, ""); err != nil {
common.ObjectLocks.Unlock(lockIndex)
return false, err
}
}
var updatedMetaData *common.MetaData
// StoreObject increments the instance id if this is a data update, we need to fetch the updated meta data
// Also, StoreObjectData updates the ObjectSize, so we need to fetch the updated meta data
updatedMetaData, err = store.RetrieveObject(orgID, objectType, objectID)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return false, err
}
if updatedMetaData.Inactive {
// Don't send inactive objects to the other side
common.ObjectLocks.Unlock(lockIndex)
return true, nil
}
notificationsInfo, err := communications.PrepareObjectNotifications(*updatedMetaData)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return true, err
}
return true, communications.SendNotifications(notificationsInfo)
}
// ObjectConsumed is used when an app indicates that it consumed the object
// Send "consumed" notification to the object's origin
// Call the storage module to mark the object as consumed
func ObjectConsumed(orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ObjectConsumed. Consumed %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to mark as consumed. Error: %s", orgID+":"+objectType+":"+objectID, err.Error())
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
if status == "" {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to mark as consumed.", orgID+":"+objectType+":"+objectID)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Failed to find object to mark as consumed"}
}
if status != common.CompletelyReceived && status != common.ObjReceived {
message := fmt.Sprintf("Invalid attempt to mark object in status %s as consumed\n", status)
if log.IsLogging(logger.ERROR) {
log.Error(message)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: message}
}
if c, err := store.DecrementAndReturnRemainingConsumers(orgID, objectType, objectID); err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Error in objectConsumed: failed to decrement consumers count. Error: %s\n", err)
}
common.ObjectLocks.Unlock(lockIndex)
} else if c == 0 {
if err := store.UpdateObjectStatus(orgID, objectType, objectID, common.ObjConsumed); err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
notificationsInfo, err := communications.PrepareObjectStatusNotification(*metaData, common.Consumed)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return err
}
return communications.SendNotifications(notificationsInfo)
} else {
common.ObjectLocks.Unlock(lockIndex)
}
return nil
}
// ObjectPolicyReceived is called when an application wants to mark an object as having received its
// destination policy
func ObjectPolicyReceived(orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ObjectPolicyReceived. Received %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
err := store.MarkDestinationPolicyReceived(orgID, objectType, objectID)
common.ObjectLocks.Unlock(lockIndex)
return err
}
// ObjectReceived is called when an app indicates that it received the object
// Call the storage module to mark the object as received
func ObjectReceived(orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ObjectReceived. Received %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
status, err := store.RetrieveObjectStatus(orgID, objectType, objectID)
if err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to mark as received. Error: %s", orgID+":"+objectType+":"+objectID, err.Error())
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
if status == "" {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to mark as received.", orgID+":"+objectType+":"+objectID)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Failed to find object to mark as received"}
}
if status != common.CompletelyReceived && status != common.ObjReceived {
message := fmt.Sprintf("Invalid attempt to mark object in status %s as received\n", status)
if log.IsLogging(logger.ERROR) {
log.Error(message)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: message}
}
var c int
if c, err = store.DecrementAndReturnRemainingReceivers(orgID, objectType, objectID); err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Error in objectReceived: failed to decrement receivers count. Error: %s\n", err)
}
} else if c == 0 {
err = store.UpdateObjectStatus(orgID, objectType, objectID, common.ObjReceived)
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
// ObjectDeleted is called when an app indicates that 1) it deleted the object, or 2) service acknowlege service reference change
// For 1):
// Send "deleted" notification to the object's origin
// Call the storage module to delete the object if deleted by all the consumers
// For 2):
// service will be removed from ESS lastDestinationPolicyServices array
func ObjectDeleted(userID string, orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ObjectDeleted. Deleted %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
if trace.IsLogging(logger.DEBUG) {
trace.Debug("Retrieve object and status for %s %s\n", objectType, objectID)
}
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to confirm deletion. Error: %s", orgID+":"+objectType+":"+objectID, err.Error())
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
if trace.IsLogging(logger.DEBUG) {
trace.Debug("Status of %s %s is: %s\n", objectType, objectID, status)
}
if status == "" {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find object %s to confirm deletion.", orgID+":"+objectType+":"+objectID)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Failed to find object to confirm deletion"}
}
if trace.IsLogging(logger.DEBUG) {
trace.Debug("metaData.Deleted of %s %s is: %t\n", objectType, objectID, metaData.Deleted)
}
if metaData.Deleted {
if status != common.ObjDeleted {
message := fmt.Sprintf("Invalid attempt to confirm deletion of object in status %s\n", status)
if log.IsLogging(logger.ERROR) {
log.Error(message)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: message}
}
if c, err := store.DecrementAndReturnRemainingConsumers(orgID, objectType, objectID); err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Error in objectDeleted: failed to decrement consumers count. Error: %s\n", err)
}
common.ObjectLocks.Unlock(lockIndex)
} else if c == 0 {
notificationsInfo, err := communications.PrepareObjectStatusNotification(*metaData, common.Deleted)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return err
}
return communications.SendNotifications(notificationsInfo)
} else {
common.ObjectLocks.Unlock(lockIndex)
}
} else {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("metaData.Deleted of %s %s is: %t, get lastRemovedPolicyServices\n", objectType, objectID, metaData.Deleted)
}
_, lastRemovedPolicyServices, err := store.RetrieveObjectAndRemovedDestinationPolicyServices(orgID, objectType, objectID)
if err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to find lastDestinationPolicyServices for object %s to confirm service reference change. Error: %s", orgID+":"+objectType+":"+objectID, err.Error())
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
if len(lastRemovedPolicyServices) == 0 {
message := fmt.Sprintln("Invalid attempt to confirm deletion of object with empty lastRemovedPolicyServices list")
if log.IsLogging(logger.ERROR) {
log.Error(message)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: message}
}
// only for debugging:
if trace.IsLogging(logger.DEBUG) {
trace.Debug("length of lastRemovedPolicyServices: %d\n", len(lastRemovedPolicyServices))
trace.Debug("Get lastRemovedPolicyServices: \n")
for _, s := range lastRemovedPolicyServices {
trace.Debug("%s/%s/%s \n", s.OrgID, s.Version, s.ServiceName)
}
trace.Debug("Remove serviceID: %s from ESS lastRemovedPolicyServices\n", userID)
trace.Debug("lastRemovedPolicyServices length before removal: %d\n", len(lastRemovedPolicyServices))
}
updatedLastRemovePolicyServices, removed := common.RemoveServiceFromServiceList(userID, lastRemovedPolicyServices)
if !removed {
message := fmt.Sprintln("Invalid attempt to confirm deletion of object for service not in lastRemovedPolicyServices")
if log.IsLogging(logger.ERROR) {
log.Error(message)
}
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: message}
}
if trace.IsLogging(logger.DEBUG) {
trace.Debug("lastRemovedPolicyServices length after removal: %d\n", len(updatedLastRemovePolicyServices))
}
if err = store.UpdateRemovedDestinationPolicyServices(orgID, objectType, objectID, updatedLastRemovePolicyServices); err != nil {
if log.IsLogging(logger.ERROR) {
log.Error("Failed to update lastDestinationPolicyServices for object %s to confirm service reference change. Error: %s", orgID+":"+objectType+":"+objectID, err.Error())
}
common.ObjectLocks.Unlock(lockIndex)
return err
}
// only for debugging:
if trace.IsLogging(logger.DEBUG) {
_, lastRemovedPolicyServices, err = store.RetrieveObjectAndRemovedDestinationPolicyServices(orgID, objectType, objectID)
trace.Debug("Get lastRemovedPolicyServices again: \n")
if err != nil {
trace.Debug("RetrieveObjectAndRemovedDestinationPolicyServices err: %s\n", err)
common.ObjectLocks.Unlock(lockIndex)
}
for _, s := range lastRemovedPolicyServices {
trace.Debug("%s/%s/%s \n", s.OrgID, s.Version, s.ServiceName)
}
}
// keep this line
common.ObjectLocks.Unlock(lockIndex)
}
return nil
}
// DeleteObject deletes an object from storage
// Call the storage module to delete the object and return the response
func DeleteObject(orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In DeleteObject. Delete %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
if metaData == nil {
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Object not found"}
}
if status != common.NotReadyToSend && status != common.ReadyToSend {
// This node is not the originator of the object being deleted.
// ESS is not allowed to remove such objects
if common.Configuration.NodeType == common.ESS {
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Can't delete object on the receiving side for ESS"}
}
// CSS removes them without notifying the other side
err = storage.DeleteStoredObject(store, *metaData)
common.ObjectLocks.Unlock(lockIndex)
return err
}
if err := storage.DeleteStoredData(store, *metaData); err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
if err := store.MarkObjectDeleted(orgID, objectType, objectID); err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
// Notify the receivers of the object that it was deleted
notificationsInfo, err := communications.PrepareDeleteNotifications(*metaData)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return err
}
return communications.SendNotifications(notificationsInfo)
}
// ActivateObject activates an inactive object
// Call the storage module to activate the object and return the response
func ActivateObject(orgID string, objectType string, objectID string) common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ActivateObject. Activate %s %s\n", objectType, objectID)
}
common.HealthStatus.ClientRequestReceived()
lockIndex := common.HashStrings(orgID, objectType, objectID)
apiObjectLocks.Lock(lockIndex)
defer apiObjectLocks.Unlock(lockIndex)
common.ObjectLocks.Lock(lockIndex)
metaData, status, err := store.RetrieveObjectAndStatus(orgID, objectType, objectID)
if err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
if metaData == nil {
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Object not found"}
}
if status != common.NotReadyToSend && status != common.ReadyToSend {
common.ObjectLocks.Unlock(lockIndex)
return &common.InvalidRequest{Message: "Can't activate object on the receiving side"}
}
if err := store.ActivateObject(orgID, objectType, objectID); err != nil {
common.ObjectLocks.Unlock(lockIndex)
return err
}
if status == common.ReadyToSend {
notificationsInfo, err := communications.PrepareObjectNotifications(*metaData)
common.ObjectLocks.Unlock(lockIndex)
if err != nil {
return err
}
return communications.SendNotifications(notificationsInfo)
}
common.ObjectLocks.Unlock(lockIndex)
return nil
}
// ListDestinations lists all destinations
func ListDestinations(orgID string) ([]common.Destination, common.SyncServiceError) {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ListDestinations.\n")
}
common.HealthStatus.ClientRequestReceived()
apiLock.RLock()
defer apiLock.RUnlock()
return store.RetrieveDestinations(orgID, "")
}
// ResendObjects asks the other side to resend all the relevant objects
func ResendObjects() common.SyncServiceError {
if trace.IsLogging(logger.DEBUG) {
trace.Debug("In ResendObjects.\n")
}
common.HealthStatus.ClientRequestReceived()
if common.Configuration.NodeType == common.CSS {
return &common.InvalidRequest{Message: "CSS can't request to resend objects"}
}
return communications.ResendObjects()
}
// Delete the organization
func deleteOrganization(orgID string) common.SyncServiceError {
common.HealthStatus.ClientRequestReceived()
if common.Configuration.NodeType == common.ESS {
return &common.InvalidRequest{Message: "ESS can't delete organization"}
}
if common.SingleOrgCSS {
return &common.InvalidRequest{Message: "Can't modify organizations for single organization CSS"}
}
apiLock.Lock()
defer apiLock.Unlock()
if err := store.DeleteOrganization(orgID); err != nil {
return err
}
if err := store.DeleteOrganizationInfo(orgID); err != nil {
return err
}
return communications.Comm.DeleteOrganization(orgID)
}
func updateOrganization(orgID string, org common.Organization) common.SyncServiceError {
common.HealthStatus.ClientRequestReceived()
if !common.IsValidName(orgID) {
return &common.InvalidRequest{Message: fmt.Sprintf("Organization ID (%s) contains invalid characters", orgID)}
}
if common.Configuration.NodeType == common.ESS {
return &common.InvalidRequest{Message: "ESS can't add organization"}
}
if common.SingleOrgCSS {
return &common.InvalidRequest{Message: "Can't modify organizations for single organization CSS"}
}
if common.Configuration.CSSOnWIoTP {
return &common.InvalidRequest{Message: "Can't modify organizations for CSS on WIoTP "}
}