3 class ArvadosModel < ActiveRecord::Base
4 self.abstract_class = true
6 include CurrentApiClient # current_user, current_api_client, etc.
8 attr_protected :created_at
9 attr_protected :modified_by_user_uuid
10 attr_protected :modified_by_client_uuid
11 attr_protected :modified_at
12 after_initialize :log_start_state
13 before_save :ensure_permission_to_save
14 before_save :ensure_owner_uuid_is_permitted
15 before_save :ensure_ownership_path_leads_to_user
16 before_destroy :ensure_owner_uuid_is_permitted
17 before_destroy :ensure_permission_to_destroy
18 before_create :update_modified_by_fields
19 before_update :maybe_update_modified_by_fields
20 after_create :log_create
21 after_update :log_update
22 after_destroy :log_destroy
23 after_find :convert_serialized_symbols_to_strings
24 validate :ensure_serialized_attribute_type
25 validate :normalize_collection_uuids
26 validate :ensure_valid_uuids
28 # Note: This only returns permission links. It does not account for
29 # permissions obtained via user.is_admin or
30 # user.uuid==object.owner_uuid.
31 has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
33 class PermissionDeniedError < StandardError
39 class UnauthorizedError < StandardError
45 def self.kind_class(kind)
46 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
50 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
53 def self.searchable_columns operator
54 textonly_operator = !operator.match(/[<=>]/)
55 self.columns.collect do |col|
56 if [:string, :text].index(col.type)
58 elsif !textonly_operator and [:datetime, :integer].index(col.type)
64 def self.attribute_column attr
65 self.columns.select { |col| col.name == attr.to_s }.first
68 # Return nil if current user is not allowed to see the list of
69 # writers. Otherwise, return a list of user_ and group_uuids with
70 # write permission. (If not returning nil, current_user is always in
71 # the list because can_manage permission is needed to see the list
74 unless (owner_uuid == current_user.uuid or
75 current_user.is_admin or
76 current_user.groups_i_can(:manage).index(owner_uuid))
79 [owner_uuid, current_user.uuid] + permissions.collect do |p|
80 if ['can_write', 'can_manage'].index p.name
86 # Return a query with read permissions restricted to the union of of the
87 # permissions of the members of users_list, i.e. if something is readable by
88 # any user in users_list, it will be readable in the query returned by this
90 def self.readable_by(*users_list)
91 # Get rid of troublesome nils
94 # Load optional keyword arguments, if they exist.
95 if users_list.last.is_a? Hash
96 kwargs = users_list.pop
101 # Check if any of the users are admin. If so, we're done.
102 if users_list.select { |u| u.is_admin }.empty?
104 # Collect the uuids for each user and any groups readable by each user.
105 user_uuids = users_list.map { |u| u.uuid }
106 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
107 sanitized_uuid_list = uuid_list.
108 collect { |uuid| sanitize(uuid) }.join(', ')
111 sql_table = kwargs.fetch(:table_name, table_name)
114 # This row is owned by a member of users_list, or owned by a group
115 # readable by a member of users_list
117 # This row uuid is the uuid of a member of users_list
119 # A permission link exists ('write' and 'manage' implicitly include
120 # 'read') from a member of users_list, or a group readable by users_list,
121 # to this row, or to the owner of this row (see join() below).
122 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
124 sql_conds += ["#{sql_table}.owner_uuid in (?)",
125 "#{sql_table}.uuid in (?)",
126 "#{sql_table}.uuid IN #{permitted_uuids}"]
127 sql_params += [uuid_list, user_uuids]
129 if sql_table == "links" and users_list.any?
130 # This row is a 'permission' or 'resources' link class
131 # The uuid for a member of users_list is referenced in either the head
132 # or tail of the link
133 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
134 sql_params += [user_uuids, user_uuids]
137 if sql_table == "logs" and users_list.any?
138 # Link head points to the object described by this row
139 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
141 # This object described by this row is owned by this user, or owned by a group readable by this user
142 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
143 sql_params += [uuid_list]
146 # Link head points to this row, or to the owner of this row (the thing to be read)
148 # Link tail originates from this user, or a group that is readable by this
149 # user (the identity with authorization to read)
151 # Link class is 'permission' ('write' and 'manage' implicitly include 'read')
152 where(sql_conds.join(' OR '), *sql_params)
154 # At least one user is admin, so don't bother to apply any restrictions.
159 def logged_attributes
163 def has_permission? perm_type, target_uuid
164 Link.where(link_class: "permission",
167 head_uuid: target_uuid).any?
172 def ensure_ownership_path_leads_to_user
173 if new_record? or owner_uuid_changed?
174 uuid_in_path = {owner_uuid => true, uuid => true}
176 while (owner_class = self.class.resource_class_for_uuid(x)) != User
179 # Test for cycles with the new version, not the DB contents
181 elsif !owner_class.respond_to? :find_by_uuid
182 raise ActiveRecord::RecordNotFound.new
184 x = owner_class.find_by_uuid(x).owner_uuid
186 rescue ActiveRecord::RecordNotFound => e
187 errors.add :owner_uuid, "is not owned by any user: #{e}"
192 errors.add :owner_uuid, "would create an ownership cycle"
194 errors.add :owner_uuid, "has an ownership cycle"
198 uuid_in_path[x] = true
204 def ensure_owner_uuid_is_permitted
205 raise PermissionDeniedError if !current_user
206 if respond_to? :owner_uuid=
207 self.owner_uuid ||= current_user.uuid
209 if self.owner_uuid_changed?
212 elsif current_user.uuid == self.owner_uuid or
213 current_user.can? write: self.owner_uuid
214 # current_user is, or has :write permission on, the new owner
216 logger.warn "User #{current_user.uuid} tried to change owner_uuid of #{self.class.to_s} #{self.uuid} to #{self.owner_uuid} but does not have permission to write to #{self.owner_uuid}"
217 raise PermissionDeniedError
222 elsif current_user.uuid == self.owner_uuid_was or
223 current_user.uuid == self.uuid or
224 current_user.can? write: self.owner_uuid_was
225 # current user is, or has :write permission on, the previous owner
228 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} but does not have permission to write #{self.owner_uuid_was}"
229 raise PermissionDeniedError
233 def ensure_permission_to_save
234 unless (new_record? ? permission_to_create : permission_to_update)
235 raise PermissionDeniedError
239 def permission_to_create
240 current_user.andand.is_active
243 def permission_to_update
245 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
248 if !current_user.is_active
249 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
252 return true if current_user.is_admin
253 if self.uuid_changed?
254 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
260 def ensure_permission_to_destroy
261 raise PermissionDeniedError unless permission_to_destroy
264 def permission_to_destroy
268 def maybe_update_modified_by_fields
269 update_modified_by_fields if self.changed? or self.new_record?
273 def update_modified_by_fields
274 self.updated_at = Time.now
275 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
276 self.modified_at = Time.now
277 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
278 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
282 def self.has_symbols? x
285 return true if has_symbols?(k) or has_symbols?(v)
290 return true if has_symbols?(k)
298 def self.recursive_stringify x
300 Hash[x.collect do |k,v|
301 [recursive_stringify(k), recursive_stringify(v)]
305 recursive_stringify k
314 def ensure_serialized_attribute_type
315 # Specifying a type in the "serialize" declaration causes rails to
316 # raise an exception if a different data type is retrieved from
317 # the database during load(). The validation preventing such
318 # crash-inducing records from being inserted in the database in
319 # the first place seems to have been left as an exercise to the
321 self.class.serialized_attributes.each do |colname, attr|
323 if self.attributes[colname].class != attr.object_class
324 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
325 elsif self.class.has_symbols? attributes[colname]
326 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
332 def convert_serialized_symbols_to_strings
333 # ensure_serialized_attribute_type should prevent symbols from
334 # getting into the database in the first place. If someone managed
335 # to get them into the database (perhaps using an older version)
336 # we'll convert symbols to strings when loading from the
337 # database. (Otherwise, loading and saving an object with existing
338 # symbols in a serialized field will crash.)
339 self.class.serialized_attributes.each do |colname, attr|
340 if self.class.has_symbols? attributes[colname]
341 attributes[colname] = self.class.recursive_stringify attributes[colname]
342 self.send(colname + '=',
343 self.class.recursive_stringify(attributes[colname]))
348 def foreign_key_attributes
349 attributes.keys.select { |a| a.match /_uuid$/ }
352 def skip_uuid_read_permission_check
353 %w(modified_by_client_uuid)
356 def skip_uuid_existence_check
360 def normalize_collection_uuids
361 foreign_key_attributes.each do |attr|
362 attr_value = send attr
363 if attr_value.is_a? String and
364 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
366 send "#{attr}=", Collection.normalize_uuid(attr_value)
368 # TODO: abort instead of silently accepting unnormalizable value?
374 @@UUID_REGEX = /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/
376 @@prefixes_hash = nil
377 def self.uuid_prefixes
378 unless @@prefixes_hash
380 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
381 if k.respond_to?(:uuid_prefix)
382 @@prefixes_hash[k.uuid_prefix] = k
389 def self.uuid_like_pattern
390 "_____-#{uuid_prefix}-_______________"
393 def ensure_valid_uuids
394 specials = [system_user_uuid, 'd41d8cd98f00b204e9800998ecf8427e+0']
396 foreign_key_attributes.each do |attr|
397 if new_record? or send (attr + "_changed?")
398 next if skip_uuid_existence_check.include? attr
399 attr_value = send attr
400 next if specials.include? attr_value
402 if (r = ArvadosModel::resource_class_for_uuid attr_value)
403 unless skip_uuid_read_permission_check.include? attr
404 r = r.readable_by(current_user)
406 if r.where(uuid: attr_value).count == 0
407 errors.add(attr, "'#{attr_value}' not found")
424 def self.readable_by (*u)
429 [{:uuid => u[:uuid]}]
433 def self.resource_class_for_uuid(uuid)
434 if uuid.is_a? ArvadosModel
437 unless uuid.is_a? String
440 if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
445 Rails.application.eager_load!
446 uuid.match @@UUID_REGEX do |re|
447 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
450 if uuid.match /.+@.+/
457 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
458 # an object in any class.
459 def self.find_by_uuid uuid
460 if self == ArvadosModel
461 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
462 # delegate to the appropriate subclass based on the given uuid.
463 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
471 @old_attributes = logged_attributes
474 def log_change(event_type)
475 log = Log.new(event_type: event_type).fill_object(self)
478 connection.execute "NOTIFY logs, '#{log.id}'"
483 log_change('create') do |log|
484 log.fill_properties('old', nil, nil)
490 log_change('update') do |log|
491 log.fill_properties('old', @old_etag, @old_attributes)
497 log_change('destroy') do |log|
498 log.fill_properties('old', @old_etag, @old_attributes)