package net.i2p.router.web; import java.io.IOException; import java.text.Collator; import java.text.DecimalFormat; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Map; import java.util.TreeSet; import net.i2p.data.DataHelper; import net.i2p.data.Destination; import net.i2p.data.Hash; import net.i2p.data.LeaseSet; import net.i2p.data.RouterAddress; import net.i2p.data.RouterInfo; import net.i2p.router.CommSystemFacade; import net.i2p.router.Router; import net.i2p.router.RouterContext; import net.i2p.router.RouterVersion; import net.i2p.router.TunnelPoolSettings; import net.i2p.router.networkdb.kademlia.FloodfillNetworkDatabaseFacade; import net.i2p.router.transport.TransportUtil; import net.i2p.stat.Rate; import net.i2p.stat.RateStat; import net.i2p.util.PortMapper; /** * Simple helper to query the appropriate router for data necessary to render * the summary sections on the router console. * * For the full summary bar use renderSummaryBar() */ public class SummaryHelper extends HelperBase { // Opera 10.63 doesn't have the char, TODO check UA //static final String THINSP = " / "; static final String THINSP = " / "; private static final char S = ','; static final String PROP_SUMMARYBAR = "routerconsole.summaryBar."; static final String DEFAULT_FULL = "HelpAndFAQ" + S + "I2PServices" + S + "I2PInternals" + S + "General" + S + "NetworkReachability" + S + "UpdateStatus" + S + "RestartStatus" + S + "Peers" + S + "FirewallAndReseedStatus" + S + "Bandwidth" + S + "Tunnels" + S + "Congestion" + S + "TunnelStatus" + S + "Destinations" + S + ""; static final String DEFAULT_MINIMAL = "ShortGeneral" + S + "NewsHeadings" + S + "UpdateStatus" + S + "NetworkReachability" + S + "RestartStatus" + S + "FirewallAndReseedStatus" + S + "Destinations" + S + ""; /** * Retrieve the shortened 4 character ident for the router located within * the current JVM at the given context. * */ public String getIdent() { if (_context == null) return "[no router]"; if (_context.routerHash() != null) return _context.routerHash().toBase64().substring(0, 4); else return "[unknown]"; } /** * Retrieve the version number of the router. * */ public String getVersion() { return RouterVersion.FULL_VERSION; } /** * Retrieve a pretty printed uptime count (ala 4d or 7h or 39m) * */ public String getUptime() { if (_context == null) return "[no router]"; Router router = _context.router(); if (router == null) return "[not up]"; else return DataHelper.formatDuration2(router.getUptime()); } /** this displayed offset, not skew - now handled in reachability() private String timeSkew() { if (_context == null) return ""; //if (!_context.clock().getUpdatedSuccessfully()) // return " (Unknown skew)"; long ms = _context.clock().getOffset(); long diff = Math.abs(ms); if (diff < 3000) return ""; return " (" + DataHelper.formatDuration2(diff) + " " + _("skew") + ")"; } **/ public boolean allowReseed() { return _context.netDb().isInitialized() && (_context.netDb().getKnownRouters() < 30) || _context.getBooleanProperty("i2p.alwaysAllowReseed"); } /** subtract one for ourselves, so if we know no other peers it displays zero */ public int getAllPeers() { return Math.max(_context.netDb().getKnownRouters() - 1, 0); } public String getReachability() { return reachability(); // + timeSkew(); // testing //return reachability() + // " Offset: " + DataHelper.formatDuration(_context.clock().getOffset()) + // " Slew: " + DataHelper.formatDuration(((RouterClock)_context.clock()).getDeltaOffset()); } private String reachability() { if (_context.commSystem().isDummy()) return "VM Comm System"; if (_context.router().getUptime() > 60*1000 && (!_context.router().gracefulShutdownInProgress()) && !_context.clientManager().isAlive()) return _("ERR-Client Manager I2CP Error - check logs"); // not a router problem but the user should know // Warn based on actual skew from peers, not update status, so if we successfully offset // the clock, we don't complain. //if (!_context.clock().getUpdatedSuccessfully()) long skew = _context.commSystem().getFramedAveragePeerClockSkew(33); // Display the actual skew, not the offset if (Math.abs(skew) > 30*1000) return _("ERR-Clock Skew of {0}", DataHelper.formatDuration2(Math.abs(skew))); if (_context.router().isHidden()) return _("Hidden"); RouterInfo routerInfo = _context.router().getRouterInfo(); if (routerInfo == null) return _("Testing"); int status = _context.commSystem().getReachabilityStatus(); switch (status) { case CommSystemFacade.STATUS_OK: RouterAddress ra = routerInfo.getTargetAddress("NTCP"); if (ra == null) return _("OK"); byte[] ip = ra.getIP(); if (ip == null) return _("ERR-Unresolved TCP Address"); // TODO set IPv6 arg based on configuration? if (TransportUtil.isPubliclyRoutable(ip, true)) return _("OK"); return _("ERR-Private TCP Address"); case CommSystemFacade.STATUS_DIFFERENT: return _("ERR-SymmetricNAT"); case CommSystemFacade.STATUS_REJECT_UNSOLICITED: if (routerInfo.getTargetAddress("NTCP") != null) return _("WARN-Firewalled with Inbound TCP Enabled"); if (((FloodfillNetworkDatabaseFacade)_context.netDb()).floodfillEnabled()) return _("WARN-Firewalled and Floodfill"); //if (_context.router().getRouterInfo().getCapabilities().indexOf('O') >= 0) // return _("WARN-Firewalled and Fast"); return _("Firewalled"); case CommSystemFacade.STATUS_DISCONNECTED: return _("Disconnected - check network cable"); case CommSystemFacade.STATUS_HOSED: return _("ERR-UDP Port In Use - Set i2np.udp.internalPort=xxxx in advanced config and restart"); case CommSystemFacade.STATUS_UNKNOWN: // fallthrough default: ra = routerInfo.getTargetAddress("SSU"); if (ra == null && _context.router().getUptime() > 5*60*1000) { if (getActivePeers() <= 0) return _("ERR-No Active Peers, Check Network Connection and Firewall"); else if (_context.getProperty(ConfigNetHelper.PROP_I2NP_NTCP_HOSTNAME) == null || _context.getProperty(ConfigNetHelper.PROP_I2NP_NTCP_PORT) == null) return _("ERR-UDP Disabled and Inbound TCP host/port not set"); else return _("WARN-Firewalled with UDP Disabled"); } return _("Testing"); } } /** * Retrieve amount of used memory. * */ /******** public String getMemory() { DecimalFormat integerFormatter = new DecimalFormat("###,###,##0"); long used = (Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory())/1024; long usedPc = 100 - ((Runtime.getRuntime().freeMemory() * 100) / Runtime.getRuntime().totalMemory()); return integerFormatter.format(used) + "KB (" + usedPc + "%)"; } ********/ /** * How many peers we are talking to now * */ public int getActivePeers() { if (_context == null) return 0; else return _context.commSystem().countActivePeers(); } /** * Should we warn about a possible firewall problem? */ public boolean showFirewallWarning() { return _context != null && _context.netDb().isInitialized() && _context.router().getUptime() > 2*60*1000 && (!_context.commSystem().isDummy()) && _context.commSystem().countActivePeers() <= 0 && _context.netDb().getKnownRouters() > 5; } /** * How many active identities have we spoken with recently * */ public int getActiveProfiles() { if (_context == null) return 0; else return _context.profileOrganizer().countActivePeers(); } /** * How many active peers the router ranks as fast. * */ public int getFastPeers() { if (_context == null) return 0; else return _context.profileOrganizer().countFastPeers(); } /** * How many active peers the router ranks as having a high capacity. * */ public int getHighCapacityPeers() { if (_context == null) return 0; else return _context.profileOrganizer().countHighCapacityPeers(); } /** * How many active peers the router ranks as well integrated. * */ public int getWellIntegratedPeers() { if (_context == null) return 0; //return _context.profileOrganizer().countWellIntegratedPeers(); return _context.peerManager().getPeersByCapability(FloodfillNetworkDatabaseFacade.CAPABILITY_FLOODFILL).size(); } /** * How many peers the router ranks as failing. * */ /******** public int getFailingPeers() { if (_context == null) return 0; else return _context.profileOrganizer().countFailingPeers(); } ********/ /** * How many peers totally suck. * */ /******** public int getBanlistedPeers() { if (_context == null) return 0; else return _context.banlist().getRouterCount(); } ********/ /** * @return "x.xx / y.yy {K|M}" */ public String getSecondKBps() { if (_context == null) return "0 / 0"; return formatPair(_context.bandwidthLimiter().getReceiveBps(), _context.bandwidthLimiter().getSendBps()); } /** * @return "x.xx / y.yy {K|M}" */ public String getFiveMinuteKBps() { if (_context == null) return "0 / 0"; RateStat receiveRate = _context.statManager().getRate("bw.recvRate"); double in = 0; if (receiveRate != null) { Rate r = receiveRate.getRate(5*60*1000); if (r != null) in = r.getAverageValue(); } RateStat sendRate = _context.statManager().getRate("bw.sendRate"); double out = 0; if (sendRate != null) { Rate r = sendRate.getRate(5*60*1000); if (r != null) out = r.getAverageValue(); } return formatPair(in, out); } /** * @return "x.xx / y.yy {K|M}" */ public String getLifetimeKBps() { if (_context == null) return "0 / 0"; RateStat receiveRate = _context.statManager().getRate("bw.recvRate"); double in; if (receiveRate == null) in = 0; else in = receiveRate.getLifetimeAverageValue(); RateStat sendRate = _context.statManager().getRate("bw.sendRate"); double out; if (sendRate == null) out = 0; else out = sendRate.getLifetimeAverageValue(); return formatPair(in, out); } /** * @return "x.xx / y.yy {K|M}" */ private static String formatPair(double in, double out) { boolean mega = in >= 1024*1024 || out >= 1024*1024; // scale both the same if (mega) { in /= 1024*1024; out /= 1024*1024; } else { in /= 1024; out /= 1024; } // control total width DecimalFormat fmt; if (in >= 1000 || out >= 1000) fmt = new DecimalFormat("#0"); else if (in >= 100 || out >= 100) fmt = new DecimalFormat("#0.0"); else fmt = new DecimalFormat("#0.00"); return fmt.format(in) + THINSP + fmt.format(out) + " " + (mega ? 'M' : 'K'); } /** * How much data have we received since the router started (pretty printed * string with 2 decimal places and the appropriate units - GB/MB/KB/bytes) * */ public String getInboundTransferred() { if (_context == null) return "0"; long received = _context.bandwidthLimiter().getTotalAllocatedInboundBytes(); return DataHelper.formatSize2(received) + 'B'; } /** * How much data have we sent since the router started (pretty printed * string with 2 decimal places and the appropriate units - GB/MB/KB/bytes) * */ public String getOutboundTransferred() { if (_context == null) return "0"; long sent = _context.bandwidthLimiter().getTotalAllocatedOutboundBytes(); return DataHelper.formatSize2(sent) + 'B'; } /** * Client destinations connected locally. * * @return html section summary */ public String getDestinations() { // convert the set to a list so we can sort by name and not lose duplicates List clients = new ArrayList(_context.clientManager().listClients()); StringBuilder buf = new StringBuilder(512); buf.append("

").append(_("Local Destinations")).append("

"); if (!clients.isEmpty()) { Collections.sort(clients, new AlphaComparator()); buf.append(""); for (Destination client : clients) { String name = getName(client); Hash h = client.calculateHash(); buf.append("\n"); LeaseSet ls = _context.netDb().lookupLeaseSetLocally(h); if (ls != null && _context.tunnelManager().getOutboundClientTunnelCount(h) > 0) { long timeToExpire = ls.getEarliestLeaseDate() - _context.clock().now(); if (timeToExpire < 0) { // red or yellow light buf.append("\n"); } else { // green light buf.append("\n"); } } else { // yellow light buf.append("\n"); } } buf.append("
\"Server\""); else buf.append("client.png\" alt=\"Client\" title=\"").append(_("Client")).append("\">"); buf.append(""); if (name.length() < 18) buf.append(DataHelper.escapeHTML(name)); else buf.append(DataHelper.escapeHTML(name.substring(0,15))).append("…"); buf.append("\"").append(_("Rebuilding")).append("…\"
\"Ready\"
\"").append(_("Building")).append("…\"
"); } else { buf.append("
").append(_("none")).append("
"); } buf.append("
\n"); return buf.toString(); } /** * Compare translated nicknames - put "shared clients" first in the sort * Inner class, can't be Serializable */ private class AlphaComparator implements Comparator { private final String xsc = _("shared clients"); public int compare(Destination lhs, Destination rhs) { String lname = getName(lhs); String rname = getName(rhs); if (lname.equals(xsc)) return -1; if (rname.equals(xsc)) return 1; return Collator.getInstance().compare(lname, rname); } } /** translate here so collation works above */ private String getName(Destination d) { TunnelPoolSettings in = _context.tunnelManager().getInboundSettings(d.calculateHash()); String name = (in != null ? in.getDestinationNickname() : null); if (name == null) { TunnelPoolSettings out = _context.tunnelManager().getOutboundSettings(d.calculateHash()); name = (out != null ? out.getDestinationNickname() : null); if (name == null) name = d.calculateHash().toBase64().substring(0,6); else name = _(name); } else { name = _(name); } return name; } /** * How many free inbound tunnels we have. * */ public int getInboundTunnels() { if (_context == null) return 0; else return _context.tunnelManager().getFreeTunnelCount(); } /** * How many active outbound tunnels we have. * */ public int getOutboundTunnels() { if (_context == null) return 0; else return _context.tunnelManager().getOutboundTunnelCount(); } /** * How many inbound client tunnels we have. * */ public int getInboundClientTunnels() { if (_context == null) return 0; else return _context.tunnelManager().getInboundClientTunnelCount(); } /** * How many active outbound client tunnels we have. * */ public int getOutboundClientTunnels() { if (_context == null) return 0; else return _context.tunnelManager().getOutboundClientTunnelCount(); } /** * How many tunnels we are participating in. * */ public int getParticipatingTunnels() { if (_context == null) return 0; else return _context.tunnelManager().getParticipatingCount(); } /** @since 0.7.10 */ public String getShareRatio() { if (_context == null) return "0"; double sr = _context.tunnelManager().getShareRatio(); DecimalFormat fmt = new DecimalFormat("##0.00"); return fmt.format(sr); } /** * How lagged our job queue is over the last minute (pretty printed with * the units attached) * */ public String getJobLag() { if (_context == null) return "0"; RateStat rs = _context.statManager().getRate("jobQueue.jobLag"); if (rs == null) return "0"; Rate lagRate = rs.getRate(60*1000); return DataHelper.formatDuration2((long)lagRate.getAverageValue()); } /** * How long it takes us to pump out a message, averaged over the last minute * (pretty printed with the units attached) * */ public String getMessageDelay() { if (_context == null) return "0"; return DataHelper.formatDuration2(_context.throttle().getMessageDelay()); } /** * How long it takes us to test our tunnels, averaged over the last 10 minutes * (pretty printed with the units attached) * */ public String getTunnelLag() { if (_context == null) return "0"; return DataHelper.formatDuration2(_context.throttle().getTunnelLag()); } public String getTunnelStatus() { if (_context == null) return ""; return _context.throttle().getTunnelStatus(); } public String getInboundBacklog() { if (_context == null) return "0"; return String.valueOf(_context.tunnelManager().getInboundBuildQueueSize()); } /******* public String getPRNGStatus() { Rate r = _context.statManager().getRate("prng.bufferWaitTime").getRate(60*1000); int use = (int) r.getLastEventCount(); int i = (int) (r.getAverageValue() + 0.5); if (i <= 0) { r = _context.statManager().getRate("prng.bufferWaitTime").getRate(10*60*1000); i = (int) (r.getAverageValue() + 0.5); } String rv = i + "/"; r = _context.statManager().getRate("prng.bufferFillTime").getRate(60*1000); i = (int) (r.getAverageValue() + 0.5); if (i <= 0) { r = _context.statManager().getRate("prng.bufferFillTime").getRate(10*60*1000); i = (int) (r.getAverageValue() + 0.5); } rv = rv + i + "ms"; // margin == fill time / use time if (use > 0 && i > 0) rv = rv + ' ' + (60*1000 / (use * i)) + 'x'; return rv; } ********/ private boolean updateAvailable() { return NewsHelper.isUpdateAvailable(); } private boolean unsignedUpdateAvailable() { return NewsHelper.isUnsignedUpdateAvailable(); } private String getUpdateVersion() { return NewsHelper.updateVersion(); } private String getUnsignedUpdateVersion() { return NewsHelper.unsignedUpdateVersion(); } /** * The update status and buttons * @since 0.8.13 moved from SummaryBarRenderer */ public String getUpdateStatus() { StringBuilder buf = new StringBuilder(512); // display all the time so we display the final failure message, and plugin update messages too String status = NewsHelper.getUpdateStatus(); boolean needSpace = false; if (status.length() > 0) { buf.append("

").append(status).append("

\n"); needSpace = true; } String dver = NewsHelper.updateVersionDownloaded(); if (dver == null) dver = NewsHelper.unsignedVersionDownloaded(); if (dver != null && !NewsHelper.isUpdateInProgress() && !_context.router().gracefulShutdownInProgress()) { if (needSpace) buf.append("
"); else needSpace = true; buf.append("

").append(_("Update downloaded")).append("
"); if (_context.hasWrapper()) buf.append(_("Click Restart to install")); else buf.append(_("Click Shutdown and restart to install")); buf.append(' ').append(_("Version {0}", dver)); buf.append("

"); } boolean avail = updateAvailable(); boolean unsignedAvail = unsignedUpdateAvailable(); String constraint = avail ? NewsHelper.updateConstraint() : null; if (avail && constraint != null && !NewsHelper.isUpdateInProgress() && !_context.router().gracefulShutdownInProgress()) { if (needSpace) buf.append("
"); else needSpace = true; buf.append("

").append(_("Update available")).append(":
"); buf.append(_("Version {0}", getUpdateVersion())).append("
"); buf.append(constraint).append("

"); avail = false; } if ((avail || unsignedAvail) && !NewsHelper.isUpdateInProgress() && !_context.router().gracefulShutdownInProgress() && _context.portMapper().getPort(PortMapper.SVC_HTTP_PROXY) > 0 && // assume using proxy for now getAction() == null && getUpdateNonce() == null) { if (needSpace) buf.append("
"); long nonce = _context.random().nextLong(); String prev = System.getProperty("net.i2p.router.web.UpdateHandler.nonce"); if (prev != null) System.setProperty("net.i2p.router.web.UpdateHandler.noncePrev", prev); System.setProperty("net.i2p.router.web.UpdateHandler.nonce", nonce+""); String uri = getRequestURI(); buf.append("
\n"); buf.append("\n"); if (avail) { buf.append("
\n"); } if (unsignedAvail) { buf.append("
\n"); } buf.append("
\n"); } return buf.toString(); } /** * The restart status and buttons * @since 0.8.13 moved from SummaryBarRenderer */ public String getRestartStatus() { return ConfigRestartBean.renderStatus(getRequestURI(), getAction(), getConsoleNonce()); } /** * The firewall status and reseed status/buttons * @since 0.9 moved from SummaryBarRenderer */ public String getFirewallAndReseedStatus() { StringBuilder buf = new StringBuilder(256); if (showFirewallWarning()) { buf.append("

") .append(_("Check network connection and NAT/firewall")) .append("

"); } boolean reseedInProgress = _context.netDb().reseedChecker().inProgress(); // If showing the reseed link is allowed if (allowReseed()) { if (reseedInProgress) { // While reseed occurring, show status message instead buf.append("").append(_context.netDb().reseedChecker().getStatus()).append("
"); } else { // While no reseed occurring, show reseed link long nonce = _context.random().nextLong(); String prev = System.getProperty("net.i2p.router.web.ReseedHandler.nonce"); if (prev != null) System.setProperty("net.i2p.router.web.ReseedHandler.noncePrev", prev); System.setProperty("net.i2p.router.web.ReseedHandler.nonce", nonce+""); String uri = getRequestURI(); buf.append("

\n"); buf.append("\n"); buf.append("

\n"); } } // If a new reseed ain't running, and the last reseed had errors, show error message if (!reseedInProgress) { String reseedErrorMessage = _context.netDb().reseedChecker().getError(); if (reseedErrorMessage.length() > 0) { buf.append("").append(reseedErrorMessage).append("
"); } } if (buf.length() <= 0) return ""; return buf.toString(); } private NewsHelper _newshelper; public void storeNewsHelper(NewsHelper n) { _newshelper = n; } public NewsHelper getNewsHelper() { return _newshelper; } public List getSummaryBarSections(String page) { String config = ""; if ("home".equals(page)) { config = _context.getProperty(PROP_SUMMARYBAR + page, DEFAULT_MINIMAL); } else { config = _context.getProperty(PROP_SUMMARYBAR + page); if (config == null) config = _context.getProperty(PROP_SUMMARYBAR + "default", DEFAULT_FULL); } return Arrays.asList(config.split("" + S)); } static void saveSummaryBarSections(RouterContext ctx, String page, Map sections) { StringBuilder buf = new StringBuilder(512); for(String section : sections.values()) buf.append(section).append(S); ctx.router().saveConfig(PROP_SUMMARYBAR + page, buf.toString()); } /** output the summary bar to _out */ public void renderSummaryBar() throws IOException { SummaryBarRenderer renderer = new SummaryBarRenderer(_context, this); renderer.renderSummaryHTML(_out); } /* below here is stuff we need to get from summarynoframe.jsp to SummaryBarRenderer */ private String _action; public void setAction(String s) { _action = s == null ? null : DataHelper.stripHTML(s); } public String getAction() { return _action; } private String _consoleNonce; public void setConsoleNonce(String s) { _consoleNonce = s == null ? null : DataHelper.stripHTML(s); } public String getConsoleNonce() { return _consoleNonce; } private String _updateNonce; public void setUpdateNonce(String s) { _updateNonce = s == null ? null : DataHelper.stripHTML(s); } public String getUpdateNonce() { return _updateNonce; } private String _requestURI; public void setRequestURI(String s) { _requestURI = s == null ? null : DataHelper.stripHTML(s); } /** * @return non-null; "/home" if (strangely) not set by jsp */ public String getRequestURI() { return _requestURI != null ? _requestURI : "/home"; } public String getConfigTable() { String[] allSections = SummaryBarRenderer.ALL_SECTIONS; Map sectionNames = SummaryBarRenderer.SECTION_NAMES; List sections = getSummaryBarSections("default"); TreeSet sortedSections = new TreeSet(); for (int i = 0; i < allSections.length; i++) { String section = allSections[i]; if (!sections.contains(section)) sortedSections.add(section); } String theme = _context.getProperty(CSSHelper.PROP_THEME_NAME, CSSHelper.DEFAULT_THEME); String imgPath = CSSHelper.BASE_THEME_PATH + theme + "/images/"; StringBuilder buf = new StringBuilder(2048); buf.append("\n"); for (String section : sections) { int i = sections.indexOf(section); buf.append("\n"); } buf.append("" + "") .append("
") .append(_("Remove")) .append("") .append(_("Name")) .append("") .append(_("Order")) .append("
") .append(_(sectionNames.get(section))) .append(""); if (i > 0) { buf.append(""); buf.append(""); } buf.append(""); if (i < sections.size() - 1) { buf.append(""); buf.append(""); } buf.append("
" + "") .append(_("Add")).append(": " + "\n" + "" + "
\n"); return buf.toString(); } }