commonwealth-vlr-engine 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12adb972f11e1c352a4b2bcfe5e70f7312807711
-  data.tar.gz: cfc7b95d77885b301c07bd70dd887e94b895b807
+  metadata.gz: 080fbde6b3ffc26b744a723c8e6d47b3a5a5c1e3
+  data.tar.gz: 0003b8e33adcffa223a1a58e49aa5cef0b7e017e
 SHA512:
-  metadata.gz: 23c4ce866b7522f680305fa90c571361a086988251ba7078896661ed90cab7c7f6a250f4f20e923bd7d55f30bec8aad5a61892372ba6be678d7f536f78cdeee4
-  data.tar.gz: 3de19dc71372e41177939e9dfe5d13d69dc73130a9d331115fec1884a205656d0eb319cdeafb282e9d5016dd990020e45f7cd2af54eee74a1cfd8f1329fb539d
+  metadata.gz: 7efc248209d8fa6bf744c1266d3db57d73c3aab18d18c64a531c349cd7e371e14c2f5a3debdd97b082af109a521e3898b192b3303f44a50c8ff3f2312138baea
+  data.tar.gz: c79fa6e0c8d619ab9c33a7ac81a01062a549e887f11269e487b26f1b3f29251fedc197429f14fef4edc4ae210eb8b45dab77c87e959c89581bb8fe2a9df5a4ba

data/README.md

@@ -42,5 +42,6 @@ The table below indicates which versions of Commonwealth-VLR-Engine are compatib
 
 VLR-Engine version | works with Blacklight version
 ----------------------- | ---------------------
-0.0.2 | >= 6.1.0
+0.0.7 | >= 6.3.0 to < 7.*
+0.0.2 | >= 6.1.0 to < 6.3
 0.0.1 | >= 5.14.0 to < 6.*  

data/app/assets/javascripts/blacklight_google_analytics/blacklight_google_analytics.js.erb

@@ -162,4 +162,15 @@ $(function() {
         }
     })
 
+    // start download button clicks
+    $("#downloads_start_links").find("a").off("click").click(function(){
+      try{
+        var action = 'trigger_download';
+        var label = $(this).attr('class').split(' ').pop();
+        ga('send', 'event', category, action, label);
+      } catch(err) {
+        BlacklightGoogleAnalytics.console_log_error(err, [category, action, label]);
+      }
+    })
+
 });

data/app/assets/javascripts/commonwealth-vlr-engine.js

@@ -17,6 +17,9 @@
 // bootstrap-accessibility-plugin
 //= require bootstrap-accessibility-plugin/bootstrap-accessibility
 
+// blacklight_range_limit
+//= require 'blacklight_range_limit'
+
 // WARNING: require tree disabled to avoid heavy JS files such as modernizr, openseadragon, etc.
 // from being automatically included on pages that don't need them
 // WARNING: to require any further app-specific JS, you must use the 'require_directory' directive

data/app/assets/javascripts/commonwealth-vlr-engine/download_utils.js

@@ -0,0 +1,4 @@
+/* close the modal when the download button is clicked */
+$('.trigger_download').on('click', function () {
+    $('#ajax-modal').modal('hide');
+});

data/app/assets/stylesheets/commonwealth-vlr-engine/commonwealth-vlr-engine.css

@@ -16,6 +16,7 @@
 @import 'book_viewer';
 @import 'carousel';
 @import 'collections';
+@import 'downloads';
 @import 'facets';
 @import 'feedback';
 @import 'folders';

data/app/assets/stylesheets/commonwealth-vlr-engine/downloads.scss

@@ -0,0 +1,18 @@
+/* styles for download popup modal */
+
+#downloads_modal {
+
+  ul.downloads_terms {
+    padding-bottom: 10px;
+
+    li {
+      padding-top: 10px;
+    }
+
+  }
+
+}
+
+#downloads_start_links {
+  text-align: left;
+}

data/app/assets/stylesheets/commonwealth-vlr-engine/facets.scss

@@ -75,6 +75,70 @@ body.blacklight-catalog-formats_facet {
     font-size: 12px;
   }
 
