triannon 1.1.0 → 2.0.0

data/app/services/triannon/ldp_loader.rb

@@ -4,29 +4,28 @@ module Triannon
   # Loads an existing Annotation from the LDP server
   class LdpLoader
 
-
+    # @param [String] root_container the LDP parent container for the annotation
     # @param [String] id the unique id of the annotation.  Can include base_uri prefix or omit it.
-    def self.load id
-      l = Triannon::LdpLoader.new id
+    def self.load(root_container, id)
+      l = Triannon::LdpLoader.new(root_container, id)
       l.load_anno_container
       l.load_bodies
       l.load_targets
 
-      oa_graph = Triannon::LdpToOaMapper.ldp_to_oa l.ldp_annotation
+      oa_graph = Triannon::LdpToOaMapper.ldp_to_oa(l.ldp_annotation, root_container)
       oa_graph
     end
 
-    # @deprecated was needed by old annotations#index action, which now redirects to search (2015-04)
-    def self.find_all
-      l = Triannon::LdpLoader.new
-      l.find_all
-    end
-
     attr_accessor :ldp_annotation
 
     # @param [String] id the unique id of the annotation.  Can include base_uri prefix or omit it.
-    def initialize id = nil
+    # @param [String] root_container the LDP parent container for the annotation
+    def initialize(root_container, id = nil)
       @id = id
+      @root_container = root_container
+      if @root_container.blank?
+        fail Triannon::LDPContainerError, "Annotations must be in a root container."
+      end
       base_url = Triannon.config[:ldp]['url']
       base_url.chop! if base_url.end_with?('/')
       container_path = Triannon.config[:ldp]['uber_container']
@@ -37,18 +36,17 @@ module Triannon
       end
       @base_uri = "#{base_url}/#{container_path}"
       @ldp_annotation = Triannon::AnnotationLdp.new
-
     end
 
     # load annotation container object into @ldp_annotation's (our Triannon::AnnotationLdp object) graph
     def load_anno_container
-      load_object_into_annotation_graph(@id)
+      load_object_into_annotation_graph("#{@root_container}/#{@id}")
     end
 
     # load body objects into @ldp_annotation's (our Triannon::AnnotationLdp object) graph
     def load_bodies
       @ldp_annotation.body_uris.each { |body_uri|
-        body_obj_path = body_uri.to_s.split(@base_uri + '/').last
+        body_obj_path = body_uri.to_s.split("#{@base_uri}/").last
         load_object_into_annotation_graph(body_obj_path)
       }
     end
@@ -56,30 +54,11 @@ module Triannon
     # load target objects into @ldp_annotation's (our Triannon::AnnotationLdp object) graph
     def load_targets
       @ldp_annotation.target_uris.each { |target_uri|
-        target_obj_path = target_uri.to_s.split(@base_uri + '/').last
+        target_obj_path = target_uri.to_s.split("#{@base_uri}/").last
         load_object_into_annotation_graph(target_obj_path)
       }
     end
 
-    # @return [Array<Triannon::Annotation>] an array of Triannon::Annotation objects with just the id set. Enough info to build the index page
-    # @deprecated was needed by old annotations#index action, which now redirects to search (2015-04).
-    def find_all
-      root_ttl = get_ttl
-      objs = []
-
-      g = RDF::Graph.new
-      g.from_ttl root_ttl
-      root_uri = RDF::URI.new @base_uri
-      results = g.query [root_uri, RDF::Vocab::LDP.contains, nil]
-      results.each do |stmt|
-        # FIXME:  can't be last with pair trees in fedora urls - leave broke as this method is deprecated
-        id = stmt.object.to_s.split('/').last
-        objs << Triannon::Annotation.new(:id => id)
-      end
-
-      objs
-    end
-
     protected
 
     # given a path to the back end storage url, retrieve the object from storage and load

data/app/services/triannon/ldp_to_oa_mapper.rb

@@ -1,9 +1,11 @@
 module Triannon
   class LdpToOaMapper
 
-    # maps an AnnotationLdp to an OA RDF::Graph
-    def self.ldp_to_oa ldp_anno
-      mapper = Triannon::LdpToOaMapper.new ldp_anno
+    # maps a Triannon::AnnotationLdp to an OA RDF::Graph
+    # @param [Triannon::AnnotationLdp] ldp_anno
+    # @param [String] root_container the LDP parent container for the annotation
+    def self.ldp_to_oa(ldp_anno, root_container)
+      mapper = Triannon::LdpToOaMapper.new(ldp_anno, root_container)
       mapper.extract_base
       mapper.extract_bodies
       mapper.extract_targets
