-
Notifications
You must be signed in to change notification settings - Fork 0
/
GetExcelLinks.py
313 lines (249 loc) · 10.2 KB
/
GetExcelLinks.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
import sys
import os
import zipfile
import argparse
import glob
from bs4 import BeautifulSoup
import unicodecsv as csv # https://pypi.python.org/pypi/unicodecsv/0.14.1
import pandas as pd
instructions = """
Usage:
python3 GetExcelLinks.py path/to/file/ (options)
Extract all hyperlinks from an .xlsx file,
including link location, destination, and linked text/formula,
and store them in a .csv file.
If you feed it a folder, it includes all the files in the folder.
Excel mangles UTF-8, so you will need to open the csv in Google Drive.
Options:
-h Print this message and quit.
-r Recursive - includes nested folders.
-o Set an output filename as the next argument.
-l Returns a Python list. Used when called by other scripts.
Last update: April 3rd 2019
来源:https://github.com/Colin-Fredericks/hx_util
20220414 linklist.extend() 改为 linklist.extend(newlinks)
"""
# Returns a dictionary of all the sheets.
# Form: {'filename1':'name1', 'filename2':'name2'}
def getSheets(soup):
sheets = {}
for tag in soup.find_all("sheet"):
if tag.parent.name == "sheets":
filename = "sheet" + tag["sheetId"]
sheets[filename] = tag["name"]
return sheets
# Returns a list of hyperlinks.
def getHyperlinks(soup):
links = []
link_refs = {}
# Get all the hyperlinks and their cells.
for tag in soup.find_all("hyperlink"):
if tag.parent.name == "hyperlinks":
# try/except because some hyperlinks have no id.
try:
link_refs[tag["ref"]] = tag["r:id"]
except:
pass
# Go through every cell and find the ones that have hyperlinks.
# Add their info to the list of links.
# HOWEVER, also check the 'f' tags because a =HYPERLINK formula
# needs to be counted as well. :(
for cell in soup.find_all("c"):
text = value = source = ""
cellID = False
is_link = False
if cell["r"] in link_refs:
# If it's a non-formula-based hyperlink:
cellID = link_refs[cell["r"]]
is_link = True
elif cell.find("f") is not None:
# If it's a formula-based hyperlink:
text = cell.find("f").get_text()
if "hyperlink(" in text.lower():
is_link = True
# As long as it's some sort of hyperlink:
if is_link:
if cell.find("v") is not None:
value = cell.find("v").get_text()
if cell.has_attr("t"):
if cell["t"] == "s":
source = cell.find("v").get_text()
else:
source = False
links.append(
{
"id": cellID,
"location": cell["r"],
"s": source,
"value": value,
"text": text,
}
)
return links
# Add URLs for .xlsx hyperlinks
def getURLs(soup, links):
# Find every link by id and get its url.
for link in links:
if link["id"]:
for rel in soup.find_all("Relationship"):
if rel["Id"] == link["id"]:
link["href"] = rel["Target"]
else:
link["href"] = ""
else:
# Splitting formula on quotes to get most likely values
link["href"] = link["text"].split('"')[1]
link["text"] = link["text"].split('"')[3]
return links
# Add text for .xlsx hyperlinks, if we haven't already found it.
def getLinkText(soup, links):
# Find every link by reference number (s) and get its url.
for link in links:
if link["s"]:
sourceTag = soup.find_all("si")[int(link["s"])]
sourceText = sourceTag.find("t").get_text()
link["text"] = sourceText
link["value"] = sourceText
return links
# Assembles the list of links from multiple data sources.
# Returns a list of dicts.
def getLinks(filename, args, dirpath):
# Open the .xlsx file as if it were a zip (because it is)
fullname = os.path.join(dirpath or "", filename)
archive = zipfile.ZipFile(fullname, "r")
# Read bytes from archive for the workbook to get the sheets.
workbook_data = archive.read("xl/workbook.xml")
workbook_soup = BeautifulSoup(workbook_data, "xml")
sheets = getSheets(workbook_soup)
complete_links = []
for sheet in sheets:
# Open each sheet and get the hyperlinks.
sheet_data = archive.read("xl/worksheets/" + sheet + ".xml")
sheet_soup = BeautifulSoup(sheet_data, "xml")
links = getHyperlinks(sheet_soup)
# URLs are stored in a different file. Cross-reference for each sheet.
try:
url_data = archive.read("xl/worksheets/_rels/" + sheet + ".xml.rels")
url_soup = BeautifulSoup(url_data, "xml")
links_with_urls = getURLs(url_soup, links)
except KeyError:
# If there's no .xml.rels file, there are no links on that sheet.
links_with_urls = links
# Mark each line with the sheet's name.
for link in links_with_urls:
link["sheet_name"] = sheets[sheet]
complete_links.extend(links_with_urls)
# Text is ALSO stored in a different file, but it's the same one for every sheet.
try:
string_data = archive.read("xl/sharedStrings.xml")
except KeyError:
# If that file doesn't exist, just skip it and move on.
return complete_links
string_soup = BeautifulSoup(string_data, "xml")
complete_links = getLinkText(string_soup, complete_links)
# Mark each line with the filename in case we're processing more than one.
for link in complete_links:
link["filename"] = os.path.basename(filename)
# Return a list of dicts full of link info
return complete_links
# Output a file and print some info.
def writeFile(linklist, filecount, outFileName, outFilePath, args):
print(
"\nChecked "
+ str(filecount)
+ " .xlsx file"
+ ("s" if filecount > 1 else "")
+ " for links."
)
with open(outFilePath, "wb") as outputFile:
# Note that we're printing formulae rather than their values.
# To include values, add 'value' to the list below.
fieldnames = ["filename", "sheet_name", "location", "href", "text"]
writer = csv.DictWriter(
outputFile, fieldnames=fieldnames, extrasaction="ignore"
)
writer.writeheader()
for row in linklist:
writer.writerow(row)
# 修复乱码问题
df = pd.read_csv(outFilePath, encoding='utf-8')
df.to_csv(outFilePath, encoding="utf_8_sig")
# print("Spreadsheet created: " + outFileName)
print("Location: " + outFilePath)
def getExcelLinks(args, args_path):
print("Getting .xlsx Links")
# Handle arguments and flags
parser = argparse.ArgumentParser(usage=instructions, add_help=False)
parser.add_argument("--help", "-h", action="store_true")
parser.add_argument("-r", action="store_true")
parser.add_argument("-l", action="store_true")
parser.add_argument("-o", action="store")
parser.add_argument("file_names", nargs="*")
args = parser.parse_args(args)
# Replace arguments with wildcards with their expansion.
# If a string does not contain a wildcard, glob will return it as is.
# Mostly important if we run this on Windows systems.
file_names = []
for name in args.file_names:
file_names += glob.glob(glob.escape(name))
# If the filenames don't exist, say so and quit.
if file_names == []:
sys.exit("No file or directory found by that name.")
# Don't run the script on itself.
if sys.argv[0] in file_names:
file_names.remove(sys.argv[0])
if args.help:
sys.exit(instructions)
filecount = 0
linklist = []
target_is_folder = False
for name in file_names:
# Make sure single files exist.
assert os.path.exists(name), "File or directory not found."
# If it's just a file...
if os.path.isfile(name):
# Make sure this is an Excel file (just check extension)
if name.lower().endswith(".xlsx"):
# Get the links from that file.
newlinks = getLinks(name, args, False)
if newlinks != []:
linklist.extend(newlinks)
filecount += 1
# If it's a directory:
if os.path.isdir(name):
target_is_folder = True
# Recursive version using os.walk for all levels.
if args.r:
for dirpath, dirnames, files in os.walk(name):
for eachfile in files:
# Get links from every file in that directory.
if eachfile.lower().endswith(".xlsx"):
linklist.extend(getLinks(eachfile, args, dirpath))
filecount += 1
# Non-recursive version breaks os.walk after the first level.
else:
topfiles = []
for (dirpath, dirnames, files) in os.walk(name):
topfiles.extend(files)
break
for eachfile in topfiles:
if eachfile.lower().endswith(".xlsx"):
linklist.extend(getLinks(eachfile, args, dirpath))
filecount += 1
if args.l:
# When asked to return a list, quietly return one and stop.
return linklist
else:
# Otherwise, create output file as sibling to the original target of the script.
outFileName = args.o if args.o else "Excel_Doc_Links.csv"
if target_is_folder:
outFilePath = os.path.join(args_path, outFileName)
outFileFolder = os.path.abspath(os.path.join(file_names[0], os.pardir))
outFilePath = os.path.join(outFileFolder, outFileName)
else:
# outFilePath = os.path.join(os.path.dirname(file_names[0]), outFileName)
outFilePath = os.path.join(args_path, outFileName) # 修改输出文件路径
writeFile(linklist, filecount, outFileName, outFilePath, args)
if __name__ == "__main__":
# this won't be run when imported
getExcelLinks(args, args_path) # 此处改为一个列表来传入