fcrepo_admin 0.4.1 → 0.5.0

data/app/views/layouts/fcrepo_admin/datastreams.html.erb

@@ -1,17 +1,15 @@
 <% content_for :main do %>
   <h1><%= object_title %></h1>
-  <h3>
-	<%= t("fcrepo_admin.datastream.title") %>: <%= @datastream.dsid %>
-  </h3>
-  <% unless ds_is_current_version? %>
+  <h3><%= datastream_title %></h3>
+  <% unless @datastream.current_version? %>
     <p>
-      <%= render :partial => 'version', :locals => {:datastream => @datastream} %>
+      <%= render_datastream_version %>
 	</p>
   <% end %>
   <%= yield %>
 <% end %>
 <% content_for :sidebar do %>
-  <%= render 'fcrepo_admin/objects/context_nav' %>
-  <%= render 'context_nav' %>
+  <%= object_nav %>
+  <%= datastream_nav %>
 <% end %>
 <%= render :template => 'layouts/fcrepo_admin/default' %>

data/app/views/layouts/fcrepo_admin/objects.html.erb

@@ -3,6 +3,6 @@
   <%= yield %>
 <% end %>
 <% content_for :sidebar do %>
-  <%= render 'fcrepo_admin/objects/context_nav' %>
+  <%= object_nav %>
 <% end %>
 <%= render :template => 'layouts/fcrepo_admin/default' %>

data/config/locales/fcrepo_admin.en.yml

@@ -66,6 +66,16 @@ en:
       title: 'Datastream'
       not_persisted: 'Not persisted to Fedora'
       version: 'Version'
+      current_version: 'current version'
+      content:
+        title: 'Content'
+      alerts:
+        inactive: 'This datastream is in the inactive state.'
+        deleted: 'This datastream is in the deleted state.'
+        caution: 'Caution!'
+        not_versionable: 'This datastream is not versionable. Changes cannot be reverted.'
+        system_managed: 'This datastream is managed by Fedora and/or Hydra and should be modified only with great care.'
+        not_persisted: 'This datastream has not been persisted to Fedora.'
       nav:
         header: 'Datastream Admin'
         items:
@@ -81,27 +91,28 @@ en:
       content_not_text: 'The datastream content is not text'
       profile:
         title: 'Profile'
-        dsLabel: 'Label'
-        dsMIME: 'MIME Type'
-        dsVersionID: 'Version'
-        dsCreateDate: 'Create Date'
-        dsState: 'State'
-        dsFormatURI: 'Format URI'
-        dsControlGroup: 'Control Group'
-        dsSize: 'Size'
-        dsVersionable: 'Versionable'
-        dsInfoType: 'Info Type'
-        dsLocation: 'Location'
-        dsLocationType: 'Location Type'
-        dsChecksumType: 'Checksum Type'
-        dsChecksum: 'Checksum'
+        keys:
+          dsLabel: 'Label'
+          dsMIME: 'MIME Type'
+          dsVersionID: 'Version'
+          dsCreateDate: 'Create Date'
+          dsState: 'State'
+          dsFormatURI: 'Format URI'
+          dsControlGroup: 'Control Group'
+          dsSize: 'Size'
+          dsVersionable: 'Versionable'
+          dsInfoType: 'Info Type'
+          dsLocation: 'Location'
+          dsLocationType: 'Location Type'
+          dsChecksumType: 'Checksum Type'
+          dsChecksum: 'Checksum'
       edit:
-        header: 'Edit Content'
-        confirm: "These changes are not validated and cannot be undone!"
-        submit: 'Update'
+        title: 'Edit Content'
+        form:
+          confirm: "These changes are not validated and cannot be undone!"
+          submit: 'Update'
       upload:
-        header: 'Upload Content'
-        confirm: "These changes are not validated and cannot be undone!"
-        submit: 'Upload'
-
-
+        title: 'Upload Content'
+        form:
+          confirm: "These changes are not validated and cannot be undone!"
+          submit: 'Upload'

