-
Notifications
You must be signed in to change notification settings - Fork 38
/
payment_packet_creator.go
391 lines (340 loc) · 13.9 KB
/
payment_packet_creator.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
package ppmshipment
import (
"fmt"
"io"
"time"
"github.com/gofrs/uuid"
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu"
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model"
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu/types"
"github.com/pkg/errors"
"go.uber.org/zap"
"github.com/transcom/mymove/pkg/appcontext"
"github.com/transcom/mymove/pkg/apperror"
"github.com/transcom/mymove/pkg/models"
"github.com/transcom/mymove/pkg/paperwork"
"github.com/transcom/mymove/pkg/services"
)
var sortedExpenseType = [8]string{"WEIGHING_FEE", "RENTAL_EQUIPMENT", "CONTRACTED_EXPENSE", "OIL", "PACKING_MATERIALS", "TOLLS", "STORAGE", "OTHER"}
type paymentPacketItem struct {
Label string
Upload models.Upload
PageSize int
}
// NewFileInfo creates a new FileInfo struct.
func newPaymentPacketItem(label string, userUpload models.Upload) paymentPacketItem {
return paymentPacketItem{
Label: label,
Upload: userUpload,
PageSize: 0,
}
}
// paymentPacketCreator is the concrete struct implementing the PaymentPacketCreator interface
type paymentPacketCreator struct {
services.PPMShipmentFetcher
pdfGenerator paperwork.Generator
aoaPacketCreator services.AOAPacketCreator
}
// NewPaymentPacketCreator creates a new PaymentPacketCreator with all of its dependencies
func NewPaymentPacketCreator(
ppmShipmentFetcher services.PPMShipmentFetcher,
pdfGenerator *paperwork.Generator,
aoaPacketCreator services.AOAPacketCreator,
) services.PaymentPacketCreator {
return &paymentPacketCreator{
ppmShipmentFetcher,
*pdfGenerator,
aoaPacketCreator,
}
}
func (p *paymentPacketCreator) Generate(appCtx appcontext.AppContext, ppmShipmentID uuid.UUID, addBookmarks bool, addWatermarks bool) (io.ReadCloser, error) {
err := verifyPPMShipment(appCtx, ppmShipmentID)
if err != nil {
return nil, err
}
errMsgPrefix := "error creating payment packet"
ppmShipment, err := p.PPMShipmentFetcher.GetPPMShipment(
appCtx,
ppmShipmentID,
// Note: Orders will be generate via SSW creator service
[]string{
EagerPreloadAssociationServiceMember,
EagerPreloadAssociationWeightTickets,
EagerPreloadAssociationProgearWeightTickets,
EagerPreloadAssociationMovingExpenses,
},
[]string{
PostLoadAssociationWeightTicketUploads,
PostLoadAssociationProgearWeightTicketUploads,
PostLoadAssociationMovingExpenseUploads,
},
)
// something bad happened on data retrieval of everything for PPM
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to load PPMShipment")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, err
}
var pdfFilesToMerge []io.ReadSeeker
// use aoa creator to generated SSW and Orders PDF
aoaPacketFile, err := p.aoaPacketCreator.CreateAOAPacket(appCtx, ppmShipmentID)
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, fmt.Sprintf("failed to generate AOA packet for ppmShipmentID: %s", ppmShipmentID.String()))
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
// AOA packet will be appended at the beginning of the final pdf file
pdfFilesToMerge = append(pdfFilesToMerge, aoaPacketFile)
// Start building individual PDFs for each expense/receipt docs. These files will then be merged as one PDF.
var pdfFileNamesToMerge []string
sortedPaymentPacketItemsMap := buildPaymentPacketItemsMap(ppmShipment)
for i := 0; i < len(sortedPaymentPacketItemsMap); i++ {
pdfFileName, perr := p.pdfGenerator.ConvertUploadToPDF(appCtx, sortedPaymentPacketItemsMap[i].Upload)
if perr != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to generate pdf for upload")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
pdfFileNamesToMerge = append(pdfFileNamesToMerge, pdfFileName)
}
if len(pdfFileNamesToMerge) > 0 {
pdfFileNamesToMergePdf, perr := p.pdfGenerator.MergePDFFiles(appCtx, pdfFileNamesToMerge)
if perr != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed pdfGenerator.MergePDFFiles")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
pdfFilesToMerge = append(pdfFilesToMerge, pdfFileNamesToMergePdf)
}
// Do final merge of all PDFs into one.
finalMergePdf, err := p.pdfGenerator.MergePDFFilesByContents(appCtx, pdfFilesToMerge)
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to generated file merged pdf")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
// Start building bookmarks and watermarks
bookmarks, err := buildBookMarks(pdfFileNamesToMerge, sortedPaymentPacketItemsMap, aoaPacketFile, p.pdfGenerator)
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to generate bookmarks for PDF")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
watermarks, err := buildWaterMarks(bookmarks, p.pdfGenerator)
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to generate watermarks for PDF")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
// Apply bookmarks and watermarks based on flag
if addWatermarks && len(watermarks) > 0 {
pdfWithWatermarks, err := p.pdfGenerator.AddWatermarks(finalMergePdf, watermarks)
if err != nil {
errMsgPrefix = fmt.Sprintf("%s: %s", errMsgPrefix, "failed to add watermarks to PDF")
appCtx.Logger().Error(errMsgPrefix, zap.Error(err))
return nil, fmt.Errorf("%s: %w", errMsgPrefix, err)
}
if addBookmarks {
return p.pdfGenerator.AddPdfBookmarks(pdfWithWatermarks, bookmarks)
}
return pdfWithWatermarks, nil
}
if addBookmarks {
return p.pdfGenerator.AddPdfBookmarks(finalMergePdf, bookmarks)
}
// bookmark and watermark both disabled
return finalMergePdf, nil
}
func (p *paymentPacketCreator) GenerateDefault(appCtx appcontext.AppContext, ppmShipmentID uuid.UUID) (io.ReadCloser, error) {
return p.Generate(appCtx, ppmShipmentID, true, true)
}
func buildBookMarks(fileNamesToMerge []string, sortedPaymentPacketItems map[int]paymentPacketItem, aoaPacketFile io.ReadSeeker, pdfGenerator paperwork.Generator) ([]pdfcpu.Bookmark, error) {
// go out and retrieve PDF file info for each file name
for i := 0; i < len(fileNamesToMerge); i++ {
pdfFileInfo, err := pdfGenerator.GetPdfFileInfo(fileNamesToMerge[i])
if err != nil {
return nil, fmt.Errorf("%s: %w", fmt.Sprintf("failed to retrieve PDF file info for: %s", fileNamesToMerge[i]), err)
}
item := sortedPaymentPacketItems[i]
// we just want the pagesize. update sortedPaymentPacketItems
item.PageSize = pdfFileInfo.PageCount
sortedPaymentPacketItems[i] = item
}
var bookmarks []pdfcpu.Bookmark
// retrieve file info for AOA packet file
aoaPacketFileInfo, err := pdfGenerator.GetPdfFileInfoForReadSeeker(aoaPacketFile)
if err != nil {
return nil, fmt.Errorf("%s: %w", "failed to retrieve PDF file info for AOA packet file", err)
}
// add first bookmark for AOA content
bookmarks = append(bookmarks, pdfcpu.Bookmark{PageFrom: 1, PageThru: aoaPacketFileInfo.PageCount, Title: "Shipment Summary Worksheet and Orders"})
// build bookmarks for all file names
var pageFrom int
var pageThru int
for i := 0; i < len(fileNamesToMerge); i++ {
item := sortedPaymentPacketItems[i]
pageFrom = bookmarks[i].PageThru + 1
pageThru = bookmarks[i].PageThru + item.PageSize
bookmarks = append(bookmarks, pdfcpu.Bookmark{PageFrom: pageFrom, PageThru: pageThru, Title: item.Label})
}
return bookmarks, nil
}
// generate watermarks which will serve as page footer labels
func buildWaterMarks(bookMarks []pdfcpu.Bookmark, pdfGenerator paperwork.Generator) (map[int][]*model.Watermark, error) {
m := make(map[int][]*model.Watermark)
opacity := 1.0
onTop := true
update := false
unit := types.POINTS
desc := fmt.Sprintf("font:Times-Italic, points:10, sc:1 abs, pos:bc, off:0 8, rot:0, op:%f", opacity)
creationTimeStamp := time.Now().UTC().Format("2006-01-02T15:04:05.000Z")
totalPages := bookMarks[len(bookMarks)-1].PageThru
currentPage := 1
bookMarkIndex := 0
for _, bm := range bookMarks {
cnt := bm.PageThru - bm.PageFrom
for j := 0; j <= cnt; j++ {
// do not add watermark on SSW pages
if currentPage < 3 {
currentPage++
continue
}
wmText := bm.Title
// we really can't use the bookmark title for the SSW+Orders.
// we will just label it as only Orders
if currentPage > 2 && bookMarkIndex == 0 {
wmText = "Orders"
}
wms := make([]*model.Watermark, 0)
pagingInfo := fmt.Sprintf("Page %d of %d", currentPage, totalPages)
text := fmt.Sprintf("%s - Payment Packet[%s] (Creation Date: %v)", pagingInfo, wmText, creationTimeStamp)
wm, _ := pdfGenerator.CreateTextWatermark(text, desc, onTop, update, unit)
wms = append(wms, wm)
// note: use current page because map is 1 based
m[currentPage] = wms
currentPage++
}
bookMarkIndex++
}
return m, nil
}
func buildPaymentPacketItemsMap(ppmShipment *models.PPMShipment) map[int]paymentPacketItem {
// items are sorted based on key(int), key represents order index
sortedPaymentPacketItems := make(map[int]paymentPacketItem)
sortedPaymentPacketItemsIndex := 0
var povRegistrationPaymentPacketItems []paymentPacketItem
// process weight tickets
weightTicketCnt := 1
for _, weightTicket := range ppmShipment.WeightTickets {
sectionLabel := fmt.Sprintf("Weight Moved: Trip #%s:", fmt.Sprint(weightTicketCnt))
emptyWeightCnt := 1
for _, uu := range weightTicket.EmptyDocument.UserUploads {
sortedPaymentPacketItems[sortedPaymentPacketItemsIndex] = newPaymentPacketItem(fmt.Sprintf("%s Empty Weight Document #%s", sectionLabel, fmt.Sprint(emptyWeightCnt)), uu.Upload)
sortedPaymentPacketItemsIndex++
emptyWeightCnt++
}
fullWeightCnt := 1
for _, uu := range weightTicket.FullDocument.UserUploads {
sortedPaymentPacketItems[sortedPaymentPacketItemsIndex] = newPaymentPacketItem(fmt.Sprintf("%s Full Weight Document #%s", sectionLabel, fmt.Sprint(fullWeightCnt)), uu.Upload)
sortedPaymentPacketItemsIndex++
fullWeightCnt++
}
// povRegistrations will be order after the other weight tickets
povCnt := 1
for _, uu := range weightTicket.ProofOfTrailerOwnershipDocument.UserUploads {
// stuff into array so we may render it later in the correct order
povRegistrationPaymentPacketItems = append(povRegistrationPaymentPacketItems, newPaymentPacketItem(fmt.Sprintf("%s POV/Registration Document #%s", sectionLabel, fmt.Sprint(povCnt)), uu.Upload))
povCnt++
}
weightTicketCnt++
}
// process pro-gear
proGearWeightTicketCnt := 1
for _, progearWeightTicket := range ppmShipment.ProgearWeightTickets {
sectionLabel := fmt.Sprintf("Pro-gear: Set #%s:", fmt.Sprint(proGearWeightTicketCnt))
proGearWeightTicketSetCnt := 1
for _, uu := range progearWeightTicket.Document.UserUploads {
var belongsToLabel = "Me"
if !*progearWeightTicket.BelongsToSelf {
belongsToLabel = "Spouse"
}
sortedPaymentPacketItems[sortedPaymentPacketItemsIndex] = newPaymentPacketItem(fmt.Sprintf("%s(%s) Weight Ticket Document #%s", sectionLabel, belongsToLabel, fmt.Sprint(proGearWeightTicketSetCnt)), uu.Upload)
sortedPaymentPacketItemsIndex++
proGearWeightTicketSetCnt++
}
proGearWeightTicketCnt++
}
// place povRegistration after the weight items
for _, item := range povRegistrationPaymentPacketItems {
sortedPaymentPacketItems[sortedPaymentPacketItemsIndex] = item
sortedPaymentPacketItemsIndex++
}
// process expenses, group by type as array list
expenseTypeMap := make(map[string][]models.MovingExpense)
for _, movingExpense := range ppmShipment.MovingExpenses {
if value, exists := expenseTypeMap[string(*movingExpense.MovingExpenseType)]; exists {
// add to existing array
value = append(value, movingExpense)
expenseTypeMap[string(*movingExpense.MovingExpenseType)] = value
} else {
// create new array and add first item
expenseTypeMap[string(*movingExpense.MovingExpenseType)] = make([]models.MovingExpense, 0)
expenseTypeMap[string(*movingExpense.MovingExpenseType)] = append(expenseTypeMap[string(*movingExpense.MovingExpenseType)], movingExpense)
}
}
expensesCnt := 1
for _, expenseType := range sortedExpenseType {
for _, item := range expenseTypeMap[expenseType] {
expensesDocCnt := 1
for _, uu := range item.Document.UserUploads {
sectionLabel := fmt.Sprintf("Expenses: Receipt #%s:", fmt.Sprint(expensesCnt))
sortedPaymentPacketItems[sortedPaymentPacketItemsIndex] = newPaymentPacketItem(fmt.Sprintf("%s %s Document #%s", sectionLabel, getExpenseTypeLabel(expenseType), fmt.Sprint(expensesDocCnt)), uu.Upload)
sortedPaymentPacketItemsIndex++
expensesDocCnt++
}
expensesCnt++
}
}
return sortedPaymentPacketItems
}
// Helper method to verify if PPMShipment is accessible for current user. This is to prevent
// backdoor access for unauthorized users in INTERNAL.
func verifyPPMShipment(appCtx appcontext.AppContext, ppmShipmentID uuid.UUID) error {
ppmShipment := models.PPMShipment{}
dbQErr := appCtx.DB().Q().Eager(
"Shipment.MoveTaskOrder.Orders.ServiceMember",
).Find(&ppmShipment, ppmShipmentID)
if dbQErr != nil {
if errors.Cause(dbQErr).Error() == models.RecordNotFoundErrorString {
return apperror.NewNotFoundError(ppmShipmentID, "PPMShipment")
}
return dbQErr
}
// if request is from INTERNAL verify if PPM belongs to user
if appCtx.Session().IsMilApp() && ppmShipment.Shipment.MoveTaskOrder.Orders.ServiceMember.ID != appCtx.Session().ServiceMemberID {
return apperror.NewForbiddenError(fmt.Sprintf("PPMShipmentId: %s", ppmShipmentID.String()))
}
return nil
}
func getExpenseTypeLabel(value string) string {
switch value {
case "CONTRACTED_EXPENSE":
return "Contracted Expense"
case "OIL":
return "Oil"
case "PACKING_MATERIALS":
return "Packing Materials"
case "RENTAL_EQUIPMENT":
return "Rental Equipment"
case "STORAGE":
return "Storage"
case "TOLLS":
return "Tolls"
case "WEIGHING_FEE":
return "Weighing Fee"
case "OTHER":
return "Other"
default:
return "Unknown"
}
}