hydra-works 0.16.0 → 2.0.0

data/lib/hydra/works/characterization/schema/audio_schema.rb

@@ -4,6 +4,8 @@ module Hydra::Works::Characterization
     property :channels, predicate: RDF::Vocab::NFO.channels
     property :data_format, predicate: RDF::Vocab::EBUCore.hasDataFormat
     property :frame_rate, predicate: RDF::Vocab::NFO.frameRate
+    # bit_rate might be an array containing multiple values
+    property :bit_rate, predicate: RDF::Vocab::EBUCore.bitRate
     property :duration, predicate: RDF::Vocab::NFO.duration
     property :sample_rate, predicate: RDF::Vocab::EBUCore.sampleRate
     # properties without cannonical URIs

data/lib/hydra/works/characterization/schema/video_schema.rb

@@ -3,7 +3,9 @@ module Hydra::Works::Characterization
     property :height, predicate: RDF::Vocab::EBUCore.height
     property :width, predicate: RDF::Vocab::EBUCore.width
     property :frame_rate, predicate: RDF::Vocab::NFO.frameRate
+    property :bit_rate, predicate: RDF::Vocab::EBUCore.bitRate
     property :duration, predicate: RDF::Vocab::NFO.duration
     property :sample_rate, predicate: RDF::Vocab::EBUCore.sampleRate
+    property :aspect_ratio, predicate: RDF::Vocab::EBUCore.aspectRatio
   end
 end

data/lib/hydra/works/models/concerns/collection_behavior.rb

@@ -28,6 +28,30 @@ module Hydra::Works
       type [Hydra::PCDM::Vocab::PCDMTerms.Collection, Vocab::WorksTerms.Collection]
     end
 
+    def parent_collections
+      in_collections + member_of_collections
+    end
+
+    def parent_collection_ids
+      in_collection_ids + member_of_collection_ids
+    end
+
+    def child_collections
+      collections + member_collections
+    end
+
+    def child_collection_ids
+      collection_ids + member_collection_ids
+    end
+
+    def child_works
+      works + member_works
+    end
+
+    def child_work_ids
+      work_ids + member_work_ids
+    end
+
     def ordered_works
       ordered_members.to_a.select(&:work?)
     end
@@ -44,6 +68,26 @@ module Hydra::Works
       works.map(&:id)
     end
 
+    def member_collections
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('member_of_collection_ids_ssim' => id)
+      member_objects.select(&:collection?).to_a
+    end
+
+    def member_collection_ids
+      member_collections.map(&:id)
+    end
+
+    def member_works
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('member_of_collection_ids_ssim' => id)
+      member_objects.select(&:work?).to_a
+    end
+
+    def member_work_ids
+      member_works.map(&:id)
+    end
+
     # @return [Boolean] whether this instance is a Hydra::Works Collection.
     def collection?
       true

data/lib/hydra/works/models/concerns/file_set_behavior.rb

@@ -43,10 +43,30 @@ module Hydra::Works
       true
     end
 
+    def parent_works
+      in_works + member_of_works
+    end
+
+    def parent_work_ids
+      in_work_ids + member_of_work_ids
+    end
+
     def in_works
       ordered_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::WorkBehavior) }.to_a
     end
 
+    def in_work_ids
+      in_works.map(&:id)
+    end
+
+    def member_of_works
+      member_of.select(&:work?).to_a
+    end
+
+    def member_of_work_ids
+      member_of_works.map(&:id)
+    end
+
     private
 
       def remove_from_works

data/lib/hydra/works/models/concerns/work_behavior.rb

@@ -29,6 +29,38 @@ module Hydra::Works
       type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.Work]
     end
 
+    def parent_collections
+      in_collections + member_of_collections
+    end
+
+    def parent_collection_ids
+      in_collection_ids + member_of_collection_ids
+    end
+
+    def parent_works
+      in_works + member_of_works
+    end
+
+    def parent_work_ids
+      in_work_ids + member_of_work_ids
+    end
+
+    def child_works
+      works + member_works
+    end
+
+    def child_work_ids
+      work_ids + member_work_ids
+    end
+
+    def child_file_sets
+      file_sets
+    end
+
+    def child_file_set_ids
+      file_set_ids
+    end
+
     def works
       members.select(&:work?)
     end
