forked from zynamics/msdn-crawler
-
Notifications
You must be signed in to change notification settings - Fork 2
/
msdn_crawler.py
244 lines (194 loc) · 11.1 KB
/
msdn_crawler.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
# zynamics msdn-crawler (http://github.com/zynamics/msdn-crawler)
# Copyright (C) 2010
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import os
import sys
import re
from xml.sax import saxutils
from os.path import join, getsize
def strip_html(string):
r1 = re.compile("<.*?>")
r2 = re.compile(" +")
return r2.sub(" ", r1.sub("", string).replace(" ", " ").replace("\t", " ").replace("&)", ")").replace("–", "-").replace("—", "-"))
def parse_old_style(file, content):
m = re.search("<ph:apidata>\s*<api>(.*)</api>\s*<name>(.*)</name>\s*</ph:apidata>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
dll = m.group(1).lower()
function_name = m.group(2)
m = re.search("<span></span><P>(.*?)</P>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
description = strip_html(m.group(1))
else:
print "Error: Could not retrieve function description from file %s" % file
return None
m = re.search("<P CLASS=\"clsRef\">Parameters</P>\s*<BLOCKQUOTE>(.*?)</BLOCKQUOTE>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
argument_names = re.findall("<DT>\s*<I>(.*?)</I>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)
descriptions = [strip_html(string) for string in re.findall("<DD>(.*?)</DD>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)]
arguments = zip(argument_names, descriptions)
else:
# It's possible to have functions without arguments
arguments = [ ]
m = re.search("<P CLASS=\"clsRef\">Return Value</P>\s*<BLOCKQUOTE>\s*<P>(.*?)</P>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
return_value = strip_html(m.group(1))
else:
# If something has no return value it's not a function.
return None
print "Found function %s!%s" % (dll, function_name)
return [(dll, function_name, description, arguments, return_value)]
else:
return None
def parse_new_style(file, content):
api_types = re.findall("<MSHelp:Attr Name=\"APIType\" Value=\"(.*?)\"[ /]*>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL) # Check for > not for /> because some docs are broken
if api_types in ([], ["Schema"], ["UserDefined"], ["HeaderDef"], ["MOFDef"], ["NA"], ["LibDef"]):
return None
if not api_types in ([], ["COM"], ["DllExport"]):
print "API Type: ", api_types
function_names = re.findall("<MSHelp:Attr Name=\"APIName\" Value=\"(.*?)\"[ /]*>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL) # Check for > not for /> because some docs are broken
if function_names != []:
dll_names = re.findall("<MSHelp:Attr Name=\"APILocation\" Value=\"(.*?)\"[ /]*>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL) # Check for > not for /> because some docs are broken
if dll_names == []:
return None
m = re.search("<meta name=\"Description\" content=\"(.*?)\"/>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
description = strip_html(m.group(1))
else:
m = re.search("</H.>(.*?)<PRE class=\"syntax\"", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
description = strip_html(m.group(1))
else:
m = re.search("</H.>(.*?)<PRE class=syntax", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
description = strip_html(m.group(1))
else:
print "Error: Could not retrieve function description from file %s" % file
return None
m = re.search("<P CLASS=\"clsRef\">Parameters</P>\s*<BLOCKQUOTE>(.*?)</BLOCKQUOTE>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
argument_names = re.findall("<DT>.*?<I>(.*?)</I>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)
descriptions = [strip_html(string) for string in re.findall("<DD>(.*?)</DD>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)]
arguments = zip(argument_names, descriptions)
else:
m = re.search("Parameters</h.>\s*<dl>(.*?)</dl>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
argument_names = re.findall("<dt>.*?<i>(.*?)</i>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)
argument_names = [argument_name.replace("<i>", "") for argument_name in argument_names]
descriptions = [strip_html(string) for string in re.findall("<dd>(.*?)</dd>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)]
arguments = zip(argument_names, descriptions)
else:
m = re.search("Parameter</h.>\s*<dl>(.*?)</dl>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
argument_names = re.findall("<dt>.*?<i>(.*?)</i>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)
argument_names = [argument_name.replace("<i>", "") for argument_name in argument_names]
descriptions = [strip_html(string) for string in re.findall("<dd>(.*?)</dd>", m.group(1), re.IGNORECASE| re.MULTILINE| re.DOTALL)]
arguments = zip(argument_names, descriptions)
else:
# It's possible to have functions without arguments
arguments = [ ]
m = re.search("Return Value</h.>(.*?)</p>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
return_value = strip_html(m.group(1))
else:
m = re.search("Return Values</h.>(.*?)</p>", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
return_value = strip_html(m.group(1))
else:
m = m = re.search("void", content, re.IGNORECASE| re.MULTILINE| re.DOTALL)
if m != None:
return_value = "void"
else:
print "If something has no return value it's not a function."
return None
return_list = []
for dll_name in dll_names:
for function_name in function_names:
print "Found function %s!%s" % (dll_name.lower(), function_name)
if not arguments:
print "No arguments: %s" % function_name
return_list.append((dll_name.lower(), function_name, description, arguments, return_value))
return return_list
else:
return None
def parse_file(file):
print "Parsing %s" % file
text_file = open(file, "r")
content = text_file.read().replace("\r\n", "")
text_file.close()
if content.find("ph:apidata", re.IGNORECASE) != -1:
return parse_old_style(file, content)
elif content.find("<MSHelp:Attr Name=\"APIName\"", re.IGNORECASE| re.MULTILINE) != -1:
return parse_new_style(file, content)
else:
return None
def to_xml(results):
xml_string = "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>"
xml_string = xml_string + "<msdn>\n"
xml_string = xml_string + "<functions>\n"
for (dll_name, function_name, description, arguments, return_value) in results:
xml_string = xml_string + "\t<function>\n"
xml_string = xml_string + "\t\t<name>%s</name>\n" % saxutils.escape(function_name.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t\t<dll>%s</dll>\n" % saxutils.escape(dll_name.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t\t<description>%s</description>\n" % saxutils.escape(description.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t\t<arguments>\n"
for (argument_name, argument_description) in arguments:
xml_string = xml_string + "\t\t\t<argument>\n"
xml_string = xml_string + "\t\t\t\t<name>%s</name>\n" % saxutils.escape(argument_name.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t\t\t\t<description>%s</description>\n" % saxutils.escape(argument_description.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t\t\t</argument>\n"
xml_string = xml_string + "\t\t</arguments>\n"
xml_string = xml_string + "\t\t<returns>%s</returns>\n" % saxutils.escape(return_value.decode('ascii', 'ignore')).encode('ISO-8859-1')
xml_string = xml_string + "\t</function>\n"
xml_string = xml_string + "</functions>\n"
xml_string = xml_string + "</msdn>"
return xml_string
def exclude_dir(directory):
exclude_dirs = [ "\\1033\\html", "\\1033\\workshop" ]
for exclude_dir in exclude_dirs:
if directory.find(exclude_dir) != -1:
return True
return False
def parse_files(msdn_directory):
file_counter = 0
results = [ ]
for root, dirs, files in os.walk(msdn_directory):
for file in files:
if exclude_dir(root):
continue
if file.endswith('htm'):
file_counter = file_counter + 1
result = parse_file(join(root, file))
if result != None:
results.append(result)
return (file_counter, results)
def main():
print "zynamics msdn-crawler - Copyright 2010"
print "For updates please check http://github.com/zynamics/msdn-crawler"
print
if len(sys.argv) != 2:
print "usage: %s path_to_msdn" % sys.argv[0]
print " where path_to_msdn is the path to the decompiled MSDN help files"
sys.exit(0)
msdn_directory = sys.argv[1] # 'C:\\Programme\\Microsoft SDKs\\Windows\\v7.0\\Help\\1033'
(file_counter, results) = parse_files(msdn_directory)
results = sum(results, [])
print "Parsed %d files" % file_counter
print "Extracted information about %d functions" % len(results)
xml_file = open("msdn.xml", "w")
xml_file.write(to_xml(results))
xml_file.close()
if __name__ == "__main__":
main()