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 from __future__ import print_function
  22 """Generate LDIF from Github documentation."""
  23
  24 import re
  25 import os
  26 import markdown
  27 import xml.etree.ElementTree as ET
  28
  29 def innertext(tag):
  30     return (tag.text or '') + \
  31             ''.join(innertext(e) for e in tag) + \
  32             (tag.tail or '')
  33
  34 def read_ms_markdown(in_file, out_folder):
  35     """Read Github documentation-derived schema files."""
  36
  37     with open(in_file) as update_file:
  38         # Remove any comments from the raw LDF files
  39         html = markdown.markdown(re.sub(r'(?m)^# .*\n?', '', update_file.read()),
  40                                  output_format='xhtml')
  41
  42     tree = ET.fromstring('<root>' + html + '</root>')
  43
  44     ldf = None
  45     try:
  46         for node in tree:
  47             if node.tag == 'h3':
  48                 if ldf is not None:
  49                     ldf.close()
  50
  51                 out_path = os.path.join(out_folder, innertext(node).strip())
  52                 ldf = open(out_path, 'w')
  53             elif node.tag == 'p' and ldf is not None:
  54                 ldf.write(innertext(node).replace('```', '') + '\n')
  55     finally:
  56         if ldf is not None:
  57             ldf.close()
  58
  59 if __name__ == '__main__':
  60     import sys
  61
  62     out_folder = ''
  63
  64     if len(sys.argv) == 0:
  65         print("Usage: %s <Schema-Update.md> [<output folder>]" % (sys.argv[0]), file=sys.stderr)
  66         sys.exit(1)
  67
  68     in_file = sys.argv[1]
  69     if len(sys.argv) > 2:
  70         out_folder = sys.argv[2]
  71
  72     read_ms_markdown(in_file, out_folder)