@@ -37,6 +69,16 @@ module Hydra::Works
       works.map(&:id)
     end
 
+    def member_works
+      return [] if id.nil?
+      member_objects = ActiveFedora::Base.where('object_ids_ssim' => id)
+      member_objects.select(&:work?).to_a
+    end
+
+    def member_work_ids
+      member_works.map(&:id)
+    end
+
     def ordered_works
       ordered_members.to_a.select(&:work?)
     end
@@ -82,6 +124,18 @@ module Hydra::Works
       ordered_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::WorkBehavior) }.to_a
     end
 
+    def in_work_ids
+      in_works.map(&:id)
+    end
+
+    def member_of_works
+      in_objects.to_a.select(&:work?)
+    end
+
+    def member_of_work_ids
+      member_of_works.map(&:id)
+    end
+
     private
 
       # Remove this object from parent works or collections

data/lib/hydra/works/services/add_external_file_to_file_set.rb

@@ -15,7 +15,7 @@ module Hydra::Works
       versioning = opts.fetch(:versioning, true)
       filename = opts.fetch(:filename, external_file_url)
 
-      # TODO: required as a workaround for https://github.com/projecthydra/active_fedora/pull/858
+      # TODO: required as a workaround for https://github.com/samvera/active_fedora/pull/858
       file_set.save unless file_set.persisted?
 
       updater_class = versioning ? VersioningUpdater : Updater

data/lib/hydra/works/services/add_file_to_file_set.rb

@@ -11,7 +11,7 @@ module Hydra::Works
       fail ArgumentError, 'supplied object must be a file set' unless file_set.file_set?
       fail ArgumentError, 'supplied file must respond to read' unless file.respond_to? :read
 
-      # TODO: required as a workaround for https://github.com/projecthydra/active_fedora/pull/858
+      # TODO: required as a workaround for https://github.com/samvera/active_fedora/pull/858
       file_set.save unless file_set.persisted?
 
       updater_class = versioning ? VersioningUpdater : Updater

data/lib/hydra/works/services/characterization_service.rb

@@ -1,4 +1,5 @@
 require 'hydra-file_characterization'
+require 'nokogiri'
 
 module Hydra::Works
   class CharacterizationService
@@ -62,6 +63,7 @@ module Hydra::Works
       def parse_metadata(metadata)
         omdoc = parser_class.new
         omdoc.ng_xml = Nokogiri::XML(metadata) if metadata.present?
+        omdoc.__cleanup__ if omdoc.respond_to? :__cleanup__
         characterization_terms(omdoc)
       end
 
@@ -101,7 +103,10 @@ module Hydra::Works
       end
 
       def append_property_value(property, value)
+        # We don't want multiple mime_types; this overwrites each time to accept last value
         value = object.send(property) + [value] unless property == :mime_type
+        # We don't want multiple heights / widths, pick the max
+        value = value.map(&:to_i).max.to_s if property == :height || property == :width
         object.send("#{property}=", value)
       end
   end

data/lib/hydra/works/services/determine_original_name.rb

@@ -1,7 +1,7 @@
 module Hydra::Works
   class DetermineOriginalName
     # Determines the original name for a given file
-    # @param [IO, File, Rack::Multipart::UploadedFile, #read] file
+    # @param [IO, File, Rack::Multipart::UploadedFile] file
     # @return [String]
     def self.call(file)
       return file.original_name if file.respond_to?(:original_name)

data/lib/hydra/works/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Works
-    VERSION = '0.16.0'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

data/lib/hydra/works/virus_scanner.rb

@@ -30,16 +30,32 @@ module Hydra::Works
     # Override this method to use your own virus checking software
     # @return [Boolean]
     def infected?
