hydra-head 4.0.0.rc6 → 4.0.0

data/app/helpers/facets_helper.rb

@@ -0,0 +1,4 @@
+module FacetsHelper
+  include Hydra::FacetsHelperBehavior
+
+end

data/app/helpers/hydra/blacklight_helper_behavior.rb

@@ -6,11 +6,8 @@ module Hydra
     include Blacklight::BlacklightHelperBehavior
     include HydraHelper
     
-    def application_name
-      'A Hydra Head'
-    end
-    
     def get_data_with_linked_label(doc, label, field_string, opts={})
+      ActiveSupport::Deprecation.warn("get_data_with_linked_label is deprecated and will be removed in the next release")
      
       (opts[:default] and !doc[field_string]) ? field = opts[:default] : field = doc[field_string]
       delim = opts[:delimiter] ? opts[:delimiter] : "<br/>"
@@ -29,6 +26,7 @@ module Hydra
     end
     
     def linked_label(field, field_string)
+      ActiveSupport::Deprecation.warn("linked_label is deprecated and will be removed in the next release")
       link_to(field, add_facet_params(field_string, field).merge!({"controller" => "catalog", :action=> "index"}))
     end
 
@@ -45,35 +43,20 @@ module Hydra
       ["%2$s/%1$s"] + super
     end
     
-    # Removing the [remove] link from the default selected facet display
-    def render_selected_facet_value(facet_solr_field, item)
-      content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected label")
-    end
-
-    
-    ###
-    ### Overrides pulled in from Libra
-    ###
-    
-    def render_facet_value(facet_solr_field, item, options ={})
-      if item.is_a? Array
-        return link_to_unless(options[:suppress_link], item[0], add_facet_params_and_redirect(facet_solr_field, item[0]), :class=>"facet_select") + " (" + format_num(item[1]) + ")" 
-      end
-
-      super
-    end
-
     def render_complex_facet_value(facet_solr_field, item, options ={})    