data/config/routes.rb

@@ -1,5 +1,8 @@
 FcrepoAdmin::Engine.routes.draw do
 
+  datastreams_resources = [:index, :show]
+  datastreams_resources += [:edit, :update] unless FcrepoAdmin.read_only
+
   scope :module => "fcrepo_admin" do
     resources :objects, :only => :show do
       member do
@@ -7,10 +10,10 @@ FcrepoAdmin::Engine.routes.draw do
         get 'permissions'
       end
       resources :associations, :only => [:index, :show]
-      resources :datastreams, :only => [:index, :show, :edit, :update] do
+      resources :datastreams, :only => datastreams_resources do
         member do
           get 'content'
-          get 'upload'
+          get 'upload' unless FcrepoAdmin.read_only
           get 'download'
           get 'history'
         end

data/lib/fcrepo_admin.rb

@@ -3,8 +3,56 @@ require 'blacklight'
 require 'hydra/head'
 
 module FcrepoAdmin
-  autoload :SolrDocumentExtension, 'fcrepo_admin/solr_document_extension'
+
+  #
+  # FcrepoAdmin configuration settings
+  #
+  mattr_accessor :read_only
+  self.read_only = false
+
+  # MIME types representing text content that do not have "text" media type.
+  mattr_accessor :extra_text_mime_types
+  self.extra_text_mime_types = ['application/xml', 'application/rdf+xml', 'application/json']
+
+  # Datastream profile keys for values to display on datastream index view
+  mattr_accessor :datastream_index_columns
+  self.datastream_index_columns = ["dsLabel", "dsMIME", "dsSize", "dsCreateDate"]
+
+  # Datastream profile keys for values to display on datastream history view
+  mattr_accessor :datastream_history_columns
+  self.datastream_history_columns = ["dsCreateDate"]
+
+  # Datastream context navigation items
+  mattr_accessor :datastream_nav_items
+  self.datastream_nav_items = [:dsid, :version, :current_version, :summary, :content, :download, :edit, :upload, :history]
+
+  mattr_accessor :datastream_show_profile_keys
+  self.datastream_show_profile_keys = ["dsLabel", "dsMIME", "dsVersionID", "dsCreateDate", "dsState", 
+                                       "dsFormatURI", "dsControlGroup", "dsSize", "dsVersionable", 
+                                       "dsInfoType", "dsLocation", "dsLocationType", "dsChecksumType",
+                                       "dsChecksum"]
+
+  # Sanity check on amount of text data to make editable via web form
+  mattr_accessor :max_editable_datastream_size
+  self.max_editable_datastream_size = 1024 * 64
+
+  # Object context navigation items
+  mattr_accessor :object_nav_items
+  self.object_nav_items = [:pid, :summary, :datastreams, :permissions, :associations, :audit_trail]
+
+  # Datastream profile values to display on object show view
+  mattr_accessor :object_show_datastream_columns
+  self.object_show_datastream_columns = ["dsLabel"]
+
+  # Methods on ActiveFedora::Base objects that represent Fcrepo object properties
+  mattr_accessor :object_properties
+  self.object_properties = [:label, :state, :create_date, :modified_date, :owner_id]
+
+  #
+  # Autoloading
+  #
   autoload :Ability, 'fcrepo_admin/ability'
+
   module Helpers
     autoload :BlacklightHelperBehavior, 'fcrepo_admin/helpers/blacklight_helper_behavior'
     autoload :ObjectsHelperBehavior, 'fcrepo_admin/helpers/objects_helper_behavior'
@@ -12,7 +60,9 @@ module FcrepoAdmin
     autoload :AssociationsHelperBehavior, 'fcrepo_admin/helpers/associations_helper_behavior'
     autoload :FcrepoAdminHelperBehavior, 'fcrepo_admin/helpers/fcrepo_admin_helper_behavior'
   end
+
   module Controller
     autoload :ControllerBehavior, 'fcrepo_admin/controller/controller_behavior'
   end
+
 end

