1 # A Job consists of many "Tasks".
2 # A task is the run of an external tool, with proper methods for failure handling
4 from Tools.CList import CList
7 NOT_STARTED, IN_PROGRESS, FINISHED, FAILED = range(4)
8 def __init__(self, name):
10 self.resident_tasks = [ ]
11 self.workspace = "/tmp"
20 self.state_changed = CList()
22 self.status = self.NOT_STARTED
24 # description is a dict
25 def fromDescription(self, description):
28 def createDescription(self):
31 def getProgress(self):
32 if self.current_task == len(self.tasks):
34 t = self.tasks[self.current_task]
35 jobprogress = t.weighting * t.progress / float(t.end) + sum([task.weighting for task in self.tasks[:self.current_task]])
36 return int(jobprogress*self.weightScale)
38 progress = property(getProgress)
40 def getStatustext(self):
41 return { self.NOT_STARTED: _("Waiting"), self.IN_PROGRESS: _("In Progress"), self.FINISHED: _("Finished"), self.FAILED: _("Failed") }[self.status]
43 def task_progress_changed_CB(self):
46 def addTask(self, task):
48 task.task_progress_changed = self.task_progress_changed_CB
49 self.tasks.append(task)
51 def start(self, callback):
52 assert self.callback is None
53 self.callback = callback
57 self.status = self.IN_PROGRESS
60 sumTaskWeightings = sum([t.weighting for t in self.tasks]) or 1
61 self.weightScale = self.end / float(sumTaskWeightings)
64 if self.current_task == len(self.tasks):
65 if len(self.resident_tasks) == 0:
68 self.status = self.FINISHED
72 print "still waiting for %d resident task(s) %s to finish" % (len(self.resident_tasks), str(self.resident_tasks))
74 self.tasks[self.current_task].run(self.taskCallback)
77 def taskCallback(self, task, res, stay_resident = False):
78 cb_idx = self.tasks.index(task)
80 if cb_idx not in self.resident_tasks:
81 self.resident_tasks.append(self.current_task)
82 print "task going resident:", task
84 print "task keeps staying resident:", task
87 print ">>> Error:", res
88 self.status = self.FAILED
90 self.callback(self, task, res)
91 if cb_idx != self.current_task:
92 if cb_idx in self.resident_tasks:
93 print "resident task finished:", task
94 self.resident_tasks.remove(cb_idx)
97 self.current_task += 1
101 assert self.status == self.FAILED
105 if self.current_task < len(self.tasks):
106 self.tasks[self.current_task].abort()
107 for i in self.resident_tasks:
108 self.tasks[i].abort()
111 # some Jobs might have a better idea of how to cancel a job
115 def __init__(self, job, name):
117 self.immediate_preconditions = [ ]
118 self.global_preconditions = [ ]
119 self.postconditions = [ ]
120 self.returncode = None
121 self.initial_input = None
131 self.task_progress_changed = None
132 self.output_line = ""
135 def setCommandline(self, cmd, args):
139 def setTool(self, tool):
142 self.global_preconditions.append(ToolExistsPrecondition())
143 self.postconditions.append(ReturncodePostcondition())
145 def setCmdline(self, cmdline):
146 self.cmdline = cmdline
148 def checkPreconditions(self, immediate = False):
151 preconditions = self.immediate_preconditions
153 preconditions = self.global_preconditions
154 for precondition in preconditions:
155 if not precondition.check(self):
156 not_met.append(precondition)
159 def run(self, callback):
160 failed_preconditions = self.checkPreconditions(True) + self.checkPreconditions(False)
161 if len(failed_preconditions):
162 callback(self, failed_preconditions)
166 self.callback = callback
167 from enigma import eConsoleAppContainer
168 self.container = eConsoleAppContainer()
169 self.container.appClosed.append(self.processFinished)
170 self.container.stdoutAvail.append(self.processStdout)
171 self.container.stderrAvail.append(self.processStderr)
173 if self.cwd is not None:
174 self.container.setCWD(self.cwd)
176 if not self.cmd and self.cmdline:
177 print "execute:", self.container.execute(self.cmdline), self.cmdline
179 assert self.cmd is not None
180 assert len(self.args) >= 1
181 print "execute:", self.container.execute(self.cmd, *self.args), ' '.join(self.args)
182 if self.initial_input:
183 self.writeInput(self.initial_input)
188 def cleanup(self, failed):
191 def processStdout(self, data):
192 self.processOutput(data)
194 def processStderr(self, data):
195 self.processOutput(data)
197 def processOutput(self, data):
198 self.output_line += data
200 i = self.output_line.find('\n')
203 self.processOutputLine(self.output_line[:i+1])
204 self.output_line = self.output_line[i+1:]
206 def processOutputLine(self, line):
209 def processFinished(self, returncode):
210 self.returncode = returncode
214 self.container.kill()
215 self.finish(aborted = True)
217 def finish(self, aborted = False):
221 not_met.append(AbortedPostcondition())
223 for postcondition in self.postconditions:
224 if not postcondition.check(self):
225 not_met.append(postcondition)
226 self.cleanup(not_met)
227 self.callback(self, not_met)
232 def writeInput(self, input):
233 self.container.write(input)
235 def getProgress(self):
236 return self.__progress
238 def setProgress(self, progress):
239 if progress > self.end:
243 self.__progress = progress
244 if self.task_progress_changed:
245 self.task_progress_changed()
247 progress = property(getProgress, setProgress)
249 # The jobmanager will execute multiple jobs, each after another.
250 # later, it will also support suspending jobs (and continuing them after reboot etc)
251 # It also supports a notification when some error occured, and possibly a retry.
254 self.active_jobs = [ ]
255 self.failed_jobs = [ ]
256 self.job_classes = [ ]
257 self.in_background = False
258 self.active_job = None
260 def AddJob(self, job):
261 self.active_jobs.append(job)
265 if self.active_job is None:
266 if len(self.active_jobs):
267 self.active_job = self.active_jobs.pop(0)
268 self.active_job.start(self.jobDone)
270 def jobDone(self, job, task, problems):
271 print "job", job, "completed with", problems, "in", task
272 from Tools import Notifications
273 if self.in_background:
274 from Screens.TaskView import JobView
275 self.in_background = False
276 Notifications.AddNotification(JobView, self.active_job)
278 from Screens.MessageBox import MessageBox
279 if problems[0].RECOVERABLE:
280 Notifications.AddNotificationWithCallback(self.errorCB, MessageBox, _("Error: %s\nRetry?") % (problems[0].getErrorMessage(task)))
282 Notifications.AddNotification(MessageBox, _("Error") + (': %s') % (problems[0].getErrorMessage(task)), type = MessageBox.TYPE_ERROR )
285 #self.failed_jobs.append(self.active_job)
287 self.active_job = None
290 def errorCB(self, answer):
293 self.active_job.retry()
295 print "not retrying job."
296 self.failed_jobs.append(self.active_job)
297 self.active_job = None
300 def getPendingJobs(self):
303 list.append(self.active_job)
304 list += self.active_jobs
307 #class PartitionExistsPostcondition:
308 # def __init__(self, device):
309 # self.device = device
311 # def check(self, task):
313 # return os.access(self.device + "part1", os.F_OK)
315 #class CreatePartitionTask(Task):
316 # def __init__(self, device):
317 # Task.__init__(self, _("Create Partition"))
318 # self.device = device
319 # self.setTool("/sbin/sfdisk")
320 # self.args += ["-f", self.device + "disc"]
321 # self.initial_input = "0,\n;\n;\n;\ny\n"
322 # self.postconditions.append(PartitionExistsPostcondition(self.device))
324 #class CreateFilesystemTask(Task):
325 # def __init__(self, device, partition = 1, largefile = True):
326 # Task.__init__(self, _("Create Filesystem"))
327 # self.setTool("/sbin/mkfs.ext")
329 # self.args += ["-T", "largefile"]
330 # self.args.append("-m0")
331 # self.args.append(device + "part%d" % partition)
333 #class FilesystemMountTask(Task):
334 # def __init__(self, device, partition = 1, filesystem = "ext3"):
335 # Task.__init__(self, _("Mounting Filesystem"))
336 # self.setTool("/bin/mount")
337 # if filesystem is not None:
338 # self.args += ["-t", filesystem]
339 # self.args.append(device + "part%d" % partition)
344 def getErrorMessage(self, task):
345 return _("An unknown error occured!") + " (%s @ task %s)" % (self.__class__.__name__, task.__class__.__name__)
347 class WorkspaceExistsPrecondition(Condition):
348 def check(self, task):
349 return os.access(task.job.workspace, os.W_OK)
351 class DiskspacePrecondition(Condition):
352 def __init__(self, diskspace_required):
353 self.diskspace_required = diskspace_required
354 self.diskspace_available = 0
356 def check(self, task):
359 s = os.statvfs(task.job.workspace)
360 self.diskspace_available = s.f_bsize * s.f_bavail
361 return self.diskspace_available >= self.diskspace_required
365 def getErrorMessage(self, task):
366 return _("Not enough diskspace. Please free up some diskspace and try again. (%d MB required, %d MB available)") % (self.diskspace_required / 1024 / 1024, self.diskspace_available / 1024 / 1024)
368 class ToolExistsPrecondition(Condition):
369 def check(self, task):
374 realpath = task.cwd + '/' + task.cmd
375 self.realpath = realpath
376 return os.access(realpath, os.X_OK)
378 def getErrorMessage(self, task):
379 return _("A required tool (%s) was not found.") % (self.realpath)
381 class AbortedPostcondition(Condition):
382 def getErrorMessage(self, task):
383 return "Cancelled upon user request"
385 class ReturncodePostcondition(Condition):
386 def check(self, task):
387 return task.returncode == 0
389 #class HDDInitJob(Job):
390 # def __init__(self, device):
391 # Job.__init__(self, _("Initialize Harddisk"))
392 # self.device = device
393 # self.fromDescription(self.createDescription())
395 # def fromDescription(self, description):
396 # self.device = description["device"]
397 # self.addTask(CreatePartitionTask(self.device))
398 # self.addTask(CreateFilesystemTask(self.device))
399 # self.addTask(FilesystemMountTask(self.device))
401 # def createDescription(self):
402 # return {"device": self.device}
404 job_manager = JobManager()