+  /* blacklight_range_limit */
+  .range_limit {
+    margin-bottom: 10px;
+
+    form.range_limit {
+      line-height: 2;
+    }
+
+    input.range_begin, input.range_end {
+      height: 25px;
+      padding: 6px;
+      width: 46px;
+    }
+
+    input.submit {
+      height: 25px;
+      padding: 2px 6px 6px;
+      margin-left: 3px;
+    }
+
+    .slider {
+      margin-left: 5px;
+
+      &.slider-horizontal {
+
+        & .slider-track {
+          height: 7px;
+          background-color: $light_gray;
+          background-image: linear-gradient(to bottom, #d9d9d9, $lighter_gray);
+          border-bottom: 1px solid #d9d9d9;
+        }
+
+        & .slider-handle {
+          margin-left: -5px;
+          background-color: $dark_gray;
+          background-image: linear-gradient(to bottom, $dark_gray, $dark_gray)
+        }
+
+      }
+
+    }
+
+    .slider_js .slider-selection {
+      background-color: $light_gray;
+      box-shadow: none;
+    }
+
+    .slider-handle {
+      height: 15px;
+      width: 10px;
+      opacity: 1;
+
+      &.round {
+        border-radius: 5px;
+      }
+
+    }
+
+    .distribution {
+      margin-left: -8px;
+    }
+
+  }
+
 }
 
 /* responsive styles */

data/app/assets/stylesheets/commonwealth-vlr-engine/vlr_dependencies.css

@@ -5,4 +5,6 @@
 @import 'bootstrap-accessibility-plugin/bootstrap-accessibility';
 @import 'blacklight_advanced_search';
 @import 'font-awesome';
-@import 'openseadragon';
+@import 'openseadragon';
+@import 'blacklight_range_limit/blacklight_range_limit';
+@import 'slider'; /* blacklight_range_limit */

data/app/controllers/bookmarks_controller.rb

@@ -19,7 +19,7 @@ class BookmarksController < CatalogController
 
     if request.xhr?
       # success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
-      success ? render(:update) : render(:text => "", :status => "500")
+      success ? render(:update) : render(plain: '', status: '500')
     else
       if @bookmarks.any? && success
         flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
@@ -27,7 +27,12 @@ class BookmarksController < CatalogController
         flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
       end
 
-      redirect_to :back
+      if respond_to? :redirect_back
+        redirect_back fallback_location: bookmarks_path
+      else
+        # Deprecated in Rails 5.0
+        redirect_to :back
+      end
     end
   end
 

data/app/controllers/collections_controller.rb

@@ -1,112 +1,4 @@
 class CollectionsController < CatalogController
