deltabot-cli 3.1.1__tar.gz → 3.2.2__tar.gz

{deltabot-cli-3.1.1/deltabot_cli.egg-info → deltabot-cli-3.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deltabot-cli
-Version: 3.1.1
+Version: 3.2.2
 Summary: Library to speedup Delta Chat bot development
 Author-email: adbenitez <adb@merlinux.eu>
 License: Mozilla Public License Version 2.0

{deltabot-cli-3.1.1 → deltabot-cli-3.2.2}/deltabot_cli/cli.py

@@ -108,10 +108,16 @@ class BotCli:
         self.add_generic_option(
             "--config-dir",
             "-c",
-            help="Program configuration folder (default: %(default)s)",
+            help="program configuration folder (default: %(default)s)",
             metavar="PATH",
             default=config_dir,
         )
+        self.add_generic_option(
+            "--account",
+            "-a",
+            help="operate over this account only when running any subcommand",
+            metavar="ADDR",
+        )
 
         init_parser = self.add_subcommand(_init_cmd, name="init")
         init_parser.add_argument("addr", help="the e-mail address to use")
@@ -123,6 +129,8 @@ class BotCli:
 
         self.add_subcommand(_serve_cmd, name="serve")
         self.add_subcommand(_qr_cmd, name="qr")
+        self.add_subcommand(_list_cmd, name="list")
+        self.add_subcommand(_remove_cmd, name="remove")
 
     def get_accounts_dir(self, args: Namespace) -> str:
         """Get bot's account folder."""
@@ -142,9 +150,12 @@ class BotCli:
         """Get account id for address.
         If no account exists with the given address, zero is returned.
         """
-        for accid in rpc.get_all_account_ids():
-            if addr == self.get_address(rpc, accid):
-                return accid
+        try:
+            return int(addr)
+        except ValueError:
+            for accid in rpc.get_all_account_ids():
+                if addr == self.get_address(rpc, accid):
+                    return accid
         return 0
 
     def get_address(self, rpc: Rpc, accid: int) -> str:
@@ -175,35 +186,10 @@ class BotCli:
                 self._parser.parse_args(["-h"])
 
 
-def _serve_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
-    """start processing messages"""
-    rpc = bot.rpc
-    accounts = rpc.get_all_account_ids()
-    addrs = []
-    for accid in accounts:
-        if rpc.is_configured(accid):
-            addrs.append(rpc.get_config(accid, "configured_addr"))
-        else:
-            bot.logger.error(f"account {accid} not configured")
-    if len(addrs) != 0:
-        bot.logger.info(f"Listening at: {', '.join(addrs)}")
-        cli._on_start(bot, args)  # noqa
-        while True:
-            try:
-                bot.run_forever()
-            except KeyboardInterrupt:
-                return
-            except Exception as ex:  # pylint:disable=W0703
-                bot.logger.exception(ex)
-                time.sleep(5)
-    else:
-        bot.logger.error("There are no configured accounts to serve")
-
-
 def _init_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
     """initialize the account"""
 
-    def on_progress(event: AttrDict) -> None:
+    def on_progress(bot: Bot, _accid: int, event: AttrDict) -> None:
         if event.comment:
             bot.logger.info(event.comment)
         pbar.set_progress(event.progress)
@@ -214,7 +200,13 @@ def _init_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
         except JsonRpcError as err:
             bot.logger.error(err)
 
-    accid = cli.get_or_create_account(bot.rpc, args.addr)
+    if args.account:
+        accid = cli.get_account(bot.rpc, args.account)
+        if not accid:
+            bot.logger.error(f"unknown account: {args.account!r}")
+            return
+    else:
+        accid = cli.get_or_create_account(bot.rpc, args.addr)
 
     bot.logger.info("Starting configuration process...")
     pbar = ConfigProgressBar()
@@ -230,9 +222,46 @@ def _init_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
         bot.logger.info("Account configured successfully.")
 
 
+def _serve_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
+    """start processing messages"""
+    rpc = bot.rpc
+    if args.account:
+        accounts = [cli.get_account(rpc, args.account)]
+        if not accounts[0]:
+            bot.logger.error(f"unknown account: {args.account!r}")
+            return
+    else:
+        accounts = rpc.get_all_account_ids()
+    addrs = []
+    for accid in accounts:
+        if rpc.is_configured(accid):
+            addrs.append(rpc.get_config(accid, "configured_addr"))
+        else:
+            bot.logger.error(f"account {accid} not configured")
+    if len(addrs) != 0:
+        bot.logger.info(f"Listening at: {', '.join(addrs)}")
+        cli._on_start(bot, args)  # noqa
+        while True:
+            try:
+                bot.run_forever(accounts[0] if args.account else 0)
+            except KeyboardInterrupt:
+                return
+            except Exception as ex:  # pylint:disable=W0703
+                bot.logger.exception(ex)
+                time.sleep(5)
+    else:
+        bot.logger.error("There are no configured accounts to serve")
+
+
 def _config_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
     """set/get account configuration values"""
-    accounts = bot.rpc.get_all_account_ids()
+    if args.account:
+        accounts = [cli.get_account(bot.rpc, args.account)]
+        if not accounts[0]:
+            bot.logger.error(f"unknown account: {args.account!r}")
+            return
+    else:
+        accounts = bot.rpc.get_all_account_ids()
     for accid in accounts:
         addr = cli.get_address(bot.rpc, accid)
         print(f"Account #{accid} ({addr}):")
@@ -259,9 +288,15 @@ def _config_cmd_for_acc(bot: Bot, accid: int, args: Namespace) -> None:
             print(f"{key}={value!r}")
 
 
-def _qr_cmd(cli: BotCli, bot: Bot, _args: Namespace) -> None:
+def _qr_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
     """get bot's verification QR"""
-    accounts = bot.rpc.get_all_account_ids()
+    if args.account:
+        accounts = [cli.get_account(bot.rpc, args.account)]
+        if not accounts[0]:
+            bot.logger.error(f"unknown account: {args.account!r}")
+            return
+    else:
+        accounts = bot.rpc.get_all_account_ids()
     for accid in accounts:
         addr = cli.get_address(bot.rpc, accid)
         print(f"Account #{accid} ({addr}):")
@@ -278,7 +313,41 @@ def _qr_cmd_for_acc(bot: Bot, accid: int) -> None:
         code = qrcode.QRCode()
         code.add_data(qrdata)
         code.print_ascii(invert=True)
-        fragment = qrdata.split(":", maxsplit=1)[1].replace("#", "&", count=1)
+        fragment = qrdata.split(":", maxsplit=1)[1].replace("#", "&", 1)
         print(f"https://i.delta.chat/#{fragment}")
     else:
         bot.logger.error("account not configured")
+
+
+def _list_cmd(cli: BotCli, bot: Bot, _args: Namespace) -> None:
+    """show a list of existing bot accounts"""
+    rpc = bot.rpc
+    accounts = rpc.get_all_account_ids()
+    for accid in accounts:
+        addr = cli.get_address(rpc, accid)
+        if not rpc.is_configured(accid):
+            addr = addr + " (not configured)"
+        print(f"#{accid} - {addr}")
+
+
+def _remove_cmd(cli: BotCli, bot: Bot, args: Namespace) -> None:
+    """remove Delta Chat accounts from the bot"""
+    if args.account:
+        accid = cli.get_account(bot.rpc, args.account)
+        if not accid:
+            bot.logger.error(f"unknown account: {args.account!r}")
+            return
+    else:
+        accounts = bot.rpc.get_all_account_ids()
+        if len(accounts) == 1:
+            accid = accounts[0]
+        else:
+            bot.logger.error(
+                "There are more than one account, to remove one of them, pass the account"
+                " address with -a/--account option"
+            )
+            return
+
+    addr = cli.get_address(bot.rpc, accid)
+    bot.rpc.remove_account(accid)
+    print(f"Account #{accid} ({addr}) removed successfully.")

{deltabot-cli-3.1.1 → deltabot-cli-3.2.2}/deltabot_cli/client.py

@@ -34,7 +34,6 @@ class Client:
         self.rpc = rpc
         self.logger = logger or logging
         self._hooks: Dict[type, Set[tuple]] = {}
-        self._should_process_messages = 0
         self.add_hooks(hooks or [])
 
     def add_hooks(self, hooks: Iterable[Tuple[HookCallback, Union[type, EventFilter]]]) -> None:
@@ -46,24 +45,12 @@ class Client:
         if isinstance(event, type):
             event = event()
         assert isinstance(event, EventFilter)
-        self._should_process_messages += int(
-            isinstance(
-                event,
-                (NewMessage, MemberListChanged, GroupImageChanged, GroupNameChanged),
-            ),
-        )
         self._hooks.setdefault(type(event), set()).add((hook, event))
 
     def remove_hook(self, hook: HookCallback, event: Union[type, EventFilter]) -> None:
         """Unregister hook from the given event filter."""
         if isinstance(event, type):
             event = event()
-        self._should_process_messages -= int(
-            isinstance(
-                event,
-                (NewMessage, MemberListChanged, GroupImageChanged, GroupNameChanged),
-            ),
-        )
         self._hooks.get(type(event), set()).remove((hook, event))
 
     def configure(self, accid: int, email: str, password: str, **kwargs) -> None:
@@ -74,11 +61,13 @@ class Client:
         self.rpc.configure(accid)
         self.logger.debug(f"Account {accid} configured")
 
-    def run_forever(self) -> None:
-        """Process events forever."""
-        self.run_until(lambda _: False)
+    def run_forever(self, accid: int = 0) -> None:
+        """Process events forever.
+        if accid != 0, only that account will be started.
+        """
+        self.run_until(lambda _: False, accid)
 
-    def run_until(self, func: Callable[[AttrDict], bool]) -> AttrDict:
+    def run_until(self, func: Callable[[AttrDict], bool], accid: int = 0) -> AttrDict:
         """Process events until the given callable evaluates to True.
 
         The callable should accept an AttrDict object representing the
@@ -86,10 +75,15 @@ class Client:
         evaluates to True.
         """
         self.logger.debug("Listening to incoming events...")
-        self.rpc.start_io_for_all_accounts()
-        for accid in self.rpc.get_all_account_ids():
+        if accid:
             if self.rpc.is_configured(accid):
+                self.rpc.start_io(accid)
                 self._process_messages(accid)  # Process old messages.
+        else:
+            self.rpc.start_io_for_all_accounts()
+            for acc_id in self.rpc.get_all_account_ids():
+                if self.rpc.is_configured(acc_id):
+                    self._process_messages(acc_id)  # Process old messages.
         while True:
             raw_event = self.rpc.get_next_event()
             accid = raw_event.context_id
@@ -173,14 +167,13 @@ class Client:
         )
 
     def _process_messages(self, accid: int) -> None:
