]> git.mxchange.org Git - fba.git/blobdiff - api.py
Continued:
[fba.git] / api.py
diff --git a/api.py b/api.py
index 02de37d4a47f3ad76e8d0d4884b5da5b82f90ebf..eb7a8f88a406ebe7038edcdea77d2c88b69730e7 100644 (file)
--- a/api.py
+++ b/api.py
-import uvicorn
-from fastapi import FastAPI, Request, HTTPException, responses, Query
-import sqlite3
-from hashlib import sha256
-from fastapi.templating import Jinja2Templates
-from requests import get
-from json import loads
+# 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 datetime import datetime
 from email import utils
+
 import re
-import fba
 
-app = FastAPI(docs_url=fba.config["base_url"] + "/docs", redoc_url=fba.config["base_url"] + "/redoc")
-templates = Jinja2Templates(directory=".")
+from fastapi import Request, HTTPException, Query
+from fastapi.responses import JSONResponse
+from fastapi.responses import PlainTextResponse
+from fastapi.templating import Jinja2Templates
+
+import fastapi
+import uvicorn
+import requests
+import validators
+
+from fba import config
+from fba import fba
+from fba import network
+
+from fba.helpers import tidyup
+
+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 api_info():
+    fba.cursor.execute("SELECT (SELECT COUNT(domain) FROM instances), (SELECT COUNT(domain) FROM instances WHERE software IN ('pleroma', 'mastodon', 'lemmy', 'friendica', 'misskey', 'peertube')), (SELECT COUNT(blocker) FROM blocks), (SELECT COUNT(domain) FROM instances WHERE last_error_details IS NOT NULL)")
+    row = fba.cursor.fetchone()
 
-@app.get(fba.config["base_url"] + "/info")
-def info():
-    fba.c.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.c.fetchone()
-    fba.c.close()
     return {
-        "known_instances": known,
-        "indexed_instances": indexed,
-        "blocks_recorded": blocks,
-        "slogan": fba.config["slogan"]
+        "known_instances"   : row[0],
+        "indexed_instances" : row[1],
+        "blocks_recorded"   : row[2],
+        "errorous_instances": row[3],
+        "slogan"            : config.get("slogan")
     }
 
-@app.get(fba.config["base_url"] + "/top")
-def top(blocked: int = None, blockers: int = None):
-    if blocked == None and blockers == None:
+@router.get(config.get("base_url") + "/api/scoreboard.json", response_class=JSONResponse)
+def api_scoreboard(mode: str, amount: int):
+    if amount > 500:
+        raise HTTPException(status_code=400, detail="Too many results")
+
+    if mode == "blocked":
+        fba.cursor.execute("SELECT blocked, COUNT(blocked) AS score FROM blocks WHERE block_level = 'reject' GROUP BY blocked ORDER BY score DESC LIMIT ?", [amount])
+    elif mode == "blocker":
+        fba.cursor.execute("SELECT blocker, COUNT(blocker) AS score FROM blocks WHERE block_level = 'reject' GROUP BY blocker ORDER BY score DESC LIMIT ?", [amount])
+    elif mode == "reference":
+        fba.cursor.execute("SELECT origin, COUNT(domain) AS score FROM instances WHERE software IS NOT NULL GROUP BY origin ORDER BY score DESC LIMIT ?", [amount])
+    elif mode == "software":
+        fba.cursor.execute("SELECT software, COUNT(domain) AS score FROM instances WHERE software IS NOT NULL GROUP BY software ORDER BY score DESC, software ASC LIMIT ?", [amount])
+    elif mode == "command":
+        fba.cursor.execute("SELECT command, COUNT(domain) AS score FROM instances WHERE command IS NOT NULL GROUP BY command ORDER BY score DESC, command ASC LIMIT ?", [amount])
+    elif mode == "error_code":
+        fba.cursor.execute("SELECT last_status_code, COUNT(domain) AS score FROM instances WHERE last_status_code IS NOT NULL AND last_status_code != '200' GROUP BY last_status_code ORDER BY score DESC LIMIT ?", [amount])
+    elif mode == "avg_peers":
+        fba.cursor.execute("SELECT software, AVG(total_peers) AS sum FROM instances WHERE software IS NOT NULL GROUP BY software HAVING sum>0 ORDER BY sum DESC LIMIT ?", [amount])
+    else:
         raise HTTPException(status_code=400, detail="No filter specified")
