"""Main logging part""" # Friendly Telegram (telegram userbot) # Copyright (C) 2018-2021 The Authors # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . # █ █ ▀ █▄▀ ▄▀█ █▀█ ▀ # █▀█ █ █ █ █▀█ █▀▄ █ # © Copyright 2022 # https://t.me/hikariatama # # 🔒 Licensed under the GNU AGPLv3 # 🌐 https://www.gnu.org/licenses/agpl-3.0.html import asyncio import contextlib import inspect import json import logging import io import os import re import telethon import traceback from typing import Optional from logging.handlers import RotatingFileHandler from . import utils from ._types import Module, BotInlineCall class HikkaException: def __init__(self, message: str, local_vars: str, full_stack: str): self.message = message self.local_vars = local_vars self.full_stack = full_stack @classmethod def from_exc_info( cls, exc_type: object, exc_value: Exception, tb: traceback.TracebackException, ) -> "HikkaException": def to_hashable(dictionary: dict) -> dict: dictionary = dictionary.copy() for key, value in dictionary.items(): if isinstance(value, dict): if ( getattr(getattr(value, "__class__", None), "__name__", None) == "Database" ): dictionary[key] = "" if isinstance(value, telethon.TelegramClient): dictionary[key] = "" dictionary[key] = to_hashable(value) else: try: json.dumps([value]) except Exception: dictionary[key] = str(value) return dictionary full_stack = traceback.format_exc().replace( "Traceback (most recent call last):\n", "" ) line_regex = r' File "(.*?)", line ([0-9]+), in (.+)' def format_line(line: str) -> str: filename_, lineno_, name_ = re.search(line_regex, line).groups() with contextlib.suppress(Exception): filename_ = os.path.basename(filename_) return ( f"👉 {utils.escape_html(filename_)}:{lineno_} in" f" {utils.escape_html(name_)}" ) filename, lineno, name = next( ( re.search(line_regex, line).groups() for line in full_stack.splitlines() if re.search(line_regex, line) ), (None, None, None), ) line = next( (line for line in full_stack.splitlines() if line.startswith(" ")), "" ) full_stack = "\n".join( [ format_line(line) if re.search(line_regex, line) else f"{utils.escape_html(line)}" for line in full_stack.splitlines() ] ) with contextlib.suppress(Exception): filename = os.path.basename(filename) return HikkaException( message=( "🚫 Error!\n🗄 Where:" f" {utils.escape_html(filename)}:{lineno}" f" in {utils.escape_html(name)}\n😵" f" {utils.escape_html(line)}" " 👈\n❓ What:" f" {utils.escape_html(''.join(traceback.format_exception_only(exc_type, exc_value)).strip())}" ), local_vars=( f"{utils.escape_html(json.dumps(to_hashable(tb.tb_frame.f_locals), indent=4))}" ), full_stack=full_stack, ) class TelegramLogsHandler(logging.Handler): """ Keeps 2 buffers. One for dispatched messages. One for unused messages. When the length of the 2 together is 100 truncate to make them 100 together, first trimming handled then unused. """ def __init__(self, targets: list, capacity: int): super().__init__(0) self.targets = targets self.capacity = capacity self.buffer = [] self.handledbuffer = [] self.lvl = logging.NOTSET # Default loglevel self._queue = [] self.tg_buff = [] self._mods = {} self.force_send_all = False def install_tg_log(self, mod: Module): if getattr(self, "_task", False): self._task.cancel() self._mods[mod.tg_id] = mod self._task = asyncio.ensure_future(self.queue_poller()) async def queue_poller(self): while True: await self.sender() await asyncio.sleep(3) def setLevel(self, level: int): self.lvl = level def dump(self): """Return a list of logging entries""" return self.handledbuffer + self.buffer def dumps(self, lvl: Optional[int] = 0, client_id: Optional[int] = None) -> list: """Return all entries of minimum level as list of strings""" return [ self.targets[0].format(record) for record in (self.buffer + self.handledbuffer) if record.levelno >= lvl and (not record.hikka_caller or client_id == record.hikka_caller) ] async def _show_full_stack( self, call: BotInlineCall, bot: "aiogram.Bot", # type: ignore item: HikkaException, ): chunks = ( item.message + "\n\n🦝 Locals:\n" + item.local_vars + "\n\n" + "🪐 Full stack:\n" + item.full_stack ) chunks = list(utils.smart_split(*telethon.extensions.html.parse(chunks), 4096)) await call.edit(chunks[0]) for chunk in chunks[1:]: await bot.send_message(chat_id=call.chat_id, text=chunk) async def sender(self): self._queue = { client_id: utils.chunks( utils.escape_html( "".join( [ item[0] for item in self.tg_buff if isinstance(item[0], str) and ( not item[1] or item[1] == client_id or self.force_send_all ) ] ) ), 4096, ) for client_id in self._mods } self._exc_queue = { client_id: [ self._mods[client_id].inline.bot.send_message( self._mods[client_id]._logchat, item[0].message, reply_markup=self._mods[client_id].inline.generate_markup( { "text": "🪐 Full stack", "callback": self._show_full_stack, "args": ( self._mods[client_id].inline.bot, item[0], ), } ), ) for item in self.tg_buff if isinstance(item[0], HikkaException) and (not item[1] or item[1] == client_id or self.force_send_all) ] for client_id in self._mods } for client_id, exceptions in self._exc_queue.items(): for exc in exceptions: await exc self.tg_buff = [] for client_id in self._mods: if client_id not in self._queue: continue if len(self._queue[client_id]) > 5: logfile = io.BytesIO("".join(self._queue[client_id]).encode("utf-8")) logfile.name = "hikka-logs.txt" logfile.seek(0) await self._mods[client_id].inline.bot.send_document( self._mods[client_id]._logchat, logfile, caption=( "🧳 Journals are too big to be sent as separate messages" ), ) self._queue[client_id] = [] continue while self._queue[client_id]: if chunk := self._queue[client_id].pop(0): asyncio.ensure_future( self._mods[client_id].inline.bot.send_message( self._mods[client_id]._logchat, f"{chunk}", disable_notification=True, ) ) def emit(self, record: logging.LogRecord): try: caller = next( ( frame_info.frame.f_locals["_hikka_client_id_logging_tag"] for frame_info in inspect.stack() if isinstance( getattr(getattr(frame_info, "frame", None), "f_locals", {}).get( "_hikka_client_id_logging_tag" ), int, ) ), False, ) if not isinstance(caller, int): caller = None except Exception: caller = None record.hikka_caller = caller if record.levelno >= 20: if record.exc_info: self.tg_buff += [ ( HikkaException.from_exc_info(*record.exc_info), caller, ) ] else: self.tg_buff += [ ( _tg_formatter.format(record), caller, ) ] if len(self.buffer) + len(self.handledbuffer) >= self.capacity: if self.handledbuffer: del self.handledbuffer[0] else: del self.buffer[0] self.buffer.append(record) if record.levelno >= self.lvl >= 0: self.acquire() try: for precord in self.buffer: for target in self.targets: if record.levelno >= target.level: target.handle(precord) self.handledbuffer = ( self.handledbuffer[-(self.capacity - len(self.buffer)) :] + self.buffer ) self.buffer = [] finally: self.release() _main_formatter = logging.Formatter( fmt="%(asctime)s [%(levelname)s] %(name)s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S", style="%", ) _tg_formatter = logging.Formatter( fmt="[%(levelname)s] %(name)s: %(message)s\n", datefmt=None, style="%", ) rotating_handler = RotatingFileHandler( filename="hikka.log", mode="a", maxBytes=10 * 1024 * 1024, backupCount=1, encoding="utf-8", delay=0, ) rotating_handler.setFormatter(_main_formatter) def init(): handler = logging.StreamHandler() handler.setLevel(logging.INFO) handler.setFormatter(_main_formatter) logging.getLogger().handlers = [] logging.getLogger().addHandler( TelegramLogsHandler((handler, rotating_handler), 7000) ) logging.getLogger().setLevel(logging.NOTSET) logging.getLogger("telethon").setLevel(logging.WARNING) logging.getLogger("matplotlib").setLevel(logging.WARNING) logging.getLogger("aiohttp").setLevel(logging.WARNING) logging.getLogger("aiogram").setLevel(logging.WARNING) logging.captureWarnings(True)