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
15 before_create :update_modified_by_fields
16 before_update :maybe_update_modified_by_fields
17 after_create :log_create
18 after_update :log_update
19 after_destroy :log_destroy
20 validate :ensure_serialized_attribute_type
21 validate :normalize_collection_uuids
23 has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
25 class PermissionDeniedError < StandardError
31 class UnauthorizedError < StandardError
37 def self.kind_class(kind)
38 kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
42 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
45 def self.searchable_columns operator
46 textonly_operator = !operator.match(/[<=>]/)
47 self.columns.collect do |col|
48 if col.name == 'owner_uuid'
50 elsif [:string, :text].index(col.type)
52 elsif !textonly_operator and [:datetime, :integer].index(col.type)
58 def self.attribute_column attr
59 self.columns.select { |col| col.name == attr.to_s }.first
62 def eager_load_associations
63 self.class.columns.each do |col|
64 re = col.name.match /^(.*)_kind$/
66 self.respond_to? re[1].to_sym and
67 (auuid = self.send((re[1] + '_uuid').to_sym)) and
68 (aclass = self.class.kind_class(self.send(col.name.to_sym))) and
69 (aobject = aclass.where('uuid=?', auuid).first))
70 self.instance_variable_set('@'+re[1], aobject)
75 def self.readable_by user
76 uuid_list = [user.uuid, *user.groups_i_can(:read)]
77 sanitized_uuid_list = uuid_list.
78 collect { |uuid| sanitize(uuid) }.join(', ')
80 if self == Link and user
81 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))"
83 joins("LEFT JOIN links permissions ON permissions.head_uuid in (#{table_name}.owner_uuid, #{table_name}.uuid) AND permissions.tail_uuid in (#{sanitized_uuid_list}) AND permissions.link_class='permission'").
84 where("?=? OR #{table_name}.owner_uuid in (?) OR #{table_name}.uuid=? OR permissions.head_uuid IS NOT NULL #{or_references_me}",
96 def ensure_permission_to_create
97 raise PermissionDeniedError unless permission_to_create
100 def permission_to_create
101 current_user.andand.is_active
104 def ensure_permission_to_update
105 raise PermissionDeniedError unless permission_to_update
108 def permission_to_update
110 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
113 if !current_user.is_active
114 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
117 return true if current_user.is_admin
118 if self.uuid_changed?
119 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
122 if self.owner_uuid_changed?
123 if current_user.uuid == self.owner_uuid or
124 current_user.can? write: self.owner_uuid
125 # current_user is, or has :write permission on, the new owner
127 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}"
131 if current_user.uuid == self.owner_uuid_was or
132 current_user.uuid == self.uuid or
133 current_user.can? write: self.owner_uuid_was
134 # current user is, or has :write permission on, the previous owner
137 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}"
142 def ensure_permission_to_destroy
143 raise PermissionDeniedError unless permission_to_destroy
146 def permission_to_destroy
150 def maybe_update_modified_by_fields
151 update_modified_by_fields if self.changed?
154 def update_modified_by_fields
155 self.created_at ||= Time.now
156 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
157 self.modified_at = Time.now
158 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
159 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
162 def ensure_serialized_attribute_type
163 # Specifying a type in the "serialize" declaration causes rails to
164 # raise an exception if a different data type is retrieved from
165 # the database during load(). The validation preventing such
166 # crash-inducing records from being inserted in the database in
167 # the first place seems to have been left as an exercise to the
169 self.class.serialized_attributes.each do |colname, attr|
171 unless self.attributes[colname].is_a? attr.object_class
172 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
178 def foreign_key_attributes
179 attributes.keys.select { |a| a.match /_uuid$/ }
182 def normalize_collection_uuids
183 foreign_key_attributes.each do |attr|
184 attr_value = send attr
185 if attr_value.is_a? String and
186 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
188 send "#{attr}=", Collection.normalize_uuid(attr_value)
190 # TODO: abort instead of silently accepting unnormalizable value?
196 def self.resource_class_for_uuid(uuid)
197 if uuid.is_a? ArvadosModel
200 unless uuid.is_a? String
203 if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
208 Rails.application.eager_load!
209 uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
210 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
211 if k.respond_to?(:uuid_prefix)
212 if k.uuid_prefix == re[1]
223 @old_attributes = logged_attributes
226 def log_change(event_type)
227 log = Log.new(event_type: event_type).fill_object(self)
234 log_change('create') do |log|
235 log.fill_properties('old', nil, nil)
241 log_change('update') do |log|
242 log.fill_properties('old', @old_etag, @old_attributes)
248 log_change('destroy') do |log|
249 log.fill_properties('old', @old_etag, @old_attributes)