Class: Sufia::GenericFile::Actor

Inherits:
Object
  • Object
show all
Includes:
Lockable
Defined in:
app/actors/sufia/generic_file/actor.rb

Overview

Actions are decoupled from controller logic so that they may be called from a controller or a background job.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Lockable

#acquire_lock_for, #lock_manager

Constructor Details

#initialize(generic_file, user) ⇒ Actor

Returns a new instance of Actor.



8
9
10
11
 
# File 'app/actors/sufia/generic_file/actor.rb', line 8

def initialize(generic_file, user)
  @generic_file = generic_file
  @user = user
end

Instance Attribute Details

#generic_file ⇒ Object (readonly)

Returns the value of attribute generic_file.



6
7
8
 
# File 'app/actors/sufia/generic_file/actor.rb', line 6

def generic_file
  @generic_file
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



6
7
8
 
# File 'app/actors/sufia/generic_file/actor.rb', line 6

def user
  @user
end

Class Method Details

.virus_check(file) ⇒ Object

Raises:



123
124
125
126
127
128
129
130
131
 
# File 'app/actors/sufia/generic_file/actor.rb', line 123

def virus_check(file)
  path = file.is_a?(String) ? file : file.path
  unless defined?(ClamAV)
    ActiveFedora::Base.logger.warn "Virus checking disabled, #{path} not checked"
    return
  end
  scan_result = ClamAV.instance.scanfile(path)
  raise Sufia::VirusFoundError, "A virus was found in #{path}: #{scan_result}" unless scan_result == 0
end

Instance Method Details

#add_file_to_collection(collection_id) ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'app/actors/sufia/generic_file/actor.rb', line 45

def add_file_to_collection(collection_id)
  return if collection_id.nil? || collection_id == "-1"
  acquire_lock_for(collection_id) do
    collection = ::Collection.find(collection_id)
    return unless user.can? :edit, collection
    collection.add_members [generic_file.id]
    collection.save
  end
end

#create_content(file, file_name, path, mime_type, collection_id = nil) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'app/actors/sufia/generic_file/actor.rb', line 32

def create_content(file, file_name, path, mime_type, collection_id = nil)
  generic_file.add_file(file, path: path, original_name: file_name, mime_type: mime_type)
  generic_file.label ||= file_name
  generic_file.title = [generic_file.label] if generic_file.title.blank?
  saved = save_characterize_and_record_committer do
    if Sufia.config.respond_to?(:after_create_content)
      Sufia.config.after_create_content.call(generic_file, user)
    end
  end
  add_file_to_collection(collection_id) if saved
  saved
end

#create_metadata(batch_id) {|generic_file| ... } ⇒ Object

in order to avoid two saves in a row, create_metadata does not save the file by default. it is typically used in conjunction with create_content, which does do a save. If you want to save when using create_metadata, you can do this:

create_metadata(batch_id) { |gf| gf.save }

Yields:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'app/actors/sufia/generic_file/actor.rb', line 17

def create_metadata(batch_id)
  generic_file.apply_depositor_metadata(user)
  time_in_utc = DateTime.now.new_offset(0)
  generic_file.date_uploaded = time_in_utc
  generic_file.date_modified = time_in_utc
  generic_file.creator = [user.name]

  if batch_id
    generic_file.batch_id = batch_id
  else
    ActiveFedora::Base.logger.warn "unable to find batch to attach to"
  end
  yield(generic_file) if block_given?
end

#destroy ⇒ Object 



86
87
88
89
90
 
# File 'app/actors/sufia/generic_file/actor.rb', line 86

def destroy
  generic_file.destroy
  FeaturedWork.where(generic_file_id: generic_file.id).destroy_all
  Sufia.config.after_destroy.call(generic_file.id, user) if Sufia.config.respond_to?(:after_destroy)
end

#push_characterize_job ⇒ Object 



118
119
120
 
# File 'app/actors/sufia/generic_file/actor.rb', line 118

def push_characterize_job
  Sufia.queue.push(CharacterizeJob.new(@generic_file.id))
end

#revert_content(revision_id) ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'app/actors/sufia/generic_file/actor.rb', line 55

def revert_content(revision_id)
  generic_file.content.restore_version(revision_id)
  generic_file.content.create_version
  save_characterize_and_record_committer do
    if Sufia.config.respond_to?(:after_revert_content)
      Sufia.config.after_revert_content.call(generic_file, user, revision_id)
    end
  end
end

#save_and_record_committer ⇒ Object

Takes an optional block and executes the block if the save was successful. returns false if the save was unsuccessful



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/actors/sufia/generic_file/actor.rb', line 101

def save_and_record_committer
  save_tries = 0
  begin
    return false unless generic_file.save
  rescue RSolr::Error::Http => error
    ActiveFedora::Base.logger.warn "Sufia::GenericFile::Actor::save_and_record_committer Caught RSOLR error #{error.inspect}"
    save_tries += 1
    # fail for good if the tries is greater than 3
    raise error if save_tries >= 3
    sleep 0.01
    retry
  end
  yield if block_given?
  generic_file.record_version_committer(user)
  true
end

#save_characterize_and_record_committer ⇒ Object

Takes an optional block and executes the block if the save was successful.



93
94
95
96
97
 
# File 'app/actors/sufia/generic_file/actor.rb', line 93

def save_characterize_and_record_committer
  save_and_record_committer { push_characterize_job }.tap do |val|
    yield if block_given? && val
  end
end

#update_content(file, path) ⇒ Object 



65
66
67
68
69
70
71
72
 
# File 'app/actors/sufia/generic_file/actor.rb', line 65

def update_content(file, path)
  generic_file.add_file(file, path: path, original_name: file.original_filename, mime_type: file.content_type)
  save_characterize_and_record_committer do
    if Sufia.config.respond_to?(:after_update_content)
      Sufia.config.after_update_content.call(generic_file, user)
    end
  end
end

#update_metadata(attributes, visibility) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'app/actors/sufia/generic_file/actor.rb', line 74

def update_metadata(attributes, visibility)
  generic_file.attributes = attributes
  update_visibility(visibility)
  generic_file.date_modified = DateTime.now
  remove_from_feature_works if generic_file.visibility_changed? && !generic_file.public?
  save_and_record_committer do
    if Sufia.config.respond_to?(:after_update_metadata)
      Sufia.config.after_update_metadata.call(generic_file, user)
    end
  end
end