hydra-core 5.0.0.pre1

data/lib/generators/hydra/templates/solr_conf/solr.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--
+ All (relative) paths are relative to the installation path
+  
+  persistent: Save changes made via the API to this file
+  sharedLib: path to a lib directory that will be shared across all cores
+-->
+<solr persistent="false" sharedLib="lib">
+
+  <!--
+  adminPath: RequestHandler path to manage cores.  
+    If 'null' (or absent), cores will not be manageable via REST
+  -->
+  <cores adminPath="/admin/cores">
+    <core name="development" instanceDir="development-core" />
+    <core name="test" instanceDir="test-core" />
+  </cores>
+</solr>

data/lib/hydra-core.rb

@@ -0,0 +1 @@
+require 'hydra-head'

data/lib/hydra-head.rb

@@ -0,0 +1,27 @@
+module HydraHead 
+  require 'hydra-head/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'hydra-head/routes'
+  require 'hydra'
+  
+  def self.version
+    HydraHead::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 Hydra Head routes to the app.
+  # The hydra:head generator puts this in routes.rb for you by default.
+  # See {HydraHead::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)
+  #   end
+  def self.add_routes(router, options = {})
+    HydraHead::Routes.new(router, options).draw
+  end
+  
+end

data/lib/hydra-head/engine.rb

@@ -0,0 +1,14 @@
+require "rails"
+module HydraHead
+  class Engine < Rails::Engine
+    # Config defaults
+    config.mount_at = '/'
+    
+    # Load rake tasks
+    rake_tasks do
+      Dir.glob(File.join(File.expand_path('../', File.dirname(__FILE__)),'railties', '*.rake')).each do |railtie|
+        load railtie
+      end
+    end
+  end 
+end

data/lib/hydra-head/routes.rb

@@ -0,0 +1,90 @@
+# -*- encoding : utf-8 -*-
+module HydraHead
+  class Routes
+
+    def initialize(router, options)
+      @router = router
+      @options = options
+    end
+
+    def draw
+      route_sets.each do |r|
+        self.send(r)
+      end
+    end
+
+    protected
+
+    def add_routes &blk
+      @router.instance_exec(@options, &blk)
+    end
+
+    def route_sets
+      (@options[:only] || default_route_sets) - (@options[:except] || [])
+    end
+
+    def default_route_sets
+      [:catalog, :superuser, :permissions, :assets_with_all_nested_routes]
+    end
+
+    module RouteSets
+
+
+      def assets_with_all_nested_routes
+        add_routes do |options|
+          match "withdraw", :to => "hydra/assets#withdraw", :as => "withdraw"   
+          namespace :hydra do
+            resources :file_assets
+            resources :assets do 
+              # this is to remove documents from SOLR but not from Fedora.
+              resources :contributors, :only=>[:new,:create]
+              match '/contributors', :to => 'contributors#update', :as => 'update_contributors'
+              # We would need to include the rails JS files (or implement our own) if we want this to work w/ DELETE because we delete from a link not a button.
+              #match 'contributors/:contributor_type/:index', :to => 'contributors#destroy', :as => 'connect',  :via => 'delete'
+              match 'contributors/:contributor_type/:index', :to => 'contributors#destroy', :as => 'connect'
+              # There is no ContributorsController#show
+              match 'contributors/:contributor_type/:index', :to => 'contributors#show', :as => 'contributor', :via => 'get'
+              resources :file_assets
+              resources :downloads, :only=>[:index]
+              resources :grants, :only=>[:new,:create]
+              resources :permissions
+              # Allow updates to assets/:asset_id/permissions (no :id necessary)
+              match '/permissions', :to => 'permissions#update', :as => 'update_group_permissions'            
+            end
+          end
+          match "generic_contents_object/content/:container_id", :to=>"generic_content_objects#create", :as=>'generic_content_object',  :via => 'post'            
+        end
+      end
+      
+      def permissions
+        add_routes do |options|
+          namespace :hydra do
+            resources :permissions
+          end
+        end
+      end
+
+
+      def superuser
+        add_routes do |options|
+          match 'superuser', :to => 'user_sessions#superuser', :as => 'superuser'
+        end
+      end
+
+      def catalog
+        add_routes do |options|
+          match 'catalog/:id/edit', :to => 'catalog#edit', :as => 'edit_catalog'
+          # The delete method renders a confirmation page with a button to submit actual destroy request
+          match 'catalog/:id/delete', :to => 'catalog#delete', :as => 'delete_catalog'
+        end
+      end
+
+
+
+
+    end
+    include RouteSets
+
+#match 'generic_contents_object/content/:container_id', :to => 'generic_content_objects#create', :as => 'generic_content_object', :via => :post
+  end
+end

