python/samba/ms_schema_markdown.py

   1 # Create schema.ldif from Github markdown
   2 #
   3 # Each LDF section in the markdown file then gets written to a corresponding
   4 # .LDF output file.
   5 #
   6 # Copyright (C) Andrew Bartlett 2017
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 """Generate LDIF from Github documentation."""
  22
  23 import re
  24 import os
  25 import markdown
  26 import xml.etree.ElementTree as ET
  27
  28
  29 def innertext(tag):
  30     return (tag.text or '') + \
  31             ''.join(innertext(e) for e in tag) + \
  32             (tag.tail or '')
  33
  34
  35 def read_ms_markdown(in_file, out_folder):
  36     """Read Github documentation-derived schema files."""
  37
  38     with open(in_file) as update_file:
  39         # Remove any comments from the raw LDF files
  40         html = markdown.markdown(re.sub(r'(?m)^# .*\n?', '', update_file.read()),
  41                                  output_format='xhtml')
  42
  43     tree = ET.fromstring('<root>' + html + '</root>')
  44
  45     ldf = None
  46     try:
  47         for node in tree:
  48             if node.tag == 'h3':
  49                 if ldf is not None:
  50                     ldf.close()
  51
  52                 out_path = os.path.join(out_folder, innertext(node).strip())
  53                 ldf = open(out_path, 'w')
  54             elif node.tag == 'h2':
  55                 if ldf is not None:
  56                     ldf.close()
  57                     ldf = None
  58             elif node.tag == 'p' and ldf is not None:
  59                 ldf.write(innertext(node).replace('```', '') + '\n')
  60     finally:
  61         if ldf is not None:
  62             ldf.close()
  63
  64
  65 if __name__ == '__main__':
  66     import sys
  67
  68     out_folder = ''
  69
  70     if len(sys.argv) == 0:
  71         print("Usage: %s <Schema-Update.md> [<output folder>]" % (sys.argv[0]), file=sys.stderr)
  72         sys.exit(1)
  73
  74     in_file = sys.argv[1]
  75     if len(sys.argv) > 2:
  76         out_folder = sys.argv[2]
  77
  78     read_ms_markdown(in_file, out_folder)