Class: Hydra::Datastream::RightsMetadata

Inherits:
ActiveFedora::OmDatastream
  • Object
show all
Extended by:
Deprecation
Defined in:
lib/hydra/datastream/rights_metadata.rb

Overview

Implements Hydra RightsMetadata XML terminology for asserting access permissions

Direct Known Subclasses

InheritableRightsMetadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#embargo_release_date(opts = {}) ⇒ Object

Returns the value of attribute embargo_release_date.



175
176
177
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 175

def embargo_release_date
  @embargo_release_date
end

Class Method Details

.date_indexer ⇒ Object 



221
222
223
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 221

def self.date_indexer
  @date_indexer ||= Solrizer::Descriptor.new(:date, :stored, :indexed)
end

.indexer ⇒ Object 



213
214
215
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 213

def self.indexer
  @indexer ||= Solrizer::Descriptor.new(:string, :stored, :indexed, :multivalued)
end

.xml_template ⇒ Object

Generates an empty Mods Article (used when you call ModsArticle.new without passing in existing xml)



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 54

def self.xml_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.rightsMetadata(:version=>"0.1", "xmlns"=>"http://hydra-collab.stanford.edu/schemas/rightsMetadata/v1") {
      xml.copyright {
        xml.human(:type=>'title')
        xml.human(:type=>'description')
        xml.machine(:type=>'uri')
        
      }
      xml.access(:type=>"discover") {
        xml.human
        xml.machine
      }
      xml.access(:type=>"read") {
        xml.human 
        xml.machine
      }
      xml.access(:type=>"edit") {
        xml.human
        xml.machine
      }
      xml.embargo{
        xml.human
        xml.machine
      }        
    }
  end
  return builder.doc
end

Instance Method Details

#clear_permissions! ⇒ Object

Completely clear the permissions



226
227
228
229
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 226

def clear_permissions!
  remove_all_permissions({:person=>true})
  remove_all_permissions({:group=>true})
end

#date_indexer ⇒ Object 



217
218
219
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 217

def date_indexer
  self.class.date_indexer
end

#groups ⇒ Object

Reports on which groups have which permissions

Returns:

  • Hash in format => group_permissions, group_name => group_permissions



125
126
127
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 125

def groups
  return quick_search_by_type(:group)
end

#indexer ⇒ Object 



209
210
211
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 209

def indexer
  self.class.indexer
end

#individuals ⇒ Object 



129
130
131
132
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 129

def individuals
  Deprecation.warn(RightsMetadata, "The method `individuals' is deprecated and will be removed from Hydra::Datastream::RightsMetadata in hydra-head 8.0.  Use `users' instead.", caller)
  users
end

#permissions(selector, new_access_level = nil) ⇒ Object

Returns the permissions for the selected person/group If new_access_level is provided, updates the selected person/group access_level to the one specified A new_access_level of “none” will remove all access_levels for the selected person/group ie. permissions(:person=>“person123”)

> “person123”=>“edit”

permissions(:person=>“person123”, “read”)

> “person123”=>“read”

permissions(:person=>“person123”)

> “person123”=>“read”

Parameters:

  • selector (Hash) —

    hash in format => identifier

  • new_access_level (default nil) (defaults to: nil)

Returns:

  • Hash in format => access_level.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 98

def permissions(selector, new_access_level=nil)
  type = selector.keys.first.to_sym
  actor = selector.values.first
  if new_access_level.nil?
    xpath = xpath(type, actor)
    nodeset = self.find_by_terms(xpath)
    if nodeset.empty?
      return "none"
    else
      return nodeset.first.ancestors("access").first.attributes["type"].text
    end
  else
    remove_all_permissions(selector)
    if new_access_level == "none" 
      self.content = self.to_xml
    else
      access_type_symbol = "#{new_access_level}_access".to_sym
      current_values = term_values(access_type_symbol, type)
      self.update_values([access_type_symbol, type] => current_values + [actor] )
    end
    return new_access_level
  end
    
end

#permissions=(params) ⇒ Object

Updates all permissions Restricts actor type to group or person. Any others will be ignored

Parameters:

  • params —

    ex. “group”=>{“group1”=>“discover”,“group2”=>“edit”, “person”=>“person1”=>“read”,“person2”=>“discover”}



151
152
153
154
155
156
157
158
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 151

def permissions= (params)
  groups_for_update = params['group'] ? params['group'].keys : []
  group_ids = groups.keys | groups_for_update
  group_ids.each {|group_id| self.permissions({"group"=>group_id}, params['group'].fetch(group_id, 'none'))}
  users_for_update = params['person'] ? params['person'].keys : []
  user_ids = users.keys | users_for_update
  user_ids.each {|person_id| self.permissions({"person"=>person_id}, params['person'].fetch(person_id, 'none'))}
end

#quick_search_by_type(type) ⇒ Object

This method limits the response to known access levels. Probably runs a bit faster than .permissions().

Parameters:

  • type (Symbol) —

    (either :group or :person)

Returns:



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 163

def quick_search_by_type(type)
  result = {}
  [{:discover_access=>"discover"},{:read_access=>"read"},{:edit_access=>"edit"}].each do |access_levels_hash|
    access_level = access_levels_hash.keys.first
    access_level_name = access_levels_hash.values.first
    self.find_by_terms(*[access_level, type]).each do |entry|
      result[entry.text] = access_level_name
    end
  end
  return result
end

#to_solr(solr_doc = Hash.new) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 196

def to_solr(solr_doc=Hash.new)
  [:discover, :read, :edit].each do |access|
    vals = send("#{access}_access").machine.group
    solr_doc[Hydra.config[:permissions][access][:group]] = vals unless vals.empty?
    vals = send("#{access}_access").machine.person
    solr_doc[Hydra.config[:permissions][access][:individual]] = vals unless vals.empty?
  end
  if embargo_release_date
    ::Solrizer::Extractor.insert_solr_field_value(solr_doc, Hydra.config[:permissions][:embargo_release_date], embargo_release_date(:format=>:solr_date))
  end
  solr_doc
end

#under_embargo? ⇒ Boolean

Returns:

  • (Boolean) 


192
193
194
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 192

def under_embargo?
  (embargo_release_date && Date.today < embargo_release_date.to_date) ? true : false
end

#update_permissions(params) ⇒ Object

Updates permissions for all of the persons and groups in a hash Currently restricts actor type to group or person. Any others will be ignored

Parameters:

  • params —

    ex. “group”=>{“group1”=>“discover”,“group2”=>“edit”, “person”=>“person1”=>“read”,“person2”=>“discover”}



143
144
145
146
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 143

def update_permissions(params)
  params.fetch("group", {}).each_pair {|group_id, access_level| self.permissions({"group"=>group_id}, access_level)}
  params.fetch("person", {}).each_pair {|person_id, access_level| self.permissions({"person"=>person_id}, access_level)}
end

#users ⇒ Object

Reports on which users have which permissions

Returns:

  • Hash in format => user_permissions, user_name => user_permissions



136
137
138
 
# File 'lib/hydra/datastream/rights_metadata.rb', line 136

def users
  return quick_search_by_type(:person)
end