-    elif blocked != None:
-        if blocked > 500:
-            raise HTTPException(status_code=400, detail="Too many results")
-        fba.c.execute("SELECT blocked, count(blocked) FROM blocks WHERE block_level = 'reject' group by blocked ORDER BY count(blocked) DESC LIMIT ?", (blocked,))
-    elif blockers != None:
-        if blockers > 500:
-            raise HTTPException(status_code=400, detail="Too many results")
-        fba.c.execute("SELECT blocker, count(blocker) FROM blocks WHERE block_level = 'reject' group by blocker ORDER BY count(blocker) DESC LIMIT ?", (blockers,))
-    scores = fba.c.fetchall()
-    fba.c.close()
-
-    scoreboard = []
-    print(scores)
-    for domain, highscore in scores:
-        scoreboard.append({"domain": domain, "highscore": highscore})
-
-    return scoreboard
-
-@app.get(fba.config["base_url"] + "/api")
-def blocked(domain: str = None, reason: str = None, reverse: str = None):
-    if domain == None and reason == None and reverse == None:
+
+    scores = list()
+
+    for domain, score in fba.cursor.fetchall():
+        scores.append({
+            "domain": domain,
+            "score" : round(score)
+        })
+
+    return scores
+
+@router.get(config.get("base_url") + "/api/index.json", response_class=JSONResponse)
+def api_blocked(domain: str = None, reason: str = None, reverse: str = None):
+    if domain is None and reason is None and reverse is None:
         raise HTTPException(status_code=400, detail="No filter specified")
-    if reason != None:
-        reason = re.sub("(%|_)", "", reason)
+
+    if reason is not None:
+        reason = re.sub("(%|_)", "", tidyup.reason(reason))
         if len(reason) < 3:
             raise HTTPException(status_code=400, detail="Keyword is shorter than three characters")
-    if domain != None:
+
+    if domain is not None:
+        domain = tidyup.domain(domain)
+        if not validators.domain(domain.split("/")[0]):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
         wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
         punycode = domain.encode('idna').decode('utf-8')
-        fba.c.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.c.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE blocker = ? ORDER BY first_added asc", (reverse,))
+    elif reverse is not None:
+        reverse = tidyup.domain(reverse)
+        if not validators.domain(reverse):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
+        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.c.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks WHERE reason like ? AND reason != '' ORDER BY first_added asc", ("%"+reason+"%",))
-    blocks = fba.c.fetchall()
-    fba.c.close()
+        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 + "%"])
+
+    blocklist = fba.cursor.fetchall()
 
     result = {}
-    for blocker, blocked, block_level, reason, first_added, last_seen in blocks:
-        entry = {"blocker": blocker, "blocked": blocked, "reason": reason, "first_added": first_added, "last_seen": last_seen}
+    for blocker, blocked, block_level, reason, first_seen, last_seen in blocklist:
+        if reason is not None and reason != "":
+            reason = reason.replace(",", " ").replace("  ", " ")
+
+        entry = {
+            "blocker"   : blocker,
+            "blocked"   : blocked,
+            "reason"    : reason,
+            "first_seen": first_seen,
+            "last_seen" : last_seen
+        }
+
         if block_level in result:
             result[block_level].append(entry)
         else:
