-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmain.go
963 lines (889 loc) · 32.3 KB
/
main.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
package main
import (
"encoding/json"
"flag"
"fmt"
"log"
"math"
"os"
"strconv"
"time"
"github.com/fatih/color"
apiLib "github.com/hornbill/goApiLib"
hornbillHelpers "github.com/hornbill/goHornbillHelpers"
"github.com/tcnksm/go-latest"
)
var (
logTimeNow string
)
func main() {
parseFlags()
//-- If configVersion just output version number and die
if configVersion {
fmt.Printf("%v \n", version)
return
}
logTimeNow = time.Now().Format("20060102150405.999999")
//Does endpoint exist?
instanceEndpoint := apiLib.GetEndPointFromName(configInstance)
if instanceEndpoint == "" {
color.Red("The provided instance ID [" + configInstance + "] could not be found.")
return
}
//Create new session
espXmlmc = apiLib.NewXmlmcInstance(configInstance)
espXmlmc.SetAPIKey(configAPIKey)
espLogger("********** Cleaner Utility Started **********", "notice")
defer espLogger("********** Cleaner Utility Completed **********", "notice")
checkVersion()
var err error
//Load the configuration file
cleanerConf, err = loadConfig()
if err != nil {
color.Red("Error decoding configuration file " + configFileName + " : " + err.Error())
espLogger("Error decoding configuration file "+configFileName+" : "+err.Error(), "error")
return
}
fmt.Println("")
fmt.Println("===== Hornbill Cleaner Utility v" + version + " =====")
//Check config to make sure we have cleaning definitions
if !cleanerConf.CleanRequests &&
!cleanerConf.CleanAssets &&
!cleanerConf.CleanUsers &&
!cleanerConf.CleanServiceAvailabilityHistory &&
!cleanerConf.CleanContacts &&
!cleanerConf.CleanOrganisations &&
!cleanerConf.CleanSuppliers &&
!cleanerConf.CleanSupplierContracts &&
!cleanerConf.CleanEmails &&
!cleanerConf.CleanReports &&
!cleanerConf.CleanChatSessions {
color.Red("No entity data has been specified for cleansing in " + configFileName)
espLogger("No entity data has been specified for cleansing in "+configFileName, "error")
return
}
if cleanerConf.CleanServiceAvailabilityHistory && len(cleanerConf.ServiceAvailabilityServiceIDs) == 0 {
color.Red("CleanServiceAvailabilityHistory is set to true but no ServiceAvailabilityServiceIDs have been specified for cleaning in " + configFileName)
espLogger("CleanServiceAvailabilityHistory is set to true but no ServiceAvailabilityServiceIDs have been specified for cleaning in "+configFileName, "error")
return
}
if cleanerConf.CleanEmails {
if len(cleanerConf.EmailFilters.FolderIDs) == 0 {
color.Red("CleanEmails is set to true but no FolderIDs have been specified for cleaning in " + configFileName)
espLogger("CleanEmails is set to true but no FolderIDs have been specified for cleaning in "+configFileName, "error")
return
}
}
if cleanerConf.CleanReports {
if len(cleanerConf.ReportIDs) == 0 {
color.Red("CleanReports is set to true but no ReportIDs have been specified for cleaning in " + configFileName)
espLogger("CleanReports is set to true but no ReportIDs have been specified for cleaning in "+configFileName, "error")
return
}
}
//Ask if we want to delete before continuing
fmt.Println("")
if configDryRun {
color.Green(" Hornbill instance: " + configInstance)
color.Green(" DryRun Mode Active. No records will be deleted.")
color.Green(" This utility will output to the log a list of all records that would have be deleted")
color.Green(" as specified in your configuration file: ")
} else {
color.Red(" Hornbill instance: " + configInstance)
color.Red(" WARNING!")
color.Red(" This utility will attempt to delete records from the following entities")
color.Red(" as specified in your configuration file: ")
}
fmt.Println("")
if cleanerConf.CleanRequests {
color.Magenta(" * Requests (and related data)")
}
if cleanerConf.CleanAssets {
color.Magenta(" * Assets (and related data)")
}
if cleanerConf.CleanUsers {
color.Magenta(" * Specified Users (and related data)")
}
if cleanerConf.CleanServiceAvailabilityHistory && len(cleanerConf.ServiceAvailabilityServiceIDs) > 0 {
color.Magenta(" * Service Availability History for the configuration defined service IDs")
}
if cleanerConf.CleanContacts && len(cleanerConf.ContactIDs) > 0 {
color.Magenta(" * Specified Contacts")
}
if cleanerConf.CleanOrganisations && len(cleanerConf.OrganisationIDs) > 0 {
color.Magenta(" * Specified Organisations")
}
if cleanerConf.CleanSuppliers && len(cleanerConf.SupplierIDs) > 0 {
color.Magenta(" * Specified Suppliers")
}
if cleanerConf.CleanSupplierContracts && len(cleanerConf.SupplierContractIDs) > 0 {
color.Magenta(" * Specified Supplier Contracts")
}
if cleanerConf.CleanEmails {
color.Magenta(" * Emails (and related data)")
}
if cleanerConf.CleanReports {
color.Magenta(" * Specified Reports")
}
if cleanerConf.CleanChatSessions {
if len(cleanerConf.ChatSessionIDs) > 0 {
color.Magenta(" * " + strconv.Itoa(len(cleanerConf.ChatSessionIDs)) + " Specified Chat Sessions")
} else {
color.Magenta(" * ALL Chat Sessions from Live Chat")
}
}
fmt.Println("")
if !configSkipPrompts {
fmt.Println("Are you sure you want to permanently delete these records? (yes/no):")
if !hornbillHelpers.ConfirmResponse("") {
espLogger("Confirmation Prompts Rejected", "info")
return
}
color.Red("Are you absolutely sure? Type in the word 'delete' to confirm...")
if !hornbillHelpers.ConfirmResponse("delete") {
espLogger("Confirmation Prompts Rejected", "info")
return
}
espLogger("Confirmation Prompts Accepted", "info")
} else {
espLogger("Confirmation Prompts Skipped", "info")
}
//Log the config
logConfig()
processRequests()
processAssets()
processServiceAvailabilityHistory()
processContacts()
processOrgs()
processSuppliers()
processSupplierContracts()
processEmails()
processChatSessions()
if cleanerConf.CleanUsers {
espLogger("[USERS] Attempting to delete "+strconv.Itoa(len(cleanerConf.Users))+" Users", "info")
for _, v := range cleanerConf.Users {
espLogger("[USER] "+v, "info")
if !configDryRun {
deleteUser(v)
}
}
}
if cleanerConf.CleanReports {
espLogger("[REPORTS] Attempting to delete "+strconv.Itoa(len(cleanerConf.ReportIDs))+" Reports", "info")
for _, v := range cleanerConf.ReportIDs {
espLogger("[REPORT] "+strconv.Itoa(v), "info")
if !configDryRun {
deleteReport(v)
}
}
}
}
func logConfig() {
espLogger("Config File Name: "+configFileName, "info")
espLogger("Dry Run: "+strconv.FormatBool(configDryRun), "info")
espLogger("Skip Prompts: "+strconv.FormatBool(configSkipPrompts), "info")
espLogger("CleanRequests: "+strconv.FormatBool(cleanerConf.CleanRequests), "info")
if cleanerConf.CleanRequests {
noFilters := true
if len(cleanerConf.RequestServices) > 0 {
noFilters = false
espLogger("Filtered by Service ID(s)", "info")
for _, v := range cleanerConf.RequestServices {
espLogger("Service ID: "+strconv.Itoa(v), "info")
}
}
if len(cleanerConf.RequestCatalogItems) > 0 {
noFilters = false
espLogger("Filtered by Catalog Item ID(s)", "info")
for _, v := range cleanerConf.RequestCatalogItems {
espLogger("Catalog Item ID: "+strconv.Itoa(v), "info")
}
}
if len(cleanerConf.RequestStatuses) > 0 {
noFilters = false
espLogger("Filtered by Request Status(es)", "info")
for _, v := range cleanerConf.RequestStatuses {
espLogger("Request Status: "+v, "info")
}
}
if len(cleanerConf.RequestTypes) > 0 {
noFilters = false
espLogger("Filtered by Request Type(s)", "info")
for _, v := range cleanerConf.RequestTypes {
espLogger("Request Type: "+v, "info")
}
}
if len(cleanerConf.RequestReferences) > 0 {
noFilters = false
espLogger("Filtered by Request Reference(s)", "info")
for _, v := range cleanerConf.RequestReferences {
espLogger("Request Reference: "+v, "info")
}
}
if cleanerConf.RequestLogDateFrom != "" {
noFilters = false
espLogger("Filtered by RequestLogDateFrom: "+cleanerConf.RequestLogDateFrom, "info")
}
if cleanerConf.RequestLogDateTo != "" {
noFilters = false
espLogger("Filtered by RequestLogDateTo: "+cleanerConf.RequestLogDateTo, "info")
}
if cleanerConf.RequestClosedDateFrom != "" {
noFilters = false
espLogger("Filtered by RequestCloseDateFrom: "+cleanerConf.RequestClosedDateFrom, "info")
}
if cleanerConf.RequestClosedDateTo != "" {
noFilters = false
espLogger("Filtered by RequestCloseDateTo: "+cleanerConf.RequestClosedDateTo, "info")
}
if noFilters {
espLogger("No Request filters specified, all Requests and associated data will be deleted.", "warn")
}
}
espLogger("CleanAssets: "+strconv.FormatBool(cleanerConf.CleanAssets), "info")
if cleanerConf.CleanAssets {
noFilters := true
if cleanerConf.AssetClassID != "" {
noFilters = false
espLogger("Filtered by AssetClassID: "+cleanerConf.AssetClassID, "info")
}
if len(cleanerConf.AssetFilters) > 0 {
noFilters = false
espLogger("Asset Filters:", "info")
for k, v := range cleanerConf.AssetFilters {
espLogger("==== Filter "+strconv.Itoa(k)+" ====", "info")
espLogger("Column Name: "+v.ColumnName, "info")
espLogger("Column Value: "+v.ColumnValue, "info")
espLogger("Operator: "+v.Operator, "info")
espLogger("Is General Property: "+strconv.FormatBool(v.IsGeneralProperty), "info")
}
}
if noFilters {
espLogger("No Asset filters specified, all Assets and associated data will be deleted.", "warn")
}
}
espLogger("CleanUsers: "+strconv.FormatBool(cleanerConf.CleanUsers), "info")
if cleanerConf.CleanUsers {
noFilters := true
if len(cleanerConf.Users) > 0 {
noFilters = false
espLogger("Users to delete:", "info")
for _, v := range cleanerConf.Users {
espLogger("User ID: "+v, "info")
}
}
if noFilters {
espLogger("No Users specified. No Users will be deleted.", "warn")
}
}
espLogger("CleanServiceAvailabilityHistory: "+strconv.FormatBool(cleanerConf.CleanServiceAvailabilityHistory), "info")
if cleanerConf.CleanServiceAvailabilityHistory {
noFilters := true
if len(cleanerConf.ServiceAvailabilityServiceIDs) > 0 {
noFilters = false
espLogger("Service IDs for Service Availability records to delete:", "info")
for _, v := range cleanerConf.ServiceAvailabilityServiceIDs {
espLogger("Service ID: "+strconv.Itoa(v), "info")
}
}
if noFilters {
espLogger("No Service IDs specified. No Service Availability data will be deleted.", "warn")
}
}
espLogger("CleanContacts: "+strconv.FormatBool(cleanerConf.CleanContacts), "info")
if cleanerConf.CleanContacts {
noFilters := true
if len(cleanerConf.ContactIDs) > 0 {
noFilters = false
espLogger("Contact IDs to delete:", "info")
for _, v := range cleanerConf.ContactIDs {
espLogger("Contact ID: "+strconv.Itoa(v), "info")
}
}
if noFilters {
espLogger("No Contacts specified. No Contacts will be deleted.", "warn")
}
}
espLogger("CleanOrganisations: "+strconv.FormatBool(cleanerConf.CleanOrganisations), "info")
if cleanerConf.CleanOrganisations {
noFilters := true
if len(cleanerConf.OrganisationIDs) > 0 {
noFilters = false
espLogger("Organisation IDs to delete:", "info")
for _, v := range cleanerConf.OrganisationIDs {
espLogger("Organisation ID: "+strconv.Itoa(v), "info")
}
}
if noFilters {
espLogger("No Organisation ID specified. No Organisations will be deleted.", "warn")
}
}
espLogger("CleanSuppliers: "+strconv.FormatBool(cleanerConf.CleanSuppliers), "info")
if cleanerConf.CleanSuppliers {
noFilters := true
if len(cleanerConf.SupplierIDs) > 0 {
noFilters = false
espLogger("Supplier IDs to delete:", "info")
for _, v := range cleanerConf.SupplierIDs {
espLogger("Supplier ID: "+strconv.Itoa(v), "info")
}
}
if noFilters {
espLogger("No Supplier IDs specified. No Suppliers will be deleted.", "warn")
}
}
espLogger("CleanSupplierContracts: "+strconv.FormatBool(cleanerConf.CleanSupplierContracts), "info")
if cleanerConf.CleanSupplierContracts {
noFilters := true
if len(cleanerConf.SupplierContractIDs) > 0 {
noFilters = false
espLogger("Supplier Contract IDs to delete:", "info")
for _, v := range cleanerConf.SupplierContractIDs {
espLogger("Supplier Contract ID: "+v, "info")
}
}
if noFilters {
espLogger("No Supplier Contract IDs specified. No Supplier Contracts will be deleted.", "warn")
}
}
espLogger("CleanEmails: "+strconv.FormatBool(cleanerConf.CleanEmails), "info")
if cleanerConf.CleanSupplierContracts {
noFilters := true
if len(cleanerConf.EmailFilters.FolderIDs) > 0 {
noFilters = false
espLogger("Folder IDs to filter by:", "info")
for _, v := range cleanerConf.EmailFilters.FolderIDs {
espLogger("Folder ID: "+strconv.Itoa(v), "info")
}
}
if cleanerConf.EmailFilters.RecipientAddress != "" {
noFilters = false
espLogger("Recipient Address to filter emails by: "+cleanerConf.EmailFilters.RecipientAddress, "info")
}
if cleanerConf.EmailFilters.RecipientClass != "" {
noFilters = false
espLogger("Recipient Class to filter emails by: "+cleanerConf.EmailFilters.RecipientClass, "info")
}
if cleanerConf.EmailFilters.ReceivedFrom != "" {
noFilters = false
espLogger("Received From to filter emails by: "+cleanerConf.EmailFilters.ReceivedFrom, "info")
}
if cleanerConf.EmailFilters.ReceivedTo != "" {
noFilters = false
espLogger("Received To to filter emails by: "+cleanerConf.EmailFilters.ReceivedTo, "info")
}
if cleanerConf.EmailFilters.Subject != "" {
noFilters = false
espLogger("Subject to filter emails by: "+cleanerConf.EmailFilters.Subject, "info")
}
if noFilters {
espLogger("No Email Filters supplied. No Email records will be deleted.", "warn")
}
}
espLogger("CleanChatSessions: "+strconv.FormatBool(cleanerConf.CleanChatSessions), "info")
if cleanerConf.CleanChatSessions {
if len(cleanerConf.ChatSessionIDs) > 0 {
espLogger("Chat Sessions to delete:", "info")
for _, v := range cleanerConf.ChatSessionIDs {
espLogger("Chat Session ID: "+v, "info")
}
} else {
espLogger("No Chat Session IDs specified. ALL Chat Sessions will be deleted.", "warn")
}
}
}
func isAppInstalled(appName string, buildVer int) bool {
apps, success := getAppList()
if success {
for _, v := range apps {
if v.Name == appName && v.Build >= buildVer {
return true
}
}
}
return false
}
func processContacts() {
//Process Contact Records
if cleanerConf.CleanContacts {
contactCount := 0
if len(cleanerConf.ContactIDs) > 0 {
currentBlock = 0
displayBlock = 1
contactCount = len(cleanerConf.ContactIDs)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
contactBlocks := float64(contactCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(contactBlocks))
espLogger("Number of Contacts to delete: "+strconv.Itoa(contactCount), "debug")
color.Green("Number of Contacts to delete: " + strconv.Itoa(contactCount))
processEntityClean("Contact", configBlockSize, "", "", 0)
} else {
espLogger("There are no contacts to delete.", "debug")
color.Red("There are no contacts to delete.")
}
}
}
func processOrgs() {
//Process Org Records
if cleanerConf.CleanOrganisations {
orgCount := 0
if len(cleanerConf.OrganisationIDs) > 0 {
currentBlock = 0
displayBlock = 1
orgCount = len(cleanerConf.OrganisationIDs)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
orgBlocks := float64(orgCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(orgBlocks))
espLogger("Number of Organisations to delete: "+strconv.Itoa(orgCount), "debug")
color.Green("Number of Organisations to delete: " + strconv.Itoa(orgCount))
processEntityClean("Organizations", configBlockSize, "", "", 0)
} else {
espLogger("There are no organisations to delete.", "debug")
color.Red("There are no organisations to delete.")
}
}
}
func processSuppliers() {
//Process Supplier Records
if cleanerConf.CleanSuppliers {
count := 0
if len(cleanerConf.SupplierIDs) > 0 {
currentBlock = 0
displayBlock = 1
count = len(cleanerConf.SupplierIDs)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
blocks := float64(count) / float64(configBlockSize)
totalBlocks = int(math.Ceil(blocks))
espLogger("Number of Suppliers to delete: "+strconv.Itoa(count), "debug")
color.Green("Number of Suppliers to delete: " + strconv.Itoa(count))
processEntityClean("Suppliers", configBlockSize, "", "", 0)
} else {
espLogger("There are no Suppliers to delete.", "debug")
color.Red("There are no Suppliers to delete.")
}
}
}
func processChatSessions() {
if cleanerConf.CleanChatSessions {
chatSessionCount := 0
if len(cleanerConf.ChatSessionIDs) > 0 {
currentBlock = 0
displayBlock = 1
chatSessionCount = len(cleanerConf.ChatSessionIDs)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
chatSessionBlocks := float64(chatSessionCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(chatSessionBlocks))
espLogger("Number of Chat Sessions to delete: "+strconv.Itoa(chatSessionCount), "debug")
color.Green("Number of Chat Sessions to delete: " + strconv.Itoa(chatSessionCount))
processEntityClean("ChatSessions", configBlockSize, "", "", 0)
} else {
chatSessionCount = getChatSessionCount()
if chatSessionCount > 0 {
currentBlock = 0
displayBlock = 1
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
chatSessionBlocks := float64(chatSessionCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(chatSessionBlocks))
espLogger("Chat Session Blocks: "+strconv.Itoa(int(chatSessionBlocks)), "debug")
espLogger("Total Blocks: "+strconv.Itoa(totalBlocks), "debug")
espLogger("Number of Chat Sessions to delete: "+strconv.Itoa(chatSessionCount), "debug")
processEntityClean("ChatSessions", configBlockSize, "", "", 0)
} else {
espLogger("There are no Chat Sessions to delete.", "debug")
color.Red("There are no Chat Sessions to delete.")
}
}
}
}
func processSupplierContracts() {
//Process Supplier Contract Records
if cleanerConf.CleanSupplierContracts {
count := 0
if len(cleanerConf.SupplierContractIDs) > 0 {
currentBlock = 0
displayBlock = 1
count = len(cleanerConf.SupplierContractIDs)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
blocks := float64(count) / float64(configBlockSize)
totalBlocks = int(math.Ceil(blocks))
espLogger("Number of Supplier Contracts to delete: "+strconv.Itoa(count), "debug")
color.Green("Number of Supplier Contracts to delete: " + strconv.Itoa(count))
processEntityClean("SupplierContracts", configBlockSize, "", "", 0)
} else {
espLogger("There are no Supplier Contracts to delete.", "debug")
color.Red("There are no Supplier Contracts to delete.")
}
}
}
func processRequests() {
//Process Request Records
if cleanerConf.CleanRequests {
//Is Board Manager installed
boardManagerInstalled = isAppInstalled(appBM, minBoardManagerBuild)
requestCount := 0
if len(cleanerConf.RequestReferences) > 0 {
currentBlock = 0
displayBlock = 1
requestCount = len(cleanerConf.RequestReferences)
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
requestBlocks := float64(requestCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(requestBlocks))
if !configDryRun {
espLogger("Number of Requests to delete: "+strconv.Itoa(requestCount), "debug")
color.Green("Number of Requests to delete: " + strconv.Itoa(requestCount))
processEntityClean("Requests", configBlockSize, "", "", 0)
}
} else {
requestCount = getRecordCount("h_itsm_requests", "", "")
if requestCount > 0 {
currentBlock = 0
displayBlock = 1
espLogger("Block Size: "+strconv.Itoa(configBlockSize), "debug")
requestBlocks := float64(requestCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(requestBlocks))
espLogger("Request Blocks: "+strconv.Itoa(int(requestBlocks)), "debug")
espLogger("Total Blocks: "+strconv.Itoa(totalBlocks), "debug")
espLogger("Number of Requests to delete: "+strconv.Itoa(requestCount), "debug")
processEntityClean("Requests", configBlockSize, "", "", 0)
} else {
espLogger("There are no requests to delete.", "debug")
color.Red("There are no requests to delete.")
}
}
}
}
func processEmails() {
//Process Email Records
if cleanerConf.CleanEmails {
emailCount := getEmailCount()
if emailCount > 0 {
currentBlock = 0
displayBlock = 1
emailBlocks := float64(emailCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(emailBlocks))
espLogger("Number of emails to delete: "+strconv.Itoa(emailCount), "debug")
color.Green("Number of emails to delete: " + strconv.Itoa(emailCount))
processEntityClean("Email", configBlockSize, "", "", 0)
} else {
espLogger("There are no emails to delete.", "debug")
color.Red("There are no emails to delete.")
}
}
}
func processAssets() {
//Process Asset Records
if cleanerConf.CleanAssets {
var assetCount int
if len(cleanerConf.AssetIDs) > 0 {
assetCount = len(cleanerConf.AssetIDs)
} else {
assetCount = getAssetCount()
}
if assetCount > 0 {
currentBlock = 0
displayBlock = 1
assetBlocks := float64(assetCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(assetBlocks))
espLogger("Number of Assets to delete: "+strconv.Itoa(assetCount), "debug")
processEntityClean("Asset", configBlockSize, "", "", 0)
} else {
espLogger("There are no assets to delete.", "debug")
color.Red("There are no assets to delete.")
}
//Cycle through assets that have been deleted, delete any links associated with them
for _, assetURN := range assetsDeleted {
//Process LEFT to RIGHT links
color.Green("Processing LEFT to RIGHT asset links for " + assetURN)
assetLinkCount := getRecordCount("h_cmdb_links", assetURN, "h_fk_id_l")
if assetLinkCount > 0 {
currentBlock = 0
displayBlock = 1
assetLinkBlocks := float64(assetLinkCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(assetLinkBlocks))
espLogger("Number of Left Asset Links to delete for asset "+assetURN+": "+strconv.Itoa(assetLinkCount), "debug")
processEntityClean("AssetsLinks", configBlockSize, assetURN, "left", 0)
} else {
espLogger("There are no left-asset links to delete for "+assetURN, "debug")
color.Red("There are no left-asset links to delete.")
}
}
for _, assetURN := range assetsDeleted {
//Process RIGHT to LEFT links
color.Green("Processing RIGHT to LEFT asset links for " + assetURN)
assetLinkCount := getRecordCount("h_cmdb_links", assetURN, "h_fk_id_r")
if assetLinkCount > 0 {
currentBlock = 0
displayBlock = 1
assetLinkBlocks := float64(assetLinkCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(assetLinkBlocks))
espLogger("Number of right Asset Links to delete for asset "+assetURN+": "+strconv.Itoa(assetLinkCount), "debug")
processEntityClean("AssetsLinks", configBlockSize, assetURN, "right", 0)
} else {
espLogger("There are no right-asset links to delete for "+assetURN, "debug")
color.Red("There are no right-asset links to delete.")
}
}
}
}
func processServiceAvailabilityHistory() {
//Process Service Availability Records
if cleanerConf.CleanServiceAvailabilityHistory {
sahCount := getServiceAvailabilityHistoryCount()
if sahCount > 0 {
currentBlock = 0
displayBlock = 1
sahBlocks := float64(sahCount) / float64(configBlockSize)
totalBlocks = int(math.Ceil(sahBlocks))
espLogger("Number of ServiceStatusHistory records to delete: "+strconv.Itoa(sahCount), "debug")
processEntityClean("ServiceStatusHistory", configBlockSize, "", "", 0)
} else {
espLogger("There are no ServiceStatusHistory records to delete.", "debug")
color.Red("There are no ServiceStatusHistory records to delete.")
}
}
}
func parseFlags() {
flag.StringVar(&configFileName, "file", "conf.json", "Name of Configuration File To Load")
flag.IntVar(&configBlockSize, "blocksize", 3, "Number of records to delete per block")
flag.StringVar(&configAPIKey, "apikey", "", "API key to authenticate the session with")
flag.StringVar(&configInstance, "instance", "", "ID of the instance (case sensitive)")
flag.BoolVar(&configDryRun, "dryrun", false, "DryRun mode - outputs record keys to log for review without deleting anything")
flag.BoolVar(&configSkipPrompts, "justrun", false, "Set to true to run the cleanup without the prompts")
flag.BoolVar(&configVersion, "version", false, "Returns the tool version")
flag.Parse()
}
// processEntityClean - iterates through and processes record blocks of size defined in flag configBlockSize
func processEntityClean(entity string, chunkSize int, assetURN, assetLinkDirection string, recordCount int) {
if entity == "Requests" && len(cleanerConf.RequestReferences) > 0 {
//Split request slice in to chunks
var divided [][]string
for i := 0; i < len(cleanerConf.RequestReferences); i += chunkSize {
batch := cleanerConf.RequestReferences[i:getLowerInt(i+chunkSize, len(cleanerConf.RequestReferences))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var requestDataToStruct []dataStruct
for _, v := range block {
requestDataToStruct = append(requestDataToStruct, dataStruct{RequestID: v})
}
deleteRecords(entity, requestDataToStruct)
}
} else if entity == "Contact" && len(cleanerConf.ContactIDs) > 0 {
//Split request slice in to chunks
var divided [][]int
for i := 0; i < len(cleanerConf.ContactIDs); i += chunkSize {
batch := cleanerConf.ContactIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.ContactIDs))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var contactDataToStruct []dataStruct
for _, v := range block {
contactDataToStruct = append(contactDataToStruct, dataStruct{ContactID: v})
}
deleteRecords(entity, contactDataToStruct)
}
} else if entity == "Organizations" && len(cleanerConf.OrganisationIDs) > 0 {
//Split request slice in to chunks
var divided [][]int
for i := 0; i < len(cleanerConf.OrganisationIDs); i += chunkSize {
batch := cleanerConf.OrganisationIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.OrganisationIDs))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var orgDataToStruct []dataStruct
for _, v := range block {
orgDataToStruct = append(orgDataToStruct, dataStruct{OrgID: v})
}
deleteRecords(entity, orgDataToStruct)
}
} else if entity == "Suppliers" && len(cleanerConf.SupplierIDs) > 0 {
//Split request slice in to chunks
var divided [][]int
for i := 0; i < len(cleanerConf.SupplierIDs); i += chunkSize {
batch := cleanerConf.SupplierIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.SupplierIDs))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var dataToStruct []dataStruct
for _, v := range block {
dataToStruct = append(dataToStruct, dataStruct{SuppID: v})
}
deleteRecords(entity, dataToStruct)
}
} else if entity == "SupplierContracts" && len(cleanerConf.SupplierContractIDs) > 0 {
//Split request slice in to chunks
var divided [][]string
for i := 0; i < len(cleanerConf.SupplierContractIDs); i += chunkSize {
batch := cleanerConf.SupplierContractIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.SupplierContractIDs))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var dataToStruct []dataStruct
for _, v := range block {
dataToStruct = append(dataToStruct, dataStruct{SuppConID: v})
}
deleteRecords(entity, dataToStruct)
}
} else if entity == "AssetsLinks" {
exitLoop := false
for !exitLoop {
AllRecordIDs := getAssetLinkIDs(assetURN, assetLinkDirection)
if len(AllRecordIDs) == 0 {
exitLoop = true
continue
}
deleteRecords(entity, AllRecordIDs)
}
} else if entity == "ChatSessions" {
// Get all records first
// Loop through in given block size
if len(cleanerConf.ChatSessionIDs) > 0 {
// Delete list of chat sessions
var divided [][]string
for i := 0; i < len(cleanerConf.ChatSessionIDs); i += chunkSize {
batch := cleanerConf.ChatSessionIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.ChatSessionIDs))]
divided = append(divided, batch)
}
//range through slice, delete chat session chunks
for _, block := range divided {
var chatDataToStruct []dataStruct
for _, v := range block {
chatDataToStruct = append(chatDataToStruct, dataStruct{ChatSessionID: v})
}
deleteRecords(entity, chatDataToStruct)
}
if configDryRun {
color.Green("[DRYRUN] " + strconv.Itoa(len(cleanerConf.ChatSessionIDs)) + " Chat Sessions would have been deleted ")
}
} else {
// Delete all chat sessions
var divided [][]string
allChatSessions := getChatSessionRecords(recordCount)
for i := 0; i < len(allChatSessions); i += chunkSize {
batch := allChatSessions[i:getLowerInt(i+chunkSize, len(allChatSessions))]
divided = append(divided, batch)
}
//range through slice, delete chat session chunks
for _, block := range divided {
var chatDataToStruct []dataStruct
for _, v := range block {
chatDataToStruct = append(chatDataToStruct, dataStruct{ChatSessionID: v})
}
deleteRecords(entity, chatDataToStruct)
}
if configDryRun {
color.Green("[DRYRUN] " + strconv.Itoa(len(allChatSessions)) + " Chat Sessions would have been deleted ")
}
}
} else if entity == "Asset" && len(cleanerConf.AssetIDs) > 0 {
//Split request slice in to chunks
var divided [][]string
for i := 0; i < len(cleanerConf.AssetIDs); i += chunkSize {
batch := cleanerConf.AssetIDs[i:getLowerInt(i+chunkSize, len(cleanerConf.AssetIDs))]
divided = append(divided, batch)
}
//range through slice, delete request chunks
for _, block := range divided {
var assetDataToStruct []dataStruct
for _, v := range block {
assetDataToStruct = append(assetDataToStruct, dataStruct{AssetID: v})
}
deleteRecords(entity, assetDataToStruct)
}
} else {
exitLoop := false
for !exitLoop {
AllRecordIDs := getRecordIDs(entity)
if len(AllRecordIDs) == 0 {
exitLoop = true
continue
}
deleteRecords(entity, AllRecordIDs)
}
}
}
// getLowerInt
func getLowerInt(a, b int) int {
if a <= b {
return a
}
return b
}
// loadConfig - loads configuration file in to struct
func loadConfig() (cleanerConfStruct, error) {
cwd, _ := os.Getwd()
configurationFilePath := cwd + "/" + configFileName
if _, fileCheckErr := os.Stat(configurationFilePath); os.IsNotExist(fileCheckErr) {
log.Fatal(fileCheckErr)
}
file, fileError := os.Open(configurationFilePath)
if fileError != nil {
log.Fatal(fileError)
}
decoder := json.NewDecoder(file)
conf := cleanerConfStruct{}
err := decoder.Decode(&conf)
return conf, err
}
// espLogger -- Log to ESP
func espLogger(message string, severity string) {
if configDryRun {
message = "[DRYRUN] " + message
}
espXmlmc.SetParam("fileName", "HornbillCleanerUtility")
espXmlmc.SetParam("group", "general")
espXmlmc.SetParam("severity", severity)
espXmlmc.SetParam("message", message)
espXmlmc.Invoke("system", "logMessage")
logger(message)
}
// logger -- function to append to the current log file
func logger(s string) {
cwd, _ := os.Getwd()
logPath := cwd + "/log"
logFileName := logPath + "/HornbillCleaner_" + logTimeNow + ".log"
//-- If Folder Does Not Exist then create it
if _, err := os.Stat(logPath); os.IsNotExist(err) {
err := os.Mkdir(logPath, 0777)
if err != nil {
color.Red("Error Creating Log Folder %q: %s \r", logPath, err)
os.Exit(101)
}
}
//-- Open Log File
f, err := os.OpenFile(logFileName, os.O_APPEND|os.O_CREATE|os.O_RDWR, 0777)
if err != nil {
color.Red("Error Creating Log File %q: %s \n", logFileName, err)
os.Exit(100)
}
// don't forget to close it
defer f.Close()
// assign the file to the standard logger
log.SetOutput(f)
//Write the log entry
log.Println(s)
}
// -- Check Latest
func checkVersion() {
githubTag := &latest.GithubTag{
Owner: "hornbill",
Repository: appName,
}
res, err := latest.Check(githubTag, version)
if err != nil {
msg := "Unable to check utility version against Github repository: " + err.Error()
color.Red(msg)
espLogger(msg, "error")
return
}
if res.Outdated {
msg := "v" + version + " is not latest, you should upgrade to " + res.Current + " by downloading the latest package from: https://github.com/hornbill/" + appName + "/releases/tag/v" + res.Current
color.Yellow(msg)
espLogger(msg, "warn")
}
}