add a bunch of API pages
[arvados.git] / app / models / job.rb
1 class Job < OrvosModel
2   include AssignUuid
3   include KindAndEtag
4   include CommonApiTemplate
5   serialize :script_parameters, Hash
6   serialize :resource_limits, Hash
7   serialize :tasks_summary, Hash
8   before_create :ensure_unique_submit_id
9   before_create :ensure_script_version_is_commit
10
11   has_many :commit_ancestors, :foreign_key => :descendant, :primary_key => :script_version
12
13   class SubmitIdReused < StandardError
14   end
15
16   api_accessible :superuser, :extend => :common do |t|
17     t.add :submit_id
18     t.add :priority
19     t.add :script
20     t.add :script_parameters
21     t.add :script_version
22     t.add :cancelled_at
23     t.add :cancelled_by_client
24     t.add :cancelled_by_user
25     t.add :started_at
26     t.add :finished_at
27     t.add :output
28     t.add :success
29     t.add :running
30     t.add :is_locked_by
31     t.add :log
32     t.add :resource_limits
33     t.add :tasks_summary
34     t.add :dependencies
35   end
36
37   def assert_finished
38     update_attributes(finished_at: finished_at || Time.now,
39                       success: success.nil? ? false : success,
40                       running: false)
41   end
42
43   protected
44
45   def ensure_script_version_is_commit
46     sha1 = Commit.find_by_commit_ish(self.script_version) rescue nil
47     if sha1
48       self.script_version = sha1
49     else
50       raise ArgumentError.new("Specified script_version does not resolve to a commit")
51     end
52   end
53
54   def ensure_unique_submit_id
55     if !submit_id.nil?
56       if Job.where('submit_id=?',self.submit_id).first
57         raise SubmitIdReused.new
58       end
59     end
60     true
61   end
62
63   def dependencies
64     deps = {}
65     self.script_parameters.values.each do |v|
66       next unless v.is_a? String
67       v.match(/^(([0-9a-f]{32})\b(\+[^,]+)?,?)*$/) do |locator|
68         bare_locator = locator[0].gsub(/\+[^,]+/,'')
69         deps[bare_locator] = true
70       end
71     end
72     deps.keys
73   end
74
75   def permission_to_update
76     if is_locked_by_was and !(current_user and
77                               current_user.uuid == is_locked_by_was)
78       if script_changed? or
79           script_parameters_changed? or
80           script_version_changed? or
81           cancelled_by_client_changed? or
82           cancelled_by_user_changed? or
83           cancelled_at_changed? or
84           started_at_changed? or
85           finished_at_changed? or
86           running_changed? or
87           success_changed? or
88           output_changed? or
89           log_changed? or
90           tasks_summary_changed?
91         logger.warn "User #{current_user.uuid if current_user} tried to change protected job attributes on locked #{self.class.to_s} #{uuid_was}"
92         return false
93       end
94     end
95     if !is_locked_by_changed?
96       super
97     else
98       if !current_user
99         logger.warn "Anonymous user tried to change lock on #{self.class.to_s} #{uuid_was}"
100         false
101       elsif is_locked_by_was and is_locked_by_was != current_user.uuid
102         logger.warn "User #{current_user.uuid} tried to steal lock on #{self.class.to_s} #{uuid_was} from #{is_locked_by_was}"
103         false
104       elsif !is_locked_by.nil? and is_locked_by != current_user.uuid
105         logger.warn "User #{current_user.uuid} tried to lock #{self.class.to_s} #{uuid_was} with uuid #{is_locked_by}"
106         false
107       else
108         super
109       end
110     end
111   end
112 end