@@ -12,30 +14,32 @@ module Triannon
 
     attr_accessor :id, :oa_graph
 
-    def initialize ldp_anno
+    # @param [Triannon::AnnotationLdp] ldp_anno
+    # @param [String] root_container the LDP parent container for the annotation
+    def initialize(ldp_anno, root_container)
       @ldp_anno = ldp_anno
+      @root_container = root_container
       @ldp_anno_graph = ldp_anno.stripped_graph
       g = RDF::Graph.new
       @oa_graph = OA::Graph.new g
     end
 
+    # load statements from base anno container into @oa_graph
     def extract_base
       root_subject_solns = @ldp_anno_graph.query OA::Graph.anno_query
       if root_subject_solns.count == 1
         stored_url = Triannon.config[:ldp]['url'].strip
         stored_url.chop! if stored_url.end_with?('/')
-        container_path = Triannon.config[:ldp]['uber_container']
-        if container_path
-          container_path.strip!
-          container_path = container_path[1..-1] if container_path.start_with?('/')
-          container_path.chop! if container_path.end_with?('/')
-          stored_url = "#{stored_url}/#{container_path}"
+        uber_container = Triannon.config[:ldp]['uber_container'].strip
+        if uber_container
+          uber_container = uber_container[1..-1] if uber_container.start_with?('/')
+          uber_container.chop! if uber_container.end_with?('/')
+          stored_url = "#{stored_url}/#{uber_container}/#{@root_container}"
         end
         @id = root_subject_solns[0].s.to_s.split("#{stored_url}/").last
-        base_url = Triannon.config[:triannon_base_url]
-        base_url.strip!
+        base_url = Triannon.config[:triannon_base_url].strip
         base_url.chop! if base_url[-1] == '/'
-        @root_uri = RDF::URI.new(base_url + "/#{@id}")
+        @root_uri = RDF::URI.new(base_url + "/#{@root_container}/#{@id}")
       end
 
       @ldp_anno_graph.each_statement do |stmnt|
@@ -49,6 +53,7 @@ module Triannon
       end
     end
 
+    # load statements from anno body containers into @oa_graph
     def extract_bodies
       @ldp_anno.body_uris.each { |body_uri|
         if !map_external_ref(body_uri, RDF::Vocab::OA.hasBody) &&
@@ -59,6 +64,7 @@ module Triannon
       }
     end
 
