sufia 1.3.0 → 2.0.0

data/sufia-models/config/locales/sufia.en.yml

@@ -0,0 +1,6 @@
+en:
+  sufia:
+    product_name:       "ScholarSphere"
+    institution_name:   "Penn State"
+    institution_name_full: "The Pennsylvania State University"                                                
+

data/sufia-models/lib/sufia/models.rb

@@ -0,0 +1,34 @@
+require "sufia/models/version"
+require "sufia/models/engine"
+require 'hydra/head'
+require 'devise'
+require 'nest'
+require 'mailboxer'
+require 'acts_as_follower'
+require 'paperclip'
+require 'RMagick'
+require 'activerecord-import'
+require 'resque/server'
+
+module Sufia
+  extend ActiveSupport::Autoload
+
+  module Models
+  end
+
+  autoload :Utils, 'sufia/models/utils'
+
+  attr_writer :queue
+
+  def self.queue
+    @queue ||= config.queue.new('sufia')
+  end
+
+  def self.config(&block)
+    @@config ||= Sufia::Models::Engine::Configuration.new
+
+    yield @@config if block
+
+    return @@config
+  end
+end

data/sufia-models/lib/sufia/models/engine.rb

@@ -0,0 +1,61 @@
+require 'sufia/models/resque'
+module Sufia
+  module Models
+    def self.config(&block)
+      @@config ||= Engine::Configuration.new
+
+      yield @@config if block
+
+      return @@config
+    end
+
+    class Engine < ::Rails::Engine
+
+      # Set some configuration defaults
+      config.enable_ffmpeg = false
+      config.noid_template = '.reeddeeddk'
+      config.ffmpeg_path = 'ffmpeg'
+      config.fits_message_length = 5
+      config.temp_file_base = nil
+      config.minter_statefile = '/tmp/minter-state'
+      config.id_namespace = "sufia"
+      config.fits_path = "fits.sh"
+      config.enable_contact_form_delivery = false
+      config.dropbox_api_key = nil
+      config.queue = Sufia::Resque::Queue
+
+      config.autoload_paths += %W(
+        #{config.root}/lib/sufia/models/jobs
+        #{config.root}/app/models/datastreams
+      )
+
+      rake_tasks do
+        load File.expand_path('../../../tasks/sufia-models_tasks.rake', __FILE__)
+      end
+
+      initializer "patches" do
+        require 'sufia/models/active_fedora/redis'
+        require 'sufia/models/active_record/redis'
+        require 'sufia/models/active_support/core_ext/marshal'
+      end
+
+      initializer 'requires' do
+        require 'sufia/models/model_methods'
+        require 'sufia/models/noid'
+        require 'sufia/models/file_content'
+        require 'sufia/models/file_content/extract_metadata'
+        require 'sufia/models/file_content/versions'
+        require 'sufia/models/generic_file/actions'
+        require 'sufia/models/generic_file/audit'
+        require 'sufia/models/generic_file/characterization'
+        require 'sufia/models/generic_file/export'
+        require 'sufia/models/generic_file/permissions'
+        require 'sufia/models/generic_file/thumbnail'
+        require 'sufia/models/generic_file'
+        require 'sufia/models/user'
+        require 'sufia/models/id_service'
+        require 'sufia/models/solr_document_behavior'
+      end
+    end
+  end
+end

data/sufia-models/lib/sufia/models/file_content.rb

@@ -0,0 +1,9 @@
+module Sufia
+  module FileContent
+    extend ActiveSupport::Autoload
+
+    autoload :ExtractMetadata, 'sufia/models/file_content/extract_metadata'
+    autoload :Versions, 'sufia/models/file_content/versions'
+
+  end
+end

data/{lib/sufia → sufia-models/lib/sufia/models}/file_content/extract_metadata.rb

@@ -14,7 +14,7 @@ module Sufia
 
       def to_tempfile &block
         return unless has_content?
-        tmp_base = Sufia::Engine.config.temp_file_base
+        tmp_base = Sufia.config.temp_file_base
         f = Tempfile.new("#{pid}-#{dsVersionID}")
         f.binmode
         if content.respond_to? :read
@@ -52,7 +52,7 @@ module Sufia
 
 
         def fits_path
-          Sufia::Engine.config.fits_path
+          Sufia.config.fits_path
         end
 
       end

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file.rb

@@ -1,7 +1,3 @@
-require 'datastreams/generic_file_rdf_datastream'
-require 'datastreams/properties_datastream'
-require 'datastreams/file_content_datastream'
-
 module Sufia
   module GenericFile
     extend ActiveSupport::Concern
@@ -12,7 +8,7 @@ module Sufia
     autoload :Audit
     autoload :Actions
     autoload :Permissions
-    autoload :WebForm
+    autoload :WebForm, 'sufia/models/generic_file/web_form'
     include Sufia::ModelMethods
     include Sufia::Noid
     include Sufia::GenericFile::Thumbnail
