sufia-models 0.0.1

data/lib/sufia/models/generic_file/permissions.rb

@@ -0,0 +1,64 @@
+require 'datastreams/paranoid_rights_datastream'
+module Sufia
+  module GenericFile
+    module Permissions
+      extend ActiveSupport::Concern
+      #we're overriding the permissions= method which is in RightsMetadata
+      include Hydra::ModelMixins::RightsMetadata
+      included do
+        has_metadata :name => "rightsMetadata", :type => ParanoidRightsDatastream
+        validate :paranoid_permissions
+      end
+
+      def set_visibility(visibility)
+        # only set explicit permissions
+        case visibility
+        when "open"
+          self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "read")
+        when "psu"
+          self.datastreams["rightsMetadata"].permissions({:group=>"registered"}, "read")
+          self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "none")
+        when "restricted" 
+          self.datastreams["rightsMetadata"].permissions({:group=>"registered"}, "none")
+          self.datastreams["rightsMetadata"].permissions({:group=>"public"}, "none")
+        end
+      end
+
+
+      def paranoid_permissions
+        # let the rightsMetadata ds make this determination
+        # - the object instance is passed in for easier access to the props ds
+        rightsMetadata.validate(self)
+      end
+
+      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
+      def permissions=(params)
+        perm_hash = permission_hash
+        params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
+        params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
+
+        params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
+        params[:group].each { |name, access| perm_hash['group'][name] = access} if params[:group]
+        rightsMetadata.update_permissions(perm_hash)
+      end
+
+      private
+
+      def permission_hash
+        old_perms = self.permissions
+        user_perms =  {}
+        old_perms.select{|r| r[:type] == 'user'}.each do |r|
+          user_perms[r[:name]] = r[:access]
+        end
+        user_perms
+        group_perms =  {}
+        old_perms.select{|r| r[:type] == 'group'}.each do |r|
+          group_perms[r[:name]] = r[:access]
+        end
+        {'person'=>user_perms, 'group'=>group_perms}
+      end
+
+
+    end
+  end
+end

data/lib/sufia/models/generic_file/thumbnail.rb

@@ -0,0 +1,91 @@
+module Sufia
+  module GenericFile
+    module Thumbnail
+      # Create thumbnail requires that the characterization has already been run (so mime_type, width and height is available)
+      # and that the object is already has a pid set
+      def create_thumbnail
+        return unless self.content.has_content?
+        if pdf?
+          create_pdf_thumbnail
+        elsif image?
+          create_image_thumbnail
+        elsif video?
+          create_video_thumbnail
+        end
+      end
+
+      protected
+      def create_video_thumbnail
+        return unless Sufia::Engine.config.enable_ffmpeg
+      
+        output_file = Dir::Tmpname.create(['sufia', ".png"], Sufia::Engine.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}"
+          system(command)
+          raise "Unable to execute command \"#{command}\"" unless $?.success?
+        end
+
+        self.thumbnail.content = File.open(output_file, 'rb').read
+        self.thumbnail.mimeType = 'image/png'
+        self.save
+      end
+
+      def create_pdf_thumbnail
+        retryCnt = 0
+        stat = false;
+        for retryCnt in 1..3
+          begin
+            pdf = load_image_transformer
+            first = pdf.to_a[0]
+            first.format = "PNG"
+            thumb = first.scale(338, 493)
+            self.thumbnail.content = thumb.to_blob { self.format = "PNG" }
+            self.thumbnail.mimeType = 'image/png'
+            self.save
+            break
+          rescue => e
+            logger.warn "Rescued an error #{e.inspect} retry count = #{retryCnt}"
+            sleep 1
+          end
+        end
+        return stat
+      end
+
+      def create_image_thumbnail
+        self.thumbnail.content = scale_image.to_blob { self.format = "PNG" }
+        self.thumbnail.mimeType = 'image/png'
+        #logger.debug "Has the content before saving? #{self.content.changed?}"
+        self.save
+      end
+
+      def scale_image
+        img = load_image_transformer
+        height = Float(self.height.first.to_i)
+        width = Float(self.width.first.to_i)
+        if width > height && width > 150 && height > 105
+          # horizontal img
+          scale  = 150 / width
+          img.scale(150, height * scale)
+        elsif height >= width && width > 150 && height > 200
+          # vertical or square
+          scale  = 200 / height
+          img.scale(width*scale, 200)
+        else
+          # Too small to worry about resizing
+          img
+        end
+      end
+
+      # Override this method if you want a different transformer, or need to load the 
+      # raw image from a different source (e.g.  external datastream)
+      def load_image_transformer
+        xformer = Magick::ImageList.new
+        xformer.from_blob(content.content)
+        xformer
+      end
+
+    end
+  end
+end