+    # load statements from anno target containers into @oa_graph
     def extract_targets
       @ldp_anno.target_uris.each { |target_uri|
         if !map_external_ref(target_uri, RDF::Vocab::OA.hasTarget) &&

data/app/services/triannon/ldp_writer.rb

@@ -4,13 +4,13 @@ module Triannon
   class LdpWriter
 
     # use LDP protocol to create the OpenAnnotation.Annotation in an RDF store
-    # @param [Triannon::Annotation] anno a Triannon::Annotation object, from
-    #   which we use the graph
-    def self.create_anno(anno)
+    # @param [Triannon::Annotation] anno a Triannon::Annotation object, from which we use the graph
+    # @param [String] root_container the LDP parent container for the annotation
+    def self.create_anno(anno, root_container)
       if anno && anno.graph
         # TODO:  special case if the Annotation object already has an id --
         #  see https://github.com/sul-dlss/triannon/issues/84
-        ldp_writer = Triannon::LdpWriter.new anno
+        ldp_writer = Triannon::LdpWriter.new anno, root_container
         id = ldp_writer.create_base
 
         bodies_solns = anno.graph.query([nil, RDF::Vocab::OA.hasBody, nil])
@@ -30,8 +30,7 @@ module Triannon
       end
     end
 
-    # deletes the indicated container and all its child containers from the LDP
-    #   store
+    # deletes the indicated container and all its child containers from the LDP store
     # @param [String] id the unique id for the LDP container for an annotation.
     #   May be a compound id, such as  uuid1/t/uuid2, in which case the LDP
     #   container object uuid2 and its children are deleted from the LDP
@@ -39,7 +38,7 @@ module Triannon
     #   the LDP store.
     def self.delete_container id
       if id && id.size > 0
-        ldpw = Triannon::LdpWriter.new nil
+        ldpw = Triannon::LdpWriter.new nil, nil
         ldpw.delete_containers id
       end
     end
@@ -126,35 +125,39 @@ module Triannon
 
 
     # @param [Triannon::Annotation] anno a Triannon::Annotation object
-    # @param [String] id the unique id for the LDP container for the passed
-    #   annotation; defaults to nil
-    def initialize(anno, id = nil)
+    # @param [String] root_container the LDP parent container for the annotation
+    # @param [String] id the unique id for the LDP container for the passed annotation; defaults to nil
+    def initialize(anno, root_container, id = nil)
       @anno = anno
+      @root_container = root_container
       @id = id
       base_url = Triannon.config[:ldp]['url'].strip
       base_url.chop! if base_url.end_with?('/')
-      container_path = Triannon.config[:ldp]['uber_container']
-      if container_path
-        container_path.strip!
-        container_path = container_path[1..-1] if container_path.start_with?('/')
-        container_path.chop! if container_path.end_with?('/')
+      @uber_container_path = Triannon.config[:ldp]['uber_container'].strip
+      if @uber_container_path
+        @uber_container_path = @uber_container_path[1..-1] if @uber_container_path.start_with?('/')
+        @uber_container_path.chop! if @uber_container_path.end_with?('/')
       end
-      @base_uri = "#{base_url}/#{container_path}"
+      @base_uri = "#{base_url}/#{@uber_container_path}"
     end
 
     # creates a stored LDP container for this object's Annotation, without its
     #   targets or bodies (as those are put in descendant containers)
     #   SIDE EFFECT:  assigns the uuid of the container created to @id
-    # @return [String] the unique id for the LDP container created for this
-    #   annotation
+    # @return [String] the unique id for the LDP container created for this annotation
     def create_base
       if @anno.graph.query([nil, RDF::Triannon.externalReference, nil]).count > 0
         fail Triannon::ExternalReferenceError, "Incoming annotations may not have http://triannon.stanford.edu/ns/externalReference as a predicate."
       end
-
       if @anno.graph.id_as_url && @anno.graph.id_as_url.size > 0
         fail Triannon::ExternalReferenceError, "Incoming new annotations may not have an existing id (yet)."
       end
+      if @root_container.blank?
+        fail Triannon::LDPContainerError, "Annotations must be created in a root container."
+      end
+      unless self.class.container_exist? "#{@uber_container_path}/#{@root_container}"
+        fail Triannon::MissingLDPContainerError, "Annotation root container #{@root_container} doesn't exist."
+      end
 
       # TODO:  special case if the Annotation object already has an id --
       #  see https://github.com/sul-dlss/triannon/issues/84
@@ -167,8 +170,9 @@ module Triannon
       g = OA::Graph.new(g)
       g.remove_non_base_statements
       g.make_null_relative_uri_out_of_blank_node
+      g << [RDF::URI.new, RDF.type, RDF::Vocab::LDP.BasicContainer]
 
-      @id = create_resource g.to_ttl
+      @id = create_resource g.to_ttl, @root_container
     end
 
     # creates the LDP container for any and all bodies for this annotation
@@ -202,8 +206,9 @@ module Triannon
       end
       something_deleted = false
       ldp_container_uris.each { |uri|
-        ldp_id = uri.to_s.split(@base_uri + '/').last
-        resp = conn.delete { |req| req.url ldp_id }
+        ldp_id = uri.to_s.split("#{@base_uri}/").last
+        ldp_id = "#{@root_container}/#{ldp_id}" unless @root_container.blank? || ldp_id.match(@root_container)
+        resp = conn.delete { |req| req.url "#{ldp_id}" }
         if resp.status != 204
           fail Triannon::LDPStorageError.new("Unable to delete LDP container #{ldp_id}", resp.status, resp.body)
         end
@@ -214,18 +219,17 @@ module Triannon
 
   protected
 
-    # POSTS a ttl representation of a graph to an existing LDP container in the
-    #   LDP store
-    # @param [String] ttl a turtle representation of RDF data to be put in the
-    #   LDP container
-    # @param [String] parent_path the path portion of the url for the LDP parent
-    #   container for this resource if no path is supplied, then the resource
-    #   will be created as a child of the root annotation; expected paths would
-    #   also be (anno_id)/t  for a target resource (inside the target container
-    #   of anno_id) or (anno_id)/b for a body resource (inside the body
-    #   container of anno_id)
-    # @return [String] path_id representing the unique path of the newly created LDP
-    #   container
+    # POSTS a ttl representation of a graph to an existing LDP container in the LDP store,
+    #   which will cause the LDP store to create a new container that is a child of
+    #   the existing container.
+    # @param [String] ttl a turtle representation of RDF data to be put in the newly created LDP container
+    # @param [String] parent_path the path portion of the url for the LDP parent container for this resource.
+    #   if no path is supplied, then the resource will be created as a child of the root annotation;
+    #   expected paths would also be
+    #     (anno_id)/t  for a target resource (new container to be created inside the target container of anno_id)
+    #     or
+    #     (anno_id)/b for a body resource (new container to be created inside the body container of anno_id)
+    # @return [String] path_id representing the unique path of the newly created LDP container
     def create_resource ttl, parent_path = nil
       return if !ttl || ttl.empty?
 
@@ -243,7 +247,7 @@ module Triannon
         req.body = ttl
       end
       if resp.status != 200 && resp.status != 201
-        fail Triannon::LDPStorageError.new("Unable to create LDP resource in container #{parent_path}; RDF sent: #{ttl}", resp.status, resp.body)
+        fail Triannon::LDPStorageError.new("Unable to create LDP resource in container #{parent_path};\nRDF sent: #{ttl}", resp.status, resp.body)
       end
       new_url = resp.headers['Location'] ? resp.headers['Location'] : resp.headers['location']
       if new_url
@@ -257,37 +261,35 @@ module Triannon
     #   the base container at @id and has the memberRelation per the
     #   oa_vocab_term. The id of the created container will be (base container
     #   id)/b  if hasBody or  (base container id)/t  if hasTarget
-    # @param [RDF::Vocabulary::Term] oa_vocab_term RDF::Vocab::OA.hasTarget or
-    #   RDF::Vocab::OA.hasBody
+    # @param [RDF::Vocabulary::Term] oa_vocab_term RDF::Vocab::OA.hasTarget or RDF::Vocab::OA.hasBody
     def create_direct_container oa_vocab_term
       null_rel_uri = RDF::URI.new
       g = RDF::Graph.new
       g << [null_rel_uri, RDF.type, RDF::Vocab::LDP.DirectContainer]
       g << [null_rel_uri, RDF::Vocab::LDP.hasMemberRelation, oa_vocab_term]
-      g << [null_rel_uri, RDF::Vocab::LDP.membershipResource, RDF::URI.new("#{@base_uri}/#{@id}")]
+      g << [null_rel_uri, RDF::Vocab::LDP.membershipResource, RDF::URI.new("#{@base_uri}/#{@root_container}/#{@id}")]
 
       resp = conn.post do |req|
-        req.url "#{@id}"
+        req.url "#{@root_container}/#{@id}"
         req.headers['Content-Type'] = 'application/x-turtle'
         # OA vocab relationships all of form "hasXXX" so this becomes 't' or 'b'
         req.headers['Slug'] = oa_vocab_term.fragment.slice(3).downcase
         req.body = g.to_ttl
       end
       if resp.status != 201
-        fail Triannon::LDPStorageError.new("Unable to create #{oa_vocab_term.fragment.sub('has', '')} LDP container for anno; RDF sent: #{g.to_ttl}", resp.status, resp.body)
+        fail Triannon::LDPStorageError.new("Unable to create #{oa_vocab_term.fragment.sub('has', '')} LDP container for anno #{@root_container}/#{@id};\nRDF sent: #{g.to_ttl}", resp.status, resp.body)
       end
       resp
     end
 
-    # create the target/body resources inside the (already created) target/body
-    #   container
-    # @param [RDF::URI] predicate either RDF::Vocab::OA.hasTarget or
-    #   RDF::Vocab::OA.hasBody
+    # create the target/body resources inside the (already created) target/body container
+    # @param [RDF::URI] predicate either RDF::Vocab::OA.hasTarget or RDF::Vocab::OA.hasBody
     def create_resources_in_container(predicate)
       predicate_solns = @anno.graph.query([nil, predicate, nil])
       resource_ids = []
       predicate_solns.each { |predicate_stmt |
         graph_for_resource = RDF::Graph.new
+        graph_for_resource << [RDF::URI.new, RDF.type, RDF::Vocab::LDP.BasicContainer]
         predicate_obj = predicate_stmt.object
         if predicate_obj.is_a?(RDF::Node)
           # we need to use the null relative URI representation of blank nodes
@@ -384,10 +386,11 @@ module Triannon
             graph_for_resource.delete(s)
           }
         }
+
         if (predicate == RDF::Vocab::OA.hasTarget)
-          resource_ids << create_resource(graph_for_resource.to_ttl, "#{@id}/t")
+          resource_ids << create_resource(graph_for_resource.to_ttl, "#{@root_container}/#{@id}/t")
         else
-          resource_ids << create_resource(graph_for_resource.to_ttl, "#{@id}/b")
+          resource_ids << create_resource(graph_for_resource.to_ttl, "#{@root_container}/#{@id}/b")
         end
       }
       resource_ids

