]> git.mxchange.org Git - fba.git/blobdiff - api.py
Continued:
[fba.git] / api.py
diff --git a/api.py b/api.py
index 37b990d8851a4eeca124f2396cf95cf153d8514a..bd5478891195ea01bf2d26cdf167a30c170d6266 100644 (file)
--- a/api.py
+++ b/api.py
@@ -1,31 +1,52 @@
-from fastapi import FastAPI, Request, HTTPException, responses, Query
+# Fedi API Block - An aggregator for fetching blocking data from fediverse nodes
+# Copyright (C) 2023 Free Software Foundation
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from fastapi import Request, HTTPException, Query
+from fastapi.responses import JSONResponse
+from fastapi.responses import PlainTextResponse
 from fastapi.templating import Jinja2Templates
 from datetime import datetime
 from email import utils
 
+import fastapi
 import uvicorn
 import requests
-import sqlite3
 import re
-import fba
+import validators
 
-app = FastAPI(docs_url=fba.config["base_url"] + "/docs", redoc_url=fba.config["base_url"] + "/redoc")
-templates = Jinja2Templates(directory=".")
+from fba import *
 
-@app.get(fba.config["base_url"] + "/info")
+router = fastapi.FastAPI(docs_url=config.get("base_url") + "/docs", redoc_url=config.get("base_url") + "/redoc")
+templates = Jinja2Templates(directory="templates")
+
+@router.get(config.get("base_url") + "/api/info.json", response_class=JSONResponse)
 def info():
-    fba.cursor.execute("SELECT (SELECT COUNT(domain) FROM instances), (SELECT COUNT(domain) FROM instances WHERE software IN ('pleroma', 'mastodon', 'misskey', 'gotosocial', 'friendica')), (SELECT COUNT(blocker) FROM blocks)")
-    known, indexed, blocks = fba.cursor.fetchone()
+    fba.cursor.execute("SELECT (SELECT COUNT(domain) FROM instances), (SELECT COUNT(domain) FROM instances WHERE software IN ('pleroma', 'mastodon', 'misskey', 'gotosocial', 'friendica', 'bookwyrm', 'takahe', 'peertube')), (SELECT COUNT(blocker) FROM blocks), (SELECT COUNT(domain) FROM instances WHERE last_status_code IS NOT NULL)")
+    known, indexed, blocks, errorous = fba.cursor.fetchone()
 
     return {
-        "known_instances"  : known,
-        "indexed_instances": indexed,
-        "blocks_recorded"  : blocks,
-        "slogan"           : fba.config["slogan"]
+        "known_instances"   : known,
+        "indexed_instances" : indexed,
+        "blocks_recorded"   : blocks,
+        "errorous_instances": errorous,
+        "slogan"            : config.get("slogan")
     }
 
-@app.get(fba.config["base_url"] + "/top")
-def top(blocked: int = None, blockers: int = None, reference: int = None, software: int = None):
+@router.get(config.get("base_url") + "/api/top.json", response_class=JSONResponse)
+def top(blocked: int = None, blockers: int = None, reference: int = None, software: int = None, originator: int = None):
     if blocked != None:
         if blocked > 500:
             raise HTTPException(status_code=400, detail="Too many results")
