Merge pull request #42 from mensch272/bots

Hostable discord bot

Author: m-haisham

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added pre-commit checks for consistent style
 - Added pre-commit badge to README.md
 - Added change log to database migrations README.md
+- Added discord bot with (most functions are only available in private):
+  - Download novel to multiple formats
+  - Search for novels using a query
+- Added alternative method to acquire package version if importlib fails
 
 ### Changed
 

Procfile

@@ -0,0 +1 @@
+bot: python -m novelsave runbot discord

README.md

@@ -2,20 +2,21 @@
 
 ![PyPI](https://img.shields.io/pypi/v/novelsave)
 ![Python Version](https://img.shields.io/badge/Python-v3.8-blue)
-![Repo Size](https://img.shields.io/github/repo-size/mensch272/novelsave)
-[![Contributors](https://img.shields.io/github/contributors/mensch272/novelsave)](https://github.com/mensch272/novelsave/graphs/contributors)
 ![Last Commit](https://img.shields.io/github/last-commit/mensch272/novelsave/main)
 ![Issues](https://img.shields.io/github/issues/mensch272/novelsave)
 ![Pull Requests](https://img.shields.io/github/issues-pr/mensch272/novelsave)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/mensch272/novelsave/main.svg)](https://results.pre-commit.ci/latest/github/mensch272/novelsave/main)
 [![License](https://img.shields.io/github/license/mensch272/novelsave)](LICENSE)
+![Discord](https://img.shields.io/discord/911120379341307904)
 
 This is a tool to download and convert novels from popular sites to e-books.
 
 > **v0.7.+ is not compatible with previous versions**
 
 ## Install
 
+### Local
+
 ```bash
 pip install novelsave
 ```
@@ -26,6 +27,32 @@ or
 pip install git+https://github.com/mensch272/novelsave.git
 ```
 
+### Chatbots
+
+#### Discord
+
+Join our server: https://discord.gg/eFgtrKTFt3
+
+##### Environmental Variables
+
+The default environmental variables are shown below. Modify them to your liking when deploying.
+
+`DISCORD_TOKEN` is required, others are optional.
+
+```shell
+DISCORD_TOKEN=  # Required: discord bot token
+DISCORD_SESSION_TIMEOUT=10 # Minutes
+DISCORD_DOWNLOAD_THREADS=4
+DISCORD_SEARCH_LIMIT=20  # Maximum results to show
+DISCORD_SEARCH_DISABLED=no  # Disable search functionality
+```
+
+#### Heroku Deployment
+
+Fill out the following form and set the environmental variables.
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
+
 ## Usage
 
 ### Basic

novelsave/__init__.py

@@ -1,4 +1,15 @@
-from importlib.metadata import version
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("novelsave")
+except PackageNotFoundError:
+    import re
+    from pathlib import Path
+
+    pyproject = Path(__file__).parent.parent / "pyproject.toml"
+    with pyproject.open("r") as f:
+        text = f.read()
+
+    __version__ = re.search(r'version = "(.+?)"', text).group(1)
 
-__version__ = version("novelsave")
 __source__ = "https://github.com/mHaisham/novelsave"

novelsave/__main__.py

@@ -1,5 +1,11 @@
-from .cli import main
+import sys
 
+from novelsave.client import cli
 
 if __name__ == "__main__":
-    main()
+    if sys.argv[1:] == ["runbot", "discord"]:
+        from novelsave.client.bots import discord
+
+        discord.main()
+    else:
+        cli.main()

novelsave/client/__init__.py

@@ -0,0 +1,6 @@
+from . import config
+from . import containers
+from . import bot
+from . import session
+from . import endpoints
+from .main import main

novelsave/client/bots/__init__.py

@@ -0,0 +1,16 @@
+import sys
+
+from loguru import logger
+
+from . import config
+
+logger.configure(**config.logger_config())
+
+try:
+    from nextcord.ext import commands
+except ImportError as e:
+    logger.exception(e)
+    sys.exit(1)
+
+
+bot = commands.Bot("$")

novelsave/client/bots/discord/__init__.py

@@ -0,0 +1,20 @@
+from nextcord.ext import commands
+
+
+async def direct_only(ctx: commands.Context):
+    """Custom direct only check
+
+    This check returns true when one of the below checks are true
+    - The message author is bot owner and is invoked with help
+    - The message is not from a guild
+    """
+    if await ctx.bot.is_owner(ctx.author) and ctx.invoked_with == "help":
+        return True
+
+    if ctx.guild is not None:
+        raise commands.CheckFailure(
+            f"You may not use this command inside a guild. "
+            f"Use the '{ctx.clean_prefix}dm' to start a private session.",
+        )
+
+    return True

novelsave/client/bots/discord/bot.py

@@ -0,0 +1,69 @@
+import functools
+import os
+import sys
+from datetime import timedelta
+
+import dotenv
+from loguru import logger
+
+from novelsave.settings import config, console_formatter
+
+
+@functools.lru_cache()
+def app() -> dict:
+    """Initialize and return the configuration used by the base application"""
+    return config.copy()
+
+
+def logger_config() -> dict:
+    return {
+        "handlers": [
+            {
+                "sink": sys.stderr,
+                "level": "TRACE",
+                "format": console_formatter,
+                "backtrace": True,
+                "diagnose": True,
+            },
+            {
+                "sink": config["config"]["dir"] / "logs" / "{time}.log",
+                "level": "TRACE",
+                "retention": "3 days",
+                "encoding": "utf-8",
+            },
+        ]
+    }
+
+
+def intenv(key: str, default: int) -> int:
+    try:
+        return int(os.getenv(key))
+    except (TypeError, ValueError):
+        return default
+
+
+@functools.lru_cache()
+def discord() -> dict:
+    """Initialize and return discord configurations as a dict
+
+    The returned dict must contain 'DISCORD_TOKEN'
+    """
+    dotenv.load_dotenv()
+
+    discord_token = os.getenv("DISCORD_TOKEN")
+    if not discord_token:
+        logger.error("Required environment variable 'DISCORD_TOKEN' is not set.")
+
+    return {
+        "key": discord_token,
+        "session": {
+            "retain": timedelta(minutes=intenv("DISCORD_SESSION_TIMEOUT", 10)),
+        },
+        "download": {
+            "threads": intenv("DISCORD_DOWNLOAD_THREADS", 4),
+        },
+        "search": {
+            "limit": intenv("DISCORD_SEARCH_LIMIT", 20),
+            "disabled": os.getenv("DISCORD_SEARCH_DISABLED", "no").lower(),
+        },
+    }

novelsave/client/bots/discord/checks.py

@@ -0,0 +1,35 @@
+from dependency_injector import containers, providers
+
+from .endpoints import DownloadHandler, SearchHandler
+from .session import SessionHandler, Session
+
+
+class SessionContainer(containers.DeclarativeContainer):
+    config = providers.Configuration(strict=True)
+
+    session_factory = providers.Selector(
+        config.search.disabled,
+        no=providers.Singleton(
+            Session.factory,
+            session_retain=config.session.retain,
+            fragments=[DownloadHandler, SearchHandler],
+        ),
+        yes=providers.Singleton(
+            Session.factory,
+            session_retain=config.session.retain,
+            fragments=[DownloadHandler],
+        ),
+    )
+
+    session_handler = providers.Singleton(
+        SessionHandler, session_factory=session_factory
+    )
+
+
+class DiscordApplication(containers.DeclarativeContainer):
+    discord_config = providers.Configuration(strict=True)
+
+    session = providers.Container(
+        SessionContainer,
+        config=discord_config,
+    )

novelsave/client/bots/discord/config.py

@@ -0,0 +1,44 @@
+import functools
+
+from loguru import logger
+
+from .session import Session
+
+
+def ensure_close(func):
+    """Ensures that when this method ends the session will be closed"""
+
+    @functools.wraps(func)
+    def wrapped(*args, **kwargs):
+        session: Session = args[0].session
+
+        result = None
+        try:
+            result = func(*args, **kwargs)
+        except Exception as e:
+            if not session.is_closed:
+                session.send_sync(f"`❗ {str(e).strip()}`")
+
+            logger.exception(e)
+
+        if not session.is_closed:
+            session.sync(session.close_and_inform)
+
+        return result
+
+    return wrapped
+
+
+def log_error(func):
+    """Catches and logs errors from the method and propagates the exception"""
+
+    @functools.wraps(func)
+    def wrapped(*args, **kwargs):
+
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            logger.exception(e)
+            raise e
+
+    return wrapped

novelsave/client/bots/discord/containers.py

@@ -0,0 +1,4 @@
+from .commands import dm, sources
+from .session import SessionCog
+from .download import Download, DownloadHandler
+from .search import Search, SearchHandler

novelsave/client/bots/discord/decorators.py

@@ -0,0 +1,53 @@
+from dependency_injector.wiring import inject, Provide
+from loguru import logger
+from nextcord.ext import commands
+
+from novelsave.containers import Application
+from novelsave.core.services.source import BaseSourceService
+from .. import checks, mfmt
+from ..bot import bot
+
+
+@bot.command()
+async def dm(ctx: commands.Context):
+    """Send a direct message to you"""
+    await ctx.author.send(
+        f"Hello, {ctx.author.name}.\n"
+        f" Send `{ctx.clean_prefix}help` to get usage instructions."
+    )
+
+
+@bot.command()
+@commands.check(checks.direct_only)
+@inject
+async def sources(
+    ctx: commands.Context,
+    *args,
+    source_service: BaseSourceService = Provide[Application.services.source_service],
+):
+    """List all the sources supported"""
+    with ctx.typing():
+        await ctx.send(
+            f"The sources currently supported include (v{source_service.current_version}):"
+        )
+
+        source_list = "\n".join(
+            f"• `{'🔍' if gateway.is_search_capable else ' '}` <{gateway.base_url}>"
+            for gateway in sorted(
+                source_service.get_novel_sources(), key=lambda g: g.base_url
+            )
+        )
+
+        await ctx.send(source_list)
+        await ctx.send(
+            "You can request a new source by creating an issue at "
+            "<https://github.com/mensch272/novelsave/issues/new/choose>"
+        )
+
+
+@sources.error
+async def sources_error(ctx: commands.Context, error: Exception):
+    if isinstance(error, commands.CommandError):
+        await ctx.send(mfmt.error(str(error)))
+
+    logger.exception(repr(error))