Merge pull request 'Update dependency black to v23' (#99) from renovate/black-23.x into master

Reviewed-on: #99

.drone.yml

@@ -4,7 +4,7 @@ type: docker
 
 steps:
   - name: lint
-    image: python:3.8-slim
+    image: python:3.8
     commands:
       - pip install poetry
       - poetry install
@@ -23,7 +23,7 @@ steps:
         from_secret: docker_password
 
   - name: publish
-    image: python:3.8-slim
+    image: python:3.8
     commands:
       - pip install poetry
       - poetry publish --build

.env.dist

@@ -1 +1,3 @@
 DISCORD_TOKEN=
+OAUTH2_CLIENT_ID=
+OAUTH2_CLIENT_SECRET=

.flake8

@@ -1,2 +1,2 @@
 [flake8]
-max-line-length = 100
+max-line-length = 88

Dockerfile

@@ -1,10 +1,10 @@
-FROM python:3.10.7-slim as build
+FROM python:3.11.1 as build
 
 WORKDIR /app
 COPY . .
 RUN pip install poetry && poetry build
 
-FROM python:3.10.7-slim
+FROM python:3.11.1
 
 COPY --from=build /app/dist /tmp/dist
 RUN pip install /tmp/dist/*.whl && rm -rf /tmp/dist

README.md

@@ -13,21 +13,37 @@ Simple website that guides you to invite a bot to read and format scheduled even
 - Go to the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
 - Enable the `Build-A-Bot` option in the `Bot` panel.
 - Click on `Reset Token` and keep it in a safe place, you will need it.
+- Click on `Reset Secret` in the `OAuth2` panel, copy both `Client ID` and `Client Secret` and keep it in a safe place, you will need it.
 - Configure the rest of your app and bot as you like (name, icon, username, etc.)
 
 ### 2) With Docker
 
 - Install [Docker](https://docs.docker.com/get-docker/)
-- Run `docker run -p 5000 -e DISCORD_TOKEN=your_bot_token xefir/divent`
-- The app is accessible at http://localhost:5000
+- Run
+```bash
+docker run -p 5000 \
+    -e DISCORD_TOKEN=your_bot_token \
+    -e OAUTH2_CLIENT_ID=your_client_id \
+    -e OAUTH2_CLIENT_SECRET=your_client_secret \
+    xefir/divent
+```
 
 ### 2) Without Docker
 
 - Install [Python 3](https://www.python.org/downloads/)
-- Install [Pip](https://pip.pypa.io/en/stable/installing/)
+- Install [Pip](https://pip.pypa.io/en/stable/installation/)
 - Run `pip install divent`
-- Run `DISCORD_TOKEN=your_bot_token divent`
-- The app is accessible at http://localhost:5000
+- Run
+```bash
+DISCORD_TOKEN=your_bot_token \
+OAUTH2_CLIENT_ID=your_client_id \
+OAUTH2_CLIENT_SECRET=your_client_secret \
+divent
+```
+
+### 3) Open your browser
+
+The app is accessible at http://localhost:5000
 
 ## Links
 

divent/bot.py

@@ -1,32 +1,46 @@
 import json
 import logging
 from datetime import datetime, timedelta
-from os import environ, path
-from typing import Optional
+from functools import wraps
+from os import getenv, path
+from typing import Dict, Optional
 
 from disnake import Client, Guild
 from dotenv import load_dotenv
 from ics import Calendar, ContentLine, Event
 from ics.alarm import DisplayAlarm
-from quart import Quart, redirect, render_template, request, url_for
+from oauthlib.oauth2 import TokenExpiredError
+from quart import Quart, redirect, render_template, request, session, url_for
+from requests_oauthlib import OAuth2Session  # type: ignore
 import sentry_sdk
 from sentry_sdk.integrations.quart import QuartIntegration
 from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware  # type: ignore
 
+
 load_dotenv()
 
-QUART_DEBUG = environ.get("QUART_DEBUG", False)
-DISCORD_TOKEN = environ.get("DISCORD_TOKEN")
+DISCORD_TOKEN = getenv("DISCORD_TOKEN")
+OAUTH2_CLIENT_ID = getenv("OAUTH2_CLIENT_ID")
+OAUTH2_CLIENT_SECRET = getenv("OAUTH2_CLIENT_SECRET")
 if not DISCORD_TOKEN:
     raise Exception("Missing DISCORD_TOKEN")
+if not OAUTH2_CLIENT_ID:
+    raise Exception("Missing OAUTH2_CLIENT_ID")
+if not OAUTH2_CLIENT_SECRET:
+    raise Exception("Missing OAUTH2_CLIENT_SECRET")
 
+QUART_DEBUG = getenv("QUART_DEBUG", False)
 if QUART_DEBUG:
     logging.basicConfig(level=logging.DEBUG)
 
-SENTRY_DSN = environ.get("SENTRY_DSN")
+SENTRY_DSN = getenv("SENTRY_DSN")
 if SENTRY_DSN:
     sentry_sdk.init(SENTRY_DSN, integrations=[QuartIntegration()])
 
+API_BASE_URL = getenv("API_BASE_URL", "https://discordapp.com/api")
+AUTHORIZATION_BASE_URL = f"{API_BASE_URL}/oauth2/authorize"
+TOKEN_URL = f"{API_BASE_URL}/oauth2/token"
+
 
 class Discord(Client):
     async def on_ready(self):
@@ -35,6 +49,7 @@ class Discord(Client):
 
 client = Discord()
 app = Quart(__name__)
+app.config["SECRET_KEY"] = OAUTH2_CLIENT_SECRET
 app.asgi_app = ProxyHeadersMiddleware(app.asgi_app, "*")  # type: ignore
 
 
@@ -60,6 +75,28 @@ async def not_found(error: Exception):
     return await render_template("error.html.j2", error=str(error)), 404
 
 
+def token_updater(token: str):
+    session["oauth2_token"] = token
+
+
+def make_session(
+    token: Optional[Dict[str, str]] = None, state: Optional[str] = None
+) -> OAuth2Session:
+    return OAuth2Session(
+        client_id=OAUTH2_CLIENT_ID,
+        token=token,
+        state=state,
+        scope=["identify", "guilds"],
+        redirect_uri=f"{request.host_url}callback",
+        auto_refresh_kwargs={
+            "client_id": OAUTH2_CLIENT_ID,
+            "client_secret": OAUTH2_CLIENT_SECRET,
+        },
+        auto_refresh_url=TOKEN_URL,
+        token_updater=token_updater,
+    )
+
+
 def i18n(str: str) -> str:
     lang = request.accept_languages.best_match(["en", "fr"])
 
@@ -84,27 +121,105 @@ def days_before_failure() -> int:
     return nextDelta.days
 
 
+def cdn_avatar_url(user_id: int, hash: str) -> str:
+    ext = "gif" if hash.startswith("a_") else "png"
+    return f"https://cdn.discordapp.com/avatars/{user_id}/{hash}.{ext}"
+
+
 @app.context_processor
 def context_processor():
-    return dict(_=i18n, client=client, days_before_failure=days_before_failure())
+    return dict(
+        _=i18n,
+        client=client,
+        cdn_avatar_url=cdn_avatar_url,
+        days_before_failure=days_before_failure(),
+    )
+
+
+def login_required(fn):
+    @wraps(fn)
+    async def wrapper(*args, **kwargs):
+        if session.get("oauth2_token"):
+            return await fn(*args, **kwargs)
+
+        session["redirect_url"] = request.path
+        return redirect(url_for(".login"))
+
+    return wrapper
 
 
 @app.route("/")
 async def index():
-    guild_id = request.args.get("guild")
-    guild = get_guild_by_id(guild_id)
+    return await render_template("index.html.j2")
+
+
+@app.route("/login")
+async def login():
+    discord = make_session()
+    authorization_url, state = discord.authorization_url(AUTHORIZATION_BASE_URL)
+    session["oauth2_state"] = state
+    return redirect(authorization_url)
+
+
+@app.route("/callback")
+async def callback():
+    request_values = await request.values
+    if request_values.get("error"):
+        return errorhandler(request_values.get("error"))
+
+    discord = make_session(state=session.get("oauth2_state"))
+    token = discord.fetch_token(
+        TOKEN_URL,
+        client_secret=OAUTH2_CLIENT_SECRET,
+        authorization_response=request.url,
+    )
+    token_updater(token)
+    return redirect(session.pop("redirect_url", url_for(".guilds")))
+
+
+@app.route("/guilds")
+@login_required
+async def guilds():
+    guild = get_guild_by_id(request.args.get("guild"))
 
     if guild:
-        return redirect(url_for(".subscribe", guild_id=guild_id))
+        return redirect(
+            url_for(".subscribe", guild_id=guild.vanity_url_code or guild.id)
+        )
 
-    return await render_template("index.html.j2")
+    try:
+        discord = make_session(token=session.get("oauth2_token"))
+        user = discord.get(f"{API_BASE_URL}/users/@me").json()
+        user_guilds = discord.get(f"{API_BASE_URL}/users/@me/guilds").json()
+    except TokenExpiredError:
+        return redirect(url_for(".login"))
+
+    common_guilds = []
+    for bot_guild in client.guilds:
+        for user_guild in user_guilds:
+            if str(bot_guild.id) == user_guild["id"]:
+                common_guilds.append(bot_guild)
+
+    return await render_template(
+        "guilds.html.j2", user=user, common_guilds=common_guilds
+    )
 
 
 @app.route("/subscribe/<guild_id>")
+@login_required
 async def subscribe(guild_id: str):
     guild = get_guild_by_id(guild_id)
     if guild is None:
-        return redirect(url_for(".index"))
+        return redirect(url_for(".login"))
+
+    try:
+        discord = make_session(token=session.get("oauth2_token"))
+        user_guilds = discord.get(f"{API_BASE_URL}/users/@me/guilds").json()
+    except TokenExpiredError:
+        return redirect(url_for(".login"))
+
+    if not any(str(guild.id) == user_guild["id"] for user_guild in user_guilds):
+        return redirect(url_for(".login"))
 
     return await render_template("subscribe.html.j2", guild=guild)
 
@@ -113,10 +228,13 @@ async def subscribe(guild_id: str):
 async def ical(guild_id: str):
     guild = get_guild_by_id(guild_id)
     if guild is None:
-        return redirect(url_for(".index"))
+        return redirect(url_for(".login"))
 
     calendar = Calendar()
 
+    calendar.extra.append(ContentLine(name="REFRESH-INTERVAL", value="PT1H"))
+    calendar.extra.append(ContentLine(name="X-PUBLISHED-TTL", value="PT1H"))
+
     calendar.extra.append(ContentLine(name="NAME", value=guild.name))
     calendar.extra.append(ContentLine(name="X-WR-CALNAME", value=guild.name))
 
@@ -148,6 +266,7 @@ async def ical(guild_id: str):
     return calendar.serialize()
 
 
-quart_task = client.loop.create_task(app.run_task("0.0.0.0"))
-quart_task.add_done_callback(lambda f: client.loop.stop())
-client.run(DISCORD_TOKEN)
+def __main__():
+    quart_task = client.loop.create_task(app.run_task("0.0.0.0"))
+    quart_task.add_done_callback(lambda f: client.loop.stop())
+    client.run(DISCORD_TOKEN)

divent/templates/base.html.j2

@@ -18,7 +18,7 @@
             {% endblock content %}
         </div>
         <footer>
-            {% include 'footer.html.j2' %}
+            {% include "footer.html.j2" %}
         </footer>
     </body>
 </html>

divent/templates/guilds.html.j2

@@ -0,0 +1,55 @@
+{% extends "base.html.j2" %}
+{% block content %}
+    <form action="{{ url_for(".guilds") }}" method="get">
+        <div id="box">
+            <div id="avatars">
+                <img src="{{ client.user.display_avatar }}"
+                     alt="{{ _('Bot Logo') }}"
+                     width="80"
+                     height="80"/>
+                <span id="dots">…</span>
+                <img src="{{ cdn_avatar_url(user.id, user.avatar) }}"
+                     alt="{{ _('User Avatar') }}"
+                     width="80"
+                     height="80"/>
+            </div>
+            <h1>
+                <a href="{{ url_for(".index") }}">{{ client.user.display_name }}</a>
+            </h1>
+            <h3>{{ _('Choose a server:') }}</h3>
+            <select name="guild" class="black_input">
+                <option>
+                    &nbsp;
+                </option>
+                {% for guild in common_guilds %}
+                    <option value="{{ guild.vanity_url_code|default(guild.id, True) }}">
+                        {{ guild.name }}
+                    </option>
+                {% endfor %}
+            </select>
+            <div class="hr-sect">{{ _("OR") }}</div>
+            <a class="button"
+               target="_blank"
+               href="https://discord.com/api/oauth2/authorize?client_id={{ client.user.id }}&permissions=8589934592&scope=bot">
+                {{ _("Add the bot on your server") }}
+            </a>
+            <ul>
+                <li>
+                    {{ _("You must have") }}
+                    <strong>{{ _("Manage Server") }}</strong>
+                    {{ _("permission on this server to perform this action") }}
+                </li>
+                <li>
+                    {{ _("After adding the bot,") }}
+                    <a href="{{ url_for(".guilds") }}">
+                        <i class="fa fa-refresh"></i>
+                        <strong>{{ _("reload the page") }}</strong>
+                    </a>
+                </li>
+            </ul>
+        </div>
+        <div id="buttons">
+            <input type="submit" class="button" value="{{ _("Let's go!") }}"/>
+        </div>
+    </form>
+{% endblock content %}

divent/templates/index.html.j2

@@ -24,41 +24,9 @@
                     {{ _('Throwing you to a new isekai world') }}
                 </li>
             </ul>
-            <hr />
-            <h3>{{ _('Choose a server:') }}</h3>
-            <select name="guild" class="black_input">
-                <option>
-                    &nbsp;
-                </option>
-                {% for guild in client.guilds %}
-                    <option value="{{ guild.vanity_url_code|default(guild.id, True) }}">
-                        {{ guild.name }}
-                    </option>
-                {% endfor %}
-            </select>
-            <div class="hr-sect">{{ _("OR") }}</div>
-            <a class="button"
-               target="_blank"
-               href="https://discord.com/api/oauth2/authorize?client_id={{ client.user.id }}&permissions=536870912&scope=bot">
-                {{ _("Add the bot on your server") }}
-            </a>
-            <ul>
-                <li>
-                    {{ _("You must have") }}
-                    <strong>{{ _("Manage Server") }}</strong>
-                    {{ _("permission on this server to perform this action") }}
-                </li>
-                <li>
-                    {{ _("After adding the bot,") }}
-                    <a href="{{ url_for(".index") }}">
-                        <i class="fa fa-refresh"></i>
-                        <strong>{{ _("reload the page") }}</strong>
-                    </a>
-                </li>
-            </ul>
         </div>
         <div id="buttons">
-            <input type="submit" class="button" value="{{ _("Let's go!") }}"/>
+            <a class="button" href="{{ url_for(".login") }}">{{ _("Let's go!") }}</a>
         </div>
     </form>
 {% endblock content %}

divent/templates/subscribe.html.j2

@@ -21,7 +21,7 @@
             <li>
                 <a class="button"
                    target="_blank"
-                   href="https://calendar.google.com/calendar/u/0/r?cid={{ request.host_url }}{{ guild.vanity_url_code|default(guild.id, True) }}.ics">
+                   href="https://calendar.google.com/calendar/u/0/r?cid=webcal://{{ request.host }}/{{ guild.vanity_url_code|default(guild.id, True) }}.ics">
                     <i class="fa fa-google"></i>
                     {{ _("Subscribe to") }} Google
                 </a>
@@ -29,7 +29,7 @@
             <li>
                 <a class="button"
                    target="_blank"
-                   href="https://outlook.live.com/owa?path=/calendar/action/compose&rru=addsubscription&url={{ request.host_url }}{{ guild.vanity_url_code|default(guild.id, True) }}.ics">
+                   href="https://outlook.live.com/owa?path=/calendar/action/compose&rru=addsubscription&url=webcal://{{ request.host }}/{{ guild.vanity_url_code|default(guild.id, True) }}.ics">
                     <i class="fa fa-windows"></i>
                     {{ _("Subscribe to") }} Outlook
                 </a>

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "divent"
-version = "1.0.3"
+version = "3.1.0"
 description = "The discord scheduled event calendar generator"
 authors = ["Xéfir Destiny"]
 license = "WTFPL"
@@ -12,21 +12,23 @@ repository = "https://git.crystalyx.net/Xefir/Divent"
 divent = 'divent.bot:__main__'
 
 [tool.poetry.dependencies]
-python = "^3.8"
-disnake = "2.5.2"
+python = "^3.8.1"
+disnake = "^2.7.0"
 ics = "0.8.0.dev0"
-python-dotenv = "0.21.0"
-quart = "0.18.0"
-sentry-sdk = "1.9.8"
-uvicorn = "0.18.3"
+python-dotenv = "^0.21.0"
+quart = "^0.18.3"
+requests-oauthlib = "^1.3.1"
+sentry-sdk = "^1.13.0"
+uvicorn = "^0.20.0"
 
 [tool.poetry.dev-dependencies]
-flake8 = "5.0.4"
-black = "22.8.0"
-mypy = "0.971"
-flake8-alphabetize = "0.0.17"
-flake8-black = "0.3.3"
-djlint = "1.12.3"
+black = "^23.0.0"
+djlint = "^1.19.11"
+flake8 = "^6.0.0"
+flake8-alphabetize = "^0.0.19"
+flake8-black = "^0.3.6"
+mypy = "^0.991"
+types-oauthlib = "^3.2.0.1"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]