xml

   1 #! /usr/bin/env python
   2 """XML Virtual FileSystem for Midnight Commander
   3
   4 The script requires Midnight Commander 3.1+
   5 (http://www.midnight-commander.org/), Python 2.4+ (http://www.python.org/).
   6
   7 For mc 4.7+ put the script in $HOME/.mc/extfs.d.
   8 For older versions put it in /usr/[local/][lib|share]/mc/extfs
   9 and add a line "xml" to the /usr/[local/][lib|share]/mc/extfs/extfs.ini.
  10 Make the script executable.
  11
  12 For mc 4.7+ run this "cd" command in the Midnight Commander (in the "bindings"
  13 file the command is "%cd"): cd file/xml://; In older versions it is
  14 cd file#xml, where "file" is the name of your XML file.
  15
  16 The VFS represents tags as directories; the directories are numbered to
  17 distinguish tags with the same name; also numbering helps to sort tags by their
  18 order in XML instead of sorting them by name. Attributes, text nodes and
  19 comments are represented as text files; attributes are shown in a file named
  20 "attributes", attributes are listed in the file as name=value lines (I
  21 deliberately ignore a small chance of newline characters in values); names and
  22 values are reencoded to the console encoding. Text nodes and comments are
  23 collected in a file named "text", stripped and reencoded. The filesystem is
  24 read-only.
  25
  26 It is useful to have a top-down view on an XML structure but it's especially
  27 convenient to extract text values from tags. One can get, for example, a
  28 base64-encoded image - just walk down the VFS to the tag's directory and copy
  29 its text file to a real file.
  30
  31 The VFS was inspired by a FUSE xmlfs: https://github.com/halhen/xmlfs
  32
  33 """
  34
  35 __version__ = "0.3.0"
  36 __author__ = "Oleg Broytman <phd@phdru.name>"
  37 __copyright__ = "Copyright (C) 2013 PhiloSoft Design"
  38 __license__ = "GPL"
  39
  40 import math
  41 import sys
  42 import xml.dom.minidom
  43
  44 try:
  45    import locale
  46    use_locale = True
  47 except ImportError:
  48    use_locale = False
  49
  50 if use_locale:
  51    # Get the default charset.
  52    try:
  53       lcAll = locale.getdefaultlocale()
  54    except locale.Error, err:
  55       print >>sys.stderr, "WARNING:", err
  56       lcAll = []
  57
  58    if len(lcAll) == 2:
  59       default_encoding = lcAll[1]
  60    else:
  61       try:
  62          default_encoding = locale.getpreferredencoding()
  63       except locale.Error, err:
  64          print >>sys.stderr, "WARNING:", err
  65          default_encoding = sys.getdefaultencoding()
  66 else:
  67    default_encoding = sys.getdefaultencoding()
  68
  69 import logging
  70 logger = logging.getLogger('xml-mcextfs')
  71 log_err_handler = logging.StreamHandler(sys.stderr)
  72 logger.addHandler(log_err_handler)
  73 logger.setLevel(logging.INFO)
  74
  75 if len(sys.argv) < 3:
  76     logger.critical("""\
  77 XML Virtual FileSystem for Midnight Commander version %s
  78 Author: %s
  79 %s
  80
  81 This is not a program. Put the script in $HOME/.mc/extfs.d or
  82 /usr/[local/][lib|share]/mc/extfs. For more information read the source!""",
  83    __version__, __author__, __copyright__
  84 )
  85     sys.exit(1)
  86
  87
  88 locale.setlocale(locale.LC_ALL, '')
  89
  90 def _attrs2text(attrs):
  91     attrs = [attrs.item(i) for i in range (attrs.length)]
  92     return '\n'.join(["%s=%s" %
  93         (a.name.encode(default_encoding, "replace"),
  94         a.value.encode(default_encoding, "replace"))
  95         for a in attrs])
  96
  97 def _collect_text(node):
  98     text_accumulator = []
  99     for element in node.childNodes:
 100         if element.localName:
 101             continue
 102         elif element.nodeType == element.COMMENT_NODE:
 103             text = u"<!--%s-->" % element.nodeValue
 104         elif element.nodeType == element.TEXT_NODE:
 105             text = element.nodeValue.strip()
 106         else:
 107             xml_error("Unknown node type %d" % element.nodeType)
 108         if text: text_accumulator.append(text)
 109     return '\n'.join(text_accumulator).encode(default_encoding, "replace")
 110
 111 def _list(node, path=''):
 112     childNodes = node.childNodes
 113     n = 0
 114     for element in childNodes:
 115         if element.localName:
 116             n += 1
 117     if n:
 118         width = int(math.log10(n))+1
 119         template = "%%0%dd" % width
 120     else:
 121         template = "%d"
 122     n = 0
 123     for element in childNodes:
 124         if element.localName:
 125             n += 1
 126             if path:
 127                 subpath = '%s/%s %s' % (path, template % n, element.localName)
 128             else:
 129                 subpath = '%s %s' % (template % n, element.localName)
 130             subpath_encoded = subpath.encode(default_encoding, "replace")
 131             print "dr--r--r-- 1 user group 0 Jan 1 00:00 %s" % subpath_encoded
 132             attrs = element.attributes
 133             if attrs:
 134                 attr_text = _attrs2text(attrs)
 135                 print "-r--r--r-- 1 user group %d Jan 1 00:00 %s/attributes" % (
 136                     len(attr_text), subpath_encoded)
 137             _list(element, subpath)
 138     if path:
 139         text = _collect_text(node)
 140         if text:
 141             print "-r--r--r-- 1 user group %d Jan 1 00:00 %s/text" % (
 142                 len(text), path.encode(default_encoding, "replace"))
 143
 144 def mcxml_list():
 145     """List the entire VFS"""
 146
 147     dom = xml.dom.minidom.parse(sys.argv[2])
 148     _list(dom)
 149
 150
 151 def _get_child_node(node, i):
 152     n = 0
 153     for element in node.childNodes:
 154         if element.localName:
 155             n += 1
 156             if n == i:
 157                 return element
 158     xml_error('There are less than %d nodes' % i)
 159
 160 def mcxml_copyout():
 161     """Extract a file from the VFS"""
 162
 163     node = xml.dom.minidom.parse(sys.argv[2])
 164     xml_filename = sys.argv[3]
 165     real_filename = sys.argv[4]
 166
 167     for path_comp in xml_filename.split('/'):
 168         if ' ' in path_comp:
 169             i = int(path_comp.split(' ', 1)[0])
 170             node = _get_child_node(node, i)
 171         elif path_comp in ('attributes', 'text'):
 172             break
 173         else:
 174             xml_error('Unknown file')
 175
 176     if path_comp == 'attributes':
 177         attrs = node.attributes
 178         if attrs:
 179             text = _attrs2text(attrs)
 180         else:
 181             xml_error('There are no attributes')
 182
 183     if path_comp == 'text':
 184         text = _collect_text(node)
 185
 186     outfile = open(real_filename, 'w')
 187     outfile.write(text)
 188     outfile.close()
 189
 190
 191 def mcxml_copyin():
 192     """Put a file to the VFS"""
 193     sys.exit("XML VFS doesn't support adding files (read-only filesystem)")
 194
 195 def mcxml_rm():
 196     """Remove a file from the VFS"""
 197     sys.exit("XML VFS doesn't support removing files/directories (read-only filesystem)")
 198
 199 mcxml_rmdir = mcxml_rm
 200
 201 def mcxml_mkdir():
 202     """Create a directory in the VFS"""
 203     sys.exit("XML VFS doesn't support creating directories (read-only filesystem)")
 204
 205
 206 def xml_error(error_str):
 207     logger.critical("Error walking XML file: %s", error_str)
 208     sys.exit(1)
 209
 210 command = sys.argv[1]
 211 procname = "mcxml_" + command
 212
 213 g = globals()
 214 if not g.has_key(procname):
 215     logger.critical("Unknown command %s", command)
 216     sys.exit(1)
 217
 218 try:
 219     g[procname]()
 220 except SystemExit:
 221     raise
 222 except:
 223     logger.exception("Error during run")