dsp-tools 0.9.13__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/commands/validate_data/sparql/value_shacl.py

@@ -0,0 +1,357 @@
+from loguru import logger
+from rdflib import RDF
+from rdflib import SH
+from rdflib import XSD
+from rdflib import BNode
+from rdflib import Graph
+from rdflib import Literal
+from rdflib import URIRef
+from rdflib.collection import Collection
+
+from dsp_tools.clients.list_client import OneList
+from dsp_tools.commands.validate_data.models.api_responses import SHACLListInfo
+from dsp_tools.utils.rdf_constants import KNORA_API
+from dsp_tools.utils.rdf_constants import PropertyTypeAlias
+from dsp_tools.utils.rdf_constants import SubjectObjectTypeAlias
+
+
+def construct_property_shapes(onto: Graph, project_lists: list[OneList]) -> Graph:
+    """
+    Returns the sh:PropertyShape for the properties in the ontology.
+
+    Args:
+        onto: ontology graph
+        project_lists: all lists from a project
+
+    Returns:
+        Graph with the property shapes
+    """
+    logger.debug("Constructing property shapes for ontology.")
+    g = Graph()
+    g += _construct_link_value_shape(onto)
+    g += _construct_link_value_node_shape(onto)
+    g += _construct_property_type_text_value(onto)
+    g += _construct_list_shapes(onto, project_lists)
+    g += _construct_seqnum_is_part_of_prop_shape(onto)
+    g += _construct_value_type_shapes_to_class_shapes(onto)
+    g += _construct_link_value_type_shapes_to_class_shapes(onto)
+    return g + _add_property_shapes_to_class_shapes(onto)
+
+
+def _add_property_shapes_to_class_shapes(onto: Graph) -> Graph:
+    logger.debug("Add property shape to resources")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+
+    CONSTRUCT {
+
+      ?class a sh:NodeShape ;
+             sh:property ?propShapesIRI .
+
+    } WHERE {
+
+      ?class a owl:Class ;
+          knora-api:isResourceClass true ;
+          knora-api:canBeInstantiated true ;
+          rdfs:subClassOf ?restriction .
+      ?restriction a owl:Restriction ;          
+          owl:onProperty ?propRestriction .
+
+      ?propRestriction knora-api:isEditable true .
+      FILTER NOT EXISTS { ?propRestriction knora-api:isLinkValueProperty true }
+
+      BIND(IRI(CONCAT(str(?propRestriction), "_PropShape")) AS ?propShapesIRI)
+    }
+    """
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_value_type_shapes_to_class_shapes(onto: Graph) -> Graph:
+    logger.debug("Add value type shape to resources")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+
+    CONSTRUCT {
+
+      ?shapesIRI a sh:PropertyShape ;
+                sh:path ?propRestriction ;
+                sh:class ?objectType ;
+                sh:message ?objectTypeMessage .
+
+    } WHERE {
+
+      ?class a owl:Class ;
+          knora-api:isResourceClass true ;
+          knora-api:canBeInstantiated true ;
+          rdfs:subClassOf ?restriction .
+      ?restriction a owl:Restriction ;          
+          owl:onProperty ?propRestriction .
+
+      ?propRestriction knora-api:isEditable true ;
+                       knora-api:objectType ?objectType .
+
+      FILTER NOT EXISTS { ?propRestriction knora-api:isLinkProperty true }
+      FILTER NOT EXISTS { ?propRestriction knora-api:isLinkValueProperty true }
+
+      BIND(IRI(CONCAT(str(?propRestriction), "_PropShape")) AS ?shapesIRI)
+      BIND(CONCAT("This property requires a ", STRAFTER(STR(?objectType), "#")) AS ?objectTypeMessage)
+    }
+    """
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_link_value_type_shapes_to_class_shapes(onto: Graph) -> Graph:
+    logger.debug("Add value type shape to resources")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+
+    CONSTRUCT {
+
+      ?shapesIRI a sh:PropertyShape ;
+                 sh:path ?propRestriction ;
+                 sh:class knora-api:LinkValue ;
+                 sh:message "This property requires a LinkValue" .
+
+    } WHERE {
+
+      ?class a owl:Class ;
+          knora-api:isResourceClass true ;
+          knora-api:canBeInstantiated true ;
+          rdfs:subClassOf ?restriction .
+      ?restriction a owl:Restriction ;          
+          owl:onProperty ?propRestriction .
+
+      ?propRestriction knora-api:isEditable true ;
+                       knora-api:isLinkProperty true .
+
+      BIND(IRI(CONCAT(str(?propRestriction), "_PropShape")) AS ?shapesIRI)
+    }
+    """
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_link_value_shape(onto: Graph) -> Graph:
+    logger.debug("Constructing LinkValue PropertyShape")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+    PREFIX salsah-gui: <http://api.knora.org/ontology/salsah-gui/v2#>
+
+    CONSTRUCT {
+
+        ?shapesIRI a sh:PropertyShape ;
+                   sh:path ?prop ;
+                   sh:node ?nodeShapeIRI .
+
+    } WHERE {
+
+        ?prop a owl:ObjectProperty ;
+                salsah-gui:guiElement salsah-gui:Searchbox .
+
+        BIND(IRI(CONCAT(str(?prop), "_PropShape")) AS ?shapesIRI)
+        BIND(IRI(CONCAT(str(?prop), "_NodeShape")) AS ?nodeShapeIRI)
+    }
+    """
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_link_value_node_shape(onto: Graph) -> Graph:
+    logger.debug("Constructing LinkValue NodeShape")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+    PREFIX salsah-gui: <http://api.knora.org/ontology/salsah-gui/v2#>
+
+    CONSTRUCT {
+
+        ?nodeShapeIRI a sh:NodeShape ;
+            sh:property    [
+                                a            sh:PropertyShape ;
+                                sh:path      api-shapes:linkValueHasTargetID ;
+                                sh:class     ?rangeClass ;
+                                sh:message   ?msg 
+                            ] ;
+            sh:severity    sh:Violation .
+
+    } WHERE {
+
+        ?prop a owl:ObjectProperty ;
+                knora-api:isLinkProperty true ;
+                knora-api:objectType ?rangeClass .
+
+        BIND(IRI(CONCAT(str(?prop), "_NodeShape")) AS ?nodeShapeIRI)
+        BIND(CONCAT("Range is ", str(?rangeClass), " or a subclass") AS ?msg)
+    }
+    """
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_property_type_text_value(onto: Graph) -> Graph:
+    property_type_mapper = {
+        "salsah-gui:SimpleText": "api-shapes:SimpleTextValue_ClassShape",
+        "salsah-gui:Textarea": "api-shapes:TextareaTextValue_ClassShape",
+        "salsah-gui:Richtext": "api-shapes:FormattedTextValue_ClassShape",
+    }
+    g = Graph()
+    for object_type, shacl_shape in property_type_mapper.items():
+        g += _construct_one_property_type_text_value(onto, object_type, shacl_shape)
+    return g
+
+
+def _construct_one_property_type_text_value(onto: Graph, gui_element: str, shacl_shape: str) -> Graph:
+    logger.debug(f"Constructing shape for {gui_element}")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+    PREFIX salsah-gui: <http://api.knora.org/ontology/salsah-gui/v2#>
+
+    CONSTRUCT {
+
+        ?shapesIRI a sh:PropertyShape ;
+                   sh:path ?prop ;
+                   sh:node %(shacl_shape)s .
+
+    } WHERE {
+
+        ?prop a owl:ObjectProperty ;
+                knora-api:objectType knora-api:TextValue ;
+                salsah-gui:guiElement %(gui_element)s .
+
+        BIND(IRI(CONCAT(str(?prop), "_PropShape")) AS ?shapesIRI)
+    }
+    """ % {"gui_element": gui_element, "shacl_shape": shacl_shape}  # noqa: UP031 (printf-string-formatting)
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_list_shapes(onto: Graph, project_lists: list[OneList]) -> Graph:
+    lists_graph = Graph()
+    for one_list in project_lists:
+        lists_graph += _construct_one_list_node_shape(one_list)
+    for one_list in project_lists:
+        lists_graph += _construct_one_list_property_shape(onto, one_list)
+    return lists_graph
+
+
+def _construct_one_list_node_shape(one_list: OneList) -> Graph:
+    g = Graph()
+    list_iri = URIRef(one_list.list_iri)
+    g.add((list_iri, RDF.type, SH.NodeShape))
+    g.add((list_iri, SH.severity, SH.Violation))
+    list_iris = [nd.iri for nd in one_list.nodes]
+    node_prop_info = SHACLListInfo(
+        list_iri=list_iri,
+        sh_path=KNORA_API.listValueAsListNode,
+        sh_message=(
+            f"A valid node from the list '{one_list.list_name}' must be used with this property "
+            f"(input displayed in format 'listName / NodeName')."
+        ),
+        sh_in=list_iris,
+    )
+    g += _construct_one_list_property_shape_with_collection(node_prop_info)
+    return g
+
+
+def _construct_one_list_property_shape_with_collection(shacl_info: SHACLListInfo) -> Graph:
+    g = Graph()
+    collection_bn = BNode()
+    collection_literals: list[SubjectObjectTypeAlias] = [Literal(lit, datatype=XSD.string) for lit in shacl_info.sh_in]
+    Collection(g, collection_bn, collection_literals)
+    prop_shape: list[tuple[PropertyTypeAlias, SubjectObjectTypeAlias]] = [
+        (RDF.type, SH.PropertyShape),
+        (SH.path, shacl_info.sh_path),
+        (URIRef("http://www.w3.org/ns/shacl#in"), collection_bn),
+        (SH.message, Literal(shacl_info.sh_message, datatype=XSD.string)),
+    ]
+    prop_bn: SubjectObjectTypeAlias = BNode()
+    for prop, obj in prop_shape:
+        g.add((prop_bn, prop, obj))
+    g.add((shacl_info.list_iri, SH.property, prop_bn))
+    return g
+
+
+def _construct_one_list_property_shape(onto: Graph, one_list: OneList) -> Graph:
+    logger.debug(f"Constructing Collection Shape for ListValue: {one_list.list_iri}")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+    PREFIX salsah-gui: <http://api.knora.org/ontology/salsah-gui/v2#>
+
+    CONSTRUCT {
+        ?shapesIRI a sh:PropertyShape ;
+                   sh:path ?prop ;
+                   sh:node <%(list)s> ;
+                   sh:severity sh:Violation .
+    } WHERE {
+        ?prop a owl:ObjectProperty ;
+              knora-api:objectType knora-api:ListValue ;
+              salsah-gui:guiAttribute %(guiAttribute)s .
+
+        BIND(IRI(CONCAT(str(?prop), "_PropShape")) AS ?shapesIRI)
+    }
+    """ % {"guiAttribute": one_list.hlist(), "list": one_list.list_iri}  # noqa: UP031 (printf-string-formatting)
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()
+
+
+def _construct_seqnum_is_part_of_prop_shape(onto: Graph) -> Graph:
+    logger.debug("Constructing Collection Shape seqnum / isPartOf")
+    query_s = """
+    PREFIX owl: <http://www.w3.org/2002/07/owl#> 
+    PREFIX sh: <http://www.w3.org/ns/shacl#>
+    PREFIX dash: <http://datashapes.org/dash#>
+    PREFIX api-shapes: <http://api.knora.org/ontology/knora-api/shapes/v2#>
+    PREFIX knora-api:  <http://api.knora.org/ontology/knora-api/v2#>
+    PREFIX salsah-gui: <http://api.knora.org/ontology/salsah-gui/v2#>
+
+    CONSTRUCT {
+        ?resourceClass sh:property api-shapes:seqnum_PropShape .
+    } WHERE {
+        ?resourceClass rdfs:subClassOf ?restriction .
+        ?restriction a owl:Restriction .
+        {
+            ?restriction owl:onProperty knora-api:seqnum .
+        }
+        UNION
+        {
+            ?restriction owl:onProperty knora-api:isPartOf .
+        }
+    }
+    """
+    # The API allows the ontology to declare cardinalities for seqnum without isPartOf and vice versa.
+    # Therefore, we have a union query.
+    if results_graph := onto.query(query_s).graph:
+        return results_graph
+    return Graph()

dsp_tools/commands/validate_data/utils.py

@@ -0,0 +1,59 @@
+import shutil
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from dsp_tools.utils.rdf_constants import SubjectObjectTypeAlias
+
+
+def get_temp_directory() -> TemporaryDirectory[str]:
+    ttl_dir = (Path.home() / ".dsp-tools" / "validate-data").absolute()
+    ttl_dir.mkdir(exist_ok=True, parents=True)
+    t_dir = TemporaryDirectory(dir=ttl_dir)
+    return t_dir
+
+
+def clean_up_temp_directory(temp_dir: TemporaryDirectory[str], save_graphs_dir: Path | None) -> None:
+    if save_graphs_dir:
+        tmp_folder = Path(temp_dir.name)
+        save_graphs_dir.mkdir(parents=True, exist_ok=True)
+        for tmp_filepath in tmp_folder.glob("*"):
+            if tmp_filepath.is_file():
+                dest_filepath = save_graphs_dir / tmp_filepath.relative_to(tmp_folder)
+                shutil.copy2(tmp_filepath, dest_filepath)
+    temp_dir.cleanup()
+
+
+def reformat_any_iri(iri: SubjectObjectTypeAlias | str) -> str:
+    """
+    Reformats any kind of IRI, if it starts with data then it treats is like a data IRI.
+    Otherwise, like an ontology IRI.
+
+    Args:
+        iri: Input IRI
+
+    Returns:
+        reformatted string
+    """
+    iri_str = str(iri)
+    if iri_str.startswith("http://data/"):
+        return reformat_data_iri(iri_str)
+    if iri_str.startswith("http://rdfh.ch/"):
+        return iri_str
+    return reformat_onto_iri(iri_str)
+
+
+def reformat_onto_iri(iri: SubjectObjectTypeAlias | str) -> str:
+    """Takes a rdflib Node and returns a prefixed IRI in string form."""
+    iri_str = str(iri)
+    if "http://www.w3.org/2000/01/rdf-schema#" in iri_str:
+        return f"rdfs:{iri_str.split('#')[-1]}"
+    onto = iri_str.split("/")[-2]
+    ending = iri_str.split("#")[-1]
+    if onto == "knora-api":
+        return ending
+    return f"{onto}:{ending}"
+
+
+def reformat_data_iri(iri: SubjectObjectTypeAlias | str) -> str:
+    """Takes a rdflib Node with in the data namespace and returns only the suffix."""
+    return str(iri).replace("http://data/", "", 1)