add help pages for i2pcontrol and torrents

2021-05-26 15:11:46 -04:00
parent ffa282671b
commit d285063b4f
9 changed files with 97 additions and 12 deletions
--- a/content.js
+++ b/content.js
@@ -80,3 +80,14 @@ fetch("http://127.0.0.1:7657/themes/console/light/images/i2plogo.png")
    var consoleLinks = document.querySelectorAll(".application-info");
    hide(consoleLinks);
  });
+
+fetch("http://127.0.0.1:7657/jsonrpc/")
+  .then((myJson) => {
+    var toopieLinks = document.querySelectorAll(".window-visit-toopie");
+    unhide(toopieLinks);
+  })
+  .catch((error) => {
+    var toopieLinks = document.querySelectorAll(".window-visit-toopie");
+    hide(toopieLinks);
+  });
+
--- a/home.html
+++ b/home.html
@@ -86,8 +86,8 @@
                        </div>
                    </li>-->

-                    <li class="application">
-                        <a class="applicationName" href="toopie.html" id="window-visit-toopie">Toopie</a> <span class="applicationDesc" id="toopie">For information about your I2P router status, go here:</span>
+                    <li class="application window-visit-toopie">
+                        <a class="applicationName window-visit-toopie" href="toopie.html" id="window-visit-toopie">Toopie</a> <span class="applicationDesc window-visit-toopie" id="toopie">For information about your I2P router status, go here:</span>
                    </li>

                    <li class="application">
@@ -147,5 +147,6 @@
    </div>
    <script src="home.js" type="text/javascript"></script> 
    <script src="content.js" type="text/javascript"></script> <!--</div>-->
+    <script src="i2pcontrol/i2pcontrol.js" type="text/javascript"></script> <!--</div>-->
 </body>
 </html>
--- a/i2pcontrol/README.md
+++ b/i2pcontrol/README.md
@@ -1,5 +1,8 @@
-i2pcontrol.js
-=============
+toopie.html/i2pcontrol.js
+=========================

