services/api/app/models/arvados_model.rb

   1 require 'assign_uuid'
   2 class ArvadosModel < ActiveRecord::Base
   3   self.abstract_class = true
   4
   5   include CurrentApiClient      # current_user, current_api_client, etc.
   6
   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   around_create { |&block| make_log_around(:create, nil, self, &block) }
  18   around_update { |&block| make_log_around(:update, self, self, &block) }
  19   around_destroy { |&block| make_log_around(:destroy, self, nil, &block) }
  20   validate :ensure_serialized_attribute_type
  21   validate :normalize_collection_uuids
  22
  23   has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
  24
  25   class PermissionDeniedError < StandardError
  26     def http_status
  27       403
  28     end
  29   end
  30
  31   class UnauthorizedError < StandardError
  32     def http_status
  33       401
  34     end
  35   end
  36
  37   def self.kind_class(kind)
  38     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
  39   end
  40
  41   def href
  42     "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
  43   end
  44
  45   def self.searchable_columns operator
  46     textonly_operator = !operator.match(/[<=>]/)
  47     self.columns.collect do |col|
  48       if col.name == 'owner_uuid'
  49         nil
  50       elsif [:string, :text].index(col.type)
  51         col.name
  52       elsif !textonly_operator and [:datetime, :integer].index(col.type)
  53         col.name
  54       end
  55     end.compact
  56   end
  57
  58   def self.attribute_column attr
  59     self.columns.select { |col| col.name == attr.to_s }.first
  60   end
  61
  62   def eager_load_associations
  63     self.class.columns.each do |col|
  64       re = col.name.match /^(.*)_kind$/
  65       if (re and
  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)
  71       end
  72     end
  73   end
  74
  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(', ')
  79     or_references_me = ''
  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))"
  82     end
  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}",
  85             true, user.is_admin,
  86             uuid_list,
  87             user.uuid)
  88   end
  89
  90   protected
  91
  92   def ensure_permission_to_create
  93     raise PermissionDeniedError unless permission_to_create
  94   end
  95
  96   def permission_to_create
  97     current_user.andand.is_active
  98   end
  99
 100   def ensure_permission_to_update
 101     raise PermissionDeniedError unless permission_to_update
 102   end
 103
 104   def permission_to_update
 105     if !current_user
 106       logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
 107       return false
 108     end
 109     if !current_user.is_active
 110       logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
 111       return false
 112     end
 113     return true if current_user.is_admin
 114     if self.uuid_changed?
 115       logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
 116       return false
 117     end
 118     if self.owner_uuid_changed?
 119       if current_user.uuid == self.owner_uuid or
 120           current_user.can? write: self.owner_uuid
 121         # current_user is, or has :write permission on, the new owner
 122       else
 123         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}"
 124         return false
 125       end
 126     end
 127     if current_user.uuid == self.owner_uuid_was or
 128         current_user.uuid == self.uuid or
 129         current_user.can? write: self.owner_uuid_was
 130       # current user is, or has :write permission on, the previous owner
 131       return true
 132     else
 133       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}"
 134       return false
 135     end
 136   end
 137
 138   def ensure_permission_to_destroy
 139     raise PermissionDeniedError unless permission_to_destroy
 140   end
 141
 142   def permission_to_destroy
 143     permission_to_update
 144   end
 145
 146   def maybe_update_modified_by_fields
 147     update_modified_by_fields if self.changed?
 148   end
 149
 150   def update_modified_by_fields
 151     self.created_at ||= Time.now
 152     self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
 153     self.modified_at = Time.now
 154     self.modified_by_user_uuid = current_user ? current_user.uuid : nil
 155     self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
 156   end
 157
 158   def ensure_serialized_attribute_type
 159     # Specifying a type in the "serialize" declaration causes rails to
 160     # raise an exception if a different data type is retrieved from
 161     # the database during load().  The validation preventing such
 162     # crash-inducing records from being inserted in the database in
 163     # the first place seems to have been left as an exercise to the
 164     # developer.
 165     self.class.serialized_attributes.each do |colname, attr|
 166       if attr.object_class
 167         unless self.attributes[colname].is_a? attr.object_class
 168           self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
 169         end
 170       end
 171     end
 172   end
 173
 174   def foreign_key_attributes
 175     attributes.keys.select { |a| a.match /_uuid$/ }
 176   end
 177
 178   def normalize_collection_uuids
 179     foreign_key_attributes.each do |attr|
 180       attr_value = send attr
 181       if attr_value.is_a? String and
 182           attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
 183         begin
 184           send "#{attr}=", Collection.normalize_uuid(attr_value)
 185         rescue
 186           # TODO: abort instead of silently accepting unnormalizable value?
 187         end
 188       end
 189     end
 190   end
 191
 192   def self.resource_class_for_uuid(uuid)
 193     if uuid.is_a? ArvadosModel
 194       return uuid.class
 195     end
 196     unless uuid.is_a? String
 197       return nil
 198     end
 199     if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
 200       return Collection
 201     end
 202     resource_class = nil
 203
 204     Rails.application.eager_load!
 205     uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
 206       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
 207         if k.respond_to?(:uuid_prefix)
 208           if k.uuid_prefix == re[1]
 209             return k
 210           end
 211         end
 212       end
 213     end
 214     nil
 215   end
 216
 217   def log_start_state
 218     @old_etag = etag
 219     @old_attributes = attributes
 220   end
 221
 222   def make_log_around(event_type, old_thing, new_thing)
 223     if self.is_a? Log
 224       yield
 225     else
 226       log = Log.start_from(old_thing, event_type.to_s)
 227       if not old_thing.nil?
 228         log.properties['old_etag'] = @old_etag
 229         log.properties['old_attributes'] = @old_attributes
 230       end
 231       yield
 232       log.update_to new_thing
 233       log_start_state
 234       log.save
 235     end
 236   end
 237 end