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