triannon 1.1.0 → 2.0.0

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

@@ -24,4 +24,4 @@
 <%= @annotation.jsonld_iiif %>
 </pre>
 
-<%= link_to "Back to List", annotations_path %>
+<%= link_to "Back to List", annotations_path(anno_root: @annotation.root_container) %>

data/config/routes.rb

@@ -1,31 +1,82 @@
 Triannon::Engine.routes.draw do
 
-  resources :annotations, except: [:update, :edit],
-    # show action must explicitly forbid "new", "iiif" and "oa" as id values;  couldn't
-    #   figure out how to do it with regexp constraint since beginning and end regex
-    #   matchers aren't allowed when enforcing formats for segment (e.g. :id)
-    constraints: lambda { |request|
-                            id = request.env["action_dispatch.request.path_parameters"][:id]
-                            id !~ /^iiif$/ && id !~ /^oa$/ && id !~ /^search$/
-                 } do
-    collection do
-      get 'search', to: 'search#find'
-    end
-  end
+  # 1. can't use resourceful routing because of :anno_root (dynamic path segment)
 
+  # 2. couldn't figure out how to exclude specific values with regexp constraint since beginning and end regex matchers
+  #    aren't allowed when enforcing formats for path segment (i.e. :anno_root, :id)
+
+  # get -> new action
+  get '/annotations/:anno_root/new', to: 'annotations#new'
+  get '/:anno_root/new', to: 'annotations#new',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      id = request.path_parameters[:id]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/ && id !~ /^search$/ && id !~ /^new$/
+    }
+
+  # get -> search controller find action
+  get '/annotations/:anno_root/search', to: 'search#find'
+  get '/annotations/search', to: 'search#find'
+  get '/:anno_root/search', to: 'search#find',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
   get '/search', to: 'search#find'
 
-  root to: 'search#find'
+  # get w id -> show action
+  get '/annotations/:anno_root/:id(.:format)', to: 'annotations#show',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
+  get '/:anno_root/:id(.:format)', to: 'annotations#show',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      id = request.path_parameters[:id]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/ && id !~ /^search$/ && id !~ /^new$/
+    }
 
-  # allow jsonld context in path (only allow iiif or oa as values)
-  #   must explicitly forbid "new" as id values;  couldn't figure
-  #   out how to do it with regexp constraint since beginning and end regex
-  #   matchers aren't allowed when enforcing formats for segment (e.g. :id)
-  get '/annotations/:jsonld_context/:id(.:format)', to: 'annotations#show',
+  # get no id -> index action
+  get '/annotations/:anno_root', to: 'annotations#index',
     constraints: lambda { |request|
-                          jsonld_context = request.env["action_dispatch.request.path_parameters"][:jsonld_context]
-                          id = request.env["action_dispatch.request.path_parameters"][:id]
-                          (jsonld_context =~ /^iiif$/ || jsonld_context =~ /^oa$/ ) && id !~ /^new$/
-                 }
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
+  get '/:anno_root', to: 'annotations#index',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
+
+  # post -> create action
+  post '/annotations/:anno_root', to: 'annotations#create',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      id = request.path_parameters[:id]
+      anno_root !~ /^search$/ && anno_root !~ /^new$/ && id !~ /^search$/ && id !~ /^new$/
+    }
+  post '/:anno_root', to: 'annotations#create',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
+
+  # delete -> destroy action
+  delete '/annotations/:anno_root/:id(.:format)', to: 'annotations#destroy',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      id = request.path_parameters[:id]
+      anno_root !~ /^search$/ && anno_root !~ /^new$/ && id !~ /^search$/ && id !~ /^new$/
+    }
+  delete '/:anno_root/:id(.:format)', to: 'annotations#destroy',
+    constraints: lambda { |request|
+      anno_root = request.path_parameters[:anno_root]
+      anno_root !~ /^annotations$/ && anno_root !~ /^search$/ && anno_root !~ /^new$/
+    }
+
+
+  get '/annotations', to: 'search#find'
+  root to: 'search#find'
 
 end

data/config/solr/log4j.properties