data/lib/fcrepo_admin/decorators/active_fedora/base_decorator.rb

@@ -0,0 +1,33 @@
+ActiveFedora::Base.class_eval do
+
+  def active?
+    state == 'A'
+  end
+
+  def auditable?
+    begin
+      self.is_a? ActiveFedora::Auditable
+    rescue
+      false
+    end
+  end
+
+  def has_permissions?
+    self.is_a? Hydra::ModelMixins::RightsMetadata
+  end
+
+  def governable?
+    !is_governed_by_association.nil?
+  end
+
+  private
+
+  def governed_by_association
+    self.reflections.each do |name, reflection|
+      # FIXME add class name condition, i.e.:
+      # && reflection.class_name == [Hydra configured policy class or Hydra::AdminPolicy]
+      return reflection if reflection.macro == :belongs_to && reflection.options[:property] == :is_governed_by
+    end
+  end
+  
+end

data/lib/fcrepo_admin/decorators/active_fedora/datastream_decorator.rb

@@ -0,0 +1,35 @@
+ActiveFedora::Datastream.class_eval do
+
+  def active?
+    dsState == 'A'
+  end
+
+  def current_version?
+    @current_version ||= (new? || versions.empty? || dsVersionID == versions.first.dsVersionID)
+  end
+
+  def content_is_url?
+    external? || redirect?
+  end
+
+  def content_is_downloadable?
+    has_content? && (managed? || inline?)
+  end
+
+  def modifiable?
+    !FcrepoAdmin.read_only && active? && current_version?
+  end
+
+  def content_is_uploadable?
+    modifiable? && (managed? || inline?)
+  end
+
+  def content_is_editable?
+    modifiable? && !content_is_url? && content_is_text? && dsSize <= FcrepoAdmin.max_editable_datastream_size
+  end
+
+  def content_is_text?
+    has_content? && !mimeType.blank? && (mimeType.start_with?('text/') || FcrepoAdmin.extra_text_mime_types.include?(mimeType))
+  end
+
+end

data/lib/fcrepo_admin/engine.rb

@@ -8,5 +8,11 @@ module FcrepoAdmin
       g.helper false
     end
 
+    config.before_initialize do
+      # load ActiveFedora decorators
+      require 'fcrepo_admin/decorators/active_fedora/base_decorator'
+      require 'fcrepo_admin/decorators/active_fedora/datastream_decorator'
+    end
+
   end
 end

data/lib/fcrepo_admin/helpers/datastreams_helper_behavior.rb

@@ -1,28 +1,152 @@
 module FcrepoAdmin::Helpers
   module DatastreamsHelperBehavior
-    include FcrepoAdmin::Helpers::FcrepoAdminHelperBehavior
 
-    def datastream_context_nav_header
+    def datastream_title
+      "#{t('fcrepo_admin.datastream.title')}: #{@datastream.dsid}"
+    end
+
+    def datastream_show_profile_keys
+      FcrepoAdmin.datastream_show_profile_keys
+    end
+
+    def datastream_nav
+      render :partial => 'fcrepo_admin/shared/context_nav', :locals => {:header => datastream_nav_header, :items => datastream_nav_items}      
+    end
+
+    def datastream_nav_header
       t("fcrepo_admin.datastream.nav.header")
     end
 
-    def datastream_context_nav_items
-      render :partial => 'fcrepo_admin/datastreams/context_nav_items', :locals => {:object => @object, :datastream => @datastream}
+    def datastream_nav_items
+      FcrepoAdmin.datastream_nav_items.collect { |item| datastream_nav_item(item) }.reject { |item| item.nil? }
     end
 
-    # List of ds profile keys for ds index view
     def datastream_index_columns
-      ["dsLabel", "dsMIME", "dsSize", "dsCreateDate"]
+      FcrepoAdmin.datastream_index_columns
     end
 
-    # List of ds profile keys for ds history view
     def datastream_history_columns
