umlaut 3.0.0alpha1

data/app/controllers/umlaut/error_handling.rb

@@ -0,0 +1,48 @@
+# A mix-in for Rails controllers with some standard error recovery
+# 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
+    end
+  end
+  
+  
+  protected 
+  
+  def handle_general_error(exception)
+    log_error_with_context(exception)
+    
+    @page_title = "Error!"
+    render "error", :status => 500
+  end
+  
+  # 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
+  end
+  
+  
+  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 << "  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)        
+    message << "  " << Rails.backtrace_cleaner.clean(exception.backtrace).join("\n ")
+                    
+    logger.send(severity, "#{message}\n\n")          
+  end
+  
+end

data/app/controllers/umlaut_controller.rb

@@ -0,0 +1,112 @@
+require 'umlaut'
+require 'umlaut_configurable'
+
+# Superclass for all Umlaut controllers, to hold default behavior,
+# also hold global configuration. It's a superclass rather than a module,
+# so we can use Rails 3 hieararchical superclass view lookup too if we want,
+# 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. 
+#
+# 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. 
+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 
+      # app_name 'Find It'
+      
+      # 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"
+      
+      # 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"
+
+      # If OpenURL came from manual entry of title/ISSN, and no match is found in
+      # 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 ) 
+    
+      # 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. 
+      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. 
+        #az_search_method  SearchMethods::Sfx4
+        #az_search_method  SearchMethods::Sfx3
+        
+        # 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        
+      end
+      
+      # 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
+        # alternate hostnames for some. Regexps matching against
+        # urls can be included here. Eg,
+        # AppConfig::Base.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!            
+      
+    end
+    
+    
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  
+end

data/app/helpers/emailer_helper.rb

@@ -0,0 +1,43 @@
+module EmailerHelper
+  include ApplicationHelper
+  
+  # returns a plain text short citation
+  def brief_citation(request, options = {})
+    
+    options[:include_labels] ||= false
+
+    rv =""
+    
+    
+    cite = request.referent.to_citation 
+
+    title = truncate(cite[:title].strip, :length => 70,  :seperator => '...')
+    
+    rv << (cite[:title_label].strip + ": ")if options[:include_labels]
+    rv << title
+    rv << "\n"
+    
+    if cite[:author]  
+      rv << "Author: " if options[:include_labels]
+      rv << cite[:author].strip
+      rv << "\n"
+    end
+    if cite[:subtitle]
+      rv << (cite[:subtitle_label].strip + ": ") if options[:include_labels]
+      rv << cite[:subtitle].strip
+      rv << "\n"
+    end
+
+    pub = []
+    pub << date_format(cite[:date]) unless cite[:date].blank?	
+    pub << 'Vol: '+cite[:volume].strip unless cite[:volume].blank?
+    pub << 'Iss: '+cite[:issue].strip unless cite[:issue].blank?	
+    pub << 'p. '+cite[:page].strip unless cite[:page].blank?
+    if pub.length > 0
+      rv << "Published: " if options[:include_labels]
+      rv << pub.join('  ')
+    end
+    
+    return rv  
+  end
+end

data/app/helpers/export_email_helper.rb

@@ -0,0 +1,34 @@
+module ExportEmailHelper
+  include EmailerHelper
+  
+  def formatted_txt_holding_status(view_data)
+    output = ""
+
+    output << view_data[:collection_str] if view_data[:collection_str]
+    output << " " + view_data[:call_number] if view_data[:call_number]
+    output << " " + view_data[:status] if view_data[:status]
+    
+    return output
+  end
+
+  def formatted_html_holding_status(view_data)
+    output = "".html_safe
+
+    
+    if view_data[:collection_str]
+      output << content_tag("span", view_data[:collection_str], :class => "collection") 
+    end
+    if view_data[:call_number]
+      output << " ".html_safe << content_tag("span", view_data[:call_number], :class => "call_no")
+    end
+    if view_data[:status]
+      output << " ".html_safe << content_tag("span", view_data[:status], :class => "status")
+    end
+      
+    return output
+  end
+
+
+
+  
+end

data/app/helpers/open_search_helper.rb

