umlaut 3.0.5 → 3.1.0.pre1

data/app/controllers/store_controller.rb

@@ -1,52 +1,50 @@
 class StoreController < UmlautController
   #require 'open_url'
   require 'openurl'
+
+  # Add resolve layout for handling errors.
+  layout :resolve_layout
+
   def index
-    
-    perm = Permalink.find(params[:id])
-        
-    co = OpenURL::ContextObject.new
+    perm = Permalink.where(:id => params[:id]).first
+    handle_404_error and return unless perm # not in our db
 
+    co = OpenURL::ContextObject.new
     # We might have a link to a Referent in our db, or we might
     # instead have to rely on an XML serialized ContextObject in
     # the permalink, if the Referent has been purged. Either way
-    # we're good. 
+    # we're good.
     referent = nil
-    if ( perm && perm.referent)
+    if (perm.referent)
       referent = perm.referent
-    elsif (perm && perm.context_obj_serialized)
+    elsif (perm.context_obj_serialized)
       stored_co = perm.restore_context_object
-      # And a referrent, no referrer for now, we'll restore it later. 
-      referent = Referent.create_by_context_object( stored_co, :permalink => false )
+      # And a referrent, no referrer for now, we'll restore it later.
+      referent = Referent.create_by_context_object(stored_co, :permalink => false)
       perm.referent = referent
     end
 
-    perm.last_access = Time.now # keep track of when permalink last actually retrieved
+    # We can't find a referent or succesfully restore an xml context
+    # object to send the user to the request. We can not resolve
+    # this permalink!
+    handle_404_error and return unless referent
 
+    perm.last_access = Time.now # keep track of when permalink last actually retrieved
     # will catch possible new referent to be saved, as well as
     # update to last_access
     perm.save!
-    
 
-    unless ( referent )
-      # We can't find a referent or succesfully restore an xml context
-      # object to send the user to the request. We can not resolve
-      # this permalink!
-      
-      raise NotFound.new("Permalink request could not be resolved. Returning 404. Permalink id: #{params[:id]}")            
-    end
-    
     # Whether it was an already existing one, or a newly created one
-    # turn it back to a co so we can add a few more things. 
+    # turn it back to a co so we can add a few more things.
     co.import_context_object(referent.to_context_object)
-    
+
     # We preserve original referrer. Even though this isn't entirely accurate
     # this is neccesary to get SFX to handle it properly when we call to SFX,
-    # including handling source-specific private data, etc. 
-    co.referrer.add_identifier( perm.orig_rfr_id ) if perm.orig_rfr_id
+    # including handling source-specific private data, etc.
+    co.referrer.add_identifier(perm.orig_rfr_id) if perm.orig_rfr_id
 
     # Let's add any supplementary umlaut params passed to us
-    # Everything except the 'id' which we used for the Rails action. 
+    # Everything except the 'id' which we used for the Rails action.
     new_params = params.clone
     new_params.delete(:id)
     # and add in our new action
@@ -60,10 +58,6 @@ class StoreController < UmlautController
     # You might think you can just merge these into a hash and use url_for,
     # but Rails redirect_to/url_for isn't happy with multiple query params
     # with same name.
-
-    redirect_to( url_for_with_co( new_params, co) )
+    redirect_to(url_for_with_co(new_params, co))
   end
-  
-  class NotFound < Exception ; end
-  
-end
+end

data/app/controllers/umlaut/controller_behavior.rb

@@ -1,35 +1,63 @@
 # All behavior from UmlautController is extracted into this module,
 # so that we can generate a local UmlautController that includes
-# this module, and local app can configure or over-ride default behavior. 
-# 
+# this module, and local app can configure or over-ride default behavior.
+#
 module Umlaut::ControllerBehavior
   extend ActiveSupport::Concern
-  
+
   include UmlautConfigurable
   include Umlaut::ErrorHandling
   include Umlaut::ControllerLogic
-  
+
   included do |controller|
     controller.helper Umlaut::Helper # global umlaut view helpers
-    
     # init default configuration values
     UmlautConfigurable.set_default_configuration!(controller.umlaut_config)
   end
-  
-  protected
-  
-  # Returns a Collection object with currently configured services. 
+
+  # Returns the search layout name unless this is an XML HTTP Request.
+  def search_layout_except_xhr
+    @layout_name ||= (request.xhr? || params["X-Requested-With"] == "XmlHttpRequest") ?
+      nil : umlaut_config.search_layout
+  end
+  protected :search_layout_except_xhr
+
+  # We intentionally use a method calculated at request-time for layout,
+  # so it can be changed in config at request-time.
+  def resolve_layout
+    umlaut_config.resolve_layout
+  end
+  protected :resolve_layout
+
+  # Returns a Collection object with currently configured services.
   # Loads from Rails.root/config/umlaut_services.yml
   #