-      ["dsCreateDate"]
+      FcrepoAdmin.datastream_history_columns
     end
 
     def datastream_params
       params.has_key?(:asOfDateTime) ? {:asOfDateTime => params[:asOfDateTime]} : {}
     end
 
+    def datastream_nav_item(item)
+      case
+      when item == :dsid            then render_datastream_dsid_label
+      when item == :version         then render_datastream_version unless @datastream.current_version?
+      when item == :current_version then link_to_datastream item, !@datastream.current_version?, false
+      when item == :summary         then link_to_datastream item
+      when item == :content         then link_to_datastream item, @datastream.content_is_text?
+      when item == :download        then link_to_datastream item, @datastream.content_is_downloadable?, false
+      when item == :edit            then link_to_datastream item, @datastream.content_is_editable? && can?(:edit, @object)
+      when item == :upload          then link_to_datastream item, @datastream.content_is_uploadable? && can?(:upload, @object)
+      when item == :history         then link_to_datastream item, !@datastream.new?
+      else custom_datastream_nav_item item
+      end
+    end
+
+    def link_to_datastream(view, condition=true, unless_current=true)
+      return nil unless condition
+      path = case
+             when view == :current_version then fcrepo_admin.object_datastream_path(@object, @datastream)
+             when view == :summary         then fcrepo_admin.object_datastream_path(@object, @datastream, datastream_params)
+             when view == :content         then fcrepo_admin.content_object_datastream_path(@object, @datastream, datastream_params)
+             when view == :download        then fcrepo_admin.download_object_datastream_path(@object, @datastream, datastream_params)
+             when view == :edit            then fcrepo_admin.edit_object_datastream_path(@object, @datastream)
+             when view == :upload          then fcrepo_admin.upload_object_datastream_path(@object, @datastream)
+             when view == :history         then fcrepo_admin.history_object_datastream_path(@object, @datastream)
+             end
+      label = t("fcrepo_admin.datastream.nav.items.#{view}")
+      unless_current ? link_to_unless_current(label, path) : link_to(label, path)
+    end
+
+    def custom_datastream_nav_item(item)
+      # Override this method with your custom item behavior
+    end
+
+    def link_to_datastream_version(dsVersion)
+      link_to_unless dsVersion.current_version?, dsVersion.dsVersionID, fcrepo_admin.object_datastream_path(@object, @datastream, :asOfDateTime => dsVersion.asOfDateTime) do |name|
+        "#{name} (current version)"
+      end
+    end
+
+    def render_datastream_version
+      render :partial => 'version', :locals => {:datastream => @datastream}
+    end
+
+    def render_datastream_dsid_label
+      content_tag :span, @datastream.dsid, :class => "label"
+    end
+
+    def datastream_alerts(*alerts)
+      rendered = ""
+      alerts.each do |alert|
+        content = datastream_alert(alert)
+        rendered << content unless content.nil?
+      end
+      rendered.html_safe
+    end
+
+    def datastream_alert(alert)
+      case
+      when alert == :system_managed
+        if ["DC", "RELS-EXT", "rightsMetadata", "defaultRights"].include?(@datastream.dsid)
+          render_datastream_alert(alert, :caution => true)
+        end
+      when alert == :not_versionable        
+        render_datastream_alert(alert, :caution => true) unless @datastream.versionable
+      when alert == :inactive
+        render_datastream_alert(alert) if @datastream.inactive?
+      when alert == :deleted
+        render_datastream_alert(alert, :css_class => "alert alert-error") if @datastream.deleted?
+      end
+    end
+
+    def render_datastream_alert(alert, opts={})
+      render :partial => 'alert', :locals => {:alert => alert, :caution => opts.fetch(:caution, false), :css_class => opts.fetch(:css_class, "alert")}
+    end
+
+    def format_datastream_state(ds)
+      state = ds.dsState
+      formatted = case 
+                  when state == 'A' then "A (Active)"
+                  when state == 'I' then "I (Inactive)"
+                  when state == 'D' then "D (Deleted)"
+                  end
+      formatted
+    end
+
+    def format_datastream_control_group(ds)
+      control_group = ds.controlGroup
+      formatted = case
+                  when control_group == 'M' then "M (Managed)"
+                  when control_group == 'X' then "X (Inline XML)"
+                  when control_group == 'E' then "E (External Referenced)"
+                  when control_group == 'R' then "R (Redirect)"
+                  end
+      formatted
+    end
+
+    def format_datastream_version_id(ds)
+      version_id = ds.dsVersionID
+      version_id += " (#{t('fcrepo_admin.datastream.current_version')})" if ds.current_version?
+      version_id
+    end
+
+    def format_datastream_profile_value(ds, key)
+      case
+      when key == "dsSize" then number_to_human_size(ds.dsSize)
+      when key == "dsCreateDate" then ds.dsCreateDate.strftime("%Y-%m-%dT%H:%M:%S.%LZ")
+      when key == "dsLocation" && ds.content_is_url? then link_to(ds.dsLocation, ds.dsLocation)
+      when key == "dsState" then format_datastream_state(ds)
+      when key == "dsControlGroup" then format_datastream_control_group(ds)
+      when key == "dsVersionID" then format_datastream_version_id(ds)
+      else ds.profile[key]
+      end
+    end
+
   end
 end

