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