sufia-models 0.0.1

data/lib/sufia/models/jobs/content_new_version_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 ContentNewVersionEventJob < EventJob
+  def run
+    gf = GenericFile.find(generic_file_id)
+    action = "User #{link_to_profile depositor_id} has added a new version of #{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

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

@@ -0,0 +1,40 @@
+# 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 ContentRestoredVersionEventJob < EventJob
+  attr_accessor :revision_id
+
+  def initialize(generic_file_id, depositor_id, revision_id)
+    self.generic_file_id = generic_file_id
+    self.depositor_id = depositor_id
+    self.revision_id = revision_id
+  end
+
+  def run
+    gf = GenericFile.find(generic_file_id)
+    action = "User #{link_to_profile depositor_id} has restored a version '#{revision_id}' of #{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

data/lib/sufia/models/jobs/content_update_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 ContentUpdateEventJob < EventJob
+  def run
+    gf = GenericFile.find(generic_file_id)
+    action = "User #{link_to_profile depositor_id} has updated #{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

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

@@ -0,0 +1,33 @@
+# 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 EventJob
+  include Rails.application.routes.url_helpers
+  include ActionView::Helpers
+  include ActionView::Helpers::DateHelper
+  include Hydra::AccessControlsEnforcement
+  include SufiaHelper
+
+  def queue_name
+    :event
+  end
+
+  attr_accessor :generic_file_id, :depositor_id
+
+  def initialize(generic_file_id, depositor_id)
+    self.generic_file_id = generic_file_id
+    self.depositor_id = depositor_id
+  end
+
+end

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

@@ -0,0 +1,61 @@
+# Created by: Justin Coyne
+# 7 Feb 2013
+# An abstract class for asyncronous jobs that transcode files using FFMpeg
+
+require 'tmpdir'
+
+class FfmpegTranscodeJob
+  extend Open3
+
+  attr_accessor :generic_file_id, :datastream_in, :datastream, :generic_file
+
+  def initialize(generic_file_id, datastream_in)
+    self.generic_file_id = generic_file_id
+    self.datastream_in = datastream_in
+  end
+
+  def process
+    raise "You attempted to call process() on an abstract class.  Implement process() on the concrete class"
+  end
+
+  def run
+    return unless Sufia::Engine.config.enable_ffmpeg
+    self.generic_file = GenericFile.find(generic_file_id)
+    self.datastream = generic_file.datastreams[datastream_in]
+    if datastream
+      process 
+      generic_file.save!
+    else
+      logger.warn "No datastream for transcoding!!!!! pid: #{generic_file_id} dsid: #{datastream_in}"
+    end
+  end
+
+  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){}
+    datastream.to_tempfile do |f|
+      self.class.encode(f.path, options, output_file)
+    end
+    out_file = File.open(output_file, "rb")
+    generic_file.add_file_datastream(out_file.read, :dsid=>dest_dsid, :mimeType=>mime_type)
+    File.unlink(output_file)
+  end
+
+  def self.encode(path, options, output_file)
+    command = "#{ffmpeg_path} -y -i \"#{path}\" #{options} #{output_file}"
+    stdin, stdout, stderr, wait_thr = popen3(command)
+    stdin.close
+    out = stdout.read
+    stdout.close
+    err = stderr.read
+    stderr.close
+    raise "Unable to execute command \"#{command}\"\n#{err}" unless wait_thr.value.success?
+  end
+
+  def self.ffmpeg_path
+    Sufia::Engine.config.ffmpeg_path
+  end
+end
+
+

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

@@ -0,0 +1,23 @@
+# 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 ResolrizeJob
+  def queue_name
+    :resolrize
+  end
+
+  def run
+    ActiveFedora::Base.reindex_everything
+  end
+end

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

@@ -0,0 +1,40 @@
+# Created by: Justin Coyne
+# 7 Feb 2013
+# An asyncronous job for transcoding audio files using FFMpeg
+
+class TranscodeAudioJob < FfmpegTranscodeJob
+  def queue_name
+    :audio
+  end
+
+  def process
+    encode_mp3()
+    encode_ogg()
+  end
+
+  private 
+    def encode_ogg
+      opts = ""
+      if generic_file.mime_type == 'audio/ogg'
+        # Don't re-encode, just copy
+        generic_file.add_file_datastream(generic_file.content.read, :dsid=>'ogg', :mimeType=>'audio/ogg')
+        #generic_file.content.rewind
+      else
+        encode_datastream('ogg', 'audio/ogg', opts)
+      end
+    end
+
+    def encode_mp3
+      opts = ""
+      if generic_file.mime_type == 'audio/mpeg'
+        # Don't re-encode, just copy
+        generic_file.add_file_datastream(generic_file.content.read, :dsid=>'mp3', :mimeType=>'audio/mp3')
+        #generic_file.content.rewind
+      else
+        encode_datastream('mp3', 'audio/mp3', opts)
+      end
+    end
+
+
+end
+

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