-  # Local app can in theory override in local UmlautController to have
-  # different custom behavior for calculating the collection, but this
-  # is not entirely tested yet. 
-  def create_collection    
-    # trim out ones with disabled:true
-    services = ServiceStore.config["default"]["services"].reject {|id, hash| hash && hash["disabled"] == true}
-            
+  # &umlaut.service_group may be used to customize which services are loaded,
+  # else default.  &umlaut.service_group=-default turns off default. Can also
+  # list other groups: NOTE: Needs to be submitted as a rails array,
+  # &umlaut.service_group[]= 
+  #
+  # Local app that wants to automatically set services based on IP or other
+  # implicit parameters, should add a before_filter that determines proper
+  # service_group argument, and then sets it in params (or redirects). 
+  # Not entirely tested yet. 
+  #
+  # See https://github.com/team-umlaut/umlaut/wiki/Alternate-service-groups
+  def create_collection
+    services = ServiceStore.global_service_store.determine_services( self.specified_service_groups.uniq )
     return Collection.new(@user_request, services)
   end
+  protected :create_collection
+
   
-  
+  def specified_service_groups(arg_params = params)    
+    specified_groups = params["umlaut.service_group"] || []
+    specified_groups = [specified_groups] if specified_groups.kind_of?(String)
+    
+    return specified_groups
+  end
+  protected :specified_service_groups
+
+
+
 end

data/app/controllers/umlaut/error_handling.rb

@@ -1,50 +1,45 @@
 # A mix-in for Rails controllers with some standard error recovery
-# logic. 
+# logic.
 module Umlaut::ErrorHandling
   extend ActiveSupport::Concern
-  
+
   included do
     # Only custom errors in production
     unless  Rails.application.config.consider_all_requests_local
-      
       # generic catch-all comes first, later ones will take priority
       rescue_from Exception, :with => :handle_general_error
-
-      rescue_from ::StoreController::NotFound, ActiveRecord::RecordNotFound, :with => :handle_404_error
+      rescue_from ActiveRecord::RecordNotFound, :with => :handle_404_error
     end
   end
-  
-  
-  protected 
-  
+
   def handle_general_error(exception)
     log_error_with_context(exception)
-    
     @page_title = "Error!"
-    render "error", :status => 500
+    # Only render this if we haven't done anything else
+    # e.g. if some other gem may be handling its own errors
+    render "error", :status => 500 unless performed?
   end
-  
-  # Just returns a generic 404 page. 
-  # Uses generic 404 page already stored in public/404.html as rails convention.     
+  protected :handle_general_error
+
+  # Just returns a generic 404 page.
+  # Uses generic 404 page already stored in public/404.html as rails convention.
   def handle_404_error(exception=nil)
-    render :file=>File.join(Rails.root ,"public/404.html"), :layout=>false, :status=>404
+    render :file=>File.join(Rails.root ,"public/404"), :layout=>false, :status=>404
   end
-  
-  
+  protected :handle_404_error
+
   def log_error_with_context(exception, severity = :fatal)
     message = "\n#{exception.class} (#{exception.message}):\n"
     message << "  uri: #{request.fullpath}\n\n"
-    message << "  params: #{params.inspect}\n\n"    
+    message << "  params: #{params.inspect}\n\n"
     message << "  Referer: #{request.referer}\n" if request.referer
     message << "  User-Agent: #{request.user_agent}\n"
     message << "  Client IP: #{request.remote_addr}\n\n"
-    
     message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
     # mysterious :noise param seems to match how default rails does it, so
-    # we actually get a backtrace. 
-    message << "  " << Rails.backtrace_cleaner.clean(exception.backtrace, :noise).join("\n  ")    
-                    
-    logger.send(severity, "#{message}\n\n")          
+    # we actually get a backtrace.
+    message << "  " << Rails.backtrace_cleaner.clean(exception.backtrace, :noise).join("\n  ")
+    logger.send(severity, "#{message}\n\n")
   end
-  
-end
+  protected :log_error_with_context
+end

data/{lib → app/controllers}/umlaut_configurable.rb

@@ -25,7 +25,9 @@ module UmlautConfigurable
   # to initialize
   def self.set_default_configuration!(configuration)
     configuration.configure do
-      app_name 'Find It'
+      app_name 'Find It'  
+      # Different navbar title? Defaults to app_name    
+      header_title deferred! {|c| c.app_name}
       # URL to image to use for link resolver, OR name of image asset in local app. 
       #link_img_url "http//something"
       
