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