]> dreyeck.freedombox.rocks Git - topic-maps.git/blobdiff - src/xtm/reader.lisp
Implement XTM association and role core with original conformance evidence
[topic-maps.git] / src / xtm / reader.lisp
index ff2e2ef89e99b1264627df224e5ca2d5df248965..28caca118f2dc99cbb506a636b06f2cd5080a3b8 100644 (file)
@@ -97,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"))))))
+                   ((string= name "mergeMap") (mergemap-iri node))
                    ((string= name "topic")
                     (attributes node '("id") '("id"))
                     (let ((id (collapse-space (attr node "id"))))
@@ -173,6 +174,82 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                           (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 "occurrence")
+                    (attributes node '("reifier") nil)
+                    (when (attr node "reifier")
+                      (resolve-iri (attr node "reifier") *document-iri* node)
+                      (reject :unsupported-construct "XTM occurrence reification is not implemented in this subset." node 'xtm-unsupported))
+                    (let ((phase 0) (type-seen nil) (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 "type") 1)
+                                           ((string= kind "scope") 2)
+                                           ((member kind '("resourceData" "resourceRef") :test #'string=) 3))))
+                          (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+                          (when (< next phase) (reject :element-order "occurrence child order is invalid." child))
+                          (setf phase next)
+                          (cond
+                            ((string= kind "itemIdentity")
+                             (validate child '("itemIdentity"))
+                             (reject :unsupported-construct "XTM occurrence item identifiers are not implemented in this subset." child 'xtm-unsupported))
+                            ((string= kind "type")
+                             (when type-seen (reject :duplicate-occurrence-type "Only one occurrence type is allowed." child))
+                             (setf type-seen t))
+                            ((string= kind "scope")
+                             (unless type-seen (reject :missing-occurrence-type "occurrence requires type before scope." child))
+                             (when scope-seen (reject :duplicate-occurrence-scope "Only one occurrence scope is allowed." child))
+                             (setf scope-seen t))
+                            (t
+                             (unless type-seen (reject :missing-occurrence-type "occurrence requires type before its resource." child))
+                             (when resource-seen (reject :occurrence-resource-cardinality "occurrence requires exactly one resource." child))
+                             (setf resource-seen t)))
+                          (validate child '("type" "scope" "resourceData" "resourceRef"))))
+                      (unless type-seen (reject :missing-occurrence-type "occurrence requires a type element." node))
+                      (unless resource-seen (reject :missing-occurrence-resource "occurrence requires a resource element." node))))
+                   ((member name '("association" "role") :test #'string=)
+                    (attributes node '("reifier") nil)
+                    (when (attr node "reifier")
+                      (resolve-iri (attr node "reifier") *document-iri* node)
+                      (reject :unsupported-construct
+                        (format nil "XTM ~A reification is not implemented in this subset." name) node 'xtm-unsupported))
+                    (let ((association-p (string= name "association"))
+                          (phase 0) (type-seen nil) (scope-seen nil) (participants 0))
+                      (dolist (child (elements node))
+                        (check-namespace child)
+                        (let* ((kind (node-name child))
+                               (next (cond ((string= kind "itemIdentity") 0)
+                                           ((string= kind "type") 1)
+                                           ((and association-p (string= kind "scope")) 2)
+                                           ((string= kind (if association-p "role" "topicRef")) 3))))
+                          (unless next (reject :unexpected-element (format nil "Unexpected ~A element." kind) child))
+                          (when (< next phase) (reject :element-order (format nil "~A child order is invalid." name) child))
+                          (setf phase next)
+                          (cond
+                            ((string= kind "itemIdentity")
+                             (validate child '("itemIdentity"))
+                             (reject :unsupported-construct
+                               (format nil "XTM ~A item identifiers are not implemented in this subset." name) child 'xtm-unsupported))
+                            ((string= kind "type")
+                             (when type-seen (reject :duplicate-type (format nil "Only one ~A type is allowed." name) child))
+                             (setf type-seen t))
+                            (t
+                             (unless type-seen
+                               (reject :missing-type (format nil "~A requires type before ~A." name kind) child))
+                             (if (string= kind "scope")
+                                 (progn
+                                   (when scope-seen (reject :duplicate-scope "Only one association scope is allowed." child))
+                                   (setf scope-seen t))
+                                 (progn
+                                   (incf participants)
+                                   (when (and (not association-p) (> participants 1))
+                                     (reject :role-player-cardinality "role requires exactly one topicRef player." child))))))
+                          (validate child (if association-p '("type" "scope" "role") '("type" "topicRef")))))
+                      (unless type-seen (reject :missing-type (format nil "~A requires a type element." name) node))
+                      (when (zerop participants)
+                        (reject (if association-p :missing-roles :missing-role-player)
+                          (if association-p "association requires at least one role." "role requires a topicRef player.") node))))
                    ((string= name "resourceRef") (leaf-href node))
                    ((string= name "resourceData")
                     (attributes node '("datatype") nil)
@@ -183,16 +260,11 @@ constructs' complete subgrammars is made. XML errors have already been checked."
                         (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)))
+                        (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)
-                          (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))))))
+                          (reject :unexpected-child "Textual resourceData cannot contain child elements." child)))))
                    ((string= name "type")
                     (attributes node nil nil)
                     (let ((refs (elements node)))
@@ -247,33 +319,47 @@ 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)))))))
+(defun read-association (node map)
+  ;; Validate the whole source before constructing any model items. Resolve
+  ;; references through the shared SI/II lookup, then create one complete native
+  ;; Association. TMDM owns role sets, inverse links, merging and old handles.
+  (let ((type nil) (scope nil) (roles nil))
+    (labels ((reference (ref) (find-reference-topic map (reference-iri ref)))
+             (type-reference (node) (reference (first (elements node)))))
+      (dolist (child (elements node))
+        (cond ((string= (node-name child) "type") (setf type (type-reference child)))
+              ((string= (node-name child) "scope") (setf scope (mapcar #'reference (elements child))))
+              ((string= (node-name child) "role")
+               (let ((children (elements child)))
+                 (push (list (type-reference (first children)) (reference (second children))) roles)))))
+      (topic-maps.tmdm:make-association map type (nreverse roles) :scope scope))))
+(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))
-         (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)
-        (when (string= (node-name child) "itemIdentity")
-          (setf variant (topic-maps.tmdm:add-item-identifier variant (leaf-href child)))))
-      ;; Reification may merge Topics and normalize this Variant again.
-      ;; Reuse the II-only resolver and retain its current native result.
-      (topic-maps.tmdm:canonical-variant (read-item-reifier node variant map)))))
+         (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=))
@@ -302,6 +388,19 @@ constructs' complete subgrammars is made. XML errors have already been checked."
       (dolist (child children)
         (when (string= (node-name child) "variant") (read-variant child name map)))
       (topic-maps.tmdm:canonical-topic-name name))))