-        if self._should_process_messages:
-            for msgid in self.rpc.get_next_msgs(accid):
-                msg = self.rpc.get_message(accid, msgid)
-                if msg.from_id not in [SpecialContactId.SELF, SpecialContactId.DEVICE]:
-                    self._on_new_msg(accid, msg)
-                if msg.is_info and msg.system_message_type != SystemMessageType.WEBXDC_INFO_MESSAGE:
-                    self._handle_info_msg(accid, msg)
-                self.rpc.markseen_msgs(accid, [msgid])
+        for msgid in self.rpc.get_next_msgs(accid):
+            msg = self.rpc.get_message(accid, msgid)
+            if msg.from_id not in [SpecialContactId.SELF, SpecialContactId.DEVICE]:
+                self._on_new_msg(accid, msg)
+            if msg.is_info and msg.system_message_type != SystemMessageType.WEBXDC_INFO_MESSAGE:
+                self._handle_info_msg(accid, msg)
+            self.rpc.set_config(accid, "last_msg_id", str(msgid))
 
 
 class Bot(Client):

{deltabot-cli-3.1.1 → deltabot-cli-3.2.2}/deltabot_cli/events.py

@@ -19,7 +19,7 @@ if TYPE_CHECKING:
     from ._utils import AttrDict
     from .client import Bot
 FilterCallback = Callable[["Bot", "AttrDict"], bool]
