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