annotate sat_frontends/jp/xml_tools.py @ 3513:753d151da886

XEP-0277: new preview/mbPreview method: This method does more or less the same thing as sending, but without actually sending the item, and parse the generated element just after. This way, the triggers are run, and a preview of the item can be made for the resulting microblog data.
author Goffi <goffi@goffi.org>
date Thu, 29 Apr 2021 15:49:59 +0200
parents be6d91572633
children 524856bd7b19
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
1 #!/usr/bin/env python3
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # jp: a SàT command line tool
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from sat.core.i18n import _
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from sat_frontends.jp.constants import Const as C
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
22
2804
710de41da2f2 jp (pubsub/node): new "import" command, to publish many nodes from an XML file
Goffi <goffi@goffi.org>
parents: 2777
diff changeset
23 def etreeParse(cmd, raw_xml, reraise=False):
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 """Import lxml and parse raw XML
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 @param cmd(CommandBase): current command instance
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 @param raw_xml(file, str): an XML bytestring, string or file-like object
2804
710de41da2f2 jp (pubsub/node): new "import" command, to publish many nodes from an XML file
Goffi <goffi@goffi.org>
parents: 2777
diff changeset
28 @param reraise(bool): if True, re raise exception on parse error instead of doing a
710de41da2f2 jp (pubsub/node): new "import" command, to publish many nodes from an XML file
Goffi <goffi@goffi.org>
parents: 2777
diff changeset
29 parser.error (which terminate the execution)
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 @return (tuple(etree.Element, module): parsed element, etree module
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 """
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 try:
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
33 from lxml import etree
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 except ImportError:
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 cmd.disp(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2804
diff changeset
36 'lxml module must be installed, please install it with "pip install lxml"',
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 error=True,
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 )
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 cmd.host.quit(C.EXIT_ERROR)
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 try:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2804
diff changeset
41 if isinstance(raw_xml, str):
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 parser = etree.XMLParser(remove_blank_text=True)
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 element = etree.fromstring(raw_xml, parser)
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 else:
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 element = etree.parse(raw_xml).getroot()
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 except Exception as e:
2804
710de41da2f2 jp (pubsub/node): new "import" command, to publish many nodes from an XML file
Goffi <goffi@goffi.org>
parents: 2777
diff changeset
47 if reraise:
710de41da2f2 jp (pubsub/node): new "import" command, to publish many nodes from an XML file
Goffi <goffi@goffi.org>
parents: 2777
diff changeset
48 raise e
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 cmd.parser.error(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2804
diff changeset
50 _("Can't parse the payload XML in input: {msg}").format(msg=e)
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
51 )
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
52 return element, etree
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
53
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
54 def getPayload(cmd, element):
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
55 """Retrieve payload element and exit with and error if not found
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
56
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
57 @param element(etree.Element): root element
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 @return element(etree.Element): payload element
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
59 """
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
60 if element.tag in ("item", "{http://jabber.org/protocol/pubsub}item"):
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
61 if len(element) > 1:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2804
diff changeset
62 cmd.disp(_("<item> can only have one child element (the payload)"),
2777
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
63 error=True)
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
64 cmd.host.quit(C.EXIT_DATA_ERROR)
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
65 element = element[0]
ff1b40823b07 jp (pubsub): new "transform" command:
Goffi <goffi@goffi.org>
parents:
diff changeset
66 return element