]> dreyeck.freedombox.rocks Git - topic-maps.git/blobdiff - src/xtm/reader.lisp
Verify CTM/XTM semantic equivalence through TMDM and CXTM (Slice 22F)
[topic-maps.git] / src / xtm / reader.lisp
index f9ea26f18c13535bac1eef83bee4b4c5185815cb..dafd4dbd5a07ca15479b8cf09882885c8774772c 100644 (file)
@@ -62,9 +62,6 @@
 (defun unsupported (node)
   (reject :unsupported-construct (format nil "XTM ~A is not implemented in this subset." (node-name node))
           node 'xtm-unsupported))
 (defun unsupported (node)
   (reject :unsupported-construct (format nil "XTM ~A is not implemented in this subset." (node-name node))
           node 'xtm-unsupported))
-(defun check-reifier (node)
-  (when (attr node "reifier")
-    (reject :reification "XTM Reification is outside this subset." node 'xtm-unsupported)))
 (defun leaf-href (node)
   (attributes node '("href") '("href"))
   (when (elements node) (reject :unexpected-child "A locator element must be empty." node))
 (defun leaf-href (node)
   (attributes node '("href") '("href"))
   (when (elements node) (reject :unexpected-child "A locator element must be empty." node))
@@ -90,7 +87,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))
@@ -99,6 +97,7 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                           (when (< next phase) (reject :element-order "topicMap child order is invalid." child))
                           (setf phase next)
                           (validate child '("itemIdentity" "mergeMap" "topic" "association"))))))
                           (when (< next phase) (reject :element-order "topicMap child order is invalid." child))
                           (setf phase next)
                           (validate child '("itemIdentity" "mergeMap" "topic" "association"))))))
+                   ((string= name "mergeMap") (mergemap-iri node))
                    ((string= name "topic")
                     (attributes node '("id") '("id"))
                     (let ((id (collapse-space (attr node "id"))))
                    ((string= name "topic")
                     (attributes node '("id") '("id"))
                     (let ((id (collapse-space (attr node "id"))))
@@ -121,6 +120,90 @@ 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)
+                    (when (attr node "reifier")
+                      (resolve-iri (attr node "reifier") *document-iri* 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)
+                    (when (attr node "reifier") (resolve-iri (attr node "reifier") *document-iri* 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)
+                        (when (equal datatype "http://www.w3.org/2001/XMLSchema#anyType")
+                          (reject :resource-data-datatype "xsd:anyType XML canonicalization is outside this subset." node 'xtm-unsupported)))
+                      (dolist (child (node-children node))
+                        (unless (stringp child)
+                          (reject :unexpected-child "Textual resourceData cannot contain child elements." child)))))
+                   ((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 +220,20 @@ 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-item-reifier (node item 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))))
+      (return-from read-item-reifier (topic-maps.tmdm:set-item-reifier item topic))))
+  item)
+(defun read-map-reifier (node map)
+  (read-item-reifier node map 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,24 +243,130 @@ 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-resource-value (resource)
+  "Return value and datatype for a validated resource node (XTM 4.16/4.17).
+This operation neither looks up Topics nor fetches resources. ANYTYPE is rejected
+by source validation before model construction. Preserve other datatype IRIs."
+  (if (string= (node-name resource) "resourceRef")
+      (values (leaf-href resource) (topic-maps.tmdm:iri-datatype))
+      (let ((datatype (or (attr resource "datatype") (topic-maps.tmdm:string-datatype)))
+            (text (with-output-to-string (out)
+                    (dolist (part (node-children resource)) (write-string part out)))))
+        (values (if (equal datatype (topic-maps.tmdm:iri-datatype))
+                    (resolve-iri text *document-iri* resource)
+                    text)
+                datatype))))
+(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))
+         (explicit (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref))) (elements scope-node))))
+    (multiple-value-bind (value datatype) (read-resource-value resource)
+      ;; ADD-VARIANT owns canonicalization and the proper-superset constraint.
+      (let ((variant (topic-maps.tmdm:add-variant name value :datatype datatype
+                       :scope (append (topic-maps.tmdm:topic-name-scope name) explicit))))
+        (dolist (child children)
+          (when (string= (node-name child) "itemIdentity")
+            (setf variant (topic-maps.tmdm:add-item-identifier variant (leaf-href child)))))
+        ;; Reification may normalize again; retain the native canonical handle.
+        (topic-maps.tmdm:canonical-variant (read-item-reifier node variant map))))))
+(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)
+        (when (string= (node-name child) "itemIdentity")
+          (setf name (topic-maps.tmdm:add-item-identifier name (leaf-href child)))))
+      ;; ADD-NAME may have returned an existing canonical Name. Reifier
+      ;; resolution/merging can normalize it again: retain the native result
+      ;; before processing Variants and return the current Name handle.
+      (setf name (read-item-reifier node name map))
+      (dolist (child children)
+        (when (string= (node-name child) "variant") (read-variant child name map)))
+      (topic-maps.tmdm:canonical-topic-name name))))
 (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)))
     (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).
