view libervia/tui/notify.py @ 4306:94e0968987cd

plugin XEP-0033: code modernisation, improve delivery, data validation: - Code has been rewritten using Pydantic models and `async` coroutines for data validation and cleaner element parsing/generation. - Delivery has been completely rewritten. It now works even if server doesn't support multicast, and send to local multicast service first. Delivering to local multicast service first is due to bad support of XEP-0033 in server (notably Prosody which has an incomplete implementation), and the current impossibility to detect if a sub-domain service handles fully multicast or only for local domains. This is a workaround to have a good balance between backward compatilibity and use of bandwith, and to make it work with the incoming email gateway implementation (the gateway will only deliver to entities of its own domain). - disco feature checking now uses `async` corountines. `host` implementation still use Deferred return values for compatibility with legacy code. rel 450
author Goffi <goffi@goffi.org>
date Thu, 26 Sep 2024 16:12:01 +0200
parents b620a8e882e1
children
line wrap: on
line source

#!/usr/bin/env python3


# Libervia TUI
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)

# 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 <http://www.gnu.org/licenses/>.

import dbus


class Notify(object):
    """Used to send notification and detect if we have focus"""

    def __init__(self):

        # X11 stuff
        self.display = None
        self.X11_id = -1

        try:
            from Xlib import display as X_display

            self.display = X_display.Display()
            self.X11_id = self.get_focus()
        except:
            pass

        # Now we try to connect to Freedesktop D-Bus API
        try:
            bus = dbus.SessionBus()
            db_object = bus.get_object(
                "org.freedesktop.Notifications",
                "/org/freedesktop/Notifications",
                follow_name_owner_changes=True,
            )
            self.freedesktop_int = dbus.Interface(
                db_object, dbus_interface="org.freedesktop.Notifications"
            )
        except:
            self.freedesktop_int = None

    def get_focus(self):
        if not self.display:
            return 0
        return self.display.get_input_focus().focus.id

    def has_focus(self):
        return (self.get_focus() == self.X11_id) if self.display else True

    def use_x11(self):
        return bool(self.display)

    def send_notification(self, summ_mess, body_mess=""):
        """Send notification to the user if possible"""
        # TODO: check options before sending notifications
        if self.freedesktop_int:
            self.send_fd_notification(summ_mess, body_mess)

    def send_fd_notification(self, summ_mess, body_mess=""):
        """Send notification with the FreeDesktop D-Bus API"""
        if self.freedesktop_int:
            app_name = "LiberviaTUI"
            replaces_id = 0
            app_icon = ""
            summary = summ_mess
            body = body_mess
            actions = dbus.Array(signature="s")
            hints = dbus.Dictionary(signature="sv")
            expire_timeout = -1

            self.freedesktop_int.Notify(
                app_name,
                replaces_id,
                app_icon,
                summary,
                body,
                actions,
                hints,
                expire_timeout,
            )