hydra-head 3.0.0pre1

data/README_RAILS3_CHANGES.textile

@@ -0,0 +1,42 @@
+
+h2. Fixtures
+
+Fixtures are loaded from a directory _within the test app_, which is updated when you run rake hyhead:setup_test_app so in order to update a fixture, you must change it in test_support/fixtures and then either re-run rake hyhead:setup_test_app or copy the fixture into tmp/test_app/test_support/fixtures
+
+h2. User objects
+
+Blacklight has switched to using devise instead of authlogic as its default user/authentication system.  As part of this switch, no longer have a "login" attribute as their unique identifier.  Instead, you must use email as the unique identifier.  
+
+h2. User Attributes
+
+User attributes (first_name, last_name, full_name, affiliation and photo) have been removed from HydraHead.
+
+h2. Controllers
+
+* Removed Djatoka (JPEG 2000) support and the GetController
+
+h2. Views
+
+* removed fluid infusion javascript
+* moved javascripts from the plugin directory.  Update your views to remove ":plugin=>:hydra_repository"
+
+h3. What this means:
+
+* Our sample user "archivist1" is now "archivist1@example.com".  
+* Your cucumber features and rspec tests must use email addresses as the unique identifier for Users
+
+Change your features and role_map YAML files accordingly.
+
+
+
+
+h2. How to upgrade
+
+* Create a new rails 3 project
+* Add ```gem 'blacklight'``` and ```gem 'hydra-head'``` to the Gemfile
+* run ```bundle install```
+* cp -r old_project/vendor/plugin/old_project_plugin/app/* new_project/app
+* cp -r old_project/vendor/plugin/old_project_plugin/lib/* new_project/lib
+* copy any tests (test, spec, feature, etc) from the old_project_plugin directory to the new project 
+ 
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Dir.glob('tasks/*.rake').each { |r| import r }

data/TESTING.textile

@@ -0,0 +1,85 @@
+h1. Directions to Clone and Test the Rails 3 hydra-head Code
+
+h2. For the Impatient 
+
+# clone the hydra-head code (to a fresh working copy) <pre>git clone git@github.com:projecthydra/hydra-head.git</pre>
+# switch tot he hydra-head directory <pre>cd hydra-head</pre>
+# checkout the rails3 branch <pre>git checkout rails3</pre>
+# install bundler gem <pre>gem install bundler</pre>
+# Get the project dependencies <pre>bundle install</pre>
+# grab the jetty submodule <pre>git submodule init; git submodule update</pre>
+# test <pre>rake hyhead:ci</pre> This command:
+## creates the test app in tmp/test_app
+## spins up jetty (in jettywrapper)
+## imports fixtures
+## runs rspec & cucumber tests
+
+h2. More Detailed Instructions & Notes
+
+h3. The Hydra Jetty
+
+In order to test the gem during development, the hydra-jetty is included as a submodule to provide both a fedora and solr instance.  Once you have cloned the github repository, 
+run the following commands to load the jetty:
+
+<pre>
+git submodule init
+git submodule update
+</pre>
+
+To start the jetty:
+
+<pre>
+rake hydra:jetty:start
+</pre>
+
+Note: the first time you start the jetty, you must use the following command in order to properly configure the jetty:
+
+<pre>
+rake hydra:jetty:load
+</pre>
+
+
+h3.  Testing the gem
+
+The specs and features for testing the gem within the context of a rails 3 app are all contained within the test_support directory.  Once you have 
+installed the test app, you will be able to run the specs/features from within that app via the provided rake tasks.
+
+A rake task is provided for setting up a rails 3 test app in the tmp/test_app directory.  To generate the app, run:
+
+<pre>
+rake hyhead:setup_test_app
+</pre>
+
+Once you have done this and have a jetty running, you are ready to run the specs and cucumbers:
+
+<pre>
+rake hyhead:test
+</pre>
+
+This will run the specs and cucumber features from within the test application.
+
+In order to run a single spec or cucumber feature, use the following from the command line:
+
+<pre>
+export RAILS_ROOT="tmp/test_app"
+rspec test_support/spec/controllers/catalog_controller_spec.rb  # path to the spec file you wish to run
+cucumber test_support/features/mods_asset_show.feature          # path to the feature file you wish to run
+</pre>
+
+h2. Note about vendor/cache directory
+
+In order to more quickly install the required gems, the gems have been cached and are stored in the vendor/cache directory.  Initially this was done to avoid the 
+excessive amount of time bundler was taking to install all the gems and their dependencies.  To get all the requisite gems, simply run:
+
+<pre>
+bundle install --local
+</pre>
+
+The cached gems also provide a quick means for generating a gemset for the test_app.  
+
+When developing the hydra-head gem, be sure to commit changes to the vendor/cache directory when you update or install a new gem.
+
+h2. Note about solr and fedora config files
+
+When you change the solr and fedora config files, you must update them in the generator templates directory (lib/generators/hydra-head) as well as root of the hydra_head code.
+

data/app/controllers/assets_controller.rb

@@ -0,0 +1,117 @@
+require 'mediashelf/active_fedora_helper'
+
+class AssetsController < ApplicationController
+    include MediaShelf::ActiveFedoraHelper
+    include Blacklight::SolrHelper
+    include Hydra::RepositoryController
+    include Hydra::AssetsControllerHelper
+#    include WhiteListHelper
+    include ReleaseProcessHelper
+    
+    
+    include Blacklight::Catalog
+    helper :hydra
+    
+    before_filter :search_session, :history_session
+    before_filter :require_solr, :require_fedora
+    
+    prepend_before_filter :sanitize_update_params, :only=>:update
+    before_filter :check_embargo_date_format, :only=>:update
+        
+    def show
+      if params.has_key?("field")
+        
+        @response, @document = get_solr_response_for_doc_id
+        # @document = SolrDocument.new(@response.docs.first)
+        result = @document["#{params["field"]}_t"]
+        # document_fedora = SaltDocument.load_instance(params[:id])
+        # result = document_fedora.datastreams_in_memory[params["datastream"]].send("#{params[:field]}_values")
+        unless result.nil?
+          if params.has_key?("field_index")
+            result = result[params["field_index"].to_i-1]
+          elsif result.kind_of?(Array)
+            result = result.first
+          end
+        end
+        respond_to do |format|
+          format.html     { render :text=>result }
+          format.textile  { render :text=> RedCloth.new(result, [:sanitize_html]).to_html  }
+        end
+      else
+        redirect_to :controller=>"catalog", :action=>"show"
+      end
+    end
+    
+    # Uses the update_indexed_attributes method provided by ActiveFedora::Base
+    # This should behave pretty much like the ActiveRecord update_indexed_attributes method
+    # For more information, see the ActiveFedora docs.
+    # 
+    # @example Appends a new "subject" value of "My Topic" to on the descMetadata datastream in in the _PID_ document.
+    #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"subject"=>{"-1"=>"My Topic"}}
+    # @example Sets the 1st and 2nd "medium" values on the descMetadata datastream in the _PID_ document, overwriting any existing values.
+    #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"medium"=>{"0"=>"Paper Document", "1"=>"Image"}}
+    def update
+      @document = load_document_from_params
+      
+      logger.debug("attributes submitted: #{@sanitized_params.inspect}")
+           
+      @response = update_document(@document, @sanitized_params)
+     
+      @document.save
+      flash[:notice] = "Your changes have been saved."
+      
+      logger.debug("returning #{response.inspect}")
+    
+      respond_to do |want| 
+        want.html {
+          redirect_to :controller=>"catalog", :action=>"edit"
+        }
+        want.js {
+          render :json=> tidy_response_from_update(@response)  
+        }
+        want.textile {
+          if @response.kind_of?(Hash)
+            textile_response = tidy_response_from_update(@response).values.first
+          end
+          render :text=> RedCloth.new(textile_response, [:sanitize_html]).to_html
+        }
+      end
+    end
+    
+    def new
+      af_model = retrieve_af_model(params[:content_type])
+      if af_model
+        @asset = af_model.new
+        apply_depositor_metadata(@asset)
+        set_collection_type(@asset, params[:content_type])
+        @asset.save
+        model_display_name = af_model.to_s.camelize.scan(/[A-Z][^A-Z]*/).join(" ")
+        msg = "Created a #{model_display_name} with pid #{@asset.pid}. Now it's ready to be edited."
+        flash[:notice]= msg
+      end
+      redirect_to url_for(:action=>"edit", :controller=>"catalog", :id=>@asset.pid)
+    end
+    
+    def destroy
+      af = ActiveFedora::Base.load_instance_from_solr(params[:id])
+      the_model = ActiveFedora::ContentModel.known_models_for( af ).first
+      unless the_model.nil?
+        af = the_model.load_instance_from_solr(params[:id])
+        assets = af.destroy_child_assets
+      end
+      af.delete
+      msg = "Deleted #{params[:id]}"
+      msg.concat(" and associated file_asset(s): #{assets.join(", ")}") unless assets.empty?
+      flash[:notice]= msg
+      redirect_to url_for(:action => 'index', :controller => "catalog", :q => nil , :f => nil)
+    end
+
+    
+    # This is a method to simply remove the item from SOLR but keep the object in fedora. 
+    alias_method :withdraw, :destroy
+    
+    #def withdraw
+    #  
+    #end
+    
+end