@@ -0,0 +1,25 @@
+#  Logging level
+solr.log=logs/
+log4j.rootLogger=INFO, file, CONSOLE
+
+# Log warnings to the console
+log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
+log4j.appender.CONSOLE.Threshold=WARN
+log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
+log4j.appender.CONSOLE.layout.ConversionPattern=%-4r [%t] %-5p %c %x \u2013 %m%n
+
+#- size rotation with log cleanup.
+log4j.appender.file=org.apache.log4j.RollingFileAppender
+log4j.appender.file.MaxFileSize=4MB
+log4j.appender.file.MaxBackupIndex=9
+
+#- File to log to and log format
+log4j.appender.file.File=${solr.log}/solr.log
+log4j.appender.file.layout=org.apache.log4j.PatternLayout
+log4j.appender.file.layout.ConversionPattern=%-5p - %d{yyyy-MM-dd HH:mm:ss.SSS}; %C; %m\n
+
+log4j.logger.org.apache.zookeeper=WARN
+log4j.logger.org.apache.hadoop=WARN
+
+# set to INFO to enable infostream log messages
+log4j.logger.org.apache.solr.update.LoggingInfoStream=OFF

data/config/solr/solr.xml

@@ -29,8 +29,10 @@
     If 'null' (or absent), cores will not be manageable via REST
   -->
   <cores adminPath="/admin/cores" defaultCoreName="development">
+<!--  don't need development or test cores for triannon
     <core name="development" instanceDir="development-core" />
     <core name="test" instanceDir="test-core" />
+-->
     <core name="triannon" instanceDir="triannon-core" />
   </cores>
 </solr>

data/config/solr/triannon-core/conf/schema.xml

@@ -10,6 +10,8 @@
     <field name="id" type="string" stored="true" indexed="true" multiValued="false" required="true"/>
     <field name="timestamp" type="date" stored="true" indexed="true" multiValued="false" default="NOW"/>
 
+    <field name="root" type="string" stored="true" indexed="true" multiValued="false"/>
+
     <field name="motivation" type="string" stored="true" indexed="true" multiValued="true"/>
     <!-- date field format: 1995-12-31T23:59:59Z; or w fractional seconds: 1995-12-31T23:59:59.999Z -->
     <field name="annotated_at" type="date" stored="true" indexed="true" multiValued="false"/>

data/config/solr/triannon-core/conf/solrconfig.xml

@@ -4,11 +4,15 @@
      this file, see http://wiki.apache.org/solr/SolrConfigXml. 
 -->
 <config>
-  <luceneMatchVersion>4.7</luceneMatchVersion>
+  <luceneMatchVersion>4.10.4</luceneMatchVersion>
+
+  <!-- solr lib dirs -->
+  <lib dir="../lib/contrib/analysis-extras/lib" />
+  <lib dir="../lib/contrib/analysis-extras/lucene-libs" />
 
   <dataDir>${solr.data.dir:}</dataDir>
 
-  <directoryFactory name="DirectoryFactory" class="${solr.directoryFactory:solr.NRTCachingDirectoryFactory}"/>
+  <directoryFactory name="DirectoryFactory" class="${solr.directoryFactory:solr.StandardDirectoryFactory}"/>
   <codecFactory class="solr.SchemaCodecFactory"/>
   <schemaFactory class="ClassicIndexSchemaFactory"/>
 
@@ -24,7 +28,7 @@
       <str name="dir">${solr.data.dir:}</str>
     </updateLog>
     <autoCommit>
-      <maxTime>15000</maxTime>
+      <maxTime>3000</maxTime>
       <openSearcher>false</openSearcher>
     </autoCommit>
   </updateHandler>
@@ -42,21 +46,23 @@
          It should only have the most common facets -->
     <listener event="newSearcher" class="solr.QuerySenderListener">
       <arr name="queries">
-		<lst>
+        <lst>
           <!-- default query for all objects: populate facet caches -->
           <int name="rows">0</int>
           <str name="fl">score</str>
           <bool name="facet">true</bool>
           <int name="facet.mincount">1</int>
+          <str name="facet.field">root</str>
+            <str name="f.root.facet.method">enum</str>
           <str name="facet.field">motivation</str>
-		    <str name="f.motivation.facet.method">enum</str>
+            <str name="f.motivation.facet.method">enum</str>
           <str name="facet.field">target_type</str>
             <str name="f.target_type.facet.method">enum</str>
           <str name="facet.field">body_type</str>
             <str name="f.body_type.facet.method">enum</str>
           <str name="facet.field">annotated_at_tdate</str>
         </lst>
-		<lst>
+        <lst>
           <!-- single object query: populate filter and fieldValue caches -->
           <str name="q">id:a*</str>
           <str name="defType">lucene</str>
@@ -64,11 +70,13 @@
           <str name="fl">score</str>
           <bool name="facet">true</bool>
           <int name="facet.mincount">1</int>
+          <str name="facet.field">root</str>
+            <str name="f.root.facet.method">enum</str>
           <str name="facet.field">motivation</str>
             <str name="f.motivation.facet.method">enum</str>
           <str name="facet.field">target_type</str>
             <str name="f.target_type.facet.method">enum</str>
