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