data/lib/fcrepo_admin/helpers/objects_helper_behavior.rb

@@ -1,6 +1,5 @@
 module FcrepoAdmin::Helpers
   module ObjectsHelperBehavior
-    include FcrepoAdmin::Helpers::FcrepoAdminHelperBehavior
 
     def object_title
       "#{object_type} #{@object.pid}"
@@ -10,17 +9,57 @@ module FcrepoAdmin::Helpers
       @object.class.to_s
     end
 
-    def object_properties_keys
-      [:owner_id, :state, :create_date, :modified_date, :label]
-    end
-
     def object_properties
-      object_properties_keys.inject(Hash.new) { |h, p| h[p] = @object.send(p); h }
+      FcrepoAdmin.object_properties.inject(Hash.new) { |h, p| h[p] = @object.send(p); h }
     end
 
-    # List of ds profile keys for for object show view
     def object_show_datastream_columns
-      ["dsLabel"]
+      FcrepoAdmin.object_show_datastream_columns
+    end
+
+    def object_nav
+      render :partial => 'fcrepo_admin/shared/context_nav', :locals => {:header => object_nav_header, :items => object_nav_items}
+    end
+
+    def object_nav_header
+	  t("fcrepo_admin.object.nav.header")
+    end
+
+    def object_nav_items
+      FcrepoAdmin.object_nav_items.collect { |item| object_nav_item(item) }.reject { |item| item.nil? }
+    end
+
+    def object_nav_item(item)
+      case
+      when item == :pid          then render_object_pid_label
+      when item == :summary      then link_to_object item
+      when item == :datastreams  then link_to_object item
+      when item == :permissions  then link_to_object item, @object.has_permissions? && can?(:permissions, @object)
+      when item == :associations then link_to_object item
+      when item == :audit_trail  then link_to_object item, @object.auditable? && can?(:audit_trail, @object)
+      else custom_object_nav_item item
+      end
+    end
+
+    def render_object_pid_label
+      content_tag :span, @object.pid, :class => "label"
+    end
+
+    def link_to_object(view, condition=true)
+      return nil unless condition
+      label = t("fcrepo_admin.object.nav.items.#{view}")
+      path = case
+             when view == :summary      then fcrepo_admin.object_path(@object)
+             when view == :datastreams  then fcrepo_admin.object_datastreams_path(@object)
+             when view == :permissions  then fcrepo_admin.permissions_object_path(@object)
+             when view == :associations then fcrepo_admin.object_associations_path(@object)
+             when view == :audit_trail  then fcrepo_admin.audit_trail_object_path(@object)
+             end
+      link_to_unless_current label, path
+    end
+
+    def custom_object_nav_item(item)
+      # Override this method with your custom item behavior
     end
     
   end