fba/helpers/cache.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 logging.basicConfig(level=logging.INFO)
  20 logger = logging.getLogger(__name__)
  21
  22 # Cache for redundant SQL queries
  23 _cache = {}
  24
  25 ##### Cache #####
  26
  27 def key_exists(key: str) -> bool:
  28     return key in _cache
  29
  30 def set_all(key: str, rows: list, value: any):
  31     logger.debug(f"key='{key}',rows()={len(rows)},value[]='{type(value)}' - CALLED!")
  32     if not isinstance(key, str):
  33         raise ValueError("Parameter key[]='{type(key)}' is not 'str'")
  34     elif not key_exists(key):
  35         logger.debug(f"Cache for key='{key}' not initialized.")
  36         _cache[key] = {}
  37
  38     for sub in rows:
  39         logger.debug(f"Setting key='{key}',sub[{type(sub)}]='{sub}'")
  40         if isinstance(sub, tuple):
  41             logger.debug(f"Setting key='{key}',sub[{type(sub)}]='{sub}',value[]='{type(value)}'")
  42             _cache[key][sub[0]] = value
  43         else:
  44             logger.warning(f"Unsupported type sub[]='{type(sub)}'")
  45
  46     logger.debug("EXIT!")
  47
  48 def set_sub_key(key: str, sub: str, value: any):
  49     logger.debug(f"key='{key}',sub='{sub}',value[]='{type(value)}' - CALLED!")
  50     if not isinstance(key, str):
  51         raise ValueError("Parameter key[]='{type(key)}' is not 'str'")
  52     elif not isinstance(sub, str):
  53         raise ValueError("Parameter sub[]='{type(sub)}' is not 'str'")
  54     elif not key_exists(key):
  55         raise Exception(f"Cache for key='{key}' is not initialized, but function invoked")
  56
  57     logger.debug(f"Setting key='{key}',sub='{sub}',value[]='{type(value)}' ...")
  58     _cache[key][sub] = value
  59
  60     logger.debug("EXIT!")
  61
  62 def sub_key_exists(key: str, sub: str) -> bool:
  63     logger.debug(f"key='{key}',sub='{sub}' - CALLED!")
  64     if not isinstance(key, str):
  65         raise ValueError("Parameter key[]='{type(key)}' is not 'str'")
  66     elif not isinstance(sub, str):
  67         raise ValueError("Parameter sub[]='{type(sub)}' is not 'str'")
  68     elif not key_exists(key):
  69         raise Exception(f"Cache for key='{key}' is not initialized, but function invoked")
  70
  71     exists = sub in _cache[key]
  72
  73     logger.debug(f"exists='{exists}' - EXIT!")
  74     return exists