216 lines
6.2 KiB
Python
216 lines
6.2 KiB
Python
"""
|
|
functionality:
|
|
- interact with redis
|
|
- hold temporary download queue in redis
|
|
- interact with celery tasks results
|
|
"""
|
|
|
|
import json
|
|
|
|
import redis
|
|
from home.src.ta.settings import EnvironmentSettings
|
|
|
|
|
|
class RedisBase:
|
|
"""connection base for redis"""
|
|
|
|
NAME_SPACE: str = EnvironmentSettings.REDIS_NAME_SPACE
|
|
|
|
def __init__(self):
|
|
self.conn = redis.Redis(
|
|
host=EnvironmentSettings.REDIS_HOST,
|
|
port=EnvironmentSettings.REDIS_PORT,
|
|
)
|
|
|
|
|
|
class RedisArchivist(RedisBase):
|
|
"""collection of methods to interact with redis"""
|
|
|
|
CHANNELS: list[str] = [
|
|
"download",
|
|
"add",
|
|
"rescan",
|
|
"subchannel",
|
|
"subplaylist",
|
|
"playlistscan",
|
|
"setting",
|
|
]
|
|
|
|
def set_message(
|
|
self,
|
|
key: str,
|
|
message: dict,
|
|
path: str = ".",
|
|
expire: bool | int = False,
|
|
save: bool = False,
|
|
) -> None:
|
|
"""write new message to redis"""
|
|
self.conn.execute_command(
|
|
"JSON.SET", self.NAME_SPACE + key, path, json.dumps(message)
|
|
)
|
|
|
|
if expire:
|
|
if isinstance(expire, bool):
|
|
secs: int = 20
|
|
else:
|
|
secs = expire
|
|
self.conn.execute_command("EXPIRE", self.NAME_SPACE + key, secs)
|
|
|
|
if save:
|
|
self.bg_save()
|
|
|
|
def bg_save(self) -> None:
|
|
"""save to aof"""
|
|
try:
|
|
self.conn.bgsave()
|
|
except redis.exceptions.ResponseError:
|
|
pass
|
|
|
|
def get_message(self, key: str) -> dict:
|
|
"""get message dict from redis"""
|
|
reply = self.conn.execute_command("JSON.GET", self.NAME_SPACE + key)
|
|
if reply:
|
|
return json.loads(reply)
|
|
|
|
return {"status": False}
|
|
|
|
def list_keys(self, query: str) -> list:
|
|
"""return all key matches"""
|
|
reply = self.conn.execute_command(
|
|
"KEYS", self.NAME_SPACE + query + "*"
|
|
)
|
|
if not reply:
|
|
return []
|
|
|
|
return [i.decode().lstrip(self.NAME_SPACE) for i in reply]
|
|
|
|
def list_items(self, query: str) -> list:
|
|
"""list all matches"""
|
|
all_matches = self.list_keys(query)
|
|
if not all_matches:
|
|
return []
|
|
|
|
return [self.get_message(i) for i in all_matches]
|
|
|
|
def del_message(self, key: str) -> bool:
|
|
"""delete key from redis"""
|
|
response = self.conn.execute_command("DEL", self.NAME_SPACE + key)
|
|
return response
|
|
|
|
|
|
class RedisQueue(RedisBase):
|
|
"""dynamically interact with queues in redis"""
|
|
|
|
def __init__(self, queue_name: str):
|
|
super().__init__()
|
|
self.key = f"{self.NAME_SPACE}{queue_name}"
|
|
|
|
def get_all(self):
|
|
"""return all elements in list"""
|
|
result = self.conn.execute_command("LRANGE", self.key, 0, -1)
|
|
all_elements = [i.decode() for i in result]
|
|
return all_elements
|
|
|
|
def length(self) -> int:
|
|
"""return total elements in list"""
|
|
return self.conn.execute_command("LLEN", self.key)
|
|
|
|
def in_queue(self, element) -> str | bool:
|
|
"""check if element is in list"""
|
|
result = self.conn.execute_command("LPOS", self.key, element)
|
|
if result is not None:
|
|
return "in_queue"
|
|
|
|
return False
|
|
|
|
def add_list(self, to_add):
|
|
"""add list to queue"""
|
|
self.conn.execute_command("RPUSH", self.key, *to_add)
|
|
|
|
def add_priority(self, to_add: str) -> None:
|
|
"""add single video to front of queue"""
|
|
item: str = json.dumps(to_add)
|
|
self.clear_item(item)
|
|
self.conn.execute_command("LPUSH", self.key, item)
|
|
|
|
def get_next(self) -> str | bool:
|
|
"""return next element in the queue, False if none"""
|
|
result = self.conn.execute_command("LPOP", self.key)
|
|
if not result:
|
|
return False
|
|
|
|
next_element = result.decode()
|
|
return next_element
|
|
|
|
def clear(self) -> None:
|
|
"""delete list from redis"""
|
|
self.conn.execute_command("DEL", self.key)
|
|
|
|
def clear_item(self, to_clear: str) -> None:
|
|
"""remove single item from list if it's there"""
|
|
self.conn.execute_command("LREM", self.key, 0, to_clear)
|
|
|
|
def trim(self, size: int) -> None:
|
|
"""trim the queue based on settings amount"""
|
|
self.conn.execute_command("LTRIM", self.key, 0, size)
|
|
|
|
def has_item(self) -> bool:
|
|
"""check if queue as at least one pending item"""
|
|
result = self.conn.execute_command("LRANGE", self.key, 0, 0)
|
|
return bool(result)
|
|
|
|
|
|
class TaskRedis(RedisBase):
|
|
"""interact with redis tasks"""
|
|
|
|
BASE: str = "celery-task-meta-"
|
|
EXPIRE: int = 60 * 60 * 24
|
|
COMMANDS: list[str] = ["STOP", "KILL"]
|
|
|
|
def get_all(self) -> list:
|
|
"""return all tasks"""
|
|
all_keys = self.conn.execute_command("KEYS", f"{self.BASE}*")
|
|
return [i.decode().replace(self.BASE, "") for i in all_keys]
|
|
|
|
def get_single(self, task_id: str) -> dict:
|
|
"""return content of single task"""
|
|
result = self.conn.execute_command("GET", self.BASE + task_id)
|
|
if not result:
|
|
return {}
|
|
|
|
return json.loads(result.decode())
|
|
|
|
def set_key(
|
|
self, task_id: str, message: dict, expire: bool | int = False
|
|
) -> None:
|
|
"""set value for lock, initial or update"""
|
|
key: str = f"{self.BASE}{task_id}"
|
|
self.conn.execute_command("SET", key, json.dumps(message))
|
|
|
|
if expire:
|
|
self.conn.execute_command("EXPIRE", key, self.EXPIRE)
|
|
|
|
def set_command(self, task_id: str, command: str) -> None:
|
|
"""set task command"""
|
|
if command not in self.COMMANDS:
|
|
print(f"{command} not in valid commands {self.COMMANDS}")
|
|
raise ValueError
|
|
|
|
message = self.get_single(task_id)
|
|
if not message:
|
|
print(f"{task_id} not found")
|
|
raise KeyError
|
|
|
|
message.update({"command": command})
|
|
self.set_key(task_id, message)
|
|
|
|
def del_task(self, task_id: str) -> None:
|
|
"""delete task result by id"""
|
|
self.conn.execute_command("DEL", f"{self.BASE}{task_id}")
|
|
|
|
def del_all(self) -> None:
|
|
"""delete all task results"""
|
|
all_tasks = self.get_all()
|
|
for task_id in all_tasks:
|
|
self.del_task(task_id)
|