data/app/services/triannon/solr_searcher.rb

@@ -49,6 +49,12 @@ module Triannon
           when 'bodyexact'
             # no need to Solr escape value because it's in quotes
             q_terms_array << "body_chars_exact:\"#{v}\""
+          when 'bodykeyword'
+            solr_params_hash[:kqf] = 'body_chars_exact^3 body_chars_unstem^2 body_chars_stem'
+            solr_params_hash[:kpf] = 'body_chars_exact^15 body_chars_unstem^10 body_chars_stem^5'
+            solr_params_hash[:kpf3] = 'body_chars_exact^9 body_chars_unstem^6 body_chars_stem^3'
+            solr_params_hash[:kpf2] = 'body_chars_exact^6 body_chars_unstem^4 body_chars_stem^2'
+            q_terms_array << '_query_:"{!dismax qf=$kqf pf=$kpf pf3=$kpf3 pf2=$kpf2}' + RSolr.solr_escape(v) + '"'
           when 'motivatedby'
             case
               when v.include?('#')
@@ -60,12 +66,8 @@ module Triannon
               else
                 fq_terms_array << "motivation:#{RSolr.solr_escape(v)}"
             end
-          when 'bodykeyword'
-            solr_params_hash[:kqf] = 'body_chars_exact^3 body_chars_unstem^2 body_chars_stem'
-            solr_params_hash[:kpf] = 'body_chars_exact^15 body_chars_unstem^10 body_chars_stem^5'
-            solr_params_hash[:kpf3] = 'body_chars_exact^9 body_chars_unstem^6 body_chars_stem^3'
-            solr_params_hash[:kpf2] = 'body_chars_exact^6 body_chars_unstem^4 body_chars_stem^2'
-            q_terms_array << '_query_:"{!dismax qf=$kqf pf=$kpf pf3=$kpf3 pf2=$kpf2}' + RSolr.solr_escape(v) + '"'
+          when 'anno_root'
+            fq_terms_array << "root:#{RSolr.solr_escape(v)}"
 
           # TODO: add'l params to implement:
           # targetType - fq

