cul_hydra 1.0.0

data/app/models/bag_aggregator.rb

@@ -0,0 +1,7 @@
+class BagAggregator < GenericAggregator
+
+  def route_as
+    "collection"
+  end
+
+end

data/app/models/concept.rb

@@ -0,0 +1,23 @@
+require "active-fedora"
+require "active_fedora_finders"
+class Concept < GenericAggregator
+  include ::ActiveFedora::FinderMethods::RepositoryMethods
+  include ::ActiveFedora::DatastreamCollections
+  include ::Hydra::ModelMethods
+  include Cul::Hydra::Models::Common
+
+  has_and_belongs_to_many :containers, :property=>:cul_member_of, :class_name=>'ActiveFedora::Base'
+
+  def route_as
+    "concept"
+  end
+
+  def index_type_label
+    "CONCEPT"
+  end
+
+  def to_solr(solr_doc = Hash.new, opts={})
+    solr_doc = super(solr_doc, opts)
+    solr_doc
+  end
+end

data/app/models/concerns/cul/hydra/models.rb

@@ -0,0 +1,24 @@
+require "active-fedora"
+require "cul_hydra/om"
+require 'uri'
+require 'rdf'
+module Cul
+module Hydra
+  module Models
+    AGGREGATOR_TYPE = RDF::CUL.Aggregator
+    RESOURCE_TYPE = RDF::CUL.Resource
+    MEMBER_OF = RDF::CUL.memberOf
+    MEMBER_SPARQL = <<-SPARQL
+      SELECT ?pid WHERE { ?pid <http://purl.oclc.org/NET/CUL/memberOf> <info:fedora/%PID%> }
+    SPARQL
+    MEMBER_ITQL = <<-ITQL
+      select $pid from <#ri> where $pid <http://purl.oclc.org/NET/CUL/memberOf> <info:fedora/%PID%>
+    ITQL
+    autoload :Aggregator, 'cul/hydra/models/aggregator'
+    autoload :Common, 'cul/hydra/models/common'
+    autoload :ImageResource, 'cul/hydra/models/image_resource'
+    autoload :LinkableResources, 'cul/hydra/models/linkable_resources'
+    autoload :Resource, 'cul/hydra/models/resource'
+  end
+end
+end

data/app/models/concerns/cul/hydra/models/aggregator.rb

@@ -0,0 +1,121 @@
+module Cul::Hydra::Models::Aggregator
+  extend ActiveSupport::Concern
+
+  included do
+    has_and_belongs_to_many :containers, :property=>:cul_member_of, :class_name=>'ActiveFedora::Base'
+    has_metadata :name => "structMetadata", :type=>Cul::Hydra::Datastreams::StructMetadata, :versionable => true, :controlGroup => 'M'
+    after_create :aggregator!
+  end
+
+  def aggregator!
+    add_relationship(:rdf_type, Cul::Hydra::Models::AGGREGATOR_TYPE.to_s)
+    @metadata_is_dirty = true
+    self.save
+  end
+
+  def add_member(member, container=self)
+    member.add_relationship(:cul_member_of, to_uri(container))
+    member.datastreams["RELS-EXT"].content_will_change!
+    member.save
+  end
+
+  def remove_member(member, container=self)
+    rel = ActiveFedora::Relationship.new()
+    rel.subject_pid= :self
+    rel.object = to_uri(container)
+    rel.predicate = :cul_member_of
+    member.remove_relationship(rel)
+    member.datastreams["RELS-EXT"].content_will_change!
+    member.save
+  end
+
+  def has_struct_metadata?
+    return (!datastreams['structMetadata'].nil?) && datastreams['structMetadata'].has_content?
+  end
+
+  def solr_members(opts={})
+    opts = {:rows=>25,:response_format=>:solr}.merge(opts)
+    r = self.parts(opts)
+    members = []
+    r.collect {|hit| members << SolrDocument.new(hit) } unless r.blank?
+    members
+  end
+
+  def members(opts={})
+    parts({:response_format=>:solr}.merge(opts))
+  end
+
+  def member_ids(opts={})
+    solr_members(opts).collect {|hit| hit.id}
+  end
+
+  def thumbnail_info
+    members = solr_members
+    if members.length == 0
+      thumb = {:asset=>"cul_hydra/crystal/file.png",:mime=>'image/png'}
+    else
+      thumb = nil
+      unless datastreams['structMetadata'].new?
+        thumb = thumb_from_struct(members)
+      else
+        thumb =  thumb_from_members(members)
+      end
+    end
+    return thumb || {:asset=>"cul_hydra/crystal/file.png",:mime=>'image/png'}
+  end
+
+  private
+  def thumb_from_struct(members)
+    puts "thumb thumb_from_struct"
+    sm = datastreams['structMetadata']
+    first = sm.divs_with_attribute(false,'ORDER','1').first
+    if first
+      members.each do |member|
+        puts "looking for #{first["CONTENTIDS"]} in #{member["identifier_ssim"].inspect}"
+        if member["identifier_ssim"].include? first["CONTENTIDS"]
+          return thumb_from_solr_doc(member)
+        end
+      end
+      return thumb_from_solr_doc(members.first) if members.first
+    else
+      return nil
+    end
+  end
+
+  def thumb_from_members(members)
+    sorted = members.sort do |a,b|
+      c = a['title_si'] <=> b['title_si']
+      if c == 0 && a['identifier_ssim']
+        if b['identifier_ssim']
+          a['identifier_ssim'].delete(a.id) unless a['identifier_ssim'].length == 1
+          b['identifier_ssim'].delete(a.id) unless b['identifier_ssim'].length == 1
+          a['identifier_ssim'][0] <=> b['identifier_ssim'][0]
+        else
+          -1
+        end
+      else
+        c
+      end
+    end
+    thumb_from_solr_doc(sorted[0])
+  end
+
+  def thumb_from_solr_doc(solr_doc)
+    if solr_doc and (member =  ActiveFedora::Base.find(solr_doc.id, :cast=>true)).respond_to? :thumbnail_info
+      member.thumbnail_info
+    else
+      return nil
+    end
+  end
+
+  def to_uri(obj)
+    if obj.respond_to? :internal_uri
+      return obj.internal_uri
+    end
+    obj = obj.pid unless obj.is_a? String
+    if obj.is_a? String and obj =~ /\A[\w\-]+:[\w\-]+\Z/
+      obj = "info:fedora/#{obj}"
+    end
+    return obj
+  end
+end

data/app/models/concerns/cul/hydra/models/common.rb

@@ -0,0 +1,220 @@
+require 'active-fedora'
+require 'uri'
+module Cul::Hydra::Models::Common
+  extend ActiveSupport::Concern
+
+  included do
+    extend ActiveModel::Callbacks
+    define_model_callbacks :create
+    has_metadata :name => "DC", :type=>Cul::Hydra::Datastreams::DCMetadata, :versionable => true
+    has_metadata :name => "descMetadata", :type=>Cul::Hydra::Datastreams::ModsDocument, :versionable => true
+    has_metadata :name => "rightsMetadata", :type=>::Hydra::Datastream::RightsMetadata, :versionable => true
+    has_many :publishers, :property => :publisher, :class_name=>'ActiveFedora::Base'
+  end
+
+  module ClassMethods
+    def pid_namespace
+      'ldpd'
+    end
+
+  end
+
+  # A Fedora object label can only contain a string value of up to 255 characters.  If we try to
+  # set a longer value, it causes errors upon object save.  Truncate labels to 255 characters.
+  # Note: this method maps to a method_missing hanlder that converts input into a String, so
+  # we use the super method first, and then post-process the output of that super method call.
+  def label=(new_label)
+    super(new_label)
+    super(self.label[0,255])
+  end
+
+  def rdf_type
+    relationships[:rdf_type]
+  end
+
+  def initialize(attrs = nil)
+    attrs = {} if attrs.nil?
+    attrs[:namespace] = self.class.pid_namespace unless attrs[:namespace]
+    super
+  end
+
+  def cmodel_pid(klass)
+    klass.pid_namespace + ":" + klass.name.split("::")[-1]
+  end
+
+  def datastreams_in_fedora
+    mds = {}
+    self.datastreams_xml['datastream'].each do |ds|
+      dsid = ds["dsid"]
+      ds.merge!({:pid => self.pid, :dsID => dsid, :dsLabel => ds["label"]})
+      if dsid == "RELS-EXT"
+        mds.merge!({dsid => ActiveFedora::RelsExtDatastream.new(ds)})
+      else
+        if self.class.ds_specs.has_key? dsid
+          mds.merge!({dsid => self.class.ds_specs[dsid][0].new(ds)})
+        else
+          mds.merge!({dsid => ActiveFedora::Datastream.new(ds)})
+        end
+      end
+      mds[dsid].new_object = false
+    end
+    mds
+  end
+
+  def route_as
+    "default"
+  end
+
+  def has_desc?
+    has_desc = false
+    begin
+      has_desc = self.datastreams.include? "descMetadata"
+      has_desc = has_desc and self.inner_object.datastreams["descMetadata"].content.length > 0
+      has_desc = has_desc and self.datastreams["descMetadata"].term_values(:identifier).length > 0
+    rescue
+      has_desc = false
+    end
+    has_desc
+  end
+
+  # set the index type label and any RI-based fields
+  def set_size_labels(solr_doc={})
+    solr_doc["index_type_label_ssi"] = [self.index_type_label]
+  end
+
+  def to_solr(solr_doc = Hash.new, opts={})
+    solr_doc = super(solr_doc, opts)
+
+    if has_desc?
+      solr_doc["descriptor_ssi"] = ["mods"]
+    else
+      solr_doc["descriptor_ssi"] = ["dublin core"]
+    end
+    # if no mods, pull some values from DC
+    if (solr_doc["title_display_ssm"].nil? or solr_doc["title_display_ssm"].length == 0)
+      if self.datastreams["DC"].term_values(:dc_title).first
+        solr_doc["title_display_ssm"] = self.datastreams["DC"].term_values(:dc_title)
+      else
+        solr_doc["title_display_ssm"] = self.datastreams["DC"].term_values(:dc_identifier).reject {|dcid| dcid.eql? self.id}
+      end
+      solr_doc["title_si"] = self.datastreams["DC"].term_values(:dc_title).first
+      if self.datastreams["DC"].term_values(:dc_relation).first
+        self.datastreams["DC"].term_values(:dc_relation).each {|val|
+          if val =~ /clio:/
+            solr_doc["clio_ssim"] ||= []
+            solr_doc["clio_ssim"] << val.split(':')[-1]
+          end
+        }
+      end
+    end
+    if (solr_doc["identifier_ssim"].nil? or solr_doc["identifier_ssim"].length == 0)
+        solr_doc["identifier_ssim"] = self.datastreams["DC"].term_values(:dc_identifier).reject {|dcid| dcid.eql? self.id}
+    end
+    if (solr_doc["title_display_ssm"].length > 1)
+      solr_doc["title_display_ssm"].uniq!
+    end
+
+    if solr_doc["contributor_ssim"].present?
+      if solr_doc["contributor_ssim"].is_a?(Array)
+        solr_doc["contributor_first_si"] = solr_doc["contributor_ssim"].first
+      else
+        solr_doc["contributor_first_si"] = solr_doc["contributor_ssim"]
+      end
+    end
+
+
+    solr_doc["format_ssi"] = [self.route_as]
+
+    set_size_labels(solr_doc)
+
+    solr_doc.each_pair {|key, value|
+      if value.is_a? Array
+        value.each {|v| v.strip! unless v.nil? }
+      elsif value.is_a? String
+        value.strip!
+      end
+    }
+    solr_doc[:structured_bsi] = 'false' unless solr_doc.has_key? :structured_bsi
+
+    solr_doc
+  end
+
+  def update_datastream_attributes(params={}, opts={})
+    logger.debug "Common.update_datastream_attributes"
+    result = params.dup
+    params.each_pair do |dsid, ds_params|
+      if datastreams.include?(dsid)
+        verify_params = ds_params.dup
+        changed = false
+        verify_params.each { |pointer, values|
+          changed ||= value_changed?(datastreams[dsid],pointer,values)
+        }
+        if changed
+          logger.debug "Common.update_datastream_attributes calling update_indexed_attributes"
+          result[dsid] = datastreams[dsid].update_indexed_attributes(ds_params)
+        else
+          result[dsid] = no_update(ds_params)
+        end
+        logger.debug "change detected? #{changed} digital_object? #{datastreams[dsid].changed?}"
+      else
+        result.delete(dsid)
+      end
+    end
+    return result
+  end
+
+  def thumbnail_info
+    {:asset=>("cul_hydra/crystal/kmultiple.png"),:mime_type=>"image/png"}
+  end
+
+  private
+  def value_changed?(ds,pointer,values)
+    if values.is_a? Hash
+      values = values.dup
+    else
+      values = {"0"=>values}
+    end
+    logger.debug "submitted values for #{pointer.inspect} : #{values.inspect}"
+    return true if values["-1"]
+    changed = false
+    old_values = ds.get_values(pointer)
+    indexed_values = {}
+    old_values.each_index {|ix| indexed_values[ix.to_s] = old_values[ix] }
+    indexed_values.each {|k,v|
+      new_val = values.delete(k)
+      logger.debug "old: #{v} new: #{new_val} changed? #{!(v.eql? new_val)}"
+      changed ||= !(v.eql? new_val)
+    }
+    logger.debug "remaining values! #{values.inspect}" if values.length > 0
+    changed || (values.length > 0)
+  end
+
+  def no_update(ds_params)
+    response = {}
+    ds_params.each{|pointer, values|
+      returned = []
+      if values.is_a? Hash
+        keys = values.keys.sort {|x,y| x.to_i <=> y.to_i}
+        keys.each {|key| returned << values[key]}
+      else
+        returned << values
+      end
+      response[OM::XML::Terminology.term_hierarchical_name(pointer)] = returned
+    }
+  end
+
+  def legacy_content_path(ds, ds_root=ActiveFedora.config.credentials[:datastreams_root])
+    unless ds.controlGroup == 'M'
+      return ds.dsLocation
+    end
+    cd = ds.dsCreateDate
+    tz = ActiveFedora.config.credentials[:time_zone]
+    tzi = ActiveSupport::TimeZone.find_tzinfo(tz)
+    ld = tzi.utc_to_local(cd)
+    month = (ld.month < 10) ? "0#{ld.month}" : ld.month.to_s
+    day = (ld.day < 10) ? "0#{ld.day}" : ld.day.to_s
+    hour = (ld.hour < 10) ? "0#{ld.hour}" : ld.hour.to_s
+    min = (ld.min < 10) ? "0#{ld.min}" : ld.min.to_s
+    return File.join(ds_root,"#{ld.year}/#{month}#{day}/#{hour}/#{min}", ds.dsLocation.sub(':','_'))
+  end
+end

data/app/models/concerns/cul/hydra/models/image_resource.rb

@@ -0,0 +1,106 @@
+module Cul::Hydra::Models::ImageResource
+  IMAGE_EXT = {"image/bmp" => 'bmp', "image/gif" => 'gif', "image/jpeg" => 'jpg', "image/png" => 'png', "image/tiff" => 'tif', "image/x-windows-bmp" => 'bmp', 'image/jp2' => 'jp2'}
+  WIDTH = RDF::URI(ActiveFedora::Predicates.find_graph_predicate(:image_width))
+  LENGTH = RDF::URI(ActiveFedora::Predicates.find_graph_predicate(:image_length))
+  WIDTH_PREDICATE = ActiveFedora::Predicates.short_predicate("http://www.w3.org/2003/12/exif/ns#imageWidth").to_s
+  LENGTH_PREDICATE = ActiveFedora::Predicates.short_predicate("http://www.w3.org/2003/12/exif/ns#imageLength").to_s
+  EXTENT_PREDICATE = ActiveFedora::Predicates.short_predicate("http://purl.org/dc/terms/extent").to_s
+  FORMAT_OF_PREDICATE = ActiveFedora::Predicates.short_predicate("http://purl.org/dc/terms/isFormatOf").to_s
+  FORMAT_URI = RDF::URI("http://purl.org/dc/terms/format")
+
+  DJATOKA_THUMBNAIL_PARMS = {
+    "url_ver" => "Z39.88-2004",
+    "svc_id" => "info:lanl-repo/svc/getRegion",
+    "svc_val_fmt" => "info:ofi/fmt:kev:mtx:jpeg2000",
+    "svc.format" => "image/jpeg",
+    "svc.level" => "",
+    "svc.rotate" => "0",
+    "svc.scale" => "200",
+    "svc.clayers" => ""
+  }
+
+  DJATOKA_BASE_URL = "http://iris.cul.columbia.edu:8888/resolve"
+
+  EXIF_ORIENTATION_TO_DEGREES = {
+    'top-left' => 0,
+    'left-bottom' => 90,
+    'bottom-right' => 180,
+    'right-top' => 270
+  }
+  DEGREES_TO_EXIF_ORIENTATIONS = EXIF_ORIENTATION_TO_DEGREES.invert
+
+  def long
+    @long_side ||= max(width(), length())
+  end
+
+  def width
+    @width ||= begin
+      ds = datastreams["content"]
+      width = 0
+      unless ds.nil? or rels_int.relationships(ds,:exif_image_width).blank?
+        width = rels_int.relationships(ds,:exif_image_width).first.object.to_s.to_i
+      end
+      width = relationships(:image_width).first.to_s.to_i if width == 0
+      width
+    end
+  end
+
+  def length
+    @length ||= begin
+      ds = datastreams["content"]
+      length = 0
+      unless ds.nil? or rels_int.relationships(ds,:exif_image_length).blank?
+        length = rels_int.relationships(ds,:exif_image_length).first.object.to_s.to_i
+      end
+      length = relationships(:image_length).first.to_s.to_i if length == 0
+      length
+    end
+  end
+
+  def zooming?
+    zoom = rels_int.relationships(datastreams['content'],:foaf_zooming).first
+    return zoom.object.to_s if zoom
+    datastreams.each do |k,v|
+      if v.mimeType =~ /image\/jp2$/i
+        zoom = "info:fedora/#{k.dsid}"
+      end
+    end
+    return zoom
+  end
+
+  def thumbnail_info
+    thumb = rels_int.relationships(datastreams['content'],:foaf_thumbnail).first
+    if thumb
+      t_dsid = thumb.object.to_s.split('/')[-1]
+      t_url = "#{ActiveFedora.fedora_config.credentials[:url]}/objects/#{pid}/datastreams/#{t_dsid}/content"
+      return {:url=>t_url,:mime=>datastreams[t_dsid].mimeType}
+    elsif (zoom = self.zooming?)
+      t_dsid = zoom.split('/')[-1]
+      t_parms = DJATOKA_THUMBNAIL_PARMS.merge({"rft_id" => datastreams[t_dsid].dsLocation})
+      url = "#{DJATOKA_BASE_URL}?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }"
+      {:url => url, :mime => t_parms["svc.format"]}
+    else
+      return {:asset=>"cul_hydra/crystal/file.png",:mime=>'image/png'}
+    end
+  end
+
+  # The number of rotational degrees required to display this image as upright
+  def required_rotation_for_upright_display
+    required_rotation_orientation_in_degrees = (360 - self.orientation) % 360
+    return required_rotation_orientation_in_degrees
+  end
+
+  # Allowed degrees arg values: 0, 90, 180, 270
+  def orientation=(degrees)
+    degrees = degrees % 360
+    raise "Invalid value for degrees.  Must be a right angle (0, 90, 180, etc.)" unless (degrees % 90 == 0)
+    self.clear_relationship(:orientation)
+    self.add_relationship(:orientation, DEGREES_TO_EXIF_ORIENTATIONS[degrees], true)
+    return degrees # Hide RDF backing structure and make this look like a simple setter method
+  end
+
+  def orientation
+    self.relationships(:orientation).present? ? EXIF_ORIENTATION_TO_DEGREES[self.relationships(:orientation).first.to_s] : 0
+  end
+
+end