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.select do |col|
59 when :datetime, :integer, :boolean
67 def self.attribute_column attr
68 self.columns.select { |col| col.name == attr.to_s }.first
71 # Return nil if current user is not allowed to see the list of
72 # writers. Otherwise, return a list of user_ and group_uuids with
73 # write permission. (If not returning nil, current_user is always in
74 # the list because can_manage permission is needed to see the list
77 unless (owner_uuid == current_user.uuid or
78 current_user.is_admin or
79 current_user.groups_i_can(:manage).index(owner_uuid))
82 [owner_uuid, current_user.uuid] + permissions.collect do |p|
83 if ['can_write', 'can_manage'].index p.name
89 # Return a query with read permissions restricted to the union of of the
90 # permissions of the members of users_list, i.e. if something is readable by
91 # any user in users_list, it will be readable in the query returned by this
93 def self.readable_by(*users_list)
94 # Get rid of troublesome nils
97 # Load optional keyword arguments, if they exist.
98 if users_list.last.is_a? Hash
99 kwargs = users_list.pop
104 # Check if any of the users are admin. If so, we're done.
105 if users_list.select { |u| u.is_admin }.empty?
107 # Collect the uuids for each user and any groups readable by each user.
108 user_uuids = users_list.map { |u| u.uuid }
109 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
110 sanitized_uuid_list = uuid_list.
111 collect { |uuid| sanitize(uuid) }.join(', ')
114 sql_table = kwargs.fetch(:table_name, table_name)
117 # This row is owned by a member of users_list, or owned by a group
118 # readable by a member of users_list
120 # This row uuid is the uuid of a member of users_list
122 # A permission link exists ('write' and 'manage' implicitly include
123 # 'read') from a member of users_list, or a group readable by users_list,
124 # to this row, or to the owner of this row (see join() below).
125 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
127 sql_conds += ["#{sql_table}.owner_uuid in (?)",
128 "#{sql_table}.uuid in (?)",
129 "#{sql_table}.uuid IN #{permitted_uuids}"]
130 sql_params += [uuid_list, user_uuids]
132 if sql_table == "links" and users_list.any?
133 # This row is a 'permission' or 'resources' link class
134 # The uuid for a member of users_list is referenced in either the head
135 # or tail of the link
136 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
137 sql_params += [user_uuids, user_uuids]
140 if sql_table == "logs" and users_list.any?
141 # Link head points to the object described by this row
142 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
144 # This object described by this row is owned by this user, or owned by a group readable by this user
145 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
146 sql_params += [uuid_list]
149 if sql_table == "collections" and users_list.any?
150 # There is a 'name' link going from a readable group to the collection.
151 name_links = "(SELECT head_uuid FROM links WHERE link_class='name' AND tail_uuid IN (#{sanitized_uuid_list}))"
152 sql_conds += ["#{sql_table}.uuid IN #{name_links}"]
155 # Link head points to this row, or to the owner of this row (the thing to be read)
157 # Link tail originates from this user, or a group that is readable by this
158 # user (the identity with authorization to read)
160 # Link class is 'permission' ('write' and 'manage' implicitly include 'read')
161 where(sql_conds.join(' OR '), *sql_params)
163 # At least one user is admin, so don't bother to apply any restrictions.
168 def logged_attributes
172 def has_permission? perm_type, target_uuid
173 Link.where(link_class: "permission",
176 head_uuid: target_uuid).any?
181 def ensure_ownership_path_leads_to_user
182 if new_record? or owner_uuid_changed?
183 uuid_in_path = {owner_uuid => true, uuid => true}
185 while (owner_class = self.class.resource_class_for_uuid(x)) != User
188 # Test for cycles with the new version, not the DB contents
190 elsif !owner_class.respond_to? :find_by_uuid
191 raise ActiveRecord::RecordNotFound.new
193 x = owner_class.find_by_uuid(x).owner_uuid
195 rescue ActiveRecord::RecordNotFound => e
196 errors.add :owner_uuid, "is not owned by any user: #{e}"
201 errors.add :owner_uuid, "would create an ownership cycle"
203 errors.add :owner_uuid, "has an ownership cycle"
207 uuid_in_path[x] = true
213 def ensure_owner_uuid_is_permitted
214 raise PermissionDeniedError if !current_user
215 if new_record? and respond_to? :owner_uuid=
216 self.owner_uuid ||= current_user.uuid
218 # Verify permission to write to old owner (unless owner_uuid was
219 # nil -- or hasn't changed, in which case the following
220 # "permission to write to new owner" block will take care of us)
221 unless !owner_uuid_changed? or
222 owner_uuid_was.nil? or
223 current_user.uuid == self.owner_uuid_was or
224 current_user.uuid == self.uuid or
225 current_user.can? write: self.owner_uuid_was
226 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write old owner_uuid #{owner_uuid_was}"
227 errors.add :owner_uuid, "cannot be changed without write permission on old owner"
228 raise PermissionDeniedError
230 # Verify permission to write to new owner
231 unless current_user == self or current_user.can? write: owner_uuid
232 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write new owner_uuid #{owner_uuid}"
233 errors.add :owner_uuid, "cannot be changed without write permission on new owner"
234 raise PermissionDeniedError
238 def ensure_permission_to_save
239 unless (new_record? ? permission_to_create : permission_to_update)
240 raise PermissionDeniedError
244 def permission_to_create
245 current_user.andand.is_active
248 def permission_to_update
250 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
253 if !current_user.is_active
254 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
257 return true if current_user.is_admin
258 if self.uuid_changed?
259 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
265 def ensure_permission_to_destroy
266 raise PermissionDeniedError unless permission_to_destroy
269 def permission_to_destroy
273 def maybe_update_modified_by_fields
274 update_modified_by_fields if self.changed? or self.new_record?
278 def update_modified_by_fields
279 self.updated_at = Time.now
280 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
281 self.modified_at = Time.now
282 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
283 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
287 def self.has_symbols? x
290 return true if has_symbols?(k) or has_symbols?(v)
295 return true if has_symbols?(k)
303 def self.recursive_stringify x
305 Hash[x.collect do |k,v|
306 [recursive_stringify(k), recursive_stringify(v)]
310 recursive_stringify k
319 def ensure_serialized_attribute_type
320 # Specifying a type in the "serialize" declaration causes rails to
321 # raise an exception if a different data type is retrieved from
322 # the database during load(). The validation preventing such
323 # crash-inducing records from being inserted in the database in
324 # the first place seems to have been left as an exercise to the
326 self.class.serialized_attributes.each do |colname, attr|
328 if self.attributes[colname].class != attr.object_class
329 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
330 elsif self.class.has_symbols? attributes[colname]
331 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
337 def convert_serialized_symbols_to_strings
338 # ensure_serialized_attribute_type should prevent symbols from
339 # getting into the database in the first place. If someone managed
340 # to get them into the database (perhaps using an older version)
341 # we'll convert symbols to strings when loading from the
342 # database. (Otherwise, loading and saving an object with existing
343 # symbols in a serialized field will crash.)
344 self.class.serialized_attributes.each do |colname, attr|
345 if self.class.has_symbols? attributes[colname]
346 attributes[colname] = self.class.recursive_stringify attributes[colname]
347 self.send(colname + '=',
348 self.class.recursive_stringify(attributes[colname]))
353 def foreign_key_attributes
354 attributes.keys.select { |a| a.match /_uuid$/ }
357 def skip_uuid_read_permission_check
358 %w(modified_by_client_uuid)
361 def skip_uuid_existence_check
365 def normalize_collection_uuids
366 foreign_key_attributes.each do |attr|
367 attr_value = send attr
368 if attr_value.is_a? String and
369 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
371 send "#{attr}=", Collection.normalize_uuid(attr_value)
373 # TODO: abort instead of silently accepting unnormalizable value?
379 @@UUID_REGEX = /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/
381 @@prefixes_hash = nil
382 def self.uuid_prefixes
383 unless @@prefixes_hash
385 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
386 if k.respond_to?(:uuid_prefix)
387 @@prefixes_hash[k.uuid_prefix] = k
394 def self.uuid_like_pattern
395 "_____-#{uuid_prefix}-_______________"
398 def ensure_valid_uuids
399 specials = [system_user_uuid, 'd41d8cd98f00b204e9800998ecf8427e+0']
401 foreign_key_attributes.each do |attr|
402 if new_record? or send (attr + "_changed?")
403 next if skip_uuid_existence_check.include? attr
404 attr_value = send attr
405 next if specials.include? attr_value
407 if (r = ArvadosModel::resource_class_for_uuid attr_value)
408 unless skip_uuid_read_permission_check.include? attr
409 r = r.readable_by(current_user)
411 if r.where(uuid: attr_value).count == 0
412 errors.add(attr, "'#{attr_value}' not found")
429 def self.readable_by (*u)
434 [{:uuid => u[:uuid]}]
438 def self.resource_class_for_uuid(uuid)
439 if uuid.is_a? ArvadosModel
442 unless uuid.is_a? String
445 if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
450 Rails.application.eager_load!
451 uuid.match @@UUID_REGEX do |re|
452 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
455 if uuid.match /.+@.+/
462 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
463 # an object in any class.
464 def self.find_by_uuid uuid
465 if self == ArvadosModel
466 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
467 # delegate to the appropriate subclass based on the given uuid.
468 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
476 @old_attributes = logged_attributes
479 def log_change(event_type)
480 log = Log.new(event_type: event_type).fill_object(self)
483 connection.execute "NOTIFY logs, '#{log.id}'"
488 log_change('create') do |log|
489 log.fill_properties('old', nil, nil)
495 log_change('update') do |log|
496 log.fill_properties('old', @old_etag, @old_attributes)
502 log_change('destroy') do |log|
503 log.fill_properties('old', @old_etag, @old_attributes)