atrium 0.0.1.alpha

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+
+  # Routes for the Atrium application are defined in Atrium::Routes
+  #
+  # These routes can be injected into your Rails application by adding
+  #     Atrium.add_routes(self)
+  # to the application's ./config/routes.rb. The injected routes can be 
+  # customized as well, e.g.:
+  #     Atrium.add_routes(self, :only => [:collection]) # will only load collection routes
+  #     Atrium.add_routes(self, :except => [:catalog]) # will not load catalog routes
+end
+

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require "atrium"
+Atrium.extend Blacklight::Configurable # not sure why this isn't being executed in lib/atrium.rb

data/lib/application_controller.rb

@@ -0,0 +1,24 @@
+module Atrium
+  ## Define ControllerMethods
+  module Controller
+  	## this one manages the usual self.included, klass_eval stuff
+    extend ActiveSupport::Concern
+    require 'cancan'
+
+    included do
+      before_filter :method_for_before_filtering
+    end
+
+    module InstanceMethods
+      def method_for_before_filtering
+        #puts "Filtering before"
+      end
+
+      def method_not_a_filter
+        puts "not used as a filter"
+      end
+    end
+  end
+end
+
+::ActionController::Base.send :include, Atrium::Controller

data/lib/atrium.rb

@@ -0,0 +1,42 @@
+require "blacklight"
+module Atrium
+  require 'atrium/engine' if defined?(Rails)
+  require 'application_controller'
+
+  require 'atrium/version'
+  require 'atrium/routes'
+
+  require 'ckeditor-rails'
+  require 'devise'
+  require 'loggable'
+
+  include Loggable
+
+  def self.version
+    Atrium::VERSION
+  end
+
+  def self.root
+    @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
+  end
+
+  # If you put this in your application's routes.rb, it will add the Atrium routes to the app.
+  # The atrium generator puts this in routes.rb for you by default.
+  # See {Atrium::Routes} for information about how to modify which routes are generated.
+  # @example
+  #   # in config/routes.rb
+  #   MyAppName::Application.routes.draw do
+  #     Blacklight.add_routes(self)
+  #     HydraHead.add_routes(self)
+  #     Atrium.add_routes(self)
+  #   end
+  def self.add_routes(router, options = {})
+    Atrium::Routes.new(router, options).draw
+  end
+
+end
+
+require 'atrium/application_helper.rb'
+require 'atrium/collections_helper.rb'
+require 'atrium/descriptions_helper.rb'
+require 'atrium/solr_helper.rb'

data/lib/atrium/application_helper.rb

@@ -0,0 +1,24 @@
+module Atrium::ApplicationHelper
+  def thumbnail_class( document )
+    display_thumnail( document ) ? ' with-thumbnail' : ''
+  end
+
+  def top_level_showcase(exhibit_id)
+    showcases = Atrium::Showcase.find_by_atrium_exhibit_id(exhibit_id)
+    showcase = showcases.first unless showcases.empty?
+  end
+
+  def is_editing?
+    session[:edit_showcase].blank? ? false : true
+  end
+
+  def get_essay_from_description(desc_hash, desc_id)
+    if !desc_hash.nil?
+      return desc_hash[desc_id]
+    else
+      logger.error("hash is blank for some reason. Please check")
+      return ""
+    end
+  end
+
+end

data/lib/atrium/atrium_helper_behavior.rb