@@ -30,7 +26,7 @@ module Sufia
 
       belongs_to :batch, :property => :is_part_of
 
-      delegate_to :properties, [:relative_path, :depositor], :unique => true
+      delegate_to :properties, [:relative_path, :depositor, :import_url], :unique => true
       delegate_to :descMetadata, [:date_uploaded, :date_modified], :unique => true
       delegate_to :descMetadata, [:related_url, :based_near, :part_of, :creator,
                                   :contributor, :title, :tag, :description, :rights,
@@ -38,16 +34,9 @@ module Sufia
                                   :resource_type, :identifier, :language]
 
       around_save :characterize_if_changed, :retry_warming
-      before_save :remove_blank_assertions
       before_destroy :cleanup_trophies
     end
 
-    def remove_blank_assertions
-      terms_for_editing.each do |key|
-        self[key] = nil if self[key] == ['']
-      end
-    end
-
 
     def record_version_committer(user)
       version = content.latest_version
@@ -78,7 +67,7 @@ module Sufia
     end
 
     def persistent_url
-      "#{Sufia::Engine.config.persistent_hostpath}#{noid}"
+      "#{Sufia.config.persistent_hostpath}#{noid}"
     end
 
     def retry_warming
@@ -161,26 +150,6 @@ module Sufia
       end
     end
 
-    def to_jq_upload
-      return {
-        "name" => self.title,
-        "size" => self.file_size,
-        "url" => "/files/#{noid}",
-        "thumbnail_url" => self.pid,
-        "delete_url" => "deleteme", # generic_file_path(:id => id),
-        "delete_type" => "DELETE"
-      }
-    end
-
-    def terms_for_editing
-      terms_for_display -
-       [:part_of, :date_modified, :date_uploaded, :format] #, :resource_type]
-    end
-
-    def terms_for_display
-      self.descMetadata.class.config.keys
-    end
-
     # Is this file in the middle of being processed by a batch?
     def processing?
        return false if self.batch.blank?

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file/actions.rb

@@ -13,6 +13,7 @@ module Sufia::GenericFile
       else
         logger.warn "unable to find batch to attach to"
       end
+      yield(generic_file) if block_given?
       generic_file.save!
     end
     
@@ -33,7 +34,21 @@ module Sufia::GenericFile
 
       generic_file.record_version_committer(user)
       Sufia.queue.push(UnzipJob.new(generic_file.pid)) if generic_file.content.mimeType == 'application/zip'
-      Sufia.queue.push(ContentDepositEventJob.new(generic_file.pid, user.user_key))
+      if Sufia.config.respond_to?(:after_create_content)
+        Sufia.config.after_create_content.call(generic_file, user)
+      end
     end
+
+    def self.virus_check(file)
+      if defined? ClamAV
+        stat = ClamAV.instance.scanfile(file.path)
+        logger.warn "Virus checking did not pass for #{file.inspect} status = #{stat}" unless stat == 0
+        stat
+      else
+        logger.warn "Virus checking disabled for #{file.inspect}"
+        0
+      end
+    end 
+
   end
 end

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file/audit.rb

@@ -77,7 +77,7 @@ module Sufia
             #logger.debug "***AUDIT*** last audit = #{latest_audit.updated_at.to_date}"
             days_since_last_audit = (DateTime.now - latest_audit.updated_at.to_date).to_i
             #logger.debug "***AUDIT*** days since last audit: #{days_since_last_audit}"
-            if days_since_last_audit < Sufia::Engine.config.max_days_between_audits
+            if days_since_last_audit < Sufia.config.max_days_between_audits
               #logger.debug "***AUDIT*** No audit needed for #{version.pid} #{version.versionID} (#{latest_audit.updated_at})"
               return false
             end

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file/characterization.rb

@@ -1,4 +1,3 @@
-require 'datastreams/fits_datastream'
 module Sufia
   module GenericFile
     module Characterization
@@ -43,7 +42,7 @@ module Sufia
       # Populate descMetadata with fields from FITS (e.g. Author from pdfs)
       def append_metadata
         terms = self.characterization_terms
-        Sufia::Engine.config.fits_to_desc_mapping.each_pair do |k, v|
+        Sufia.config.fits_to_desc_mapping.each_pair do |k, v|
           if terms.has_key?(k)
             # coerce to array to remove a conditional
             terms[k] = [terms[k]] unless terms[k].is_a? Array

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file/permissions.rb

@@ -1,4 +1,3 @@
-require 'datastreams/paranoid_rights_datastream'
 module Sufia
   module GenericFile
     module Permissions

data/{lib/sufia → sufia-models/lib/sufia/models}/generic_file/thumbnail.rb

@@ -16,13 +16,13 @@ module Sufia
 
       protected
       def create_video_thumbnail
-        return unless Sufia::Engine.config.enable_ffmpeg
+        return unless Sufia.config.enable_ffmpeg
       
