fba/models/blocks.py

   1 # Fedi API Block - An aggregator for fetching blocking data from fediverse nodes
   2 # Copyright (C) 2023 Free Software Foundation
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published
   6 # by the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  16
  17 import logging
  18
  19 import time
  20
  21 from fba import database
  22
  23 from fba.helpers import blacklist
  24 from fba.helpers import domain as domain_helper
  25 from fba.helpers import tidyup
  26
  27 logging.basicConfig(level=logging.INFO)
  28 logger = logging.getLogger(__name__)
  29
  30 def update_reason(reason: str, blocker: str, blocked: str, block_level: str):
  31     logger.debug("reason='%s',blocker='%s',blocked='%s',block_level='%s' - CALLED!", reason, blocker, blocked, block_level)
  32     if not isinstance(reason, str) and reason is not None:
  33         raise ValueError(f"Parameter reason[]='{type(reason)}' is not 'str'")
  34     elif not isinstance(blocker, str):
  35         raise ValueError(f"Parameter blocker[]='{type(blocker)}' is not 'str'")
  36     elif blocker == "":
  37         raise ValueError("Parameter 'blocker' is empty")
  38     elif blocker.lower() != blocker:
  39         raise ValueError(f"Parameter blocker='{blocker}' must be all lower-case")
  40     elif not isinstance(blocked, str):
  41         raise ValueError(f"Parameter blocked[]='{type(blocked)}' is not 'str'")
  42     elif blocked == "":
  43         raise ValueError("Parameter 'blocked' is empty")
  44     elif blocked.lower() != blocked:
  45         raise ValueError(f"Parameter blocked='{blocked}' must be all lower-case")
  46     elif not isinstance(block_level, str):
  47         raise ValueError(f"Parameter block_level[]='{type(block_level)}' is not 'str'")
  48     elif block_level == "":
  49         raise ValueError("Parameter 'block_level' is empty")
  50     elif block_level in ["accept", "suspend", "silence"]:
  51         raise ValueError(f"block_level='{block_level}' is not wanted.")
  52
  53     logger.debug("Updating block reason='%s',blocker='%s',blocked='%s',block_level='%s'", reason, blocker, blocked, block_level)
  54     database.cursor.execute(
  55         "UPDATE blocks SET reason = ?, last_seen = ? WHERE blocker = ? AND blocked = ? AND block_level = ? AND (reason IS NULL OR reason = '') LIMIT 1",
  56         [
  57             reason,
  58             time.time(),
  59             blocker,
  60             blocked,
  61             block_level
  62         ])
  63
  64     logger.debug("EXIT!")
  65
  66 def update_last_seen(blocker: str, blocked: str, block_level: str):
  67     logger.debug("blocker='%s',blocked='%s',block_level='%s' - CALLED!", blocker, blocked, block_level)
  68     if not isinstance(blocker, str):
  69         raise ValueError(f"Parameter blocker[]='{type(blocker)}' is not 'str'")
  70     elif blocker == "":
  71         raise ValueError("Parameter 'blocker' is empty")
  72     elif blocker.lower() != blocker:
  73         raise ValueError(f"Parameter blocker='{blocker}' must be all lower-case")
  74     elif not isinstance(blocked, str):
  75         raise ValueError(f"Parameter blocked[]='{type(blocked)}' is not 'str'")
  76     elif blocked == "":
  77         raise ValueError("Parameter 'blocked' is empty")
  78     elif blocked.lower() != blocked:
  79         raise ValueError(f"Parameter blocked='{blocked}' must be all lower-case")
  80     elif not isinstance(block_level, str):
  81         raise ValueError(f"Parameter block_level[]='{type(block_level)}' is not 'str'")
  82     elif block_level == "":
  83         raise ValueError("Parameter 'block_level' is empty")
  84     elif block_level in ["accept", "suspend", "silence"]:
  85         raise ValueError(f"blocked='{blocked}' has unwanted block_level='{block_level}'")
  86
  87     database.cursor.execute(
  88         "UPDATE blocks SET last_seen = ? WHERE blocker = ? AND blocked = ? AND block_level = ? LIMIT 1",
  89         [
  90             time.time(),
  91             blocker,
  92             blocked,
  93             block_level
  94         ])
  95
  96     logger.debug("EXIT!")
  97
  98 def is_instance_blocked(blocker: str, blocked: str, block_level: str) -> bool:
  99     logger.debug("blocker='%s',blocked='%s',block_level='%s' - CALLED!", blocker, blocked, block_level)
 100     if not isinstance(blocker, str):
 101         raise ValueError(f"Parameter blocker[]='{type(blocker)}' is not of type 'str'")
 102     elif blocker == "":
 103         raise ValueError("Parameter 'blocker' is empty")
 104     elif blocker.lower() != blocker:
 105         raise ValueError(f"Parameter blocker='{blocker}' must be all lower-case")
 106     elif not isinstance(blocked, str):
 107         raise ValueError(f"Parameter blocked[]='{type(blocked)}' is not of type 'str'")
 108     elif blocked == "":
 109         raise ValueError("Parameter 'blocked' is empty")
 110     elif blocked.lower() != blocked:
 111         raise ValueError(f"Parameter blocked='{blocked}' must be all lower-case")
 112     elif not isinstance(block_level, str):
 113         raise ValueError(f"Parameter block_level[]='{type(block_level)}' is not of type 'str'")
 114     elif block_level == "":
 115         raise ValueError("Parameter 'block_level' is empty")
 116     elif block_level in ["accept", "suspend", "silence"]:
 117         raise ValueError(f"blocked='{blocked}' has unwanted block_level='{block_level}'")
 118
 119     database.cursor.execute(
 120         "SELECT * FROM blocks WHERE blocker = ? AND blocked = ? AND block_level = ? LIMIT 1",
 121         (
 122             blocker,
 123             blocked,
 124             block_level
 125         ),
 126     )
 127
 128     is_blocked = database.cursor.fetchone() is not None
 129
 130     logger.debug("is_blocked='%s' - EXIT!", is_blocked)
 131     return is_blocked
 132
 133 def add_instance(blocker: str, blocked: str, reason: str, block_level: str):
 134     logger.debug("blocker='%s',blocked='%s',reason='%s',block_level='%s' - CALLED!", blocker, blocked, reason, block_level)
 135     domain_helper.raise_on(blocker)
 136     domain_helper.raise_on(blocked)
 137
 138     if not isinstance(block_level, str):
 139         raise ValueError(f"Parameter block_level[]='{type(block_level)}' is not of type 'str'")
 140     elif block_level == "":
 141         raise ValueError("Parameter 'block_level' is empty")
 142     elif blacklist.is_blacklisted(blocker):
 143         raise Exception(f"blocker='{blocker}' is blacklisted but function invoked")
 144     elif blacklist.is_blacklisted(blocked):
 145         raise Exception(f"blocked='{blocked}' is blacklisted but function invoked")
 146     elif block_level in ["accept", "suspend", "silence"]:
 147         raise ValueError(f"blocked='{blocked}' has unwanted block_level='{block_level}'")
 148
 149     if reason is not None:
 150         # Maybe needs cleaning
 151         reason = tidyup.reason(reason)
 152
 153     logger.info("New block: blocker='%s',blocked='%s',reason='%s',block_level='%s'", blocker, blocked, reason, block_level)
 154
 155     database.cursor.execute(
 156         "INSERT INTO blocks (blocker, blocked, reason, block_level, first_seen, last_seen) VALUES (?, ?, ?, ?, ?, ?)",
 157         [
 158              blocker,
 159              blocked,
 160              reason,
 161              block_level,
 162              time.time(),
 163              time.time()
 164         ])
 165
 166     logger.debug("EXIT!")
 167
 168 def is_valid_level(block_level: str) -> bool:
 169     logger.debug("block_level='%s' - CALLED!", block_level)
 170     if not isinstance(block_level, str):
 171         raise ValueError(f"Parameter block_level[]='{type(block_level)}' is not of type 'str'")
 172     elif block_level == "":
 173         raise ValueError("Parameter 'block_level' is empty")
 174
 175     # Query database
 176     database.cursor.execute(
 177         "SELECT block_level FROM blocks WHERE block_level = ? LIMIT 1", [block_level]
 178     )
 179
 180     valid = database.cursor.fetchone() is not None
 181
 182     logger.debug("valid='%s' - EXIT!", valid)
 183     return valid