X-Git-Url: https://git.phdru.name/?p=extfs.d.git;a=blobdiff_plain;f=xml;h=fe3b5b584a3c51fe3402a71ab96c9f029cf260cb;hp=e8049dd146e85617042f90f364c0e2ca413bc73d;hb=HEAD;hpb=51d5bf6af357c9e0665db44375373ce8990caa6d diff --git a/xml b/xml index e8049dd..fe3b5b5 100755 --- a/xml +++ b/xml @@ -1,4 +1,4 @@ -#! /usr/bin/env python +#! /usr/bin/env python3 """XML Virtual FileSystem for Midnight Commander The script requires Midnight Commander 3.1+ @@ -14,18 +14,22 @@ file the command is "%cd"): cd file/xml://; in older versions it is cd file#xml, where "file" is the name of your XML file. See detailed installation instructions at -http://phdru.name/Software/mc/INSTALL.html. +https://phdru.name/Software/mc/xml_INSTALL.html. The VFS represents tags as directories; the directories are numbered to distinguish tags with the same name; numbering also helps to sort tags by their -order in XML instead of sorting them by name. Attributes, text nodes and -comments are represented as text files; attributes are shown in a file named -"attributes", attributes are listed in the file as name=value lines (I -deliberately ignore a small chance of newline characters in values); names and -values are reencoded to the console encoding. Text nodes and comments are -collected in a file named "text", stripped and reencoded. The filesystem is +order in XML instead of sorting them by name and prevents name clash when tag +names coincide with the names of special files used by XML VFS. Attributes, +text nodes and comments are represented as text files; attributes are shown in +a file named "attributes", attributes are listed in the file as name=value +lines (I deliberately ignore a small chance of newline characters in values); +names and values are reencoded to the console encoding. Text nodes and comments +are collected in a file named "text", stripped and reencoded. The filesystem is read-only. +Date/time for all directories/files set to the last modification time of the +XML file. + Implementation based on minidom doesn't understand namespaces, it just shows them among other attributes. ElementTree-based implementation doesn't show namespaces at all. Implementation based on lxml.etree shows namespaces in a @@ -39,30 +43,26 @@ its text file to a real file. The VFS was inspired by a FUSE xmlfs: https://github.com/halhen/xmlfs """ +from __future__ import print_function -__version__ = "1.1.0" +__version__ = "1.2.1" __author__ = "Oleg Broytman " -__copyright__ = "Copyright (C) 2013 PhiloSoft Design" +__copyright__ = "Copyright (C) 2013-2023 PhiloSoft Design" __license__ = "GPL" -force_implementation = None # Can be None for default choice, - # 'lxml', 'elementtree' or 'minidom' +# Can be None for default choice, 'lxml', 'elementtree' or 'minidom'. +force_implementation = None use_minidom = True use_elementtree = False use_lxml = False import math +from os.path import getmtime import sys +from time import localtime import xml.dom.minidom -try: - import xml.etree.ElementTree as ET -except ImportError: - pass -else: - use_elementtree = True - try: import lxml.etree as etree except ImportError: @@ -71,29 +71,32 @@ else: use_lxml = True try: - import locale - use_locale = True + import locale + use_locale = True except ImportError: - use_locale = False + use_locale = False if use_locale: - # Get the default charset. - try: - lcAll = locale.getdefaultlocale() - except locale.Error, err: - print >>sys.stderr, "WARNING:", err - lcAll = [] - - if len(lcAll) == 2: - default_encoding = lcAll[1] - else: - try: - default_encoding = locale.getpreferredencoding() - except locale.Error, err: - print >>sys.stderr, "WARNING:", err - default_encoding = sys.getdefaultencoding() + # Get the default charset. + try: + if sys.version_info[:2] < (3, 11): + lcAll = locale.getdefaultlocale() + else: + lcAll = [] + except locale.Error as err: + print("WARNING:", err, file=sys.stderr) + lcAll = [] + + if len(lcAll) == 2: + default_encoding = lcAll[1] + else: + try: + default_encoding = locale.getpreferredencoding() + except locale.Error as err: + print("WARNING:", err, file=sys.stderr) + default_encoding = sys.getdefaultencoding() else: - default_encoding = sys.getdefaultencoding() + default_encoding = sys.getdefaultencoding() import logging logger = logging.getLogger('xml-mcextfs') @@ -109,13 +112,27 @@ Author: %s This is not a program. Put the script in $HOME/[.local/share/].mc/extfs.d or /usr/[local/][lib|share]/mc/extfs. For more information read the source!""", - __version__, __author__, __copyright__ -) + __version__, __author__, __copyright__) sys.exit(1) locale.setlocale(locale.LC_ALL, '') +PY3 = (sys.version_info[0] >= 3) +if PY3: + def output(s): + sys.stdout.buffer.write(s.encode(default_encoding, 'replace') + b'\n') +else: + def output(s): + sys.stdout.write(s + '\n') + + try: + import xml.etree.ElementTree as ET + except ImportError: + pass + else: + use_elementtree = True + class XmlVfs(object): """Abstract base class""" @@ -123,12 +140,18 @@ class XmlVfs(object): supports_namespaces = False def __init__(self): + self.xml_file = sys.argv[2] self.parse() def list(self): + Y, m, d, H, M = localtime(getmtime(self.xml_file))[0:5] + self.xml_file_dt = "%02d-%02d-%d %02d:%02d" % (m, d, Y, H, M) + root_comments = self.get_root_comments() if root_comments: - print "-r--r--r-- 1 user group %d Jan 1 00:00 text" % (len(root_comments)) + output("-r--r--r-- 1 user group %d %s text" % ( + len(root_comments), self.xml_file_dt)) + self._list(self.getroot()) def _list(self, node, path=''): @@ -148,20 +171,20 @@ class XmlVfs(object): subpath = '%s/%s %s' % (path, template % n, tag) else: subpath = '%s %s' % (template % n, tag) - subpath_encoded = subpath.encode(default_encoding, "replace") - print "dr-xr-xr-x 1 user group 0 Jan 1 00:00 %s" % subpath_encoded + output("dr-xr-xr-x 1 user group 0 %s %s" % ( + self.xml_file_dt, subpath)) if self.getattrs(element): attr_text = self.attrs2text(element) - print "-r--r--r-- 1 user group %d Jan 1 00:00 %s/attributes" % ( - len(attr_text), subpath_encoded) + output("-r--r--r-- 1 user group %d %s %s/attributes" % ( + len(attr_text), self.xml_file_dt, subpath)) if self.supports_namespaces and self.has_ns(element): ns_text = self.ns2text(element) - print "-r--r--r-- 1 user group %d Jan 1 00:00 %s/namespaces" % ( - len(ns_text), subpath_encoded) + output("-r--r--r-- 1 user group %d %s %s/namespaces" % ( + len(ns_text), self.xml_file_dt, subpath)) text = self.collect_text(element) if text: - print "-r--r--r-- 1 user group %d Jan 1 00:00 %s/text" % ( - len(text), subpath_encoded) + output("-r--r--r-- 1 user group %d %s %s/text" % ( + len(text), self.xml_file_dt, subpath)) self._list(element, subpath) def get_tag_node(self, node, i): @@ -176,8 +199,7 @@ class XmlVfs(object): def attrs2text(self, node): attr_accumulator = [] for name, value in self.getattrs(node): - name = self.getlocalname(name).encode(default_encoding, "replace") - value = value.encode(default_encoding, "replace") + name = self.getlocalname(name) attr_accumulator.append("%s=%s" % (name, value)) return '\n'.join(attr_accumulator) @@ -187,7 +209,7 @@ class XmlVfs(object): class MiniDOMXmlVfs(XmlVfs): def parse(self): - self.document = xml.dom.minidom.parse(sys.argv[2]) + self.document = xml.dom.minidom.parse(self.xml_file) def getattrs(self, node): attrs = node.attributes @@ -205,8 +227,9 @@ class MiniDOMXmlVfs(XmlVfs): text = element.nodeValue.strip() else: xml_error("Unknown node type %d" % element.nodeType) - if text: text_accumulator.append(text) - return '\n'.join(text_accumulator).encode(default_encoding, "replace") + if text: + text_accumulator.append(text) + return '\n'.join(text_accumulator) def getroot(self): return self.document @@ -236,15 +259,17 @@ if use_elementtree or use_lxml: text_accumulator = [] if node.text: text = node.text.strip() - if text: text_accumulator.append(text) + if text: + text_accumulator.append(text) for element in node: if not self.istag(element): text = u"" % element.text text_accumulator.append(text) if node.tail: text = node.tail.strip() - if text: text_accumulator.append(text) - return '\n'.join(text_accumulator).encode(default_encoding, "replace") + if text: + text_accumulator.append(text) + return '\n'.join(text_accumulator) def getchildren(self, node): return list(node) @@ -259,7 +284,7 @@ if use_elementtree or use_lxml: if use_elementtree: class ElementTreeXmlVfs(CommonEtreeXmlVfs): def parse(self): - # Copied from http://effbot.org/zone/element-pi.ht + # Copied from http://effbot.org/zone/element-pi.htm class PIParser(ET.XMLTreeBuilder): @@ -284,7 +309,7 @@ if use_elementtree: self._target.data(target + " " + data) self._target.end(ET.PI) - self.document = ET.parse(sys.argv[2], PIParser()) + self.document = ET.parse(self.xml_file, PIParser()) def getroot(self): return self.document.getroot() @@ -295,7 +320,7 @@ if use_elementtree: if not self.istag(element): text = u"" % element.text text_accumulator.append(text) - return '\n'.join(text_accumulator).encode(default_encoding, "replace") + return '\n'.join(text_accumulator) def getlocalname(self, name): if name.startswith('{'): @@ -308,17 +333,18 @@ if use_lxml: supports_namespaces = True def parse(self): - self.document = etree.parse(sys.argv[2]) + self.document = etree.parse(self.xml_file) def getroot(self): return [self.document.getroot()] def get_root_comments(self): text_accumulator = [] - for element in self.document.getroot().itersiblings(tag=etree.Comment, preceding=True): + for element in self.document.getroot().itersiblings( + tag=etree.Comment, preceding=True): text = u"" % element.text text_accumulator.append(text) - return '\n'.join(text_accumulator).encode(default_encoding, "replace") + return '\n'.join(text_accumulator) def getlocalname(self, name): return etree.QName(name).localname @@ -327,9 +353,10 @@ if use_lxml: this_nsmap = node.nsmap parent = node.getparent() if parent is not None: - parents_nsmap = parent.nsmap - for key in parents_nsmap: - del this_nsmap[key] + parent_nsmap = parent.nsmap + for key in parent_nsmap: + if this_nsmap[key] == parent_nsmap[key]: + del this_nsmap[key] return this_nsmap def has_ns(self, node): @@ -338,9 +365,8 @@ if use_lxml: def ns2text(self, node): ns_accumulator = [] for name, value in self._get_local_ns(node).items(): - if name is None: name = '' - name = name.encode(default_encoding, "replace") - value = value.encode(default_encoding, "replace") + if not name: + name = 'xmlns' ns_accumulator.append("%s=%s" % (name, value)) return '\n'.join(ns_accumulator) @@ -360,7 +386,8 @@ def build_xmlvfs(): elif force_implementation == 'lxml': return LxmlEtreeXmlVfs() else: - raise ValueError('Unknown implementation "%s", expected "minidom", "elementtree" or "lxml"' % force_implementation) + raise ValueError('Unknown implementation "%s", expected "minidom", ' + '"elementtree" or "lxml"' % force_implementation) def mcxml_list(): @@ -417,15 +444,19 @@ def mcxml_copyin(): """Put a file to the VFS""" sys.exit("XML VFS doesn't support adding files (read-only filesystem)") + def mcxml_rm(): """Remove a file from the VFS""" - sys.exit("XML VFS doesn't support removing files/directories (read-only filesystem)") + sys.exit("XML VFS doesn't support removing files/directories " + "(read-only filesystem)") mcxml_rmdir = mcxml_rm + def mcxml_mkdir(): """Create a directory in the VFS""" - sys.exit("XML VFS doesn't support creating directories (read-only filesystem)") + sys.exit("XML VFS doesn't support creating directories " + "(read-only filesystem)") def xml_error(error_str): @@ -436,7 +467,7 @@ command = sys.argv[1] procname = "mcxml_" + command g = globals() -if not g.has_key(procname): +if procname not in g: logger.critical("Unknown command %s", command) sys.exit(1) @@ -444,5 +475,5 @@ try: g[procname]() except SystemExit: raise -except: +except Exception: logger.exception("Error during run")