@@ -75,11 +77,7 @@ module UmlautConfigurable
       # hash, key is regexp to match a sid, value is filter object
       # (see lib/referent_filters )        
       add_referent_filters!( :match => /.*/, :filter => DissertationCatch.new ) 
-      
-      
-      # Create a permalink short URL for every request?
-      create_permalinks true
-        
+                  
       # skip_resolve_menu can be used to control 'direct' linking, skipping
       # the resolve menu to deliver a full text link or other resource
       # directly to the user.
@@ -115,7 +113,12 @@ module UmlautConfigurable
       
       # How many seconds between updates of the background updater for background
       # services?
-      poll_wait_seconds 4
+      poll_wait_seconds 3
+      # The FIRST AJAX callback for bg tasks should be much quicker. So we
+      # get any bg tasks that executed nearly instantaneously, and on page
+      # refresh when bg is really all loaded on back-end, but still needs JS to 
+      # fetch it. 
+      initial_poll_wait_seconds 0.300
       
       # if a background service hasn't returned in this many seconds, consider
       # it failed. (May actually be slow, more likely raised an exception and
@@ -148,14 +151,20 @@ module UmlautConfigurable
   
       end
       
+      resolve_display do
+        # Where available, prefix links with year coverage summary
+        # using ResolveHelper#coverage_summery helper. 
+        show_coverage_summary true
+      end
+      
       # Configuration for the 'search' functions -- A-Z lookup
       # and citation entry. 
       search do
         # Is your SFX database connection, defined in database.yml under
-        # sfx_db and used for A-Z searches, Sfx3 or Sfx4?  Other SearchMethods
-        # in addition to SFX direct db may be provided later. 
+        # sfx_db and used for A-Z searches, Sfx4 or do you want to use Sfx4Solr?  
+        # Other SearchMethods in addition to SFX direct db may be provided later. 
         az_search_method  SearchMethods::Sfx4
-        #az_search_method  SearchMethods::Sfx3
+        #az_search_method  SearchMethods::Sfx4Solr::Local
         
         # When talking directly to the SFX A-Z list database, you may
         # need to set this, if you have multiple A-Z profiles configured
@@ -198,6 +207,12 @@ module UmlautConfigurable
         #sfx_load_ignore_hosts  [/.*\.archive\.org/, /www\.netlibrary\.com/, 'www.loc.gov']
         sfx_load_ignore_hosts  []        
       end
+      
+      # config only relevant to holdings display
+      holdings do
+        # Holding statuses that should be styled as "Available"
+        available_statuses ["Not Charged", "Available"]
+      end
     
       # Output timing of service execution to logs
       log_service_timing (Rails.env == "development")
@@ -246,19 +261,19 @@ module UmlautConfigurable
         show_heading false
         show_spinner false
       end
-      
+            
       add_resolve_sections! do
-        div_id "search_inside"
-        html_area :resource_info
-        partial "search_inside"
+        div_id "fulltext"    
+        section_title "Online Access"
+        html_area :main
+        partial :fulltext
         show_partial_only true
       end
-      
+
       add_resolve_sections! do
-        div_id "fulltext"
-        section_title "#{ServiceTypeValue[:fulltext].display_name} via:"
+        div_id "search_inside"
         html_area :main
-        partial :fulltext
+        partial "search_inside"
         show_partial_only true
       end
       
@@ -271,8 +286,7 @@ module UmlautConfigurable
       end
       
       add_resolve_sections! do
-        div_id "audio"
-        section_title "#{ServiceTypeValue[:audio].display_name} via"
+        div_id "audio"        
         html_area :main
         visibility :responses_exist
       end
@@ -290,7 +304,7 @@ module UmlautConfigurable
         section_title "Request a copy from Inter-Library Loan"
         html_area :main
         visibility :responses_exist
-        bg_update false
+        #bg_update false
       end
       
       add_resolve_sections! do

data/app/controllers/umlaut_controller.rb

@@ -7,41 +7,41 @@ require 'umlaut_configurable'
 # for general umlaut views. And also so local app can over-ride
 # methods here once, and have it apply to all Umlaut controllers.
 # But there's not much magic in here or anything, the
-# common behavior is ordinary methods available to be called, mostly. 
+# common behavior is ordinary methods available to be called, mostly.
 #
 # This class is copied into the local app -- the default implementation
 # does nothing but 'include Umlaut::ControllerBehavior'
 #
 # You will ordinarily set config here, and can also over-ride
 # methods from Umlaut::ControllerBehavior if desired. Or add
-# additional helpers to over-ride Umlaut helpers if needed. 
+# additional helpers to over-ride Umlaut helpers if needed.
 class UmlautController < ApplicationController
     include Umlaut::ControllerBehavior
