2 # -*- coding: utf-8 -*-
4 # Fedi API Block - An aggregator for fetching blocking data from fediverse nodes
5 # Copyright (C) 2023 Free Software Foundation
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published
9 # by the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <https://www.gnu.org/licenses/>.
22 from datetime import datetime
23 from email.utils import format_datetime
24 from pathlib import Path
27 from fastapi import Request, HTTPException, Query
28 from fastapi.responses import JSONResponse
29 from fastapi.responses import PlainTextResponse
30 from fastapi.staticfiles import StaticFiles
31 from fastapi.templating import Jinja2Templates
36 from fba import database
39 from fba.helpers import config
40 from fba.helpers import json as json_helper
41 from fba.helpers import tidyup
43 from fba.models import blocks
44 from fba.models import instances
46 router = fastapi.FastAPI(docs_url=config.get("base_url") + "/docs", redoc_url=config.get("base_url") + "/redoc")
49 StaticFiles(directory=Path(__file__).parent.absolute() / "static"),
53 templates = Jinja2Templates(directory="templates")
55 @router.get(config.get("base_url") + "/api/info.json", response_class=JSONResponse)
57 database.cursor.execute("SELECT (SELECT COUNT(domain) FROM instances), (SELECT COUNT(domain) FROM instances WHERE software IN ('pleroma', 'mastodon', 'lemmy', 'friendica', 'misskey', 'peertube', 'takahe')), (SELECT COUNT(blocker) FROM blocks), (SELECT COUNT(domain) FROM instances WHERE last_error_details IS NOT NULL)")
58 row = database.cursor.fetchone()
61 "known_instances" : row[0],
62 "supported_instances": row[1],
63 "blocks_recorded" : row[2],
64 "erroneous_instances": row[3],
67 @router.get(config.get("base_url") + "/api/scoreboard.json", response_class=JSONResponse)
68 def api_scoreboard(mode: str, amount: int):
69 if amount > config.get("api_limit"):
70 raise HTTPException(status_code=400, detail="Too many results")
73 database.cursor.execute("SELECT blocked, COUNT(blocked) AS score FROM blocks GROUP BY blocked ORDER BY score DESC LIMIT ?", [amount])
74 elif mode == "blocker":
75 database.cursor.execute("SELECT blocker, COUNT(blocker) AS score FROM blocks GROUP BY blocker ORDER BY score DESC LIMIT ?", [amount])
76 elif mode == "reference":
77 database.cursor.execute("SELECT origin, COUNT(domain) AS score FROM instances WHERE origin IS NOT NULL GROUP BY origin ORDER BY score DESC LIMIT ?", [amount])
78 elif mode == "software":
79 database.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])
80 elif mode == "command":
81 database.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])
82 elif mode == "error_code":
83 database.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])
84 elif mode == "detection_mode":
85 database.cursor.execute("SELECT detection_mode, COUNT(domain) AS cnt FROM instances GROUP BY detection_mode ORDER BY cnt DESC LIMIT ?", [amount])
86 elif mode == "avg_peers":
87 database.cursor.execute("SELECT software, AVG(total_peers) AS average FROM instances WHERE software IS NOT NULL GROUP BY software HAVING average>0 ORDER BY average DESC LIMIT ?", [amount])
88 elif mode == "obfuscator":
89 database.cursor.execute("SELECT software, COUNT(domain) AS cnt FROM instances WHERE has_obfuscation = 1 GROUP BY software ORDER BY cnt DESC LIMIT ?", [amount])
90 elif mode == "obfuscation":
91 database.cursor.execute("SELECT has_obfuscation, COUNT(domain) AS cnt FROM instances WHERE software IN ('pleroma', 'mastodon', 'friendica') GROUP BY has_obfuscation ORDER BY cnt DESC LIMIT ?", [amount])
92 elif mode == "block_level":
93 database.cursor.execute("SELECT block_level, COUNT(rowid) AS cnt FROM blocks GROUP BY block_level ORDER BY cnt DESC LIMIT ?", [amount])
95 raise HTTPException(status_code=400, detail="No filter specified")
99 for domain, score in database.cursor.fetchall():
102 "score" : round(score)
107 @router.get(config.get("base_url") + "/api/list.json", response_class=JSONResponse)
108 def api_list(request: Request, mode: str, value: str, amount: int):
109 if mode is None or value is None or amount is None:
110 raise HTTPException(status_code=500, detail="No filter specified")
111 elif amount > config.get("api_limit"):
112 raise HTTPException(status_code=500, detail=f"amount={amount} is to big")
114 domain = wildchar = punycode = reason = None
116 if mode in ("detection_mode", "software", "command"):
117 database.cursor.execute(
118 f"SELECT domain, origin, software, detection_mode, command, total_peers, total_blocks, first_seen, last_updated \
122 LIMIT ?", [value, amount]
125 domainlist = database.cursor.fetchall()
129 @router.get(config.get("base_url") + "/api/top.json", response_class=JSONResponse)
130 def api_index(request: Request, mode: str, value: str, amount: int):
131 if mode is None or value is None or amount is None:
132 raise HTTPException(status_code=500, detail="No filter specified")
133 elif amount > config.get("api_limit"):
134 raise HTTPException(status_code=500, detail=f"amount={amount} is to big")
136 domain = wildchar = punycode = reason = None
138 if mode == "block_level":
139 database.cursor.execute(
140 "SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks WHERE block_level = ? LIMIT ?", [value, amount]
142 elif mode in ["domain", "reverse"]:
143 domain = tidyup.domain(value)
144 if not utils.is_domain_wanted(domain):
145 raise HTTPException(status_code=500, detail=f"domain='{domain}' is not wanted")
147 wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
148 punycode = domain.encode("idna").decode("utf-8")
149 elif mode == "reason":
150 reason = re.sub("(%|_)", "", tidyup.reason(value))
152 raise HTTPException(status_code=400, detail="Keyword is shorter than three characters")
155 database.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen \
157 WHERE blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? OR blocked = ? \
158 ORDER BY block_level ASC, first_seen ASC \
164 utils.get_hash(domain),
170 elif mode == "reverse":
171 database.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen \
173 WHERE blocker = ? OR blocker = ? OR blocker = ? OR blocker = ? OR blocker = ? OR blocker = ? \
174 ORDER BY first_seen ASC \
179 utils.get_hash(domain),
184 elif mode == "reason":
185 database.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen \
187 WHERE reason LIKE ? AND reason != '' \
188 ORDER BY first_seen ASC \
194 blocklist = database.cursor.fetchall()
197 for blocker, blocked, block_level, reason, first_seen, last_seen in blocklist:
198 if reason is not None and reason != "":
199 reason = reason.replace(",", " ").replace(" ", " ")
205 "first_seen": first_seen,
206 "last_seen" : last_seen
209 if block_level in result:
210 result[block_level].append(entry)
212 result[block_level] = [entry]
216 @router.get(config.get("base_url") + "/api/domain.json", response_class=JSONResponse)
217 def api_domain(domain: str):
218 # Tidy up domain name
219 domain = tidyup.domain(domain)
221 if not utils.is_domain_wanted(domain):
222 raise HTTPException(status_code=500, detail=f"domain='{domain}' is not wanted")
225 database.cursor.execute("SELECT * FROM instances WHERE domain = ? LIMIT 1", [domain])
226 domain_data = database.cursor.fetchone()
228 if domain_data is None:
229 raise HTTPException(status_code=404, detail=f"domain='{domain}' not found")
233 @router.get(config.get("base_url") + "/api/mutual.json", response_class=JSONResponse)
234 def api_mutual(domains: list[str] = Query()):
235 """Return 200 if federation is open between the two, 4xx otherwise"""
236 database.cursor.execute(
237 "SELECT block_level FROM blocks " \
238 "WHERE ((blocker = :a OR blocker = :b) AND (blocked = :b OR blocked = :a OR blocked = :aw OR blocked = :bw)) " \
239 "AND block_level = 'reject' " \
244 "aw": "*." + domains[0],
245 "bw": "*." + domains[1],
249 if database.cursor.fetchone() is not None:
251 return JSONResponse(status_code=418, content={})
254 return JSONResponse(status_code=200, content={})
256 @router.get(config.get("base_url") + "/scoreboard")
257 def scoreboard(request: Request, mode: str, amount: int):
260 if mode == "blocker" and amount > 0:
261 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=blocker&amount={amount}")
262 elif mode == "blocked" and amount > 0:
263 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=blocked&amount={amount}")
264 elif mode == "reference" and amount > 0:
265 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=reference&amount={amount}")
266 elif mode == "software" and amount > 0:
267 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=software&amount={amount}")
268 elif mode == "command" and amount > 0:
269 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=command&amount={amount}")
270 elif mode == "error_code" and amount > 0:
271 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=error_code&amount={amount}")
272 elif mode == "detection_mode" and amount > 0:
273 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=detection_mode&amount={amount}")
274 elif mode == "avg_peers" and amount > 0:
275 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=avg_peers&amount={amount}")
276 elif mode == "obfuscator" and amount > 0:
277 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=obfuscator&amount={amount}")
278 elif mode == "obfuscation" and amount > 0:
279 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=obfuscation&amount={amount}")
280 elif mode == "block_level" and amount > 0:
281 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/scoreboard.json?mode=block_level&amount={amount}")
283 raise HTTPException(status_code=400, detail="No filter specified")
286 raise HTTPException(status_code=500, detail="Could not determine scores")
287 elif not response.ok:
288 raise HTTPException(status_code=response.status_code, detail=response.text)
290 return templates.TemplateResponse("views/scoreboard.html", {
291 "base_url" : config.get("base_url"),
292 "slogan" : config.get("slogan"),
293 "theme" : config.get("theme"),
298 "scores" : json_helper.from_response(response)
301 @router.get(config.get("base_url") + "/")
302 def index(request: Request):
304 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/info.json")
307 raise HTTPException(status_code=response.status_code, detail=response.text)
309 return templates.TemplateResponse("views/index.html", {
311 "theme" : config.get("theme"),
312 "info" : response.json(),
313 "slogan" : config.get("slogan"),
316 @router.get(config.get("base_url") + "/list")
317 def list_domains(request: Request, mode: str, value: str, amount: int = config.get("api_limit")):
318 if mode == "detection_mode" and not instances.valid(value, "detection_mode"):
319 raise HTTPException(status_code=500, detail="Invalid detection mode provided")
321 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/list.json?mode={mode}&value={value}&amount={amount}")
324 if response is not None and response.ok:
325 domainlist = response.json()
326 format = config.get("timestamp_format")
327 for row in domainlist:
328 row["first_seen"] = datetime.utcfromtimestamp(row["first_seen"]).strftime(format)
329 row["last_updated"] = datetime.utcfromtimestamp(row["last_updated"]).strftime(format)
331 return templates.TemplateResponse("views/list.html", {
333 "mode" : mode if response is not None else None,
334 "value" : value if response is not None else None,
335 "amount" : amount if response is not None else None,
336 "found" : len(domainlist),
337 "domainlist": domainlist,
338 "slogan" : config.get("slogan"),
339 "theme" : config.get("theme"),
342 @router.get(config.get("base_url") + "/top")
343 def top(request: Request, mode: str, value: str, amount: int = config.get("api_limit")):
344 if mode == "block_level" and not blocks.valid(value, "block_level"):
345 raise HTTPException(status_code=500, detail="Invalid block level provided")
346 elif mode in ["domain", "reverse"] and not utils.is_domain_wanted(value):
347 raise HTTPException(status_code=500, detail="Invalid or blocked domain specified")
349 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/top.json?mode={mode}&value={value}&amount={amount}")
353 if response is not None and response.ok:
354 blocklist = response.json()
356 format = config.get("timestamp_format")
357 for block_level in blocklist:
358 for block in blocklist[block_level]:
359 block["first_seen"] = datetime.utcfromtimestamp(block["first_seen"]).strftime(format)
360 block["last_seen"] = datetime.utcfromtimestamp(block["last_seen"]).strftime(format)
363 return templates.TemplateResponse("views/top.html", {
365 "mode" : mode if response is not None else None,
366 "value" : value if response is not None else None,
367 "amount" : amount if response is not None else None,
369 "blocklist": blocklist,
370 "slogan" : config.get("slogan"),
371 "theme" : config.get("theme"),
374 @router.get(config.get("base_url") + "/infos")
375 def rss(request: Request, domain: str):
376 # Tidy up domain name
377 domain = tidyup.domain(domain)
379 if not utils.is_domain_wanted(domain):
380 raise HTTPException(status_code=500, detail=f"domain='{domain}' is not wanted")
382 response = requests.get(f"http://{config.get('host')}:{config.get('port')}{config.get('base_url')}/api/domain.json?domain={domain}")
384 if not response.ok or response.status_code > 200 or response.text.strip() == "":
385 raise HTTPException(status_code=response.status_code, detail=response.reason)
387 domain_data = response.json()
390 format = config.get("timestamp_format")
392 for key in domain_data.keys():
393 if key in ["last_nodeinfo", "last_blocked", "first_seen", "last_updated", "last_instance_fetch"]:
395 instance[key] = datetime.utcfromtimestamp(domain_data[key]).strftime(format) if isinstance(domain_data[key], float) else "-"
398 instance[key] = domain_data[key]
400 return templates.TemplateResponse("views/infos.html", {
403 "instance": instance,
404 "theme" : config.get("theme"),
405 "slogan" : config.get("slogan"),
408 @router.get(config.get("base_url") + "/rss")
409 def rss(request: Request, domain: str = None):
410 if domain is not None:
411 domain = tidyup.domain(domain)
413 wildchar = "*." + ".".join(domain.split(".")[-domain.count("."):])
414 punycode = domain.encode("idna").decode("utf-8")
416 database.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 ?", [
418 "*." + domain, wildchar,
419 utils.get_hash(domain),
422 config.get("rss_limit")
425 database.cursor.execute("SELECT blocker, blocked, block_level, reason, first_seen, last_seen FROM blocks ORDER BY first_seen DESC LIMIT ?", [config.get("rss_limit")])
427 result = database.cursor.fetchall()
434 "block_level": row[2],
435 "reason" : "Provided reason: '" + row[3] + "'" if row[3] is not None and row[3] != "" else "No reason provided.",
436 "first_seen" : format_datetime(datetime.fromtimestamp(row[4])),
437 "last_seen" : format_datetime(datetime.fromtimestamp(row[5])),
440 return templates.TemplateResponse("views/rss.xml", {
442 "timestamp": format_datetime(datetime.now()),
444 "hostname" : config.get("hostname"),
447 "Content-Type": "routerlication/rss+xml"
450 @router.get(config.get("base_url") + "/robots.txt", response_class=PlainTextResponse)
451 def robots(request: Request):
452 return templates.TemplateResponse("views/robots.txt", {
454 "base_url": config.get("base_url")
457 if __name__ == "__main__":
458 uvicorn.run("daemon:router", host=config.get("host"), port=config.get("port"), log_level=config.get("log_level"))