Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend jobtable #256

Merged
merged 3 commits into from
Nov 20, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ Release notes
-----
*Unreleased*


Added
~~~~~

- Jobs website shortcut to cancel a job using the cancel.json webservice.

Removed
~~~~~~~

Expand Down
174 changes: 122 additions & 52 deletions scrapyd/website.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from datetime import datetime
from datetime import datetime, timedelta

import socket

Expand All @@ -11,6 +11,7 @@

from six.moves.urllib.parse import urlparse


class Root(resource.Resource):

def __init__(self, config, app):
Expand Down Expand Up @@ -97,63 +98,132 @@ def render_GET(self, txrequest):
""" % vars
return s.encode('utf-8')


def microsec_trunc(timelike):
if hasattr(timelike, 'microsecond'):
ms = timelike.microsecond
else:
ms = timelike.microseconds
return timelike - timedelta(microseconds=ms)


class Jobs(resource.Resource):

def __init__(self, root, local_items):
resource.Resource.__init__(self)
self.root = root
self.local_items = local_items

def render(self, txrequest):
cols = 8
s = "<html><head><title>Scrapyd</title></head>"
s += "<body>"
s += "<h1>Jobs</h1>"
s += "<p><a href='..'>Go back</a></p>"
s += "<table border='1'>"
s += "<tr><th>Project</th><th>Spider</th><th>Job</th><th>PID</th><th>Start</th><th>Runtime</th><th>Finish</th><th>Log</th>"
if self.local_items:
s += "<th>Items</th>"
cols = 9
s += "</tr>"
s += "<tr><th colspan='%s' style='background-color: #ddd'>Pending</th></tr>" % cols
for project, queue in self.root.poller.queues.items():
for m in queue.list():
s += "<tr>"
s += "<td>%s</td>" % project
s += "<td>%s</td>" % str(m['name'])
s += "<td>%s</td>" % str(m['_job'])
s += "</tr>"
s += "<tr><th colspan='%s' style='background-color: #ddd'>Running</th></tr>" % cols
for p in self.root.launcher.processes.values():
s += "<tr>"
for a in ['project', 'spider', 'job', 'pid']:
s += "<td>%s</td>" % getattr(p, a)
s += "<td>%s</td>" % p.start_time.replace(microsecond=0)
s += "<td>%s</td>" % (datetime.now().replace(microsecond=0) - p.start_time.replace(microsecond=0))
s += "<td></td>"
s += "<td><a href='/logs/%s/%s/%s.log'>Log</a></td>" % (p.project, p.spider, p.job)
if self.local_items:
s += "<td><a href='/items/%s/%s/%s.jl'>Items</a></td>" % (p.project, p.spider, p.job)
s += "</tr>"
s += "<tr><th colspan='%s' style='background-color: #ddd'>Finished</th></tr>" % cols
for p in self.root.launcher.finished:
s += "<tr>"
for a in ['project', 'spider', 'job']:
s += "<td>%s</td>" % getattr(p, a)
s += "<td></td>"
s += "<td>%s</td>" % p.start_time.replace(microsecond=0)
s += "<td>%s</td>" % (p.end_time.replace(microsecond=0) - p.start_time.replace(microsecond=0))
s += "<td>%s</td>" % p.end_time.replace(microsecond=0)
s += "<td><a href='/logs/%s/%s/%s.log'>Log</a></td>" % (p.project, p.spider, p.job)
if self.local_items:
s += "<td><a href='/items/%s/%s/%s.jl'>Items</a></td>" % (p.project, p.spider, p.job)
s += "</tr>"
s += "</table>"
s += "</body>"
s += "</html>"
cancel_button = """
<form method="post" action="/cancel.json">
<input type="hidden" name="project" value="{project}"/>
<input type="hidden" name="job" value="{jobid}"/>
<input type="submit" style="float: left;" value="Cancel"/>
</form>
""".format

header_cols = [
'Project', 'Spider',
'Job', 'PID',
'Start', 'Runtime', 'Finish',
'Log', 'Items',
'Cancel',
]

def gen_css(self):
css = [
'#jobs>thead td {text-align: center; font-weight: bold}',
'#jobs>tbody>tr:first-child {background-color: #eee}',
]
if not self.local_items:
col_idx = self.header_cols.index('Items') + 1
css.append('#jobs>*>tr>*:nth-child(%d) {display: none}' % col_idx)
if 'cancel.json' not in self.root.children:
col_idx = self.header_cols.index('Cancel') + 1
css.append('#jobs>*>tr>*:nth-child(%d) {display: none}' % col_idx)
return '\n'.join(css)

def prep_row(self, cells):
if not isinstance(cells, dict):
assert len(cells) == len(self.header_cols)
else:
cells = [cells.get(k) for k in self.header_cols]
cells = ['<td>%s</td>' % ('' if c is None else c) for c in cells]
return '<tr>%s</tr>' % ''.join(cells)

def prep_doc(self):
return (
'<html>'
'<head>'
'<title>Scrapyd</title>'
'<style type="text/css">' + self.gen_css() + '</style>'
'</head>'
'<body><h1>Jobs</h1>'
'<p><a href="..">Go back</a></p>'
+ self.prep_table() +
'</body>'
'</html>'
)

def prep_table(self):
return (
'<table id="jobs" border="1">'
'<thead>' + self.prep_row(self.header_cols) + '</thead>'
'<tbody>'
+ '<tr><th colspan="%d">Pending</th></tr>' % len(self.header_cols)
+ self.prep_tab_pending() +
'</tbody>'
'<tbody>'
+ '<tr><th colspan="%d">Running</th></tr>' % len(self.header_cols)
+ self.prep_tab_running() +
'</tbody>'
'<tbody>'
+ '<tr><th colspan="%d">Finished</th></tr>' % len(self.header_cols)
+ self.prep_tab_finished() +
'</tbody>'
'</table>'
)

def prep_tab_pending(self):
return '\n'.join(
self.prep_row(dict(
Project=project, Spider=m['name'], Job=m['_job'],
Cancel=self.cancel_button(project=project, jobid=m['_job'])
))
for project, queue in self.root.poller.queues.items()
for m in queue.list()
)

def prep_tab_running(self):
return '\n'.join(
self.prep_row(dict(
Project=p.project, Spider=p.spider,
Job=p.job, PID=p.pid,
Start=microsec_trunc(p.start_time),
Runtime=microsec_trunc(datetime.now() - p.start_time),
Log='<a href="/logs/%s/%s/%s.log">Log</a>' % (p.project, p.spider, p.job),
Items='<a href="/items/%s/%s/%s.jl">Items</a>' % (p.project, p.spider, p.job),
Cancel=self.cancel_button(project=p.project, jobid=p.job)
))
for p in self.root.launcher.processes.values()
)

def prep_tab_finished(self):
return '\n'.join(
self.prep_row(dict(
Project=p.project, Spider=p.spider,
Job=p.job,
Start=microsec_trunc(p.start_time),
Runtime=microsec_trunc(p.end_time - p.start_time),
Finish=microsec_trunc(p.end_time),
Log='<a href="/logs/%s/%s/%s.log">Log</a>' % (p.project, p.spider, p.job),
Items='<a href="/items/%s/%s/%s.jl">Items</a>' % (p.project, p.spider, p.job),
))
for p in self.root.launcher.finished
)

def render(self, txrequest):
doc = self.prep_doc()
txrequest.setHeader('Content-Type', 'text/html; charset=utf-8')
txrequest.setHeader('Content-Length', len(s))

return s.encode('utf-8')
txrequest.setHeader('Content-Length', len(doc))
return doc.encode('utf-8')