-
-  ##
-  # Give CollectionsController access to the CatalogController configuration
-  include Blacklight::Configurable
-  include Blacklight::SearchHelper
-
-  copy_blacklight_config_from(CatalogController)
-
-  # remove collection facet and collapse others
-  before_filter :relation_base_blacklight_config, :only => [:index, :show]
-  before_filter :add_series_facet, :only => :show
-  before_filter :collections_limit, :only => [:index, :facet]
-  before_filter :collapse_institution_facet, :only => :index
-
-  # Blacklight uses #search_action_url to figure out the right URL for
-  # the global search box
-  def search_action_url options = {}
-    search_catalog_url(options.except(:controller, :action))
-  end
-  helper_method :search_action_url
-
-  def index
-    @nav_li_active = 'explore'
-    (@response, @document_list) = search_results(params)
-    params[:view] = 'list'
-    params[:sort] = 'title_info_primary_ssort asc'
-
-    respond_to do |format|
-      format.html
-    end
-  end
-
-  def show
-    @nav_li_active = 'explore'
-    @show_response, @document = fetch(params[:id])
-    @collection_title = @document[blacklight_config.index.title_field.to_sym]
-
-    # add params[:f] for proper facet links
-    params[:f] = set_collection_facet_params(@collection_title, @document)
-
-    # get the response for the facets representing items in collection
-    (@response, @document_list) = search_results({:f => params[:f]})
-
-    # get an image for the collection
-    if @document[:exemplary_image_ssi]
-      @collection_image_pid = @document[:exemplary_image_ssi]
-      @collection_image_info = get_collection_image_info(@collection_image_pid,
-                                                         @document[:id])
-    end
-
-    respond_to do |format|
-      format.html
-    end
-
-  end
-
-  private
-
-  # show series facet
-  def add_series_facet
-    blacklight_config.facet_fields['related_item_series_ssim'].include_in_request = true
-  end
-
-  # collapse the institution facet, if Institutions supported
-  def collapse_institution_facet
-    return unless t('blacklight.home.browse.institutions.enabled')
-    blacklight_config.facet_fields['physical_location_ssim'].collapse = true
-  end
-
-  # filter out non-collection items
-  def collections_limit
-    blacklight_config.search_builder_class = CommonwealthCollectionsSearchBuilder
-  end
-
-  # find the title and pid for the object representing the collection image
-  def get_collection_image_info(image_pid, collection_pid)
-    col_img_info = {title: '', pid: collection_pid, access_master: false}
-    col_img_file_doc = fetch(image_pid)[1]
-    if col_img_file_doc
-      col_img_info[:access_master] = true if col_img_file_doc[:is_image_of_ssim]
-      col_img_field = col_img_file_doc[:is_image_of_ssim].presence || col_img_file_doc[:is_file_of_ssim].presence
-      if col_img_field
-        col_img_obj_pid = col_img_field.first.gsub(/info:fedora\//,'')
-        col_img_obj_doc = fetch(col_img_obj_pid)[1]
-        if col_img_obj_doc
-          col_img_info[:title] = col_img_obj_doc[blacklight_config.index.title_field.to_sym]
-          col_img_info[:pid] = col_img_obj_pid
-        end
-      end
-    end
-    col_img_info
-  end
-
-  # find a representative image/item for a series
-  def get_series_image_obj(series_title,collection_title)
-    blacklight_config.search_builder_class = CommonwealthFlaggedSearchBuilder # ignore flagged items
-    series_doc_list = search_results({f: {'related_item_series_ssim' => series_title,
-                                          blacklight_config.collection_field => collection_title},
-                                      rows: 1})[1]
-    series_doc_list.first
-  end
-  helper_method :get_series_image_obj
-
-  # set the correct facet params for facets from the collection
-  def set_collection_facet_params(collection_title, document)
-    facet_params = {blacklight_config.collection_field => [collection_title]}
-    facet_params[blacklight_config.institution_field] = document[blacklight_config.institution_field.to_sym] if t('blacklight.home.browse.institutions.enabled')
-    facet_params
-  end
+  include CommonwealthVlrEngine::CollectionsControllerBehavior
 
 end

data/app/controllers/concerns/commonwealth_vlr_engine/collections_controller_behavior.rb

@@ -0,0 +1,132 @@
+module CommonwealthVlrEngine
+  module CollectionsControllerBehavior
+    extend ActiveSupport::Concern
+    ##
+    # Give CollectionsController access to the CatalogController configuration
+    include Blacklight::Configurable
+    include Blacklight::SearchHelper
+
+    included do
+      copy_blacklight_config_from(CatalogController)
+
+      # remove collection facet and collapse others
+      before_filter :relation_base_blacklight_config, :only => [:index, :show]
+      before_filter :add_series_facet, :only => :show
+      before_filter :collections_limit, :only => :index
+      before_filter :collections_limit_for_facets, :only => :facet
+      before_filter :collapse_institution_facet, :only => :index
+
+      helper_method :search_action_url
+      helper_method :get_series_image_obj
+    end
+
+    def index
+      @nav_li_active = 'explore'
+      (@response, @document_list) = search_results(params)
+      params[:view] = 'list'
+      params[:sort] = 'title_info_primary_ssort asc'
+
+      respond_to do |format|
+        format.html
+      end
+    end
+
+    def show
+      @nav_li_active = 'explore'
+      @show_response, @document = fetch(params[:id])
+      @collection_title = @document[blacklight_config.index.title_field.to_sym]
+
+      # add params[:f] for proper facet links
+      params[:f] = set_collection_facet_params(@collection_title, @document)
+
+      # get the response for the facets representing items in collection
+      (@response, @document_list) = search_results({:f => params[:f]})
+
+      # get an image for the collection
+      if @document[:exemplary_image_ssi]
+        @collection_image_pid = @document[:exemplary_image_ssi]
+        @collection_image_info = get_collection_image_info(@collection_image_pid,
+                                                           @document[:id])
+      end
+
+      respond_to do |format|
+        format.html
+      end
+
+    end
+
+    def range_limit
+      redirect_to range_limit_catalog_path(params.except('controller', 'action')) and return
+    end
+
+    protected
+
+    # Blacklight uses #search_action_url to figure out the right URL for the global search box
+    def search_action_url options = {}
+      search_catalog_url(options.except(:controller, :action))
+    end
+
+    # find a representative image/item for a series
+    def get_series_image_obj(series_title,collection_title)
+      blacklight_config.search_builder_class = CommonwealthFlaggedSearchBuilder # ignore flagged items
+      series_doc_list = search_results({f: {'related_item_series_ssim' => series_title,
+                                            blacklight_config.collection_field => collection_title},
+                                        rows: 1})[1]
+      series_doc_list.first
+    end
+
+    # show series facet
+    def add_series_facet
+      blacklight_config.facet_fields['related_item_series_ssim'].include_in_request = true
+    end
+
+    # collapse the institution facet, if Institutions supported
+    def collapse_institution_facet
+      return unless t('blacklight.home.browse.institutions.enabled')
+      blacklight_config.facet_fields['physical_location_ssim'].collapse = true
+    end
+
+    # find only collection objects
+    def collections_limit
+      blacklight_config.search_builder_class = CommonwealthCollectionsSearchBuilder
+    end
+
+    # find object data for facet results
+    # collections#facet can be called within BOTH collections#index and collections#show contexts
+    # when collections#index, want to limit to collection objects
+    # when collections#show, should be objects that are child of collection
+    # so we use the check below, since request.query_parameters['f'] is only added in collections#show
+    # via set_collection_facet_params
+    def collections_limit_for_facets
+      unless request.query_parameters['f'] && request.query_parameters['f'][blacklight_config.collection_field]
+        self.collections_limit
+      end
+    end
+
+    # find the title and pid for the object representing the collection image
+    def get_collection_image_info(image_pid, collection_pid)
+      col_img_info = {title: '', pid: collection_pid, access_master: false}
+      col_img_file_doc = fetch(image_pid)[1]
+      if col_img_file_doc
+        col_img_info[:access_master] = true if col_img_file_doc[:is_image_of_ssim]
+        col_img_field = col_img_file_doc[:is_image_of_ssim].presence || col_img_file_doc[:is_file_of_ssim].presence
+        if col_img_field
+          col_img_obj_pid = col_img_field.first.gsub(/info:fedora\//,'')
+          col_img_obj_doc = fetch(col_img_obj_pid)[1]
+          if col_img_obj_doc
+            col_img_info[:title] = col_img_obj_doc[blacklight_config.index.title_field.to_sym]
+            col_img_info[:pid] = col_img_obj_pid
+          end
+        end
+      end
+      col_img_info
+    end
+
+    # set the correct facet params for facets from the collection
+    def set_collection_facet_params(collection_title, document)
+      facet_params = {blacklight_config.collection_field => [collection_title]}
+      facet_params[blacklight_config.institution_field] = document[blacklight_config.institution_field.to_sym] if t('blacklight.home.browse.institutions.enabled')
+      facet_params
+    end
+  end
+end

data/app/controllers/concerns/commonwealth_vlr_engine/downloads_controller_behavior.rb

@@ -0,0 +1,184 @@
+# heavily based on Hydra::Controller::DownloadBehavior
+module CommonwealthVlrEngine
+  module DownloadsControllerBehavior
+    extend ActiveSupport::Concern
+
+    include Blacklight::Catalog
+    include CommonwealthVlrEngine::Streaming
+    include CommonwealthVlrEngine::ApplicationHelper
+    include CommonwealthVlrEngine::Finder
+    # for some reason have to require AND include Zipline, or you get errors
+    require 'zipline'
+    include Zipline
+    require 'open-uri'
+
+    included do
+      copy_blacklight_config_from(CatalogController)
+      helper_method :search_action_url
+    end
+
+    # render a page/modal with license terms, download links, etc
+    def show
+      @doc_response, @document = fetch(params[:id])
+      if @document[:has_model_ssim].include? 'info:fedora/afmodel:Bplmodels_File'
+        parent_response, @parent_document = fetch(parent_id(@document))
+        @object_profile = JSON.parse(@document['object_profile_ssm'].first)
+      else
+        @parent_document = @document
+        @object_profile = nil
+      end
+
+      respond_to do |format|
+        format.html # for users w/o JS
+        format.js { render :layout => false } # download modal window
+      end
+    end
+
+    # initiates the file download
+    def trigger_download
+      response, @solr_document = fetch(params[:id])
+      if !@solr_document.to_h.empty? && params[:datastream_id]
+        if @solr_document[:has_model_ssim].include? 'info:fedora/afmodel:Bplmodels_File'
+          @object_id = parent_id(@solr_document)
+          send_content
+        elsif @solr_document[:has_model_ssim].include? 'info:fedora/afmodel:Bplmodels_ObjectBase'
+          @file_list = get_image_files(params[:id])
+          if !@file_list.empty?
+            @object_id = params[:id]
+            send_zipped_content
+          else
+            not_found
+          end
+        else
+          not_found
+        end
+      end
+    end
+
+    protected
+
+    # Blacklight uses #search_action_url to figure out the right URL for
+    # the global search box
+    def search_action_url options = {}
+      search_catalog_url(options.except(:controller, :action))
+    end
+
+    # Handle the HTTP show request
+    def send_content
+      response.headers['Accept-Ranges'] = 'bytes'
+      if request.head?
+        content_head
+      elsif request.headers['HTTP_RANGE']
+        send_range
+      else
+        send_file_contents
+      end
+    end
+
+    # send multiple files as a zip archive
+    def send_zipped_content
+      files_array = []
+      @file_list.each_with_index do |file,index|
+        params[:id] = file[:id] # hack this so file_url returns correct value
+        @solr_document = file
+        files_array << [file_url, "#{(index+1).to_s}_#{file_name_with_extension}"]
+      end
+      file_mappings = files_array.lazy.map { |url, path| [open(url), path] }
+      zipline(file_mappings, "#{file_name}.zip")
+    end
+
+    # render an HTTP HEAD response
+    def content_head
+      response.headers['Content-Length'] = file_size if file_size
+      head :ok, content_type: mime_type
+    end
+
+    # Create some headers for the datastream
+    def content_options
+      { disposition: 'attachment', type: mime_type, filename: file_name_with_extension }
+    end
+
+    # returns a Fedora datastream url or IIIF url
+    def file_url
+      if params[:datastream_id] == 'accessFull'
+        iiif_image_url(params[:id], {})
+      else
+        datastream_disseminator_url(params[:id], params[:datastream_id])
+      end
+    end
+
+    def file_extension
+      if params[:datastream_id] =~ /Master/
+        JSON.parse(@solr_document[:object_profile_ssm].first)["objLabel"].split('.')[1]
+      else
+        'jpg'
+      end
+    end
+
+    # @return [String] the filename
+    def file_name
+      "#{@object_id}_#{params[:datastream_id]}"
+    end
+
+    # @return [String] the filename with extension
+    def file_name_with_extension
+      "#{file_name}.#{file_extension}"
+    end
+
+    def file_size
+      return false if params[:datastream_id] == 'accessFull'
+      JSON.parse(@solr_document[:object_profile_ssm].first)["datastreams"][params[:datastream_id]]["dsSize"]
+    end
+
+    def mime_type
+      if params[:datastream_id] =~ /Master/
+        @solr_document[:mime_type_tesim].first
+      else
+        'image/jpeg'
+      end
+    end
+
+    def prepare_file_headers
+      send_file_headers! content_options
+      response.headers['Content-Type'] = mime_type
+      response.headers['Content-Length'] ||= file_size.to_s if file_size
+      # Prevent Rack::ETag from calculating a digest over body
+      response.headers['Last-Modified'] = Time.new(@solr_document[:system_modified_dtsi]).utc.strftime("%a, %d %b %Y %T GMT")
+      self.content_type = mime_type
+    end
+
+    def send_file_contents
+      self.status = 200
+      prepare_file_headers
+      stream_body file_stream(file_url)
+    end
+
+    # render an HTTP Range response
+    def send_range
+      _, range = request.headers['HTTP_RANGE'].split('bytes=')
+      from, to = range.split('-').map(&:to_i)
+      to = file_size.to_i - 1 unless to
+      length = to - from + 1
+      response.headers['Content-Range'] = "bytes #{from}-#{to}/#{file_size}"
+      response.headers['Content-Length'] = "#{length}"
+      self.status = 206
+      prepare_file_headers
+      stream_body file_stream(file_url, request.headers['HTTP_RANGE'])
+    end
+
+    private
+
+    def parent_id(document)
+      document[:is_file_of_ssim].first.gsub(/info:fedora\//,'')
+    end
+
+    def stream_body(iostream)
+      iostream.each do |in_buff|
+        response.stream.write in_buff
+      end
+    ensure
+      response.stream.close
+    end
+
+  end
+end