data/lib/sufia/models/id_service.rb

@@ -0,0 +1,57 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'noid'
+
+module Sufia
+  module IdService
+    @minter = ::Noid::Minter.new(:template => '.reeddeeddk')
+    @pid = $$
+    @namespace = Sufia::Engine.config.id_namespace
+    @semaphore = Mutex.new
+    def self.valid?(identifier)
+      # remove the fedora namespace since it's not part of the noid
+      noid = identifier.split(":").last
+      return @minter.valid? noid
+    end
+    def self.mint
+      @semaphore.synchronize do
+        while true
+          pid = self.next_id
+          return pid unless ActiveFedora::Base.exists?(pid)
+        end
+      end
+    end
+
+    protected
+
+    def self.next_id
+      pid = ''
+      File.open("tmp/minter-state", File::RDWR|File::CREAT, 0644) {|f|
+        f.flock(File::LOCK_EX)
+        yaml = YAML::load(f.read)
+        yaml = {:template => '.reeddeeddk'} unless yaml
+        minter = ::Noid::Minter.new(yaml)
+        pid =  "#{@namespace}:#{minter.mint}"
+        f.rewind
+        yaml = YAML::dump(minter.dump)
+        f.write yaml
+        f.flush
+        f.truncate(f.pos)
+      }
+      return pid
+    end
+    
+  end
+end

data/lib/sufia/models/jobs/audit_job.rb

@@ -0,0 +1,65 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class AuditJob
+  def queue_name
+    :audit
+  end
+
+  PASS = 'Passing Audit Run'
+  FAIL = 'Failing Audit Run'
+
+  attr_accessor :generic_file_id, :datastream_id, :version_id
+
+  def initialize(generic_file_id, datastream_id, version_id)
+    self.generic_file_id = generic_file_id
+    self.datastream_id = datastream_id
+    self.version_id = version_id
+  end
+
+  def run
+    generic_file = GenericFile.find(generic_file_id)
+    #logger.info "GF is #{generic_file.pid}"
+    if generic_file
+      datastream = generic_file.datastreams[datastream_id]
+      #logger.info "DS is #{datastream.inspect}"
+      if datastream
+        #logger.info "Datastream for audit = #{datastream.inspect}"
+        version =  datastream.versions.select { |v| v.versionID == version_id}.first
+        log = GenericFile.run_audit(version)
+
+        # look up the user for sending the message to
+        login = generic_file.depositor
+        #logger.info "User login is #{login}"`
+        #logger.info "All users = #{User.all}"
+        if login
+          user = User.find_by_user_key(login)
+          logger.warn "User '#{login}' not found" unless user
+          #logger.info "ZZZ user = #{user.inspect}"
+          job_user = User.audituser()
+          #send the user a message about the failing audit
+          unless (log.pass == 1)
+            message = "The audit run at #{log.created_at} for #{log.pid}:#{log.dsid}:#{log.version} was #{log.pass == 1 ? 'passing' : 'failing'}."
+            subject = (log.pass == 1 ? PASS : FAIL)
+            job_user.send_message(user, message, subject)
+          end 
+        end
+      else
+        logger.warn "No datastream for audit!!!!! pid: #{generic_file_id} dsid: #{datastream_id}"
+      end
+    else
+      logger.warn "No generic file for data stream audit!!!!! pid: #{generic_file_id} dsid: #{datastream_id}"
+    end
+  end
+end

data/lib/sufia/models/jobs/batch_update_job.rb

