Issue 639 prints in cdxj

ipwb/__main__.py

@@ -1,26 +1,23 @@
-import sys
-import os
 import argparse
-import tempfile
-import string  # For generating a temp file for stdin
 import random  # For generating a temp file for stdin
-from .__init__ import __version__ as ipwbVersion
+import string  # For generating a temp file for stdin
+import sys
+import tempfile
 
 # ipwb modules
-from . import replay
-from . import indexer
-from . import util as ipwbUtil
-
-from .util import IPWBREPLAY_HOST, IPWBREPLAY_PORT
+from ipwb import settings, replay, indexer, util
+from ipwb.error_handler import exception_logger
+from .__init__ import __version__ as ipwb_version
 
 
+@exception_logger(catch=not settings.DEBUG)
 def main():
     checkArgs(sys.argv)
 
 
 def checkArgs_index(args):
-    if not ipwbUtil.isDaemonAlive():
-        sys.exit()
+    util.check_daemon_is_alive()
+
     encKey = None
     compressionLevel = None
     if args.e:
@@ -139,17 +136,17 @@ def checkArgs(argsIn):
         '-d', '--daemon',
         help=("Multi-address of IPFS daemon "
               "(default /dns/localhost/tcp/5001/http)"),
-        default=ipwbUtil.IPFSAPI_MUTLIADDRESS,
+        default=util.IPFSAPI_MUTLIADDRESS,
         dest='daemon_address')
     parser.add_argument(
         '-v', '--version', help='Report the version of ipwb', action='version',
-        version='InterPlanetary Wayback ' + ipwbVersion)
+        version=f'InterPlanetary Wayback {ipwb_version}')
     parser.add_argument(
         '-u', '--update-check',
         action='store_true',
         help='Check whether an updated version of ipwb is available'
         )
-    parser.set_defaults(func=ipwbUtil.checkForUpdate)
+    parser.set_defaults(func=util.checkForUpdate)
 
     argCount = len(argsIn)
     cmdList = ['index', 'replay']

ipwb/error_handler.py

@@ -0,0 +1,42 @@
+import functools
+import logging
+from typing import Callable
+
+logger = logging.getLogger('ipwb')
+
+
+def exception_logger(catch=True, exception_class=Exception):
+    """
+    Decorator which catches exceptions in the function and logs them.
+
+    Usage:
+
+    ```python
+    @exception_logger()
+    def decorated_function(foo, bar):
+        do_something
+    ```
+
+    `exception_logger()` will catch any exception which happens in
+    `decorated_function()` while it is being executed, and log an error using
+    Python built in `logging` library.
+
+    Unless `catch` argument is `False` - in which case the exception will be
+    reraised.
+    """
+    def decorator(f: Callable):
+        @functools.wraps(f)
+        def wrapper(*args, **kwargs):
+            try:
+                return f(*args, **kwargs)
+
+            except exception_class as err:
+                if catch:
+                    logger.critical(str(err))
+
+                else:
+                    raise
+
+        return wrapper
+
+    return decorator

ipwb/exceptions.py

@@ -0,0 +1,2 @@
+class IPFSDaemonNotAvailable(Exception):
+    """IPFS Daemon is for some reason not available."""

ipwb/indexer.py

@@ -14,7 +14,6 @@
 import os
 import json
 import ipfshttpclient as ipfsapi
-import argparse
 import zlib
 import surt
 import ntpath
@@ -33,14 +32,10 @@
 from six import PY2
 from six import PY3
 
-from .util import iso8601ToDigits14
-from . import util as ipwbUtils
-
-# from warcio.archiveiterator import ArchiveIterator
+from ipwb.util import iso8601ToDigits14, ipfs_client
 
 import requests
 import datetime
-import shutil
 
 from bs4 import BeautifulSoup
 
@@ -52,11 +47,6 @@
 
 DEBUG = False
 
-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
     return bytes(s) if PY2 else bytes(s, 'utf-8')
@@ -367,20 +357,17 @@ def logError(errIn, end='\n'):
 
 
 def pullFromIPFS(hash):
-    global IPFS_API
-    return IPFS_API.cat(hash)
+    return ipfs_client().cat(hash)
 
 
 def pushBytesToIPFS(bytes):
     """
     Call the IPFS API to add the byte string to IPFS.
     When IPFS returns a hash, return this to the caller
     """
-    global IPFS_API
-
     # Returns unicode in py2.7, str in py3.7
     try:
-        res = IPFS_API.add_bytes(bytes)  # bytes)
+        res = ipfs_client().add_bytes(bytes)  # bytes)
     except TypeError as err:
         print('fail')
         logError('IPFS_API had an issue pushing the item to IPFS')

ipwb/replay.py

@@ -35,7 +35,8 @@
 
 from . import util as ipwbUtils
 from .backends import get_web_archive_index
-from .util import unsurt
+from .exceptions import IPFSDaemonNotAvailable
+from .util import unsurt, ipfs_client
 from .util import IPWBREPLAY_HOST, IPWBREPLAY_PORT
 from .util import INDEX_FILE
 
