include "href" key for each object in API response
[arvados.git] / services / api / app / models / arvados_model.rb
1 class ArvadosModel < ActiveRecord::Base
2   self.abstract_class = true
3
4   include CurrentApiClient      # current_user, current_api_client, etc.
5
6   attr_protected :created_at
7   attr_protected :modified_by_user_uuid
8   attr_protected :modified_by_client_uuid
9   attr_protected :modified_at
10   before_create :ensure_permission_to_create
11   before_update :ensure_permission_to_update
12   before_create :update_modified_by_fields
13   before_update :maybe_update_modified_by_fields
14   validate :ensure_serialized_attribute_type
15
16   has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
17
18   class PermissionDeniedError < StandardError
19   end
20
21   def self.kind_class(kind)
22     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
23   end
24
25   def href
26     "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
27   end
28
29   def eager_load_associations
30     self.class.columns.each do |col|
31       re = col.name.match /^(.*)_kind$/
32       if (re and
33           self.respond_to? re[1].to_sym and
34           (auuid = self.send((re[1] + '_uuid').to_sym)) and
35           (aclass = self.class.kind_class(self.send(col.name.to_sym))) and
36           (aobject = aclass.where('uuid=?', auuid).first))
37         self.instance_variable_set('@'+re[1], aobject)
38       end
39     end
40   end
41
42   protected
43
44   def ensure_permission_to_create
45     raise PermissionDeniedError unless permission_to_create
46   end
47
48   def permission_to_create
49     current_user.andand.is_active
50   end
51
52   def ensure_permission_to_update
53     raise PermissionDeniedError unless permission_to_update
54   end
55
56   def permission_to_update
57     if !current_user
58       logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
59       return false
60     end
61     if !current_user.is_active
62       logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
63       return false
64     end
65     return true if current_user.is_admin
66     if self.uuid_changed?
67       logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
68       return false
69     end
70     if self.owner_uuid_changed?
71       if current_user.uuid == self.owner_uuid or
72           current_user.can? write: self.owner_uuid
73         # current_user is, or has :write permission on, the new owner
74       else
75         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}"
76         return false
77       end
78     end
79     if current_user.uuid == self.owner_uuid_was or
80         current_user.uuid == self.uuid or
81         current_user.can? write: self.owner_uuid_was
82       # current user is, or has :write permission on, the previous owner
83       return true
84     else
85       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}"
86       return false
87     end
88   end
89
90   def maybe_update_modified_by_fields
91     update_modified_by_fields if self.changed?
92   end
93
94   def update_modified_by_fields
95     self.created_at ||= Time.now
96     self.owner_uuid ||= current_default_owner
97     self.modified_at = Time.now
98     self.modified_by_user_uuid = current_user ? current_user.uuid : nil
99     self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
100   end
101
102   def ensure_serialized_attribute_type
103     # Specifying a type in the "serialize" declaration causes rails to
104     # raise an exception if a different data type is retrieved from
105     # the database during load().  The validation preventing such
106     # crash-inducing records from being inserted in the database in
107     # the first place seems to have been left as an exercise to the
108     # developer.
109     self.class.serialized_attributes.each do |colname, attr|
110       if attr.object_class
111         unless self.attributes[colname].is_a? attr.object_class
112           self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
113         end
114       end
115     end
116   end
117 end