1
0
Fork 0
slidge-whatsapp/slidge_whatsapp/gateway.py

98 lines
3.1 KiB
Python

from logging import getLogger
from pathlib import Path
from shelve import open
from typing import TYPE_CHECKING
from slidge import BaseGateway, FormField, GatewayUser, global_config
from . import config
from .generated import whatsapp
if TYPE_CHECKING:
from .session import Session
REGISTRATION_INSTRUCTIONS = (
"Continue and scan the resulting QR codes on your main device, or alternatively, "
"use the 'pair-phone' command to complete registration. More information at "
"https://slidge.im/slidge-whatsapp/user.html"
)
WELCOME_MESSAGE = (
"Thank you for registering! Please scan the following QR code on your main device "
"or use the 'pair-phone' command to complete registration, or type 'help' to list "
"other available commands."
)
class Gateway(BaseGateway):
COMPONENT_NAME = "WhatsApp (slidge)"
COMPONENT_TYPE = "whatsapp"
COMPONENT_AVATAR = "https://www.whatsapp.com/apple-touch-icon.png"
REGISTRATION_INSTRUCTIONS = REGISTRATION_INSTRUCTIONS
WELCOME_MESSAGE = WELCOME_MESSAGE
REGISTRATION_FIELDS = []
SEARCH_FIELDS = [
FormField(var="phone", label="Phone number", required=True),
]
ROSTER_GROUP = "WhatsApp"
MARK_ALL_MESSAGES = True
GROUPS = True
PROPER_RECEIPTS = True
def __init__(self):
super().__init__()
Path(config.DB_PATH.parent).mkdir(exist_ok=True)
(global_config.HOME_DIR / "tmp").mkdir(exist_ok=True)
self.whatsapp = whatsapp.NewGateway()
self.whatsapp.SetLogHandler(handle_log)
self.whatsapp.DBPath = str(config.DB_PATH)
self.whatsapp.Name = "Slidge on " + str(global_config.JID)
self.whatsapp.TempDir = str(global_config.HOME_DIR / "tmp")
self.whatsapp.Init()
async def validate(self, user_jid, registration_form):
"""
Validate registration form. A no-op for WhatsApp, as actual registration takes place
after in-band registration commands complete.
"""
pass
async def unregister(self, user: GatewayUser):
"""
Logout from the active WhatsApp session. This will also force a remote log-out, and thus
require pairing on next login. For simply disconnecting the active session, look at the
:meth:`.Session.disconnect` function.
"""
session: "Session" = self.get_session_from_user(user) # type:ignore
session.whatsapp.Logout()
with open(str(session.user_shelf_path)) as shelf:
try:
device = whatsapp.LinkedDevice(ID=shelf["device_id"])
self.whatsapp.CleanupSession(device)
except KeyError:
pass
except RuntimeError as err:
log.error("Failed to clean up WhatsApp session: %s", err)
session.user_shelf_path.unlink()
def handle_log(level, msg: str):
"""
Log given message of specified level in system-wide logger.
"""
if level == whatsapp.LevelError:
log.error(msg)
elif level == whatsapp.LevelWarning:
log.warning(msg)
elif level == whatsapp.LevelDebug:
log.debug(msg)
else:
log.info(msg)
log = getLogger(__name__)