@@ -56,6 +57,10 @@
 from flask import send_from_directory
 from flask import make_response
 
+import logging
+
+logger = logging.getLogger(__name__)
+
 UPLOAD_FOLDER = tempfile.gettempdir()
 ALLOWED_EXTENSIONS = ('.warc', '.warc.gz')
 
@@ -64,12 +69,6 @@
 app.debug = False
 
 
-IPFS_API = ipwbUtils.createIPFSClient()
-if IPFS_API is None:
-    print("Error initializing IPFS API client")
-    sys.exit()
-
-
 @app.context_processor
 def formatters():
     return {'pluralize': lambda x, s, p: "{} {}".format(x, s if x == 1 else p)}
@@ -134,7 +133,6 @@ class UnsupportedIPFSVersions(Exception):
 
 @app.route('/ipfsdaemon/<cmd>')
 def commandDaemon(cmd):
-    global IPFS_API
     if cmd == 'status':
         return generateDaemonStatusButton()
     elif cmd == 'start':
@@ -143,10 +141,10 @@ def commandDaemon(cmd):
 
     elif cmd == 'stop':
         try:
-            installedIPFSVersion = IPFS_API.version()['Version']
+            installedIPFSVersion = ipfs_client().version()['Version']
             if ipwbUtils.compareVersions(installedIPFSVersion, '0.4.10') < 0:
                 raise UnsupportedIPFSVersions()
-            IPFS_API.shutdown()
+            ipfs_client().shutdown()
         except (subprocess.CalledProcessError, UnsupportedIPFSVersions) as e:
             if os.name != 'nt':  # Big hammer
                 subprocess.call(['killall', 'ipfs'])
@@ -593,13 +591,15 @@ def showLandingPage():
 
 
 def show_uri(path, datetime=None):
-    global IPFS_API
+    try:
+        ipwbUtils.check_daemon_is_alive(ipwbUtils.IPFSAPI_MUTLIADDRESS)
 
-    if not ipwbUtils.isDaemonAlive(ipwbUtils.IPFSAPI_MUTLIADDRESS):
+    except IPFSDaemonNotAvailable:
         errStr = ('IPFS daemon not running. '
                   'Start it using $ ipfs daemon on the command-line '
                   ' or from the <a href="/">'
                   'IPWB replay homepage</a>.')
+
         return Response(errStr, status=503)
 
     cdxjLine = ''
@@ -642,8 +642,8 @@ def handler(signum, frame):
         #    signal.signal(signal.SIGALRM, handler)
         #    signal.alarm(10)
 
-        payload = IPFS_API.cat(digests[-1])
-        header = IPFS_API.cat(digests[-2])
+        payload = ipfs_client().cat(digests[-1])
+        header = ipfs_client().cat(digests[-2])
 
         # if os.name != 'nt':  # Bug #310
         #    signal.alarm(0)
@@ -846,7 +846,14 @@ def extractResponseFromChunkedData(data):
 def generateDaemonStatusButton():
     text = 'Not Running'
     buttonText = 'Start'
-    if ipwbUtils.isDaemonAlive():
+
+    try:
+        ipwbUtils.check_daemon_is_alive()
+
+    except IPFSDaemonNotAvailable:
+        pass
+
+    else:
         text = 'Running'
         buttonText = 'Stop'
 
@@ -1034,12 +1041,11 @@ def start(cdxjFilePath, proxy=None):
     if not hostPort:
         ipwbUtils.setIPWBReplayConfig(IPWBREPLAY_HOST, IPWBREPLAY_PORT)
 
-    if ipwbUtils.isDaemonAlive():
-        ipwbUtils.setIPWBReplayIndexPath(cdxjFilePath)
-        app.cdxjFilePath = cdxjFilePath
-    else:
-        print('Sample data not pulled from IPFS.')
-        print('Check that the IPFS daemon is running.')
+    # This will throw an exception if daemon is not available.
+    ipwbUtils.check_daemon_is_alive()
+
+    ipwbUtils.setIPWBReplayIndexPath(cdxjFilePath)
+    app.cdxjFilePath = cdxjFilePath
 
     try:
         print((f'IPWB replay started on '

ipwb/settings.py

@@ -0,0 +1,35 @@
+"""Settings and configuration parameters of ipwb."""
+
+import os
+from logging import config as logging_config
+
+# Running in debug mode or not?
+DEBUG = os.environ.get('DEBUG', False)
+
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'standard': {
+            'format': '%(asctime)s [%(levelname)s] %(name)s: %(message)s'
+        }
+    },
+    'handlers': {
+        'console': {
+            'level': 'DEBUG' if DEBUG else 'INFO',
+            'formatter': 'standard',
+            'class': 'logging.StreamHandler',
+        },
+    },
+    'loggers': {
+        '': {
+            'handlers': ['console'],
+            'level': 'INFO',
+            'propagate': False
+        },
+    }
+}
+
+
+logging_config.dictConfig(LOGGING)