data/app/services/triannon/solr_writer.rb

@@ -7,16 +7,20 @@ module Triannon
     # Convert a OA::Graph object into a Hash suitable for writing to Solr.
     #
     # @param [OA::Graph] triannon_graph a populated OA::Graph object for a *stored* anno
+    # @param [String] root_container the id of the LDP parent container for the annotation
     # @return [Hash] a hash to be written to Solr, populated appropriately
-    def self.solr_hash(triannon_graph)
+    def self.solr_hash(triannon_graph, root_container)
       doc_hash = {}
       triannon_id = triannon_graph.id_as_url
-      if triannon_id
-        # chars in Solr/Lucene query syntax are a big pain in Solr id fields, so we only use
-        # the uuid portion of the Triannon anno id, not the full url
+      if triannon_id && root_container.present?
+        # we simplify the URL, removing the triannon base_url.  This will only be problematic if
+        #  two different LDP Stores had the same root-container/pair-tree/uuid format AND they were
+        #  both writing to the same Solr index.
         solr_id = triannon_id.sub(Triannon.config[:triannon_base_url], "")
         doc_hash[:id] = solr_id.sub(/^\/*/, "") # remove first char slash(es) if present
 
+        doc_hash[:root] = root_container
+
         # use short strings for motivation field
         doc_hash[:motivation] = triannon_graph.motivated_by.map { |m| m.sub(RDF::Vocab::OA.to_s, "") }
 
@@ -60,8 +64,9 @@ module Triannon
     # Convert the OA::Graph to a Solr document hash, then call RSolr.add
     #  with the doc hash
     # @param [OA::Graph] tgraph anno represented as a OA::Graph
-    def write(tgraph)
-      doc_hash = self.class.solr_hash(tgraph) if tgraph && !tgraph.id_as_url.empty?
+    # @param [String] root the id of the LDP parent container for the annotation
+    def write(tgraph, root)
+      doc_hash = self.class.solr_hash(tgraph, root) if tgraph && !tgraph.id_as_url.empty? && !root.blank?
       add(doc_hash) if doc_hash && !doc_hash.empty?
     end
 

data/app/views/triannon/annotations/new.html.erb

@@ -1 +1,21 @@
-<%= render 'form' %>
+<%= form_for @annotation, url: {action: "create"} do |f| %>
+  <% if @annotation.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@annotation.errors.count, "error") %> prohibited this annotation from being saved:</h2>
+
+      <ul>
+      <% @annotation.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label 'Annotation (as json-ld or turtle)' %><br>
+    <%= f.text_area :data, size: "80x20" %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>