-        
+
     # Some suggested configuration. More config keys
     # are available, see UmlautConfigurable.set_default_configuration!
     # implementation for list. Configuration actually uses
-    # a Confstruct object. 
-    
-    umlaut_config.configure do 
+    # a Confstruct object.
+
+    umlaut_config.configure do
       # app_name 'Find It'
-      
-      # URL to image to use for link resolver in some self-links, 
-      # OR name of image asset in local app. 
+
+      # URL to image to use for link resolver in some self-links,
+      # OR name of image asset in local app.
       #link_img_url "http//something"
-      
+
       # string used in standard layout footer to identify your app.
       # mark it html_safe if it includes html
       # footer_credit "Find It service provided by <a href='http://www.university.edu/'>My University</a>".html_safe
 
-      
+
       # Sometimes Umlaut sends out email, what email addr should it be from?
       # from_email_addr 'no_reply@umlaut.example.com'
-      
+
       # Local layout for UmlautController's, instead of
       # built in 'umlaut' layout?
       # layout "application"
-      
+
       # A help url used on error page and a few other places.
       # help_url  "http://www.library.jhu.edu/services/askalib/index.html"
 
@@ -49,56 +49,55 @@ class UmlautController < ApplicationController
       # link resolver knowledge base, display a warning to the user of potential
       # typo?
       # entry_not_in_kb_warning true
-      
+
       # rfr_ids used for umlaut generated pages.
       # rfr_ids do
       #   opensearch  "info:sid/umlaut.code4lib.org:opensearch"
       #  citation    "info:sid/umlaut.code4lib.org:citation"
       #   azlist      'info:sid/umlaut.code4lib.org:azlist'
       # end
-      
+
       # Referent filters. Sort of like SFX source parsers.
       # hash, key is regexp to match a sid, value is filter object
-      # (see lib/referent_filters )        
-      # add_referent_filters!( :match => /.*/, :filter => DissertationCatch.new ) 
-    
+      # (see lib/referent_filters )
+      # add_referent_filters!( :match => /.*/, :filter => DissertationCatch.new )
+
       # Turn off permalink-generation? If you don't want it at all, or
       # don't want it temporarily because you are pointing at a database
-      # that won't last. 
+      # that won't last.
       # create_permalinks false
-      
+
       # How many seconds between updates of the background updater for background
       # services?
       # poll_wait_seconds 4
-      
+
       # Configuration for the 'search' functions -- A-Z lookup
-      # and citation entry. 
+      # and citation entry.
       search do
         # Is your SFX database connection, defined in database.yml under
-        # sfx_db and used for A-Z searches, Sfx3 or Sfx4?  Other SearchMethods
-        # in addition to SFX direct db may be provided later. 
+        # sfx_db and used for A-Z searches, Sfx4 or do you want to use Sfx4Solr?
+        # Other SearchMethods in addition to SFX direct db may be provided later.
         #az_search_method  SearchMethods::Sfx4
-        #az_search_method  SearchMethods::Sfx3
-        
+        #az_search_method  SearchMethods::Sfx4Solr::Local
+
         # When talking directly to the SFX A-Z list database, you may
         # need to set this, if you have multiple A-Z profiles configured
         # and don't want to use the 'default.
-        # sfx_az_profile "default"    
-                
-        # can set to "_blank" etc. 
-        # result_link_target nil        
+        # sfx_az_profile "default"
+
+        # can set to "_blank" etc.
+        # result_link_target nil
       end
-      
-      # config only relevant to SFX use  
-      sfx do      
+
+      # config only relevant to SFX use
+      sfx do
         # base sfx url to use for search actions, error condition backup,
         # and some other purposes. For search actions (A-Z), direct database
         # connection to your SFX db also needs to be defined in database.yml
         # sfx_base_url  'http://sfx.library.jhu.edu:8000/jhu_sfx?'
-        # 
-  
-        
-        
+        #
+
+
         # Umlaut tries to figure out from the SFX knowledge base
         # which hosts are "SFX controlled", to avoid duplicating SFX
         # urls with urls from catalog. But sometimes it misses some, or
@@ -106,17 +105,15 @@ class UmlautController < ApplicationController
         # urls can be included here. Eg,
         # additional_sfx_controlled_urls  [
         #    %r{^http://([^\.]\.)*pubmedcentral\.com}
-        #  ]    
+        #  ]
         # additional_sfx_controlled_urls []
-        
-        
+
+
       end
-      
+
       # Advanced topic, you can declaratively configure
       # what sections of the resolve page are output where
-      # and how using resolve_sections and add_resolve_sections!            
-      
+      # and how using resolve_sections and add_resolve_sections!
+
     end
-    
-    
-end
+end