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