@@ -0,0 +1,86 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class BatchUpdateJob
+  include Hydra::PermissionsQuery
+  include GenericFileHelper
+  include Rails.application.routes.url_helpers 
+
+  def queue_name
+    :batch_update
+  end
+
+  attr_accessor :login, :title, :file_attributes, :batch_id, :visibility
+
+  def initialize(login, params)
+    self.login = login
+    self.title = params[:title]
+    self.file_attributes = params[:generic_file]
+    self.visibility = params[:visibility]
+    self.batch_id = params[:id]
+
+  end
+
+  def run
+    batch = Batch.find_or_create(self.batch_id)
+    user = User.find_by_user_key(self.login)
+    @saved = []
+    @denied = []
+
+    batch.generic_files.each do |gf|
+      update_file(gf, user)
+    end
+    batch.update_attributes({status:["Complete"]})
+    
+    job_user = User.batchuser()
+    
+    message = '<a class="batchid ui-helper-hidden">ss-'+batch.noid+'</a>The file(s) '+ file_list(@saved)+ " have been saved." unless @saved.empty?
+    job_user.send_message(user, message, 'Batch upload complete') unless @saved.empty?
+ 
+    message = '<a class="batchid ui-helper-hidden">'+batch.noid+'</a>The file(s) '+ file_list(@denied)+" could not be updated.  You do not have sufficient privileges to edit it." unless @denied.empty?
+    job_user.send_message(user, message, 'Batch upload permission denied') unless @denied.empty?
+     
+  end
+
+  def update_file(gf, user)
+    unless user.can? :edit, gf
+      logger.error "User #{user.user_key} DENIED access to #{gf.pid}!"
+      @denied << gf
+      return
+    end
+    gf.title = title[gf.pid] if title[gf.pid] rescue gf.label
+    gf.attributes=file_attributes
+    gf.set_visibility(visibility)
+
+    save_tries = 0
+    begin
+      gf.save!
+    rescue RSolr::Error::Http => error
+      save_tries += 1
+      logger.warn "BatchUpdateJob caught RSOLR error on #{gf.pid}: #{error.inspect}"
+      # fail for good if the tries is greater than 3
+      raise error if save_tries >=3
+      sleep 0.01
+      retry
+    end #
+    Sufia.queue.push(ContentUpdateEventJob.new(gf.pid, login))
+    @saved << gf
+  end
+  
+  def file_list ( files)
+    return files.map {|gf| '<a href="'+Sufia::Engine.routes.url_helpers.generic_files_path+'/'+gf.noid+'">'+display_title(gf)+'</a>'}.join(', ')
+    
+  end
+  
+end

data/lib/sufia/models/jobs/characterize_job.rb

@@ -0,0 +1,43 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class CharacterizeJob
+
+  def queue_name
+    :characterize
+  end
+
+  attr_accessor :generic_file_id, :generic_file
+
+  def initialize(generic_file_id)
+    self.generic_file_id = generic_file_id
+  end
+
+  def run
+    self.generic_file = GenericFile.find(generic_file_id)
+    generic_file.characterize
+    after_characterize
+  end
+
+  def after_characterize
+    if generic_file.pdf? || generic_file.image? || generic_file.video?
+      generic_file.create_thumbnail
+    end
+    if generic_file.video?
+      Sufia.queue.push(TranscodeVideoJob.new(generic_file_id, 'content'))
+    elsif generic_file.audio?
+      Sufia.queue.push(TranscodeAudioJob.new(generic_file_id, 'content'))
+    end
+  end
+end

data/lib/sufia/models/jobs/content_delete_event_job.rb

@@ -0,0 +1,31 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class ContentDeleteEventJob < EventJob
+
+
+  def run
+    action = "User #{link_to_profile depositor_id} has deleted file '#{generic_file_id}'"
+    timestamp = Time.now.to_i
+    depositor = User.find_by_user_key(depositor_id)
+    # Create the event
+    event = depositor.create_event(action, timestamp)
+    # Log the event to the depositor's profile stream
+    depositor.log_profile_event(event)
+    # Fan out the event to all followers
+    depositor.followers.each do |follower|
+      follower.log_event(event)
+    end
+  end
+end

data/lib/sufia/models/jobs/content_deposit_event_job.rb

@@ -0,0 +1,32 @@
+# Copyright © 2012 The Pennsylvania State University
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class ContentDepositEventJob < EventJob
+  def run
+    gf = GenericFile.find(generic_file_id)
+    action = "User #{link_to_profile depositor_id} has deposited #{link_to gf.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(gf.noid)}"
+    timestamp = Time.now.to_i
+    depositor = User.find_by_user_key(depositor_id)
+    # Create the event
+    event = depositor.create_event(action, timestamp)
+    # Log the event to the depositor's profile stream
+    depositor.log_profile_event(event)
+    # Log the event to the GF's stream
+    gf.log_event(event)
+    # Fan out the event to all followers who have access
+    depositor.followers.select { |user| user.can? :read, gf }.each do |follower|
+      follower.log_event(event)
+    end
+  end
+end