@@ -0,0 +1,162 @@
+
+module Atrium::AtriumHelperBehavior
+  include BlacklightHelper
+  include FacetsHelper
+
+  def application_name
+    'Atrium Application'
+  end
+
+  # An array of strings to be added to HTML HEAD section of view.
+  def extra_head_content
+    @extra_head_content ||= []
+  end
+
+
+  # Array, where each element is an array of arguments to
+  # Rails stylesheet_link_tag helper. See
+  # ApplicationHelper#render_head_content for details.
+  def stylesheet_links
+    @stylesheet_links ||= []
+  end
+
+  # Array, where each element is an array of arguments to
+  # Rails javascript_include_tag helper. See
+  # ApplicationHelper#render_head_content for details.
+  def javascript_includes
+    @javascript_includes ||= []
+  end
+
+  # used in the catalog/_facets partial
+  #def facet_field_names
+  #  if params[:collection_id] && params[:controller] == 'catalog' && params[:action] = 'index'
+  #    logger.debug("Into get facets")
+  #    collection = @atrium_collection?  @atrium_collection : Atrium::Collection.find(params[:collection_id])
+  #    if collection
+  #      collection.search_facets.collect {|f| f.name}
+  #    end
+  #  else
+  #    super
+  #  end
+  #end
+
+  def render_facet_limit(display_facet, options = {})
+    if params[:edit_exhibit_filter] ||  params[:edit_collection_filter] || params[:edit_browse_level_filter] || params[:add_featured]  || params[:exclude_browse_level_filter]
+      if display_facet.is_a? String or display_facet.is_a? Symbol
+        $stderr.puts "............... DEPRECATION WARNING: Blacklight::FacetsHelper#render_facet_limit: use #render_facet_partials to render facets by field name"
+        return render_facet_partials([display_facet])
+      end
+      options = options.dup
+      options[:partial] ||= facet_partial_name(display_facet)
+      options[:layout] ||= "facet_layout" unless options.has_key?(:layout)
+      options[:locals] ||= {}
+      options[:locals][:solr_field] ||= display_facet.name
+      options[:locals][:solr_fname] ||= display_facet.name # DEPRECATED
+      options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
+      options[:locals][:display_facet] ||= display_facet
+      render(options)
+    else
+      super
+    end
+  end
+
+  # link_to_document(doc, :label=>'VIEW', :counter => 3)
+  # Use the catalog_path RESTful route to create a link to the show page for a specific item.
+  # catalog_path accepts a HashWithIndifferentAccess object. The solr query params are stored in the session,
+  # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
+  def link_to_document(doc, opts={:label=>blacklight_config.index.show_link.to_sym, :counter => nil, :results_view => true})
+    logger.debug("Atrium link_to_document Label: #{opts[:label]}")
+    collection_id =  params[:controller] == "atrium/collections" ? params[:id] :  params[:collection_id]
+    exhibit_id = params[:controller] == "atrium_exhibits" ?  params[:id] :  params[:exhibit_id]
+    label = render_document_index_label doc, opts
+    args = {}
+    args.merge!(:f=>params[:f]) if params[:f]
+    #&& params[:controller] != "catalog"
+    #try to retrieve collection id if not set
+    if exhibit_id && !collection_id
+      begin
+        exhibit = Atrium::Exhibit.find(exhibit_id)
+        collection_id = exhibit.collection.id if exhibit && exhibit.collection
+      rescue
+      end
+    end
+    args.merge!(:'data-counter' => opts[:counter])
+    if exhibit_id && collection_id
+      #link_to_with_data(label, atrium_collection_exhibit_browse_path(collection_id, exhibit_id, doc.id, args), {:method => :put, :class => label.parameterize, :data => opts}).html_safe
+      label = render_document_index_label doc, opts
+      logger.debug("URL: #{atrium_collection_exhibit_browse_path(collection_id, exhibit_id, doc.id, args).inspect}")
+      link_to label, atrium_collection_exhibit_browse_path(collection_id, exhibit_id, doc.id, args)
+    #elsif exhibit_id
+    #  link_to_with_data(label, atrium_exhibit_browse_path(exhibit_id, doc.id, args), {:method => :put, :class => label.parameterize, :data => opts}).html_safe
+    elsif collection_id
+      params[:controller] == "catalog" ? current_path = atrium_collection_catalog_path(collection_id, doc.id, args) : current_path = atrium_collection_browse_path(collection_id, doc.id, args)
+      label = render_document_index_label doc, opts
+      link_to label, current_path, :'data-counter' => opts[:counter]
+      #link_to_with_data(label, current_path, {:method => :put, :class => label.parameterize, :data => opts}).html_safe
+    else
+      logger.debug("call supper")
+      super
+    end
+
+  end
+
+  # If collection is defined and in an collection browse view
+  # then do not set limit on facet values displayed.
+  # Otherwise use code lifted from catalog controller in blacklight plugin
+  def facet_limit_for(facet_field)
+
+    #if (params[:collection_id] && !params[:render_search].blank?)
+    if params[:controller] == "catalog"
+      super
+    else
+      nil
+    end
+  end
+
+  # Overriding so that it will not show facet constraints if selecting
+  # featured items because we should not be able to remove facet selections
+  # that are setting proper search scope for a browse page
+  def render_constraints(localized_params = params)
+    if params[:add_featured]
+      (render_constraints_query(localized_params)).html_safe
+    else
+      (render_constraints_query(localized_params) + render_constraints_filters(localized_params)).html_safe
+    end
+  end
+
+  # Override this from BlacklightHelper so we can have a link back to browsing a collection
+  # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
+  def link_back_to_catalog(opts={:label=>'Back to Search'})
+    if params[:atrium_collection_browse]
+      params[:controller] == "atrium_collections" ? collection_id = params[:id] : collection_id = params[:collection_id]
+      link_to "Back to Browse Collection", atrium_collection_path(collection_id)
+    elsif params[:atrium_exhibit_browse]
+      params[:controller] == "atrium_exhibits" ? exhibit_id = params[:id] : exhibit_id = params[:exhibit_id]
+      link_to "Back to Browse Exhibit", atrium_exhibit_path(exhibit_id,:f=>params[:f])
+    else
+      super
+    end
+  end
+
+  def save_collection_id_in_session(collection_id)
+    session[:collection_id] = collection_id
+  end
+
+  def save_exhibit_id_in_session(exhibit_id)
+    session[:exhibit_id] = exhibit_id
+  end
+
+  def set_edit_showcase_in_session
+    logger.debug("Setting edit showcase")
+    session[:edit_showcase] = true
+  end
+
+  def get_start_over_path
+    if (params[:collection_id])
+      atrium_collection_home_path(params[:collection_id])
+    else
+      catalog_index_path
+    end
+  end
+
+end