@@ -77,105 +134,175 @@ 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):
-    if blockers == None and blocked == None:
-        raise HTTPException(status_code=400, detail="No filter specified")
-    elif blockers != None:
-        scores = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/top?blockers={blockers}")
-    elif blocked != None:
-        scores = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/top?blocked={blocked}")
-    if scores != None:
-        if not scores.ok:
-            raise HTTPException(status_code=blocks.status_code, detail=blocks.text)
-        scores = scores.json()
-    return templates.TemplateResponse("index.html", {"request": request, "scoreboard": True, "blockers": blockers, "blocked": blocked, "scores": scores})
-
-@app.get(fba.config["base_url"] + "/")
-def index(request: Request, domain: str = None, reason: str = None, reverse: str = None):
-    if domain == "" or reason == "" or reverse == "":
-        return responses.RedirectResponse("/")
-    info = None
-    blocks = None
-    if domain == None and reason == None and reverse == None:
-        info = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/info")
-        if not info.ok:
-            raise HTTPException(status_code=info.status_code, detail=info.text)
-        info = info.json()
-    elif domain != None:
-        blocks = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/api?domain={domain}")
-    elif reason != None:
-        blocks = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/api?reason={reason}")
-    elif reverse != None:
-        blocks = get(f"http://127.0.0.1:{fba.config['base_url']}{fba.config['base_url']}/api?reverse={reverse}")
-    if blocks != None:
-        if not blocks.ok:
-            raise HTTPException(status_code=blocks.status_code, detail=blocks.text)
-        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')
-
-    return templates.TemplateResponse("index.html", {"request": request, "domain": domain, "blocks": blocks, "reason": reason, "reverse": reverse, "info": info})
-
-@app.get(fba.config["base_url"] + "/api/mutual")
-def mutual(domains: list[str] = Query()):
+@router.get(config.get("base_url") + "/api/mutual.json", response_class=JSONResponse)
+def api_mutual(domains: list[str] = Query()):
     """Return 200 if federation is open between the two, 4xx otherwise"""
-    fba.c.execute(
+    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],
+            "a" : domains[0],
+            "b" : domains[1],
             "aw": "*." + domains[0],
             "bw": "*." + domains[1],
         },
     )
-    res = fba.c.fetchone()
-    fba.c.close()
-    if res is not None:
+    response = fba.cursor.fetchone()
+
+    if response is not None:
         # Blocks found
-        return responses.JSONResponse(status_code=418, content={})
+        return JSONResponse(status_code=418, content={})
+
     # No known blocks
-    return responses.JSONResponse(status_code=200, content={})
+    return JSONResponse(status_code=200, content={})
+
+@router.get(config.get("base_url") + "/scoreboard")
+def scoreboard(request: Request, mode: str, amount: int):
+    response = None
+
+    if mode == "blocker" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=blocker&amount={amount}")
+    elif mode == "blocked" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=blocked&amount={amount}")
+    elif mode == "reference" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=reference&amount={amount}")
+    elif mode == "software" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=software&amount={amount}")
+    elif mode == "command" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=command&amount={amount}")
+    elif mode == "error_code" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=error_code&amount={amount}")
+    elif mode == "avg_peers" and amount > 0:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=avg_peers&amount={amount}")
+    else:
+        raise HTTPException(status_code=400, detail="No filter specified")
+
+    if response is None:
+        raise HTTPException(status_code=500, detail="Could not determine scores")
+    elif not response.ok:
+        raise HTTPException(status_code=response.status_code, detail=response.text)
+
+    return templates.TemplateResponse("views/scoreboard.html", {
+        "base_url"  : config.get("base_url"),
+        "slogan"    : config.get("slogan"),
+        "request"   : request,
+        "scoreboard": True,
+        "mode"      : mode,
+        "amount"    : amount,
+        "scores"    : network.json_from_response(response)
+    })
+
+@router.get(config.get("base_url") + "/")
+def index(request: Request):
+    # Get info
+    response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/info.json")
+
+    if not response.ok:
+        raise HTTPException(status_code=response.status_code, detail=response.text)
+
+    return templates.TemplateResponse("views/index.html", {
+        "request": request,
+        "info"   : response.json()
+    })
+
+@router.get(config.get("base_url") + "/top")
+def top(request: Request, domain: str = None, reason: str = None, reverse: str = None):
+    if domain == "" or reason == "" or reverse == "":
+        raise HTTPException(status_code=500, detail="Insufficient parameter provided")
+
+    response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/info.json")
+
+    if not response.ok:
+        raise HTTPException(status_code=response.status_code, detail=response.text)
 
