forked from scroberts/Library
/
CID.py
348 lines (321 loc) · 14.1 KB
/
CID.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
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
#!/usr/bin/env python3
# external modules
import pprint
import json
from datetime import datetime
import openpyxl
from openpyxl.styles import Font, Style, Alignment
from openpyxl.styles.colors import BLUE
# my modules
import DCC
import GetUrlWord
import Config as CF
import MyUtil
# Set Excel Styles
# Excel hyperlink style is calibri 11, underline blue
font_url_style = Font(color = BLUE, underline = 'single')
bold_style = Font(bold = True)
align_hv_cen_style = Alignment(horizontal = 'center', vertical = 'center')
align_ver_cen_style = Alignment(vertical = 'center')
align_hv_cen_wrap_style = Alignment(horizontal = 'center', vertical = 'center', wrap_text = True)
def cid_ss_headings(ws):
col = 1
ws.cell(row = 1, column = col).value = "DOC Handle"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "DCC Title"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "TMT Number"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Doc Owner"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "CID Ref. Note"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Curr. CID Ref."
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Curr. CID Ref. Comment"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Curr. CID Ref. Owner"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Curr. CID Ref. Date"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Sug. CID Ref. (Current)"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Sug. CID Ref. Comment"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Sug. CID Ref. Owner"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
col += 1
ws.cell(row = 1, column = col).value = "Sug. CID Ref. Date"
ws.cell(row = 1, column = col).alignment = align_hv_cen_wrap_style
for col in range(1, 14):
ws.cell(row = 1, column = col).font = bold_style
def cid_report(ss, ss_name):
# Open the spreadsheet
wb = openpyxl.Workbook()
ws = wb.worksheets[0]
# Write and format the headings in Excel
cid_ss_headings(ws)
ssrow = 2
for doc in ss:
col = 1
# Column 1: DCC Document Handle
ws.cell(row = ssrow, column = col).value = doc[0]
ws.cell(row = ssrow, column = col).font = font_url_style
ws.cell(row = ssrow, column = col).hyperlink = CF.dcc_url + CF.dcc_prop + doc[0]
ws.cell(row = ssrow, column = col).alignment = Alignment(vertical = 'center')
col += 1
# Column 2: DCC Document Title
ws.cell(row = ssrow, column = col).value = doc[1]
ws.cell(row = ssrow, column = col).alignment = Alignment(wrap_text = True, vertical = 'center')
col += 1
# Column 3: TMT Document Number
ws.cell(row = ssrow, column = col).value = doc[2]
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
# Column 4: Document Owner
ws.cell(row = ssrow, column = col).value = doc[3]
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
# Column 5: CID Ref. Note
ws.cell(row = ssrow, column = col).value = doc[4]
ws.cell(row = ssrow, column = col).alignment = Alignment(wrap_text = True, vertical = 'center')
col += 1
# Column 6: Current CID Reference Handle
ws.cell(row = ssrow, column = col).value = doc[5]
ws.cell(row = ssrow, column = col).font = font_url_style
ws.cell(row = ssrow, column = col).hyperlink = CF.dcc_url + CF.dcc_prop + doc[5]
ws.cell(row = ssrow, column = col).alignment = Alignment(vertical = 'center')
col += 1
# Column 7: Current CID Reference Comment
ws.cell(row = ssrow, column = col).value = doc[6]
ws.cell(row = ssrow, column = col).alignment = Alignment(wrap_text = True, vertical = 'center')
col += 1
# Column 8: Current CID Reference Owner
ws.cell(row = ssrow, column = col).value = doc[7]
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
# Column 9: Current CID Reference Date
ws.cell(row = ssrow, column = col).value = datetime.strptime(doc[8], '%a, %d %b %Y %H:%M:%S %Z')
ws.cell(row = ssrow, column = col).number_format = 'YYYY MMM DD'
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
# Column 10: Suggested CID Reference Handle
ws.cell(row = ssrow, column = col).value = doc[9]
ws.cell(row = ssrow, column = col).font = font_url_style
ws.cell(row = ssrow, column = col).hyperlink = CF.dcc_url + CF.dcc_prop + doc[9]
ws.cell(row = ssrow, column = col).alignment = Alignment(vertical = 'center')
col += 1
# Column 11: Suggested CID Reference Comment
ws.cell(row = ssrow, column = col).value = doc[10]
ws.cell(row = ssrow, column = col).alignment = Alignment(wrap_text = True, vertical = 'center')
col += 1
# Column 12: Suggested CID Reference Owner
ws.cell(row = ssrow, column = col).value = doc[11]
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
# Column 13: Suggested CID Reference Date
ws.cell(row = ssrow, column = col).value = datetime.strptime(doc[12], '%a, %d %b %Y %H:%M:%S %Z')
ws.cell(row = ssrow, column = col).number_format = 'YYYY MMM DD'
ws.cell(row = ssrow, column = col).alignment = align_hv_cen_style
col += 1
ssrow += 1
# Set column widths
# Handles:
ws.column_dimensions["A"].width = 15.0
ws.column_dimensions["F"].width = 15.0
ws.column_dimensions["J"].width = 15.0
# Titles and Comments
ws.column_dimensions["B"].width = 45.0
ws.column_dimensions["G"].width = 45.0
ws.column_dimensions["K"].width = 45.0
# TMT Document Number
ws.column_dimensions["C"].width = 23.0
# Dates
ws.column_dimensions["I"].width = 20.0
ws.column_dimensions["M"].width = 20.0
# Owner and ref. note.
ws.column_dimensions["D"].width = 10.0
ws.column_dimensions["E"].width = 10.0
ws.column_dimensions["H"].width = 10.0
ws.column_dimensions["L"].width = 10.0
# Save the spreadsheet
wb.save(ss_name)
def gen_ss_cid(s, dl):
# Spreadsheet dataset will be a list of lists
ss = []
for d in dl:
ssrow = []
print("trying", d)
if 'Document-' in d:
# CID link is to a document Handle
doc = DCC.prop_get(s,d,InfoSet = 'DocBasic')
doc['Versions'] = DCC.prop_get(s,d,InfoSet = 'Versions')
# Now read preferred version
prefver = DCC.prop_get(s,doc['Versions']['prefver'],InfoSet = 'VerAll')
# Check how many places the document is located
doc['locations'] = DCC.prop_get(s,d,InfoSet = 'Parents')
# Subject Document
ssrow.append(doc['handle'])
ssrow.append(doc['title'])
ssrow.append(doc['tmtnum'])
ssrow.append(doc['owner-username'])
# Evaluation of current reference
ssrow.append('Doc Ref')
# Current reference
ssrow.append(doc['handle'])
ssrow.append(doc['title'])
ssrow.append(doc['owner-username'])
ssrow.append(doc['date'])
# Suggested reference
ssrow.append(prefver['dccver'])
ssrow.append(prefver['vercomment'])
ssrow.append(prefver['owner-username'])
ssrow.append(prefver['date'])
DCC.print_doc_basic(doc)
DCC.print_ver(prefver)
DCC.print_locations(doc)
print(doc['handle'], doc['title'], doc['tmtnum'], doc['owner-username'])
print("Doc Ref")
print(prefver['dccver'], prefver['vercomment'], prefver['owner-username'], prefver['date'])
print('Document has %d locations' % len(doc['locations']))
elif 'Version-' in d:
# CID link is to a version handle
ver = DCC.prop_get(s,d,InfoSet = 'VerAll')
doc = DCC.prop_get(s,ver['dccdoc'],InfoSet = 'DocBasic')
# Subject Document
ssrow.append(doc['handle'])
ssrow.append(doc['title'])
ssrow.append(doc['tmtnum'])
ssrow.append(doc['owner-username'])
# find info on the preferred version
prefver = DCC.prop_get(s,doc['prefver'],InfoSet = 'VerAll')
# Evaluation of current reference
print("CID references Version")
print(doc['handle'], doc['title'], doc['tmtnum'])
print("Referenced Version")
print(ver['dccver'], ver['vercomment'], ver['owner-username'], ver['date'])
if prefver['dccver'] == ver['dccver']:
print("Referenced Version IS the Preferred Version")
# Evaluation of current reference
ssrow.append('Pref. Ver.')
DCC.print_doc_all(doc)
DCC.print_ver(prefver)
# Current reference
ssrow.append(prefver['dccver'])
ssrow.append(prefver['vercomment'])
ssrow.append(prefver['owner-username'])
ssrow.append(prefver['date'])
else:
print("Referenced Version IS NOT the Preferred Version")
# Evaluation of current reference
ssrow.append('Non-Pref. Ver.')
print("Non-Preferred Version")
print(prefver['dccver'], prefver['vercomment'], prefver['owner-username'], prefver['date'])
DCC.print_doc_all(doc)
DCC.print_ver(ver)
DCC.print_ver(prefver)
# Current reference
ssrow.append(ver['dccver'])
ssrow.append(ver['vercomment'])
ssrow.append(ver['owner-username'])
ssrow.append(ver['date'])
# Suggested reference
ssrow.append(prefver['dccver'])
ssrow.append(prefver['vercomment'])
ssrow.append(prefver['owner-username'])
ssrow.append(prefver['date'])
else:
print("Don't know how to handle", d)
sys.exit()
ss.append(ssrow)
return(ss)
def get_cid_ssdata(s, json_handlelist, json_ssdata):
fh = open(json_handlelist,'r')
dl = json.load(fh)
fh.close()
ss = gen_ss_cid(s, dl)
fh = open(json_ssdata,'w')
json.dump(ss,fh)
fh.close()
def write_spreadsheet(json_fname, xls_fname):
# Open the spreadsheet
wb = openpyxl.Workbook()
ws = wb.worksheets[0]
fh = open(json_fname,'r')
ss = json.load(fh)
fh.close()
cid_report(ss,xls_fname)
def make_handle_lists(json_ssdata, docfname, verfname):
fh = open(json_ssdata,'r')
ss = json.load(fh)
fh.close()
dl = []
vl = []
for doc in ss:
dl.append(doc[0])
vl.append(doc[9])
dfh = open(docfname,'w')
vfh = open(verfname,'w')
json.dump(dl,dfh)
json.dump(vl,vfh)
dfh.close()
vfh.close()
def make_cid(dirpath, CID_coll, htmlfile, outroot):
# Get list of DCC documents from a Word file saved as html
GetUrlWord.get_url_word(dirpath + outroot, dirpath + htmlfile)
# Login to DCC
prod = ['prod', 'production', 'p', ' ']
tes = ['test', 'tes', 't']
checker = False
print("Would you like to log into the production site or the test site?")
print("Valid Inputs are as follows: Production, prod, p, test, t :", end="")
choice = input().lower()
#while loop to continue asking the user for input until a correct input has been entered
while (checker == False):
#Production site login choice
if(choice in prod):
print("You are now logging into the Production version of DocuShare")
s = DCC.login(Site ='Production')
checker = True
#test site login choice
elif(choice in tes):
print("You are now logging into the test VM DocuShare")
s = DCC.login(Site ='Test')
checker = True
#cf.dcc_url + cf.dcc_login
#error message alerting user to enter a valid choice
else:
print("Please enter a valid choice, (P)roduction or (T)est")
choice = input().lower()
json_handlelist = dirpath + outroot + 'bothlist.txt'
json_ssdata = dirpath + outroot + 'CID.txt'
get_cid_ssdata(s, json_handlelist, json_ssdata)
xlfile = dirpath + outroot + 'CID_Analysis.xls'
write_spreadsheet(json_ssdata, xlfile)
json_verlist = dirpath + outroot + 'ver_list.txt'
json_doclist = dirpath + outroot + 'doc_list.txt'
make_handle_lists(json_ssdata, json_doclist, json_verlist)
## Remove the files that are currently located in the collection for the CID
if MyUtil.get_yn('Remove location (not delete) of files from ' + CID_coll[0] +'(Y/N)?: '):
doclist = DCC.list_obj_in_coll(s, CID_coll[0],Print=True,Jwrite=False,Depth='infinity',Type='Doc')
for doc in doclist:
DCC.dcc_remove_doc_from_coll(s, doc, CID_coll[0])
## Add CID files to the collection
fh = open(json_doclist, 'r')
dl = json.load(fh)
fh.close()
if MyUtil.get_yn('Add CID files to ' + CID_coll[0] +' (Y/N)?: '):
DCC.add_docs_2_collections(s, dl, CID_coll)
# Check that the expected docs are in the collection
DCC.check_docs_in_coll(s, dl, CID_coll)