@@ -37,11 +58,15 @@ def top(blocked: int = None, blockers: int = None, reference: int = None, softwa
     elif reference != None:
         if reference > 500:
             raise HTTPException(status_code=400, detail="Too many results")
-        fba.cursor.execute("SELECT origin, COUNT(domain) FROM instances GROUP BY origin ORDER BY COUNT(domain) DESC LIMIT ?", [reference])
+        fba.cursor.execute("SELECT origin, COUNT(domain) FROM instances WHERE software IS NOT NULL GROUP BY origin ORDER BY COUNT(domain) DESC LIMIT ?", [reference])
     elif software != None:
         if software > 500:
             raise HTTPException(status_code=400, detail="Too many results")
-        fba.cursor.execute("SELECT software, COUNT(domain) FROM instances GROUP BY software ORDER BY COUNT(domain) DESC LIMIT ?", [software])
+        fba.cursor.execute("SELECT software, COUNT(domain) FROM instances WHERE software IS NOT NULL GROUP BY software ORDER BY COUNT(domain) DESC, software ASC LIMIT ?", [software])
+    elif originator != None:
+        if originator > 500:
+            raise HTTPException(status_code=400, detail="Too many results")
+        fba.cursor.execute("SELECT originator, COUNT(domain) FROM instances WHERE originator IS NOT NULL GROUP BY originator ORDER BY COUNT(domain) DESC, originator ASC LIMIT ?", [originator])
     else:
         raise HTTPException(status_code=400, detail="No filter specified")
 
@@ -57,33 +82,36 @@ def top(blocked: int = None, blockers: int = None, reference: int = None, softwa
 
     return scoreboard
 
-@app.get(fba.config["base_url"] + "/api")
+@router.get(config.get("base_url") + "/api/index.json", response_class=JSONResponse)
 def blocked(domain: str = None, reason: str = None, reverse: str = None):
     if domain == None and reason == None and reverse == None:
         raise HTTPException(status_code=400, detail="No filter specified")
+
     if reason != None:
         reason = re.sub("(%|_)", "", reason)
         if len(reason) < 3:
             raise HTTPException(status_code=400, detail="Keyword is shorter than three characters")
+
     if domain != None:
         wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
         punycode = domain.encode('idna').decode('utf-8')
-        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? ORDER BY first_added ASC",
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks WHERE blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? ORDER BY first_seen ASC",
                   (domain, "*." + domain, wildchar, fba.get_hash(domain), punycode, "*." + punycode))
     elif reverse != None:
-        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE blocker = ? ORDER BY first_added ASC", [reverse])
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks WHERE blocker = ? ORDER BY first_seen ASC", [reverse])
     else:
-        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE reason like ? AND reason != '' ORDER BY first_added ASC", ["%" + reason + "%"])
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks WHERE reason like ? AND reason != '' ORDER BY first_seen ASC", ["%" + reason + "%"])
+
     blocks = fba.cursor.fetchall()
 
     result = {}
-    for blocker, blocked, block_level, reason, first_added, last_seen in blocks:
+    for blocker, blocked, block_level, reason, first_seen, last_seen in blocks:
         entry = {
-            "blocker"    : blocker,
-            "blocked"    : blocked,
-            "reason"     : reason,
-            "first_added": first_added,
-            "last_seen"  : last_seen
+            "blocker"   : blocker,
+            "blocked"   : blocked,
+            "reason"    : reason,
+            "first_seen": first_seen,
+            "last_seen" : last_seen
         }
         if block_level in result:
             result[block_level].append(entry)
@@ -92,58 +120,90 @@ def blocked(domain: str = None, reason: str = None, reverse: str = None):
 
     return result
 
-@app.get(fba.config["base_url"] + "/scoreboard")
-def index(request: Request, blockers: int = None, blocked: int = None, reference: int = None, software: int = None):
+@router.get(config.get("base_url") + "/api/mutual.json", response_class=JSONResponse)
+def mutual(domains: list[str] = Query()):
+    """Return 200 if federation is open between the two, 4xx otherwise"""
+    fba.cursor.execute(
+        "SELECT block_level FROM blocks " \
+        "WHERE ((blocker = :a OR blocker = :b) AND (blocked = :b OR blocked = :a OR blocked = :aw OR blocked = :bw)) " \
+        "AND block_level = 'reject' " \
+        "LIMIT 1",
+        {
+            "a" : domains[0],
+            "b" : domains[1],
+            "aw": "*." + domains[0],
+            "bw": "*." + domains[1],
+        },
+    )
+    response = fba.cursor.fetchone()
+
+    if response is not None:
+        # Blocks found
+        return JSONResponse(status_code=418, content={})
+
+    # No known blocks
+    return JSONResponse(status_code=200, content={})
+
+@router.get(config.get("base_url") + "/scoreboard")
+def index(request: Request, blockers: int = None, blocked: int = None, reference: int = None, software: int = None, originator: int = None):
     scores = None
 
     if blockers != None and blockers > 0:
-        res = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/top?blockers={blockers}")
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?blockers={blockers}")
     elif blocked != None and blocked > 0:
-        res = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/top?blocked={blocked}")
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?blocked={blocked}")
     elif reference != None and reference > 0:
-        res = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/top?reference={reference}")
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?reference={reference}")
     elif software != None and software > 0:
-        res = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/top?software={software}")
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?software={software}")
+    elif originator != None and originator > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?originator={originator}")
     else:
         raise HTTPException(status_code=400, detail="No filter specified")
 
-    if res == None:
+    if response == None:
         raise HTTPException(status_code=500, detail="Could not determine scores")
-    elif not res.ok:
-        raise HTTPException(status_code=res.status_code, detail=res.text)
+    elif not response.ok:
+        raise HTTPException(status_code=response.status_code, detail=response.text)
 
-    return templates.TemplateResponse("index.html", {
-        "base_url"  : fba.config["base_url"],
+    return templates.TemplateResponse("scoreboard.html", {
+        "base_url"  : config.get("base_url"),
+        "slogan"    : config.get("slogan"),
         "request"   : request,
         "scoreboard": True,
         "blockers"  : blockers,
         "blocked"   : blocked,
         "reference" : reference,
         "software"  : software,
-        "scores"    : res.json()
+        "originator": originator,
+        "scores"    : fba.json_from_response(response)
     })
 
-@app.get(fba.config["base_url"] + "/")
+@router.get(config.get("base_url") + "/")
 def index(request: Request, domain: str = None, reason: str = None, reverse: str = None):
     if domain == "" or reason == "" or reverse == "":
-        return responses.RedirectResponse("/")
+        return fastapi.responses.RedirectResponse("/")
 
-    info = None
-    blocks = None
+    response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/info.json")
 
-    if domain == None and reason == None and reverse == None:
-        info = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/info")
+    if not response.ok:
+        raise HTTPException(status_code=response.status_code, detail=response.text)
 
-        if not info.ok:
-            raise HTTPException(status_code=info.status_code, detail=info.text)
+    info = response.json()
+    blocks = None
 
-        info = info.json()
-    elif domain != None:
-        blocks = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/api?domain={domain}")
+    if domain != None:
+        if not validators.domain(domain):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
+        blocks = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?domain={domain}")
     elif reason != None:
-        blocks = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/api?reason={reason}")
+        blocks = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?reason={reason}")
     elif reverse != None:
-        blocks = requests.get(f"http://127.0.0.1:{fba.config['port']}{fba.config['base_url']}/api?reverse={reverse}")
+        if not validators.domain(reverse):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
+        blocks = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?reverse={reverse}")
 
     if blocks != None:
         if not blocks.ok:
@@ -151,8 +211,8 @@ def index(request: Request, domain: str = None, reason: str = None, reverse: str
         blocks = blocks.json()
         for block_level in blocks:
             for block in blocks[block_level]:
-                block["first_added"] = datetime.utcfromtimestamp(block["first_added"]).strftime('%Y-%m-%d %H:%M')
-                block["last_seen"] = datetime.utcfromtimestamp(block["last_seen"]).strftime('%Y-%m-%d %H:%M')
+                block["first_seen"] = datetime.utcfromtimestamp(block["first_seen"]).strftime(config.get("timestamp_format"))
+                block["last_seen"] = datetime.utcfromtimestamp(block["last_seen"]).strftime(config.get("timestamp_format"))
 
     return templates.TemplateResponse("index.html", {
         "request": request,
@@ -163,68 +223,50 @@ def index(request: Request, domain: str = None, reason: str = None, reverse: str
         "info"   : info
     })
 
-@app.get(fba.config["base_url"] + "/api/mutual")
-def mutual(domains: list[str] = Query()):
-    """Return 200 if federation is open between the two, 4xx otherwise"""
-    fba.cursor.execute(
-        "SELECT block_level FROM blocks " \
-        "WHERE ((blocker = :a OR blocker = :b) AND (blocked = :b OR blocked = :a OR blocked = :aw OR blocked = :bw)) " \
-        "AND block_level = 'reject' " \
-        "LIMIT 1",
-        {
-            "a": domains[0],
-            "b": domains[1],
-            "aw": "*." + domains[0],
-            "bw": "*." + domains[1],
-        },
-    )
-    res = fba.cursor.fetchone()
-
-    if res is not None:
-        # Blocks found
-        return responses.JSONResponse(status_code=418, content={})
-
-    # No known blocks
-    return responses.JSONResponse(status_code=200, content={})
-
-@app.get(fba.config["base_url"] + "/rss")
+@router.get(config.get("base_url") + "/rss")
 def rss(request: Request, domain: str = None):
     if domain != None:
         wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
         punycode = domain.encode('idna').decode('utf-8')
-        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? ORDER BY first_added DESC LIMIT 50",
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks WHERE blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? ORDER BY first_seen DESC LIMIT 50",
                   (domain, "*." + domain, wildchar, fba.get_hash(domain), punycode, "*." + punycode))
     else:
-        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks ORDER BY first_added DESC LIMIT 50")
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks ORDER BY first_seen DESC LIMIT 50")
 
-    blocks = fba.cursor.fetchall()
+    result = fba.cursor.fetchall()
 
-    result = []
-    for blocker, blocked, block_level, reason, first_added, last_seen in blocks:
-        first_added = utils.format_datetime(datetime.fromtimestamp(first_added))
+    blocks = []
+    for blocker, blocked, block_level, reason, first_seen, last_seen in result:
+        first_seen = utils.format_datetime(datetime.fromtimestamp(first_seen))
         if reason == None or reason == '':
             reason = "No reason provided."
         else:
             reason = "Provided reason: '" + reason + "'"
 
-        result.append({
-            "blocker": blocker,
-            "blocked": blocked,
+        blocks.append({
+            "blocker"    : blocker,
+            "blocked"    : blocked,
             "block_level": block_level,
-            "reason": reason,
-            "first_added": first_added
+            "reason"     : reason,
+            "first_seen" : first_seen
         })
 
-    timestamp = utils.format_datetime(datetime.now())
-
     return templates.TemplateResponse("rss.xml", {
-        "request": request,
-        "timestamp": timestamp,
-        "domain": domain,
-        "blocks": result
+        "request"  : request,
+        "timestamp": utils.format_datetime(datetime.now()),
+        "domain"   : domain,
+        "hostname" : config.get("hostname"),
+        "blocks"   : blocks
     }, headers={
-        "Content-Type": "application/rss+xml"
+        "Content-Type": "routerlication/rss+xml"
+    })
+
+@router.get(config.get("base_url") + "/robots.txt", response_class=PlainTextResponse)
+def robots(request: Request):
+    return templates.TemplateResponse("robots.txt", {
+        "request" : request,
+        "base_url": config.get("base_url")
     })
 
 if __name__ == "__main__":
-    uvicorn.run("api:app", host="127.0.0.1", port=fba.config["port"], log_level=fba.config["log_level"])
+    uvicorn.run("api:router", host=config.get("host"), port=config.get("port"), log_level=config.get("log_level"))