-This is inside of the webextension for now, but it's actually a fully-fledged,
-standalone library for talking to i2pcontrol.
+To enable toopie.html, the built in I2P monitoring system in this webextension,
+go to the [Web App Configuration page in the I2P Router and start I2PControl](http://127.0.0.1:7657/configwebapps).
+Click the "Start" button next to the menu item that says `jsonrpc`.
+
+- ![i2pcontrol.png](i2pcontrol.png)
--- a/i2pcontrol/i2pcontrol.js
+++ b/i2pcontrol/i2pcontrol.js
@@ -383,9 +383,30 @@ function UpdateContents() {
 }

 var done = Echo(hello);
-done.then(Done);
+done.then(Done).catch(Done);

 function Done(output) {
+  function hide(elements) {
+    elements = elements.length ? elements : [elements];
+    for (var index = 0; index < elements.length; index++) {
+      elements[index].style.display = "none";
+    }
+  }
+
+  function unhide(elements) {
+    elements = elements.length ? elements : [elements];
+    for (var index = 0; index < elements.length; index++) {
+      elements[index].style.display = "inline-block";
+    }
+  }
+
  console.log("(i2pcontrol) I2PControl connection tested,", output);
+  if (output == hello) {
+    var toopieLinks = document.querySelectorAll(".window-visit-toopie");
+    unhide(toopieLinks);
+  }else{
+    var toopieLinks = document.querySelectorAll(".window-visit-toopie");
+    hide(toopieLinks);
+  }
  return output;
 }
--- a/i2pcontrol/i2pcontrol.png
+++ b/i2pcontrol/i2pcontrol.png
--- a/i2pcontrol/index.html
+++ b/i2pcontrol/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>I2P in Private Browsing Mode</title>
+  <link rel="stylesheet" type="text/css" href="../home.css" />
+  <link rel="stylesheet" type="text/css" href="../sidebar.css" />
+</head>
+<body>
+
+<h1 id="toopie.htmli2pcontrol.js">toopie.html/i2pcontrol.js</h1>
+<p>To enable toopie.html, the built in I2P monitoring system in this webextension, go to the <a href="http://127.0.0.1:7657/configwebapps">Web App Configuration page in the I2P Router and start I2PControl</a>. Click the “Start” button next to the menu item that says <code>jsonrpc</code>.</p>
+<ul>
+<li><img src="i2pcontrol.png" title="fig:" alt="i2pcontrol.png" /></li>
+</ul>
+
+</body>
+</html>
--- a/info.js
+++ b/info.js
@@ -123,6 +123,12 @@ document.addEventListener("click", (clickEvent) => {
  } else if (clickEvent.target.id === "window-visit-index") {
    console.log("attempting to create index tab");
    goIndex();
+  } else if (clickEvent.target.id === "window-visit-torrent") {
+    console.log("attempting to create torrent tab");
+    goTorrent();
+  } else if (clickEvent.target.id === "window-visit-help") {
+    console.log("attempting to create torrent tab");
+    goHelp();
  } else if (clickEvent.target.id === "window-visit-homepage") {
    console.log("attempting to create homepage tab");
    goHome();
@@ -226,7 +232,7 @@ function goHome() {

 function goIndex() {
  function onTabError() {
-    console.log("Help tab created");
+    console.log("Help tab not created");
  }
  let createData = {
    url: "index.html",
@@ -236,6 +242,30 @@ function goIndex() {
  creating.then(onTabCreated, onTabError);
 }

+function goTorrent() {
+  function onTabError() {
+    console.log("Torrent Help tab not created");
+  }
+  let createData = {
+    url: "torrent/index.html",
+  };
+  console.log("visiting torrent help");
+  let creating = browser.tabs.create(createData);
+  creating.then(onTabCreated, onTabError);
+}
+
+function goHelp() {
+  function onTabError() {
+    console.log("Torrent Help tab not created");
+  }
+  let createData = {
+    url: "i2pcontrol/index.html",
+  };
+  console.log("visiting torrent help");
+  let creating = browser.tabs.create(createData);
+  creating.then(onTabCreated, onTabError);
+}
+
 function goToopie() {
  function onTabError() {
    console.log("Toopie tab created");
--- a/torrent/README.md
+++ b/torrent/README.md
@@ -1,4 +1,4 @@
-Acknowledgement
+Acknowledgementindex
 ===============

 **Many, many thanks to the [Transmitter](https://github.com/myfreeweb/transmitter)
@@ -33,7 +33,7 @@ To install the plugin, go to [http://127.0.0.1:7657/configplugins](http://127.0.
 and scroll down to the section of the page where it says "Installation from URL"
 and paste the following URL:

-```http://stats.i2p/i2p/plugins/i2psnark-rpc.su3```
+`http://stats.i2p/i2p/plugins/i2psnark-rpc.su3`

 Click the "Install Plugin" button and you'll be ready to go. Now, open the
 extension options menu, and just click "Save." The defaults are correct for use
--- a/window.html
+++ b/window.html
@@ -84,9 +84,9 @@
                <p id="applicationExplain">These applications use I2P to provide them with security and privacy.</p>

                <ul>
-                    <li class="application"><button class="applicationName window-visit-homepage" href="#" id="window-visit-index" target="_blank">Help Page</button> <span class="applicationDesc" id="abouthome">For more information about this extension, go here:</span></li>
+                    <li class="application"><button class="applicationName window-visit-help" href="#" id="window-visit-help" target="_blank">Help Page</button> <span class="applicationDesc" id="abouthome">For more information about this extension, go here:</span></li>

-                    <li class="application"><button class="applicationName window-visit-toopie" href="#" id="window-visit-toopie" target="_blank">Toopie</button> <span class="applicationDesc" id="toopie">For information about your I2P router status, go here:</span></li>
+                    <li class="application window-visit-toopie"><button class="applicationName window-visit-toopie" href="#" id="window-visit-toopie" target="_blank">Toopie</button> <span class="applicationDesc window-visit-toopie" id="toopie">For information about your I2P router status, go here:</span></li>

                    <li class="application"><button class="applicationName" id="window-visit-i2ptunnel" target="_blank">Hidden Services Manager</button> <span class="applicationDesc" id="i2ptunnel">I2P has a web-based interface for configuring .i2p services like web sites, to set up your own web sites, go here:</span></li>

@@ -113,6 +113,8 @@
                <br>
                The server address is not set yet.
                <br>
+                <a class="torrent-opener" id="window-visit-torrent" href="#">For assistance, visit the torrent help page</a>.
+                <br>
                <a class="config-opener" href="#">Open the settings</a> to continue.
            </div>