data/lib/atrium/catalog.rb

@@ -0,0 +1,203 @@
+require 'blacklight/catalog'
+require 'atrium/layout_helper'
+
+# Include this module into any of your Blacklight Catalog classes (ie. CatalogController) to add Atrium functionality
+#
+# This module will only work if you also include Blacklight::Catalog in the Controller you're extending.
+# The atrium rails generator will create the CatalogController for you in app/controllers/catalog_controller.rb
+# @example
+# require 'blacklight/catalog'
+# require 'atrium/catalog'
+# class CustomCatalogController < ApplicationController
+# include Blacklight::Catalog
+# include Atrium::Catalog
+# end
+module Atrium::Catalog
+  extend ActiveSupport::Concern
+  include Blacklight::Catalog
+  include Atrium::SolrHelper
+  include Atrium::LayoutHelper
+  include BlacklightHelper
+
+  def self.included(klass)
+    klass.before_filter :initialize_collection
+    klass.layout :collection_theme_if_present
+  end
+
+  def show
+    super
+    if params[:atrium_collection_browse] || params[:atrium_exhibit_browse]
+      @exhibit_navigation_data = get_exhibit_navigation_data
+      ##logger.debug("render browse_show")
+      #render "browse_show"
+    end
+  end
+
+  def browse_show
+  end
+
+  def index
+    #put in atrium index code here
+    if params[:save_collection_filter_button]
+      #logger.debug("pressed save collection filter button")
+      if @atrium_collection
+        if !session[:folder_document_ids].blank?
+          @atrium_collection.collection_items ||= Hash.new
+          selected_document_ids = session[:folder_document_ids]
+          collection_items={}
+          collection_items[:solr_doc_ids]=selected_document_ids.join(',')
+          #@atrium_collection.update_attributes(:collection_items=>collection_items)
+          @atrium_collection.update_attributes(:filter_query_params=>collection_items)
+          session[:folder_document_ids] = session[:copy_folder_document_ids]
+          session[:copy_folder_document_ids]=nil
+          #logger.debug("@@atrium_collection: #{@atrium_collection.inspect},Selected Items: #{@atrium_collection.filter_query_params.inspect}, folders_selected: #{session[:folder_document_ids].inspect}")
+        else
+          filter_query_params = search_session.clone
+          filter_query_params.delete(:save_collection_filter_button)
+          filter_query_params.delete(:collection_id)
+          filter_query_params.delete :action
+          filter_query_params.delete :id
+          filter_query_params.delete :controller
+          filter_query_params.delete :utf8
+          @atrium_collection.update_attributes(:filter_query_params=>filter_query_params)
+        end
+        redirect_to edit_atrium_collection_path(@atrium_collection.id)
+      else
+        redirect_to new_atrium_collection_path
+      end
+    elsif params[:save_exhibit_filter_button]
+      params[:exhibit_id] ? exhibit_id = params[:exhibit_id] : exhibit_id = params[:edit_exhibit_filter]
+      @exhibit = Atrium::Exhibit.find(exhibit_id) if exhibit_id
+      #logger.debug("pressed save exhibit filter button")
+      if @exhibit
+        if !session[:folder_document_ids].blank?
+          selected_document_ids = session[:folder_document_ids]
+          exhibit_items={}
+          exhibit_items[:solr_doc_ids]=selected_document_ids.join(',')
+          @exhibit.update_attributes(:filter_query_params=>exhibit_items)
+          session[:folder_document_ids] = session[:copy_folder_document_ids]
+          session[:copy_folder_document_ids]=nil
+          #logger.debug("exhibit: #{@exhibit.inspect},Selected Items: #{@exhibit.filter_query_params.inspect}, folders_selected: #{session[:folder_document_ids].inspect}")
+        else
+          filter_query_params = search_session.clone
+          filter_query_params.delete(:save_exhibit_filter_button)
+          filter_query_params.delete(:collection_id)
+          filter_query_params.delete(:exhibit_id)
+          filter_query_params.delete :action
+          filter_query_params.delete :id
+          filter_query_params.delete :controller
+          filter_query_params.delete :utf8
+          @exhibit.update_attributes(:filter_query_params=>filter_query_params)
+        end
+        redirect_to edit_atrium_exhibit_path(@exhibit.id)
+      else
+        redirect_to new_atrium_exhibit_path
+      end
+    elsif params[:save_browse_level_filter_button]
+      params[:browse_level_id] ? browse_level_id = params[:browse_level_id] : browse_level_id = params[:edit_browse_level_filter]
+      @browse_level = Atrium::BrowseLevel.find(browse_level_id) if browse_level_id
+      #logger.debug("pressed save browse level filter button")
+      if @browse_level
+        filter_query_params = search_session.clone
+        filter_query_params.delete(:save_browse_level_filter_button)
+        filter_query_params.delete(:collection_id)
+        filter_query_params.delete(:browse_level_id)
+        @browse_level.update_attributes(:filter_query_params=>filter_query_params)
+        redirect_to edit_atrium_exhibit_path(@browse_level.atrium_exhibit_id)
+      else
+        redirect_to new_atrium_exhibit_path
+      end
+    elsif params[:save_browse_level_exclude_button]
+      params[:browse_level_id] ? browse_level_id = params[:browse_level_id] : browse_level_id = params[:edit_browse_level_filter]
+      @browse_level = Atrium::BrowseLevel.find(browse_level_id) if browse_level_id
+      #logger.debug("pressed save browse level filter button")
+      if @browse_level
+        filter_query_params = search_session.clone
+        filter_query_params[:exclude] = filter_query_params[:f]
+        filter_query_params.delete(:f)
+        filter_query_params.delete(:save_browse_level_exclude_button)
+        filter_query_params.delete(:collection_id)
+        filter_query_params.delete(:browse_level_id)
+        @browse_level.update_attributes(:exclude_query_params=>filter_query_params)
+        redirect_to edit_atrium_exhibit_path(@browse_level.atrium_exhibit_id)
+      else
+        redirect_to new_atrium_exhibit_path
+      end
+    else
+      delete_or_assign_search_session_params if !params[:add_description]
+
+      extra_head_content << view_context.auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => "RSS for results")
+      extra_head_content << view_context.auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => "Atom for results")
+
+      @extra_controller_params ||= {}
+      if params[:exhibit_id]
+        @exhibit = Atrium::Exhibit.find(params[:exhibit_id])
+        @atrium_collection = @exhibit.collection if @exhibit
+      end
+
+      if params[:browse_level_id]
+        @browse_level = Atrium::BrowseLevel.find(params[:browse_level_id])
+        @exhibit = @browse_level.exhibit if @browse_level
+        @atrium_collection = @exhibit.collection if @exhibit
+      end
+
+      #do not mixin whatever level I am on if I am editing the settings
+      collection = @atrium_collection unless params[:edit_collection_filter]
+      exhibit = @exhibit unless params[:edit_exhibit_filter] || params[:edit_collection_filter]
+      browse_level = @browse_level unless params[:edit_exhibit_filter] || params[:edit_collection_filter] || params[:edit_browse_level_filter]
+      #logger.debug("collection is: #{collection.inspect}")
+      #logger.debug("exhibit is: #{exhibit.inspect}")
+      #logger.debug("browse level is: #{browse_level.inspect}")
+      #logger.debug("params before search are: #{params.inspect}")
+      if params[:add_description] || params[:edit_exhibit_filter] ||  params[:edit_collection_filter] || params[:edit_browse_level_filter] || params[:CKEditor]
+        @extra_controller_params={}
+      else
+        @extra_controller_params = prepare_extra_controller_params_for_collection_query(collection,exhibit,browse_level,params,@extra_controller_params) if collection || exhibit || browse_level
+      end
+
+      logger.debug("extra params before search are: #{@extra_controller_params.inspect}")
+      (@response, @document_list) = get_search_results(params,@extra_controller_params)
+      @images = get_all_children(@document_list, "is_part_of_s")
+      #@members = get_all_children(@document_list, "is_member_of_s")
+
+      #reset to settings before was merged with user params
+      @extra_controller_params = reset_extra_controller_params_after_collection_query(collection,exhibit,browse_level,@extra_controller_params) if collection || exhibit || browse_level
+      @filters = params[:f] || []
+      search_session[:total] = @response.total unless @response.nil?
+
+      if params[:CKEditor] || params[:edit_exhibit_filter] ||  params[:edit_collection_filter] || params[:edit_browse_level_filter] || params[:add_featured]
+        render "list_item", :layout=> "item_listing"
+      elsif params[:add_description]
+        render "list_description", :layout=> "item_listing"
+      end
+
+      respond_to do |format|
+        format.html { save_current_search_params unless params[:edit_exhibit_filter] ||  params[:edit_collection_filter] || params[:edit_browse_level_filter]}
+        format.rss  { render :layout => false }
+        format.atom { render :layout => false }
+      end
+    end
+  end
+
+  def initialize_collection
+  if collection_id = determine_collection_id
+    return __initialize_collection( collection_id )
+  else
+    return false
+  end
+  end
+
+  #protected :initialize_collection
+
+  private
+
+  def determine_collection_id
+    if params.has_key? :collection_id
+        return params[:collection_id]
+    elsif params.has_key? :collection_number
+      return params[:collection_number]
+    end
+  end
+
+end
+