rename projects
[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
8   attr_protected :modified_by_client
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   def self.kind_class(kind)
17     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
18   end
19
20   def eager_load_associations
21     self.class.columns.each do |col|
22       re = col.name.match /^(.*)_kind$/
23       if (re and
24           self.respond_to? re[1].to_sym and
25           (auuid = self.send((re[1] + '_uuid').to_sym)) and
26           (aclass = self.class.kind_class(self.send(col.name.to_sym))) and
27           (aobject = aclass.where('uuid=?', auuid).first))
28         self.instance_variable_set('@'+re[1], aobject)
29       end
30     end
31   end
32
33   protected
34
35   def ensure_permission_to_create
36     raise "Permission denied" unless permission_to_create
37   end
38
39   def permission_to_create
40     current_user
41   end
42
43   def ensure_permission_to_update
44     raise "Permission denied" unless permission_to_update
45   end
46
47   def permission_to_update
48     if !current_user
49       logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
50       return false
51     end
52     if self.uuid_changed?
53       logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
54       return false
55     end
56     return true if current_user.is_admin
57     if self.owner_changed?
58       if current_user.uuid == self.owner or
59           current_user.can? write: self.owner
60         # current_user is, or has :write permission on, the new owner
61       else
62         logger.warn "User #{current_user.uuid} tried to change owner of #{self.class.to_s} #{self.uuid} to #{self.owner} but does not have permission to write to #{self.owner}"
63         return false
64       end
65     end
66     if current_user.uuid == self.owner_was or
67         current_user.uuid == self.uuid or
68         current_user.can? write: self.owner_was
69       # current user is, or has :write permission on, the previous owner
70       return true
71     else
72       logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} but does not have permission to write #{self.owner_was}"
73       return false
74     end
75   end
76
77   def maybe_update_modified_by_fields
78     update_modified_by_fields if self.changed?
79   end
80
81   def update_modified_by_fields
82     self.created_at ||= Time.now
83     self.owner ||= current_default_owner
84     self.modified_at = Time.now
85     self.modified_by_user = current_user ? current_user.uuid : nil
86     self.modified_by_client = current_api_client ? current_api_client.uuid : nil
87   end
88
89   def ensure_serialized_attribute_type
90     # Specifying a type in the "serialize" declaration causes rails to
91     # raise an exception if a different data type is retrieved from
92     # the database during load().  The validation preventing such
93     # crash-inducing records from being inserted in the database in
94     # the first place seems to have been left as an exercise to the
95     # developer.
96     self.class.serialized_attributes.each do |colname, attr|
97       if attr.object_class
98         unless self.attributes[colname].is_a? attr.object_class
99           self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
100         end
101       end
102     end
103   end
104 end