-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathreport_artifacts_html.py
283 lines (219 loc) · 12.2 KB
/
report_artifacts_html.py
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
'''
Copyright 2021 Flexera Software LLC
See LICENSE.TXT for full license text
SPDX-License-Identifier: MIT
Author : sgeary
Created On : Mon Dec 13 2021
File : report_artifacts_html.py
'''
import logging
import os
import base64
import _version
logger = logging.getLogger(__name__)
#------------------------------------------------------------------#
def generate_html_report(reportData):
logger.info(" Entering generate_html_report")
reportName = reportData["reportName"]
projectName = reportData["projectName"]
reportFileNameBase = reportData["reportFileNameBase"]
reportTimeStamp = reportData["reportTimeStamp"]
takeAction = reportData["takeAction"]
stringsToClaim = reportData["stringsToClaim"]
inventoryItemForClaimedFiles = reportData["inventoryItemForClaimedFiles"]
claimableFiles = reportData["claimableFiles"]
nonclaimableFiles = reportData["nonclaimableFiles"]
scriptDirectory = os.path.dirname(os.path.realpath(__file__))
cssFile = os.path.join(scriptDirectory, "report_branding/css/revenera_common.css")
logoImageFile = os.path.join(scriptDirectory, "report_branding/images/logo_reversed.svg")
iconFile = os.path.join(scriptDirectory, "report_branding/images/favicon-revenera.ico")
#########################################################
# Encode the image files
encodedLogoImage = encodeImage(logoImageFile)
encodedfaviconImage = encodeImage(iconFile)
htmlFile = reportFileNameBase + ".html"
logger.debug(" htmlFile: %s" %htmlFile)
#---------------------------------------------------------------------------------------------------
# Create a simple HTML file to display
#---------------------------------------------------------------------------------------------------
try:
html_ptr = open(htmlFile,"w")
except:
logger.error("Failed to open htmlfile %s:" %htmlFile)
raise
html_ptr.write("<html>\n")
html_ptr.write(" <head>\n")
html_ptr.write(" <!-- Required meta tags --> \n")
html_ptr.write(" <meta charset='utf-8'> \n")
html_ptr.write(" <meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'> \n")
html_ptr.write('''
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.1/css/bootstrap.min.css" integrity="sha384-VCmXjywReHh4PwowAiWNagnWcLhlEJLA5buUprzK8rxFgeH0kww/aWY76TfkUoSX" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.3/css/bootstrap.css">
<link rel="stylesheet" href="https://cdn.datatables.net/1.10.21/css/dataTables.bootstrap4.min.css">
''')
html_ptr.write(" <style>\n")
# Add the contents of the css file to the head block
try:
f_ptr = open(cssFile)
logger.debug(" Adding css file details")
for line in f_ptr:
html_ptr.write(" %s" %line)
f_ptr.close()
except:
logger.error("Unable to open %s" %cssFile)
print("Unable to open %s" %cssFile)
html_ptr.write(" </style>\n")
html_ptr.write(" <link rel='icon' type='image/png' href='data:image/png;base64, {}'>\n".format(encodedfaviconImage.decode('utf-8')))
html_ptr.write(" <title>%s</title>\n" %(reportName))
html_ptr.write(" </head>\n")
html_ptr.write("<body>\n")
html_ptr.write("<div class=\"container-fluid\">\n")
#---------------------------------------------------------------------------------------------------
# Report Header
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN HEADER -->\n")
html_ptr.write("<div class='header'>\n")
html_ptr.write(" <div class='logo'>\n")
html_ptr.write(" <img src='data:image/svg+xml;base64,{}' style='height: 5%;'>\n".format(encodedLogoImage.decode('utf-8')))
html_ptr.write(" </div>\n")
html_ptr.write("<div class='report-title'>%s</div>\n" %reportName)
html_ptr.write("</div>\n")
html_ptr.write("<!-- END HEADER -->\n")
#---------------------------------------------------------------------------------------------------
# Body of Report
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN BODY -->\n")
html_ptr.write("<div class=\"container-fluid\">\n")
if takeAction:
html_ptr.write("<h2>String evidence that has been claimed</h2>\n")
else:
html_ptr.write("<h2>String evidence that is claimable</h2>\n")
html_ptr.write("<ul>\n")
for string in stringsToClaim:
html_ptr.write("<li>%s</li>\n"%string)
html_ptr.write("</ul'>\n")
html_ptr.write("</div>\n")
html_ptr.write("<hr class='small'>")
html_ptr.write("<table id='claimableFiles' class='table table-hover table-sm row-border' style='width:90%'>\n")
html_ptr.write(" <thead>\n")
html_ptr.write(" <tr>\n")
if takeAction:
html_ptr.write(" <th colspan='10' class='text-center'><h4>%s - Files claimed and added to %s</h4></th>\n" %(projectName, inventoryItemForClaimedFiles))
else:
html_ptr.write(" <th colspan='10' class='text-center'><h4>%s - Files that are claimable</h4></th>\n" %projectName)
html_ptr.write(" </tr>\n")
html_ptr.write(" <tr>\n")
html_ptr.write(" <th style='width: 50%' class='text-left text-nowrap'>File Path</th>\n")
if takeAction:
html_ptr.write(" <th style='width: 10%' class='text-center'>Claimed Copyright</th>\n")
html_ptr.write(" <th style='width: 10%' class='text-center'>Claimed Email/URL</th>\n")
else:
html_ptr.write(" <th style='width: 10%' class='text-center'>Claimable Copyright</th>\n")
html_ptr.write(" <th style='width: 10%' class='text-center'>Claimable Email/URL</th>\n")
html_ptr.write(" <th style='width: 10%' class='text-center'>Search Terms</th>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </thead>\n")
html_ptr.write(" <tbody>\n")
for filePath in sorted(claimableFiles):
filelink = claimableFiles[filePath]["filelink"]
html_ptr.write(" <tr> \n")
html_ptr.write(" <td class='text-left'><a href='%s' target='_blank'>%s</a></td>\n" %(filelink, filePath))
for evidence in ["copyright", "emailURL", "searchTerm"]:
# See if the evidence exists. If the key is not there that type was not found
if evidence in claimableFiles[filePath]["claimableEvidence"]:
html_ptr.write(" <td class='text-center text-nowrap' style='vertical-align: middle;'><span class='dot dot-%s'></span></td>\n" %evidence)
else:
html_ptr.write(" <td> </td>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </tbody>\n")
html_ptr.write("</table>\n")
html_ptr.write("<hr class='small'>")
html_ptr.write("<table id='nonclaimableFiles' class='table table-hover table-sm row-border' style='width:90%'>\n")
html_ptr.write(" <thead>\n")
html_ptr.write(" <tr>\n")
html_ptr.write(" <th colspan='10' class='text-center'><h4>%s - Files with Claimable and Other Evidence</h4></th>\n" %projectName)
html_ptr.write(" </tr>\n")
html_ptr.write(" <tr>\n")
html_ptr.write(" <th style='width: 50%' class='text-left text-nowrap'>File Path</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Claimable Copyright</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Claimable Email/URL</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Other Copyright</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Other Email/URL</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>License</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Search Terms</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Exact File Match</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>Source Code Match</th>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </thead>\n")
html_ptr.write(" <tbody>\n")
for filePath in sorted(nonclaimableFiles):
filelink = nonclaimableFiles[filePath]["filelink"]
html_ptr.write(" <tr> \n")
html_ptr.write(" <td class='text-left'><a href='%s' target='_blank'>%s</a></td>\n" %(filelink, filePath))
for evidence in ["copyright", "emailURL"]:
# See if the evidence exists. If the key is not there that type was not found
if evidence in nonclaimableFiles[filePath]["claimableEvidence"]:
html_ptr.write(" <td class='text-center text-nowrap' style='vertical-align: middle;'><span class='dot dot-%s'></span></td>\n" %evidence)
else:
html_ptr.write(" <td> </td>\n")
for evidence in ["copyright", "emailURL", "license", "searchTerm", "exactMatch", "sourceMatch"]:
# See if the evidence exists. If the key is not there that type was not found
if evidence in nonclaimableFiles[filePath]["nonclaimableEvidence"]:
html_ptr.write(" <td class='text-center text-nowrap' style='vertical-align: middle;'><span class='dot dot-%s'></span></td>\n" %evidence)
else:
html_ptr.write(" <td> </td>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </tbody>\n")
html_ptr.write("</table>\n")
html_ptr.write("<!-- END BODY -->\n")
#---------------------------------------------------------------------------------------------------
# Report Footer
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN FOOTER -->\n")
html_ptr.write("<div class='report-footer'>\n")
html_ptr.write(" <div style='float:right'>Generated on %s</div>\n" %reportTimeStamp)
html_ptr.write("<br>\n")
html_ptr.write(" <div style='float:right'>Report Version: %s</div>\n" %_version.__version__)
html_ptr.write("</div>\n")
html_ptr.write("<!-- END FOOTER -->\n")
html_ptr.write("</div>\n")
#---------------------------------------------------------------------------------------------------
# Add javascript
#---------------------------------------------------------------------------------------------------
html_ptr.write('''
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<script src="https://cdn.datatables.net/1.10.21/js/jquery.dataTables.min.js"></script>
<script src="https://cdn.datatables.net/1.10.21/js/dataTables.bootstrap4.min.js"></script>
''')
html_ptr.write("<script>\n")
# Add the js for inventory datatable
html_ptr.write('''
var table = $('#claimableFiles').DataTable();
$(document).ready(function() {
table;
} );
''')
html_ptr.write('''
var table = $('#nonclaimableFiles').DataTable();
$(document).ready(function() {
table;
} );
''')
html_ptr.write("</script>\n")
html_ptr.write("</body>\n")
html_ptr.write("</html>\n")
html_ptr.close()
logger.info(" Exiting generate_html_report")
return htmlFile
####################################################################
def encodeImage(imageFile):
#############################################
# Create base64 variable for branding image
try:
with open(imageFile,"rb") as image:
encodedImage = base64.b64encode(image.read())
return encodedImage
except:
logger.error("Unable to open %s" %imageFile)
raise