X-Git-Url: https://dreyeck.freedombox.rocks/gitweb/topic-maps.git/blobdiff_plain/7f4aa941293e555ccb9d96f0c05c651b0549a866..b2eecffa05de4fce41c10ae1ada9ae11a0c6e7dc:/src/xtm/reader.lisp?ds=inline diff --git a/src/xtm/reader.lisp b/src/xtm/reader.lisp index 069ced3..d8b15a3 100644 --- a/src/xtm/reader.lisp +++ b/src/xtm/reader.lisp @@ -1,5 +1,7 @@ (in-package #:topic-maps.xtm) +(defparameter +any-type+ "http://www.w3.org/2001/XMLSchema#anyType") + (defparameter +namespace+ "http://www.topicmaps.org/xtm/") ;; This is a source tree of XML events, not a second Topic Maps object model. ;; Positions are SAX approximations at the end of a start tag, never byte spans. @@ -25,6 +27,67 @@ (let ((node (pop (handler-stack h)))) (setf (node-children node) (nreverse (node-children node))))) (defmethod sax:end-document ((h source-handler)) (handler-root h)) +;;; Document-local association, not a second XML or Topic Maps model. The +;;; opaque context is NEVER supplied by callers or reused between documents. +(defstruct xml-resource-binding document-iri source-key original snapshot nodes indices values) +(defvar *xml-resource-binding* nil) +(defun source-resource-nodes (node) + ;; Same expanded-name predicate and complete preorder as XML's documented + ;; RESOURCE-DATA-COUNT / CANONICALIZE-RESOURCE-DATA. Do not count only anyType + ;; or skip foreign subtrees: every resourceData slot affects the ordinal. + (append (when (and (equal (node-uri node) +namespace+) (equal (node-name node) "resourceData")) (list node)) + (loop for child in (node-children node) unless (stringp child) append (source-resource-nodes child)))) +(defun resource-association-error (detail) + ;; Internal association failure, not a claim that valid XTM is syntactically + ;; invalid. There is no native source span for this invariant; use NIL. + (error 'xtm-xml-error :code :resource-data-association :detail detail :cause nil + :document-iri *document-iri* :source-key *source-key* :line nil :column nil)) +(defun prepare-xml-resources (root original snapshot) + (let* ((nodes (coerce (source-resource-nodes root) 'vector)) + (any (find +any-type+ nodes :test #'equal :key (lambda (n) (attr n "datatype"))))) + (when any + (unless (equalp original snapshot) (resource-association-error "Original XML octets changed after source parsing.")) + ;; Provenance is established by construction: this private call uses only + ;; the octet snapshot taken BEFORE parsing this source tree. No DOM/private + ;; XML API or reconstructed XML is used for association or canonicalization. + (let* ((context (topic-maps.xml:parse-canonical-context snapshot)) + (indices (make-hash-table :test #'eq)) + (values (make-array (length nodes) :initial-element nil))) + (unless (= (length nodes) (topic-maps.xml:resource-data-count context)) + (resource-association-error "Source/context resourceData inventories disagree.")) + (loop for n across nodes for i from 0 do + (when (nth-value 1 (gethash n indices)) (resource-association-error "Source resourceData node occurs twice.")) + (setf (gethash n indices) i) + (when (equal (attr n "datatype") +any-type+) + (setf (aref values i) + (handler-case (topic-maps.xml:canonicalize-resource-data context :index i) + (topic-maps.xml:canonicalization-error (c) + (error 'xtm-xml-error :code (topic-maps.xml:canonicalization-error-code c) + :detail (princ-to-string c) :cause c :document-iri *document-iri* :source-key *source-key* + :line nil :column nil)))))) + (unless (equalp original snapshot) (resource-association-error "Original XML octets changed during context preparation.")) + (make-xml-resource-binding :document-iri (copy-seq *document-iri*) :source-key (if (stringp *source-key*) (copy-seq *source-key*) *source-key*) + :original original :snapshot snapshot :nodes nodes :indices indices :values values))))) +(defun bound-xml-value (node) + (let ((b *xml-resource-binding*)) + (unless (and b (equal *document-iri* (xml-resource-binding-document-iri b)) + (equal *source-key* (xml-resource-binding-source-key b)) + (equalp (xml-resource-binding-original b) (xml-resource-binding-snapshot b))) + (resource-association-error "No matching immutable XML document frame.")) + (multiple-value-bind (index found) (gethash node (xml-resource-binding-indices b)) + (unless (and found (typep index '(integer 0 *)) (< index (length (xml-resource-binding-nodes b))) + (eq node (aref (xml-resource-binding-nodes b) index)) + (stringp (aref (xml-resource-binding-values b) index))) + (resource-association-error "resourceData is not owned by this document/ordinal.")) + (aref (xml-resource-binding-values b) index)))) +(defun validate-embedded-markup (node) + ;; XTM 4.3.1 any-markup excludes elements in the XTM namespace at EVERY + ;; depth; arbitrary foreign elements/attributes remain XML, not XTM syntax. + (when (equal (node-uri node) +namespace+) + (reject :embedded-xtm-element "XTM elements cannot occur inside embedded XML." node)) + (dolist (child (node-children node)) + (unless (stringp child) (validate-embedded-markup child)))) + (defun xml-space-p (c) (find c '(#\Space #\Tab #\Newline #\Return))) (defun collapse-space (text) ;; xsd:ID has whiteSpace=collapse, even with a non-validating XML processor. @@ -177,8 +240,7 @@ constructs' complete subgrammars is made. XML errors have already been checked." ((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)) + (resolve-iri (attr node "reifier") *document-iri* node)) (let ((phase 0) (type-seen nil) (scope-seen nil) (resource-seen nil)) (dolist (child (elements node)) (check-namespace child) @@ -191,9 +253,7 @@ constructs' complete subgrammars is made. XML errors have already been checked." (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 "itemIdentity") nil) ((string= kind "type") (when type-seen (reject :duplicate-occurrence-type "Only one occurrence type is allowed." child)) (setf type-seen t)) @@ -205,9 +265,46 @@ constructs' complete subgrammars is made. XML errors have already been checked." (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")))) + (validate child '("itemIdentity" "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)) + (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") nil) + ((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 '("itemIdentity" "type" "scope" "role") '("itemIdentity" "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) @@ -217,12 +314,11 @@ constructs' complete subgrammars is made. XML errors have already been checked." (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))) + (validate-decoded-reference (unescape-reference datatype node) node)) (dolist (child (node-children node)) (unless (stringp child) - (reject :unexpected-child "Textual resourceData cannot contain child elements." child))))) + (if (equal datatype +any-type+) (validate-embedded-markup child) + (reject :unexpected-child "Textual resourceData cannot contain child elements." child)))))) ((string= name "type") (attributes node nil nil) (let ((refs (elements node))) @@ -277,19 +373,57 @@ 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-item-identities (node item) + ;; XTM 4.6: assign locators to the actual canonical item, never intern Topics. + ;; ADD-ITEM-IDENTIFIER owns set semantics and cross-item conflict checks. + (dolist (child (elements node) item) + (when (string= (node-name child) "itemIdentity") + (setf item (topic-maps.tmdm:add-item-identifier item (leaf-href child)))))) +(defun read-association (node map) + ;; Resolve references in source order, then construct the complete native + ;; Association. The constructor may already merge Associations AND Roles. + (let ((type nil) (scope nil) (roles nil) (role-nodes 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 (find "type" children :key #'node-name :test #'string=)) + (reference (find "topicRef" children :key #'node-name :test #'string=))) roles) + (push child role-nodes))))) + (let ((association (read-item-identities node + (topic-maps.tmdm:make-association map type (reverse roles) :scope scope)))) + ;; Match source metadata to the native Role by its complete signature + ;; within THIS canonical Parent. Role order/II are not equality keys. + (loop for pair in (reverse roles) for source in (reverse role-nodes) do + ;; A preceding Role Reifier may have merged Topics and this Parent. + (setf association (topic-maps.tmdm:canonical-association association)) + (let ((role (find-if (lambda (role) + (and (eq (topic-maps.tmdm:association-role-type role) + (topic-maps.tmdm:canonical-topic (first pair))) + (eq (topic-maps.tmdm:association-role-player role) + (topic-maps.tmdm:canonical-topic (second pair))))) + (topic-maps.tmdm:association-roles association)))) + (setf role (read-item-identities source role)) + (read-item-reifier source (topic-maps.tmdm:canonical-association-role role) map))) + ;; Role metadata is now on the native canonical Parent. Reifier merging + ;; may normalize it again; return the resulting Association handle. + (topic-maps.tmdm:canonical-association + (read-item-reifier node association map)))))) (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." +This operation neither looks up Topics nor fetches resources. ANYTYPE values +come only from the checked document-local XML binding. Preserve 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)))) + (let ((datatype (or (attr resource "datatype") (topic-maps.tmdm:string-datatype)))) + (if (equal datatype +any-type+) (values (bound-xml-value resource) datatype) + (let ((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=)) @@ -299,9 +433,7 @@ by source validation before model construction. Preserve other datatype IRIs." ;; 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))))) + (setf variant (read-item-identities node variant)) ;; 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) @@ -322,9 +454,7 @@ by source validation before model construction. Preserve other datatype IRIs." (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))))) + (setf name (read-item-identities node name)) ;; 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. @@ -344,7 +474,11 @@ by source validation before model construction. Preserve other datatype IRIs." (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))))) + ;; Resolve Reifier by II only after native Occurrence normalization and + ;; II assignment. Reifier merging can normalize again: return its handle. + (read-item-reifier node + (read-item-identities node + (topic-maps.tmdm:add-occurrence owner type value :datatype datatype :scope scope)) 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")))))) @@ -417,6 +551,7 @@ is mutated. Each public call has its own resource recursion context." (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) + (*xml-resource-binding* nil) (snapshot (copy-seq bytes)) (handler (make-instance 'source-handler))) (require-document-iri document-iri) (let* ((root @@ -432,6 +567,7 @@ is mutated. Each public call has its own resource recursion context." :line (sax:line-number handler) :column (sax:column-number handler))))) (map (topic-maps.tmdm:make-topic-map))) (validate-source root) + (setf *xml-resource-binding* (prepare-xml-resources root bytes snapshot)) ;; The attribute is processed before itemIdentity and later Topic nodes. (read-map-reifier root map) (dolist (child (elements root)) @@ -440,5 +576,6 @@ is mutated. Each public call has its own resource recursion context." ((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)))