-      defined?(ClamAV) ? clam_av_scanner : null_scanner
+      if defined?(Clamby)
+        clamby_scanner
+      elsif defined?(ClamAV)
+        clam_av_scanner
+      else
+        null_scanner
+      end
     end
 
     def clam_av_scanner
+      Deprecation.warn(self, "The ClamAV has been replaced by Clamby " \
+        "as the supported virus scanner for hydra-works. " \
+        "ClamAV support will be removed in hydra-works 2.0 ")
       scan_result = ClamAV.instance.method(:scanfile).call(file)
       return false if scan_result == 0
       warning "A virus was found in #{file}: #{scan_result}"
       true
     end
 
+    # @return [Boolean]
+    def clamby_scanner
+      scan_result = Clamby.virus?(file)
+      warning("A virus was found in #{file}") if scan_result
+      scan_result
+    end
+
     # Always return zero if there's nothing available to check for viruses. This means that
     # we assume all files have no viruses because we can't conclusively say if they have or not.
     def null_scanner
@@ -50,7 +66,7 @@ module Hydra::Works
     private
 
       def warning(msg)
-        ActiveFedora::Base.logger.warn(msg) if ActiveFedora::Base.logger
+        ActiveFedora::Base.logger&.warn(msg)
       end
   end
 end

