common.py 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. # defusedxml
  2. #
  3. # Copyright (c) 2013 by Christian Heimes <christian@python.org>
  4. # Licensed to PSF under a Contributor Agreement.
  5. # See https://www.python.org/psf/license for licensing details.
  6. """Common constants, exceptions and helpe functions
  7. """
  8. import sys
  9. import xml.parsers.expat
  10. PY3 = sys.version_info[0] == 3
  11. # Fail early when pyexpat is not installed correctly
  12. if not hasattr(xml.parsers.expat, "ParserCreate"):
  13. raise ImportError("pyexpat") # pragma: no cover
  14. class DefusedXmlException(ValueError):
  15. """Base exception
  16. """
  17. def __repr__(self):
  18. return str(self)
  19. class DTDForbidden(DefusedXmlException):
  20. """Document type definition is forbidden
  21. """
  22. def __init__(self, name, sysid, pubid):
  23. super(DTDForbidden, self).__init__()
  24. self.name = name
  25. self.sysid = sysid
  26. self.pubid = pubid
  27. def __str__(self):
  28. tpl = "DTDForbidden(name='{}', system_id={!r}, public_id={!r})"
  29. return tpl.format(self.name, self.sysid, self.pubid)
  30. class EntitiesForbidden(DefusedXmlException):
  31. """Entity definition is forbidden
  32. """
  33. def __init__(self, name, value, base, sysid, pubid, notation_name):
  34. super(EntitiesForbidden, self).__init__()
  35. self.name = name
  36. self.value = value
  37. self.base = base
  38. self.sysid = sysid
  39. self.pubid = pubid
  40. self.notation_name = notation_name
  41. def __str__(self):
  42. tpl = "EntitiesForbidden(name='{}', system_id={!r}, public_id={!r})"
  43. return tpl.format(self.name, self.sysid, self.pubid)
  44. class ExternalReferenceForbidden(DefusedXmlException):
  45. """Resolving an external reference is forbidden
  46. """
  47. def __init__(self, context, base, sysid, pubid):
  48. super(ExternalReferenceForbidden, self).__init__()
  49. self.context = context
  50. self.base = base
  51. self.sysid = sysid
  52. self.pubid = pubid
  53. def __str__(self):
  54. tpl = "ExternalReferenceForbidden(system_id='{}', public_id={})"
  55. return tpl.format(self.sysid, self.pubid)
  56. class NotSupportedError(DefusedXmlException):
  57. """The operation is not supported
  58. """
  59. def _apply_defusing(defused_mod):
  60. assert defused_mod is sys.modules[defused_mod.__name__]
  61. stdlib_name = defused_mod.__origin__
  62. __import__(stdlib_name, {}, {}, ["*"])
  63. stdlib_mod = sys.modules[stdlib_name]
  64. stdlib_names = set(dir(stdlib_mod))
  65. for name, obj in vars(defused_mod).items():
  66. if name.startswith("_") or name not in stdlib_names:
  67. continue
  68. setattr(stdlib_mod, name, obj)
  69. return stdlib_mod
  70. def _generate_etree_functions(DefusedXMLParser, _TreeBuilder, _parse, _iterparse):
  71. """Factory for functions needed by etree, dependent on whether
  72. cElementTree or ElementTree is used."""
  73. def parse(source, parser=None, forbid_dtd=False, forbid_entities=True, forbid_external=True):
  74. if parser is None:
  75. parser = DefusedXMLParser(
  76. target=_TreeBuilder(),
  77. forbid_dtd=forbid_dtd,
  78. forbid_entities=forbid_entities,
  79. forbid_external=forbid_external,
  80. )
  81. return _parse(source, parser)
  82. def iterparse(
  83. source,
  84. events=None,
  85. parser=None,
  86. forbid_dtd=False,
  87. forbid_entities=True,
  88. forbid_external=True,
  89. ):
  90. if parser is None:
  91. parser = DefusedXMLParser(
  92. target=_TreeBuilder(),
  93. forbid_dtd=forbid_dtd,
  94. forbid_entities=forbid_entities,
  95. forbid_external=forbid_external,
  96. )
  97. return _iterparse(source, events, parser)
  98. def fromstring(text, forbid_dtd=False, forbid_entities=True, forbid_external=True):
  99. parser = DefusedXMLParser(
  100. target=_TreeBuilder(),
  101. forbid_dtd=forbid_dtd,
  102. forbid_entities=forbid_entities,
  103. forbid_external=forbid_external,
  104. )
  105. parser.feed(text)
  106. return parser.close()
  107. return parse, iterparse, fromstring