File: notifyplugin.py

package info (click to toggle)
backintime 1.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 10,424 kB
  • sloc: python: 27,312; sh: 886; makefile: 174; xml: 62
file content (73 lines) | stat: -rw-r--r-- 2,472 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# SPDX-FileCopyrightText: © 2008-2022 Oprea Dan
# SPDX-FileCopyrightText: © 2008-2022 Bart de Koning
# SPDX-FileCopyrightText: © 2008-2022 Richard Bailey
# SPDX-FileCopyrightText: © 2008-2022 Germar Reitze
# SPDX-FileCopyrightText: © 2021 Felix Stupp
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
# This file is part of the program "Back In Time" which is released under GNU
# General Public License v2 (GPLv2). See LICENSES directory or go to
# <https://spdx.org/licenses/GPL-2.0-or-later.html>.
"""Notify plugin module"""
import getpass
import dbus
import pluginmanager
import logger


class NotifyPlugin(pluginmanager.Plugin):
    """Plugin used to create notification bubbles in systray.

    The plugin use DBUS to send notifications. See its base class for more
    details.
    """

    def isGui(self):  # noqa: N802
        return True

    # pylint: disable-next=too-many-arguments,too-many-positional-arguments
    def message(self,
                profile_id,
                profile_name,
                level,
                message,
                timeout):
        # 1 is ERROR, 0 is INFO
        if level != 1:
            # Dev note (2024-10, buhtz):
            # Message with level 0/INFO for example generatet by
            # setTakeSnapshotMessage()
            # Not clear to me why the notify plugin should only process
            # errors.
            return

        try:
            notify_interface = dbus.Interface(
                object=dbus.SessionBus().get_object(
                    "org.freedesktop.Notifications",
                    "/org/freedesktop/Notifications"),
                dbus_interface="org.freedesktop.Notifications"
            )

        except dbus.exceptions.DBusException as exc:
            logger.error('Unexpected DBusException while initiating '
                         f'dbus.Interface(): {exc}')
            return

        if timeout > 0:
            timeout = 1000 * timeout
        else:
            # let timeout default to notification server settings
            timeout = -1

        title = f'Back In Time ({getpass.getuser()}) : {profile_name}'
        message = message.replace('\n', ' ')
        message = message.replace('\r', '')

        try:
            notify_interface.Notify(
                'Back In Time', 0, '', title, message, [], {}, timeout)

        except dbus.exceptions.DBusException as exc:
            logger.error(f'Unexpected DBusException while Notify(): {exc}')