data/app/controllers/contributors_controller.rb

@@ -0,0 +1,54 @@
+require 'mediashelf/active_fedora_helper'
+
+class ContributorsController < ApplicationController
+  
+  include MediaShelf::ActiveFedoraHelper
+  before_filter :require_solr, :require_fedora
+  
+  # Display form for adding a new Contributor
+  # If contributor_type is provided, renders the appropriate "new" form
+  # If contributor_type is not provided, renders a form for selecting which type of contributor to add
+  # If format is .inline, this renders without layout so you can embed it in a page
+  def new
+    
+    # Only load the document if you need to
+    if params.has_key?(:contributor_type) 
+      @document_fedora = load_document_from_id(params[:asset_id])
+      @next_contributor_index = @document_fedora
+    end
+    
+    respond_to do |format|
+      format.html { render :file=>"contributors/new.html" , :layout=>true}
+      format.inline { render :partial=>"contributors/new.html", :layout=>false }
+    end
+  end
+  
+  def create
+    @document_fedora = load_document_from_id(params[:asset_id])
+    
+    ct = params[:contributor_type]
+    inserted_node, new_node_index = @document_fedora.insert_contributor(ct)
+    @document_fedora.save
+    partial_name = "contributors/edit_#{ct}.html"
+    respond_to do |format|
+      format.html { redirect_to( url_for(:controller=>"catalog", :action=>"edit", :id=>params[:asset_id] )+"##{params[:contributor_type]}_#{new_node_index}" ) }
+      format.inline { render :partial=>partial_name, :locals=>{"edit_#{ct}".to_sym =>inserted_node, "edit_#{ct}_counter".to_sym =>new_node_index}, :layout=>false }
+    end
+    
+  end
+  
+  def destroy
+    af_model = retrieve_af_model(params[:content_type], :default=>ModsAsset)
+    @document_fedora = af_model.find(params[:asset_id])
+    @document_fedora.remove_contributor(params[:contributor_type], params[:index])
+    result = @document_fedora.save
+    render :text=>result.inspect
+  end
+  
+  private
+  
+  def load_document_from_id(asset_id)
+    af_model = retrieve_af_model(params[:content_type], :default=>ModsAsset)
+    af_model.find(asset_id)
+  end
+end