-		  <str name="facet.field">body_type</str>
+          <str name="facet.field">body_type</str>
             <str name="f.body_type.facet.method">enum</str>
           <str name="facet.field">annotated_at_tdate</str>
         </lst>
@@ -78,20 +86,22 @@
     <!-- A First Searcher is opened when there is _no_ existing (current) Searcher. ("fast warmup") -->
     <listener event="firstSearcher" class="solr.QuerySenderListener">
       <arr name="queries">
-		<lst>
+        <lst>
           <!-- default query for all objects: populate facet caches -->
           <int name="rows">0</int>
           <str name="fl">score</str>
           <bool name="facet">true</bool>
           <int name="facet.mincount">1</int>
+          <str name="facet.field">root</str>
+            <str name="f.root.facet.method">enum</str>
           <str name="facet.field">motivation</str>
             <str name="f.motivation.facet.method">enum</str>
           <str name="facet.field">target_type</str>
             <str name="f.target_type.facet.method">enum</str>
-		  <str name="facet.field">body_type</str>
+          <str name="facet.field">body_type</str>
             <str name="f.body_type.facet.method">enum</str>
         </lst>
-		<lst>
+        <lst>
           <!-- single object query: populate filter and fieldValue caches -->
           <str name="q">id:a*</str>
           <str name="defType">lucene</str>
@@ -99,11 +109,13 @@
           <str name="fl">score</str>
           <bool name="facet">true</bool>
           <int name="facet.mincount">1</int>
+          <str name="facet.field">root</str>
+            <str name="f.root.facet.method">enum</str>
           <str name="facet.field">motivation</str>
             <str name="f.motivation.facet.method">enum</str>
           <str name="facet.field">target_type</str>
             <str name="f.target_type.facet.method">enum</str>
-		  <str name="facet.field">body_type</str>
+          <str name="facet.field">body_type</str>
             <str name="f.body_type.facet.method">enum</str>
         </lst>
       </arr>
@@ -123,9 +135,9 @@
   <requestHandler name="/select" class="solr.SearchHandler" default="true">
     <lst name="defaults">
       <str name="echoParams">explicit</str>
-	  <str name="sort">score desc, annotated_at_tdate desc</str>
-      <int name="rows">20</int>
-	  <str name="fl">* score</str>
+      <str name="sort">score desc, annotated_at_tdate desc</str>
+      <int name="rows">2500</int>
+      <str name="fl">* score</str>
       <str name="wt">ruby</str>
       <str name="indent">true</str>
 	  
@@ -140,46 +152,48 @@
       <str name="df">anno_jsonld</str>
       <str name="q.op">AND</str>
 	  
-	  <str name="qf">
+      <str name="qf">
   	    body_chars_exact^3
   	    body_chars_unstem^2
   	    body_chars_stem
-	    annotated_by_unstem^2
-	    annotated_by_stem
-	    target_url
-	    body_url
-	    motivation
-	    id
-	  </str>
-	  <str name="pf"> <!-- (phrase boost within result set) -->
-    	body_chars_exact^15
+        annotated_by_unstem^2
+        annotated_by_stem
+        target_url
+        body_url
+        motivation
+        id
+      </str>
+      <str name="pf"> <!-- (phrase boost within result set) -->
+        body_chars_exact^15
         body_chars_unstem^10
         body_chars_stem^5
   	    annotated_by_unstem^10
   	    annotated_by_stem^5
-	  </str>
-	  <str name="pf3">  <!-- (token trigrams boost within result set) -->
+      </str>
+      <str name="pf3">  <!-- (token trigrams boost within result set) -->
       	body_chars_exact^9
         body_chars_unstem^6
         body_chars_stem^3
         annotated_by_unstem^6
         annotated_by_stem^3
-	  </str>
-	  <str name="pf2"> <!--(token bigrams boost within result set) -->
+      </str>
+      <str name="pf2"> <!--(token bigrams boost within result set) -->
       	body_chars_exact^6
         body_chars_unstem^4
         body_chars_stem^2
         annotated_by_unstem^4
         annotated_by_stem^2
-	  </str>
+      </str>
       
-	  <bool name="facet">true</bool>
+      <bool name="facet">true</bool>
       <int name="facet.mincount">1</int>
+      <str name="facet.field">root</str>
+        <str name="f.root.facet.method">enum</str>
       <str name="facet.field">motivation</str>
         <str name="f.motivation.facet.method">enum</str>
       <str name="facet.field">target_type</str>
         <str name="f.target_type.facet.method">enum</str>
