Merge pull request #611 from oduwsdl/issue-610

Fix semantics of host/port as @ibnesayeed recommended in #609

ipwb/__main__.py

@@ -8,18 +8,18 @@
 # ipwb modules
 from . import replay
 from . import indexer
-from . import util
+from . import util as ipwbUtil
 
-from .util import IPFSAPI_HOST, IPFSAPI_PORT, IPWBREPLAY_HOST, IPWBREPLAY_PORT
+from .util import IPWBREPLAY_HOST, IPWBREPLAY_PORT
 
 
 def main():
-    util.checkForUpdate()
+    ipwbUtil.checkForUpdate()
     args = checkArgs(sys.argv)
 
 
 def checkArgs_index(args):
-    if not util.isDaemonAlive():
+    if not ipwbUtil.isDaemonAlive():
         sys.exit()
     encKey = None
     compressionLevel = None
@@ -137,8 +137,9 @@ def checkArgs(argsIn):
 
     parser.add_argument(
         '-d', '--daemon',
-        help='Location of ipfs daemon (default 127.0.0.1:5001)',
-        default='{0}:{1}'.format(IPFSAPI_HOST, IPFSAPI_PORT),
+        help=("Multi-address of IPFS daemon "
+              "(default /dns/localhost/tcp/5001/http)"),
+        default=ipwbUtil.IPFSAPI_MUTLIADDRESS,
         dest='daemon_address')
     parser.add_argument(
         '-v', '--version', help='Report the version of ipwb', action='version',

ipwb/indexer.py

@@ -33,8 +33,8 @@
 from six import PY2
 from six import PY3
 
-from .util import IPFSAPI_HOST, IPFSAPI_PORT
 from .util import iso8601ToDigits14
+from . import util as ipwbUtils
 
 # from warcio.archiveiterator import ArchiveIterator
 
@@ -52,7 +52,10 @@
 
 DEBUG = False
 
-IPFS_API = ipfsapi.Client(f"/dns/{IPFSAPI_HOST}/tcp/{IPFSAPI_PORT}/http")
+IPFS_API = ipwbUtils.createIPFSClient()
+if IPFS_API is None:
+    print("Error initializing IPFS API client")
+    sys.exit()
 
 
 def s2b(s):  # Convert str to bytes, cross-py

ipwb/replay.py

@@ -41,7 +41,7 @@
 
 from . import util as ipwbUtils
 from .util import unsurt
-from .util import IPFSAPI_HOST, IPFSAPI_PORT, IPWBREPLAY_HOST, IPWBREPLAY_PORT
+from .util import IPWBREPLAY_HOST, IPWBREPLAY_PORT
 from .util import INDEX_FILE
 
 from . import indexer
@@ -68,7 +68,11 @@
 app.config['UPLOAD_FOLDER'] = UPLOAD_FOLDER
 app.debug = False
 
-IPFS_API = ipfsapi.Client(f"/dns/{IPFSAPI_HOST}/tcp/{IPFSAPI_PORT}/http")
+
+IPFS_API = ipwbUtils.createIPFSClient()
+if IPFS_API is None:
+    print("Error initializing IPFS API client")
+    sys.exit()
 
 
 @app.context_processor
@@ -552,9 +556,8 @@ def all_exception_handler(error):
 
 @app.route('/ipwbadmin', strict_slashes=False)
 def showAdmin():
-    ipfsEndpoint = '{0}:{1}'.format(IPFSAPI_HOST, IPFSAPI_PORT)
     status = {'ipwbVersion': ipwbVersion,
-              'ipfsEndpoint': ipfsEndpoint}
+              'ipfsEndpoint': ipwbUtils.IPFSAPI_MUTLIADDRESS}
     iFile = ipwbUtils.getIPWBReplayIndexPath()
 
     mementoInfo = calculateMementoInfoInIndex(iFile)
@@ -605,8 +608,7 @@ def showLandingPage():
 def show_uri(path, datetime=None):
     global IPFS_API
 
-    daemonAddress = '{0}:{1}'.format(IPFSAPI_HOST, IPFSAPI_PORT)
-    if not ipwbUtils.isDaemonAlive(daemonAddress):
+    if not ipwbUtils.isDaemonAlive(ipwbUtils.IPFSAPI_MUTLIADDRESS):
         errStr = ('IPFS daemon not running. '
                   'Start it using $ ipfs daemon on the command-line '
                   ' or from the <a href="/">'

ipwb/util.py

@@ -23,12 +23,18 @@
 
 # from requests.exceptions import ConnectionError
 from ipfshttpclient.exceptions import ConnectionError
+from ipfshttpclient.exceptions import AddressError
+from multiaddr.exceptions import StringParseError
 
+IPFSAPI_MUTLIADDRESS = '/dns/localhost/tcp/5001/http'
+# or '/dns/{host}/tcp/{port}/http'
+# or '/ip4/{ipaddress}/tcp/{port}/http'
+# or '/ip6/{ipaddress}/tcp/{port}/http
 
-IPFSAPI_HOST = 'localhost'
-IPFSAPI_PORT = 5001
-IPWBREPLAY_HOST = 'localhost'
-IPWBREPLAY_PORT = 5000
+IPWBREPLAY_ADDRESS = 'localhost:5000'
+
+(IPWBREPLAY_HOST, IPWBREPLAY_PORT) = IPWBREPLAY_ADDRESS.split(':')
+IPWBREPLAY_PORT = int(IPWBREPLAY_PORT)
 
 INDEX_FILE = 'samples/indexes/salam-home.cdxj'
 
@@ -39,16 +45,26 @@
 dtPattern = re.compile(r"^(\d{4})(\d{2})?(\d{2})?(\d{2})?(\d{2})?(\d{2})?$")
 
 
-def isDaemonAlive(hostAndPort="{0}:{1}".format(IPFSAPI_HOST, IPFSAPI_PORT)):
+def createIPFSClient(daemonMultiaddr=IPFSAPI_MUTLIADDRESS):
+    try:
+        return ipfsapi.Client(daemonMultiaddr)
+    except (StringParseError, AddressError):
+        return None  # Malformed multiaddress for the daemon
+
+
+def isDaemonAlive(daemonMultiaddr=IPFSAPI_MUTLIADDRESS):
     """Ensure that the IPFS daemon is running via HTTP before proceeding"""
-    client = ipfsapi.Client(f"/dns/{IPFSAPI_HOST}/tcp/{IPFSAPI_PORT}/http")
+    client = createIPFSClient()
+    if client is None:
+        print("Error initializing IPFS API client")
+        return False
 
     try:
         # ConnectionError/AttributeError if IPFS daemon not running
         client.id()
         return True
     except (ConnectionError):  # exceptions.AttributeError):
-        logError("Daemon is not running at http://" + hostAndPort)
+        logError("Daemon is not running at " + daemonMultiaddr)
         return False
     except OSError:
         logError("IPFS is likely not installed. "