@@ -0,0 +1,7 @@
+module OpenSearchHelper
+  
+  def opensearch_template_url
+    url_for(:controller => "search", :action => "journal_search", :rfr_id => umlaut_config.lookup('rfr_id.opensearch'), :'umlaut.title_search_type' => 'contains', :only_path => false ) + '&rft.jtitle={searchTerms}'
+  end
+  
+end

data/app/helpers/resolve_helper.rb

@@ -0,0 +1,225 @@
+module ResolveHelper
+  # some useful methods started out as helper methods, but now are in the
+  # Request model. We delegate them for convenience and backwards compat.
+  delegate :get_service_type, 
+           :failed_service_dispatches, 
+           :service_type_in_progress?, 
+           :service_types_in_progress?, 
+           :any_services_in_progress?, 
+           :title_level_citation?, :to => :@user_request
+
+
+  #backwards compat, should be called title_level_citation? delegated
+  # to @user_request above, but some
+  alias title_level_request? title_level_citation?
+
+  # Will render an Umlaut HTML section. See SectionRenderer.
+  # Argument can be:
+  # 1. An already initialized SectionRenderer
+  # 2. :id => X, will load Section description hash from the resolve_sections
+  #    configuration, finding description hash with :div_id == X.
+  # 3. A complete section description hash. Ordinarily only used when that
+  #    complete hash was previously looked up from resolve_sections config.
+  #
+  # For documentation of possible values in the section descripton hash,
+  # see SectionRenderer. 
+  def render_section(arguments = {})
+    if arguments.kind_of?( SectionRenderer )
+      presenter = arguments
+    else
+      presenter = SectionRenderer.new(@user_request, arguments  )
+    end
+    
+ 
+    render(:partial => "section_display",
+           :locals => 
+            {:presenter => presenter }   )
+  end
+
+  
+  def app_name
+    return umlaut_config.app_name
+  end
+
+
+  # size can be 'small', 'medium', or 'large.
+  # returns a ServiceResponse  object, or nil. 
+  def cover_image_response(size='medium')
+    cover_images = get_service_type('cover_image')
+    cover_images.each do |service_response|
+      return service_response if service_response.service_data[:size] == size 
+    end
+    return nil
+  end
+
+
+
+  # Did this come from citation linker style entry?
+  # We check the referrer. 
+  def user_entered_citation?(uml_request)
+    return false unless uml_request && uml_request.referrer_id
+    
+    id = uml_request.referrer_id
+    return id == 'info:sid/sfxit.com:citation' || id == umlaut_config.lookup("rfr_ids.citation") || id == umlaut_config.lookup('rfr_ids.opensearch')
+  end
+
+  def display_not_found_warning?(uml_request)
+    metadata = uml_request.referent.metadata
+    display_manually_entered_typo_warning = umlaut_config.lookup!("entry_not_in_kb_warning", false)
+      
+    return (metadata['genre'] != 'book' && metadata['object_id'].blank? && user_entered_citation?(@user_request) && display_manually_entered_typo_warning) 
+  end
+
+
+  # Generate content in an expand-contract block, with a heading that
+  # you can click on to show/hide it. Actual content in block.
+  # Example, in view:
+  #  <% expand_contract_section("My Content", "div_id_to_use") do %>
+  #      this will be hidden and shown
+  #  <% end %>
+  def expand_contract_section(arg_heading, id, options={}, &block)         
+    expanded = (params["umlaut.show_#{id}"] == "true") || options[:initial_expand] || false
+    
+    icon = image_tag( ( expanded ? "list_open.png" : "list_closed.png"),
+                       :alt => "",
+                       :class => "toggle_icon",
+                       :border => "0")
+    heading = content_tag(:span,( expanded ? "Hide " : "Show "), :class=>'expand_contract_action_label') + arg_heading
+
+    
+    link_params = params.merge('umlaut.request_id' => @user_request.id,
+      "umlaut_show_#{id}" => (! expanded).to_s )
+      
+    # Make sure a self-referencing link from partial_html_sections
+    # really goes to full HTML view.
+    link_params[:action] = "index" if link_params[:action] == "partial_html_sections"
+    
+    
+    
+    return content_tag(:div, :class => "expand_contract_section") do
+      link_to( icon + heading, link_params, 
+            :anchor =>  "#{id}_toggle_link", 
+            :id => "#{id}_toggle_link", 
+            :class => "expand_contract_toggle" ) + "\n" +
+        content_tag(:div, :id => id, 
+                    :class => "expand_contract_content", 
+                    :style => ("display: none;" unless expanded), 
+                    &block)
+    end         
+  end
+  
+  
+
+  # Code-generating helper to add a "More" link to a list, with a maximum
+  # number of items to show before 'more'. AJAXy show, with unobtrusive
+  # degredation when no javascript. 
+  # Based on the idea here for a helper that takes a block. Uses
+  # expand_contract_section for actual hidden overflow. Will split list
+  # into two different <ul>'s, one before the cut and one after. Will generate
+  # <ul> tags itself. 
+  # http://blog.zmok.net/articles/2008/04/22/block-level-helpers-in-ruby-on-rails
+  #
+  # id:  id to use for HTML div for hidden part of list. Other ids
+  #      will be based on this id too.
+  # list: your list
+  # limit: how many lines to show before cut off. Default 5. Note that
+  #        at least two items will always be included in 'more'. If cutoff
+  #        is 5 and your list is 5, all 5 will be shown. If cut-off is 5
+  #        and list is 6, 4 items will be shown, with more. This is five
+  #        total lines if the 'more' is considered a line. 
+  # block: will be passed |item, index|, should generate html for that
+  #           item in block.
+  #
+  # Example, in a view:
+  # <% list_with_limit("div_id_for_list", list, :limit=>10) do |item, index| %>
+  #     <li>Item Number: <%= index %>: <%= item.title %></li>
+  # <% end %>
+  def list_with_limit(id, list, options = {}, &block)
+    
+    
+    
+    # backwards compatible to when third argument was just a number
+    # for limit. 
+    options = {:limit => options} unless options.kind_of?(Hash)  
+    options[:limit] ||= 5
+
+    return "" if list.empty?
+            
+
+    content = "".html_safe
+    
+    content <<
+    content_tag(:ul, :class => ("" || options[:ul_class])) do        
+      list.enum_for(:each_with_index).collect do |item, index|      
+        capture(item, index, &block) unless  list.length > options[:limit] && index >= options[:limit]-2        
+      end.join(" \n    ").html_safe
+    end    
+    
+    if (list.length > options[:limit] )      
+      content << 
+      expand_contract_section("#{list.length - options[:limit] + 1} more", id) do
+        content_tag(:ul, :class=>options[:ul_class]) do        
+          list.slice(options[:limit]-1..list.length-1).enum_for(:each_with_index).each do |item, index|            
+            yield(item, index)
+          end.join(" \n    ").html_safe              
+        end          
+      end
+    end
+    
+    return content
+  end
+
+
+  def link_to_toggle_debug_info(name = "[D]", options = {})
+    javascript = " jQuery('.debug_info').toggle();"  
+  
+    return link_to_function(name, javascript, options)  
+  end
+    
+  ## 
+  # Methods to grab SectionRenderer definitions from config. Caching in
+  # class-level variables. 
+  #
+  @@bg_update_sections = nil
+  @@partial_update_sections = nil
+  
+  # Called by background updater to get a list of all sections configured
+  # in application config parameter resolve_sections to be included in
+  # background updates. 
+  def bg_update_sections
+    unless (@@bg_update_sections)
+      @@bg_update_sections = umlaut_config.lookup!("resolve_sections", []).find_all do |section|
+        section[:bg_update] != false
+      end
+    end
+    @@bg_update_sections
+  end
+
+  # Called by partial_html_sections action to get a list of all sections
+  # that should be included in the partial_html_sections api response. 
+  def partial_html_sections
+    unless (@@partial_update_sections)
+      @@partial_update_sections = umlaut_config.lookup!("resolve_sections", []).find_all do |section|
+        section[:partial_html_api] != false
+      end
+    end
+    @@partial_update_sections
+  end
+
+  # Called by resolve/index view to find sections configured
+  # in application config resolve_sections list for a specific
+  # part of the page. :main, :sidebar, or :resource_info. 
+  def html_sections(area)
+    umlaut_config.lookup!("resolve_sections", []).find_all do |section|
+      section[:html_area] == area
+    end
+  end
+  
+  def html_section_by_div_id(div_id)
+    umlaut_config.lookup!("resolve_sections", []).find do |defn|
+      defn[:div_id] == div_id
+    end
+  end
+ 
+  
+end