data/lib/hydra-head/version.rb

@@ -0,0 +1,4 @@
+module HydraHead
+  VERSION = "5.0.0.pre1"
+end
+

data/lib/hydra.rb

@@ -0,0 +1,30 @@
+require 'hydra-access-controls'
+
+# Hydra libraries
+module Hydra
+  extend ActiveSupport::Autoload
+  autoload :GlobalConfigurable
+  extend GlobalConfigurable
+  autoload :Catalog
+  autoload :Controller
+  autoload :ModelMethods
+  autoload :RepositoryController
+  autoload :Solr
+
+  module ModelMixins
+    # We can't autoload ModelMixins, because it's defined by hydra-access-controls
+    autoload :CommonMetadata
+    autoload :SolrDocumentExtension
+  end
+  module Models
+    extend ActiveSupport::Autoload
+    autoload :FileAsset
+  end
+
+end
+
+begin
+  SolrDocument.use_extension Hydra::ModelMixins::SolrDocumentExtension
+rescue NameError
+end
+

data/lib/hydra/catalog.rb

@@ -0,0 +1,11 @@
+require 'hydra/controller/catalog_controller_behavior'
+require 'deprecation'
+module Hydra::Catalog
+  extend ActiveSupport::Concern
+  extend Deprecation
+
+  included do
+    Deprecation.warn(Hydra::Catalog, "Hydra::Catalog is deprecated and is replaced by Hydra::Controller::CatalogControllerBehavior.")
+    include Hydra::Controller::CatalogControllerBehavior
+  end
+end

data/lib/hydra/controller.rb

@@ -0,0 +1,25 @@
+# Include this module into any of your Controller classes to add Hydra functionality
+#
+# The primary function of this module is to mix in a number of other Hydra Modules, including 
+#   Hydra::AccessControlsEnforcement
+#
+# @example 
+#  class CustomHydraController < ApplicationController  
+#    include Hydra::Controller
+#  end
+#
+# will move to lib/hydra/controller/controller_behavior in release 5.x
+module Hydra::Controller
+  autoload :AssetsControllerBehavior, 'hydra/controller/assets_controller_behavior'
+  autoload :ControllerBehavior, 'hydra/controller/controller_behavior'
+  autoload :RepositoryControllerBehavior, 'hydra/controller/repository_controller_behavior'
+  autoload :UploadBehavior, 'hydra/controller/upload_behavior'
+  autoload :FileAssetsBehavior, 'hydra/controller/file_assets_behavior'
+
+  extend ActiveSupport::Concern
+  
+  included do
+    ActiveSupport::Deprecation.warn("Hydra::Controller has been renamed Hydra::Controller::ControllerBehavior.")
+    include Hydra::Controller::ControllerBehavior
+  end
+end

data/lib/hydra/controller/controller_behavior.rb

