apps/workbench/app/models/arvados_base.rb

   1 class ArvadosBase < ActiveRecord::Base
   2   self.abstract_class = true
   3   attr_accessor :attribute_sortkey
   4   attr_accessor :create_params
   5
   6   def self.arvados_api_client
   7     ArvadosApiClient.new_or_current
   8   end
   9
  10   def arvados_api_client
  11     ArvadosApiClient.new_or_current
  12   end
  13
  14   def self.uuid_infix_object_kind
  15     @@uuid_infix_object_kind ||=
  16       begin
  17         infix_kind = {}
  18         arvados_api_client.discovery[:schemas].each do |name, schema|
  19           if schema[:uuidPrefix]
  20             infix_kind[schema[:uuidPrefix]] =
  21               'arvados#' + name.to_s.camelcase(:lower)
  22           end
  23         end
  24
  25         # Recognize obsolete types.
  26         infix_kind.
  27           merge('mxsvm' => 'arvados#pipelineTemplate', # Pipeline
  28                 'uo14g' => 'arvados#pipelineInstance', # PipelineInvocation
  29                 'ldvyl' => 'arvados#group') # Project
  30       end
  31   end
  32
  33   def initialize raw_params={}, create_params={}
  34     super self.class.permit_attribute_params(raw_params)
  35     @create_params = create_params
  36     @attribute_sortkey ||= {
  37       'id' => nil,
  38       'name' => '000',
  39       'owner_uuid' => '002',
  40       'event_type' => '100',
  41       'link_class' => '100',
  42       'group_class' => '100',
  43       'tail_uuid' => '101',
  44       'head_uuid' => '102',
  45       'object_uuid' => '102',
  46       'summary' => '104',
  47       'description' => '104',
  48       'properties' => '150',
  49       'info' => '150',
  50       'created_at' => '200',
  51       'modified_at' => '201',
  52       'modified_by_user_uuid' => '202',
  53       'modified_by_client_uuid' => '203',
  54       'uuid' => '999',
  55     }
  56     @loaded_attributes = {}
  57   end
  58
  59   def self.columns
  60     return @columns if @columns.andand.any?
  61     @columns = []
  62     @attribute_info ||= {}
  63     schema = arvados_api_client.discovery[:schemas][self.to_s.to_sym]
  64     return @columns if schema.nil?
  65     schema[:properties].each do |k, coldef|
  66       case k
  67       when :etag, :kind
  68         attr_reader k
  69       else
  70         if coldef[:type] == coldef[:type].downcase
  71           # boolean, integer, etc.
  72           @columns << column(k, coldef[:type].to_sym)
  73         else
  74           # Hash, Array
  75           @columns << column(k, :text)
  76           serialize k, coldef[:type].constantize
  77         end
  78         define_method k do
  79           unless new_record? or @loaded_attributes.include? k.to_s
  80             Rails.logger.debug "BUG: access non-loaded attribute #{k}"
  81             # We should...
  82             # raise ActiveModel::MissingAttributeError, "missing attribute: #{k}"
  83           end
  84           super()
  85         end
  86         @attribute_info[k] = coldef
  87       end
  88     end
  89     @columns
  90   end
  91
  92   def self.column(name, sql_type = nil, default = nil, null = true)
  93     ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
  94   end
  95
  96   def self.attribute_info
  97     self.columns
  98     @attribute_info
  99   end
 100
 101   def self.find(uuid, opts={})
 102     if uuid.class != String or uuid.length < 27 then
 103       raise 'argument to find() must be a uuid string. Acceptable formats: warehouse locator or string with format xxxxx-xxxxx-xxxxxxxxxxxxxxx'
 104     end
 105
 106     if self == ArvadosBase
 107       # Determine type from uuid and defer to the appropriate subclass.
 108       return resource_class_for_uuid(uuid).find(uuid, opts)
 109     end
 110
 111     # Only do one lookup on the API side per {class, uuid, workbench
 112     # request} unless {cache: false} is given via opts.
 113     cache_key = "request_#{Thread.current.object_id}_#{self.to_s}_#{uuid}"
 114     if opts[:cache] == false
 115       Rails.cache.write cache_key, arvados_api_client.api(self, '/' + uuid)
 116     end
 117     hash = Rails.cache.fetch cache_key do
 118       arvados_api_client.api(self, '/' + uuid)
 119     end
 120     new.private_reload(hash)
 121   end
 122
 123   def self.find?(*args)
 124     find(*args) rescue nil
 125   end
 126
 127   def self.order(*args)
 128     ArvadosResourceList.new(self).order(*args)
 129   end
 130
 131   def self.filter(*args)
 132     ArvadosResourceList.new(self).filter(*args)
 133   end
 134
 135   def self.where(*args)
 136     ArvadosResourceList.new(self).where(*args)
 137   end
 138
 139   def self.limit(*args)
 140     ArvadosResourceList.new(self).limit(*args)
 141   end
 142
 143   def self.select(*args)
 144     ArvadosResourceList.new(self).select(*args)
 145   end
 146
 147   def self.distinct(*args)
 148     ArvadosResourceList.new(self).distinct(*args)
 149   end
 150
 151   def self.eager(*args)
 152     ArvadosResourceList.new(self).eager(*args)
 153   end
 154
 155   def self.all
 156     ArvadosResourceList.new(self)
 157   end
 158
 159   def self.permit_attribute_params raw_params
 160     # strong_parameters does not provide security in Workbench: anyone
 161     # who can get this far can just as well do a call directly to our
 162     # database (Arvados) with the same credentials we use.
 163     #
 164     # The following permit! is necessary even with
 165     # "ActionController::Parameters.permit_all_parameters = true",
 166     # because permit_all does not permit nested attributes.
 167     ActionController::Parameters.new(raw_params).permit!
 168   end
 169
 170   def self.create raw_params={}, create_params={}
 171     x = super(permit_attribute_params(raw_params))
 172     x.create_params = create_params
 173     x
 174   end
 175
 176   def update_attributes raw_params={}
 177     super(self.class.permit_attribute_params(raw_params))
 178   end
 179
 180   def save
 181     obdata = {}
 182     self.class.columns.each do |col|
 183       # Non-nil serialized values must be sent because we can't tell
 184       # whether they've changed. Other than that, any given attribute
 185       # is either unchanged (in which case there's no need to send its
 186       # old value in the update/create command) or has been added to
 187       # #changed by ActiveRecord's #attr= method.
 188       if changed.include? col.name or
 189           (self.class.serialized_attributes.include? col.name and
 190            @loaded_attributes[col.name])
 191         obdata[col.name.to_sym] = self.send col.name
 192       end
 193     end
 194     obdata.delete :id
 195     postdata = { self.class.to_s.underscore => obdata }
 196     if etag
 197       postdata['_method'] = 'PUT'
 198       obdata.delete :uuid
 199       resp = arvados_api_client.api(self.class, '/' + uuid, postdata)
 200     else
 201       postdata.merge!(@create_params) if @create_params
 202       resp = arvados_api_client.api(self.class, '', postdata)
 203     end
 204     return false if !resp[:etag] || !resp[:uuid]
 205
 206     # set read-only non-database attributes
 207     @etag = resp[:etag]
 208     @kind = resp[:kind]
 209
 210     # attributes can be modified during "save" -- we should update our copies
 211     resp.keys.each do |attr|
 212       if self.respond_to? "#{attr}=".to_sym
 213         self.send(attr.to_s + '=', resp[attr.to_sym])
 214       end
 215     end
 216
 217     changes_applied
 218     @new_record = false
 219
 220     self
 221   end
 222
 223   def save!
 224     self.save or raise Exception.new("Save failed")
 225   end
 226
 227   def destroy
 228     if etag || uuid
 229       postdata = { '_method' => 'DELETE' }
 230       resp = arvados_api_client.api(self.class, '/' + uuid, postdata)
 231       resp[:etag] && resp[:uuid] && resp
 232     else
 233       true
 234     end
 235   end
 236
 237   def links(*args)
 238     o = {}
 239     o.merge!(args.pop) if args[-1].is_a? Hash
 240     o[:link_class] ||= args.shift
 241     o[:name] ||= args.shift
 242     o[:tail_uuid] = self.uuid
 243     if all_links
 244       return all_links.select do |m|
 245         ok = true
 246         o.each do |k,v|
 247           if !v.nil?
 248             test_v = m.send(k)
 249             if (v.respond_to?(:uuid) ? v.uuid : v.to_s) != (test_v.respond_to?(:uuid) ? test_v.uuid : test_v.to_s)
 250               ok = false
 251             end
 252           end
 253         end
 254         ok
 255       end
 256     end
 257     @links = arvados_api_client.api Link, '', { _method: 'GET', where: o, eager: true }
 258     @links = arvados_api_client.unpack_api_response(@links)
 259   end
 260
 261   def all_links
 262     return @all_links if @all_links
 263     res = arvados_api_client.api Link, '', {
 264       _method: 'GET',
 265       where: {
 266         tail_kind: self.kind,
 267         tail_uuid: self.uuid
 268       },
 269       eager: true
 270     }
 271     @all_links = arvados_api_client.unpack_api_response(res)
 272   end
 273
 274   def reload
 275     private_reload(self.uuid)
 276   end
 277
 278   def private_reload(uuid_or_hash)
 279     raise "No such object" if !uuid_or_hash
 280     if uuid_or_hash.is_a? Hash
 281       hash = uuid_or_hash
 282     else
 283       hash = arvados_api_client.api(self.class, '/' + uuid_or_hash)
 284     end
 285     hash.each do |k,v|
 286       @loaded_attributes[k.to_s] = true
 287       if self.respond_to?(k.to_s + '=')
 288         self.send(k.to_s + '=', v)
 289       else
 290         # When ArvadosApiClient#schema starts telling us what to expect
 291         # in API responses (not just the server side database
 292         # columns), this sort of awfulness can be avoided:
 293         self.instance_variable_set('@' + k.to_s, v)
 294         if !self.respond_to? k
 295           singleton = class << self; self end
 296           singleton.send :define_method, k, lambda { instance_variable_get('@' + k.to_s) }
 297         end
 298       end
 299     end
 300     @all_links = nil
 301     changes_applied
 302     @new_record = false
 303     self
 304   end
 305
 306   def to_param
 307     uuid
 308   end
 309
 310   def initialize_copy orig
 311     super
 312     forget_uuid!
 313   end
 314
 315   def attributes_for_display
 316     self.attributes.reject { |k,v|
 317       attribute_sortkey.has_key?(k) and !attribute_sortkey[k]
 318     }.sort_by { |k,v|
 319       attribute_sortkey[k] or k
 320     }
 321   end
 322
 323   def class_for_display
 324     self.class.to_s.underscore.humanize
 325   end
 326
 327   def self.class_for_display
 328     self.to_s.underscore.humanize
 329   end
 330
 331   # Array of strings that are names of attributes that should be rendered as textile.
 332   def textile_attributes
 333     []
 334   end
 335
 336   def self.creatable?
 337     current_user.andand.is_active
 338   end
 339
 340   def self.goes_in_projects?
 341     false
 342   end
 343
 344   # can this class of object be copied into a project?
 345   # override to false on indivudal model classes for which this should not be true
 346   def self.copies_to_projects?
 347     self.goes_in_projects?
 348   end
 349
 350   def editable?
 351     (current_user and current_user.is_active and
 352      (current_user.is_admin or
 353       current_user.uuid == self.owner_uuid or
 354       new_record? or
 355       (respond_to?(:writable_by) ?
 356        writable_by.include?(current_user.uuid) :
 357        (ArvadosBase.find(owner_uuid).writable_by.include? current_user.uuid rescue false)))) or false
 358   end
 359
 360   # Array of strings that are the names of attributes that can be edited
 361   # with X-Editable.
 362   def editable_attributes
 363     self.class.columns.map(&:name) -
 364       %w(created_at modified_at modified_by_user_uuid modified_by_client_uuid updated_at)
 365   end
 366
 367   def attribute_editable?(attr, ever=nil)
 368     if not editable_attributes.include?(attr.to_s)
 369       false
 370     elsif not (current_user.andand.is_active)
 371       false
 372     elsif attr == 'uuid'
 373       current_user.is_admin
 374     elsif ever
 375       true
 376     else
 377       editable?
 378     end
 379   end
 380
 381   def self.resource_class_for_uuid(uuid, opts={})
 382     if uuid.is_a? ArvadosBase
 383       return uuid.class
 384     end
 385     unless uuid.is_a? String
 386       return nil
 387     end
 388     if opts[:class].is_a? Class
 389       return opts[:class]
 390     end
 391     if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
 392       return Collection
 393     end
 394     resource_class = nil
 395     uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
 396       resource_class ||= arvados_api_client.
 397         kind_class(self.uuid_infix_object_kind[re[1]])
 398     end
 399     if opts[:referring_object] and
 400         opts[:referring_attr] and
 401         opts[:referring_attr].match /_uuid$/
 402       resource_class ||= arvados_api_client.
 403         kind_class(opts[:referring_object].
 404                    attributes[opts[:referring_attr].
 405                               sub(/_uuid$/, '_kind')])
 406     end
 407     resource_class
 408   end
 409
 410   def resource_param_name
 411     self.class.to_s.underscore
 412   end
 413
 414   def friendly_link_name lookup=nil
 415     (name if self.respond_to? :name) || default_name
 416   end
 417
 418   def content_summary
 419     self.class_for_display
 420   end
 421
 422   def selection_label
 423     friendly_link_name
 424   end
 425
 426   def self.default_name
 427     self.to_s.underscore.humanize
 428   end
 429
 430   def controller
 431     (self.class.to_s.pluralize + 'Controller').constantize
 432   end
 433
 434   def controller_name
 435     self.class.to_s.tableize
 436   end
 437
 438   # Placeholder for name when name is missing or empty
 439   def default_name
 440     if self.respond_to? :name
 441       "New #{class_for_display.downcase}"
 442     else
 443       uuid
 444     end
 445   end
 446
 447   def owner
 448     ArvadosBase.find(owner_uuid) rescue nil
 449   end
 450
 451   protected
 452
 453   def forget_uuid!
 454     self.uuid = nil
 455     @etag = nil
 456     self
 457   end
 458
 459   def self.current_user
 460     Thread.current[:user] ||= User.current if Thread.current[:arvados_api_token]
 461     Thread.current[:user]
 462   end
 463   def current_user
 464     self.class.current_user
 465   end
 466 end