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