-        output_file = Dir::Tmpname.create(['sufia', ".png"], Sufia::Engine.config.temp_file_base){}
+        output_file = Dir::Tmpname.create(['sufia', ".png"], Sufia.config.temp_file_base){}
         content.to_tempfile do |f|
           # we could use something like this in order to find a frame in the middle.
           #ffprobe -show_files video.avi 2> /dev/null | grep duration | cut -d= -f2 53.399999  
-          command = "#{Sufia::Engine.config.ffmpeg_path} -i \"#{f.path}\" -loglevel quiet -vf \"scale=338:-1\"  -r  1  -t  1 #{output_file}"
+          command = "#{Sufia.config.ffmpeg_path} -i \"#{f.path}\" -loglevel quiet -vf \"scale=338:-1\"  -r  1  -t  1 #{output_file}"
           system(command)
           raise "Unable to execute command \"#{command}\"" unless $?.success?
         end

data/sufia-models/lib/sufia/models/generic_file/web_form.rb

@@ -0,0 +1,45 @@
+module Sufia
+  module GenericFile
+    module WebForm
+      extend ActiveSupport::Concern
+      included do
+        before_save :remove_blank_assertions
+      end
+
+      def remove_blank_assertions
+        terms_for_editing.each do |key|
+          self[key] = nil if self[key] == ['']
+        end
+      end
+
+      # override this method if you need to initialize more complex RDF assertions (b-nodes)
+      def initialize_fields
+        terms_for_editing.each do |key|
+          # if value is empty, we create an one element array to loop over for output 
+          self[key] = [''] if self[key].empty?
+        end
+      end
+
+      def terms_for_editing
+        terms_for_display -
+         [:part_of, :date_modified, :date_uploaded, :format] #, :resource_type]
+      end
+
+      def terms_for_display
+        self.descMetadata.class.config.keys
+      end
+
+      def to_jq_upload
+        return {
+          "name" => self.title,
+          "size" => self.file_size,
+          "url" => "/files/#{noid}",
+          "thumbnail_url" => self.pid,
+          "delete_url" => "deleteme", # generic_file_path(:id => id),
+          "delete_type" => "DELETE"
+        }
+      end
+
+    end
+  end
+end

data/{lib/sufia → sufia-models/lib/sufia/models}/id_service.rb

@@ -16,9 +16,14 @@ require 'noid'
 
 module Sufia
   module IdService
-    @minter = ::Noid::Minter.new(:template => '.reeddeeddk')
+
+    def self.noid_template
+      Sufia.config.noid_template
+    end
+
+    @minter = ::Noid::Minter.new(:template => noid_template)
     @pid = $$
-    @namespace = Sufia::Engine.config.id_namespace
+    @namespace = Sufia.config.id_namespace
     @semaphore = Mutex.new
     def self.valid?(identifier)
       # remove the fedora namespace since it's not part of the noid
@@ -38,20 +43,19 @@ module Sufia
 
     def self.next_id
       pid = ''
-      File.open("tmp/minter-state", File::RDWR|File::CREAT, 0644) {|f|
+      File.open(Sufia.config.minter_statefile, File::RDWR|File::CREAT, 0644) do |f|
         f.flock(File::LOCK_EX)
         yaml = YAML::load(f.read)
-        yaml = {:template => '.reeddeeddk'} unless yaml
+        yaml = {:template => noid_template} unless yaml
         minter = ::Noid::Minter.new(yaml)
-        pid =  "#{@namespace}:#{minter.mint}"
+        pid = "#{@namespace}:#{minter.mint}"
         f.rewind
         yaml = YAML::dump(minter.dump)
         f.write yaml
         f.flush
         f.truncate(f.pos)
-      }
+      end
       return pid
     end
-    
   end
 end

data/{lib/sufia → sufia-models/lib/sufia/models}/jobs/ffmpeg_transcode_job.rb

@@ -19,7 +19,7 @@ class FfmpegTranscodeJob
   end
 
   def run
-    return unless Sufia::Engine.config.enable_ffmpeg
+    return unless Sufia.config.enable_ffmpeg
     self.generic_file = GenericFile.find(generic_file_id)
     self.datastream = generic_file.datastreams[datastream_in]
     if datastream
@@ -33,7 +33,7 @@ class FfmpegTranscodeJob
   def encode_datastream(dest_dsid, mime_type, options)
     file_suffix = dest_dsid
     out_file = nil
-    output_file = Dir::Tmpname.create(['sufia', ".#{file_suffix}"], Sufia::Engine.config.temp_file_base){}
+    output_file = Dir::Tmpname.create(['sufia', ".#{file_suffix}"], Sufia.config.temp_file_base){}
     datastream.to_tempfile do |f|
       self.class.encode(f.path, options, output_file)
     end
@@ -54,7 +54,7 @@ class FfmpegTranscodeJob
   end
 
   def self.ffmpeg_path
-    Sufia::Engine.config.ffmpeg_path
+    Sufia.config.ffmpeg_path
   end
 end