@@ -0,0 +1,39 @@
+# Include this module into any of your Controller classes to add Hydra functionality
+#
+# The primary function of this module is to mix in a number of other Hydra Modules, including 
+#   Hydra::AccessControlsEnforcement
+#
+# @example 
+#  class CustomHydraController < ApplicationController  
+#    include Hydra::Controller::ControllerBehavior
+#  end
+#
+module Hydra::Controller::ControllerBehavior
+  extend ActiveSupport::Concern
+
+  included do
+    # Other modules to auto-include
+    include Hydra::AccessControlsEnforcement
+    include Hydra::Controller::RepositoryControllerBehavior
+  
+    # Catch permission errors
+    rescue_from Hydra::AccessDenied do |exception|
+      if (exception.action == :edit)
+        redirect_to({:action=>'show'}, :alert => exception.message)
+      elsif current_user and current_user.persisted?
+        redirect_to root_url, :alert => exception.message
+      else
+        session["user_return_to"] = request.url
+        redirect_to new_user_session_url, :alert => exception.message
+      end
+    end
+  end
+  
+  
+  # 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
+    current_user.user_key if current_user
+  end
+  
+end

data/lib/hydra/controller/repository_controller_behavior.rb

@@ -0,0 +1,78 @@
+# Hydra::RepositoryContollerBehavior is a controller layer mixin. It is in the controller scope: request params, session etc.
+#
+module Hydra::Controller::RepositoryControllerBehavior
+  
+  # TODO, move these to a helper file.
+  def self.included(c)
+    if c.respond_to?(:helper_method)
+      c.helper_method :solr_name
+      c.helper_method :format_pid
+    end
+  end
+  
+  
+  #
+  # This method converts pid strings into xhtml safe IDs, since xhmlt expects namespaces to be defined. 
+  # I.E. hydrus:123 = hydrus_123
+  def format_pid(pid)
+    pid.gsub(":", "_")
+  end
+  
+  
+  
+  def solr_name(field_name, field_type = :text)
+    ::ActiveFedora::SolrService.solr_name(field_name, field_type)
+  end
+  
+  
+  # Returns a list of datastreams for download.
+  # Uses user's roles and "mime_type" value in submitted params to decide what to return.
+  # if you pass the optional argument of :canonical=>true, it will return the canonical datastream for this object (a single object not a hash of datastreams)
+  def downloadables(fedora_object=@fedora_object, opts={})
+    if opts[:canonical]
+      mime_type = opts[:mime_type] ? opts[:mime_type] : "application/pdf"
+      result = filter_datastreams_for_mime_type(fedora_object.datastreams, mime_type).sort.first[1]
+    elsif can? :edit, fedora_object
+      if params["mime_type"] == "all"
+        result = fedora_object.datastreams
+      else
+        result = Hash[]
+        fedora_object.datastreams.each_pair do |dsid,ds|
+          if !ds.new_object?
+            mime_type = ds.mimeType ? ds.mimeType : ""
+            if mime_type.include?("pdf") || ds.label.include?("_TEXT.xml") || ds.label.include?("_METS.xml")
+             result[dsid] = ds
+            end 
+          end 
+        end
+      end
+    else
+      result = Hash[]
+      fedora_object.datastreams.each_pair do |dsid,ds|
+         if ds.mimeType.include?("pdf")
+           result[dsid] = ds
+         end  
+       end
+    end 
+    # puts "downloadables result: #{result}"
+    return result    
+  end
+
+  protected 
+  def load_document
+    @document = ActiveFedora::Base.find(params[:id], :cast=>true)
+  end
+
+  private
+  
+  def filter_datastreams_for_mime_type(datastreams_hash, mime_type)
+    result = Hash[]
+    datastreams_hash.each_pair do |dsid,ds|
+      ds_mime_type = ds.mimeType ? ds.mimeType : ""
+      if ds_mime_type == mime_type
+       result[dsid] = ds
+      end  
+    end
+    return result
+  end
+end

data/lib/hydra/controller/upload_behavior.rb

