Move can_read permission logic into ArvadosModel.readable_by scope,
[arvados.git] / services / api / app / models / arvados_model.rb
1 require 'assign_uuid'
2 class ArvadosModel < ActiveRecord::Base
3   self.abstract_class = true
4
5   include CurrentApiClient      # current_user, current_api_client, etc.
6
7   attr_protected :created_at
8   attr_protected :modified_by_user_uuid
9   attr_protected :modified_by_client_uuid
10   attr_protected :modified_at
11   before_create :ensure_permission_to_create
12   before_update :ensure_permission_to_update
13   before_destroy :ensure_permission_to_destroy
14   before_create :update_modified_by_fields
15   before_update :maybe_update_modified_by_fields
16   validate :ensure_serialized_attribute_type
17
18   has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
19
20   class PermissionDeniedError < StandardError
21     def http_status
22       403
23     end
24   end
25
26   class UnauthorizedError < StandardError
27     def http_status
28       401
29     end
30   end
31
32   def self.kind_class(kind)
33     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
34   end
35
36   def href
37     "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
38   end
39
40   def self.searchable_columns
41     self.columns.collect do |col|
42       if [:string, :text].index(col.type) && col.name != 'owner_uuid'
43         col.name
44       end
45     end.compact
46   end
47
48   def eager_load_associations
49     self.class.columns.each do |col|
50       re = col.name.match /^(.*)_kind$/
51       if (re and
52           self.respond_to? re[1].to_sym and
53           (auuid = self.send((re[1] + '_uuid').to_sym)) and
54           (aclass = self.class.kind_class(self.send(col.name.to_sym))) and
55           (aobject = aclass.where('uuid=?', auuid).first))
56         self.instance_variable_set('@'+re[1], aobject)
57       end
58     end
59   end
60
61   def self.readable_by user
62     uuid_list = [user.uuid, *user.groups_i_can(:read)]
63     sanitized_uuid_list = uuid_list.
64       collect { |uuid| sanitize(uuid) }.join(', ')
65     or_references_me = ''
66     if self == Link and user
67       or_references_me = "OR (#{table_name}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND #{sanitize user.uuid} IN (#{table_name}.head_uuid, #{table_name}.tail_uuid))"
68     end
69     joins("LEFT JOIN links permissions ON permissions.head_uuid in (#{table_name}.owner_uuid, #{table_name}.uuid) AND permissions.tail_uuid in (#{sanitized_uuid_list}) AND permissions.link_class='permission'").
70       where("?=? OR #{table_name}.owner_uuid in (?) OR #{table_name}.uuid=? OR permissions.head_uuid IS NOT NULL #{or_references_me}",
71             true, user.is_admin,
72             uuid_list,
73             user.uuid)
74   end
75
76   protected
77
78   def ensure_permission_to_create
79     raise PermissionDeniedError unless permission_to_create
80   end
81
82   def permission_to_create
83     current_user.andand.is_active
84   end
85
86   def ensure_permission_to_update
87     raise PermissionDeniedError unless permission_to_update
88   end
89
90   def permission_to_update
91     if !current_user
92       logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
93       return false
94     end
95     if !current_user.is_active
96       logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
97       return false
98     end
99     return true if current_user.is_admin
100     if self.uuid_changed?
101       logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
102       return false
103     end
104     if self.owner_uuid_changed?
105       if current_user.uuid == self.owner_uuid or
106           current_user.can? write: self.owner_uuid
107         # current_user is, or has :write permission on, the new owner
108       else
109         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}"
110         return false
111       end
112     end
113     if current_user.uuid == self.owner_uuid_was or
114         current_user.uuid == self.uuid or
115         current_user.can? write: self.owner_uuid_was
116       # current user is, or has :write permission on, the previous owner
117       return true
118     else
119       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}"
120       return false
121     end
122   end
123
124   def ensure_permission_to_destroy
125     raise PermissionDeniedError unless permission_to_destroy
126   end
127
128   def permission_to_destroy
129     permission_to_update
130   end
131
132   def maybe_update_modified_by_fields
133     update_modified_by_fields if self.changed?
134   end
135
136   def update_modified_by_fields
137     self.created_at ||= Time.now
138     self.owner_uuid ||= current_default_owner
139     self.modified_at = Time.now
140     self.modified_by_user_uuid = current_user ? current_user.uuid : nil
141     self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
142   end
143
144   def ensure_serialized_attribute_type
145     # Specifying a type in the "serialize" declaration causes rails to
146     # raise an exception if a different data type is retrieved from
147     # the database during load().  The validation preventing such
148     # crash-inducing records from being inserted in the database in
149     # the first place seems to have been left as an exercise to the
150     # developer.
151     self.class.serialized_attributes.each do |colname, attr|
152       if attr.object_class
153         unless self.attributes[colname].is_a? attr.object_class
154           self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
155         end
156       end
157     end
158   end
159
160   def self.resource_class_for_uuid(uuid)
161     if uuid.is_a? ArvadosModel
162       return uuid.class
163     end
164     unless uuid.is_a? String
165       return nil
166     end
167     if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
168       return Collection
169     end
170     resource_class = nil
171
172     Rails.application.eager_load!
173     uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
174       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
175         if k.respond_to?(:uuid_prefix)
176           if k.uuid_prefix == re[1]
177             return k
178           end
179         end
180       end
181     end
182     nil
183   end
184
185 end