+(defun read-occurrence (node owner map)
+  ;; XTM 4.13-4.17/4.20: reuse native Topics and the qualified resource path.
+  ;; ADD-OCCURRENCE owns live Parent/Type/Scope handles and TMDM 5.6/6.5 merging.
+  (let* ((children (elements node))
+         (type-node (find "type" children :key #'node-name :test #'string=))
+         (type (find-reference-topic map (reference-iri (first (elements type-node)))))
+         (scope-node (find "scope" children :key #'node-name :test #'string=))
+         (scope (when scope-node (mapcar (lambda (ref) (find-reference-topic map (reference-iri ref)))
+                                        (elements scope-node))))
+         (resource (find-if (lambda (child) (member (node-name child) '("resourceData" "resourceRef") :test #'string=)) children)))
+    (multiple-value-bind (value datatype) (read-resource-value resource)
+      (topic-maps.tmdm:canonical-occurrence
+        (topic-maps.tmdm:add-occurrence owner type value :datatype datatype :scope scope)))))
 (defun read-topic (node map)
   (let ((topic (topic-maps.tmdm:intern-topic map :item-identifier
                  (concatenate 'string *document-iri* "#" (collapse-space (attr node "id"))))))
@@ -310,18 +409,68 @@ constructs' complete subgrammars is made. XML errors have already been checked."
         (cond
           ((string= name "instanceOf") (read-instance-of child topic map))
           ((string= name "name") (read-name child topic map))
+          ((string= name "occurrence") (read-occurrence 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)
-  "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
-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)))
@@ -342,7 +491,11 @@ distinct. No resources are fetched. No externally supplied Map is mutated."
       ;; 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))
-            (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)))
+              ((string= (node-name child) "association") (read-association child map))
+              (t (read-topic child map))))
       map)))