@@ -0,0 +1,139 @@
+# will move to lib/hydra/controller / upload_behavior.rb in release 5.x
+module Hydra::Controller::UploadBehavior
+  
+  # Creates a File Asset, adding the posted blob to the File Asset's datastreams and saves the File Asset
+  #
+  # @return [FileAsset] the File Asset  
+  def create_and_save_file_assets_from_params
+    if params.has_key?(:Filedata)
+      @file_assets = []
+      params[:Filedata].each do |file|
+        @file_asset = create_asset_from_file(file)
+        add_posted_blob_to_asset(@file_asset,file)
+        @file_asset.save
+        @file_assets << @file_asset
+      end
+      return @file_assets
+    else
+      render :text => "400 Bad Request", :status => 400
+    end
+  end
+  
+  # Puts the contents of params[:Filedata] (posted blob) into a datastream within the given @asset
+  # Sets asset label and title to filename if they're empty
+  #
+  # @param [FileAsset] asset the File Asset to add the blob to
+  # @return [FileAsset] file the File Asset  
+  def add_posted_blob_to_asset(asset, file)
+    #file_name = filename_from_params
+    file_name = file.original_filename
+    options = {:label=>file_name, :mimeType=>mime_type(file_name)}
+    dsid = datastream_id #Only call this once so that it could be a sequence
+    options[:dsid] = dsid if dsid
+    asset.add_file_datastream(file, options)
+    asset.set_title_and_label( file_name, :only_if_blank=>true )
+  end
+
+  #Override this if you want to specify the datastream_id (dsID) for the created blob
+  def datastream_id
+    "content"
+  end
+  
+  # Associate the new file asset with its container
+  def associate_file_asset_with_container(file_asset=nil, container_id=nil)
+    if container_id.nil?
+      container_id = params[:asset_id]
+    end
+    if file_asset.nil?
+      file_asset = @file_asset
+    end
+    file_asset.add_relationship(:is_part_of, container_id)
+    file_asset.datastreams["RELS-EXT"].dirty = true
+    file_asset.save
+  end
+  
+  # Apply any posted file metadata to the file asset
+  def apply_posted_file_metadata         
+    @metadata_update_response = update_document(@file_asset, @sanitized_params)
+    @file_asset.save
+  end
+  
+  
+  # The posted File 
+  # @return [File] the posted file.  Defaults to nil if no file was posted.
+  def posted_file
+    params[:Filedata]
+  end
+  
+  # A best-guess filename based on POST params
+  # If Filename was submitted, it uses that.  Otherwise, it calls +original_filename+ on the posted file
+  def filename_from_params
+    if !params[:Filename].nil?
+      file_name = params[:Filename]      
+    else
+      file_name = posted_file.original_filename
+      params[:Filename] = file_name
+    end
+  end
+
+  # Creates a File Asset and sets its label from params[:Filename]
+  #
+  # @return [FileAsset] the File Asset
+  def create_asset_from_params    
+    file_asset = FileAsset.new
+    file_asset.label = params[:Filename]
+    
+    return file_asset
+  end
+  
+  # Creates a File Asset and sets its label from filename
+  #
+  # @return [FileAsset] the File Asset
+  def create_asset_from_file(file)
+    file_asset = FileAsset.new
+    file_asset.label = file.original_filename
+
+    return file_asset
+  end
+  
+  
+  # This is pre-Hydra code that created an AudioAsset, VideoAsset or ImageAsset based on the
+  # current params in the controller.
+  #
+  # @return [Constant] the recommended Asset class 
+  def asset_class_from_params
+    if params.has_key?(:type)
+      chosen_type = case params[:type]
+      when "AudioAsset"
+        AudioAsset
+      when "VideoAsset"
+        VideoAsset
+      when "ImageAsset"
+        ImageAsset
+      else
+        FileAsset
+      end
+    elsif params.has_key?(:Filename)
+      chosen_type = choose_model_by_filename( params[:Filename] )
+    else
+      chosen_type = FileAsset
+    end
+    
+    return chosen_type
+  end
+  
+  def choose_model_by_filename(filename)
+    choose_model_by_filename_extension( File.extname(filename) )
+  end
+  
+
+  private
+  # Return the mimeType for a given file name
+  # @param [String] file_name The filename to use to get the mimeType
+  # @return [String] mimeType for filename passed in. Default: application/octet-stream if mimeType cannot be determined
+  def mime_type file_name
+    mime_types = MIME::Types.of(file_name)
+    mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+  end
+  
+end