data/spec/fixtures/fits_0.8.5_tiff.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul
+.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="0.8.5" timestamp="6/20/17 11:20 AM">
+  <identification>
+    <identity format="Tagged Image File Format" mimetype="image/tiff" toolname="FITS" toolversion="0.8.5">
+      <tool toolname="Jhove" toolversion="1.5" />
+      <tool toolname="file utility" toolversion="5.14" />
+      <tool toolname="Exiftool" toolversion="9.13" />
+      <tool toolname="ffident" toolversion="0.2" />
+      <tool toolname="Tika" toolversion="1.3" />
+      <version toolname="Jhove" toolversion="1.5">6.0</version>
+    </identity>
+  </identification>
+  <fileinfo>
+    <size toolname="Jhove" toolversion="1.5">11082294</size>
+    <creatingApplicationName toolname="Jhove" toolversion="1.5">Capture One 8 Macintosh</creatingApplicationName>
+    <lastmodified toolname="Exiftool" toolversion="9.13" status="CONFLICT">2017:06:19 14:26:24-04:00</lastmodified>
+    <lastmodified toolname="Tika" toolversion="1.3" status="CONFLICT">2016-08-22T11:40:49</lastmodified>
+    <created toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">2016:08:22 11:40:49</created>
+    <filepath toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">/home/ubuntu/2012-002_928.tif</filepath>
+    <filename toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">2012-002_928.tif</filename>
+    <md5checksum toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">b8344bf2f88bd421986d9ac988578e28</md5checksum>
+    <fslastmodified toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">1497896784000</fslastmodified>
+  </fileinfo>
+  <filestatus>
+    <well-formed toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">true</well-formed>
+    <valid toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">true</valid>
+  </filestatus>
+  <metadata>
+    <image>
+      <byteOrder toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">little endian</byteOrder>
+      <byteOrder toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">little endian</byteOrder>
+      <compressionScheme toolname="Jhove" toolversion="1.5">Uncompressed</compressionScheme>
+      <imageWidth toolname="Tika" toolversion="1.3" status="CONFLICT">160</imageWidth>
+      <imageWidth toolname="Jhove" toolversion="1.5" status="CONFLICT">2226</imageWidth>
+      <imageHeight toolname="Jhove" toolversion="1.5" status="CONFLICT">1650</imageHeight>
+      <imageHeight toolname="Tika" toolversion="1.3" status="CONFLICT">119</imageHeight>
+      <colorSpace toolname="Jhove" toolversion="1.5">RGB</colorSpace>
+      <referenceBlackWhite toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">0.0 255.0 0.0 255.0 0.0 255.0 0.0 255.0 0.0 255.0 0.0 255.0</referenceBlackWhite>
+      <iccProfileName toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">Adobe RGB (1998)</iccProfileName>
+      <orientation toolname="Jhove" toolversion="1.5">normal*</orientation>
+      <samplingFrequencyUnit toolname="Jhove" toolversion="1.5">in.</samplingFrequencyUnit>
+      <xSamplingFrequency toolname="Jhove" toolversion="1.5">300</xSamplingFrequency>
+      <ySamplingFrequency toolname="Jhove" toolversion="1.5">300</ySamplingFrequency>
+      <bitsPerSample toolname="Jhove" toolversion="1.5">8 8 8</bitsPerSample>
+      <bitsPerSample toolname="Jhove" toolversion="1.5" status="SINGLE_RESULT">8 8 8</bitsPerSample>
+      <samplesPerPixel toolname="Jhove" toolversion="1.5" status="CONFLICT">3 3</samplesPerPixel>
+      <samplesPerPixel toolname="Exiftool" toolversion="9.13" status="CONFLICT">3</samplesPerPixel>
+      <scanningSoftwareName toolname="Jhove" toolversion="1.5">Capture One 8 Macintosh</scanningSoftwareName>
+      <digitalCameraModelName toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">IQ3 80MP</digitalCameraModelName>
+      <exposureTime toolname="Jhove" toolversion="1.5" status="CONFLICT">0.017</exposureTime>
+      <exposureTime toolname="Exiftool" toolversion="9.13" status="CONFLICT">1/60</exposureTime>
+      <isoSpeedRating toolname="Jhove" toolversion="1.5">50</isoSpeedRating>
+      <lightSource toolname="Jhove" toolversion="1.5" status="CONFLICT">other</lightSource>
+      <lightSource toolname="Exiftool" toolversion="9.13" status="CONFLICT">other light source</lightSource>
+      <iccProfileVersion toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">2.1.0</iccProfileVersion>
+      <captureDevice toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">digital still camera</captureDevice>
+      <digitalCameraManufacturer toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">Phase One</digitalCameraManufacturer>
+      <exposureProgram toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">Manual</exposureProgram>
+      <exifVersion toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">0220</exifVersion>
+      <shutterSpeedValue toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">1/60</shutterSpeedValue>
+      <sensingMethod toolname="Exiftool" toolversion="9.13" status="SINGLE_RESULT">One-chip color area sensor</sensingMethod>
+    </image>
+  </metadata>
+  <statistics fitsExecutionTime="1523">
+    <tool toolname="OIS Audio Information" toolversion="0.1" status="did not run" />
+    <tool toolname="ADL Tool" toolversion="0.1" status="did not run" />
+    <tool toolname="Jhove" toolversion="1.5" executionTime="1220" />
+    <tool toolname="file utility" toolversion="5.14" executionTime="964" />
+    <tool toolname="Exiftool" toolversion="9.13" executionTime="1110" />
+    <tool toolname="NLNZ Metadata Extractor" toolversion="3.4GA" status="did not run" />
+    <tool toolname="OIS File Information" toolversion="0.2" executionTime="225" />
+    <tool toolname="OIS XML Metadata" toolversion="0.2" status="did not run" />
+    <tool toolname="ffident" toolversion="0.2" executionTime="695" />
+    <tool toolname="Tika" toolversion="1.3" executionTime="1371" />
+  </statistics>
+</fits>
+

