fba/helpers/software.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 from fba.helpers import tidyup
  20
  21 logging.basicConfig(level=logging.INFO)
  22 logger = logging.getLogger(__name__)
  23
  24 # A list of relay software
  25 relays = [
  26     "activityrelay",
  27     "aoderelay",
  28     "selective-relay",
  29     "pub-relay"
  30 ]
  31
  32 def alias(software: str) -> str:
  33     logger.debug("software='%s'- CALLED!", software)
  34
  35     if not isinstance(software, str) and software is not None:
  36         raise ValueError(f"software[]='{type(software)}' is not type 'str'")
  37
  38     logger.debug("software='%s'- BEFORE!", software)
  39     software = tidyup.domain(software)
  40     logger.debug("software='%s'- AFTER!", software)
  41
  42     if software in ["akkoma", "rebased", "akkounfucked", "ched", "incestoma", "revolver"]:
  43         logger.debug("Setting pleroma: software='%s'", software)
  44         software = "pleroma"
  45     elif "radiant" in software:
  46         logger.debug("Setting radiant: software='%s'", software)
  47         software = "radiant"
  48     elif software in ["hometown", "ecko", "fedibird", "glitchcafe"] or "되는 마스토돈" in software or "mastodon" in software:
  49         logger.debug("Setting mastodon: software='%s'", software)
  50         software = "mastodon"
  51     elif software in ["slipfox calckey", "calckey", "groundpolis", "foundkey", "cherrypick", "meisskey", "magnetar", "keybump", "dolphin", "calckey social", "azk.sns", "firefish", "qtmmsky", "iceshrimp", "owohub", "re＋", "russkey", "loverskey", "hajkey"] or "shumihub" in software or "мисскей" in software or "milkey" in software or "misskey" in software:
  52         logger.debug("Setting misskey: software='%s'", software)
  53         software = "misskey"
  54     elif software in ["runtube.re", "islameye"]:
  55         logger.debug("Setting peertube: software='%s'", software)
  56         software = "peertube"
  57     elif software in ["nextcloud social", "nextcloudpi", "storage share", "nube"] or "nextcloud" in software:
  58         logger.debug("Setting nextcloud: software='%s'", software)
  59         software = "nextcloud"
  60     elif "discourse" in software:
  61         logger.debug("Setting discourse: software='%s'", software)
  62         software = "discourse"
  63     elif software == "activity-relay":
  64         logger.debug("Setting activityrelay: software='%s'", software)
  65         software = "activityrelay"
  66     elif "owncast" in software:
  67         logger.debug("Setting owncast: software='%s'", software)
  68         software = "owncast"
  69     elif software in ["streams-hubzilla-social", "streams13"]:
  70         logger.debug("Setting streams: software='%s'", software)
  71         software = "streams"
  72     elif software == "roadhouse":
  73         logger.debug("Setting hubzilla: software='%s'", software)
  74         software = "hubzilla"
  75     elif software == "takahē":
  76         logger.debug("Setting takahe: software='%s'", software)
  77         software = "takahe"
  78     elif software == "diaspora* social network":
  79         logger.debug("Setting diaspora: software='%s'", software)
  80         software = "diaspora"
  81     elif software == "tkz relay":
  82         logger.debug("Setting aoderelay: software='%s'", software)
  83         software = "aoderelay"
  84     elif software == "gitdab":
  85         logger.debug("Setting forgejo: software='%s'", software)
  86         software = "forgejo"
  87     elif "gnu social" in software:
  88         logger.debug("Setting gnusocial: software='%s'", software)
  89         software = "gnusocial"
  90     elif software.find("/") > 0:
  91         logger.warning("Spliting of slash: software='%s'", software)
  92         software = software.split("/")[-1]
  93     elif software.find("|") > 0:
  94         logger.warning("Spliting of pipe: software='%s'", software)
  95         software = software.split("|")[0]
  96     elif "powered by" in software:
  97         logger.debug("software='%s' has 'powered by' in it", software)
  98         software = strip_powered_by(software)
  99     elif software.endswith(" experimental"):
 100         logger.debug("software='%s' ends with 'experimental", software)
 101         software = strip_until(software, "experimental")
 102
 103     if isinstance(software, str) and " by " in software:
 104         logger.debug("software='%s' has ' by ' in it", software)
 105         software = strip_until(software, " by ")
 106     elif isinstance(software, str) and " - " in software:
 107         logger.debug("software='%s' has ' - ' in it", software)
 108         software = strip_until(software, " - ")
 109     elif isinstance(software, str) and " see " in software:
 110         logger.debug("software='%s' has ' see ' in it", software)
 111         software = strip_until(software, " see ")
 112
 113     logger.debug("software['%s']='%s'", type(software), software)
 114     if software == "":
 115         logger.warning("tidyup.domain() left no software name behind: software='%s'", software)
 116         software = None
 117     else:
 118         logger.debug("software='%s' is being cleaned up further ...")
 119         software = software.rstrip("!").strip()
 120
 121     logger.debug("software[%s]='%s' - EXIT!", type(software), software)
 122     return software
 123
 124 def strip_hosted_on(software: str) -> str:
 125     logger.debug("software='%s' - CALLED!", software)
 126
 127     if not isinstance(software, str):
 128         raise ValueError(f"Parameter software[]='{type(software)}' is not of type 'str'")
 129     elif software == "":
 130         raise ValueError("Parameter 'software' is empty")
 131     elif "hosted on" not in software:
 132         logger.warning("Cannot find 'hosted on' in software='%s'!", software)
 133         return software
 134
 135     end = software.find("hosted on ")
 136     logger.debug("end[%s]=%d", type(end), end)
 137
 138     software = software[0:end].strip()
 139     logger.debug("software[%s]='%s'", type(software), software)
 140
 141     if " - " in software:
 142         logger.debug("Stripping ' - ' of from software='%s' ...", software)
 143         software = strip_until(software, " - ").strip()
 144
 145     logger.debug("software='%s' - EXIT!", software)
 146     return software
 147
 148 def strip_powered_by(software: str) -> str:
 149     logger.debug("software='%s' - CALLED!", software)
 150     if not isinstance(software, str):
 151         raise ValueError(f"Parameter software[]='{type(software)}' is not of type 'str'")
 152     elif software == "":
 153         raise ValueError("Parameter 'software' is empty")
 154     elif "powered by" not in software:
 155         logger.warning("Cannot find 'powered by' in software='%s'!", software)
 156         return software
 157
 158     start = software.find("powered by ")
 159     logger.debug("start[%s]=%d", type(start), start)
 160
 161     software = software[start + 11:].strip()
 162     logger.debug("software='%s'", software)
 163
 164     if " - " in software:
 165         logger.debug("Stripping ' - ' of from software='%s' ...", software)
 166         software = strip_until(software, " - ").strip()
 167
 168     logger.debug("software='%s' - EXIT!", software)
 169     return software
 170
 171 def strip_until(software: str, until: str) -> str:
 172     logger.debug("software='%s',until='%s' - CALLED!", software, until)
 173
 174     if not isinstance(software, str):
 175         raise ValueError(f"Parameter software[]='{type(software)}' is not of type 'str'")
 176     elif software == "":
 177         raise ValueError("Parameter 'software' is empty")
 178     elif not isinstance(until, str):
 179         raise ValueError(f"Parameter until[]='{type(until)}' is not of type 'str'")
 180     elif until == "":
 181         raise ValueError("Parameter 'until' is empty")
 182     elif not until in software:
 183         logger.warning("Cannot find until='%s' in software='%s'!", until, software)
 184         return software
 185
 186     # Next, strip until part
 187     end = software.strip().find(until)
 188
 189     logger.debug("end[%s]=%d", type(end), end)
 190     if end > 0:
 191         software = software[0:end].strip()
 192
 193     logger.debug("software='%s' - EXIT!", software)
 194     return software
 195
 196 def is_relay(software: str) -> bool:
 197     logger.debug("software='%s'- CALLED!", software)
 198
 199     if not isinstance(software, str) and software is not None:
 200         raise ValueError(f"software[]='{type(software)}' is not type 'str'")
 201
 202     found = software in relays
 203     logger.debug("found='%s' - EXIT!", found)
 204     return found