Module: Hydra::AccessControls::Embargoable

Extended by:
ActiveSupport::Concern
Includes:
WithAccessRight
Defined in:
app/models/concerns/hydra/access_controls/embargoable.rb

Instance Method Summary collapse

Methods included from Permissions

#discover_groups, #discover_groups=, #discover_groups_string, #discover_groups_string=, #discover_users, #discover_users=, #discover_users_string, #discover_users_string=, #edit_groups, #edit_groups=, #edit_groups_string, #edit_groups_string=, #edit_users, #edit_users=, #permissions, #permissions=, #permissions_attributes=, #read_groups, #read_groups=, #read_groups_string, #read_groups_string=, #read_users, #read_users=, #read_users_string, #read_users_string=, #set_discover_groups, #set_discover_users, #set_edit_groups, #set_edit_users, #set_read_groups, #set_read_users

Methods included from Visibility

#visibility, #visibility_changed?

Instance Method Details

#active_lease? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 21

def active_lease?
  rightsMetadata.active_lease?
end

#apply_embargo(release_date, visibility_during = nil, visibility_after = nil) ⇒ Object 



38
39
40
41
42
43
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 38

def apply_embargo(release_date, visibility_during=nil, visibility_after=nil)
  self.embargo_release_date = release_date
  self.visibility_during_embargo = visibility_during unless visibility_during.nil?
  self.visibility_after_embargo = visibility_after unless visibility_after.nil?
  embargo_visibility!
end

#apply_lease(release_date, visibility_during = nil, visibility_after = nil) ⇒ Object 



109
110
111
112
113
114
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 109

def apply_lease(release_date, visibility_during=nil, visibility_after=nil)
  self.lease_expiration_date = release_date
  self.visibility_during_lease = visibility_during unless visibility_during.nil?
  self.visibility_after_lease = visibility_after unless visibility_after.nil?
  self.lease_visibility!
end

#deactivate_embargo! ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 45

def deactivate_embargo!
  embargo_state = under_embargo? ? "active" : "expired"
  embargo_record = embargo_history_message(embargo_state, Date.today, embargo_release_date, visibility_during_embargo, visibility_after_embargo)
  self.embargo_release_date = nil
  self.visibility_during_embargo = nil
  self.visibility_after_embargo = nil
  self.embargo_history += [embargo_record]
end

#deactivate_lease! ⇒ Object 



116
117
118
119
120
121
122
123
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 116

def deactivate_lease!
  lease_state = active_lease? ? "active" : "expired"
  lease_record = lease_history_message(lease_state, Date.today, lease_expiration_date, visibility_during_lease, visibility_after_lease)
  self.lease_expiration_date = nil
  self.visibility_during_lease = nil
  self.visibility_after_lease = nil
  self.lease_history += [lease_record]
end

#embargo_visibility! ⇒ Object

Set the current visibility to match what is described in the embargo.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 76

def embargo_visibility!
  if embargo_release_date
    if under_embargo?
      self.visibility_during_embargo = visibility_during_embargo ? visibility_during_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
      self.visibility_after_embargo = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
      self.visibility = visibility_during_embargo
    else
      self.visibility = visibility_after_embargo ? visibility_after_embargo : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
    end
  end
end

#lease_visibility! ⇒ Object

Set the current visibility to match what is described in the lease.



126
127
128
129
130
131
132
133
134
135
136
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 126

def lease_visibility!
  if lease_expiration_date
    if active_lease?
      self.visibility_during_lease = visibility_during_lease ? visibility_during_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
      self.visibility_after_lease = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
      self.visibility = visibility_during_lease
    else
      self.visibility = visibility_after_lease ? visibility_after_lease : Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
    end
  end
end

#under_embargo? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 17

def under_embargo?
  rightsMetadata.under_embargo?
end

#validate_embargo ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 54

def validate_embargo
  if embargo_release_date
    if under_embargo?
      expected_visibility = visibility_during_embargo
      failure_message = "An embargo is in effect for this object until #{embargo_release_date}.  Until that time the "
    else
      expected_visibility = visibility_after_embargo
      failure_message = "The embargo expired on #{embargo_release_date}.  The "
    end
    if visibility == expected_visibility
      return true
    else
      failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call embargo_visibility! on this object to repair."
      self.errors[:embargo] << failure_message
      return false
    end
  else
    return true
  end
end

#validate_lease ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 88

def validate_lease
  if lease_expiration_date
    if active_lease?
      expected_visibility = visibility_during_lease
      failure_message = "A lease is in effect for this object until #{lease_expiration_date}.  Until that time the "
    else
      expected_visibility = visibility_after_lease
      failure_message = "The lease expired on #{lease_expiration_date}.  The "
    end
    if visibility == expected_visibility
      return true
    else
      failure_message << "visibility should be #{expected_visibility} but it is currently #{visibility}.  Call lease_visibility! on this object to repair."
      self.errors[:lease] << failure_message
      return false
    end
  else
    return true
  end
end

#visibility=(value) ⇒ Object

If changing away from embargo or lease, this will deactivate the lease/embargo before proceeding. The lease_visibility! and embargo_visibility! methods rely on this to deactivate the lease when applicable.



27
28
29
30
31
32
33
34
35
36
 
# File 'app/models/concerns/hydra/access_controls/embargoable.rb', line 27

def visibility=(value)
  # If changing from embargo or lease, deactivate the lease/embargo and wipe out the associated metadata before proceeding
  if !embargo_release_date.nil?
    deactivate_embargo! unless value == visibility_during_embargo
  end
  if !lease_expiration_date.nil?
    deactivate_lease! unless value == visibility_during_lease
  end
  super
end