]> dreyeck.freedombox.rocks Git - topic-maps.git/blobdiff - src/xtm/reader.lisp
Support XTM topic map reification (Slice 21L)
[topic-maps.git] / src / xtm / reader.lisp
index f9ea26f18c13535bac1eef83bee4b4c5185815cb..f2b4ad10c6aa70faa2019125712c8a123c75cf17 100644 (file)
@@ -90,7 +90,8 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                     (attributes node '("version" "reifier") '("version"))
                     (unless (equal (attr node "version") "2.0")
                       (reject :invalid-version "This reader accepts XTM version 2.0 only." node))
                     (attributes node '("version" "reifier") '("version"))
                     (unless (equal (attr node "version") "2.0")
                       (reject :invalid-version "This reader accepts XTM version 2.0 only." node))
-                    (check-reifier node)
+                    (when (attr node "reifier")
+                      (resolve-iri (attr node "reifier") *document-iri* node))
                     (let ((phase 0))
                       (dolist (child (elements node))
                         (let* ((name (node-name child))
                     (let ((phase 0))
                       (dolist (child (elements node))
                         (let* ((name (node-name child))
@@ -121,6 +122,94 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                     (attributes node nil nil)
                     (unless (elements node) (reject :empty-instance-of "instanceOf needs at least one topicRef." node))
                     (dolist (child (elements node)) (validate child '("topicRef"))))
                     (attributes node nil nil)
                     (unless (elements node) (reject :empty-instance-of "instanceOf needs at least one topicRef." node))
                     (dolist (child (elements node)) (validate child '("topicRef"))))
+                   ((string= name "name")
+                    (attributes node '("reifier") nil)
+                    (check-reifier node)
+                    (let ((phase 0) (type-seen nil) (scope-seen nil) (value-seen nil))
+                      (dolist (child (elements node))
+                        (check-namespace child)
+                        (let* ((kind (node-name child))
+                               (next (position kind '("itemIdentity" "type" "scope" "value" "variant") :test #'string=)))
+                          (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+                          (when (or (< next phase) (and (string= kind "variant") (not value-seen)))
+                            (reject :element-order "name child order is invalid." child))
+                          (setf phase next)
+                          (cond
+                            ((member kind '("itemIdentity" "variant") :test #'string=) nil)
+                            ((string= kind "type")
+                             (when type-seen (reject :duplicate-name-type "Only one name type is allowed." child))
+                             (setf type-seen t))
+                            ((string= kind "scope")
+                             (when scope-seen (reject :duplicate-name-scope "Only one name scope is allowed." child))
+                             (setf scope-seen t))
+                            ((string= kind "value")
+                             (when value-seen (reject :duplicate-name-value "Only one name value is allowed." child))
+                             (setf value-seen t))
+                            ;; Valid extension points remain explicitly unsupported.
+                            ;; Their complete subgrammars are outside this subset.
+                            (t (unsupported child)))
+                          (validate child '("itemIdentity" "type" "scope" "value" "variant"))))
+                      (unless value-seen (reject :missing-name-value "name requires a value element." node))))
+                   ((string= name "variant")
+                    (attributes node '("reifier") nil)
+                    (check-reifier node)
+                    (let ((phase 0) (scope-seen nil) (resource-seen nil))
+                      (dolist (child (elements node))
+                        (check-namespace child)
+                        (let* ((kind (node-name child))
+                               (next (cond ((string= kind "itemIdentity") 0)
+                                           ((string= kind "scope") 1)
+                                           ((member kind '("resourceData" "resourceRef") :test #'string=) 2))))
+                          (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+                          (when (< next phase) (reject :element-order "variant child order is invalid." child))
+                          (setf phase next)
+                          (cond
+                            ((string= kind "itemIdentity") nil)
+                            ((string= kind "scope")
+                             (when scope-seen (reject :duplicate-variant-scope "Only one variant scope is allowed." child))
+                             (setf scope-seen t))
+                            (t
+                             (unless scope-seen (reject :missing-variant-scope "variant requires scope before its resource." child))
+                             (when resource-seen (reject :variant-resource-cardinality "variant requires exactly one resource." child))
+                             (setf resource-seen t)))
+                          (validate child '("itemIdentity" "scope" "resourceData" "resourceRef"))))
+                      (unless scope-seen (reject :missing-variant-scope "variant requires a scope element." node))
+                      (unless resource-seen (reject :missing-variant-resource "variant requires a resource element." node))))
+                   ((string= name "resourceRef") (leaf-href node))
+                   ((string= name "resourceData")
+                    (attributes node '("datatype") nil)
+                    (let ((datatype (attr node "datatype")))
+                      ;; DATATYPE is already an absolute IRI, not content to
+                      ;; resolve against the document or percent-normalize.
+                      (when datatype
+                        (unless (iri-parts-scheme (split-iri datatype))
+                          (reject :invalid-resource-data-datatype "resourceData datatype must be an absolute IRI." node))
+                        (validate-decoded-reference (unescape-reference datatype node) node)
+                        (unless (member datatype (list (topic-maps.tmdm:string-datatype) (topic-maps.tmdm:iri-datatype)) :test #'equal)
+                          (reject :resource-data-datatype "Only textual xsd:string and xsd:anyURI resourceData are implemented." node 'xtm-unsupported)))
+                      (dolist (child (node-children node))
+                        (unless (stringp child)
+                          (if (or (equal datatype (topic-maps.tmdm:iri-datatype)) (equal (node-uri child) +namespace+))
+                              (reject :unexpected-child
+                                (if (equal datatype (topic-maps.tmdm:iri-datatype))
+                                    "anyURI resourceData cannot contain child elements."
+                                    "resourceData cannot contain XTM markup.") child)
+                              (reject :resource-data-markup "Embedded XML resourceData is outside this subset." child 'xtm-unsupported))))))
+                   ((string= name "type")
+                    (attributes node nil nil)
+                    (let ((refs (elements node)))
+                      (unless (= 1 (length refs)) (reject :type-cardinality "type requires exactly one topicRef." node))
+                      (validate (first refs) '("topicRef"))))
+                   ((string= name "scope")
+                    (attributes node nil nil)
+                    (unless (elements node) (reject :empty-scope "scope requires at least one topicRef." node))
+                    (dolist (child (elements node)) (validate child '("topicRef"))))
+                   ((string= name "value")
+                    (attributes node nil nil)
+                    ;; VALUE accepts all character data, including empty text and
+                    ;; whitespace. ELEMENTS would apply the wrong text policy.
+                    (dolist (child (node-children node))
+                      (unless (stringp child) (reject :unexpected-child "value accepts character data only." child))))
                    ((string= name "topicRef") (reference-iri node))
                    ((member name '("itemIdentity" "subjectIdentifier" "subjectLocator") :test #'string=)
                     (leaf-href node))
                    ((string= name "topicRef") (reference-iri node))
                    ((member name '("itemIdentity" "subjectIdentifier" "subjectLocator") :test #'string=)
                     (leaf-href node))
@@ -137,6 +226,18 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                         (topic-maps.tmdm:topic-map-topics map))))
     (if topic (topic-maps.tmdm:canonical-topic topic)
         (topic-maps.tmdm:intern-topic map :item-identifier iri))))
                         (topic-maps.tmdm:topic-map-topics map))))
     (if topic (topic-maps.tmdm:canonical-topic topic)
         (topic-maps.tmdm:intern-topic map :item-identifier iri))))
+(defun read-map-reifier (node map)
+  ;; XTM 4.3.2 looks up Item Identifiers only, unlike topicRef (4.20).
+  ;; INTERN-TOPIC adds the II on a miss; any SI/II identity merging then
+  ;; follows the existing TMDM rules, independently of this lookup.
+  (when (attr node "reifier")
+    (let* ((iri (resolve-iri (attr node "reifier") *document-iri* node))
+           (topic (or (find iri (topic-maps.tmdm:topic-map-topics map)
+                        :test (lambda (iri topic)
+                                (member iri (topic-maps.tmdm:topic-item-identifiers topic) :test #'string=)))
+                      (topic-maps.tmdm:intern-topic map :item-identifier iri))))
+      (topic-maps.tmdm:set-item-reifier map topic)))
+  map)
 (defun core-topic (map local)
   (topic-maps.tmdm:intern-topic map :subject-identifier
     (concatenate 'string "http://psi.topicmaps.org/iso13250/model/" local)))
 (defun core-topic (map local)
   (topic-maps.tmdm:intern-topic map :subject-identifier
     (concatenate 'string "http://psi.topicmaps.org/iso13250/model/" local)))
@@ -146,20 +247,68 @@ constructs' complete subgrammars is made. XML errors have already been checked."
       (topic-maps.tmdm:make-association map (core-topic map "type-instance")
         (list (list (core-topic map "type") type)
               (list (core-topic map "instance") (topic-maps.tmdm:canonical-topic owner)))))))
       (topic-maps.tmdm:make-association map (core-topic map "type-instance")
         (list (list (core-topic map "type") type)
               (list (core-topic map "instance") (topic-maps.tmdm:canonical-topic owner)))))))
+(defun read-variant (node name map)
+  (let* ((children (elements node))
+         (scope-node (find "scope" children :key #'node-name :test #'string=))
+         (resource (find-if (lambda (child) (member (node-name child) '("resourceData" "resourceRef") :test #'string=)) children))
+         (reference-p (string= (node-name resource) "resourceRef"))
+         (uri-data-p (and (not reference-p) (equal (attr resource "datatype") (topic-maps.tmdm:iri-datatype))))
+         (explicit (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref))) (elements scope-node)))
+         ;; A resource locator is a value, not a topic reference. LEAF-HREF uses
+         ;; the shared XTM IRI resolver without topic lookup or resource access.
+         (text (unless reference-p (with-output-to-string (out)
+                 (dolist (part (node-children resource)) (write-string part out)))))
+         (value (cond (reference-p (leaf-href resource))
+                      (uri-data-p (resolve-iri text *document-iri* resource))
+                      (t text))))
+    ;; ADD-VARIANT canonicalizes the union and enforces the proper superset.
+    ;; A nonempty explicit scope may still add no theme to the Name scope.
+    (let ((variant (topic-maps.tmdm:add-variant name value
+                     :datatype (if (or reference-p uri-data-p) (topic-maps.tmdm:iri-datatype) (topic-maps.tmdm:string-datatype))
+                     :scope (append (topic-maps.tmdm:topic-name-scope name) explicit))))
+      ;; Normalize first: an equal Variant may already own this identifier.
+      ;; Keep the native canonical result and its global conflict conditions.
+      (dolist (child children variant)
+        (when (string= (node-name child) "itemIdentity")
+          (setf variant (topic-maps.tmdm:add-item-identifier variant (leaf-href child))))))))
+(defun read-name (node owner map)
+  (let* ((children (elements node))
+         (type-node (find "type" children :key #'node-name :test #'string=))
+         (scope-node (find "scope" children :key #'node-name :test #'string=))
+         (type (when type-node (find-reference-topic map (reference-iri (first (elements type-node))))))
+         (scope (when scope-node (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref)))
+                                        (elements scope-node))))
+         (value-node (find "value" children :key #'node-name :test #'string=))
+         (value (with-output-to-string (out)
+                  (dolist (part (node-children value-node)) (write-string part out)))))
+    ;; SAX has already resolved XML character/entity references. Preserve the
+    ;; resulting Unicode sequence without trimming or decoding it again.
+    ;; ADD-NAME owns canonical set semantics and normalization after merging.
+    (let ((name (if type-node
+                    (topic-maps.tmdm:add-name owner value :type type :scope scope)
+                    (topic-maps.tmdm:add-default-name owner value :scope scope))))
+      ;; Item identifiers belong to the canonical Name, never its owner/type.
+      ;; Use the shared model API for set semantics and global conflicts.
+      (dolist (child children name)
+        (cond ((string= (node-name child) "itemIdentity")
+               (setf name (topic-maps.tmdm:add-item-identifier name (leaf-href child))))
+              ((string= (node-name child) "variant") (read-variant child name map)))))))
 (defun read-topic (node map)
   (let ((topic (topic-maps.tmdm:intern-topic map :item-identifier
                  (concatenate 'string *document-iri* "#" (collapse-space (attr node "id"))))))
     (dolist (child (elements node))
       (let ((name (node-name child)))
 (defun read-topic (node map)
   (let ((topic (topic-maps.tmdm:intern-topic map :item-identifier
                  (concatenate 'string *document-iri* "#" (collapse-space (attr node "id"))))))
     (dolist (child (elements node))
       (let ((name (node-name child)))
-        (if (string= name "instanceOf") (read-instance-of child topic map)
-            (setf topic (topic-maps.tmdm:add-topic-identifier topic
-                          (cond ((string= name "itemIdentity") :item-identifier)
-                                ((string= name "subjectIdentifier") :subject-identifier)
-                                (t :subject-locator))
-                          (leaf-href child))))))
+        (cond
+          ((string= name "instanceOf") (read-instance-of child topic map))
+          ((string= name "name") (read-name child topic map))
+          (t (setf topic (topic-maps.tmdm:add-topic-identifier topic
+                           (cond ((string= name "itemIdentity") :item-identifier)
+                                 ((string= name "subjectIdentifier") :subject-identifier)
+                                 (t :subject-locator))
+                           (leaf-href child)))))))
     (topic-maps.tmdm:canonical-topic topic)))
 (defun deserialize-octets (bytes &key document-iri source-key)
     (topic-maps.tmdm:canonical-topic topic)))
 (defun deserialize-octets (bytes &key document-iri source-key)
-  "Deserialize raw XML octets into a new TMDM Topic Map (XTM 2.0 identity subset).
+  "Deserialize raw XML octets into a new TMDM Topic Map (XTM 2.0 identity/Name subset).
 DOCUMENT-IRI is required, absolute and fragment-free. SOURCE-KEY is a diagnostic
 label only. XML positions are approximate SAX line/column values, not spans.
 XML-policy errors, XTM rejection/unsupported and original TMDM conflicts remain
 DOCUMENT-IRI is required, absolute and fragment-free. SOURCE-KEY is a diagnostic
 label only. XML positions are approximate SAX line/column values, not spans.
 XML-policy errors, XTM rejection/unsupported and original TMDM conflicts remain
@@ -181,6 +330,8 @@ distinct. No resources are fetched. No externally supplied Map is mutated."
                         :line (sax:line-number handler) :column (sax:column-number handler)))))
            (map (topic-maps.tmdm:make-topic-map)))
       (validate-source root)
                         :line (sax:line-number handler) :column (sax:column-number handler)))))
            (map (topic-maps.tmdm:make-topic-map)))
       (validate-source root)
+      ;; The attribute is processed before itemIdentity and later Topic nodes.
+      (read-map-reifier root map)
       (dolist (child (elements root))
         (if (string= (node-name child) "itemIdentity")
             (topic-maps.tmdm:add-item-identifier map (leaf-href child))
       (dolist (child (elements root))
         (if (string= (node-name child) "itemIdentity")
             (topic-maps.tmdm:add-item-identifier map (leaf-href child))