2 class ArvadosModel < ActiveRecord::Base
3 self.abstract_class = true
5 include CurrentApiClient # current_user, current_api_client, etc.
7 attr_protected :created_at
8 attr_protected :modified_by_user_uuid
9 attr_protected :modified_by_client_uuid
10 attr_protected :modified_at
11 after_initialize :log_start_state
12 before_create :ensure_permission_to_create
13 before_update :ensure_permission_to_update
14 before_destroy :ensure_permission_to_destroy
16 before_create :update_modified_by_fields
17 before_update :maybe_update_modified_by_fields
18 after_create :log_create
19 after_update :log_update
20 after_destroy :log_destroy
21 validate :ensure_serialized_attribute_type
22 validate :normalize_collection_uuids
23 validate :ensure_valid_uuids
25 has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
27 class PermissionDeniedError < StandardError
33 class UnauthorizedError < StandardError
39 def self.kind_class(kind)
40 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
44 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
47 def self.searchable_columns operator
48 textonly_operator = !operator.match(/[<=>]/)
49 self.columns.collect do |col|
50 if col.name == 'owner_uuid'
52 elsif [:string, :text].index(col.type)
54 elsif !textonly_operator and [:datetime, :integer].index(col.type)
60 def self.attribute_column attr
61 self.columns.select { |col| col.name == attr.to_s }.first
64 # def eager_load_associations
65 # self.class.columns.each do |col|
66 # re = col.name.match /^(.*)_kind$/
68 # self.respond_to? re[1].to_sym and
69 # (auuid = self.send((re[1] + '_uuid').to_sym)) and
70 # (aclass = self.class.kind_class(self.send(col.name.to_sym))) and
71 # (aobject = aclass.where('uuid=?', auuid).first))
72 # self.instance_variable_set('@'+re[1], aobject)
77 def self.readable_by user
78 uuid_list = [user.uuid, *user.groups_i_can(:read)]
79 sanitized_uuid_list = uuid_list.
80 collect { |uuid| sanitize(uuid) }.join(', ')
84 or_row_is_me = "OR (#{table_name}.uuid=#{sanitize user.uuid})"
88 or_references_me = "OR (#{table_name}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND #{sanitize user.uuid} IN (#{table_name}.head_uuid, #{table_name}.tail_uuid))"
92 or_object_uuid = ", #{table_name}.object_uuid"
93 or_object_owner = "OR (#{table_name}.object_owner_uuid in (#{sanitized_uuid_list}))"
96 # Link head points to this row, or to the owner of this row (the thing to be read)
97 # (or the object described by this row, for logs table only)
98 # Link tail originates from this user, or a group that is readable by this
99 # user (the identity with authorization to read)
100 # Link is any permission link ('write' and 'manage' implicitly include 'read')
101 # The existence of such a link is tested in the where clause as permissions.head_uuid IS NOT NULL.
105 # This row is owned by this user, or owned by a group readable by this user
107 # This is the users table
108 # This row uuid is equal this user uuid
110 # This is the links table
111 # This row is a permission link
112 # The current user is referenced in either the head or tail of the link
114 # This is the logs table
115 # This object described by this row is owned by this user, or owned by a group readable by this user
117 joins("LEFT JOIN links permissions ON permissions.head_uuid in (#{table_name}.owner_uuid, #{table_name}.uuid #{or_object_uuid}) AND permissions.tail_uuid in (#{sanitized_uuid_list}) AND permissions.link_class='permission'").
118 where("permissions.head_uuid IS NOT NULL OR ?=? OR #{table_name}.owner_uuid in (?) #{or_row_is_me} #{or_references_me} #{or_object_owner}",
119 user.is_admin, true, uuid_list).uniq
122 def logged_attributes
128 def ensure_permission_to_create
129 raise PermissionDeniedError unless permission_to_create
132 def permission_to_create
133 current_user.andand.is_active
136 def ensure_permission_to_update
137 raise PermissionDeniedError unless permission_to_update
140 def permission_to_update
142 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
145 if !current_user.is_active
146 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
149 return true if current_user.is_admin
150 if self.uuid_changed?
151 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
154 if self.owner_uuid_changed?
155 if current_user.uuid == self.owner_uuid or
156 current_user.can? write: self.owner_uuid
157 # current_user is, or has :write permission on, the new owner
159 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}"
163 if current_user.uuid == self.owner_uuid_was or
164 current_user.uuid == self.uuid or
165 current_user.can? write: self.owner_uuid_was
166 # current user is, or has :write permission on, the previous owner
169 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}"
174 def ensure_permission_to_destroy
175 raise PermissionDeniedError unless permission_to_destroy
178 def permission_to_destroy
182 def maybe_update_modified_by_fields
183 update_modified_by_fields if self.changed? or self.new_record?
186 def update_modified_by_fields
187 self.updated_at = Time.now
188 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
189 self.modified_at = Time.now
190 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
191 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
194 def ensure_serialized_attribute_type
195 # Specifying a type in the "serialize" declaration causes rails to
196 # raise an exception if a different data type is retrieved from
197 # the database during load(). The validation preventing such
198 # crash-inducing records from being inserted in the database in
199 # the first place seems to have been left as an exercise to the
201 self.class.serialized_attributes.each do |colname, attr|
203 unless self.attributes[colname].is_a? attr.object_class
204 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
210 def foreign_key_attributes
211 attributes.keys.select { |a| a.match /_uuid$/ }
214 def skip_uuid_read_permission_check
215 %w(modified_by_client_uuid)
218 def skip_uuid_existence_check
222 def normalize_collection_uuids
223 foreign_key_attributes.each do |attr|
224 attr_value = send attr
225 if attr_value.is_a? String and
226 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
228 send "#{attr}=", Collection.normalize_uuid(attr_value)
230 # TODO: abort instead of silently accepting unnormalizable value?
236 @@UUID_REGEX = /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/
238 @@prefixes_hash = nil
239 def self.uuid_prefixes
240 unless @@prefixes_hash
242 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
243 if k.respond_to?(:uuid_prefix)
244 @@prefixes_hash[k.uuid_prefix] = k
251 def self.uuid_like_pattern
252 "_____-#{uuid_prefix}-_______________"
255 def ensure_valid_uuids
256 specials = [system_user_uuid, 'd41d8cd98f00b204e9800998ecf8427e+0']
258 foreign_key_attributes.each do |attr|
259 if new_record? or send (attr + "_changed?")
260 next if skip_uuid_existence_check.include? attr
261 attr_value = send attr
262 next if specials.include? attr_value
264 if (r = ArvadosModel::resource_class_for_uuid attr_value)
265 unless skip_uuid_read_permission_check.include? attr
266 r = r.readable_by(current_user)
268 if r.where(uuid: attr_value).count == 0
269 errors.add(attr, "'#{attr_value}' not found")
286 def self.readable_by (u)
291 [{:uuid => u[:uuid]}]
295 def self.resource_class_for_uuid(uuid)
296 if uuid.is_a? ArvadosModel
299 unless uuid.is_a? String
302 if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
307 Rails.application.eager_load!
308 uuid.match @@UUID_REGEX do |re|
309 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
312 if uuid.match /.+@.+/
321 @old_attributes = logged_attributes
324 def log_change(event_type)
325 log = Log.new(event_type: event_type).fill_object(self)
328 connection.execute "NOTIFY logs, '#{log.id}'"
333 log_change('create') do |log|
334 log.fill_properties('old', nil, nil)
340 log_change('update') do |log|
341 log.fill_properties('old', @old_etag, @old_attributes)
347 log_change('destroy') do |log|
348 log.fill_properties('old', @old_etag, @old_attributes)