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