-HookCallback = Callable[["Bot", "AttrDict"], None]
+HookCallback = Callable[["Bot", int, "AttrDict"], None]
 HookDecorator = Callable[[HookCallback], HookCallback]
 
 
@@ -103,9 +103,6 @@ class RawEvent(EventFilter):
 class NewMessage(EventFilter):
     """Matches whenever a new message arrives.
 
-    Warning: registering a handler for this event will cause the messages
-    to be marked as read. Its usage is mainly intended for bots.
-
     :param pattern: if set, this Pattern will be used to filter the message by its text
                     content.
     :param command: If set, only match messages with the given command (ex. /help).
@@ -187,9 +184,6 @@ class NewMessage(EventFilter):
 class MemberListChanged(EventFilter):
     """Matches when a group member is added or removed.
 
-    Warning: registering a handler for this event will cause the messages
-    to be marked as read. Its usage is mainly intended for bots.
-
     :param added: If set to True only match if a member was added, if set to False
                   only match if a member was removed. If omitted both, member additions
                   and removals, will be matched.
@@ -218,9 +212,6 @@ class MemberListChanged(EventFilter):
 class GroupImageChanged(EventFilter):
     """Matches when the group image is changed.
 
-    Warning: registering a handler for this event will cause the messages
-    to be marked as read. Its usage is mainly intended for bots.
-
     :param deleted: If set to True only match if the image was deleted, if set to False
                     only match if a new image was set. If omitted both, image changes and
                     removals, will be matched.
@@ -249,9 +240,6 @@ class GroupImageChanged(EventFilter):
 class GroupNameChanged(EventFilter):
     """Matches when the group name is changed.
 
-    Warning: registering a handler for this event will cause the messages
-    to be marked as read. Its usage is mainly intended for bots.
-
     :param func: A Callable that should accept the bot and event as input parameter,
                  and return a bool value indicating whether the event should be dispatched or not.
     """

{deltabot-cli-3.1.1 → deltabot-cli-3.2.2/deltabot_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deltabot-cli
-Version: 3.1.1
+Version: 3.2.2
 Summary: Library to speedup Delta Chat bot development
 Author-email: adbenitez <adb@merlinux.eu>
 License: Mozilla Public License Version 2.0