data/spec/fixtures/fits_1.2.0_avi.xml

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fits xmlns="http://hul.harvard.edu/ois/xml/ns/fits/fits_output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hul.harvard.edu/ois/xml/ns/fits/fits_output http://hul.harvard.edu/ois/xml/xsd/fits/fits_output.xsd" version="1.2.0" timestamp="4/4/18 4:12 PM">
+  <identification status="CONFLICT">
+    <identity format="AVI" mimetype="video/avi" toolname="FITS" toolversion="1.2.0">
+      <tool toolname="MediaInfo" toolversion="0.7.75" />
+    </identity>
+    <identity format="Audio/Video Interleaved Format" mimetype="video/x-msvideo" toolname="FITS" toolversion="1.2.0">
+      <tool toolname="Droid" toolversion="6.3" />
+      <tool toolname="file utility" toolversion="5.31" />
+      <tool toolname="ffident" toolversion="0.2" />
+      <externalIdentifier toolname="Droid" toolversion="6.3" type="puid">fmt/5</externalIdentifier>
+    </identity>
+  </identification>
+  <fileinfo>
+    <filepath toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">/Users/cjcolvar/Documents/Code/samvera/hydra-works/spec/fixtures/countdown.avi</filepath>
+    <filename toolname="MediaInfo" toolversion="0.7.75">countdown.avi</filename>
+    <size toolname="MediaInfo" toolversion="0.7.75">723678</size>
+    <md5checksum toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">d43ffafa098925dae10feeca46dc9a87</md5checksum>
+    <fslastmodified toolname="OIS File Information" toolversion="0.2" status="SINGLE_RESULT">1522855873000</fslastmodified>
+  </fileinfo>
+  <filestatus />
+  <metadata>
+    <video>
+      <location toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">/Users/cjcolvar/Documents/Code/samvera/hydra-works/spec/fixtures/countdown.avi</location>
+      <mimeType toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">video/avi</mimeType>
+      <format toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">AVI</format>
+      <duration toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">14148</duration>
+      <bitRate toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">409204</bitRate>
+      <dateModified toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">UTC 2018-04-04 15:31:13</dateModified>
+      <track type="video" id="0" toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">
+        <videoDataEncoding>CRAM</videoDataEncoding>
+        <codecId>CRAM</codecId>
+        <codecCC>CRAM</codecCC>
+        <codecName>CRAM</codecName>
+        <codecInfo>Microsoft Video 1</codecInfo>
+        <compression>Unknown</compression>
+        <byteOrder>Unknown</byteOrder>
+        <bitDepth>8 bits</bitDepth>
+        <bitRate>313826</bitRate>
+        <duration>14100</duration>
+        <delay>0</delay>
+        <trackSize>553118</trackSize>
+        <width>356 pixels</width>
+        <height>264 pixels</height>
+        <frameRate>10.000</frameRate>
+        <frameCount>141</frameCount>
+        <aspectRatio>4:3</aspectRatio>
+      </track>
+      <track type="audio" id="1" toolname="MediaInfo" toolversion="0.7.75" status="SINGLE_RESULT">
+        <audioDataEncoding>PCM</audioDataEncoding>
+        <codecId>1</codecId>
+        <codecFamily>PCM</codecFamily>
+        <compression>none</compression>
+        <bitRate>88200</bitRate>
+        <bitRateMode>Constant</bitRateMode>
+        <bitDepth>8 bits</bitDepth>
+        <duration>14148</duration>
+        <delay>0</delay>
+        <trackSize>155980</trackSize>
+        <samplingRate>11025</samplingRate>
+        <numSamples>155982</numSamples>
+        <channels>1</channels>
+        <byteOrder>Little</byteOrder>
+      </track>
+    </video>
+  </metadata>
+  <statistics fitsExecutionTime="692">
+    <tool toolname="MediaInfo" toolversion="0.7.75" executionTime="662" />
+    <tool toolname="OIS Audio Information" toolversion="0.1" status="did not run" />
+    <tool toolname="ADL Tool" toolversion="0.1" status="did not run" />
+    <tool toolname="VTT Tool" toolversion="0.1" status="did not run" />
+    <tool toolname="Droid" toolversion="6.3" executionTime="273" />
+    <tool toolname="Jhove" toolversion="1.16" status="did not run" />
+    <tool toolname="file utility" toolversion="5.31" executionTime="644" />
+    <tool toolname="Exiftool" toolversion="10.00" status="did not run" />
+    <tool toolname="NLNZ Metadata Extractor" toolversion="3.6GA" status="did not run" />
+    <tool toolname="OIS File Information" toolversion="0.2" executionTime="80" />
+    <tool toolname="OIS XML Metadata" toolversion="0.2" status="did not run" />
+    <tool toolname="ffident" toolversion="0.2" executionTime="555" />
+    <tool toolname="Tika" toolversion="1.10" status="did not run" />
+  </statistics>
+</fits>
+