@@ -0,0 +1,39 @@
+# Created by: Justin Coyne
+# 13 Dec 2012
+# An asyncronous job for transcoding video files using FFMpeg
+
+class TranscodeVideoJob < FfmpegTranscodeJob
+  def queue_name
+    :video
+  end
+
+  def process
+    encode_mp4()
+    encode_webm()
+  end
+
+  private 
+
+  def encode_webm
+    # -g 30 enforces keyframe generation every second (30fps)
+    # -b:v is the video bitrate
+    # -acodec is the audio codec
+    opts = "#{size_attributes}  -g 30 -b:v 345k -acodec libvorbis #{audio_attributes}"
+    encode_datastream('webm', 'video/webm', opts)
+  end
+
+  def encode_mp4
+    opts = "#{size_attributes} -b:v 345k -vcodec libx264 -acodec libfaac #{audio_attributes} "
+    encode_datastream('mp4', 'video/mp4', opts)
+  end
+
+
+  def size_attributes
+    "-s 320x240"
+  end
+
+  def audio_attributes 
+    "-ac 2 -ab 96k -ar 44100"
+  end
+end
+

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

@@ -0,0 +1,54 @@
+# 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 UnzipJob
+  def queue_name
+    :unzip
+  end
+
+  attr_accessor :pid
+
+  def initialize(pid)
+    self.pid = pid
+  end
+
+  def run
+    Zip::Archive.open_buffer(zip_file.content.content) do |archive|
+      archive.each do |f|
+        create_file(f)
+      end
+    end
+  end
+
+  protected
+
+  def create_file(f)
+    @generic_file = GenericFile.new
+    @generic_file.batch_id = zip_file.batch.pid
+    file_name = f.name
+    mime_types = MIME::Types.of(file_name)
+    mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+    options = {:label=>file_name, :dsid=>'content', :mimeType=>mime_type}
+    @generic_file.add_file_datastream(f.read, options)
+    @generic_file.set_title_and_label( file_name, :only_if_blank=>true )
+    @generic_file.apply_depositor_metadata(zip_file.edit_users.first)
+    @generic_file.date_uploaded = Time.now.ctime
+    @generic_file.date_modified = Time.now.ctime
+    @generic_file.save
+  end
+
+  def zip_file
+    @zip_file ||= GenericFile.find(pid)
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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 UserEditProfileEventJob < EventJob
+  attr_accessor :editor_id
+
+  def initialize(editor_id)
+    self.editor_id = editor_id
+  end
+
+  def run
+    action = "User #{link_to_profile editor_id} has edited his or her profile"
+    timestamp = Time.now.to_i
+    editor = User.find_by_user_key(editor_id)
+    # Create the event
+    event = editor.create_event(action, timestamp)
+    # Log the event to the editor's stream
+    editor.log_event(event)
+    # Fan out the event to all followers
+    editor.followers.each do |user|
+      user.log_event(event)
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# 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 UserFollowEventJob < EventJob
+  attr_accessor :follower_id, :followee_id
+
+  def initialize(follower_id, followee_id)
+    self.follower_id = follower_id
+    self.followee_id = followee_id
+  end
+
+  def run
+    # Create the event
+    follower = User.find_by_user_key(follower_id)
+    event = follower.create_event("User #{link_to_profile follower_id} is now following #{link_to_profile followee_id}", Time.now.to_i)
+    # Log the event to the follower's stream
+    follower.log_event(event)
+    # Fan out the event to followee
+    followee = User.find_by_user_key(followee_id)
+    followee.log_event(event)
+    # Fan out the event to all followers
+    follower.followers.each do |user|
+      user.log_event(event)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# 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 UserUnfollowEventJob < EventJob
+  attr_accessor :unfollower_id, :unfollowee_id
+
+  def initialize(unfollower_id, unfollowee_id)
+    self.unfollower_id = unfollower_id
+    self.unfollowee_id = unfollowee_id
+  end
+  def run
+    action = "User #{link_to_profile unfollower_id} has unfollowed #{link_to_profile unfollowee_id}"
+    timestamp = Time.now.to_i
+    unfollower = User.find_by_user_key(unfollower_id)
+    # Create the event
+    event = unfollower.create_event(action, timestamp)
+    # Log the event to the unfollower's stream
+    unfollower.log_event(event)
+    # Fan out the event to unfollowee
+    unfollowee = User.find_by_user_key(unfollowee_id)
+    unfollowee.log_event(event)
+    # Fan out the event to all followers
+    unfollower.followers.each do |user|
+      user.log_event(event)
+    end
+  end
+end