data/app/controllers/file_assets_controller.rb

@@ -0,0 +1,152 @@
+
+class FileAssetsController < ApplicationController
+  
+  include Hydra::AccessControlsEnforcement
+  include Hydra::AssetsControllerHelper
+  include Hydra::FileAssetsHelper  
+  include Hydra::RepositoryController  
+  include MediaShelf::ActiveFedoraHelper
+  include Blacklight::SolrHelper
+  
+  before_filter :require_fedora
+  before_filter :require_solr, :only=>[:index, :create, :show, :destroy]
+  prepend_before_filter :sanitize_update_params
+  
+  helper :hydra_uploader
+  
+  def index
+=begin
+Removed from file_assets/index.html.haml
+-# javascript_includes << infusion_javascripts(:inline_edit, :extras=>[:inline_editor_integrations], :debug=>true, :render_html=>false) 
+-# javascript_includes << ['../infusion/framework/core/js/ProgressiveEnhancement.js', '../infusion/InfusionAll.js', {:cache=>true, :plugin=>"fluid-infusion"}]
+
+- javascript_includes << "jquery.jeditable.mini"
+- javascript_includes << 'custom'
+- javascript_includes << "catalog/edit"
+- javascript_includes << "jquery.hydraMetadata.js"  
+- javascript_includes << "/plugin_assets/fluid-infusion/infusion/components/undo/js/Undo.js" 
+- javascript_includes << "jquery.form.js"
+
+
+
+
+=end
+
+    if params[:layout] == "false"
+      # action = "index_embedded"
+      layout = false
+    end
+
+    if params[:asset_id].nil?
+      # @solr_result = ActiveFedora::SolrService.instance.conn.query('has_model_field:info\:fedora/afmodel\:FileAsset', @search_params)
+      @solr_result = FileAsset.find_by_solr(:all)
+    else
+      container_uri = "info:fedora/#{params[:asset_id]}"
+      escaped_uri = container_uri.gsub(/(:)/, '\\:')
+      extra_controller_params =  {:q=>"is_part_of_s:#{escaped_uri}"}
+      @response, @document_list = get_search_results( extra_controller_params )
+      
+      # Including this line so permissions tests can be run against the container
+      @container_response, @document = get_solr_response_for_doc_id(params[:asset_id])
+      
+      # Including these lines for backwards compatibility (until we can use Rails3 callbacks)
+      @container =  ActiveFedora::Base.load_instance(params[:asset_id])
+      @solr_result = @container.file_objects(:response_format=>:solr)
+    end
+    
+    # Load permissions_solr_doc based on params[:asset_id]
+    load_permissions_from_solr(params[:asset_id])
+    
+    render :action=>params[:action], :layout=>layout
+  end
+  
+  def new
+=begin
+From file_assets/_new.html.haml
+=render :partial=>"fluid_infusion/uploader"
+=render :partial=>"fluid_infusion/uploader_js"
+=end
+    render :partial=>"new", :layout=>false
+  end
+  
+  # Creates and Saves a File Asset to contain the the Uploaded file 
+  # If container_id is provided:
+  # * the File Asset will use RELS-EXT to assert that it's a part of the specified container
+  # * the method will redirect to the container object's edit view after saving
+  def create
+    if params.has_key?(:Filedata)
+      @file_asset = create_and_save_file_asset_from_params
+      apply_depositor_metadata(@file_asset)
+    
+      flash[:notice] = "The file #{params[:Filename]} has been saved in <a href=\"#{asset_url(@file_asset.pid)}\">#{@file_asset.pid}</a>."
+            
+      if !params[:asset_id].nil?
+        associate_file_asset_with_container
+      end
+    
+      ## Apply any posted file metadata
+      unless params[:asset].nil?
+        logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
+        apply_file_metadata
+      end
+      # If redirect_params has not been set, use {:action=>:index}
+      logger.debug "Created #{@file_asset.pid}."
+    else
+      flash[:notice] = "You must specify a file to upload."
+    end
+    
+    if !params[:asset_id].nil?
+      redirect_params = {:controller=>"catalog", :id=>params[:asset_id], :action=>:edit}
+    end
+    
+    redirect_params ||= {:action=>:index}
+    
+    redirect_to redirect_params
+  end
+  
+  # Common destroy method for all AssetsControllers 
+  def destroy
+    # The correct implementation, with garbage collection:
+    # if params.has_key?(:container_id)
+    #   container = ActiveFedora::Base.load_instance(params[:container_id]) 
+    #   container.file_objects_remove(params[:id])
+    #   FileAsset.garbage_collect(params[:id])
+    # else
+    
+    # The dirty implementation (leaves relationship in container object, deletes regardless of whether the file object has other containers)
+    ActiveFedora::Base.load_instance(params[:id]).delete 
+    render :text => "Deleted #{params[:id]} from #{params[:asset_id]}."
+  end
+  
+  
+  def show
+    @file_asset = FileAsset.find(params[:id])
+    if (@file_asset.nil?)
+      logger.warn("No such file asset: " + params[:id])
+      flash[:notice]= "No such file asset."
+      redirect_to(:action => 'index', :q => nil , :f => nil)
+    else
+      # get array of parent (container) objects for this FileAsset
+      @id_array = @file_asset.containers(:response_format => :id_array)
+      @downloadable = false
+      # A FileAsset is downloadable iff the user has read or higher access to a parent
+      @id_array.each do |pid|
+        @response, @document = get_solr_response_for_doc_id(pid)
+        if reader?
+          @downloadable = true
+          break
+        end
+      end
+
+      if @downloadable
+        if @file_asset.datastreams_in_memory.include?("DS1")
+          send_datastream @file_asset.datastreams_in_memory["DS1"]
+        end
+      else
+        flash[:notice]= "You do not have sufficient access privileges to download this document, which has been marked private."
+        redirect_to(:action => 'index', :q => nil , :f => nil)
+      end
+    end
+  end
+  
+end