]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - src/allmydata/web/status.py
web/status.py: minor renaming to hush pyflakes
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / web / status.py
1
2 import pprint, itertools
3 import simplejson
4 from twisted.internet import defer
5 from nevow import rend, inevow, tags as T
6 from allmydata.util import base32, idlib
7 from allmydata.web.common import getxmlfile, get_arg, \
8      abbreviate_time, abbreviate_rate, abbreviate_size, plural, compute_rate, render_time
9 from allmydata.interfaces import IUploadStatus, IDownloadStatus, \
10      IPublishStatus, IRetrieveStatus, IServermapUpdaterStatus
11
12 class RateAndTimeMixin:
13
14     def render_time(self, ctx, data):
15         return abbreviate_time(data)
16
17     def render_rate(self, ctx, data):
18         return abbreviate_rate(data)
19
20 class UploadResultsRendererMixin(RateAndTimeMixin):
21     # this requires a method named 'upload_results'
22
23     def render_pushed_shares(self, ctx, data):
24         d = self.upload_results()
25         d.addCallback(lambda res: res.get_pushed_shares())
26         return d
27
28     def render_preexisting_shares(self, ctx, data):
29         d = self.upload_results()
30         d.addCallback(lambda res: res.get_preexisting_shares())
31         return d
32
33     def render_sharemap(self, ctx, data):
34         d = self.upload_results()
35         d.addCallback(lambda res: res.get_sharemap())
36         def _render(sharemap):
37             if sharemap is None:
38                 return "None"
39             l = T.ul()
40             for shnum, servers in sorted(sharemap.items()):
41                 server_names = ', '.join([s.get_name() for s in servers])
42                 l[T.li["%d -> placed on [%s]" % (shnum, server_names)]]
43             return l
44         d.addCallback(_render)
45         return d
46
47     def render_servermap(self, ctx, data):
48         d = self.upload_results()
49         d.addCallback(lambda res: res.get_servermap())
50         def _render(servermap):
51             if servermap is None:
52                 return "None"
53             l = T.ul()
54             for server, shnums in sorted(servermap.items()):
55                 shares_s = ",".join(["#%d" % shnum for shnum in shnums])
56                 l[T.li["[%s] got share%s: %s" % (server.get_name(),
57                                                  plural(shnums), shares_s)]]
58             return l
59         d.addCallback(_render)
60         return d
61
62     def data_file_size(self, ctx, data):
63         d = self.upload_results()
64         d.addCallback(lambda res: res.get_file_size())
65         return d
66
67     def _get_time(self, name):
68         d = self.upload_results()
69         d.addCallback(lambda res: res.get_timings().get(name))
70         return d
71
72     def data_time_total(self, ctx, data):
73         return self._get_time("total")
74
75     def data_time_storage_index(self, ctx, data):
76         return self._get_time("storage_index")
77
78     def data_time_contacting_helper(self, ctx, data):
79         return self._get_time("contacting_helper")
80
81     def data_time_cumulative_fetch(self, ctx, data):
82         return self._get_time("cumulative_fetch")
83
84     def data_time_helper_total(self, ctx, data):
85         return self._get_time("helper_total")
86
87     def data_time_peer_selection(self, ctx, data):
88         return self._get_time("peer_selection")
89
90     def data_time_total_encode_and_push(self, ctx, data):
91         return self._get_time("total_encode_and_push")
92
93     def data_time_cumulative_encoding(self, ctx, data):
94         return self._get_time("cumulative_encoding")
95
96     def data_time_cumulative_sending(self, ctx, data):
97         return self._get_time("cumulative_sending")
98
99     def data_time_hashes_and_close(self, ctx, data):
100         return self._get_time("hashes_and_close")
101
102     def _get_rate(self, name):
103         d = self.upload_results()
104         def _convert(r):
105             file_size = r.get_file_size()
106             duration = r.get_timings().get(name)
107             return compute_rate(file_size, duration)
108         d.addCallback(_convert)
109         return d
110
111     def data_rate_total(self, ctx, data):
112         return self._get_rate("total")
113
114     def data_rate_storage_index(self, ctx, data):
115         return self._get_rate("storage_index")
116
117     def data_rate_encode(self, ctx, data):
118         return self._get_rate("cumulative_encoding")
119
120     def data_rate_push(self, ctx, data):
121         return self._get_rate("cumulative_sending")
122
123     def data_rate_encode_and_push(self, ctx, data):
124         d = self.upload_results()
125         def _convert(r):
126             file_size = r.get_file_size()
127             time1 = r.get_timings().get("cumulative_encoding")
128             time2 = r.get_timings().get("cumulative_sending")
129             if (time1 is None or time2 is None):
130                 return None
131             else:
132                 return compute_rate(file_size, time1+time2)
133         d.addCallback(_convert)
134         return d
135
136     def data_rate_ciphertext_fetch(self, ctx, data):
137         d = self.upload_results()
138         def _convert(r):
139             fetch_size = r.get_ciphertext_fetched()
140             duration = r.get_timings().get("cumulative_fetch")
141             return compute_rate(fetch_size, duration)
142         d.addCallback(_convert)
143         return d
144
145 class UploadStatusPage(UploadResultsRendererMixin, rend.Page):
146     docFactory = getxmlfile("upload-status.xhtml")
147
148     def __init__(self, data):
149         rend.Page.__init__(self, data)
150         self.upload_status = data
151
152     def upload_results(self):
153         return defer.maybeDeferred(self.upload_status.get_results)
154
155     def render_results(self, ctx, data):
156         d = self.upload_results()
157         def _got_results(results):
158             if results:
159                 return ctx.tag
160             return ""
161         d.addCallback(_got_results)
162         return d
163
164     def render_started(self, ctx, data):
165         started_s = render_time(data.get_started())
166         return started_s
167
168     def render_si(self, ctx, data):
169         si_s = base32.b2a_or_none(data.get_storage_index())
170         if si_s is None:
171             si_s = "(None)"
172         return si_s
173
174     def render_helper(self, ctx, data):
175         return {True: "Yes",
176                 False: "No"}[data.using_helper()]
177
178     def render_total_size(self, ctx, data):
179         size = data.get_size()
180         if size is None:
181             return "(unknown)"
182         return size
183
184     def render_progress_hash(self, ctx, data):
185         progress = data.get_progress()[0]
186         # TODO: make an ascii-art bar
187         return "%.1f%%" % (100.0 * progress)
188
189     def render_progress_ciphertext(self, ctx, data):
190         progress = data.get_progress()[1]
191         # TODO: make an ascii-art bar
192         return "%.1f%%" % (100.0 * progress)
193
194     def render_progress_encode_push(self, ctx, data):
195         progress = data.get_progress()[2]
196         # TODO: make an ascii-art bar
197         return "%.1f%%" % (100.0 * progress)
198
199     def render_status(self, ctx, data):
200         return data.get_status()
201
202 class DownloadResultsRendererMixin(RateAndTimeMixin):
203     # this requires a method named 'download_results'
204
205     def render_servermap(self, ctx, data):
206         d = self.download_results()
207         d.addCallback(lambda res: res.servermap)
208         def _render(servermap):
209             if servermap is None:
210                 return "None"
211             l = T.ul()
212             for peerid in sorted(servermap.keys()):
213                 peerid_s = idlib.shortnodeid_b2a(peerid)
214                 shares_s = ",".join(["#%d" % shnum
215                                      for shnum in servermap[peerid]])
216                 l[T.li["[%s] has share%s: %s" % (peerid_s,
217                                                  plural(servermap[peerid]),
218                                                  shares_s)]]
219             return l
220         d.addCallback(_render)
221         return d
222
223     def render_servers_used(self, ctx, data):
224         d = self.download_results()
225         d.addCallback(lambda res: res.servers_used)
226         def _got(servers_used):
227             if not servers_used:
228                 return ""
229             peerids_s = ", ".join(["[%s]" % idlib.shortnodeid_b2a(peerid)
230                                    for peerid in servers_used])
231             return T.li["Servers Used: ", peerids_s]
232         d.addCallback(_got)
233         return d
234
235     def render_problems(self, ctx, data):
236         d = self.download_results()
237         d.addCallback(lambda res: res.server_problems)
238         def _got(server_problems):
239             if not server_problems:
240                 return ""
241             l = T.ul()
242             for peerid in sorted(server_problems.keys()):
243                 peerid_s = idlib.shortnodeid_b2a(peerid)
244                 l[T.li["[%s]: %s" % (peerid_s, server_problems[peerid])]]
245             return T.li["Server Problems:", l]
246         d.addCallback(_got)
247         return d
248
249     def data_file_size(self, ctx, data):
250         d = self.download_results()
251         d.addCallback(lambda res: res.file_size)
252         return d
253
254     def _get_time(self, name):
255         d = self.download_results()
256         d.addCallback(lambda res: res.timings.get(name))
257         return d
258
259     def data_time_total(self, ctx, data):
260         return self._get_time("total")
261
262     def data_time_peer_selection(self, ctx, data):
263         return self._get_time("peer_selection")
264
265     def data_time_uri_extension(self, ctx, data):
266         return self._get_time("uri_extension")
267
268     def data_time_hashtrees(self, ctx, data):
269         return self._get_time("hashtrees")
270
271     def data_time_segments(self, ctx, data):
272         return self._get_time("segments")
273
274     def data_time_cumulative_fetch(self, ctx, data):
275         return self._get_time("cumulative_fetch")
276
277     def data_time_cumulative_decode(self, ctx, data):
278         return self._get_time("cumulative_decode")
279
280     def data_time_cumulative_decrypt(self, ctx, data):
281         return self._get_time("cumulative_decrypt")
282
283     def data_time_paused(self, ctx, data):
284         return self._get_time("paused")
285
286     def _get_rate(self, name):
287         d = self.download_results()
288         def _convert(r):
289             file_size = r.file_size
290             duration = r.timings.get(name)
291             return compute_rate(file_size, duration)
292         d.addCallback(_convert)
293         return d
294
295     def data_rate_total(self, ctx, data):
296         return self._get_rate("total")
297
298     def data_rate_segments(self, ctx, data):
299         return self._get_rate("segments")
300
301     def data_rate_fetch(self, ctx, data):
302         return self._get_rate("cumulative_fetch")
303
304     def data_rate_decode(self, ctx, data):
305         return self._get_rate("cumulative_decode")
306
307     def data_rate_decrypt(self, ctx, data):
308         return self._get_rate("cumulative_decrypt")
309
310     def render_server_timings(self, ctx, data):
311         d = self.download_results()
312         d.addCallback(lambda res: res.timings.get("fetch_per_server"))
313         def _render(per_server):
314             if per_server is None:
315                 return ""
316             l = T.ul()
317             for peerid in sorted(per_server.keys()):
318                 peerid_s = idlib.shortnodeid_b2a(peerid)
319                 times_s = ", ".join([self.render_time(None, t)
320                                      for t in per_server[peerid]])
321                 l[T.li["[%s]: %s" % (peerid_s, times_s)]]
322             return T.li["Per-Server Segment Fetch Response Times: ", l]
323         d.addCallback(_render)
324         return d
325
326 class DownloadStatusPage(DownloadResultsRendererMixin, rend.Page):
327     docFactory = getxmlfile("download-status.xhtml")
328
329     def __init__(self, data):
330         rend.Page.__init__(self, data)
331         self.download_status = data
332
333     def child_timeline(self, ctx):
334         return DownloadStatusTimelinePage(self.download_status)
335
336     def download_results(self):
337         return defer.maybeDeferred(self.download_status.get_results)
338
339     def relative_time(self, t):
340         if t is None:
341             return t
342         if self.download_status.first_timestamp is not None:
343             return t - self.download_status.first_timestamp
344         return t
345     def short_relative_time(self, t):
346         t = self.relative_time(t)
347         if t is None:
348             return ""
349         return "+%.6fs" % t
350
351     def _find_overlap(self, events, start_key, end_key):
352         # given a list of event dicts, return a new list in which each event
353         # has an extra "row" key (an int, starting at 0), and if appropriate
354         # a "serverid" key (ascii-encoded server id), replacing the "server"
355         # key. This is a hint to our JS frontend about how to overlap the
356         # parts of the graph it is drawing.
357
358         # we must always make a copy, since we're going to be adding keys
359         # and don't want to change the original objects. If we're
360         # stringifying serverids, we'll also be changing the serverid keys.
361         new_events = []
362         rows = []
363         for ev in events:
364             ev = ev.copy()
365             if ev.has_key('server'):
366                 ev["serverid"] = ev["server"].get_longname()
367                 del ev["server"]
368             # find an empty slot in the rows
369             free_slot = None
370             for row,finished in enumerate(rows):
371                 if finished is not None:
372                     if ev[start_key] > finished:
373                         free_slot = row
374                         break
375             if free_slot is None:
376                 free_slot = len(rows)
377                 rows.append(ev[end_key])
378             else:
379                 rows[free_slot] = ev[end_key]
380             ev["row"] = free_slot
381             new_events.append(ev)
382         return new_events
383
384     def _find_overlap_requests(self, events):
385         """We compute a three-element 'row tuple' for each event: (serverid,
386         shnum, row). All elements are ints. The first is a mapping from
387         serverid to group number, the second is a mapping from shnum to
388         subgroup number. The third is a row within the subgroup.
389
390         We also return a list of lists of rowcounts, so renderers can decide
391         how much vertical space to give to each row.
392         """
393
394         serverid_to_group = {}
395         groupnum_to_rows = {} # maps groupnum to a table of rows. Each table
396                               # is a list with an element for each row number
397                               # (int starting from 0) that contains a
398                               # finish_time, indicating that the row is empty
399                               # beyond that time. If finish_time is None, it
400                               # indicate a response that has not yet
401                               # completed, so the row cannot be reused.
402         new_events = []
403         for ev in events:
404             # DownloadStatus promises to give us events in temporal order
405             ev = ev.copy()
406             ev["serverid"] = ev["server"].get_longname()
407             del ev["server"]
408             if ev["serverid"] not in serverid_to_group:
409                 groupnum = len(serverid_to_group)
410                 serverid_to_group[ev["serverid"]] = groupnum
411             groupnum = serverid_to_group[ev["serverid"]]
412             if groupnum not in groupnum_to_rows:
413                 groupnum_to_rows[groupnum] = []
414             rows = groupnum_to_rows[groupnum]
415             # find an empty slot in the rows
416             free_slot = None
417             for row,finished in enumerate(rows):
418                 if finished is not None:
419                     if ev["start_time"] > finished:
420                         free_slot = row
421                         break
422             if free_slot is None:
423                 free_slot = len(rows)
424                 rows.append(ev["finish_time"])
425             else:
426                 rows[free_slot] = ev["finish_time"]
427             ev["row"] = (groupnum, free_slot)
428             new_events.append(ev)
429         del groupnum
430         # maybe also return serverid_to_group, groupnum_to_rows, and some
431         # indication of the highest finish_time
432         #
433         # actually, return the highest rownum for each groupnum
434         highest_rownums = [len(groupnum_to_rows[groupnum])
435                            for groupnum in range(len(serverid_to_group))]
436         return new_events, highest_rownums
437
438     def child_event_json(self, ctx):
439         inevow.IRequest(ctx).setHeader("content-type", "text/plain")
440         data = { } # this will be returned to the GET
441         ds = self.download_status
442
443         data["misc"] = self._find_overlap(ds.misc_events,
444                                           "start_time", "finish_time")
445         data["read"] = self._find_overlap(ds.read_events,
446                                           "start_time", "finish_time")
447         data["segment"] = self._find_overlap(ds.segment_events,
448                                              "start_time", "finish_time")
449         # TODO: overlap on DYHB isn't very useful, and usually gets in the
450         # way. So don't do it.
451         data["dyhb"] = self._find_overlap(ds.dyhb_requests,
452                                           "start_time", "finish_time")
453         data["block"],data["block_rownums"] = self._find_overlap_requests(ds.block_requests)
454
455         server_info = {} # maps longname to {num,color,short}
456         server_shortnames = {} # maps servernum to shortname
457         for d_ev in ds.dyhb_requests:
458             s = d_ev["server"]
459             longname = s.get_longname()
460             if longname not in server_info:
461                 num = len(server_info)
462                 server_info[longname] = {"num": num,
463                                          "color": self.color(s),
464                                          "short": s.get_name() }
465                 server_shortnames[str(num)] = s.get_name()
466
467         data["server_info"] = server_info
468         data["num_serverids"] = len(server_info)
469         # we'd prefer the keys of serverids[] to be ints, but this is JSON,
470         # so they get converted to strings. Stupid javascript.
471         data["serverids"] = server_shortnames
472         data["bounds"] = {"min": ds.first_timestamp, "max": ds.last_timestamp}
473         return simplejson.dumps(data, indent=1) + "\n"
474
475     def render_timeline_link(self, ctx, data):
476         from nevow import url
477         return T.a(href=url.URL.fromContext(ctx).child("timeline"))["timeline"]
478
479     def _rate_and_time(self, bytes, seconds):
480         time_s = self.render_time(None, seconds)
481         if seconds != 0:
482             rate = self.render_rate(None, 1.0 * bytes / seconds)
483             return T.span(title=rate)[time_s]
484         return T.span[time_s]
485
486     def render_events(self, ctx, data):
487         if not self.download_status.storage_index:
488             return
489         srt = self.short_relative_time
490         l = T.div()
491
492         t = T.table(align="left", class_="status-download-events")
493         t[T.tr[T.th["serverid"], T.th["sent"], T.th["received"],
494                T.th["shnums"], T.th["RTT"]]]
495         for d_ev in self.download_status.dyhb_requests:
496             server = d_ev["server"]
497             sent = d_ev["start_time"]
498             shnums = d_ev["response_shnums"]
499             received = d_ev["finish_time"]
500             rtt = None
501             if received is not None:
502                 rtt = received - sent
503             if not shnums:
504                 shnums = ["-"]
505             t[T.tr(style="background: %s" % self.color(server))[
506                 [T.td[server.get_name()], T.td[srt(sent)], T.td[srt(received)],
507                  T.td[",".join([str(shnum) for shnum in shnums])],
508                  T.td[self.render_time(None, rtt)],
509                  ]]]
510
511         l[T.h2["DYHB Requests:"], t]
512         l[T.br(clear="all")]
513
514         t = T.table(align="left",class_="status-download-events")
515         t[T.tr[T.th["range"], T.th["start"], T.th["finish"], T.th["got"],
516                T.th["time"], T.th["decrypttime"], T.th["pausedtime"],
517                T.th["speed"]]]
518         for r_ev in self.download_status.read_events:
519             start = r_ev["start"]
520             length = r_ev["length"]
521             bytes = r_ev["bytes_returned"]
522             decrypt_time = ""
523             if bytes:
524                 decrypt_time = self._rate_and_time(bytes, r_ev["decrypt_time"])
525             speed, rtt = "",""
526             if r_ev["finish_time"] is not None:
527                 rtt = r_ev["finish_time"] - r_ev["start_time"] - r_ev["paused_time"]
528                 speed = self.render_rate(None, compute_rate(bytes, rtt))
529                 rtt = self.render_time(None, rtt)
530             paused = self.render_time(None, r_ev["paused_time"])
531
532             t[T.tr[T.td["[%d:+%d]" % (start, length)],
533                    T.td[srt(r_ev["start_time"])], T.td[srt(r_ev["finish_time"])],
534                    T.td[bytes], T.td[rtt],
535                    T.td[decrypt_time], T.td[paused],
536                    T.td[speed],
537                    ]]
538
539         l[T.h2["Read Events:"], t]
540         l[T.br(clear="all")]
541
542         t = T.table(align="left",class_="status-download-events")
543         t[T.tr[T.th["segnum"], T.th["start"], T.th["active"], T.th["finish"],
544                T.th["range"],
545                T.th["decodetime"], T.th["segtime"], T.th["speed"]]]
546         for s_ev in self.download_status.segment_events:
547             range_s = "-"
548             segtime_s = "-"
549             speed = "-"
550             decode_time = "-"
551             if s_ev["finish_time"] is not None:
552                 if s_ev["success"]:
553                     segtime = s_ev["finish_time"] - s_ev["active_time"]
554                     segtime_s = self.render_time(None, segtime)
555                     seglen = s_ev["segment_length"]
556                     range_s = "[%d:+%d]" % (s_ev["segment_start"], seglen)
557                     speed = self.render_rate(None, compute_rate(seglen, segtime))
558                     decode_time = self._rate_and_time(seglen, s_ev["decode_time"])
559                 else:
560                     # error
561                     range_s = "error"
562             else:
563                 # not finished yet
564                 pass
565
566             t[T.tr[T.td["seg%d" % s_ev["segment_number"]],
567                    T.td[srt(s_ev["start_time"])],
568                    T.td[srt(s_ev["active_time"])],
569                    T.td[srt(s_ev["finish_time"])],
570                    T.td[range_s],
571                    T.td[decode_time],
572                    T.td[segtime_s], T.td[speed]]]
573
574         l[T.h2["Segment Events:"], t]
575         l[T.br(clear="all")]
576         t = T.table(align="left",class_="status-download-events")
577         t[T.tr[T.th["serverid"], T.th["shnum"], T.th["range"],
578                T.th["txtime"], T.th["rxtime"],
579                T.th["received"], T.th["RTT"]]]
580         for r_ev in self.download_status.block_requests:
581             server = r_ev["server"]
582             rtt = None
583             if r_ev["finish_time"] is not None:
584                 rtt = r_ev["finish_time"] - r_ev["start_time"]
585             color = self.color(server)
586             t[T.tr(style="background: %s" % color)[
587                 T.td[server.get_name()], T.td[r_ev["shnum"]],
588                 T.td["[%d:+%d]" % (r_ev["start"], r_ev["length"])],
589                 T.td[srt(r_ev["start_time"])], T.td[srt(r_ev["finish_time"])],
590                 T.td[r_ev["response_length"] or ""],
591                 T.td[self.render_time(None, rtt)],
592                 ]]
593
594         l[T.h2["Requests:"], t]
595         l[T.br(clear="all")]
596
597         return l
598
599     def color(self, server):
600         peerid = server.get_serverid() # binary
601         def m(c):
602             return min(ord(c) / 2 + 0x80, 0xff)
603         return "#%02x%02x%02x" % (m(peerid[0]), m(peerid[1]), m(peerid[2]))
604
605     def render_results(self, ctx, data):
606         d = self.download_results()
607         def _got_results(results):
608             if results:
609                 return ctx.tag
610             return ""
611         d.addCallback(_got_results)
612         return d
613
614     def render_started(self, ctx, data):
615         started_s = render_time(data.get_started())
616         return started_s + " (%s)" % data.get_started()
617
618     def render_si(self, ctx, data):
619         si_s = base32.b2a_or_none(data.get_storage_index())
620         if si_s is None:
621             si_s = "(None)"
622         return si_s
623
624     def render_helper(self, ctx, data):
625         return {True: "Yes",
626                 False: "No"}[data.using_helper()]
627
628     def render_total_size(self, ctx, data):
629         size = data.get_size()
630         if size is None:
631             return "(unknown)"
632         return size
633
634     def render_progress(self, ctx, data):
635         progress = data.get_progress()
636         # TODO: make an ascii-art bar
637         return "%.1f%%" % (100.0 * progress)
638
639     def render_status(self, ctx, data):
640         return data.get_status()
641
642 class DownloadStatusTimelinePage(rend.Page):
643     docFactory = getxmlfile("download-status-timeline.xhtml")
644
645     def render_started(self, ctx, data):
646         started_s = render_time(data.get_started())
647         return started_s + " (%s)" % data.get_started()
648
649     def render_si(self, ctx, data):
650         si_s = base32.b2a_or_none(data.get_storage_index())
651         if si_s is None:
652             si_s = "(None)"
653         return si_s
654
655     def render_helper(self, ctx, data):
656         return {True: "Yes",
657                 False: "No"}[data.using_helper()]
658
659     def render_total_size(self, ctx, data):
660         size = data.get_size()
661         if size is None:
662             return "(unknown)"
663         return size
664
665     def render_progress(self, ctx, data):
666         progress = data.get_progress()
667         # TODO: make an ascii-art bar
668         return "%.1f%%" % (100.0 * progress)
669
670     def render_status(self, ctx, data):
671         return data.get_status()
672
673 class RetrieveStatusPage(rend.Page, RateAndTimeMixin):
674     docFactory = getxmlfile("retrieve-status.xhtml")
675
676     def __init__(self, data):
677         rend.Page.__init__(self, data)
678         self.retrieve_status = data
679
680     def render_started(self, ctx, data):
681         started_s = render_time(data.get_started())
682         return started_s
683
684     def render_si(self, ctx, data):
685         si_s = base32.b2a_or_none(data.get_storage_index())
686         if si_s is None:
687             si_s = "(None)"
688         return si_s
689
690     def render_helper(self, ctx, data):
691         return {True: "Yes",
692                 False: "No"}[data.using_helper()]
693
694     def render_current_size(self, ctx, data):
695         size = data.get_size()
696         if size is None:
697             size = "(unknown)"
698         return size
699
700     def render_progress(self, ctx, data):
701         progress = data.get_progress()
702         # TODO: make an ascii-art bar
703         return "%.1f%%" % (100.0 * progress)
704
705     def render_status(self, ctx, data):
706         return data.get_status()
707
708     def render_encoding(self, ctx, data):
709         k, n = data.get_encoding()
710         return ctx.tag["Encoding: %s of %s" % (k, n)]
711
712     def render_problems(self, ctx, data):
713         problems = data.get_problems()
714         if not problems:
715             return ""
716         l = T.ul()
717         for peerid in sorted(problems.keys()):
718             peerid_s = idlib.shortnodeid_b2a(peerid)
719             l[T.li["[%s]: %s" % (peerid_s, problems[peerid])]]
720         return ctx.tag["Server Problems:", l]
721
722     def _get_rate(self, data, name):
723         file_size = self.retrieve_status.get_size()
724         duration = self.retrieve_status.timings.get(name)
725         return compute_rate(file_size, duration)
726
727     def data_time_total(self, ctx, data):
728         return self.retrieve_status.timings.get("total")
729     def data_rate_total(self, ctx, data):
730         return self._get_rate(data, "total")
731
732     def data_time_fetch(self, ctx, data):
733         return self.retrieve_status.timings.get("fetch")
734     def data_rate_fetch(self, ctx, data):
735         return self._get_rate(data, "fetch")
736
737     def data_time_decode(self, ctx, data):
738         return self.retrieve_status.timings.get("decode")
739     def data_rate_decode(self, ctx, data):
740         return self._get_rate(data, "decode")
741
742     def data_time_decrypt(self, ctx, data):
743         return self.retrieve_status.timings.get("decrypt")
744     def data_rate_decrypt(self, ctx, data):
745         return self._get_rate(data, "decrypt")
746
747     def render_server_timings(self, ctx, data):
748         per_server = self.retrieve_status.timings.get("fetch_per_server")
749         if not per_server:
750             return ""
751         l = T.ul()
752         for server in sorted(per_server.keys(), key=lambda s: s.get_name()):
753             times_s = ", ".join([self.render_time(None, t)
754                                  for t in per_server[server]])
755             l[T.li["[%s]: %s" % (server.get_name(), times_s)]]
756         return T.li["Per-Server Fetch Response Times: ", l]
757
758
759 class PublishStatusPage(rend.Page, RateAndTimeMixin):
760     docFactory = getxmlfile("publish-status.xhtml")
761
762     def __init__(self, data):
763         rend.Page.__init__(self, data)
764         self.publish_status = data
765
766     def render_started(self, ctx, data):
767         started_s = render_time(data.get_started())
768         return started_s
769
770     def render_si(self, ctx, data):
771         si_s = base32.b2a_or_none(data.get_storage_index())
772         if si_s is None:
773             si_s = "(None)"
774         return si_s
775
776     def render_helper(self, ctx, data):
777         return {True: "Yes",
778                 False: "No"}[data.using_helper()]
779
780     def render_current_size(self, ctx, data):
781         size = data.get_size()
782         if size is None:
783             size = "(unknown)"
784         return size
785
786     def render_progress(self, ctx, data):
787         progress = data.get_progress()
788         # TODO: make an ascii-art bar
789         return "%.1f%%" % (100.0 * progress)
790
791     def render_status(self, ctx, data):
792         return data.get_status()
793
794     def render_encoding(self, ctx, data):
795         k, n = data.get_encoding()
796         return ctx.tag["Encoding: %s of %s" % (k, n)]
797
798     def render_sharemap(self, ctx, data):
799         servermap = data.get_servermap()
800         if servermap is None:
801             return ctx.tag["None"]
802         l = T.ul()
803         sharemap = servermap.make_sharemap()
804         for shnum in sorted(sharemap.keys()):
805             l[T.li["%d -> Placed on " % shnum,
806                    ", ".join(["[%s]" % server.get_name()
807                               for server in sharemap[shnum]])]]
808         return ctx.tag["Sharemap:", l]
809
810     def render_problems(self, ctx, data):
811         problems = data.get_problems()
812         if not problems:
813             return ""
814         l = T.ul()
815         # XXX: is this exercised? I don't think PublishStatus.problems is
816         # ever populated
817         for peerid in sorted(problems.keys()):
818             peerid_s = idlib.shortnodeid_b2a(peerid)
819             l[T.li["[%s]: %s" % (peerid_s, problems[peerid])]]
820         return ctx.tag["Server Problems:", l]
821
822     def _get_rate(self, data, name):
823         file_size = self.publish_status.get_size()
824         duration = self.publish_status.timings.get(name)
825         return compute_rate(file_size, duration)
826
827     def data_time_total(self, ctx, data):
828         return self.publish_status.timings.get("total")
829     def data_rate_total(self, ctx, data):
830         return self._get_rate(data, "total")
831
832     def data_time_setup(self, ctx, data):
833         return self.publish_status.timings.get("setup")
834
835     def data_time_encrypt(self, ctx, data):
836         return self.publish_status.timings.get("encrypt")
837     def data_rate_encrypt(self, ctx, data):
838         return self._get_rate(data, "encrypt")
839
840     def data_time_encode(self, ctx, data):
841         return self.publish_status.timings.get("encode")
842     def data_rate_encode(self, ctx, data):
843         return self._get_rate(data, "encode")
844
845     def data_time_pack(self, ctx, data):
846         return self.publish_status.timings.get("pack")
847     def data_rate_pack(self, ctx, data):
848         return self._get_rate(data, "pack")
849     def data_time_sign(self, ctx, data):
850         return self.publish_status.timings.get("sign")
851
852     def data_time_push(self, ctx, data):
853         return self.publish_status.timings.get("push")
854     def data_rate_push(self, ctx, data):
855         return self._get_rate(data, "push")
856
857     def render_server_timings(self, ctx, data):
858         per_server = self.publish_status.timings.get("send_per_server")
859         if not per_server:
860             return ""
861         l = T.ul()
862         for server in sorted(per_server.keys(), key=lambda s: s.get_name()):
863             times_s = ", ".join([self.render_time(None, t)
864                                  for t in per_server[server]])
865             l[T.li["[%s]: %s" % (server.get_name(), times_s)]]
866         return T.li["Per-Server Response Times: ", l]
867
868 class MapupdateStatusPage(rend.Page, RateAndTimeMixin):
869     docFactory = getxmlfile("map-update-status.xhtml")
870
871     def __init__(self, data):
872         rend.Page.__init__(self, data)
873         self.update_status = data
874
875     def render_started(self, ctx, data):
876         started_s = render_time(data.get_started())
877         return started_s
878
879     def render_finished(self, ctx, data):
880         when = data.get_finished()
881         if not when:
882             return "not yet"
883         started_s = render_time(data.get_finished())
884         return started_s
885
886     def render_si(self, ctx, data):
887         si_s = base32.b2a_or_none(data.get_storage_index())
888         if si_s is None:
889             si_s = "(None)"
890         return si_s
891
892     def render_helper(self, ctx, data):
893         return {True: "Yes",
894                 False: "No"}[data.using_helper()]
895
896     def render_progress(self, ctx, data):
897         progress = data.get_progress()
898         # TODO: make an ascii-art bar
899         return "%.1f%%" % (100.0 * progress)
900
901     def render_status(self, ctx, data):
902         return data.get_status()
903
904     def render_problems(self, ctx, data):
905         problems = data.problems
906         if not problems:
907             return ""
908         l = T.ul()
909         for peerid in sorted(problems.keys()):
910             peerid_s = idlib.shortnodeid_b2a(peerid)
911             l[T.li["[%s]: %s" % (peerid_s, problems[peerid])]]
912         return ctx.tag["Server Problems:", l]
913
914     def render_privkey_from(self, ctx, data):
915         server = data.get_privkey_from()
916         if server:
917             return ctx.tag["Got privkey from: [%s]" % server.get_name()]
918         else:
919             return ""
920
921     def data_time_total(self, ctx, data):
922         return self.update_status.timings.get("total")
923
924     def data_time_initial_queries(self, ctx, data):
925         return self.update_status.timings.get("initial_queries")
926
927     def data_time_cumulative_verify(self, ctx, data):
928         return self.update_status.timings.get("cumulative_verify")
929
930     def render_server_timings(self, ctx, data):
931         per_server = self.update_status.timings.get("per_server")
932         if not per_server:
933             return ""
934         l = T.ul()
935         for server in sorted(per_server.keys(), key=lambda s: s.get_name()):
936             times = []
937             for op,started,t in per_server[server]:
938                 #times.append("%s/%.4fs/%s/%s" % (op,
939                 #                              started,
940                 #                              self.render_time(None, started - self.update_status.get_started()),
941                 #                              self.render_time(None,t)))
942                 if op == "query":
943                     times.append( self.render_time(None, t) )
944                 elif op == "late":
945                     times.append( "late(" + self.render_time(None, t) + ")" )
946                 else:
947                     times.append( "privkey(" + self.render_time(None, t) + ")" )
948             times_s = ", ".join(times)
949             l[T.li["[%s]: %s" % (server.get_name(), times_s)]]
950         return T.li["Per-Server Response Times: ", l]
951
952     def render_timing_chart(self, ctx, data):
953         imageurl = self._timing_chart()
954         return ctx.tag[imageurl]
955
956     def _timing_chart(self):
957         started = self.update_status.get_started()
958         total = self.update_status.timings.get("total")
959         per_server = self.update_status.timings.get("per_server")
960         # We'd like to use an https: URL here, but the site has a domain/cert mismatch.
961         base = "http://chart.apis.google.com/chart?"
962         pieces = ["cht=bhs"]
963         pieces.append("chco=ffffff,4d89f9,c6d9fd") # colors
964         data0 = []
965         data1 = []
966         data2 = []
967         nb_nodes = 0
968         graph_botom_margin= 21
969         graph_top_margin = 5
970         server_names = []
971         top_abs = started
972         # we sort the queries by the time at which we sent the first request
973         sorttable = [ (times[0][1], server)
974                       for server, times in per_server.items() ]
975         sorttable.sort()
976         servers = [t[1] for t in sorttable]
977
978         for server in servers:
979             nb_nodes += 1
980             times = per_server[server]
981             name = server.get_name()
982             server_names.append(name)
983             # for servermap updates, there are either one or two queries per
984             # peer. The second (if present) is to get the privkey.
985             op,q_started,q_elapsed = times[0]
986             data0.append("%.3f" % (q_started-started))
987             data1.append("%.3f" % q_elapsed)
988             top_abs = max(top_abs, q_started+q_elapsed)
989             if len(times) > 1:
990                 op,p_started,p_elapsed = times[0]
991                 data2.append("%.3f" % p_elapsed)
992                 top_abs = max(top_abs, p_started+p_elapsed)
993             else:
994                 data2.append("0.0")
995         finished = self.update_status.get_finished()
996         if finished:
997             top_abs = max(top_abs, finished)
998         top_rel = top_abs - started
999         chs ="chs=400x%d" % ( (nb_nodes*28) + graph_top_margin + graph_botom_margin )
1000         chd = "chd=t:" + "|".join([",".join(data0),
1001                                    ",".join(data1),
1002                                    ",".join(data2)])
1003         pieces.append(chd)
1004         pieces.append(chs)
1005         chds = "chds=0,%0.3f" % top_rel
1006         pieces.append(chds)
1007         pieces.append("chxt=x,y")
1008         pieces.append("chxr=0,0.0,%0.3f" % top_rel)
1009         pieces.append("chxl=1:|" + "|".join(reversed(server_names)))
1010         # use up to 10 grid lines, at decimal multiples.
1011         # mathutil.next_power_of_k doesn't handle numbers smaller than one,
1012         # unfortunately.
1013         #pieces.append("chg="
1014
1015         if total is not None:
1016             finished_f = 1.0 * total / top_rel
1017             pieces.append("chm=r,FF0000,0,%0.3f,%0.3f" % (finished_f,
1018                                                           finished_f+0.01))
1019         url = base + "&".join(pieces)
1020         return T.img(src=url,border="1",align="right", float="right")
1021
1022
1023 class Status(rend.Page):
1024     docFactory = getxmlfile("status.xhtml")
1025     addSlash = True
1026
1027     def __init__(self, history):
1028         rend.Page.__init__(self, history)
1029         self.history = history
1030
1031     def renderHTTP(self, ctx):
1032         req = inevow.IRequest(ctx)
1033         t = get_arg(req, "t")
1034         if t == "json":
1035             return self.json(req)
1036         return rend.Page.renderHTTP(self, ctx)
1037
1038     def json(self, req):
1039         req.setHeader("content-type", "text/plain")
1040         data = {}
1041         data["active"] = active = []
1042         for s in self._get_active_operations():
1043             si_s = base32.b2a_or_none(s.get_storage_index())
1044             size = s.get_size()
1045             status = s.get_status()
1046             if IUploadStatus.providedBy(s):
1047                 h,c,e = s.get_progress()
1048                 active.append({"type": "upload",
1049                                "storage-index-string": si_s,
1050                                "total-size": size,
1051                                "status": status,
1052                                "progress-hash": h,
1053                                "progress-ciphertext": c,
1054                                "progress-encode-push": e,
1055                                })
1056             elif IDownloadStatus.providedBy(s):
1057                 active.append({"type": "download",
1058                                "storage-index-string": si_s,
1059                                "total-size": size,
1060                                "status": status,
1061                                "progress": s.get_progress(),
1062                                })
1063
1064         return simplejson.dumps(data, indent=1) + "\n"
1065
1066     def _get_all_statuses(self):
1067         h = self.history
1068         return itertools.chain(h.list_all_upload_statuses(),
1069                                h.list_all_download_statuses(),
1070                                h.list_all_mapupdate_statuses(),
1071                                h.list_all_publish_statuses(),
1072                                h.list_all_retrieve_statuses(),
1073                                h.list_all_helper_statuses(),
1074                                )
1075
1076     def data_active_operations(self, ctx, data):
1077         return self._get_active_operations()
1078
1079     def _get_active_operations(self):
1080         active = [s
1081                   for s in self._get_all_statuses()
1082                   if s.get_active()]
1083         return active
1084
1085     def data_recent_operations(self, ctx, data):
1086         return self._get_recent_operations()
1087
1088     def _get_recent_operations(self):
1089         recent = [s
1090                   for s in self._get_all_statuses()
1091                   if not s.get_active()]
1092         recent.sort(lambda a,b: cmp(a.get_started(), b.get_started()))
1093         recent.reverse()
1094         return recent
1095
1096     def render_row(self, ctx, data):
1097         s = data
1098
1099         started_s = render_time(s.get_started())
1100         ctx.fillSlots("started", started_s)
1101
1102         si_s = base32.b2a_or_none(s.get_storage_index())
1103         if si_s is None:
1104             si_s = "(None)"
1105         ctx.fillSlots("si", si_s)
1106         ctx.fillSlots("helper", {True: "Yes",
1107                                  False: "No"}[s.using_helper()])
1108
1109         size = s.get_size()
1110         if size is None:
1111             size = "(unknown)"
1112         elif isinstance(size, (int, long, float)):
1113             size = abbreviate_size(size)
1114         ctx.fillSlots("total_size", size)
1115
1116         progress = data.get_progress()
1117         if IUploadStatus.providedBy(data):
1118             link = "up-%d" % data.get_counter()
1119             ctx.fillSlots("type", "upload")
1120             # TODO: make an ascii-art bar
1121             (chk, ciphertext, encandpush) = progress
1122             progress_s = ("hash: %.1f%%, ciphertext: %.1f%%, encode: %.1f%%" %
1123                           ( (100.0 * chk),
1124                             (100.0 * ciphertext),
1125                             (100.0 * encandpush) ))
1126             ctx.fillSlots("progress", progress_s)
1127         elif IDownloadStatus.providedBy(data):
1128             link = "down-%d" % data.get_counter()
1129             ctx.fillSlots("type", "download")
1130             ctx.fillSlots("progress", "%.1f%%" % (100.0 * progress))
1131         elif IPublishStatus.providedBy(data):
1132             link = "publish-%d" % data.get_counter()
1133             ctx.fillSlots("type", "publish")
1134             ctx.fillSlots("progress", "%.1f%%" % (100.0 * progress))
1135         elif IRetrieveStatus.providedBy(data):
1136             ctx.fillSlots("type", "retrieve")
1137             link = "retrieve-%d" % data.get_counter()
1138             ctx.fillSlots("progress", "%.1f%%" % (100.0 * progress))
1139         else:
1140             assert IServermapUpdaterStatus.providedBy(data)
1141             ctx.fillSlots("type", "mapupdate %s" % data.get_mode())
1142             link = "mapupdate-%d" % data.get_counter()
1143             ctx.fillSlots("progress", "%.1f%%" % (100.0 * progress))
1144         ctx.fillSlots("status", T.a(href=link)[s.get_status()])
1145         return ctx.tag
1146
1147     def childFactory(self, ctx, name):
1148         h = self.history
1149         stype,count_s = name.split("-")
1150         count = int(count_s)
1151         if stype == "up":
1152             for s in itertools.chain(h.list_all_upload_statuses(),
1153                                      h.list_all_helper_statuses()):
1154                 # immutable-upload helpers use the same status object as a
1155                 # regular immutable-upload
1156                 if s.get_counter() == count:
1157                     return UploadStatusPage(s)
1158         if stype == "down":
1159             for s in h.list_all_download_statuses():
1160                 if s.get_counter() == count:
1161                     return DownloadStatusPage(s)
1162         if stype == "mapupdate":
1163             for s in h.list_all_mapupdate_statuses():
1164                 if s.get_counter() == count:
1165                     return MapupdateStatusPage(s)
1166         if stype == "publish":
1167             for s in h.list_all_publish_statuses():
1168                 if s.get_counter() == count:
1169                     return PublishStatusPage(s)
1170         if stype == "retrieve":
1171             for s in h.list_all_retrieve_statuses():
1172                 if s.get_counter() == count:
1173                     return RetrieveStatusPage(s)
1174
1175
1176 class HelperStatus(rend.Page):
1177     docFactory = getxmlfile("helper.xhtml")
1178
1179     def __init__(self, helper):
1180         rend.Page.__init__(self, helper)
1181         self.helper = helper
1182
1183     def renderHTTP(self, ctx):
1184         req = inevow.IRequest(ctx)
1185         t = get_arg(req, "t")
1186         if t == "json":
1187             return self.render_JSON(req)
1188         return rend.Page.renderHTTP(self, ctx)
1189
1190     def data_helper_stats(self, ctx, data):
1191         return self.helper.get_stats()
1192
1193     def render_JSON(self, req):
1194         req.setHeader("content-type", "text/plain")
1195         if self.helper:
1196             stats = self.helper.get_stats()
1197             return simplejson.dumps(stats, indent=1) + "\n"
1198         return simplejson.dumps({}) + "\n"
1199
1200     def render_active_uploads(self, ctx, data):
1201         return data["chk_upload_helper.active_uploads"]
1202
1203     def render_incoming(self, ctx, data):
1204         return "%d bytes in %d files" % (data["chk_upload_helper.incoming_size"],
1205                                          data["chk_upload_helper.incoming_count"])
1206
1207     def render_encoding(self, ctx, data):
1208         return "%d bytes in %d files" % (data["chk_upload_helper.encoding_size"],
1209                                          data["chk_upload_helper.encoding_count"])
1210
1211     def render_upload_requests(self, ctx, data):
1212         return str(data["chk_upload_helper.upload_requests"])
1213
1214     def render_upload_already_present(self, ctx, data):
1215         return str(data["chk_upload_helper.upload_already_present"])
1216
1217     def render_upload_need_upload(self, ctx, data):
1218         return str(data["chk_upload_helper.upload_need_upload"])
1219
1220     def render_upload_bytes_fetched(self, ctx, data):
1221         return str(data["chk_upload_helper.fetched_bytes"])
1222
1223     def render_upload_bytes_encoded(self, ctx, data):
1224         return str(data["chk_upload_helper.encoded_bytes"])
1225
1226
1227 class Statistics(rend.Page):
1228     docFactory = getxmlfile("statistics.xhtml")
1229
1230     def __init__(self, provider):
1231         rend.Page.__init__(self, provider)
1232         self.provider = provider
1233
1234     def renderHTTP(self, ctx):
1235         req = inevow.IRequest(ctx)
1236         t = get_arg(req, "t")
1237         if t == "json":
1238             stats = self.provider.get_stats()
1239             req.setHeader("content-type", "text/plain")
1240             return simplejson.dumps(stats, indent=1) + "\n"
1241         return rend.Page.renderHTTP(self, ctx)
1242
1243     def data_get_stats(self, ctx, data):
1244         return self.provider.get_stats()
1245
1246     def render_load_average(self, ctx, data):
1247         return str(data["stats"].get("load_monitor.avg_load"))
1248
1249     def render_peak_load(self, ctx, data):
1250         return str(data["stats"].get("load_monitor.max_load"))
1251
1252     def render_uploads(self, ctx, data):
1253         files = data["counters"].get("uploader.files_uploaded", 0)
1254         bytes = data["counters"].get("uploader.bytes_uploaded", 0)
1255         return ("%s files / %s bytes (%s)" %
1256                 (files, bytes, abbreviate_size(bytes)))
1257
1258     def render_downloads(self, ctx, data):
1259         files = data["counters"].get("downloader.files_downloaded", 0)
1260         bytes = data["counters"].get("downloader.bytes_downloaded", 0)
1261         return ("%s files / %s bytes (%s)" %
1262                 (files, bytes, abbreviate_size(bytes)))
1263
1264     def render_publishes(self, ctx, data):
1265         files = data["counters"].get("mutable.files_published", 0)
1266         bytes = data["counters"].get("mutable.bytes_published", 0)
1267         return "%s files / %s bytes (%s)" % (files, bytes,
1268                                              abbreviate_size(bytes))
1269
1270     def render_retrieves(self, ctx, data):
1271         files = data["counters"].get("mutable.files_retrieved", 0)
1272         bytes = data["counters"].get("mutable.bytes_retrieved", 0)
1273         return "%s files / %s bytes (%s)" % (files, bytes,
1274                                              abbreviate_size(bytes))
1275
1276     def render_drop_monitored(self, ctx, data):
1277         dirs = data["counters"].get("drop_upload.dirs_monitored", 0)
1278         return "%s directories" % (dirs,)
1279
1280     def render_drop_uploads(self, ctx, data):
1281         # TODO: bytes uploaded
1282         files = data["counters"].get("drop_upload.files_uploaded", 0)
1283         return "%s files" % (files,)
1284
1285     def render_drop_queued(self, ctx, data):
1286         files = data["counters"].get("drop_upload.files_queued", 0)
1287         return "%s files" % (files,)
1288
1289     def render_drop_failed(self, ctx, data):
1290         files = data["counters"].get("drop_upload.files_failed", 0)
1291         return "%s files" % (files,)
1292
1293     def render_raw(self, ctx, data):
1294         raw = pprint.pformat(data)
1295         return ctx.tag[raw]