error reporting

[librarian.git] / librarian / document.py

diff --git a/librarian/document.py b/librarian/document.py
index 32148e3..a4a8593 100755 (executable)
--- a/librarian/document.py
+++ b/librarian/document.py
@@ -11,21 +11,41 @@ from .parser import SSTParser
 
 
 class Document(object):
-    # Do I use meta_context?
     def __init__(self, edoc, meta_context=None):
         self.edoc = edoc
-
         root_elem = edoc.getroot()
+        # Do I use meta_context?
         if meta_context is not None:
             root_elem.meta_context = meta_context
+        self.validate()
 
+    def validate(self):
+        root_elem = self.edoc.getroot()
         if not isinstance(root_elem, Section):
             if root_elem.tag != SSTNS('section'):
-                raise ValidationError("Invalid root element. Found '%s', should be '%s'" % (
-                    root_elem.tag, SSTNS('section')))
+                if root_elem.tag == 'section':
+                    for element in root_elem.iter():
+                        if element.tag in ('section', 'header', 'div', 'span', 'aside', 'metadata'):
+                            element.tag = str(SSTNS(element.tag))
+
+                    parser = SSTParser()
+                    tree = etree.parse(StringIO(etree.tostring(root_elem)), parser)
+                    tree.xinclude()
+                    self.edoc = tree
+                    root_elem = self.edoc.getroot()
+                else:
+                    raise ValueError("Invalid root element. Found '%s', should be '%s'" % (
+                        root_elem.tag, SSTNS('section')))
             else:
-                raise ValidationError("Invalid class of root element. "
-                    "Use librarian.parser.SSTParser.")
+                raise ValueError("Invalid class of root element. Use librarian.parser.SSTParser.")
+        if len(root_elem) < 1 or root_elem[0].tag != SSTNS('metadata'):
+            raise ValueError("The first tag in section should be metadata")
+        if len(root_elem) < 2 or root_elem[1].tag != SSTNS('header'):
+            raise ValueError("The first tag after metadata should be header")
+        header = root_elem[1]
+        if not getattr(header, 'text', None) or not header.text.strip():
+            raise ValueError(
+                "The first header should contain the title in plain text (no links, emphasis etc.) and cannot be empty")
 
     @classmethod
     def from_string(cls, xml, *args, **kwargs):
@@ -47,6 +67,8 @@ class Document(object):
             data = data.decode('utf-8')
 
         data = data.replace(u'\ufeff', '')
+        # This is bad. The editor shouldn't spew unknown HTML entities.
+        data = data.replace(u'&nbsp;', u'\u00a0')
 
         parser = SSTParser()
         tree = etree.parse(StringIO(data.encode('utf-8')), parser)