htsworkflow/util/rdfhelp.py

   1 """Helper features for working with librdf
   2 """
   3 import collections
   4 from datetime import datetime
   5 from glob import glob
   6 from urllib.parse import urlparse, urlunparse
   7 from urllib.request import urlopen
   8 import logging
   9 import os
  10 import sys
  11 import types
  12 from pkg_resources import resource_listdir, resource_string
  13
  14 import lxml.html
  15 import lxml.html.clean
  16 import RDF
  17
  18 logger = logging.getLogger(__name__)
  19
  20 from htsworkflow.util.rdfns import *
  21
  22 SCHEMAS_URL='http://jumpgate.caltech.edu/phony/schemas'
  23 INFERENCE_URL='http://jumpgate.caltech.edu/phony/inference'
  24
  25 ISOFORMAT_MS = "%Y-%m-%dT%H:%M:%S.%f"
  26 ISOFORMAT_SHORT = "%Y-%m-%dT%H:%M:%S"
  27
  28 def sparql_query(model, query_filename, output_format='text'):
  29     """Execute sparql query from file
  30     """
  31     logger.info("Opening: %s" % (query_filename,))
  32     query_body = open(query_filename, 'r').read()
  33     query = RDF.SPARQLQuery(query_body)
  34     results = query.execute(model)
  35     if output_format == 'html':
  36         html_query_results(results)
  37     else:
  38         display_query_results(results)
  39
  40
  41 def display_query_results(results):
  42     """A very simple display of sparql query results showing name value pairs
  43     """
  44     for row in results:
  45         for k, v in list(row.items())[::-1]:
  46             print("{0}: {1}".format(k, v))
  47         print()
  48
  49 def html_query_results(result_stream):
  50     from django.conf import settings
  51     from django.template import Context, loader
  52
  53     # I did this because I couldn't figure out how to
  54     # get simplify_rdf into the django template as a filter
  55     class Simplified(object):
  56         def __init__(self, value):
  57             self.simple = simplify_rdf(value)
  58             if value.is_resource():
  59                 self.url = value
  60             else:
  61                 self.url = None
  62
  63     template = loader.get_template('rdf_report.html')
  64     results = []
  65     for row in result_stream:
  66         new_row = collections.OrderedDict()
  67         row_urls = []
  68         for k,v in list(row.items()):
  69             new_row[k] = Simplified(v)
  70         results.append(new_row)
  71     context = Context({'results': results,})
  72     print(template.render(context))
  73
  74 def blankOrUri(value=None):
  75     """Return a blank node for None or a resource node for strings.
  76     """
  77     node = None
  78     if value is None:
  79         node = RDF.Node()
  80     elif type(value) in str:
  81         node = RDF.Node(uri_string=value)
  82     elif isinstance(value, RDF.Node):
  83         node = value
  84
  85     return node
  86
  87
  88 def toTypedNode(value, language="en"):
  89     """Convert a python variable to a RDF Node with its closest xsd type
  90     """
  91     if type(value) == bool:
  92         value_type = xsdNS['boolean'].uri
  93         if value:
  94             value = '1'
  95         else:
  96             value = '0'
  97     elif type(value) in (int, int):
  98         value_type = xsdNS['decimal'].uri
  99         value = str(value)
 100     elif type(value) == float:
 101         value_type = xsdNS['float'].uri
 102         value = str(value)
 103     elif isinstance(value, datetime):
 104         value_type = xsdNS['dateTime'].uri
 105         if value.microsecond == 0:
 106             value = value.strftime(ISOFORMAT_SHORT)
 107         else:
 108             value = value.strftime(ISOFORMAT_MS)
 109     else:
 110         value_type = None
 111         value = str(value)
 112
 113     if value_type is not None:
 114         node = RDF.Node(literal=value, datatype=value_type)
 115     else:
 116         node = RDF.Node(literal=str(value).encode('utf-8'), language=language)
 117     return node
 118
 119
 120 def fromTypedNode(node):
 121     """Convert a typed RDF Node to its closest python equivalent
 122     """
 123     if not isinstance(node, RDF.Node):
 124         return node
 125     if node.is_resource():
 126         return node
 127
 128     value_type = get_node_type(node)
 129     literal = node.literal_value['string']
 130     literal_lower = literal.lower()
 131
 132     if value_type == 'boolean':
 133         if literal_lower in ('1', 'yes', 'true'):
 134             return True
 135         elif literal_lower in ('0', 'no', 'false'):
 136             return False
 137         else:
 138             raise ValueError("Unrecognized boolean %s" % (literal,))
 139     elif value_type == 'integer':
 140         return int(literal)
 141     elif value_type == 'decimal' and literal.find('.') == -1:
 142         return int(literal)
 143     elif value_type in ('decimal', 'float', 'double'):
 144         return float(literal)
 145     elif value_type in ('string'):
 146         return literal
 147     elif value_type in ('dateTime'):
 148         try:
 149             return datetime.strptime(literal, ISOFORMAT_MS)
 150         except ValueError as _:
 151             return datetime.strptime(literal, ISOFORMAT_SHORT)
 152     return literal
 153
 154
 155 def get_node_type(node):
 156     """Return just the base name of a XSD datatype:
 157     e.g. http://www.w3.org/2001/XMLSchema#integer -> integer
 158     """
 159     # chop off xml schema declaration
 160     value_type = node.literal_value['datatype']
 161     if value_type is None:
 162         return "string"
 163     else:
 164         value_type = str(value_type)
 165         return value_type.replace(str(xsdNS[''].uri), '')
 166
 167
 168 def simplify_rdf(value):
 169     """Return a short name for a RDF object
 170     e.g. The last part of a URI or an untyped string.
 171     """
 172     if isinstance(value, RDF.Node):
 173         if value.is_resource():
 174             name = simplify_uri(str(value.uri))
 175         elif value.is_blank():
 176             name = '<BLANK>'
 177         else:
 178             name = value.literal_value['string']
 179     elif isinstance(value, RDF.Uri):
 180         name = split_uri(str(value))
 181     else:
 182         name = value
 183     return str(name)
 184
 185
 186 def simplify_uri(uri):
 187     """Split off the end of a uri
 188
 189     >>> simplify_uri('http://asdf.org/foo/bar')
 190     'bar'
 191     >>> simplify_uri('http://asdf.org/foo/bar#bleem')
 192     'bleem'
 193     >>> simplify_uri('http://asdf.org/foo/bar/')
 194     'bar'
 195     >>> simplify_uri('http://asdf.org/foo/bar?was=foo')
 196     'was=foo'
 197     """
 198     if isinstance(uri, RDF.Node):
 199         if uri.is_resource():
 200             uri = uri.uri
 201         else:
 202             raise ValueError("Can't simplify an RDF literal")
 203     if isinstance(uri, RDF.Uri):
 204         uri = str(uri)
 205
 206     parsed = urlparse(uri)
 207     if len(parsed.query) > 0:
 208         return parsed.query
 209     elif len(parsed.fragment) > 0:
 210         return parsed.fragment
 211     elif len(parsed.path) > 0:
 212         for element in reversed(parsed.path.split('/')):
 213             if len(element) > 0:
 214                 return element
 215     raise ValueError("Unable to simplify %s" % (uri,))
 216
 217 def stripNamespace(namespace, term):
 218     """Remove the namespace portion of a term
 219
 220     returns None if they aren't in common
 221     """
 222     if isinstance(term, RDF.Node):
 223         if  term.is_resource():
 224             term = term.uri
 225         else:
 226             raise ValueError("This works on resources")
 227     elif not isinstance(term, RDF.Uri):
 228         raise ValueError("This works on resources")
 229     term_s = str(term)
 230     if not term_s.startswith(namespace._prefix):
 231         return None
 232     return term_s.replace(namespace._prefix, "")
 233
 234
 235 def get_model(model_name=None, directory=None):
 236     if directory is None:
 237         directory = os.getcwd()
 238
 239     if model_name is None:
 240         storage = RDF.MemoryStorage(options_string="contexts='yes'")
 241         logger.info("Using RDF Memory model")
 242     else:
 243         options = "contexts='yes',hash-type='bdb',dir='{0}'".format(directory)
 244         storage = RDF.HashStorage(model_name,
 245                       options=options)
 246         logger.info("Using {0} with options {1}".format(model_name, options))
 247     model = RDF.Model(storage)
 248     return model
 249
 250
 251 def load_into_model(model, parser_name, path, ns=None):
 252     if type(ns) in str:
 253         ns = RDF.Uri(ns)
 254
 255     if isinstance(path, RDF.Node):
 256         if path.is_resource():
 257             path = str(path.uri)
 258         else:
 259             raise ValueError("url to load can't be a RDF literal")
 260
 261     url_parts = list(urlparse(path))
 262     if len(url_parts[0]) == 0 or url_parts[0] == 'file':
 263         url_parts[0] = 'file'
 264         url_parts[2] = os.path.abspath(url_parts[2])
 265     if parser_name is None or parser_name == 'guess':
 266         parser_name = guess_parser_by_extension(path)
 267     url = urlunparse(url_parts)
 268     logger.info("Opening {0} with parser {1}".format(url, parser_name))
 269
 270     rdf_parser = RDF.Parser(name=parser_name)
 271
 272     statements = []
 273     retries = 3
 274     while retries > 0:
 275         try:
 276             retries -= 1
 277             statements = rdf_parser.parse_as_stream(url, ns)
 278             retries = 0
 279         except RDF.RedlandError as e:
 280             errmsg = "RDF.RedlandError: {0} {1} tries remaining"
 281             logger.error(errmsg.format(str(e), retries))
 282
 283     for s in statements:
 284         conditionally_add_statement(model, s, ns)
 285
 286 def load_string_into_model(model, parser_name, data, ns=None):
 287     ns = fixup_namespace(ns)
 288     logger.debug("load_string_into_model parser={0}, len={1}".format(
 289         parser_name, len(data)))
 290     rdf_parser = RDF.Parser(name=parser_name)
 291
 292     for s in rdf_parser.parse_string_as_stream(data, ns):
 293         conditionally_add_statement(model, s, ns)
 294
 295
 296 def fixup_namespace(ns):
 297     if ns is None:
 298         ns = RDF.Uri("http://localhost/")
 299     elif type(ns) in str:
 300         ns = RDF.Uri(ns)
 301     elif not(isinstance(ns, RDF.Uri)):
 302         errmsg = "Namespace should be string or uri not {0}"
 303         raise ValueError(errmsg.format(str(type(ns))))
 304     return ns
 305
 306
 307 def conditionally_add_statement(model, s, ns):
 308     imports = owlNS['imports']
 309     if s.predicate == imports:
 310         obj = str(s.object)
 311         logger.info("Importing %s" % (obj,))
 312         load_into_model(model, None, obj, ns)
 313     if s.object.is_literal():
 314         value_type = get_node_type(s.object)
 315         if value_type == 'string':
 316             s.object = sanitize_literal(s.object)
 317     model.add_statement(s)
 318
 319
 320 def add_default_schemas(model, schema_path=None):
 321     """Add default schemas to a model
 322     Looks for turtle files in either htsworkflow/util/schemas
 323     or in the list of directories provided in schema_path
 324     """
 325
 326     schemas = resource_listdir(__name__, 'schemas')
 327     for s in schemas:
 328         schema = resource_string(__name__,  'schemas/' + s)
 329         namespace = 'file://localhost/htsworkflow/schemas/'+s
 330         add_schema(model, schema, namespace)
 331
 332     if schema_path:
 333         if type(schema_path) in str:
 334             schema_path = [schema_path]
 335
 336         for path in schema_path:
 337             for pathname in glob(os.path.join(path, '*.turtle')):
 338                 url = 'file://' + os.path.splitext(pathname)[0]
 339                 stream = open(pathname, 'r')
 340                 add_schema(model, stream, url)
 341                 stream.close()
 342
 343 def add_schema(model, schema, url):
 344     """Add a schema to a model.
 345
 346     Main difference from 'load_into_model' is it tags it with
 347     a RDFlib context so I can remove them later.
 348     """
 349     parser = RDF.Parser(name='turtle')
 350     context = RDF.Node(RDF.Uri(SCHEMAS_URL))
 351     for s in parser.parse_string_as_stream(schema, url):
 352         try:
 353             model.append(s, context)
 354         except RDF.RedlandError as e:
 355             logger.error("%s with %s", str(e), str(s))
 356
 357
 358 def remove_schemas(model):
 359     """Remove statements labeled with our schema context"""
 360     context = RDF.Node(RDF.Uri(SCHEMAS_URL))
 361     model.context_remove_statements(context)
 362
 363
 364 def sanitize_literal(node):
 365     """Clean up a literal string
 366     """
 367     if not isinstance(node, RDF.Node):
 368         raise ValueError("sanitize_literal only works on RDF.Nodes")
 369
 370     s = node.literal_value['string']
 371     if len(s) > 0:
 372         element = lxml.html.fromstring(s)
 373         cleaner = lxml.html.clean.Cleaner(page_structure=False)
 374         element = cleaner.clean_html(element)
 375         text = lxml.html.tostring(element)
 376         p_len = 3
 377         slash_p_len = 4
 378
 379         args = {'literal': text[p_len:-slash_p_len]}
 380     else:
 381         args = {'literal': ''}
 382     datatype = node.literal_value['datatype']
 383     if datatype is not None:
 384         args['datatype'] = datatype
 385     language = node.literal_value['language']
 386     if language is not None:
 387         args['language'] = language
 388     return RDF.Node(**args)
 389
 390
 391 def guess_parser(content_type, pathname):
 392     if content_type in ('application/rdf+xml',):
 393         return 'rdfxml'
 394     elif content_type in ('application/x-turtle',):
 395         return 'turtle'
 396     elif content_type in ('text/html',):
 397         return 'rdfa'
 398     elif content_type is None or content_type in ('text/plain',):
 399         return guess_parser_by_extension(pathname)
 400
 401 def guess_parser_by_extension(pathname):
 402     _, ext = os.path.splitext(pathname)
 403     if ext in ('.xml', '.rdf'):
 404         return 'rdfxml'
 405     elif ext in ('.html',):
 406         return 'rdfa'
 407     elif ext in ('.turtle',):
 408         return 'turtle'
 409     return 'guess'
 410
 411 def get_serializer(name='turtle'):
 412     """Return a serializer with our standard prefixes loaded
 413     """
 414     writer = RDF.Serializer(name=name)
 415     # really standard stuff
 416     writer.set_namespace('rdf', rdfNS._prefix)
 417     writer.set_namespace('rdfs', rdfsNS._prefix)
 418     writer.set_namespace('owl', owlNS._prefix)
 419     writer.set_namespace('dc', dcNS._prefix)
 420     writer.set_namespace('xml', xmlNS._prefix)
 421     writer.set_namespace('xsd', xsdNS._prefix)
 422     writer.set_namespace('vs', vsNS._prefix)
 423     writer.set_namespace('wot', wotNS._prefix)
 424
 425     # should these be here, kind of specific to an application
 426     writer.set_namespace('htswlib', libraryOntology._prefix)
 427     writer.set_namespace('ucscSubmission', submissionOntology._prefix)
 428     writer.set_namespace('ucscDaf', dafTermOntology._prefix)
 429     writer.set_namespace('geoSoft', geoSoftNS._prefix)
 430     writer.set_namespace('encode3', encode3NS._prefix)
 431     return writer
 432
 433 def get_turtle_header():
 434     """Return a turtle header with our typical namespaces
 435     """
 436     serializer = get_serializer()
 437     empty = get_model()
 438     return serializer.serialize_model_to_string(empty)
 439
 440 def dump_model(model, destination=None):
 441     if destination is None:
 442         destination = sys.stdout
 443     serializer = get_serializer()
 444     destination.write(serializer.serialize_model_to_string(model))
 445     destination.write(os.linesep)