plistlib.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993
  1. r"""plistlib.py -- a tool to generate and parse MacOSX .plist files.
  2. The property list (.plist) file format is a simple XML pickle supporting
  3. basic object types, like dictionaries, lists, numbers and strings.
  4. Usually the top level object is a dictionary.
  5. To write out a plist file, use the dump(value, file)
  6. function. 'value' is the top level object, 'file' is
  7. a (writable) file object.
  8. To parse a plist from a file, use the load(file) function,
  9. with a (readable) file object as the only argument. It
  10. returns the top level object (again, usually a dictionary).
  11. To work with plist data in bytes objects, you can use loads()
  12. and dumps().
  13. Values can be strings, integers, floats, booleans, tuples, lists,
  14. dictionaries (but only with string keys), Data, bytes, bytearray, or
  15. datetime.datetime objects.
  16. Generate Plist example:
  17. pl = dict(
  18. aString = "Doodah",
  19. aList = ["A", "B", 12, 32.1, [1, 2, 3]],
  20. aFloat = 0.1,
  21. anInt = 728,
  22. aDict = dict(
  23. anotherString = "<hello & hi there!>",
  24. aUnicodeValue = "M\xe4ssig, Ma\xdf",
  25. aTrueValue = True,
  26. aFalseValue = False,
  27. ),
  28. someData = b"<binary gunk>",
  29. someMoreData = b"<lots of binary gunk>" * 10,
  30. aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),
  31. )
  32. with open(fileName, 'wb') as fp:
  33. dump(pl, fp)
  34. Parse Plist example:
  35. with open(fileName, 'rb') as fp:
  36. pl = load(fp)
  37. print(pl["aKey"])
  38. """
  39. __all__ = [
  40. "readPlist", "writePlist", "readPlistFromBytes", "writePlistToBytes",
  41. "Data", "InvalidFileException", "FMT_XML", "FMT_BINARY",
  42. "load", "dump", "loads", "dumps"
  43. ]
  44. import binascii
  45. import codecs
  46. import contextlib
  47. import datetime
  48. import enum
  49. from io import BytesIO
  50. import itertools
  51. import os
  52. import re
  53. import struct
  54. from warnings import warn
  55. from xml.parsers.expat import ParserCreate
  56. PlistFormat = enum.Enum('PlistFormat', 'FMT_XML FMT_BINARY', module=__name__)
  57. globals().update(PlistFormat.__members__)
  58. #
  59. #
  60. # Deprecated functionality
  61. #
  62. #
  63. @contextlib.contextmanager
  64. def _maybe_open(pathOrFile, mode):
  65. if isinstance(pathOrFile, str):
  66. with open(pathOrFile, mode) as fp:
  67. yield fp
  68. else:
  69. yield pathOrFile
  70. def readPlist(pathOrFile):
  71. """
  72. Read a .plist from a path or file. pathOrFile should either
  73. be a file name, or a readable binary file object.
  74. This function is deprecated, use load instead.
  75. """
  76. warn("The readPlist function is deprecated, use load() instead",
  77. DeprecationWarning, 2)
  78. with _maybe_open(pathOrFile, 'rb') as fp:
  79. return load(fp, fmt=None, use_builtin_types=False)
  80. def writePlist(value, pathOrFile):
  81. """
  82. Write 'value' to a .plist file. 'pathOrFile' may either be a
  83. file name or a (writable) file object.
  84. This function is deprecated, use dump instead.
  85. """
  86. warn("The writePlist function is deprecated, use dump() instead",
  87. DeprecationWarning, 2)
  88. with _maybe_open(pathOrFile, 'wb') as fp:
  89. dump(value, fp, fmt=FMT_XML, sort_keys=True, skipkeys=False)
  90. def readPlistFromBytes(data):
  91. """
  92. Read a plist data from a bytes object. Return the root object.
  93. This function is deprecated, use loads instead.
  94. """
  95. warn("The readPlistFromBytes function is deprecated, use loads() instead",
  96. DeprecationWarning, 2)
  97. return load(BytesIO(data), fmt=None, use_builtin_types=False)
  98. def writePlistToBytes(value):
  99. """
  100. Return 'value' as a plist-formatted bytes object.
  101. This function is deprecated, use dumps instead.
  102. """
  103. warn("The writePlistToBytes function is deprecated, use dumps() instead",
  104. DeprecationWarning, 2)
  105. f = BytesIO()
  106. dump(value, f, fmt=FMT_XML, sort_keys=True, skipkeys=False)
  107. return f.getvalue()
  108. class Data:
  109. """
  110. Wrapper for binary data.
  111. This class is deprecated, use a bytes object instead.
  112. """
  113. def __init__(self, data):
  114. if not isinstance(data, bytes):
  115. raise TypeError("data must be as bytes")
  116. self.data = data
  117. @classmethod
  118. def fromBase64(cls, data):
  119. # base64.decodebytes just calls binascii.a2b_base64;
  120. # it seems overkill to use both base64 and binascii.
  121. return cls(_decode_base64(data))
  122. def asBase64(self, maxlinelength=76):
  123. return _encode_base64(self.data, maxlinelength)
  124. def __eq__(self, other):
  125. if isinstance(other, self.__class__):
  126. return self.data == other.data
  127. elif isinstance(other, bytes):
  128. return self.data == other
  129. else:
  130. return NotImplemented
  131. def __repr__(self):
  132. return "%s(%s)" % (self.__class__.__name__, repr(self.data))
  133. #
  134. #
  135. # End of deprecated functionality
  136. #
  137. #
  138. #
  139. # XML support
  140. #
  141. # XML 'header'
  142. PLISTHEADER = b"""\
  143. <?xml version="1.0" encoding="UTF-8"?>
  144. <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  145. """
  146. # Regex to find any control chars, except for \t \n and \r
  147. _controlCharPat = re.compile(
  148. r"[\x00\x01\x02\x03\x04\x05\x06\x07\x08\x0b\x0c\x0e\x0f"
  149. r"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f]")
  150. def _encode_base64(s, maxlinelength=76):
  151. # copied from base64.encodebytes(), with added maxlinelength argument
  152. maxbinsize = (maxlinelength//4)*3
  153. pieces = []
  154. for i in range(0, len(s), maxbinsize):
  155. chunk = s[i : i + maxbinsize]
  156. pieces.append(binascii.b2a_base64(chunk))
  157. return b''.join(pieces)
  158. def _decode_base64(s):
  159. if isinstance(s, str):
  160. return binascii.a2b_base64(s.encode("utf-8"))
  161. else:
  162. return binascii.a2b_base64(s)
  163. # Contents should conform to a subset of ISO 8601
  164. # (in particular, YYYY '-' MM '-' DD 'T' HH ':' MM ':' SS 'Z'. Smaller units
  165. # may be omitted with # a loss of precision)
  166. _dateParser = re.compile(r"(?P<year>\d\d\d\d)(?:-(?P<month>\d\d)(?:-(?P<day>\d\d)(?:T(?P<hour>\d\d)(?::(?P<minute>\d\d)(?::(?P<second>\d\d))?)?)?)?)?Z", re.ASCII)
  167. def _date_from_string(s):
  168. order = ('year', 'month', 'day', 'hour', 'minute', 'second')
  169. gd = _dateParser.match(s).groupdict()
  170. lst = []
  171. for key in order:
  172. val = gd[key]
  173. if val is None:
  174. break
  175. lst.append(int(val))
  176. return datetime.datetime(*lst)
  177. def _date_to_string(d):
  178. return '%04d-%02d-%02dT%02d:%02d:%02dZ' % (
  179. d.year, d.month, d.day,
  180. d.hour, d.minute, d.second
  181. )
  182. def _escape(text):
  183. m = _controlCharPat.search(text)
  184. if m is not None:
  185. raise ValueError("strings can't contains control characters; "
  186. "use bytes instead")
  187. text = text.replace("\r\n", "\n") # convert DOS line endings
  188. text = text.replace("\r", "\n") # convert Mac line endings
  189. text = text.replace("&", "&amp;") # escape '&'
  190. text = text.replace("<", "&lt;") # escape '<'
  191. text = text.replace(">", "&gt;") # escape '>'
  192. return text
  193. class _PlistParser:
  194. def __init__(self, use_builtin_types, dict_type):
  195. self.stack = []
  196. self.current_key = None
  197. self.root = None
  198. self._use_builtin_types = use_builtin_types
  199. self._dict_type = dict_type
  200. def parse(self, fileobj):
  201. self.parser = ParserCreate()
  202. self.parser.StartElementHandler = self.handle_begin_element
  203. self.parser.EndElementHandler = self.handle_end_element
  204. self.parser.CharacterDataHandler = self.handle_data
  205. self.parser.EntityDeclHandler = self.handle_entity_decl
  206. self.parser.ParseFile(fileobj)
  207. return self.root
  208. def handle_entity_decl(self, entity_name, is_parameter_entity, value, base, system_id, public_id, notation_name):
  209. # Reject plist files with entity declarations to avoid XML vulnerabilies in expat.
  210. # Regular plist files don't contain those declerations, and Apple's plutil tool does not
  211. # accept them either.
  212. raise InvalidFileException("XML entity declarations are not supported in plist files")
  213. def handle_begin_element(self, element, attrs):
  214. self.data = []
  215. handler = getattr(self, "begin_" + element, None)
  216. if handler is not None:
  217. handler(attrs)
  218. def handle_end_element(self, element):
  219. handler = getattr(self, "end_" + element, None)
  220. if handler is not None:
  221. handler()
  222. def handle_data(self, data):
  223. self.data.append(data)
  224. def add_object(self, value):
  225. if self.current_key is not None:
  226. if not isinstance(self.stack[-1], type({})):
  227. raise ValueError("unexpected element at line %d" %
  228. self.parser.CurrentLineNumber)
  229. self.stack[-1][self.current_key] = value
  230. self.current_key = None
  231. elif not self.stack:
  232. # this is the root object
  233. self.root = value
  234. else:
  235. if not isinstance(self.stack[-1], type([])):
  236. raise ValueError("unexpected element at line %d" %
  237. self.parser.CurrentLineNumber)
  238. self.stack[-1].append(value)
  239. def get_data(self):
  240. data = ''.join(self.data)
  241. self.data = []
  242. return data
  243. # element handlers
  244. def begin_dict(self, attrs):
  245. d = self._dict_type()
  246. self.add_object(d)
  247. self.stack.append(d)
  248. def end_dict(self):
  249. if self.current_key:
  250. raise ValueError("missing value for key '%s' at line %d" %
  251. (self.current_key,self.parser.CurrentLineNumber))
  252. self.stack.pop()
  253. def end_key(self):
  254. if self.current_key or not isinstance(self.stack[-1], type({})):
  255. raise ValueError("unexpected key at line %d" %
  256. self.parser.CurrentLineNumber)
  257. self.current_key = self.get_data()
  258. def begin_array(self, attrs):
  259. a = []
  260. self.add_object(a)
  261. self.stack.append(a)
  262. def end_array(self):
  263. self.stack.pop()
  264. def end_true(self):
  265. self.add_object(True)
  266. def end_false(self):
  267. self.add_object(False)
  268. def end_integer(self):
  269. self.add_object(int(self.get_data()))
  270. def end_real(self):
  271. self.add_object(float(self.get_data()))
  272. def end_string(self):
  273. self.add_object(self.get_data())
  274. def end_data(self):
  275. if self._use_builtin_types:
  276. self.add_object(_decode_base64(self.get_data()))
  277. else:
  278. self.add_object(Data.fromBase64(self.get_data()))
  279. def end_date(self):
  280. self.add_object(_date_from_string(self.get_data()))
  281. class _DumbXMLWriter:
  282. def __init__(self, file, indent_level=0, indent="\t"):
  283. self.file = file
  284. self.stack = []
  285. self._indent_level = indent_level
  286. self.indent = indent
  287. def begin_element(self, element):
  288. self.stack.append(element)
  289. self.writeln("<%s>" % element)
  290. self._indent_level += 1
  291. def end_element(self, element):
  292. assert self._indent_level > 0
  293. assert self.stack.pop() == element
  294. self._indent_level -= 1
  295. self.writeln("</%s>" % element)
  296. def simple_element(self, element, value=None):
  297. if value is not None:
  298. value = _escape(value)
  299. self.writeln("<%s>%s</%s>" % (element, value, element))
  300. else:
  301. self.writeln("<%s/>" % element)
  302. def writeln(self, line):
  303. if line:
  304. # plist has fixed encoding of utf-8
  305. # XXX: is this test needed?
  306. if isinstance(line, str):
  307. line = line.encode('utf-8')
  308. self.file.write(self._indent_level * self.indent)
  309. self.file.write(line)
  310. self.file.write(b'\n')
  311. class _PlistWriter(_DumbXMLWriter):
  312. def __init__(
  313. self, file, indent_level=0, indent=b"\t", writeHeader=1,
  314. sort_keys=True, skipkeys=False):
  315. if writeHeader:
  316. file.write(PLISTHEADER)
  317. _DumbXMLWriter.__init__(self, file, indent_level, indent)
  318. self._sort_keys = sort_keys
  319. self._skipkeys = skipkeys
  320. def write(self, value):
  321. self.writeln("<plist version=\"1.0\">")
  322. self.write_value(value)
  323. self.writeln("</plist>")
  324. def write_value(self, value):
  325. if isinstance(value, str):
  326. self.simple_element("string", value)
  327. elif value is True:
  328. self.simple_element("true")
  329. elif value is False:
  330. self.simple_element("false")
  331. elif isinstance(value, int):
  332. if -1 << 63 <= value < 1 << 64:
  333. self.simple_element("integer", "%d" % value)
  334. else:
  335. raise OverflowError(value)
  336. elif isinstance(value, float):
  337. self.simple_element("real", repr(value))
  338. elif isinstance(value, dict):
  339. self.write_dict(value)
  340. elif isinstance(value, Data):
  341. self.write_data(value)
  342. elif isinstance(value, (bytes, bytearray)):
  343. self.write_bytes(value)
  344. elif isinstance(value, datetime.datetime):
  345. self.simple_element("date", _date_to_string(value))
  346. elif isinstance(value, (tuple, list)):
  347. self.write_array(value)
  348. else:
  349. raise TypeError("unsupported type: %s" % type(value))
  350. def write_data(self, data):
  351. self.write_bytes(data.data)
  352. def write_bytes(self, data):
  353. self.begin_element("data")
  354. self._indent_level -= 1
  355. maxlinelength = max(
  356. 16,
  357. 76 - len(self.indent.replace(b"\t", b" " * 8) * self._indent_level))
  358. for line in _encode_base64(data, maxlinelength).split(b"\n"):
  359. if line:
  360. self.writeln(line)
  361. self._indent_level += 1
  362. self.end_element("data")
  363. def write_dict(self, d):
  364. if d:
  365. self.begin_element("dict")
  366. if self._sort_keys:
  367. items = sorted(d.items())
  368. else:
  369. items = d.items()
  370. for key, value in items:
  371. if not isinstance(key, str):
  372. if self._skipkeys:
  373. continue
  374. raise TypeError("keys must be strings")
  375. self.simple_element("key", key)
  376. self.write_value(value)
  377. self.end_element("dict")
  378. else:
  379. self.simple_element("dict")
  380. def write_array(self, array):
  381. if array:
  382. self.begin_element("array")
  383. for value in array:
  384. self.write_value(value)
  385. self.end_element("array")
  386. else:
  387. self.simple_element("array")
  388. def _is_fmt_xml(header):
  389. prefixes = (b'<?xml', b'<plist')
  390. for pfx in prefixes:
  391. if header.startswith(pfx):
  392. return True
  393. # Also check for alternative XML encodings, this is slightly
  394. # overkill because the Apple tools (and plistlib) will not
  395. # generate files with these encodings.
  396. for bom, encoding in (
  397. (codecs.BOM_UTF8, "utf-8"),
  398. (codecs.BOM_UTF16_BE, "utf-16-be"),
  399. (codecs.BOM_UTF16_LE, "utf-16-le"),
  400. # expat does not support utf-32
  401. #(codecs.BOM_UTF32_BE, "utf-32-be"),
  402. #(codecs.BOM_UTF32_LE, "utf-32-le"),
  403. ):
  404. if not header.startswith(bom):
  405. continue
  406. for start in prefixes:
  407. prefix = bom + start.decode('ascii').encode(encoding)
  408. if header[:len(prefix)] == prefix:
  409. return True
  410. return False
  411. #
  412. # Binary Plist
  413. #
  414. class InvalidFileException (ValueError):
  415. def __init__(self, message="Invalid file"):
  416. ValueError.__init__(self, message)
  417. _BINARY_FORMAT = {1: 'B', 2: 'H', 4: 'L', 8: 'Q'}
  418. _undefined = object()
  419. class _BinaryPlistParser:
  420. """
  421. Read or write a binary plist file, following the description of the binary
  422. format. Raise InvalidFileException in case of error, otherwise return the
  423. root object.
  424. see also: http://opensource.apple.com/source/CF/CF-744.18/CFBinaryPList.c
  425. """
  426. def __init__(self, use_builtin_types, dict_type):
  427. self._use_builtin_types = use_builtin_types
  428. self._dict_type = dict_type
  429. def parse(self, fp):
  430. try:
  431. # The basic file format:
  432. # HEADER
  433. # object...
  434. # refid->offset...
  435. # TRAILER
  436. self._fp = fp
  437. self._fp.seek(-32, os.SEEK_END)
  438. trailer = self._fp.read(32)
  439. if len(trailer) != 32:
  440. raise InvalidFileException()
  441. (
  442. offset_size, self._ref_size, num_objects, top_object,
  443. offset_table_offset
  444. ) = struct.unpack('>6xBBQQQ', trailer)
  445. self._fp.seek(offset_table_offset)
  446. self._object_offsets = self._read_ints(num_objects, offset_size)
  447. self._objects = [_undefined] * num_objects
  448. return self._read_object(top_object)
  449. except (OSError, IndexError, struct.error, OverflowError,
  450. ValueError):
  451. raise InvalidFileException()
  452. def _get_size(self, tokenL):
  453. """ return the size of the next object."""
  454. if tokenL == 0xF:
  455. m = self._fp.read(1)[0] & 0x3
  456. s = 1 << m
  457. f = '>' + _BINARY_FORMAT[s]
  458. return struct.unpack(f, self._fp.read(s))[0]
  459. return tokenL
  460. def _read_ints(self, n, size):
  461. data = self._fp.read(size * n)
  462. if size in _BINARY_FORMAT:
  463. return struct.unpack(f'>{n}{_BINARY_FORMAT[size]}', data)
  464. else:
  465. if not size or len(data) != size * n:
  466. raise InvalidFileException()
  467. return tuple(int.from_bytes(data[i: i + size], 'big')
  468. for i in range(0, size * n, size))
  469. def _read_refs(self, n):
  470. return self._read_ints(n, self._ref_size)
  471. def _read_object(self, ref):
  472. """
  473. read the object by reference.
  474. May recursively read sub-objects (content of an array/dict/set)
  475. """
  476. result = self._objects[ref]
  477. if result is not _undefined:
  478. return result
  479. offset = self._object_offsets[ref]
  480. self._fp.seek(offset)
  481. token = self._fp.read(1)[0]
  482. tokenH, tokenL = token & 0xF0, token & 0x0F
  483. if token == 0x00:
  484. result = None
  485. elif token == 0x08:
  486. result = False
  487. elif token == 0x09:
  488. result = True
  489. # The referenced source code also mentions URL (0x0c, 0x0d) and
  490. # UUID (0x0e), but neither can be generated using the Cocoa libraries.
  491. elif token == 0x0f:
  492. result = b''
  493. elif tokenH == 0x10: # int
  494. result = int.from_bytes(self._fp.read(1 << tokenL),
  495. 'big', signed=tokenL >= 3)
  496. elif token == 0x22: # real
  497. result = struct.unpack('>f', self._fp.read(4))[0]
  498. elif token == 0x23: # real
  499. result = struct.unpack('>d', self._fp.read(8))[0]
  500. elif token == 0x33: # date
  501. f = struct.unpack('>d', self._fp.read(8))[0]
  502. # timestamp 0 of binary plists corresponds to 1/1/2001
  503. # (year of Mac OS X 10.0), instead of 1/1/1970.
  504. result = (datetime.datetime(2001, 1, 1) +
  505. datetime.timedelta(seconds=f))
  506. elif tokenH == 0x40: # data
  507. s = self._get_size(tokenL)
  508. result = self._fp.read(s)
  509. if len(result) != s:
  510. raise InvalidFileException()
  511. if not self._use_builtin_types:
  512. result = Data(result)
  513. elif tokenH == 0x50: # ascii string
  514. s = self._get_size(tokenL)
  515. data = self._fp.read(s)
  516. if len(data) != s:
  517. raise InvalidFileException()
  518. result = data.decode('ascii')
  519. elif tokenH == 0x60: # unicode string
  520. s = self._get_size(tokenL) * 2
  521. data = self._fp.read(s)
  522. if len(data) != s:
  523. raise InvalidFileException()
  524. result = data.decode('utf-16be')
  525. # tokenH == 0x80 is documented as 'UID' and appears to be used for
  526. # keyed-archiving, not in plists.
  527. elif tokenH == 0xA0: # array
  528. s = self._get_size(tokenL)
  529. obj_refs = self._read_refs(s)
  530. result = []
  531. self._objects[ref] = result
  532. result.extend(self._read_object(x) for x in obj_refs)
  533. # tokenH == 0xB0 is documented as 'ordset', but is not actually
  534. # implemented in the Apple reference code.
  535. # tokenH == 0xC0 is documented as 'set', but sets cannot be used in
  536. # plists.
  537. elif tokenH == 0xD0: # dict
  538. s = self._get_size(tokenL)
  539. key_refs = self._read_refs(s)
  540. obj_refs = self._read_refs(s)
  541. result = self._dict_type()
  542. self._objects[ref] = result
  543. try:
  544. for k, o in zip(key_refs, obj_refs):
  545. result[self._read_object(k)] = self._read_object(o)
  546. except TypeError:
  547. raise InvalidFileException()
  548. else:
  549. raise InvalidFileException()
  550. self._objects[ref] = result
  551. return result
  552. def _count_to_size(count):
  553. if count < 1 << 8:
  554. return 1
  555. elif count < 1 << 16:
  556. return 2
  557. elif count << 1 << 32:
  558. return 4
  559. else:
  560. return 8
  561. _scalars = (str, int, float, datetime.datetime, bytes)
  562. class _BinaryPlistWriter (object):
  563. def __init__(self, fp, sort_keys, skipkeys):
  564. self._fp = fp
  565. self._sort_keys = sort_keys
  566. self._skipkeys = skipkeys
  567. def write(self, value):
  568. # Flattened object list:
  569. self._objlist = []
  570. # Mappings from object->objectid
  571. # First dict has (type(object), object) as the key,
  572. # second dict is used when object is not hashable and
  573. # has id(object) as the key.
  574. self._objtable = {}
  575. self._objidtable = {}
  576. # Create list of all objects in the plist
  577. self._flatten(value)
  578. # Size of object references in serialized containers
  579. # depends on the number of objects in the plist.
  580. num_objects = len(self._objlist)
  581. self._object_offsets = [0]*num_objects
  582. self._ref_size = _count_to_size(num_objects)
  583. self._ref_format = _BINARY_FORMAT[self._ref_size]
  584. # Write file header
  585. self._fp.write(b'bplist00')
  586. # Write object list
  587. for obj in self._objlist:
  588. self._write_object(obj)
  589. # Write refnum->object offset table
  590. top_object = self._getrefnum(value)
  591. offset_table_offset = self._fp.tell()
  592. offset_size = _count_to_size(offset_table_offset)
  593. offset_format = '>' + _BINARY_FORMAT[offset_size] * num_objects
  594. self._fp.write(struct.pack(offset_format, *self._object_offsets))
  595. # Write trailer
  596. sort_version = 0
  597. trailer = (
  598. sort_version, offset_size, self._ref_size, num_objects,
  599. top_object, offset_table_offset
  600. )
  601. self._fp.write(struct.pack('>5xBBBQQQ', *trailer))
  602. def _flatten(self, value):
  603. # First check if the object is in the object table, not used for
  604. # containers to ensure that two subcontainers with the same contents
  605. # will be serialized as distinct values.
  606. if isinstance(value, _scalars):
  607. if (type(value), value) in self._objtable:
  608. return
  609. elif isinstance(value, Data):
  610. if (type(value.data), value.data) in self._objtable:
  611. return
  612. elif id(value) in self._objidtable:
  613. return
  614. # Add to objectreference map
  615. refnum = len(self._objlist)
  616. self._objlist.append(value)
  617. if isinstance(value, _scalars):
  618. self._objtable[(type(value), value)] = refnum
  619. elif isinstance(value, Data):
  620. self._objtable[(type(value.data), value.data)] = refnum
  621. else:
  622. self._objidtable[id(value)] = refnum
  623. # And finally recurse into containers
  624. if isinstance(value, dict):
  625. keys = []
  626. values = []
  627. items = value.items()
  628. if self._sort_keys:
  629. items = sorted(items)
  630. for k, v in items:
  631. if not isinstance(k, str):
  632. if self._skipkeys:
  633. continue
  634. raise TypeError("keys must be strings")
  635. keys.append(k)
  636. values.append(v)
  637. for o in itertools.chain(keys, values):
  638. self._flatten(o)
  639. elif isinstance(value, (list, tuple)):
  640. for o in value:
  641. self._flatten(o)
  642. def _getrefnum(self, value):
  643. if isinstance(value, _scalars):
  644. return self._objtable[(type(value), value)]
  645. elif isinstance(value, Data):
  646. return self._objtable[(type(value.data), value.data)]
  647. else:
  648. return self._objidtable[id(value)]
  649. def _write_size(self, token, size):
  650. if size < 15:
  651. self._fp.write(struct.pack('>B', token | size))
  652. elif size < 1 << 8:
  653. self._fp.write(struct.pack('>BBB', token | 0xF, 0x10, size))
  654. elif size < 1 << 16:
  655. self._fp.write(struct.pack('>BBH', token | 0xF, 0x11, size))
  656. elif size < 1 << 32:
  657. self._fp.write(struct.pack('>BBL', token | 0xF, 0x12, size))
  658. else:
  659. self._fp.write(struct.pack('>BBQ', token | 0xF, 0x13, size))
  660. def _write_object(self, value):
  661. ref = self._getrefnum(value)
  662. self._object_offsets[ref] = self._fp.tell()
  663. if value is None:
  664. self._fp.write(b'\x00')
  665. elif value is False:
  666. self._fp.write(b'\x08')
  667. elif value is True:
  668. self._fp.write(b'\x09')
  669. elif isinstance(value, int):
  670. if value < 0:
  671. try:
  672. self._fp.write(struct.pack('>Bq', 0x13, value))
  673. except struct.error:
  674. raise OverflowError(value) from None
  675. elif value < 1 << 8:
  676. self._fp.write(struct.pack('>BB', 0x10, value))
  677. elif value < 1 << 16:
  678. self._fp.write(struct.pack('>BH', 0x11, value))
  679. elif value < 1 << 32:
  680. self._fp.write(struct.pack('>BL', 0x12, value))
  681. elif value < 1 << 63:
  682. self._fp.write(struct.pack('>BQ', 0x13, value))
  683. elif value < 1 << 64:
  684. self._fp.write(b'\x14' + value.to_bytes(16, 'big', signed=True))
  685. else:
  686. raise OverflowError(value)
  687. elif isinstance(value, float):
  688. self._fp.write(struct.pack('>Bd', 0x23, value))
  689. elif isinstance(value, datetime.datetime):
  690. f = (value - datetime.datetime(2001, 1, 1)).total_seconds()
  691. self._fp.write(struct.pack('>Bd', 0x33, f))
  692. elif isinstance(value, Data):
  693. self._write_size(0x40, len(value.data))
  694. self._fp.write(value.data)
  695. elif isinstance(value, (bytes, bytearray)):
  696. self._write_size(0x40, len(value))
  697. self._fp.write(value)
  698. elif isinstance(value, str):
  699. try:
  700. t = value.encode('ascii')
  701. self._write_size(0x50, len(value))
  702. except UnicodeEncodeError:
  703. t = value.encode('utf-16be')
  704. self._write_size(0x60, len(t) // 2)
  705. self._fp.write(t)
  706. elif isinstance(value, (list, tuple)):
  707. refs = [self._getrefnum(o) for o in value]
  708. s = len(refs)
  709. self._write_size(0xA0, s)
  710. self._fp.write(struct.pack('>' + self._ref_format * s, *refs))
  711. elif isinstance(value, dict):
  712. keyRefs, valRefs = [], []
  713. if self._sort_keys:
  714. rootItems = sorted(value.items())
  715. else:
  716. rootItems = value.items()
  717. for k, v in rootItems:
  718. if not isinstance(k, str):
  719. if self._skipkeys:
  720. continue
  721. raise TypeError("keys must be strings")
  722. keyRefs.append(self._getrefnum(k))
  723. valRefs.append(self._getrefnum(v))
  724. s = len(keyRefs)
  725. self._write_size(0xD0, s)
  726. self._fp.write(struct.pack('>' + self._ref_format * s, *keyRefs))
  727. self._fp.write(struct.pack('>' + self._ref_format * s, *valRefs))
  728. else:
  729. raise TypeError(value)
  730. def _is_fmt_binary(header):
  731. return header[:8] == b'bplist00'
  732. #
  733. # Generic bits
  734. #
  735. _FORMATS={
  736. FMT_XML: dict(
  737. detect=_is_fmt_xml,
  738. parser=_PlistParser,
  739. writer=_PlistWriter,
  740. ),
  741. FMT_BINARY: dict(
  742. detect=_is_fmt_binary,
  743. parser=_BinaryPlistParser,
  744. writer=_BinaryPlistWriter,
  745. )
  746. }
  747. def load(fp, *, fmt=None, use_builtin_types=True, dict_type=dict):
  748. """Read a .plist file. 'fp' should be a readable and binary file object.
  749. Return the unpacked root object (which usually is a dictionary).
  750. """
  751. if fmt is None:
  752. header = fp.read(32)
  753. fp.seek(0)
  754. for info in _FORMATS.values():
  755. if info['detect'](header):
  756. P = info['parser']
  757. break
  758. else:
  759. raise InvalidFileException()
  760. else:
  761. P = _FORMATS[fmt]['parser']
  762. p = P(use_builtin_types=use_builtin_types, dict_type=dict_type)
  763. return p.parse(fp)
  764. def loads(value, *, fmt=None, use_builtin_types=True, dict_type=dict):
  765. """Read a .plist file from a bytes object.
  766. Return the unpacked root object (which usually is a dictionary).
  767. """
  768. fp = BytesIO(value)
  769. return load(
  770. fp, fmt=fmt, use_builtin_types=use_builtin_types, dict_type=dict_type)
  771. def dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False):
  772. """Write 'value' to a .plist file. 'fp' should be a writable,
  773. binary file object.
  774. """
  775. if fmt not in _FORMATS:
  776. raise ValueError("Unsupported format: %r"%(fmt,))
  777. writer = _FORMATS[fmt]["writer"](fp, sort_keys=sort_keys, skipkeys=skipkeys)
  778. writer.write(value)
  779. def dumps(value, *, fmt=FMT_XML, skipkeys=False, sort_keys=True):
  780. """Return a bytes object with the contents for a .plist file.
  781. """
  782. fp = BytesIO()
  783. dump(value, fp, fmt=fmt, skipkeys=skipkeys, sort_keys=sort_keys)
  784. return fp.getvalue()