Merge branch '1976-pipeline-progress'
[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   protected
62
63   def ensure_permission_to_create
64     raise PermissionDeniedError unless permission_to_create
65   end
66
67   def permission_to_create
68     current_user.andand.is_active
69   end
70
71   def ensure_permission_to_update
72     raise PermissionDeniedError unless permission_to_update
73   end
74
75   def permission_to_update
76     if !current_user
77       logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
78       return false
79     end
80     if !current_user.is_active
81       logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
82       return false
83     end
84     return true if current_user.is_admin
85     if self.uuid_changed?
86       logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
87       return false
88     end
89     if self.owner_uuid_changed?
90       if current_user.uuid == self.owner_uuid or
91           current_user.can? write: self.owner_uuid
92         # current_user is, or has :write permission on, the new owner
93       else
94         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}"
95         return false
96       end
97     end
98     if current_user.uuid == self.owner_uuid_was or
99         current_user.uuid == self.uuid or
100         current_user.can? write: self.owner_uuid_was
101       # current user is, or has :write permission on, the previous owner
102       return true
103     else
104       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}"
105       return false
106     end
107   end
108
109   def ensure_permission_to_destroy
110     raise PermissionDeniedError unless permission_to_destroy
111   end
112
113   def permission_to_destroy
114     permission_to_update
115   end
116
117   def maybe_update_modified_by_fields
118     update_modified_by_fields if self.changed?
119   end
120
121   def update_modified_by_fields
122     self.created_at ||= Time.now
123     self.owner_uuid ||= current_default_owner
124     self.modified_at = Time.now
125     self.modified_by_user_uuid = current_user ? current_user.uuid : nil
126     self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
127   end
128
129   def ensure_serialized_attribute_type
130     # Specifying a type in the "serialize" declaration causes rails to
131     # raise an exception if a different data type is retrieved from
132     # the database during load().  The validation preventing such
133     # crash-inducing records from being inserted in the database in
134     # the first place seems to have been left as an exercise to the
135     # developer.
136     self.class.serialized_attributes.each do |colname, attr|
137       if attr.object_class
138         unless self.attributes[colname].is_a? attr.object_class
139           self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}"
140         end
141       end
142     end
143   end
144
145   def self.resource_class_for_uuid(uuid)
146     if uuid.is_a? ArvadosModel
147       return uuid.class
148     end
149     unless uuid.is_a? String
150       return nil
151     end
152     if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/
153       return Collection
154     end
155     resource_class = nil
156
157     Rails.application.eager_load!
158     uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re|
159       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
160         if k.respond_to?(:uuid_prefix)
161           if k.uuid_prefix == re[1]
162             return k
163           end
164         end
165       end
166     end
167     nil
168   end
169
170 end