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