-@app.get(fba.config["base_url"] + "/rss")
+    info = response.json()
+    response = None
+
+    if domain is not None:
+        domain = tidyup.domain(domain)
+        if not validators.domain(domain.split("/")[0]):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?domain={domain}")
+    elif reason is not None:
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?reason={reason}")
+    elif reverse is not None:
+        reverse = tidyup.domain(reverse)
+        if not validators.domain(reverse):
+            raise HTTPException(status_code=500, detail="Invalid domain")
+
+        response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/index.json?reverse={reverse}")
+
+    if response is not None:
+        if not response.ok:
+            raise HTTPException(status_code=response.status_code, detail=response.text)
+
+        blocklist = response.json()
+
+        for block_level in blocklist:
+            for block in blocklist[block_level]:
+                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("views/top.html", {
+        "request": request,
+        "domain" : domain,
+        "blocks" : blocklist,
+        "reason" : reason,
+        "reverse": reverse,
+        "info"   : info
+    })
+
+@router.get(config.get("base_url") + "/rss")
 def rss(request: Request, domain: str = None):
-    if domain != None:
+    if domain is not None:
+        domain = tidyup.domain(domain)
+
         wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
-        punycode = domain.encode('idna').decode('utf-8')
-        fba.c.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",
-                  (domain, "*." + domain, wildchar, fba.get_hash(domain), punycode, "*." + punycode))
-    else:
-        fba.c.execute("SELECT blocker, blocked, block_level, reason, first_added, last_seen FROM blocks ORDER BY first_added DESC LIMIT 50")
+        punycode = domain.encode("idna").decode("utf-8")
 
-    blocks = fba.c.fetchall()
-    fba.c.close()
+        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 ?", [
+            domain,
+            "*." + domain, wildchar,
+            fba.get_hash(domain),
+            punycode,
+            "*." + punycode,
+            config.get("rss_limit")
+        ])
+    else:
+        fba.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks ORDER BY first_seen DESC LIMIT ?", [config.get("rss_limit")])
 
-    result = []
-    for blocker, blocked, block_level, reason, first_added, last_seen in blocks:
-        first_added = utils.format_datetime(datetime.fromtimestamp(first_added))
-        if reason == None or reason == '':
-            reason = "No reason provided."
-        else:
-            reason = "Provided reason: '" + reason + "'"
+    result = fba.cursor.fetchall()
+    blocklist = []
 
-        result.append(
-            {
-            "blocker": blocker,
-            "blocked": blocked,
-            "block_level": block_level,
-            "reason": reason,
-            "first_added": first_added
-            }
-        )
+    for row in result:
+        blocklist.append({
+            "blocker"    : row[0],
+            "blocked"    : row[1],
+            "block_level": row[2],
+            "reason"     : "Provided reason: '" + row[3] + "'" if row[3] is not None and row[3] != "" else "No reason provided.",
+            "first_seen" : utils.format_datetime(datetime.fromtimestamp(row[4])),
+            "last_seen"  : utils.format_datetime(datetime.fromtimestamp(row[5])),
+        })
 
-    timestamp = utils.format_datetime(datetime.now())
+    return templates.TemplateResponse("rss.xml", {
+        "request"  : request,
+        "timestamp": utils.format_datetime(datetime.now()),
+        "domain"   : domain,
+        "hostname" : config.get("hostname"),
+        "blocks"   : blocklist
+    }, headers={
+        "Content-Type": "routerlication/rss+xml"
+    })
 
-    return templates.TemplateResponse("rss.xml", {"request": request, "timestamp": timestamp, "domain": domain, "blocks": result}, headers={"Content-Type": "application/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"))