+      ActiveSupport::Deprecation.warn("render_complex_facet_value is deprecated and will be removed in the next release")
       link_to_unless(options[:suppress_link], format_item_value(item.value), add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " (" + format_num(item.hits) + ")" 
     end
 
     def render_journal_facet_value(facet_solr_field, item, options ={})
+      ActiveSupport::Deprecation.warn("render_journal_facet_value is deprecated and will be removed in the next release")
 
       val = item.value.strip.length > 12 ? item.value.strip[0..12].concat("...") : item.value.strip
       link_to_unless(options[:suppress_link], val, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " (" + format_num(item.hits) + ")" 
     end
 
     def render_complex_facet_image(facet_solr_field, item, options = {})
+      ActiveSupport::Deprecation.warn("render_complex_facet_image is deprecated and will be removed in the next release")
       computing_id = extract_computing_id(item.value)
       if File.exists?("#{Rails.root}/public/images/faculty_images/#{computing_id}.jpg")
         img = image_tag "/images/faculty_images/#{computing_id}.jpg", :width=> "100", :alt=>"#{item.value}"
@@ -84,6 +67,7 @@ module Hydra
     end
 
     def render_journal_image(facet_solr_field, item, options = {})
+      ActiveSupport::Deprecation.warn("render_journal_image is deprecated and will be removed in the next release")
       if File.exists?("#{Rails.root}/public/images/journal_images/#{item.value.strip.downcase.gsub(/\s+/,'_')}.jpg")
         img = image_tag "/images/journal_images/#{item.value.strip.downcase.gsub(/\s+/,'_')}.jpg", :width => "100"
       else
@@ -94,6 +78,7 @@ module Hydra
     end
 
     def get_randomized_display_items items
+      ActiveSupport::Deprecation.warn("get_randomized_display_items is deprecated and will be removed in the next release")
       clean_items = items.each.inject([]) do |array, item|
         array << item unless item.value.strip.blank?
         array
@@ -109,11 +94,13 @@ module Hydra
     end
 
     def extract_computing_id val
+      ActiveSupport::Deprecation.warn("extract_computing_id is deprecated and will be removed in the next release")
       cid = val.split(" ")[-1]
       cid[1..cid.length-2]
     end
 
     def format_item_value val
+      ActiveSupport::Deprecation.warn("format_item_value is deprecated and will be removed in the next release")
       begin
         last, f_c = val.split(", ")
         first = f_c.split(" (")[0]
@@ -123,25 +110,6 @@ module Hydra
       [last, "#{first[0..0]}."].join(", ")
     end
 
-    def render_head_content
-      render_stylesheet_includes +
-      render_js_includes +
-      render_extra_head_content_without_unapi +
-      content_for(:head)
-    end
-
-    def render_extra_head_content_without_unapi
-      remove_unapi! 
-      render_extra_head_content
-    end 
-
-    # rel="unapi-server" is not HTML5 valid.  Need to see if there is a way to do that properly while still validating.
-    def remove_unapi!
-      extra_head_content.delete_if do |ehc|
-        ehc.include?("unapi-server")
-      end
-    end
-
   #   COPIED from vendor/plugins/blacklight/app/helpers/application_helper.rb
     # Used in catalog/facet action, facets.rb view, for a click
     # on a facet value. Add on the facet params to existing

data/app/helpers/hydra/facets_helper_behavior.rb

@@ -0,0 +1,27 @@
+module Hydra
+  module FacetsHelperBehavior
+    include Blacklight::FacetsHelperBehavior
+
+    # Removing the [remove] link and label class from the default selected facet display
+    def render_selected_facet_value(facet_solr_field, item)
+      content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected")
+    end
+
+    # @override to remove the label class (easier integration with bootstrap)
+    # and handles arrays
+    def render_facet_value(facet_solr_field, item, options ={})    
+      if item.is_a? Array
+        render_array_facet_value(facet_solr_field, item, options)
+      end
+
+      (link_to_unless(options[:suppress_link], item.value, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+    end
+
+    def render_array_facet_value(facet_solr_field, item, options)
+      ActiveSupport::Deprecation.warn("render_array_facet_value is deprecated and will be removed in the next release")
+
+      (link_to_unless(options[:suppress_link], item[0], add_facet_params_and_redirect(facet_solr_field, item[0]), :class=>"facet_select") + " (" + format_num(item[1]) + ")").html_safe 
+    end
+  end
+end
+

data/app/models/hydra/ability.rb

@@ -1,67 +1,64 @@
 module Hydra::Ability
   include Hydra::AccessControlsEnforcement
 
-  attr_reader :user, :user_groups
-
   def initialize(user, session=nil)
     user ||= User.new # guest user (not logged in)
-    @user = user
-    @user_groups = RoleMapper.roles(user_key)
+    hydra_default_permissions(user, session)
+  end
+
+  ## You can override this method if you are using a different AuthZ (such as LDAP)
+  def user_groups(user, session)
+    return @user_groups if @user_groups
+    @user_groups = RoleMapper.roles(user_key(user)) + default_user_groups
+    @user_groups << 'registered' unless user.new_record?
+    @user_groups
+  end
+
+  def default_user_groups
     # # everyone is automatically a member of the group 'public'
-    # @user_groups.push 'public' unless @user_groups.include?('public')
-    # # logged-in users are automatically members of the group "registered"
-    # @user_groups.push 'registered' unless (@user.email == '' || @user == "public" || @user_groups.include?('registered') )
-    
-    logger.debug("Usergroups is " + @user_groups.inspect)
-    
-    if @user.is_being_superuser?(session)
-      can :manage, :all
-    else
-      hydra_default_permissions(user, session)
-    end
+    ['public']
   end
+  
 
   def hydra_default_permissions(user, session)
-    edit_permissions(user, session)
-    read_permissions(user, session)
-    custom_permissions(user, session)
+    logger.debug("Usergroups are " + user_groups(user, session).inspect)
+    if user.is_being_superuser?(session)
+      can :manage, :all
+    else
+      edit_permissions(user, session)
+      read_permissions(user, session)
+      custom_permissions(user, session)
+    end
   end
 
   def edit_permissions(user, session)
     can :edit, String do |pid|
-      @response, @permissions_solr_document = get_permissions_solr_response_for_doc_id(pid)
-      test_edit
+      test_edit(pid, user, session)
     end 
 
     can :edit, ActiveFedora::Base do |obj|
-      @response, @permissions_solr_document = get_permissions_solr_response_for_doc_id(obj.pid)
-      test_edit
+      test_edit(obj.pid, user, session)
     end
  
     can :edit, SolrDocument do |obj|
       @permissions_solr_document = obj
-      test_edit
+      test_edit(obj.id, user, session)
     end       
 
-    can :edit, SolrDocument do |obj|
-      test_edit
-    end       
   end
 
   def read_permissions(user, session)
     can :read, String do |pid|
-      @response, @permissions_solr_document = get_permissions_solr_response_for_doc_id(pid)
-      test_read
+      test_read(pid, user, session)
     end
 
     can :read, ActiveFedora::Base do |obj|
-      @response, @permissions_solr_document = get_permissions_solr_response_for_doc_id(obj.pid)
-      test_read
+      test_read(obj.pid, user, session)
     end 
     
     can :read, SolrDocument do |obj|
       @permissions_solr_document = obj
-      test_read
+      test_read(obj.id, user, session)
     end 
   end
 
@@ -71,18 +68,28 @@ module Hydra::Ability
   end
   
   protected
-  def test_edit
-    logger.debug("CANCAN Checking edit permissions for user: #{@user}")
-    group_intersection = @user_groups & edit_groups
-    result = !group_intersection.empty? || edit_persons.include?(@user.email)
+
+  def permissions_doc(pid)
+    return @permissions_solr_document if @permissions_solr_document
+    response, @permissions_solr_document = get_permissions_solr_response_for_doc_id(pid)
+    @permissions_solr_document
+  end
+
+
+  def test_edit(pid, user, session)
+    permissions_doc(pid)
+    logger.debug("CANCAN Checking edit permissions for user: #{user}")
+    group_intersection = user_groups(user, session) & edit_groups
+    result = !group_intersection.empty? || edit_persons.include?(user_key(user))
     logger.debug("CANCAN decision: #{result}")
     result
   end   
   
-  def test_read
-    logger.debug("CANCAN Checking edit permissions for user: #{@user}")
-    group_intersection = @user_groups & read_groups
-    result = !group_intersection.empty? || read_persons.include?(@user.email)
+  def test_read(pid, user, session)
+    permissions_doc(pid)
+    logger.debug("CANCAN Checking edit permissions for user: #{user}")
+    group_intersection = user_groups(user, session) & read_groups
+    result = !group_intersection.empty? || read_persons.include?(user_key(user))
     logger.debug("CANCAN decision: #{result}")
     result
   end 
@@ -120,8 +127,8 @@ module Hydra::Ability
   
   # get the currently configured user identifier.  Can be overridden to return whatever (ie. login, email, etc)
   # defaults to using whatever you have set as the Devise authentication_key
-  def user_key
-    @user.send(Devise.authentication_keys.first)
+  def user_key(user)
+    user.send(Devise.authentication_keys.first)
   end
 
 

data/app/models/hydra/role_mapper_behavior.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+module Hydra::RoleMapperBehavior
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def role_names
+      map.keys
+    end
+    def roles(username)
+      byname[username]||[]
+    end
+    
+    def whois(r)
+      map[r]||[]
+    end
+
+    def map
+      @map ||= YAML.load(File.open(File.join(Rails.root, "config/role_map_#{Rails.env}.yml")))
+    end
+
+
+    def byname
+      return @byname if @byname
+      m = Hash.new{|h,k| h[k]=[]}
+      @byname = map.inject(m) do|memo, (role,usernames)| 
+        ((usernames if usernames.respond_to?(:each)) || [usernames]).each { |x| memo[x]<<role}
+        memo
+      end
+    end
+  end
+end
+

data/app/models/role_mapper.rb

@@ -1,22 +1,3 @@
-require 'yaml'
 class RoleMapper
-  @@map = YAML.load(File.open(File.join(Rails.root, "config/role_map_#{Rails.env}.yml")))
-  m = Hash.new{|h,k| h[k]=[]}
-  @@byname = @@map.inject(m) do|memo, (role,usernames)| 
-    ((usernames if usernames.respond_to?(:each)) || [usernames]).each { |x| memo[x]<<role}
-    memo
-  end
-  class << self
-    def role_names
-      @@map.keys
-    end
-    def roles(username)
-      @@byname[username]||[]
-    end
-    
-    def whois(r)
-      @@map[r]||[]
-    end
-    
-  end
+  include Hydra::RoleMapperBehavior
 end

data/config/jetty.yml

@@ -0,0 +1,6 @@
+default:
+  jetty_port: 8983
+  startup_wait: 30
+  java_opts:
+    - "-Xmx256m" 
+    - "-XX:MaxPermSize=128m"

data/hydra-head.gemspec

@@ -12,24 +12,23 @@ Gem::Specification.new do |s|
   s.summary     = %q{Hydra-Head Rails Engine (requires Rails3) }
   s.description = %q{Hydra-Head is a Rails Engine containing the core code for a Hydra application. The full hydra stack includes: Blacklight, Fedora, Solr, active-fedora, solrizer, and om}
 
-  s.add_dependency "rails", '3.2.2' # 3.2.3 needs an updated version of BL(>3.3.1)
-  s.add_dependency "blacklight", '~>3.3.1'  
+  s.add_dependency "rails", '3.2.3' 
+  s.add_dependency "blacklight", '~>3.3.2'  
   s.add_dependency "devise"
-  s.add_dependency "active-fedora", '~>4.0.0.rc20'
+  s.add_dependency "active-fedora", '~>4.0.0'
   s.add_dependency 'RedCloth', '=4.2.9'
-  s.add_development_dependency 'solrizer-fedora', '>=1.2.5'
   s.add_dependency 'block_helpers'
   s.add_dependency 'sanitize'
   s.add_dependency 'cancan'
   
   s.add_development_dependency 'sqlite3'
-
   s.add_development_dependency 'yard'
   s.add_development_dependency 'jettywrapper', ">=1.0.4"
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'cucumber-rails', '>=1.2.0'
   s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'solrizer-fedora', '>=2.0.0'
 
 
   s.files         = `git ls-files`.split("\n")

data/lib/generators/hydra/assets_generator.rb

@@ -29,7 +29,6 @@ module Hydra
         insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery_ujs" do
 %q{
 // Required by Hydra
-//= require 'jquery.hydraMetadata.js'         
 //= require 'jquery.ui.datepicker.js'      
 }          
         end

data/lib/hydra-head/version.rb

@@ -1,4 +1,4 @@
 module HydraHead
-  VERSION = "4.0.0.rc6"
+  VERSION = "4.0.0"
 end
 

data/lib/hydra/access_controls_enforcement.rb

@@ -103,13 +103,13 @@ module Hydra::AccessControlsEnforcement
           # check for depositor raise "#{@document["depositor_t"].first} --- #{user_key}"
           ### Assuming we're using devise and have only one authentication key
           unless current_user && user_key == @permissions_solr_document["depositor_t"].first
-            flash[:notice] = "This item is under embargo.  You do not have sufficient access privileges to read this document."
+            flash[:alert] = "This item is under embargo.  You do not have sufficient access privileges to read this document."
             redirect_to(:action=>'index', :q=>nil, :f=>nil) and return false
           end
         end
       end
       unless can? :read, params[:id] 
-        flash[:notice]= "You do not have sufficient access privileges to read this document, which has been marked private."
+        flash[:alert]= "You do not have sufficient access privileges to read this document, which has been marked private."
         redirect_to(:action => 'index', :q => nil , :f => nil) and return false
       end
     end
@@ -143,12 +143,8 @@ module Hydra::AccessControlsEnforcement
   # Currently does nothing, instead relies on 
   # @param [Hash] opts (optional, not currently used)
   def enforce_index_permissions(opts={})
-    return true
     # Do nothing. Relies on enforce_search_permissions being included in the Controller's solr_search_params_logic
-    # apply_gated_discovery
-    # if !reader? 
-    #   solr_parameters[:qt] = Blacklight.config[:public_qt]
-    # end
+    return true
   end
   
   #
@@ -168,9 +164,6 @@ module Hydra::AccessControlsEnforcement
   #   end
   def add_access_controls_to_solr_params(solr_parameters, user_parameters)
     apply_gated_discovery(solr_parameters, user_parameters)
-    if !can? :read, params[:id]
-      solr_parameters[:qt] = Blacklight.config[:public_qt]
-    end
   end
   
   # Contrller before filter that sets up access-controlled lucene query in order to provide gated discovery behavior
@@ -189,7 +182,7 @@ module Hydra::AccessControlsEnforcement
     # Grant access based on user id & role
     unless current_user.nil?
       # for roles
-      RoleMapper.roles(user_key).each_with_index do |role, i|
+      ::RoleMapper.roles(user_key).each_with_index do |role, i|
         permission_types.each do |type|
           user_access_filters << "#{type}_access_group_t:#{role}"
         end
@@ -234,57 +227,4 @@ module Hydra::AccessControlsEnforcement
     solr_parameters[:fq] ||= []
     solr_parameters[:fq] << "-has_model_s:\"info:fedora/afmodel:FileAsset\""
   end
-
-  # Build the lucene query that performs gated discovery based on Hydra rightsMetadata information in Solr
-  # @param [String] user_query the user's original query request that will be wrapped in access controls
-  def build_lucene_query(user_query)
-    logger.warn("DEPRECATED: build_lucene_query has been deprecated.  Recommended convention is to use blacklight's dismax search requestHandler (not lucene) and filter queries with :fq solr parameters.  See Hydra::AccessControlsEnforcement#apply_gated_discovery and Hydra::AccessControlsEnforcement#exclude_unwanted_models")
-    q = ""
-    # start query of with user supplied query term
-      q << "_query_:\"{!dismax qf=$qf_dismax pf=$pf_dismax}#{user_query}\" AND " if user_query
-
-
-    # Append the exclusion of FileAssets
-      q << "NOT _query_:\"info\\\\:fedora/afmodel\\\\:FileAsset\""
-
-    # Append the query responsible for adding the users discovery level
-      permission_types = ["edit","discover","read"]
-      field_queries = []
-      embargo_query = ""
-      permission_types.each do |type|
-        field_queries << "_query_:\"#{type}_access_group_t:public\""
-      end
-
-      unless current_user.nil?
-        # for roles
-        RoleMapper.roles(user_key).each do |role|
-          permission_types.each do |type|
-            field_queries << "_query_:\"#{type}_access_group_t:#{role}\""
-          end
-        end
-        # for individual person access
-        permission_types.each do |type|
-          field_queries << "_query_:\"#{type}_access_person_t:#{user_key}\""
-        end
-        if current_user.is_being_superuser?(session)
-          permission_types.each do |type|
-            field_queries << "_query_:\"#{type}_access_person_t:[* TO *]\""
-          end
-        end
-
-        # if it is the depositor and it is under embargo, that is ok
-        # otherwise if it not the depositor and it is under embargo, don't show it
-        embargo_query = " OR  ((_query_:\"embargo_release_date_dt:[NOW TO *]\" AND  _query_:\"depositor_t:#{user_key}\") AND NOT (NOT _query_:\"depositor_t:#{user_key}\" AND _query_:\"embargo_release_date_dt:[NOW TO *]\"))"
-      end
-      
-      # remove anything with an embargo release date in the future  
-#embargo_query = " AND NOT _query_:\"embargo_release_date_dt:[NOW TO *]\"" if embargo_query.blank?
-      field_queries << " NOT _query_:\"embargo_release_date_dt:[NOW TO *]\"" if embargo_query.blank?
-      
-      q << " AND (#{field_queries.join(" OR ")})"
-      q << embargo_query 
-    return q
-  end
-
-
 end