-	  <str name="facet.field">body_type</str>
+      <str name="facet.field">body_type</str>
         <str name="f.body_type.facet.method">enum</str>
       <str name="facet.field">annotated_at_tdate</str>
 	  
@@ -191,7 +205,7 @@
     <lst name="defaults">
       <str name="echoParams">explicit</str>
       <str name="fl">*</str>
-      <int name="rows">1</int>
+      <int name="rows">10</int> <!-- just in case;  expecting 1 -->
       <str name="q">{!raw f=id v=$id}</str> <!-- use id=666 instead of q=id:666 -->
       <str name="wt">ruby</str>
       <str name="indent">true</str>
@@ -236,4 +250,3 @@
   </admin>
 
 </config>
-

data/lib/tasks/triannon_tasks.rake

@@ -1,25 +1,47 @@
 require_relative '../../app/services/triannon/ldp_writer'
 
 namespace :triannon do
-  desc "set up jetty for triannon"
-  task :jetty_setup => [:solr_jetty_setup, :disable_fedora_auth_in_jetty]
+  desc "clean out then reset jetty from scratch for Triannon - starts jetty"
+  task :jetty_reset => ['jetty:stop', 'jetty:clean', 'jetty:environment', :jetty_config, 'jetty:start']
 
-  desc "set up triannon Solr in jetty"
-  task :solr_jetty_setup do
+  desc "configure Fedora and Solr in jetty for triannon"
+  task :jetty_config => [:solr_jetty_config, :disable_fedora_auth_in_jetty]
+
+	# don't display this in rake -T
+	#desc "set up triannon core in jetty Solr"
+  task :solr_jetty_config do
     `cp -r config/solr/triannon-core jetty/solr`
     `cp config/solr/solr.xml jetty/solr`
+    `cp config/solr/log4j.properties jetty/resources`
   end
 
-  desc "disable fedora basic authorization in jetty"
+	# don't display this in rake -T
+	#desc "disable fedora basic authorization in jetty"
   task :disable_fedora_auth_in_jetty do
     `cp config/jetty/etc/* jetty/etc`
   end
 
-  desc 'Create the uber root annotation container'
+
+  # ------- root container tasks ----------
+
+  # don't display this in rake -T
+  #desc 'ONLY WORKS WITHIN RAILS APP: Create the uber root annotation container per triannon.yml'
   task :create_uber_root_container do
     unless File.exist? Triannon.triannon_file
-      puts "Triannon config file missing: #{Triannon.triannon_file}"
+      puts "ERROR:  Triannon config file missing: #{Triannon.triannon_file} - are you in the rails app root directory?"
+      raise "Triannon config file missing: #{Triannon.triannon_file}"
     end
     Triannon::LdpWriter.create_basic_container(nil, Triannon.config[:ldp]['uber_container'])
   end
-end
+
+  desc "ONLY WORKS WITHIN RAILS APP: Create root anno containers per triannon.yml"
+  task :create_root_containers => :create_uber_root_container do
+    unless File.exist? Triannon.triannon_file
+      puts "ERROR:  Triannon config file missing: #{Triannon.triannon_file} - are you in the rails app root directory?"
+      raise "Triannon config file missing: #{Triannon.triannon_file}"
+    end
+    Triannon.config[:ldp]['anno_containers'].each { |container_name|
+	    Triannon::LdpWriter.create_basic_container(Triannon.config[:ldp]['uber_container'], container_name)
+    }
+  end
+end # namespace triannon

data/lib/triannon.rb

@@ -1,6 +1,5 @@
 require 'linkeddata'
 require 'oa/graph'
-require 'rdf/iiif'
 require 'rdf/triannon_vocab'
 require 'bootstrap-sass'
 require 'faraday' # for writing to LDP store

data/lib/triannon/error.rb

@@ -9,6 +9,20 @@ module Triannon
     end
   end
 
+  # general error for LDP anno root container issues
+  class LDPContainerError < Triannon::Error
+    def initialize(message = nil)
+      super(message)
+    end
+  end
+
+  # used when LDP anno root container doesn't exist
+  class MissingLDPContainerError < Triannon::LDPContainerError
+    def initialize(message = nil)
+      super(message)
+    end
+  end
+
   # used to keep HTTP response info from LDP
   class LDPStorageError < Triannon::Error
     attr_accessor :ldp_resp_status, :ldp_resp_body

data/lib/triannon/version.rb

@@ -1,3 +1,3 @@
 module Triannon
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end