-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
-distinct. No resources are fetched. No externally supplied Map is mutated."
+(defun mergemap-iri (node)
+  (let ((iri (leaf-href node)))
+    (when (iri-parts-fragment (split-iri iri))
+      (reject :mergemap-fragment "mergeMap href must not have a fragment identifier." node))
+    iri))
+(defun resource-failure (code detail node &optional cause)
+  (error 'xtm-resource-error :code code :detail detail :cause cause
+    :document-iri *document-iri* :source-key *source-key*
+    :line (node-line node) :column (node-column node)))
+(defun resource-octets-p (value)
+  ;; Same resolver value convention as CTM, without a dependency on its Reader.
+  (and (vectorp value) (not (stringp value))
+    (every (lambda (n) (and (integerp n) (<= 0 n 255))) value)))
+(defun read-mergemap (node map resolver max-depth active-iris)
+  (let ((resource (mergemap-iri node)))
+    (unless resolver
+      (reject :resource-resolver-required "mergeMap requires an explicit resource resolver; no resource was loaded." node 'xtm-unsupported))
+    ;; These are finite resource-policy guards, not normative cycle semantics.
+    ;; Each independent public call starts a new active path; siblings may repeat.
+    (when (member resource active-iris :test #'string=)
+      (reject :cyclic-mergemap "Active recursive XTM resource dependency; cycle processing is not implemented." node 'xtm-unsupported))
+    (when (>= (length active-iris) (1+ max-depth))
+      (reject :resource-depth-limit "Configured nested XTM resource limit reached; this is implementation policy." node 'xtm-unsupported))
+    (multiple-value-bind (bytes source-key)
+        (handler-case
+            (funcall resolver resource :purpose :mergemap :from-document-iri *document-iri*
+              :notation "http://psi.topicmaps.org/iso13250/xtm")
+          (error (c) (resource-failure :resource-resolver-failure (princ-to-string c) node c)))
+      (unless bytes
+        (resource-failure :resource-unavailable "Resolver declined or did not supply the requested XTM resource." node))
+      (unless (and (resource-octets-p bytes) (or (null source-key) (stringp source-key)))
+        (resource-failure :invalid-resource-result "Resolver must return an octet vector and a string source key or NIL." node))
+      (let ((source (deserialize-document
+                      (if (typep bytes '(vector (unsigned-byte 8))) bytes
+                          (map '(vector (unsigned-byte 8)) #'identity bytes))
+                      resource (or source-key resource) resolver max-depth active-iris)))
+        ;; Import only Topics/Associations. The existing operation preflights
+        ;; conflicts, preserves SOURCE, and excludes its Map identifiers/reifier.
+        (handler-case (topic-maps.tmdm:import-map-content map source)
+          (error (c) (resource-failure :mergemap-import-failure (princ-to-string c) node c)))))))
+(defun deserialize-octets (bytes &key document-iri source-key resource-resolver (max-resource-depth 32))
+  "Deserialize raw XTM 2.0 octets into a fresh TMDM Map.
+DOCUMENT-IRI is required, absolute and fragment-free. SOURCE-KEY is diagnostic.
+RESOURCE-RESOLVER is optional: (resolver absolute-iri :purpose :mergemap
+ :from-document-iri parent-iri :notation XTM-notation-IRI)
+returns raw octets and an optional diagnostic source key. No implicit I/O.
+Children use their resolved IRI as Document IRI and the same explicit resolver.
+MAX-RESOURCE-DEPTH bounds nested imports (default 32); active cycles are
+Unsupported implementation policy, not a normative XTM invalidity decision.
+Child XML/XTM/model errors retain their original contexts; resolver/import
+failures use XTM-RESOURCE-ERROR with the original ERROR-CAUSE. No supplied Map
+is mutated. Each public call has its own resource recursion context."
+  (check-type max-resource-depth (integer 0 *))
+  (deserialize-document bytes document-iri source-key resource-resolver max-resource-depth nil))
+(defun deserialize-document (bytes document-iri source-key resource-resolver max-resource-depth active-iris)
   (check-type bytes (vector (unsigned-byte 8)))
   (let ((*document-iri* document-iri) (*source-key* source-key)
         (handler (make-instance 'source-handler)))
   (check-type bytes (vector (unsigned-byte 8)))
   (let ((*document-iri* document-iri) (*source-key* source-key)
         (handler (make-instance 'source-handler)))
@@ -181,8 +384,13 @@ 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))
       (dolist (child (elements root))
-        (if (string= (node-name child) "itemIdentity")
-            (topic-maps.tmdm:add-item-identifier map (leaf-href child))
-            (read-topic child map)))
+        (cond ((string= (node-name child) "itemIdentity")
+               (topic-maps.tmdm:add-item-identifier map (leaf-href child)))
+              ((string= (node-name child) "mergeMap")
+               (read-mergemap child map resource-resolver max-resource-depth
+                 (cons document-iri active-iris)))
+              (t (read-topic child map))))
       map)))
       map)))