10396d6f01
* chore: remove more tools.ietf.org server only related things. * chore: remove use of tools.ietf.org floorplans\n\nThe data will move into the FloorPlan models instead.
88 lines
3.2 KiB
Python
88 lines
3.2 KiB
Python
# Copyright The IETF Trust 2022, All Rights Reserved
|
|
# -*- coding: utf-8 -*-
|
|
import os
|
|
import xml2rfc
|
|
|
|
import debug # pyflakes: ignore
|
|
|
|
from contextlib import ExitStack
|
|
|
|
from .draft import Draft
|
|
|
|
|
|
class XMLDraft(Draft):
|
|
"""Draft from XML source
|
|
|
|
Currently just a holding place for get_refs() for an XML file. Can eventually expand
|
|
to implement the other public methods of Draft as need arises.
|
|
"""
|
|
def __init__(self, xml_file):
|
|
"""Initialize XMLDraft instance
|
|
|
|
:parameter xml_file: path to file containing XML source
|
|
"""
|
|
super().__init__()
|
|
# cast xml_file to str so, e.g., this will work with a Path
|
|
self.xmltree = self.parse_xml(str(xml_file))
|
|
self.xmlroot = self.xmltree.getroot()
|
|
|
|
@staticmethod
|
|
def parse_xml(filename):
|
|
orig_write_out = xml2rfc.log.write_out
|
|
orig_write_err = xml2rfc.log.write_err
|
|
tree = None
|
|
with ExitStack() as stack:
|
|
@stack.callback
|
|
def cleanup(): # called when context exited, even if there's an exception
|
|
xml2rfc.log.write_out = orig_write_out
|
|
xml2rfc.log.write_err = orig_write_err
|
|
|
|
xml2rfc.log.write_out = open(os.devnull, 'w')
|
|
xml2rfc.log.write_err = open(os.devnull, 'w')
|
|
|
|
parser = xml2rfc.XmlRfcParser(filename, quiet=True)
|
|
tree = parser.parse()
|
|
xml_version = tree.getroot().get('version', '2')
|
|
if xml_version == '2':
|
|
v2v3 = xml2rfc.V2v3XmlWriter(tree)
|
|
tree.tree = v2v3.convert2to3()
|
|
return tree
|
|
|
|
def _document_name(self, anchor):
|
|
"""Guess document name from reference anchor
|
|
|
|
Looks for series numbers and removes leading 0s from the number.
|
|
"""
|
|
anchor = anchor.lower() # always give back lowercase
|
|
label = anchor.rstrip('0123456789') # remove trailing digits
|
|
if label in ['rfc', 'bcp', 'fyi', 'std']:
|
|
number = int(anchor[len(label):])
|
|
return f'{label}{number}'
|
|
return anchor
|
|
|
|
def _reference_section_type(self, section_name):
|
|
"""Determine reference type from name of references section"""
|
|
if section_name:
|
|
section_name = section_name.lower()
|
|
if 'normative' in section_name:
|
|
return self.REF_TYPE_NORMATIVE
|
|
elif 'informative' in section_name:
|
|
return self.REF_TYPE_INFORMATIVE
|
|
return self.REF_TYPE_UNKNOWN
|
|
|
|
def _reference_section_name(self, section_elt):
|
|
section_name = section_elt.findtext('name')
|
|
if section_name is None and 'title' in section_elt.keys():
|
|
section_name = section_elt.get('title') # fall back to title if we have it
|
|
return section_name
|
|
|
|
def get_refs(self):
|
|
"""Extract references from the draft"""
|
|
refs = {}
|
|
# accept nested <references> sections
|
|
for section in self.xmlroot.findall('back//references'):
|
|
ref_type = self._reference_section_type(self._reference_section_name(section))
|
|
for ref in (section.findall('./reference') + section.findall('./referencegroup')):
|
|
refs[self._document_name(ref.get('anchor'))] = ref_type
|
|
return refs
|