apps/workbench/app/models/arvados_base.rb

   1 class ArvadosBase < ActiveRecord::Base
   2   self.abstract_class = true
   3   attr_accessor :attribute_sortkey
   4
   5   def self.uuid_infix_object_kind
   6     @@uuid_infix_object_kind ||=
   7       begin
   8         infix_kind = {}
   9         $arvados_api_client.discovery[:schemas].each do |name, schema|
  10           if schema[:uuidPrefix]
  11             infix_kind[schema[:uuidPrefix]] =
  12               'arvados#' + name.to_s.camelcase(:lower)
  13           end
  14         end
  15
  16         # Recognize obsolete types.
  17         infix_kind.
  18           merge('mxsvm' => 'arvados#pipelineTemplate', # Pipeline
  19                 'uo14g' => 'arvados#pipelineInstance', # PipelineInvocation
  20                 'ldvyl' => 'arvados#group') # Project
  21       end
  22   end
  23
  24   def initialize(*args)
  25     super(*args)
  26     @attribute_sortkey ||= {
  27       'id' => nil,
  28       'name' => '000',
  29       'owner_uuid' => '002',
  30       'event_type' => '100',
  31       'link_class' => '100',
  32       'group_class' => '100',
  33       'tail_uuid' => '101',
  34       'head_uuid' => '102',
  35       'object_uuid' => '102',
  36       'summary' => '104',
  37       'description' => '104',
  38       'properties' => '150',
  39       'info' => '150',
  40       'created_at' => '200',
  41       'modified_at' => '201',
  42       'modified_by_user_uuid' => '202',
  43       'modified_by_client_uuid' => '203',
  44       'uuid' => '999',
  45     }
  46   end
  47
  48   def self.columns
  49     return @columns unless @columns.nil?
  50     @columns = []
  51     @attribute_info ||= {}
  52     schema = $arvados_api_client.discovery[:schemas][self.to_s.to_sym]
  53     return @columns if schema.nil?
  54     schema[:properties].each do |k, coldef|
  55       case k
  56       when :etag, :kind
  57         attr_reader k
  58       else
  59         if coldef[:type] == coldef[:type].downcase
  60           # boolean, integer, etc.
  61           @columns << column(k, coldef[:type].to_sym)
  62         else
  63           # Hash, Array
  64           @columns << column(k, :text)
  65           serialize k, coldef[:type].constantize
  66         end
  67         attr_accessible k
  68         @attribute_info[k] = coldef
  69       end
  70     end
  71     @columns
  72   end
  73
  74   def self.column(name, sql_type = nil, default = nil, null = true)
  75     ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
  76   end
  77
  78   def self.attribute_info
  79     self.columns
  80     @attribute_info
  81   end
  82
  83   def self.find(uuid, opts={})
  84     if uuid.class != String or uuid.length < 27 then
  85       raise 'argument to find() must be a uuid string. Acceptable formats: warehouse locator or string with format xxxxx-xxxxx-xxxxxxxxxxxxxxx'
  86     end
  87
  88     # Only do one lookup on the API side per {class, uuid, workbench
  89     # request} unless {cache: false} is given via opts.
  90     cache_key = "request_#{Thread.current.object_id}_#{self.to_s}_#{uuid}"
  91     if opts[:cache] == false
  92       Rails.cache.write cache_key, $arvados_api_client.api(self, '/' + uuid)
  93     end
  94     hash = Rails.cache.fetch cache_key do
  95       $arvados_api_client.api(self, '/' + uuid)
  96     end
  97     new.private_reload(hash)
  98   end
  99
 100   def self.order(*args)
 101     ArvadosResourceList.new(self).order(*args)
 102   end
 103
 104   def self.filter(*args)
 105     ArvadosResourceList.new(self).filter(*args)
 106   end
 107
 108   def self.where(*args)
 109     ArvadosResourceList.new(self).where(*args)
 110   end
 111
 112   def self.limit(*args)
 113     ArvadosResourceList.new(self).limit(*args)
 114   end
 115
 116   def self.eager(*args)
 117     ArvadosResourceList.new(self).eager(*args)
 118   end
 119
 120   def self.all(*args)
 121     ArvadosResourceList.new(self).all(*args)
 122   end
 123
 124   def save
 125     obdata = {}
 126     self.class.columns.each do |col|
 127       obdata[col.name.to_sym] = self.send(col.name.to_sym)
 128     end
 129     obdata.delete :id
 130     postdata = { self.class.to_s.underscore => obdata }
 131     if etag
 132       postdata['_method'] = 'PUT'
 133       obdata.delete :uuid
 134       resp = $arvados_api_client.api(self.class, '/' + uuid, postdata)
 135     else
 136       resp = $arvados_api_client.api(self.class, '', postdata)
 137     end
 138     return false if !resp[:etag] || !resp[:uuid]
 139
 140     # set read-only non-database attributes
 141     @etag = resp[:etag]
 142     @kind = resp[:kind]
 143
 144     # attributes can be modified during "save" -- we should update our copies
 145     resp.keys.each do |attr|
 146       if self.respond_to? "#{attr}=".to_sym
 147         self.send(attr.to_s + '=', resp[attr.to_sym])
 148       end
 149     end
 150
 151     @new_record = false
 152
 153     self
 154   end
 155
 156   def save!
 157     self.save or raise Exception.new("Save failed")
 158   end
 159
 160   def destroy
 161     if etag || uuid
 162       postdata = { '_method' => 'DELETE' }
 163       resp = $arvados_api_client.api(self.class, '/' + uuid, postdata)
 164       resp[:etag] && resp[:uuid] && resp
 165     else
 166       true
 167     end
 168   end
 169
 170   def links(*args)
 171     o = {}
 172     o.merge!(args.pop) if args[-1].is_a? Hash
 173     o[:link_class] ||= args.shift
 174     o[:name] ||= args.shift
 175     o[:tail_uuid] = self.uuid
 176     if all_links
 177       return all_links.select do |m|
 178         ok = true
 179         o.each do |k,v|
 180           if !v.nil?
 181             test_v = m.send(k)
 182             if (v.respond_to?(:uuid) ? v.uuid : v.to_s) != (test_v.respond_to?(:uuid) ? test_v.uuid : test_v.to_s)
 183               ok = false
 184             end
 185           end
 186         end
 187         ok
 188       end
 189     end
 190     @links = $arvados_api_client.api Link, '', { _method: 'GET', where: o, eager: true }
 191     @links = $arvados_api_client.unpack_api_response(@links)
 192   end
 193
 194   def all_links
 195     return @all_links if @all_links
 196     res = $arvados_api_client.api Link, '', {
 197       _method: 'GET',
 198       where: {
 199         tail_kind: self.kind,
 200         tail_uuid: self.uuid
 201       },
 202       eager: true
 203     }
 204     @all_links = $arvados_api_client.unpack_api_response(res)
 205   end
 206
 207   def reload
 208     private_reload(self.uuid)
 209   end
 210
 211   def private_reload(uuid_or_hash)
 212     raise "No such object" if !uuid_or_hash
 213     if uuid_or_hash.is_a? Hash
 214       hash = uuid_or_hash
 215     else
 216       hash = $arvados_api_client.api(self.class, '/' + uuid_or_hash)
 217     end
 218     hash.each do |k,v|
 219       if self.respond_to?(k.to_s + '=')
 220         self.send(k.to_s + '=', v)
 221       else
 222         # When ArvadosApiClient#schema starts telling us what to expect
 223         # in API responses (not just the server side database
 224         # columns), this sort of awfulness can be avoided:
 225         self.instance_variable_set('@' + k.to_s, v)
 226         if !self.respond_to? k
 227           singleton = class << self; self end
 228           singleton.send :define_method, k, lambda { instance_variable_get('@' + k.to_s) }
 229         end
 230       end
 231     end
 232     @all_links = nil
 233     @new_record = false
 234     self
 235   end
 236
 237   def to_param
 238     uuid
 239   end
 240
 241   def dup
 242     super.forget_uuid!
 243   end
 244
 245   def attributes_for_display
 246     self.attributes.reject { |k,v|
 247       attribute_sortkey.has_key?(k) and !attribute_sortkey[k]
 248     }.sort_by { |k,v|
 249       attribute_sortkey[k] or k
 250     }
 251   end
 252
 253   def class_for_display
 254     self.class.to_s
 255   end
 256
 257   def self.creatable?
 258     current_user
 259   end
 260
 261   def editable?
 262     (current_user and current_user.is_active and
 263      (current_user.is_admin or
 264       current_user.uuid == self.owner_uuid))
 265   end
 266
 267   def attribute_editable?(attr)
 268     if "created_at modified_at modified_by_user_uuid modified_by_client_uuid updated_at".index(attr.to_s)
 269       false
 270     elsif not (current_user.andand.is_active)
 271       false
 272     elsif "uuid owner_uuid".index(attr.to_s) or current_user.is_admin
 273       current_user.is_admin
 274     else
 275       current_user.uuid == self.owner_uuid or current_user.uuid == self.uuid
 276     end
 277   end
 278
 279   def self.resource_class_for_uuid(uuid, opts={})
 280     if uuid.is_a? ArvadosBase
 281       return uuid.class
 282     end
 283     unless uuid.is_a? String
 284       return nil
 285     end
 286     if opts[:class].is_a? Class
 287       return opts[:class]
 288     end
 289     if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
 290       return Collection
 291     end
 292     resource_class = nil
 293     uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
 294       resource_class ||= $arvados_api_client.
 295         kind_class(self.uuid_infix_object_kind[re[1]])
 296     end
 297     if opts[:referring_object] and
 298         opts[:referring_attr] and
 299         opts[:referring_attr].match /_uuid$/
 300       resource_class ||= $arvados_api_client.
 301         kind_class(opts[:referring_object].
 302                    attributes[opts[:referring_attr].
 303                               sub(/_uuid$/, '_kind')])
 304     end
 305     resource_class
 306   end
 307
 308   def friendly_link_name
 309     (name if self.respond_to? :name) || uuid
 310   end
 311
 312   def content_summary
 313     self.class_for_display
 314   end
 315
 316   def selection_label
 317     friendly_link_name
 318   end
 319
 320   protected
 321
 322   def forget_uuid!
 323     self.uuid = nil
 324     @etag = nil
 325     self
 326   end
 327
 328   def self.current_user
 329     Thread.current[:user] ||= User.current if Thread.current[:arvados_api_token]
 330     Thread.current[:user]
 331   end
 332   def current_user
 333     self.class.current_user
 334   end
 335 end