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