blob: c551debf3881028aaee397c5965f94c9b9354c1e [file] [log] [blame]
Guido van Rossuma219efa1997-11-18 15:09:54 +00001# A parser for XML, using the derived class as static DTD.
Guido van Rossum5d68e8e1997-11-18 15:27:20 +00002# Author: Sjoerd Mullender.
Guido van Rossuma219efa1997-11-18 15:09:54 +00003
4import re
5import string
6
7
Guido van Rossumb083a9f1998-12-18 20:17:13 +00008version = '0.2'
Guido van Rossum7e07b381998-04-03 16:02:39 +00009
Guido van Rossuma219efa1997-11-18 15:09:54 +000010# Regular expressions used for parsing
11
Guido van Rossumeeb2f321998-10-19 13:28:26 +000012_S = '[ \t\r\n]+' # white space
13_opS = '[ \t\r\n]*' # optional white space
14_Name = '[a-zA-Z_:][-a-zA-Z0-9._:]*' # valid XML name
15_QStr = "(?:'[^']*'|\"[^\"]*\")" # quoted XML string
Guido van Rossum7e07b381998-04-03 16:02:39 +000016illegal = re.compile('[^\t\r\n -\176\240-\377]') # illegal chars in content
17interesting = re.compile('[]&<]')
Guido van Rossuma219efa1997-11-18 15:09:54 +000018
Guido van Rossum7e07b381998-04-03 16:02:39 +000019amp = re.compile('&')
20ref = re.compile('&(' + _Name + '|#[0-9]+|#x[0-9a-fA-F]+)[^-a-zA-Z0-9._:]')
Guido van Rossuma219efa1997-11-18 15:09:54 +000021entityref = re.compile('&(?P<name>' + _Name + ')[^-a-zA-Z0-9._:]')
22charref = re.compile('&#(?P<char>[0-9]+[^0-9]|x[0-9a-fA-F]+[^0-9a-fA-F])')
Guido van Rossum7e07b381998-04-03 16:02:39 +000023space = re.compile(_S + '$')
Guido van Rossuma219efa1997-11-18 15:09:54 +000024newline = re.compile('\n')
25
Guido van Rossumeeb2f321998-10-19 13:28:26 +000026attrfind = re.compile(
27 _S + '(?P<name>' + _Name + ')'
28 '(' + _opS + '=' + _opS +
29 '(?P<value>'+_QStr+'|[-a-zA-Z0-9.:+*%?!()_#=~]+))?')
Guido van Rossuma219efa1997-11-18 15:09:54 +000030starttagopen = re.compile('<' + _Name)
Guido van Rossuma219efa1997-11-18 15:09:54 +000031starttagend = re.compile(_opS + '(?P<slash>/?)>')
Guido van Rossumeeb2f321998-10-19 13:28:26 +000032starttagmatch = re.compile('<(?P<tagname>'+_Name+')'
33 '(?P<attrs>(?:'+attrfind.pattern+')*)'+
34 starttagend.pattern)
35endtagopen = re.compile('</')
Guido van Rossum7e07b381998-04-03 16:02:39 +000036endbracket = re.compile(_opS + '>')
Guido van Rossumeeb2f321998-10-19 13:28:26 +000037endbracketfind = re.compile('(?:[^>\'"]|'+_QStr+')*>')
Guido van Rossuma219efa1997-11-18 15:09:54 +000038tagfind = re.compile(_Name)
Guido van Rossum02505e41998-01-29 14:55:24 +000039cdataopen = re.compile(r'<!\[CDATA\[')
40cdataclose = re.compile(r'\]\]>')
Guido van Rossum7e07b381998-04-03 16:02:39 +000041# this matches one of the following:
42# SYSTEM SystemLiteral
43# PUBLIC PubidLiteral SystemLiteral
Guido van Rossumeeb2f321998-10-19 13:28:26 +000044_SystemLiteral = '(?P<%s>'+_QStr+')'
Guido van Rossum7e07b381998-04-03 16:02:39 +000045_PublicLiteral = '(?P<%s>"[-\'()+,./:=?;!*#@$_%% \n\ra-zA-Z0-9]*"|' \
46 "'[-()+,./:=?;!*#@$_%% \n\ra-zA-Z0-9]*')"
47_ExternalId = '(?:SYSTEM|' \
48 'PUBLIC'+_S+_PublicLiteral%'pubid'+ \
49 ')'+_S+_SystemLiteral%'syslit'
50doctype = re.compile('<!DOCTYPE'+_S+'(?P<name>'+_Name+')'
51 '(?:'+_S+_ExternalId+')?'+_opS)
52xmldecl = re.compile('<\?xml'+_S+
Guido van Rossumeeb2f321998-10-19 13:28:26 +000053 'version'+_opS+'='+_opS+'(?P<version>'+_QStr+')'+
Guido van Rossum7e07b381998-04-03 16:02:39 +000054 '(?:'+_S+'encoding'+_opS+'='+_opS+
55 "(?P<encoding>'[A-Za-z][-A-Za-z0-9._]*'|"
56 '"[A-Za-z][-A-Za-z0-9._]*"))?'
57 '(?:'+_S+'standalone'+_opS+'='+_opS+
58 '(?P<standalone>\'(?:yes|no)\'|"(?:yes|no)"))?'+
59 _opS+'\?>')
60procopen = re.compile(r'<\?(?P<proc>' + _Name + ')' + _opS)
Guido van Rossum02505e41998-01-29 14:55:24 +000061procclose = re.compile(_opS + r'\?>')
Guido van Rossuma219efa1997-11-18 15:09:54 +000062commentopen = re.compile('<!--')
63commentclose = re.compile('-->')
64doubledash = re.compile('--')
Guido van Rossum7e07b381998-04-03 16:02:39 +000065attrtrans = string.maketrans(' \r\n\t', ' ')
Guido van Rossuma219efa1997-11-18 15:09:54 +000066
Guido van Rossumb083a9f1998-12-18 20:17:13 +000067# definitions for XML namespaces
68_NCName = '[a-zA-Z_][-a-zA-Z0-9._]*' # XML Name, minus the ":"
69ncname = re.compile(_NCName + '$')
70qname = re.compile('(?:(?P<prefix>' + _NCName + '):)?' # optional prefix
71 '(?P<local>' + _NCName + ')$')
72
73xmlns = re.compile('xmlns(?::(?P<ncname>'+_NCName+'))?$')
Guido van Rossuma219efa1997-11-18 15:09:54 +000074
75# XML parser base class -- find tags and call handler functions.
76# Usage: p = XMLParser(); p.feed(data); ...; p.close().
Guido van Rossum5d68e8e1997-11-18 15:27:20 +000077# The dtd is defined by deriving a class which defines methods with
78# special names to handle tags: start_foo and end_foo to handle <foo>
79# and </foo>, respectively. The data between tags is passed to the
80# parser by calling self.handle_data() with some data as argument (the
81# data may be split up in arbutrary chunks). Entity references are
82# passed by calling self.handle_entityref() with the entity reference
83# as argument.
Guido van Rossuma219efa1997-11-18 15:09:54 +000084
85class XMLParser:
Guido van Rossumb083a9f1998-12-18 20:17:13 +000086 attributes = {} # default, to be overridden
87 elements = {} # default, to be overridden
Guido van Rossuma219efa1997-11-18 15:09:54 +000088
89 # Interface -- initialize and reset this instance
Guido van Rossumb083a9f1998-12-18 20:17:13 +000090 def __init__(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000091 self.reset()
Guido van Rossuma219efa1997-11-18 15:09:54 +000092
93 # Interface -- reset this instance. Loses all unprocessed data
94 def reset(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000095 self.rawdata = ''
96 self.stack = []
97 self.nomoretags = 0
98 self.literal = 0
99 self.lineno = 1
100 self.__at_start = 1
101 self.__seen_doctype = None
102 self.__seen_starttag = 0
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000103 self.__namespaces = {'xml':None} # xml is implicitly declared
Guido van Rossuma219efa1997-11-18 15:09:54 +0000104
105 # For derived classes only -- enter literal mode (CDATA) till EOF
106 def setnomoretags(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000107 self.nomoretags = self.literal = 1
Guido van Rossuma219efa1997-11-18 15:09:54 +0000108
109 # For derived classes only -- enter literal mode (CDATA)
110 def setliteral(self, *args):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000111 self.literal = 1
Guido van Rossuma219efa1997-11-18 15:09:54 +0000112
113 # Interface -- feed some data to the parser. Call this as
114 # often as you want, with as little or as much text as you
115 # want (may include '\n'). (This just saves the text, all the
116 # processing is done by goahead().)
117 def feed(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000118 self.rawdata = self.rawdata + data
119 self.goahead(0)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000120
121 # Interface -- handle the remaining data
122 def close(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000123 self.goahead(1)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000124
125 # Interface -- translate references
Guido van Rossum7e07b381998-04-03 16:02:39 +0000126 def translate_references(self, data, all = 1):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000127 i = 0
128 while 1:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000129 res = amp.search(data, i)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000130 if res is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000131 return data
132 res = ref.match(data, res.start(0))
133 if res is None:
134 self.syntax_error("bogus `&'")
135 i =i+1
136 continue
137 i = res.end(0)
138 if data[i - 1] != ';':
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000139 self.syntax_error("`;' missing after entity/char reference")
Guido van Rossum7e07b381998-04-03 16:02:39 +0000140 i = i-1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000141 str = res.group(1)
Guido van Rossum7e07b381998-04-03 16:02:39 +0000142 pre = data[:res.start(0)]
143 post = data[i:]
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000144 if str[0] == '#':
145 if str[1] == 'x':
Guido van Rossum7e07b381998-04-03 16:02:39 +0000146 str = chr(string.atoi(str[2:], 16))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000147 else:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000148 str = chr(string.atoi(str[1:]))
149 data = pre + str + post
150 i = res.start(0)+len(str)
151 elif all:
152 if self.entitydefs.has_key(str):
153 data = pre + self.entitydefs[str] + post
154 i = res.start(0) # rescan substituted text
155 else:
156 self.syntax_error('reference to unknown entity')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000157 # can't do it, so keep the entity ref in
Guido van Rossum7e07b381998-04-03 16:02:39 +0000158 data = pre + '&' + str + ';' + post
159 i = res.start(0) + len(str) + 2
160 else:
161 # just translating character references
162 pass # i is already postioned correctly
Guido van Rossuma219efa1997-11-18 15:09:54 +0000163
164 # Internal -- handle data as far as reasonable. May leave state
165 # and data to be processed by a subsequent call. If 'end' is
166 # true, force handling all data as if followed by EOF marker.
167 def goahead(self, end):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000168 rawdata = self.rawdata
169 i = 0
170 n = len(rawdata)
171 while i < n:
172 if i > 0:
173 self.__at_start = 0
174 if self.nomoretags:
175 data = rawdata[i:n]
176 self.handle_data(data)
177 self.lineno = self.lineno + string.count(data, '\n')
178 i = n
179 break
180 res = interesting.search(rawdata, i)
181 if res:
182 j = res.start(0)
183 else:
184 j = n
185 if i < j:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000186 if self.__at_start:
187 self.syntax_error('illegal data at start of file')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000188 self.__at_start = 0
189 data = rawdata[i:j]
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000190 if not self.stack and space.match(data) is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000191 self.syntax_error('data not in content')
192 if illegal.search(data):
193 self.syntax_error('illegal character in content')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000194 self.handle_data(data)
195 self.lineno = self.lineno + string.count(data, '\n')
196 i = j
197 if i == n: break
198 if rawdata[i] == '<':
199 if starttagopen.match(rawdata, i):
200 if self.literal:
201 data = rawdata[i]
202 self.handle_data(data)
203 self.lineno = self.lineno + string.count(data, '\n')
204 i = i+1
205 continue
206 k = self.parse_starttag(i)
207 if k < 0: break
208 self.__seen_starttag = 1
209 self.lineno = self.lineno + string.count(rawdata[i:k], '\n')
210 i = k
211 continue
212 if endtagopen.match(rawdata, i):
213 k = self.parse_endtag(i)
214 if k < 0: break
215 self.lineno = self.lineno + string.count(rawdata[i:k], '\n')
216 i = k
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000217 continue
218 if commentopen.match(rawdata, i):
219 if self.literal:
220 data = rawdata[i]
221 self.handle_data(data)
222 self.lineno = self.lineno + string.count(data, '\n')
223 i = i+1
224 continue
225 k = self.parse_comment(i)
226 if k < 0: break
227 self.lineno = self.lineno + string.count(rawdata[i:k], '\n')
228 i = k
229 continue
230 if cdataopen.match(rawdata, i):
231 k = self.parse_cdata(i)
232 if k < 0: break
233 self.lineno = self.lineno + string.count(rawdata[i:i], '\n')
234 i = k
235 continue
Guido van Rossum7e07b381998-04-03 16:02:39 +0000236 res = xmldecl.match(rawdata, i)
237 if res:
238 if not self.__at_start:
239 self.syntax_error("<?xml?> declaration not at start of document")
240 version, encoding, standalone = res.group('version',
241 'encoding',
242 'standalone')
243 if version[1:-1] != '1.0':
244 raise RuntimeError, 'only XML version 1.0 supported'
245 if encoding: encoding = encoding[1:-1]
246 if standalone: standalone = standalone[1:-1]
247 self.handle_xml(encoding, standalone)
248 i = res.end(0)
249 continue
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000250 res = procopen.match(rawdata, i)
251 if res:
252 k = self.parse_proc(i)
253 if k < 0: break
254 self.lineno = self.lineno + string.count(rawdata[i:k], '\n')
255 i = k
256 continue
257 res = doctype.match(rawdata, i)
258 if res:
259 if self.literal:
260 data = rawdata[i]
261 self.handle_data(data)
262 self.lineno = self.lineno + string.count(data, '\n')
263 i = i+1
264 continue
265 if self.__seen_doctype:
266 self.syntax_error('multiple DOCTYPE elements')
267 if self.__seen_starttag:
268 self.syntax_error('DOCTYPE not at beginning of document')
269 k = self.parse_doctype(res)
270 if k < 0: break
271 self.__seen_doctype = res.group('name')
272 self.lineno = self.lineno + string.count(rawdata[i:k], '\n')
273 i = k
274 continue
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000275 elif rawdata[i] == '&':
Guido van Rossum204b65c1998-12-08 13:25:00 +0000276 if self.literal:
277 data = rawdata[i]
278 self.handle_data(data)
279 i = i+1
280 continue
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000281 res = charref.match(rawdata, i)
282 if res is not None:
283 i = res.end(0)
284 if rawdata[i-1] != ';':
285 self.syntax_error("`;' missing in charref")
286 i = i-1
Guido van Rossum7e07b381998-04-03 16:02:39 +0000287 if not self.stack:
288 self.syntax_error('data not in content')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000289 self.handle_charref(res.group('char')[:-1])
290 self.lineno = self.lineno + string.count(res.group(0), '\n')
291 continue
292 res = entityref.match(rawdata, i)
293 if res is not None:
294 i = res.end(0)
295 if rawdata[i-1] != ';':
296 self.syntax_error("`;' missing in entityref")
297 i = i-1
Guido van Rossum7e07b381998-04-03 16:02:39 +0000298 name = res.group('name')
299 if self.entitydefs.has_key(name):
300 self.rawdata = rawdata = rawdata[:res.start(0)] + self.entitydefs[name] + rawdata[i:]
301 n = len(rawdata)
302 i = res.start(0)
303 else:
304 self.syntax_error('reference to unknown entity')
305 self.unknown_entityref(name)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000306 self.lineno = self.lineno + string.count(res.group(0), '\n')
307 continue
Guido van Rossum7e07b381998-04-03 16:02:39 +0000308 elif rawdata[i] == ']':
Guido van Rossum204b65c1998-12-08 13:25:00 +0000309 if self.literal:
310 data = rawdata[i]
311 self.handle_data(data)
312 i = i+1
313 continue
Guido van Rossum7e07b381998-04-03 16:02:39 +0000314 if n-i < 3:
315 break
316 if cdataclose.match(rawdata, i):
317 self.syntax_error("bogus `]]>'")
318 self.handle_data(rawdata[i])
319 i = i+1
320 continue
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000321 else:
322 raise RuntimeError, 'neither < nor & ??'
323 # We get here only if incomplete matches but
324 # nothing else
Guido van Rossum7e07b381998-04-03 16:02:39 +0000325 break
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000326 # end while
Guido van Rossum7e07b381998-04-03 16:02:39 +0000327 if i > 0:
328 self.__at_start = 0
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000329 if end and i < n:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000330 data = rawdata[i]
331 self.syntax_error("bogus `%s'" % data)
332 if illegal.search(data):
333 self.syntax_error('illegal character in content')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000334 self.handle_data(data)
335 self.lineno = self.lineno + string.count(data, '\n')
Guido van Rossum7e07b381998-04-03 16:02:39 +0000336 self.rawdata = rawdata[i+1:]
337 return self.goahead(end)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000338 self.rawdata = rawdata[i:]
339 if end:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000340 if not self.__seen_starttag:
341 self.syntax_error('no elements in file')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000342 if self.stack:
343 self.syntax_error('missing end tags')
344 while self.stack:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000345 self.finish_endtag(self.stack[-1][0])
Guido van Rossuma219efa1997-11-18 15:09:54 +0000346
347 # Internal -- parse comment, return length or -1 if not terminated
348 def parse_comment(self, i):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000349 rawdata = self.rawdata
350 if rawdata[i:i+4] <> '<!--':
351 raise RuntimeError, 'unexpected call to handle_comment'
352 res = commentclose.search(rawdata, i+4)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000353 if res is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000354 return -1
Guido van Rossum7e07b381998-04-03 16:02:39 +0000355 if doubledash.search(rawdata, i+4, res.start(0)):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000356 self.syntax_error("`--' inside comment")
Guido van Rossum7e07b381998-04-03 16:02:39 +0000357 if rawdata[res.start(0)-1] == '-':
358 self.syntax_error('comment cannot end in three dashes')
359 if illegal.search(rawdata, i+4, res.start(0)):
360 self.syntax_error('illegal character in comment')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000361 self.handle_comment(rawdata[i+4: res.start(0)])
362 return res.end(0)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000363
Guido van Rossum02505e41998-01-29 14:55:24 +0000364 # Internal -- handle DOCTYPE tag, return length or -1 if not terminated
365 def parse_doctype(self, res):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000366 rawdata = self.rawdata
367 n = len(rawdata)
368 name = res.group('name')
Guido van Rossum7e07b381998-04-03 16:02:39 +0000369 pubid, syslit = res.group('pubid', 'syslit')
370 if pubid is not None:
371 pubid = pubid[1:-1] # remove quotes
372 pubid = string.join(string.split(pubid)) # normalize
373 if syslit is not None: syslit = syslit[1:-1] # remove quotes
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000374 j = k = res.end(0)
Guido van Rossum7e07b381998-04-03 16:02:39 +0000375 if k >= n:
376 return -1
377 if rawdata[k] == '[':
378 level = 0
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000379 k = k+1
Guido van Rossum7e07b381998-04-03 16:02:39 +0000380 dq = sq = 0
381 while k < n:
382 c = rawdata[k]
383 if not sq and c == '"':
384 dq = not dq
385 elif not dq and c == "'":
386 sq = not sq
387 elif sq or dq:
388 pass
389 elif level <= 0 and c == ']':
390 res = endbracket.match(rawdata, k+1)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000391 if res is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000392 return -1
393 self.handle_doctype(name, pubid, syslit, rawdata[j+1:k])
394 return res.end(0)
395 elif c == '<':
396 level = level + 1
397 elif c == '>':
398 level = level - 1
399 if level < 0:
400 self.syntax_error("bogus `>' in DOCTYPE")
401 k = k+1
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000402 res = endbracketfind.match(rawdata, k)
403 if res is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000404 return -1
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000405 if endbracket.match(rawdata, k) is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000406 self.syntax_error('garbage in DOCTYPE')
407 self.handle_doctype(name, pubid, syslit, None)
408 return res.end(0)
Guido van Rossum02505e41998-01-29 14:55:24 +0000409
410 # Internal -- handle CDATA tag, return length or -1 if not terminated
Guido van Rossuma219efa1997-11-18 15:09:54 +0000411 def parse_cdata(self, i):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000412 rawdata = self.rawdata
413 if rawdata[i:i+9] <> '<![CDATA[':
Guido van Rossum7e07b381998-04-03 16:02:39 +0000414 raise RuntimeError, 'unexpected call to parse_cdata'
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000415 res = cdataclose.search(rawdata, i+9)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000416 if res is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000417 return -1
Guido van Rossum7e07b381998-04-03 16:02:39 +0000418 if illegal.search(rawdata, i+9, res.start(0)):
419 self.syntax_error('illegal character in CDATA')
420 if not self.stack:
421 self.syntax_error('CDATA not in content')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000422 self.handle_cdata(rawdata[i+9:res.start(0)])
423 return res.end(0)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000424
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000425 __xml_namespace_attributes = {'ns':None, 'src':None, 'prefix':None}
Guido van Rossum02505e41998-01-29 14:55:24 +0000426 # Internal -- handle a processing instruction tag
427 def parse_proc(self, i):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000428 rawdata = self.rawdata
429 end = procclose.search(rawdata, i)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000430 if end is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000431 return -1
432 j = end.start(0)
Guido van Rossum7e07b381998-04-03 16:02:39 +0000433 if illegal.search(rawdata, i+2, j):
434 self.syntax_error('illegal character in processing instruction')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000435 res = tagfind.match(rawdata, i+2)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000436 if res is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000437 raise RuntimeError, 'unexpected call to parse_proc'
438 k = res.end(0)
439 name = res.group(0)
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000440 if name == 'xml:namespace':
441 self.syntax_error('old-fashioned namespace declaration')
442 # namespace declaration
443 # this must come after the <?xml?> declaration (if any)
444 # and before the <!DOCTYPE> (if any).
445 if self.__seen_doctype or self.__seen_starttag:
446 self.syntax_error('xml:namespace declaration too late in document')
447 attrdict, namespace, k = self.parse_attributes(name, k, j)
448 if namespace:
449 self.syntax_error('namespace declaration inside namespace declaration')
450 for attrname in attrdict.keys():
451 if not self.__xml_namespace_attributes.has_key(attrname):
452 self.syntax_error("unknown attribute `%s' in xml:namespace tag" % attrname)
453 if not attrdict.has_key('ns') or not attrdict.has_key('prefix'):
454 self.syntax_error('xml:namespace without required attributes')
455 prefix = attrdict.get('prefix')
456 if ncname.match(prefix) is None:
457 self.syntax_error('xml:namespace illegal prefix value')
458 return end.end(0)
459 if self.__namespaces.has_key(prefix):
460 self.syntax_error('xml:namespace prefix not unique')
461 self.__namespaces[prefix] = attrdict['ns']
462 else:
463 if string.find(string.lower(name), 'xml') >= 0:
464 self.syntax_error('illegal processing instruction target name')
465 self.handle_proc(name, rawdata[k:j])
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000466 return end.end(0)
Guido van Rossum02505e41998-01-29 14:55:24 +0000467
468 # Internal -- parse attributes between i and j
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000469 def parse_attributes(self, tag, i, j):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000470 rawdata = self.rawdata
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000471 attrdict = {}
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000472 namespace = {}
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000473 while i < j:
474 res = attrfind.match(rawdata, i)
475 if res is None:
476 break
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000477 attrname, attrvalue = res.group('name', 'value')
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000478 i = res.end(0)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000479 if attrvalue is None:
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000480 self.syntax_error("no value specified for attribute `%s'" % attrname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000481 attrvalue = attrname
482 elif attrvalue[:1] == "'" == attrvalue[-1:] or \
483 attrvalue[:1] == '"' == attrvalue[-1:]:
484 attrvalue = attrvalue[1:-1]
485 else:
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000486 self.syntax_error("attribute `%s' value not quoted" % attrname)
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000487 res = xmlns.match(attrname)
488 if res is not None:
489 # namespace declaration
490 ncname = res.group('ncname')
491 namespace[ncname or ''] = attrvalue or None
492 continue
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000493 if '<' in attrvalue:
494 self.syntax_error("`<' illegal in attribute value")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000495 if attrdict.has_key(attrname):
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000496 self.syntax_error("attribute `%s' specified twice" % attrname)
Guido van Rossum7e07b381998-04-03 16:02:39 +0000497 attrvalue = string.translate(attrvalue, attrtrans)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000498 attrdict[attrname] = self.translate_references(attrvalue)
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000499 return attrdict, namespace, i
Guido van Rossuma219efa1997-11-18 15:09:54 +0000500
501 # Internal -- handle starttag, return length or -1 if not terminated
502 def parse_starttag(self, i):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000503 rawdata = self.rawdata
504 # i points to start of tag
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000505 end = endbracketfind.match(rawdata, i+1)
506 if end is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000507 return -1
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000508 tag = starttagmatch.match(rawdata, i)
509 if tag is None or tag.end(0) != end.end(0):
510 self.syntax_error('garbage in starttag')
511 return end.end(0)
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000512 nstag = tagname = tag.group('tagname')
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000513 if not self.__seen_starttag and self.__seen_doctype and \
514 tagname != self.__seen_doctype:
515 self.syntax_error('starttag does not match DOCTYPE')
Guido van Rossum7e07b381998-04-03 16:02:39 +0000516 if self.__seen_starttag and not self.stack:
517 self.syntax_error('multiple elements on top level')
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000518 k, j = tag.span('attrs')
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000519 attrdict, nsdict, k = self.parse_attributes(tagname, k, j)
520 self.stack.append((tagname, nsdict, nstag))
521 res = qname.match(tagname)
522 if res is not None:
523 prefix, nstag = res.group('prefix', 'local')
524 if prefix is None:
525 prefix = ''
526 ns = None
527 for t, d, nst in self.stack:
528 if d.has_key(prefix):
529 ns = d[prefix]
530 if ns is None and prefix != '':
531 ns = self.__namespaces.get(prefix)
532 if ns is not None:
533 nstag = ns + ' ' + nstag
534 elif prefix != '':
535 nstag = prefix + ':' + nstag # undo split
536 self.stack[-1] = tagname, nsdict, nstag
537 # translate namespace of attributes
538 nattrdict = {}
539 for key, val in attrdict.items():
540 res = qname.match(key)
541 if res is not None:
542 aprefix, key = res.group('prefix', 'local')
543 if aprefix is None:
544 aprefix = ''
545 ans = None
546 for t, d, nst in self.stack:
547 if d.has_key(aprefix):
548 ans = d[aprefix]
549 if ans is None and aprefix != '':
550 ans = self.__namespaces.get(aprefix)
551 if ans is not None:
552 key = ans + ' ' + key
553 elif aprefix != '':
554 key = aprefix + ':' + key
555 elif ns is not None:
556 key = ns + ' ' + key
557 nattrdict[key] = val
558 attrdict = nattrdict
559 attributes = self.attributes.get(nstag)
560 if attributes is not None:
561 for key in attrdict.keys():
562 if not attributes.has_key(key):
563 self.syntax_error("unknown attribute `%s' in tag `%s'" % (key, tagname))
564 for key, val in attributes.items():
565 if val is not None and not attrdict.has_key(key):
566 attrdict[key] = val
567 method = self.elements.get(nstag, (None, None))[0]
568 self.finish_starttag(nstag, attrdict, method)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000569 if tag.group('slash') == '/':
570 self.finish_endtag(tagname)
571 return tag.end(0)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000572
573 # Internal -- parse endtag
574 def parse_endtag(self, i):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000575 rawdata = self.rawdata
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000576 end = endbracketfind.match(rawdata, i+1)
577 if end is None:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000578 return -1
579 res = tagfind.match(rawdata, i+2)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000580 if res is None:
Guido van Rossumf484a331998-12-07 21:59:56 +0000581 if self.literal:
582 self.handle_data(rawdata[i])
583 return i+1
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000584 self.syntax_error('no name specified in end tag')
585 tag = ''
586 k = i+2
587 else:
588 tag = res.group(0)
Guido van Rossumf484a331998-12-07 21:59:56 +0000589 if self.literal:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000590 if not self.stack or tag != self.stack[-1][0]:
Guido van Rossumf484a331998-12-07 21:59:56 +0000591 self.handle_data(rawdata[i])
592 return i+1
593 self.literal = 0
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000594 k = res.end(0)
Guido van Rossumeeb2f321998-10-19 13:28:26 +0000595 if endbracket.match(rawdata, k) is None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000596 self.syntax_error('garbage in end tag')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000597 self.finish_endtag(tag)
598 return end.end(0)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000599
600 # Internal -- finish processing of start tag
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000601 def finish_starttag(self, tagname, attrdict, method):
602 if method is not None:
603 self.handle_starttag(tagname, method, attrdict)
Guido van Rossum7e07b381998-04-03 16:02:39 +0000604 else:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000605 self.unknown_starttag(tagname, attrdict)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000606
607 # Internal -- finish processing of end tag
608 def finish_endtag(self, tag):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000609 if not tag:
610 self.syntax_error('name-less end tag')
611 found = len(self.stack) - 1
612 if found < 0:
613 self.unknown_endtag(tag)
614 return
615 else:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000616 found = -1
617 for i in range(len(self.stack)):
618 if tag == self.stack[i][0]:
619 found = i
620 if found == -1:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000621 self.syntax_error('unopened end tag')
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000622 method = self.elements.get(tag, (None, None))[1]
623 if method is not None:
Guido van Rossum7e07b381998-04-03 16:02:39 +0000624 self.handle_endtag(tag, method)
625 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000626 self.unknown_endtag(tag)
627 return
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000628 while len(self.stack) > found:
629 if found < len(self.stack) - 1:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000630 self.syntax_error('missing close tag for %s' % self.stack[-1][2])
631 nstag = self.stack[-1][2]
632 method = self.elements.get(nstag, (None, None))[1]
633 if method is not None:
634 self.handle_endtag(nstag, method)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000635 else:
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000636 self.unknown_endtag(nstag)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000637 del self.stack[-1]
Guido van Rossuma219efa1997-11-18 15:09:54 +0000638
Guido van Rossum02505e41998-01-29 14:55:24 +0000639 # Overridable -- handle xml processing instruction
640 def handle_xml(self, encoding, standalone):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000641 pass
Guido van Rossum02505e41998-01-29 14:55:24 +0000642
643 # Overridable -- handle DOCTYPE
Guido van Rossum7e07b381998-04-03 16:02:39 +0000644 def handle_doctype(self, tag, pubid, syslit, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000645 pass
Guido van Rossum02505e41998-01-29 14:55:24 +0000646
Guido van Rossuma219efa1997-11-18 15:09:54 +0000647 # Overridable -- handle start tag
648 def handle_starttag(self, tag, method, attrs):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000649 method(attrs)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000650
651 # Overridable -- handle end tag
652 def handle_endtag(self, tag, method):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000653 method()
Guido van Rossuma219efa1997-11-18 15:09:54 +0000654
655 # Example -- handle character reference, no need to override
656 def handle_charref(self, name):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000657 try:
658 if name[0] == 'x':
659 n = string.atoi(name[1:], 16)
660 else:
661 n = string.atoi(name)
662 except string.atoi_error:
663 self.unknown_charref(name)
664 return
665 if not 0 <= n <= 255:
666 self.unknown_charref(name)
667 return
668 self.handle_data(chr(n))
Guido van Rossuma219efa1997-11-18 15:09:54 +0000669
670 # Definition of entities -- derived classes may override
Guido van Rossum7e07b381998-04-03 16:02:39 +0000671 entitydefs = {'lt': '&#60;', # must use charref
672 'gt': '&#62;',
673 'amp': '&#38;', # must use charref
674 'quot': '&#34;',
675 'apos': '&#39;',
676 }
Guido van Rossuma219efa1997-11-18 15:09:54 +0000677
678 # Example -- handle entity reference, no need to override
679 def handle_entityref(self, name):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000680 table = self.entitydefs
681 if table.has_key(name):
682 self.handle_data(table[name])
683 else:
684 self.unknown_entityref(name)
685 return
Guido van Rossuma219efa1997-11-18 15:09:54 +0000686
687 # Example -- handle data, should be overridden
688 def handle_data(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000689 pass
Guido van Rossuma219efa1997-11-18 15:09:54 +0000690
691 # Example -- handle cdata, could be overridden
692 def handle_cdata(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000693 pass
Guido van Rossuma219efa1997-11-18 15:09:54 +0000694
695 # Example -- handle comment, could be overridden
696 def handle_comment(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000697 pass
Guido van Rossuma219efa1997-11-18 15:09:54 +0000698
699 # Example -- handle processing instructions, could be overridden
700 def handle_proc(self, name, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000701 pass
Guido van Rossuma219efa1997-11-18 15:09:54 +0000702
Guido van Rossuma219efa1997-11-18 15:09:54 +0000703 # Example -- handle relatively harmless syntax errors, could be overridden
Guido van Rossum02505e41998-01-29 14:55:24 +0000704 def syntax_error(self, message):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000705 raise RuntimeError, 'Syntax error at line %d: %s' % (self.lineno, message)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000706
707 # To be overridden -- handlers for unknown objects
708 def unknown_starttag(self, tag, attrs): pass
709 def unknown_endtag(self, tag): pass
710 def unknown_charref(self, ref): pass
711 def unknown_entityref(self, ref): pass
712
713
714class TestXMLParser(XMLParser):
715
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000716 def __init__(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000717 self.testdata = ""
Guido van Rossumb083a9f1998-12-18 20:17:13 +0000718 XMLParser.__init__(self)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000719
Guido van Rossum02505e41998-01-29 14:55:24 +0000720 def handle_xml(self, encoding, standalone):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000721 self.flush()
722 print 'xml: encoding =',encoding,'standalone =',standalone
Guido van Rossum02505e41998-01-29 14:55:24 +0000723
Guido van Rossum7e07b381998-04-03 16:02:39 +0000724 def handle_doctype(self, tag, pubid, syslit, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000725 self.flush()
726 print 'DOCTYPE:',tag, `data`
Guido van Rossum02505e41998-01-29 14:55:24 +0000727
Guido van Rossum7e07b381998-04-03 16:02:39 +0000728 def handle_entity(self, name, strval, pubid, syslit, ndata):
729 self.flush()
730 print 'ENTITY:',`data`
731
Guido van Rossuma219efa1997-11-18 15:09:54 +0000732 def handle_data(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000733 self.testdata = self.testdata + data
734 if len(`self.testdata`) >= 70:
735 self.flush()
Guido van Rossuma219efa1997-11-18 15:09:54 +0000736
737 def flush(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000738 data = self.testdata
739 if data:
740 self.testdata = ""
741 print 'data:', `data`
Guido van Rossuma219efa1997-11-18 15:09:54 +0000742
743 def handle_cdata(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000744 self.flush()
745 print 'cdata:', `data`
Guido van Rossuma219efa1997-11-18 15:09:54 +0000746
747 def handle_proc(self, name, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000748 self.flush()
749 print 'processing:',name,`data`
Guido van Rossuma219efa1997-11-18 15:09:54 +0000750
Guido van Rossuma219efa1997-11-18 15:09:54 +0000751 def handle_comment(self, data):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000752 self.flush()
753 r = `data`
754 if len(r) > 68:
755 r = r[:32] + '...' + r[-32:]
756 print 'comment:', r
Guido van Rossuma219efa1997-11-18 15:09:54 +0000757
Guido van Rossum02505e41998-01-29 14:55:24 +0000758 def syntax_error(self, message):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000759 print 'error at line %d:' % self.lineno, message
Guido van Rossuma219efa1997-11-18 15:09:54 +0000760
761 def unknown_starttag(self, tag, attrs):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000762 self.flush()
763 if not attrs:
764 print 'start tag: <' + tag + '>'
765 else:
766 print 'start tag: <' + tag,
767 for name, value in attrs.items():
768 print name + '=' + '"' + value + '"',
769 print '>'
Guido van Rossuma219efa1997-11-18 15:09:54 +0000770
771 def unknown_endtag(self, tag):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000772 self.flush()
773 print 'end tag: </' + tag + '>'
Guido van Rossuma219efa1997-11-18 15:09:54 +0000774
775 def unknown_entityref(self, ref):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000776 self.flush()
777 print '*** unknown entity ref: &' + ref + ';'
Guido van Rossuma219efa1997-11-18 15:09:54 +0000778
779 def unknown_charref(self, ref):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000780 self.flush()
781 print '*** unknown char ref: &#' + ref + ';'
Guido van Rossuma219efa1997-11-18 15:09:54 +0000782
783 def close(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000784 XMLParser.close(self)
785 self.flush()
Guido van Rossuma219efa1997-11-18 15:09:54 +0000786
787def test(args = None):
788 import sys
789
790 if not args:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000791 args = sys.argv[1:]
Guido van Rossuma219efa1997-11-18 15:09:54 +0000792
793 if args and args[0] == '-s':
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000794 args = args[1:]
795 klass = XMLParser
Guido van Rossuma219efa1997-11-18 15:09:54 +0000796 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000797 klass = TestXMLParser
Guido van Rossuma219efa1997-11-18 15:09:54 +0000798
799 if args:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000800 file = args[0]
Guido van Rossuma219efa1997-11-18 15:09:54 +0000801 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000802 file = 'test.xml'
Guido van Rossuma219efa1997-11-18 15:09:54 +0000803
804 if file == '-':
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000805 f = sys.stdin
Guido van Rossuma219efa1997-11-18 15:09:54 +0000806 else:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000807 try:
808 f = open(file, 'r')
809 except IOError, msg:
810 print file, ":", msg
811 sys.exit(1)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000812
813 data = f.read()
814 if f is not sys.stdin:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000815 f.close()
Guido van Rossuma219efa1997-11-18 15:09:54 +0000816
817 x = klass()
Guido van Rossum7e07b381998-04-03 16:02:39 +0000818 try:
819 for c in data:
820 x.feed(c)
821 x.close()
822 except RuntimeError, msg:
823 print msg
824 sys.exit(1)
Guido van Rossuma219efa1997-11-18 15:09:54 +0000825
826
827if __name__ == '__main__':
828 test()